OleEnumObjects

3.1

  #include <ole.h>    

  OLESTATUS OleEnumObjects(lhDoc, lplpObject)    
  LHCLIENTDOC lhDoc; /* document handle, */  
  LPOLEOBJECT FAR* lplpObject; /* address of pointer to object */

The OleEnumObjects function enumerates the objects in a specified document.

Parameters

lhDoc

Identifies the document for which the objects are enumerated.

lplpObject

Points to an object in the document when the function returns. For the first call to this function, this parameter should point to a NULL object.

Return Value

The return value is OLE_OK if the function is successful. Otherwise, it is an error value, which may be one of the following:

OLE_ERROR_HANDLE OLE_ERROR_OBJECT

Comments

When an application specifies a NULL object for the lplpObject parameter, the OleEnumObjects function returns the first object in the document. Whenever an application specifies an object that was returned by a previous call to OleEnumObjects, the function returns the next object, in sequence. When there are no more objects in the document, the lplpObject parameter points to a NULL object.

Only objects that have been loaded and not released are enumerated by this function.

See Also

OleDelete, OleRelease