IKnownFolder::GetFolderDefinition-Methode (shobjidl_core.h)

  • Artikel

Ruft eine Struktur ab, die die definierenden Elemente eines bekannten Ordners enthält, einschließlich der Kategorie, des Namens, des Pfads, der Beschreibung, der QuickInfo, des Symbols und anderer Eigenschaften des Ordners.

Syntax

HRESULT GetFolderDefinition(
  [out] KNOWNFOLDER_DEFINITION *pKFD
);

Parameter

[out] pKFD

Typ: KNOWNFOLDER_DEFINITION*

Wenn diese Methode zurückgibt, enthält einen Zeiger auf die KNOWNFOLDER_DEFINITION-Struktur . Wenn sie nicht mehr benötigt wird, ist die aufrufende Anwendung dafür verantwortlich, FreeKnownFolderDefinitionFields aufzurufen, um diese Ressource frei zu geben.

Rückgabewert

Typ: HRESULT

Wenn diese Methode erfolgreich ist, wird S_OK zurückgegeben. Andernfalls wird ein Fehlercode HRESULT zurückgegeben.

Hinweise

Wenn eine Drittanbieteranwendung einen eigenen bekannten Ordner erstellt, wird dieser mit einer KNOWNFOLDER_DEFINITION-Struktur definiert und dann beim System registriert. Alle registrierten informationen zur Definition bekannter Ordner – vom System bereitgestellt oder von der Anwendung erstellt – können mit dieser Methode abgerufen werden.

Um diese Methode aufrufen zu können, muss der Aufrufer mindestens über Benutzerberechtigungen verfügen.

Anforderungen

   
Unterstützte Mindestversion (Client) Windows Vista [nur Desktop-Apps]
Unterstützte Mindestversion (Server) Windows Server 2008 [nur Desktop-Apps]
Zielplattform Windows
Kopfzeile shobjidl_core.h (shobjidl.h einschließen)

Weitere Informationen

IKnownFolder

Bekannte Ordner (Beispiel)