IKnownFolder::SetPath-Methode (shobjidl_core.h)

  • Artikel

Weist einem bekannten Ordner einen neuen Pfad zu.

Syntax

HRESULT SetPath(
  [in] DWORD   dwFlags,
  [in] LPCWSTR pszPath
);

Parameter

[in] dwFlags

Art: DWORD

Entweder null oder der folgende Wert:

KF_FLAG_DONT_UNEXPAND

Legen Sie den vollständigen Pfad ohne Umgebungszeichenfolgen fest. Wenn dieses Flag nicht festgelegt ist, können Teile des Pfads in pszPath durch Umgebungszeichenfolgen wie %USERPROFILE%dargestellt werden.

[in] pszPath

Typ: LPCWSTR

Zeiger auf den neuen Pfad des Ordners. Hierbei handelt es sich um eine unicode-Zeichenfolge mit null-Endung der Länge MAX_PATH. Dieser Pfad darf keine Länge von 0 sein. Wenn dieser Wert NULL ist, legt IKnownFolder::SetPath den Pfad auf den Standardwert fest.

Rückgabewert

Typ: HRESULT

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

Hinweise

Diese Methode kann nicht für Ordner vom Typ KF_CATEGORY_FIXED oder KF_CATEGORY_VIRTUAL aufgerufen werden.

Um diese Methode in einem Ordner vom Typ KF_CATEGORY_COMMON aufzurufen, muss die aufrufende Anwendung mit erhöhten Rechten ausgeführt werden.

Diese Methode entspricht SHSetKnownFolderPath.

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)
DLL Shell32.dll

Weitere Informationen

IKnownFolder

Bekannte Ordner (Beispiel)

SHSetKnownFolderPath