IOleContainer::EnumObjects

Enumerates objects in the current container.

HRESULT EnumObjects(

DWORD grfFlags,

//Value specifying what is to be enumerated

IEnumUnknown **ppenum

//Indirect pointer to enumerator object

);

Parameters

grfFlags

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

ppenum

    [out] When successful, indirect pointer to the IEnumUnknown interface on the enumerator object. Each time a container receives a successful call to EnumObjects, it must increase the reference count on the 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, this parameter must be set 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.

See Also

IEnumUnknown, IOleItemContainer, OLECONTF