Méthode IKnownFolderManager ::GetFolderByName (shobjidl_core.h)

  • Article

Obtient un objet qui représente un dossier connu identifié par son nom canonique. L’objet vous permet d’interroger certaines propriétés de dossier, d’obtenir le chemin d’accès actuel du dossier, de rediriger le dossier vers un autre emplacement et d’obtenir le chemin du dossier sous la forme d’un ITEMIDLIST.

Syntaxe

HRESULT GetFolderByName(
  [in]  LPCWSTR      pszCanonicalName,
  [out] IKnownFolder **ppkf
);

Paramètres

[in] pszCanonicalName

Type : LPCWSTR

Pointeur vers le nom canonique non localisé du dossier connu, stocké sous la forme d’une chaîne Unicode terminée par null. Si ce dossier est un dossier commun ou par utilisateur , cette valeur est également utilisée comme nom de valeur des paramètres de Registre « Dossiers de l’interpréteur de commandes utilisateur ». Cette valeur est récupérée via le membre pszName de la structure KNOWNFOLDER_DEFINITION du dossier.

[out] ppkf

Type : IKnownFolder**

Lorsque cette méthode retourne, contient l’adresse d’un pointeur vers l’objet IKnownFolder qui représente le dossier connu.

Valeur retournée

Type : HRESULT

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

Remarques

Quand utiliser

Utilisez cette méthode lorsque vous savez exactement quel dossier connu vous recherchez et que vous souhaitez y accéder directement.

Configuration requise

Condition requise Valeur
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 (inclure Shobjidl.h)

Voir aussi

IKnownFolderManager

Dossiers connus, exemple