structure KNOWNFOLDER_DEFINITION (shobjidl_core.h)
Définit les spécificités d’un dossier connu.
Syntaxe
typedef struct KNOWNFOLDER_DEFINITION {
KF_CATEGORY category;
LPWSTR pszName;
LPWSTR pszDescription;
KNOWNFOLDERID fidParent;
LPWSTR pszRelativePath;
LPWSTR pszParsingName;
LPWSTR pszTooltip;
LPWSTR pszLocalizedName;
LPWSTR pszIcon;
LPWSTR pszSecurity;
DWORD dwAttributes;
KF_DEFINITION_FLAGS kfdFlags;
FOLDERTYPEID ftidType;
} KNOWNFOLDER_DEFINITION;
Membres
category
Type : KF_CATEGORY
Une valeur unique de la KF_CATEGORY constantes qui classe le dossier comme virtuel, fixe, commun ou par utilisateur.
pszName
Type : LPWSTR
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 ». Ce nom est destiné à être un nom unique et lisible par l’homme. Il est recommandé à des tiers de suivre le format Company.Application.Name. Le nom donné ici ne doit pas être confondu avec le nom d’affichage.
pszDescription
Type : LPWSTR
Pointeur vers une brève description du dossier connu, stocké sous la forme d’une chaîne Unicode terminée par null. Cette description doit inclure l’objectif et l’utilisation du dossier.
fidParent
Type : KNOWNFOLDERID
Valeur KNOWNFOLDERID qui nomme un autre dossier connu pour servir de dossier parent. S’applique uniquement aux dossiers courants et par utilisateur. Cette valeur est utilisée conjointement avec pszRelativePath. Pour plus d’informations, consultez Remarques .
Cette valeur est facultative si aucune valeur n’est fournie pour pszRelativePath.
pszRelativePath
Type : LPWSTR
facultatif. Pointeur vers un chemin relatif au dossier parent spécifié dans fidParent. Il s’agit d’une chaîne Unicode terminée par null, qui fait référence au chemin d’accès du système de fichiers physique et qui n’est pas localisée. S’applique uniquement aux dossiers courants et par utilisateur. Pour plus d’informations, consultez Remarques .
pszParsingName
Type : LPWSTR
Pointeur vers le chemin du dossier de l’espace de noms Shell du dossier, stocké sous la forme d’une chaîne Unicode terminée par null. S’applique uniquement aux dossiers virtuels. Par exemple, Control Panel a un nom d’analyse de ::%CLSID_MyComputer%::%CLSID_ControlPanel%.
pszTooltip
Type : LPWSTR
facultatif. Pointeur vers la ressource d’info-bulle par défaut utilisée pour ce dossier connu lors de sa création. Il s’agit d’une chaîne Unicode terminée par null sous la forme suivante :
Nom du module, ID de ressource
Par exemple, @%_SYS_MOD_PATH%,-12688 est l’info-bulle pour Les images courantes. Lorsque le dossier est créé, cette chaîne est stockée dans la copie de Desktop.ini de ce dossier. Il peut être modifié ultérieurement par d’autres API Shell. Cette ressource peut être localisée.
Ces informations ne sont pas requises pour les dossiers virtuels.
pszLocalizedName
Type : LPWSTR
facultatif. Pointeur vers la ressource de nom localisé par défaut utilisée lors de la création du dossier. Il s’agit d’une chaîne Unicode terminée par null sous la forme suivante :
Nom du module, ID de ressource
Lorsque le dossier est créé, cette chaîne est stockée dans la copie de Desktop.ini de ce dossier. Il peut être modifié ultérieurement par d’autres API Shell.
Ces informations ne sont pas requises pour les dossiers virtuels.
pszIcon
Type : LPWSTR
facultatif. Pointeur vers la ressource d’icône par défaut utilisée lors de la création du dossier. Il s’agit d’une chaîne Unicode terminée par null sous la forme suivante :
Nom du module, ID de ressource
Lorsque le dossier est créé, cette chaîne est stockée dans la copie de Desktop.ini de ce dossier. Il peut être modifié ultérieurement par d’autres API Shell.
Ces informations ne sont pas requises pour les dossiers virtuels.
pszSecurity
Type : LPWSTR
facultatif. Pointeur vers une chaîne de format de langage de définition de descripteur de sécurité . Il s’agit d’une chaîne Unicode terminée par null qui décrit le descripteur de sécurité par défaut que le dossier reçoit lors de sa création. Si ce paramètre a la valeur NULL, le nouveau dossier hérite du descripteur de sécurité de son parent. Cela est particulièrement utile pour les dossiers courants auxquels tous les utilisateurs accèdent.
dwAttributes
Type : DWORD
facultatif. Attributs de système de fichiers par défaut donnés au dossier lors de sa création. Par exemple, le fichier peut être masqué et en lecture seule (FILE_ATTRIBUTE_HIDDEN et FILE_ATTRIBUTE_READONLY). Pour obtenir la liste complète des valeurs possibles, consultez le paramètre dwFlagsAndAttributes de la fonction CreateFile . Définissez -1 si ce n’est pas nécessaire.
kfdFlags
Type : KF_DEFINITION_FLAGS
facultatif. L’une des autres valeurs de l’énumération KF_DEFINITION_FLAGS qui vous permet de restreindre la redirection, d’autoriser l’itinérance PC à PC et de contrôler l’heure de création du dossier connu. Définissez sur 0 si ce n’est pas nécessaire.
ftidType
Type : FOLDERTYPEID
Une des valeurs FOLDERTYPEID qui identifie le type de dossier connu en fonction de son contenu (par exemple, des documents, de la musique ou des photographies). Cette valeur est un GUID.
Remarques
Les valeurs fidParent et pszRelativePath fonctionnent ensemble. Par exemple, supposons que vous définissez un dossier appelé MyNewFolder et que vous souhaitez créer ce dossier en tant que ...< ; Username>\AppData\Local\MyApp\MyNewFolder. Fournissez FOLDERID_LocalAppData dans fidParent pour représenter ...< ; Username>\AppData\Local. Indiquez « \MyApp\MyNewFolder » dans pszRelativePath.
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] |
| En-tête | shobjidl_core.h (inclure Shobjidl.h) |
Voir aussi
IKnownFolder ::GetFolderDefinition