This interface is used to enumerate the components of a moniker or to enumerate the monikers in a table of monikers. IEnumMonikerhas the same methods as all enumerator interfaces: Next, Skip, Reset, and Clone.

When to Implement

You need to implement IEnumMonikerif you are writing a new type of moniker and your monikers have an internal structure that can be enumerated. Your implementation of IMoniker::Enummust return an enumerator that implements IEnumMonikerand can enumerate your moniker's components. If your moniker has no structure that can be enumerated, your IMoniker::Enummethod can simply return a NULL pointer.

When to Use

Call the methods of the IEnumMonikerinterface if you need to enumerate the components of a composite moniker, or to enumerate the monikers in a table.

OLE defines two interfaces that supply an IEnumMonikerinterface pointer:

• The IMoniker::Enummethod gets a pointer to an IEnumMonikerimplementation that can enumerate forwards or backwards through the components of the moniker.
• The IRunningObjectTable::EnumRunningmethod returns a pointer to an IEnumMonikerimplementation that can enumerate the monikers registered in a Running Object Table.

  The prototypes of the methods are as follows:

  HRESULT
  Next(
  ULONG
  celt, 
  IMoniker_com_IMoniker
  *
  rgelt, 
  ULONG
  *
  pceltFetched
  );
  HRESULT
  Skip(
  ULONG
  celt
  );
  HRESULT
  Reset(void)
  HRESULT
  Clone(
  IEnumMoniker
  **
  ppenum
  );

  Requirements

  Runs On	Versions	Defined in	Include	Link to
  Windows CE OS	3.0 and later	Objidl.h

  Note   This API is part of the complete Windows CE OS package as provided by Microsoft. The functionality of a particular platform is determined by the original equipment manufacturer (OEM) and some devices may not support this API.

  See Also

  IMoniker::Enum, IRunningObjectTable::EnumRunning

  
  

  ---

  Last updated on Friday, May 26, 2006

  © 2004 Microsoft Corporation. All rights reserved.