énumération KNOWN_FOLDER_FLAG (shlobj_core.h)

  • Article

Définit des constantes qui spécifient des options de récupération spéciales pour les dossiers connus (par exemple, à utiliser lors de l’appel de la fonction SHGetKnownFolderIDList pour récupérer le chemin d’accès d’un dossier connu). Ces valeurs remplacent les valeurs CSIDL , qui ont des significations parallèles.

Syntax

typedef enum {
  KF_FLAG_DEFAULT = 0x00000000,
  KF_FLAG_FORCE_APP_DATA_REDIRECTION = 0x00080000,
  KF_FLAG_RETURN_FILTER_REDIRECTION_TARGET = 0x00040000,
  KF_FLAG_FORCE_PACKAGE_REDIRECTION = 0x00020000,
  KF_FLAG_NO_PACKAGE_REDIRECTION = 0x00010000,
  KF_FLAG_FORCE_APPCONTAINER_REDIRECTION = 0x00020000,
  KF_FLAG_NO_APPCONTAINER_REDIRECTION = 0x00010000,
  KF_FLAG_CREATE = 0x00008000,
  KF_FLAG_DONT_VERIFY = 0x00004000,
  KF_FLAG_DONT_UNEXPAND = 0x00002000,
  KF_FLAG_NO_ALIAS = 0x00001000,
  KF_FLAG_INIT = 0x00000800,
  KF_FLAG_DEFAULT_PATH = 0x00000400,
  KF_FLAG_NOT_PARENT_RELATIVE = 0x00000200,
  KF_FLAG_SIMPLE_IDLIST = 0x00000100,
  KF_FLAG_ALIAS_ONLY = 0x80000000
} KNOWN_FOLDER_FLAG;

Constantes

 
KF_FLAG_DEFAULT
Valeur : 0x00000000
Spécifie aucune option de récupération spéciale.
KF_FLAG_FORCE_APP_DATA_REDIRECTION
Valeur : 0x00080000
Introduit dans Windows 10, version 1709. En cas d’appel à partir d’une application empaquetée, spécifie que les dossiersRoamingAppDataLocalAppData/ sont redirigés vers des emplacements d’application privés qui correspondent aux chemins d’accès retournés par Windows.Storage.ApplicationData.Current dans les propriétés LocalFolder et RoamingFolder. D’autres dossiers sont redirigés vers les sous-répertoires de LocalAppData.

Cet indicateur est utilisé avec FOLDERID_AppDataDesktop, FOLDERID_AppDataDocuments, FOLDERID_AppDataFavorites et FOLDERID_AppDataProgramData. Il est également destiné à la compatibilité avec les applications .NET et n’est pas destiné à être utilisé directement à partir d’une application.
KF_FLAG_RETURN_FILTER_REDIRECTION_TARGET
Valeur : 0x00040000
Introduit dans Windows 10, version 1703. Lors de l’exécution dans un processus empaqueté, spécifie que certains emplacements de système de fichiers sont redirigés vers des emplacements spécifiques au package par le système de fichiers. Cet indicateur entraîne le retour de la cible de la direction pour ces emplacements. Cela est utile dans les cas où l’emplacement réel dans le système de fichiers doit être connu.
KF_FLAG_FORCE_PACKAGE_REDIRECTION
Valeur : 0x00020000
Introduit dans Windows 10, version 1703. Lors de l’exécution à l’intérieur d’un processus AppContainer ou lors de la fourniture d’un jeton AppContainer, spécifie que certains dossiers sont redirigés vers des emplacements spécifiques d’AppContainer au sein du package. Cet indicateur force la redirection (pour les dossiers qui ne sont pas normalement redirigés) à des fins de processus empaquetés et peut être utilisé pour partager des fichiers entre UWP et des applications empaquetées dans le même package. Cet indicateur remplace les KF_FLAG_FORCE_APPCONTAINER_REDIRECTION dépréciés.
KF_FLAG_NO_PACKAGE_REDIRECTION
Valeur : 0x00010000
Introduit dans Windows 10, version 1703. Lors de l’exécution à l’intérieur d’un processus empaqueté ou lors de la fourniture d’un jeton de processus empaqueté, spécifie que certains dossiers sont redirigés vers des emplacements spécifiques au package. Cet indicateur désactive la redirection sur les emplacements où elle est appliquée et retourne à la place le chemin qui serait retourné s’il ne s’exécute pas à l’intérieur d’un processus empaqueté. Cet indicateur remplace le KF_FLAG_NO_APPCONTAINER_REDIRECTION déconseillé.
KF_FLAG_FORCE_APPCONTAINER_REDIRECTION
Valeur : 0x00020000
Introduit dans Windows 8. Cet indicateur a été déprécié dans Windows 10, version 1703. Utilisez KF_FLAG_FORCE_PACKAGE_REDIRECTION à la place.
KF_FLAG_NO_APPCONTAINER_REDIRECTION
Valeur : 0x00010000
Introduit dans Windows 8. Cet indicateur a été déprécié dans Windows 10, version 1703. Utilisez KF_FLAG_NO_PACKAGE_REDIRECTION à la place.
KF_FLAG_CREATE
Valeur : 0x00008000
Spécifie de forcer la création du dossier spécifié si ce dossier n’existe pas déjà. Les dispositions de sécurité prédéfinies pour ce dossier sont appliquées. Si le dossier n’existe pas et ne peut pas être créé, la fonction retourne un code d’échec et aucun chemin d’accès n’est retourné. Cette valeur ne peut être utilisée qu’avec les fonctions et méthodes suivantes :

