Skip to content

Latest commit

 

History

History
81 lines (62 loc) · 3.54 KB

nf-shobjidl_core-iknownfolder-getfolderdefinition.md

File metadata and controls

81 lines (62 loc) · 3.54 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:shobjidl_core.IKnownFolder.GetFolderDefinition
IKnownFolder::GetFolderDefinition (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.
GetFolderDefinition
GetFolderDefinition method [Windows Shell]
GetFolderDefinition method [Windows Shell]
IKnownFolder interface
IKnownFolder interface [Windows Shell]
GetFolderDefinition method
IKnownFolder.GetFolderDefinition
IKnownFolder::GetFolderDefinition
_shell_IKnownFolder_GetFolderDefinition
shell.IKnownFolder_GetFolderDefinition
shobjidl_core/IKnownFolder::GetFolderDefinition
shell\IKnownFolder_GetFolderDefinition.htm
shell
b6f544cc-f487-405c-915d-b3a6dc59422c
12/05/2018
GetFolderDefinition, GetFolderDefinition method [Windows Shell], GetFolderDefinition method [Windows Shell],IKnownFolder interface, IKnownFolder interface [Windows Shell],GetFolderDefinition method, IKnownFolder.GetFolderDefinition, IKnownFolder::GetFolderDefinition, _shell_IKnownFolder_GetFolderDefinition, shell.IKnownFolder_GetFolderDefinition, shobjidl_core/IKnownFolder::GetFolderDefinition
shobjidl_core.h
Shobjidl.h
Windows
Windows Vista [desktop apps only]
Windows Server 2008 [desktop apps only]
Shobjidl.idl
Windows
19H1
IKnownFolder::GetFolderDefinition
shobjidl_core/IKnownFolder::GetFolderDefinition
c++
APIRef
kbSyntax
COM
shobjidl_core.h
IKnownFolder.GetFolderDefinition

IKnownFolder::GetFolderDefinition

-description

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.

-parameters

-param pKFD [out]

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.

-returns

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.

-see-also

IKnownFolder

Known Folders Sample