IKnownFolderManager::FolderIdFromCsidl method (shobjidl_core.h)

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

Syntax

HRESULT FolderIdFromCsidl(
  [in]  int           nCsidl,
  [out] KNOWNFOLDERID *pfid
);

Parameters

[in] nCsidl

Type: int

The CSIDL value.

[out] pfid

Type: KNOWNFOLDERID*

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

Return value

Type: HRESULT

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

Remarks

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

Requirements

See also

IKnownFolderManager

IKnownFolderManager::FolderIdToCsidl

Known Folders Sample