IKnownFolderManager::GetFolderByName-Methode (shobjidl_core.h)

  • Artikel

Ruft ein -Objekt ab, das einen bekannten Ordner darstellt, der durch seinen kanonischen Namen identifiziert wird. Mit dem -Objekt können Sie bestimmte Ordnereigenschaften abfragen, den aktuellen Pfad des Ordners abrufen, den Ordner an einen anderen Speicherort umleiten und den Pfad des Ordners als ITEMIDLIST abrufen.

Syntax

HRESULT GetFolderByName(
  [in]  LPCWSTR      pszCanonicalName,
  [out] IKnownFolder **ppkf
);

Parameter

[in] pszCanonicalName

Typ: LPCWSTR

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 Wert wird über das pszName-Element der KNOWNFOLDER_DEFINITION Struktur des Ordners abgerufen.

[out] ppkf

Typ: IKnownFolder**

Wenn diese Methode zurückgibt, enthält die Adresse eines Zeigers auf das IKnownFolder-Objekt , das den bekannten Ordner darstellt.

Rückgabewert

Typ: HRESULT

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

Hinweise

Wann sollte verwendet werden?

Verwenden Sie diese Methode, wenn Sie genau wissen, nach welchem bekannten Ordner Sie suchen und direkt darauf zugreifen möchten.

Anforderungen

Anforderung Wert
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 (einschließlich Shobjidl.h)

Weitere Informationen

IKnownFolderManager

Bekannte Ordner (Beispiel)