SHGetKnownFolderItem, fonction (shlobj_core.h)

Récupère un objet IShellItem qui représente un dossier connu.

Syntaxe

HRESULT SHGetKnownFolderItem(
  [in]  REFKNOWNFOLDERID  rfid,
  [in]  KNOWN_FOLDER_FLAG flags,
  [in]  HANDLE            hToken,
  [in]  REFIID            riid,
  [out] void              **ppv
);

Paramètres

[in] rfid

Type : REFKNOWNFOLDERID

Référence au KNOWNFOLDERID, GUID qui identifie le dossier qui contient l’élément.

[in] flags

Type : KNOWN_FOLDER_FLAG

Indicateurs qui spécifient des options spéciales utilisées dans la récupération du dossier connu IShellItem. Cette valeur peut être KF_FLAG_DEFAULT ; sinon, une ou plusieurs valeurs KNOWN_FOLDER_FLAG .

[in] hToken

Type : HANDLE

Jeton d’accès utilisé pour représenter un utilisateur particulier. Ce paramètre est généralement défini sur NULL, auquel cas la fonction tente d’accéder à l’instance de l’utilisateur actuel du dossier. Toutefois, vous devrez peut-être affecter une valeur à hToken pour ces dossiers qui peuvent avoir plusieurs utilisateurs, mais qui sont traités comme appartenant à un seul utilisateur. Le dossier le plus couramment utilisé de ce type est Documents.

L’application appelante est responsable de l’emprunt d’identité correct lorsque hToken n’est pas null. Il doit disposer des privilèges de sécurité appropriés pour l’utilisateur particulier, notamment TOKEN_QUERY et TOKEN_IMPERSONATE, et la ruche de Registre de l’utilisateur doit être actuellement montée. Pour plus d’informations sur les problèmes de contrôle d’accès, consultez Contrôle d’accès.

L’affectation du paramètre hToken à une valeur de -1 indique l’utilisateur par défaut. Cela permet aux clients de SHSetKnownFolderPath de définir des emplacements de dossier (tels que le dossier Desktop ) pour l’utilisateur par défaut. Le profil utilisateur par défaut est dupliqué lorsque tout nouveau compte d’utilisateur est créé et inclut des dossiers spéciaux tels que Documents et Bureau. Tous les éléments ajoutés au dossier Utilisateur par défaut apparaissent également dans n’importe quel nouveau compte d’utilisateur. Notez que l’accès aux dossiers utilisateur par défaut nécessite des privilèges d’administrateur.

[in] riid

Type : REFIID

Référence à l’IID de l’interface qui représente l’élément, généralement IID_IShellItem ou IID_IShellItem2.

[out] ppv

Type : void**

Lorsque cette méthode est retournée, contient le pointeur d’interface demandé dans riid.

Valeur renvoyée

Type : HRESULT

Retourne S_OK si elle réussit ou une valeur d’erreur sinon, y compris les éléments suivants :

Remarques

Pour appeler cette fonction sur des dossiers connus publics, l’appelant doit disposer de privilèges d’administrateur. Pour les dossiers connus par utilisateur, l’appelant requiert uniquement des privilèges utilisateur.

Certains des dossiers connus, par exemple, le dossier Documents , sont par utilisateur. Chaque utilisateur a un chemin différent pour son dossier Documents . Si hToken a la valeur NULL, l’API tente d’accéder à l’instance de l’application appelante du dossier, qui est celle de l’utilisateur actuel. Si hToken est un jeton d’utilisateur valide, l’API tente d’emprunter l’identité de l’utilisateur à l’aide de ce jeton et tente d’accéder à l’instance de cet utilisateur.

Cette fonction ne peut pas être appelée sur des dossiers de type KF_CATEGORY_FIXED et KF_CATEGORY_VIRTUAL.

Pour appeler cette fonction sur un dossier de type KF_CATEGORY_COMMON, l’application appelante doit s’exécuter avec des privilèges élevés.

Exigences

Voir aussi

IKnownFolder ::GetPath

IKnownFolderManager ::Redirect

Exemple de dossiers connus

SHCreateItemInKnownFolder

SHGetKnownFolderIDList

SHGetKnownFolderPath