* SHGetKnownFolderPath
* SHGetKnownFolderIDList
* IKnownFolder ::GetIDList
* IKnownFolder ::GetPath
* IKnownFolder ::GetShellItem
KF_FLAG_DONT_VERIFY
Valeur : 0x00004000
Spécifie de ne pas vérifier l’existence du dossier avant d’essayer de récupérer le chemin d’accès ou IDList. Si cet indicateur n’est pas défini, une tentative est effectuée pour vérifier que le dossier est vraiment présent au niveau du chemin d’accès. Si cette vérification échoue parce que le dossier est absent ou inaccessible, la fonction retourne un code d’échec et aucun chemin d’accès n’est retourné.

Si le dossier se trouve sur un réseau, l’exécution de la fonction peut prendre plus de temps. Ainsi, la définition de cet indicateur peut réduire cette latence.
KF_FLAG_DONT_UNEXPAND
Valeur : 0x00002000
Spécifie de stocker le chemin d’accès complet dans le Registre sans utiliser de chaînes d’environnement. Si cet indicateur n’est pas défini, des parties du chemin d’accès peuvent être représentées par des chaînes d’environnement telles que %USERPROFILE%. Cet indicateur ne peut être utilisé qu’avec SHSetKnownFolderPath et IKnownFolder ::SetPath.
KF_FLAG_NO_ALIAS
Valeur : 0x00001000
Spécifie de récupérer le chemin d’accès système réel du dossier, exempt de tout espace réservé avec alias tel que %USERPROFILE%, retourné par SHGetKnownFolderIDList et IKnownFolder ::GetIDList. Cet indicateur n’a aucun effet sur les chemins retournés par SHGetKnownFolderPath et IKnownFolder ::GetPath. Par défaut, les fonctions et méthodes de récupération de dossiers connus retournent le chemin d’accès sous alias s’il existe un alias.
KF_FLAG_INIT
Valeur : 0x00000800
Spécifie d’initialiser le dossier à l’aide de ses Desktop.ini paramètres. Si le dossier ne peut pas être initialisé, la fonction retourne un code d’échec et aucun chemin d’accès n’est retourné. Cet indicateur doit toujours être combiné avec KF_FLAG_CREATE.

Si le dossier se trouve sur un réseau, l’exécution de la fonction peut prendre plus de temps.
KF_FLAG_DEFAULT_PATH
Valeur : 0x00000400
Spécifie de récupérer le chemin d’accès par défaut d’un dossier connu. Si cet indicateur n’est pas défini, la fonction récupère le chemin d’accès actuel (et éventuellement redirigé) du dossier. L’exécution de cet indicateur inclut une vérification de l’existence du dossier, sauf si KF_FLAG_DONT_VERIFY est défini.
KF_FLAG_NOT_PARENT_RELATIVE
Valeur : 0x00000200
Spécifie de récupérer le chemin d’accès par défaut du dossier, indépendamment de l’emplacement actuel de son parent. KF_FLAG_DEFAULT_PATH doit également être défini.
KF_FLAG_SIMPLE_IDLIST
Valeur : 0x00000100
Spécifie de générer une liste d’identité (PIDL) simple. Cette valeur peut être utilisée lorsque vous souhaitez récupérer le chemin du système de fichiers. Mais ne spécifiez pas cette valeur si vous récupérez le nom d’affichage localisé du dossier, car il peut ne pas être résolu correctement.
KF_FLAG_ALIAS_ONLY
Valeur : 0x80000000
Introduit dans Windows 7. Spécifie de récupérer uniquement les LISTES PIDL avec alias. N’utilisez pas le chemin du système de fichiers.

Remarques

Ces valeurs, à l’exception de KF_FLAG_ALIAS_ONLY, ont été définies dans Windows Vista en tant que constantes individuelles. Ils sont définis en tant qu’énumération uniquement dans Windows 7 et versions ultérieures. Toutefois, toutes les valeurs numériques sous-jacentes sont les mêmes dans l’une ou l’autre des formes.

Configuration requise

Condition requise Valeur
Client minimal pris en charge Windows 7 [applications de bureau uniquement]
Serveur minimal pris en charge Windows Server 2008 R2 [applications de bureau uniquement]
En-tête shlobj_core.h (inclure Shlobj.h)

Voir aussi