KNOWNFOLDER_DEFINITION-Struktur (shobjidl_core.h)
Definiert die Besonderheiten eines bekannten Ordners.
Syntax
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;
Member
category
Typ: KF_CATEGORY
Ein einzelner Wert aus dem KF_CATEGORY Konstanten, der den Ordner als virtual, fixed, common oder pro Benutzer klassifiziert.
pszName
Typ: LPWSTR
Ein Zeiger auf den nicht lokalisierten kanonischen Namen für den bekannten Ordner, der als Unicode-Zeichenfolge mit NULL-Beendigung gespeichert ist. Wenn es sich bei diesem Ordner um einen allgemeinen Ordner oder einen Ordner pro Benutzer handelt, wird dieser Wert auch als Wertname der Registrierungseinstellungen "Benutzershellordner" verwendet. Dieser Name soll ein eindeutiger, lesbarer Name sein. Drittanbietern wird empfohlen, das Format Company.Application.Name
zu verwenden. Der hier angegebene Name sollte nicht mit dem Anzeigenamen verwechselt werden.
pszDescription
Typ: LPWSTR
Ein Zeiger auf eine kurze Beschreibung des bekannten Ordners, der als Unicode-Zeichenfolge mit Null-Endung gespeichert ist. Diese Beschreibung sollte den Zweck und die Verwendung des Ordners enthalten.
fidParent
Typ: KNOWNFOLDERID
Ein KNOWNFOLDERID-Wert , der einen anderen bekannten Ordner als übergeordneten Ordner bezeichnet. Gilt nur für allgemeine Ordner und benutzerspezifische Ordner. Dieser Wert wird in Verbindung mit pszRelativePath verwendet. Weitere Informationen finden Sie unter Hinweise .
Dieser Wert ist optional, wenn für pszRelativePath kein Wert bereitgestellt wird.
pszRelativePath
Typ: LPWSTR
Optional. Ein Zeiger auf einen Pfad relativ zum übergeordneten Ordner, der in fidParent angegeben ist. Dies ist eine Unicode-Zeichenfolge mit NULL-Beendigung, verweist auf den pfad des physischen Dateisystems und ist nicht lokalisiert. Gilt nur für allgemeine Ordner und benutzerspezifische Ordner. Weitere Informationen finden Sie unter Hinweise .
pszParsingName
Typ: LPWSTR
Ein Zeiger auf den Ordnerpfad des Shell-Namespaces des Ordners, der als Unicode-Zeichenfolge mit Null-Endung gespeichert ist. Gilt nur für virtuelle Ordner. Hat z. B. Control Panel
den Analysenamen ::%CLSID_MyComputer%::%CLSID_ControlPanel%
.
pszTooltip
Typ: LPWSTR
Optional. Ein Zeiger auf die Standard-QuickInfo-Ressource, die für diesen bekannten Ordner verwendet wird, wenn sie erstellt wird. Hierbei handelt es sich um eine mit NULL beendete Unicode-Zeichenfolge in dieser Form:
Modulname, Ressourcen-ID
@%_SYS_MOD_PATH%,-12688
Beispielsweise ist die QuickInfo für allgemeine Bilder. Wenn der Ordner erstellt wird, wird diese Zeichenfolge in der Kopie dieses Ordners Desktop.ini gespeichert. Sie kann später von anderen Shell-APIs geändert werden. Diese Ressource kann lokalisiert sein.
Diese Informationen sind für virtuelle Ordner nicht erforderlich.
pszLocalizedName
Typ: LPWSTR
Optional. Ein Zeiger auf die standardmäßig lokalisierte Namensressource, die beim Erstellen des Ordners verwendet wird. Hierbei handelt es sich um eine mit NULL beendete Unicode-Zeichenfolge in dieser Form:
Modulname, Ressourcen-ID
Wenn der Ordner erstellt wird, wird diese Zeichenfolge in der Kopie dieses Ordners Desktop.ini gespeichert. Sie kann später von anderen Shell-APIs geändert werden.
Diese Informationen sind für virtuelle Ordner nicht erforderlich.
pszIcon
Typ: LPWSTR
Optional. Ein Zeiger auf die Standardsymbolressource, die beim Erstellen des Ordners verwendet wird. Hierbei handelt es sich um eine mit NULL beendete Unicode-Zeichenfolge in dieser Form:
Modulname, Ressourcen-ID
Wenn der Ordner erstellt wird, wird diese Zeichenfolge in der Kopie dieses Ordners Desktop.ini gespeichert. Sie kann später von anderen Shell-APIs geändert werden.
Diese Informationen sind für virtuelle Ordner nicht erforderlich.
pszSecurity
Typ: LPWSTR
Optional. Ein Zeiger auf eine Formatzeichenfolge der Sicherheitsdeskriptordefinitionssprache . Hierbei handelt es sich um eine Unicode-Zeichenfolge mit Null-Beendigung, die die Standardsicherheitsbeschreibung beschreibt, die der Ordner beim Erstellen empfängt. Wenn dieser Parameter NULL ist, erbt der neue Ordner die Sicherheitsbeschreibung des übergeordneten Ordners. Dies ist besonders nützlich für allgemeine Ordner, auf die alle Benutzer zugreifen.
dwAttributes
Art: DWORD
Optional. Standarddateisystemattribute, die dem Ordner beim Erstellen zugewiesen werden. Beispielsweise könnte die Datei ausgeblendet und schreibgeschützt sein (FILE_ATTRIBUTE_HIDDEN und FILE_ATTRIBUTE_READONLY). Eine vollständige Liste der möglichen Werte finden Sie im dwFlagsAndAttributes-Parameter der CreateFile-Funktion . Legen Sie bei Bedarf auf -1 fest.
kfdFlags
Typ: KF_DEFINITION_FLAGS
Optional. Einer von weiteren Werten aus der KF_DEFINITION_FLAGS Enumeration, mit denen Sie die Umleitung einschränken, das Roaming von PC zu PC zulassen und den Zeitpunkt steuern können, zu dem der bekannte Ordner erstellt wird. Legen Sie bei Bedarf auf 0 fest.
ftidType
Typ: FOLDERTYPEID
Einer der FOLDERTYPEID-Werte , der den bekannten Ordnertyp basierend auf seinem Inhalt (z. B. Dokumente, Musik oder Fotos) identifiziert. Dieser Wert ist eine GUID.
Hinweise
Die Werte fidParent und pszRelativePath arbeiten zusammen. Angenommen, Sie definieren einen Ordner namens MyNewFolder und möchten diesen Ordner als ...< Username>\AppData\Local\MyApp\MyNewFolder. Geben Sie FOLDERID_LocalAppData in fidParent an, um ...< Benutzername>\AppData\Local. Geben Sie "\MyApp\MyNewFolder" in pszRelativePath an.
Anforderungen
Anforderung | Wert |
---|---|
Unterstützte Mindestversion (Client) | Windows Vista [nur Desktop-Apps] |
Unterstützte Mindestversion (Server) | Windows Server 2008 [nur Desktop-Apps] |
Kopfzeile | shobjidl_core.h (einschließlich Shobjidl.h) |
Weitere Informationen
IKnownFolder::GetFolderDefinition