IKnownFolderManager ::GetFolder, méthode (shobjidl_core.h)

  • Article

Obtient un objet qui représente un dossier connu identifié par son KNOWNFOLDERID. 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 GetFolder(
  [in]  REFKNOWNFOLDERID rfid,
  [out] IKnownFolder     **ppkf
);

Paramètres

[in] rfid

Type : REFKNOWNFOLDERID

Référence à KNOWNFOLDERID.

[out] ppkf

Type : IKnownFolder**

Lorsque cette méthode est retournée, contient un pointeur d’interface vers l’objet IKnownFolder qui représente le dossier.

Valeur retournée

Type : HRESULT

Retourne S_OK en cas de réussite, ou une valeur d’erreur dans le cas contraire, y compris les éléments suivants :

Code de retour Description
E_INVALIDARG
 Entre autres choses, cette valeur peut indiquer que le paramètre rfid fait référence à un KNOWNFOLDERID qui n’est pas présent sur le système. Toutes les valeurs KNOWNFOLDERID ne sont pas présentes sur tous les systèmes. Utilisez IKnownFolderManager ::GetFolderIds pour récupérer l’ensemble des valeurs KNOWNFOLDERID pour le système actuel.

Remarques

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

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 (incluez Shobjidl.h)
DLL Shell32.dll

Voir aussi

IKnownFolderManager

Dossiers connus, exemple