IOleContainer::EnumObjects

Enumerates objects in the current container.

HRESULT EnumObjects(
  DWORD grfFlags,  //Value specifying what is to be enumerated
  IEnumUnknown **ppenum
                   //Address of output variable that receives the 
                   // IEnumUnknown interface pointer
);
 

Parameters

grfFlags

[in] Value that specifies which objects in a container are to be enumerated, as defined in the enumeration OLECONTF.

ppenum

[out] Address of IEnumUnknown* pointer variable that receives the interface pointer to the enumerator object. Each time a container receives a successful call to EnumObjects, it must increase the reference count on the *ppenum pointer the method returns. It is the caller's responsibility to call IUnknown::Release when it is done with the pointer. If an error is returned, the implementation must set *ppenum to NULL.

Return Values

This method supports the standard return value E_FAIL, as well as the following:

S_OK

Enumerator successfully returned.

E_NOTIMPL

Object enumeration not supported.

Remarks

A container should implement EnumObjects to enable programmatic clients to find out what objects it holds. This method, however, is not called in standard linking scenarios.

QuickInfo

  Windows NT: Use version 3.1 or later.
  Windows: Use Windows 95 or later.
  Windows CE: Unsupported.
  Header: Declared in oleidl.h.

See Also

IEnumUnknown, IOleItemContainer, OLECONTF