IKnownFolder::GetFolderDefinition, méthode (shobjidl_core.h)

  • Article

Récupère une structure qui contient les éléments de définition d’un dossier connu, qui inclut la catégorie, le nom, le chemin d’accès, la description, l’info-bulle, l’icône et d’autres propriétés du dossier.

Syntaxe

HRESULT GetFolderDefinition(
  [out] KNOWNFOLDER_DEFINITION *pKFD
);

Paramètres

[out] pKFD

Type : KNOWNFOLDER_DEFINITION*

Lorsque cette méthode est retournée, contient un pointeur vers la structure KNOWNFOLDER_DEFINITION . Lorsque vous n’en avez plus besoin, l’application appelante est chargée d’appeler FreeKnownFolderDefinitionFields pour libérer cette ressource.

Valeur retournée

Type : HRESULT

Si cette méthode réussit, elle retourne S_OK. Sinon, elle retourne un code d’erreur HRESULT.

Remarques

Lorsqu’une application tierce crée son propre dossier connu, elle le fait en le définissant avec une structure KNOWNFOLDER_DEFINITION , puis en l’inscrivant auprès du système. Toutes les informations de définition de dossier connues inscrites (fournies par le système ou créées par l’application) peuvent être récupérées à l’aide de cette méthode.

Pour appeler cette méthode, l’appelant doit avoir au moins des privilèges Utilisateur.

Configuration requise

   
Client minimal pris en charge Windows Vista [applications de bureau uniquement]
Serveur minimal pris en charge Windows Server 2008 [applications de bureau uniquement]
Plateforme cible Windows
En-tête shobjidl_core.h (incluez Shobjidl.h)

Voir aussi

IKnownFolder

Dossiers connus, exemple