IKnownFolder::GetFolderDefinition method (shobjidl_core.h)
Retrieves a structure that contains the defining elements of a known folder, which includes the folder's category, name, path, description, tooltip, icon, and other properties.
Syntax
HRESULT GetFolderDefinition(
[out] KNOWNFOLDER_DEFINITION *pKFD
);
Parameters
[out] pKFD
Type: KNOWNFOLDER_DEFINITION*
When this method returns, contains a pointer to the KNOWNFOLDER_DEFINITION structure. When no longer needed, the calling application is responsible for calling FreeKnownFolderDefinitionFields to free this resource.
Return value
Type: HRESULT
If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.
Remarks
When a third-party application creates their own known folder, they do so by defining it with a KNOWNFOLDER_DEFINITION structure, then registering it with the system. Any registered known folder definition information—system-provided or application-created—can be retrieved through this method.
To call this method, the caller must have at least User privileges.
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) |