IDVGetEnum::CreateEnumIDListFromContents method

[This interface is supported through Windows XP Service Pack 2 (SP2) and Windows Server 2003. It is not supported as of Windows Vista.]

Gets the enumeration results to pass to another object.

Syntax


HRESULT CreateEnumIDListFromContents(
  [in]  LPCITEMIDLIST pidlFolder,
  [in]  DWORD         dwEnumFlags,
  [out] IEnumIDList   **ppEnumIDList
);

Parameters

pidlFolder [in]

Type: LPCITEMIDLIST

The folder's PIDL. This verifies that the system folder view object is looking at the same folder as the object that will receive the enumeration.

dwEnumFlags [in]

Type: DWORD

One or more values from the SHCONTF enumeration that specify the desired contents of the enumeration.

ppEnumIDList [out]

Type: IEnumIDList**

A pointer to the address of the IEnumIDList instance representing the enumeration.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

This method can fail if the SHCONTF flags used by the system folder view object are not a superset of dwEnumFlags. It can also fail if pidlFolder does not match the folder currently in view in the system folder view object.

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

End of client support

Windows XP with SP2

End of server support

Windows Server 2003

Header

Shobjidl.h

IDL

Shobjidl.idl

Library

Shell32.lib

DLL

Shell32.dll (version 5.0 or later)

 

 

Show: