IMoniker::Enum - OLE Programmer's Reference (ole.hlp)

IMoniker::Enum

Returns a pointer to an enumerator that can enumerate the components of the moniker.

HRESULT Enum(

BOOL fForward,	//Specifies direction of enumeration
IEnumMoniker **ppenumMoniker	//Receives the enumerator
);

Parameters
fForward

[in] Specifies the enumeration order. TRUE enumerates the monikers from left to right; FALSE enumerates from right to left.

ppenumMoniker

[out] Receives a pointer to an IEnumMoniker enumerator for this moniker. If an error occurs or if the moniker has no enumerable components, the implementation sets *ppenumMoniker to NULL. If *ppenumMoniker is non-NULL, the implementation must call IUnknown::AddRef on the parameter; it is the caller's responsibility to call IUnknown::Release.

Return Values
S_OK

Indicates success. This value is returned even if the moniker does not provide an enumerator (that is, if *ppenumMoniker equals NULL).

E_OUTOFMEMORY

Indicates insufficient memory.

E_UNEXPECTED

Indicates an unexpected error.

Comments
As examples of enumeration, the IMoniker::Enum method for a generic composite moniker creates an enumerator that returns the individual monikers that make up the composite, and the IMoniker::Enum method for a file moniker creates an enumerator that returns monikers representing each of the components in the pathname.

Notes to Callers
You would call this method if you want to examine the individual components that make up a composite moniker.

Notes to Implementors
If your monikers have no discernible internal structure, your implementation of this method can simply return S_OK and set *ppenumMoniker to NULL.

See Also
IEnumXXXX

More Online Helps

Win32 Programmer's Reference (win32.hlp)
Win32 Multimedia Programmer's Reference (mmedia.hlp)
Microsoft Windows Pen API Programmer's Reference (penapi.hlp)
Microsoft Windows Sockets 2 Reference (sock2.hlp)
Microsoft Windows Telephony API (TAPI) Programmer's Reference (sock2.hlp)
Unix Manual Pages

greatis just4fun network