IKnownFolderManager::FolderIdToCsidl method
Gets the legacy CSIDL value that is the equivalent of a given KNOWNFOLDERID.
Syntax
HRESULT FolderIdToCsidl( [in] REFKNOWNFOLDERID rfid, [out] int *pnCsidl );
Parameters
- rfid [in]
-
Type: REFKNOWNFOLDERID
Reference to the KNOWNFOLDERID.
- pnCsidl [out]
-
Type: int*
When this method returns, contains a pointer to the CSIDL value. This pointer is passed uninitialized.
Return value
Type: HRESULT
Returns S_OK if successful, or an error value otherwise, including the following:
| Return code | Description |
|---|---|
|
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. |
Remarks
To call this method, the caller must have at least User privileges.
Requirements
|
Minimum supported client |
Windows Vista [desktop apps only] |
|---|---|
|
Minimum supported server |
Windows Server 2008 [desktop apps only] |
|
Header |
|
|
IDL |
|
|
DLL |
|
See also