IKnownFolder::GetIDList method (shobjidl_core.h)

Article
02/22/2024

Gets the location of the Shell namespace folder in the IDList (ITEMIDLIST) form.

Syntax

HRESULT GetIDList(
  [in]  DWORD            dwFlags,
  [out] PIDLIST_ABSOLUTE *ppidl
);

Parameters

[in] dwFlags

Type: DWORD

Flags that specify special retrieval options. This value can be 0; otherwise, one or more of the KNOWN_FOLDER_FLAG values.

[out] ppidl

Type: PIDLIST_ABSOLUTE*

When this method returns, contains the address of an absolute PIDL. This parameter is passed uninitialized. The calling application is responsible for freeing this resource when it is no longer needed.

Return value

Type: HRESULT

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

Remarks

Equivalent to SHGetKnownFolderIDList.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2008 [desktop apps only]
Target Platform	Windows
Header	shobjidl_core.h (include Shobjidl.h)
DLL	Shell32.dll