IKnownFolderManager::FolderIdToCsidl method (shobjidl_core.h)

Gets the legacy CSIDL value that is the equivalent of a given KNOWNFOLDERID.

Syntax

HRESULT FolderIdToCsidl(
  [in]  REFKNOWNFOLDERID rfid,
  [out] int              *pnCsidl
);

[in] rfid

Type: REFKNOWNFOLDERID

Reference to the KNOWNFOLDERID.

[out] pnCsidl

Type: int*

When this method returns, contains a pointer to the CSIDL value. This pointer is passed uninitialized.

Type: HRESULT

Returns S_OK if successful, or an error value otherwise, including the following:

Return code	Description
E_INVALIDARG	Among other things, this value can indicate that the rfid parameter references a KNOWNFOLDERID that is not present on the system. Not all KNOWNFOLDERID values are present on all systems. Use IKnownFolderManager::GetFolderIds to retrieve the set of KNOWNFOLDERID values for the current system.

To call this method, the caller must have at least User privileges.

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