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

  • Article

Affecte un nouveau chemin d’accès à un dossier connu.

Syntaxe

HRESULT SetPath(
  [in] DWORD   dwFlags,
  [in] LPCWSTR pszPath
);

Paramètres

[in] dwFlags

Type : DWORD

Zéro ou valeur suivante :

KF_FLAG_DONT_UNEXPAND

Définissez le chemin d’accès complet sans chaînes d’environnement. Si cet indicateur n’est pas défini, des parties du chemin d’accès à pszPath peuvent être représentées par des chaînes d’environnement telles que %USERPROFILE%.

[in] pszPath

Type : LPCWSTR

Pointeur vers le nouveau chemin d’accès du dossier. Il s’agit d’une chaîne Unicode terminée par un caractère Null de longueur MAX_PATH. Ce chemin ne peut pas être de longueur nulle. Si cette valeur est NULL, IKnownFolder ::SetPath définit le chemin d’accès à la valeur par défaut.

Valeur retournée

Type : HRESULT

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

Remarques

Cette méthode ne peut pas être appelée sur des dossiers de type KF_CATEGORY_FIXED ou KF_CATEGORY_VIRTUAL.

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

Cette méthode est équivalente à SHSetKnownFolderPath.

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

IKnownFolder

Dossiers connus, exemple

SHSetKnownFolderPath