nf-objidl-imoniker-enum.md

UID	title	description	helpviewer_keywords	old-location	tech.root	ms.assetid	ms.date	ms.keywords	req.header	req.include-header	req.target-type	req.target-min-winverclnt	req.target-min-winversvr	req.kmdf-ver	req.umdf-ver	req.ddi-compliance	req.unicode-ansi	req.idl	req.max-support	req.namespace	req.assembly	req.type-library	req.lib	req.dll	req.irql	targetos	req.typenames	req.redist	ms.custom	f1_keywords	dev_langs	topic_type	api_type	api_location	api_name
NF:objidl.IMoniker.Enum	IMoniker::Enum (objidl.h)	Retrieves a pointer to an enumerator for the components of a composite moniker.	Enum Enum method [COM] Enum method [COM] IMoniker interface IMoniker interface [COM] Enum method IMoniker.Enum IMoniker::Enum _com_imoniker_enum com.imoniker_enum objidl/IMoniker::Enum	com\imoniker_enum.htm	com	7e2e4d92-d5dd-4294-944e-8b1e88901ee1	12/05/2018	Enum, Enum method [COM], Enum method [COM],IMoniker interface, IMoniker interface [COM],Enum method, IMoniker.Enum, IMoniker::Enum, _com_imoniker_enum, com.imoniker_enum, objidl/IMoniker::Enum	objidl.h		Windows	Windows 2000 Professional [desktop apps only]	Windows 2000 Server [desktop apps only]					ObjIdl.idl								Windows			19H1	IMoniker::Enum objidl/IMoniker::Enum	c++	APIRef kbSyntax	COM	ObjIdl.h	IMoniker.Enum

IMoniker::Enum

-description

Retrieves a pointer to an enumerator for the components of a composite moniker.

-parameters

-param fForward [in]

If TRUE, enumerates the monikers from left to right. If FALSE, enumerates from right to left.

-param ppenumMoniker [out]

A pointer to an IEnumMoniker pointer variable that receives the interface pointer to the enumerator object for the moniker. When successful, the implementation must call AddRef on the enumerator object. It is the caller's responsibility to call Release. If an error occurs or if the moniker has no enumerable components, the implementation sets *ppenumMoniker to NULL.

-returns

This method can return the standard return values E_OUTOFMEMORY, E_UNEXPECTED, and S_OK.

-remarks

This method must supply an IEnumMoniker pointer to an enumerator that can enumerate the components of a moniker. For example, the implementation of the IMoniker::Enum method for a generic composite moniker creates an enumerator that can determine the individual monikers that make up the composite, while the IMoniker::Enum method for a file moniker creates an enumerator that returns monikers representing each of the components in the path.

Notes to Callers

Call this method to examine the components that make up a composite moniker.

Notes to Implementers

If the new moniker class has no discernible internal structure, your implementation of this method can simply return S_OK and set ppenumMoniker to NULL.

Implementation-specific Notes

Implementation	Notes
Anti-moniker	This method returns S_OK and sets ppenumMoniker to NULL.
Class moniker	This method returns S_OK and sets ppenumMoniker to NULL.
File moniker	This method returns S_OK and sets ppenumMoniker to NULL.
Generic composite moniker	If successful, this method returns S_OK and passes back an enumerator that enumerates the component monikers that make up the composite; otherwise, the method returns E_OUTOFMEMORY.
Item moniker	This method returns S_OK and sets ppenumMoniker to NULL.
OBJREF moniker	This method returns S_OK and sets ppenumMoniker to NULL.
Pointer moniker	This method returns E_NOTIMPL.
URL moniker	This method returns S_OK and sets ppenumMoniker to NULL.

-see-also

IEnumMoniker

IMoniker