IEnumIDList  Interface

IID_IEnumIDList

{000214F2-0000-0000-C000-000000000046}

The IEnumIDList interface provides a standard set of methods that can be used to enumerate the pointers to item identifier lists (PIDLs) of the items in a Shell folder. When a folder's IShellFolder::EnumObjects method is called, it creates an enumeration object and passes a pointer to the object's IEnumIDList interface back to the caller.

Remarks

All Shell folder objects must be able to respond to a call to their IShellFolder::EnumObjects method by creating an enumeration object that exports IEnumIDList. The Shell, in particular, uses these objects to enumerate the items in a folder.

 

Use this interface to enumerate the contents of a Shell folder object. Call the folder's IShellFolder::EnumObjects method and use the returned IEnumIDList pointer to enumerate the PIDLs of the items in the folder.

Methods in VTable order

IUnknown Methods

Description

QueryInterface

Returns pointers to supported interfaces.

AddRef

Increments reference count.

Release

Decrements reference count.

IEnumIDList Methods

Description

Next

Retrieves the specified number of item identifiers in the enumeration sequence and advances the current position by the number of items retrieved.

Skip

Skips over the specified number of elements in the enumeration sequence.

Reset

Returns to the beginning of the enumeration sequence.

Clone

Creates a new item enumeration object with the same contents and state as the current one.

Next

FUNCTION IEnumIDList_Next ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL celt AS DWORD _
, BYVAL rgelt AS DWORD _
, BYREF pceltFetched AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[3] USING IEnumIDList_Next (pthis, celt, rgelt, pceltFetched) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

Skip

FUNCTION IEnumIDList_Skip ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL celt AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[4] USING IEnumIDList_Skip (pthis, celt) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

Reset

FUNCTION IEnumIDList_Reset ( _
  BYVAL pthis AS DWORD PTR _
  ) AS LONG

  LOCAL HRESULT AS LONG

  CALL DWORD @@pthis[5] USING IEnumIDList_Reset (pthis) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

Clone

FUNCTION IEnumIDList_Clone ( _
  BYVAL pthis AS DWORD PTR _
, BYREF ppenum AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG

  CALL DWORD @@pthis[6] USING IEnumIDList_Clone (pthis, ppenum) TO HRESULT

  FUNCTION = HRESULT

END FUNCTION