IKnownFolderManager::Redirect-Methode (shobjidl_core.h)

  • Artikel

Leitet Ordneranforderungen für allgemeine Ordner und benutzerspezifische Ordner um.

Syntax

HRESULT Redirect(
  [in]           REFKNOWNFOLDERID    rfid,
  [in, optional] HWND                hwnd,
  [in]           KF_REDIRECT_FLAGS   flags,
  [in, optional] LPCWSTR             pszTargetPath,
  [in]           UINT                cFolders,
  [in]           const KNOWNFOLDERID *pExclusion,
  [out]          LPWSTR              *ppszError
);

Parameter

[in] rfid

Typ: REFKNOWNFOLDERID

Ein Verweis auf die KNOWNFOLDERID des ordners, der umgeleitet werden soll.

[in, optional] hwnd

Typ: HWND

Das Handle des übergeordneten Fensters, das zum Anzeigen von Dialogfeldern zum Kopieren des Modulstatus verwendet wird, wenn KF_REDIRECT_WITH_UI im Flags-Parameter übergeben wird. Wenn kein Statusdialogfeld erforderlich ist, kann dieser Wert NULL sein.

[in] flags

Typ: KF_REDIRECT_FLAGS

Die KF_REDIRECT_FLAGS Optionen für die Umleitung.

[in, optional] pszTargetPath

Typ: LPCWSTR

Ein Zeiger auf den neuen Pfad für den Ordner. Dies ist eine Unicode-Zeichenfolge mit Null-Beendigung. Dieser Wert kann NULL sein.

[in] cFolders

Typ: UINT

Die Anzahl der KNOWNFOLDERID-Werte im Array bei pExclusion.

[in] pExclusion

Typ: KNOWNFOLDERID const*

Zeiger auf ein Array von KNOWNFOLDERID-Werten , die auf Unterordner von rfid verweisen, die von der Umleitung ausgeschlossen werden sollten. Wenn keine Unterordner ausgeschlossen werden, kann dieser Wert NULL sein.

[out] ppszError

Typ: LPWSTR*

Wenn diese Methode zurückgibt, enthält die Adresse eines Zeigers auf eine Unicode-Zeichenfolge mit Null-Beendigung, die eine Fehlermeldung enthält, falls eine generiert wurde. Dieser Wert kann NULL sein.

Rückgabewert

Typ: HRESULT

Gibt bei erfolgreicher Ausführung S_OK oder andernfalls einen Fehlerwert zurück, einschließlich der folgenden:

Rückgabecode Beschreibung
E_INVALIDARG
 Dieser Wert kann unter anderem angeben, dass der rfid-Parameter auf eine KNOWNFOLDERID verweist, die im System nicht vorhanden ist. Nicht alle KNOWNFOLDERID-Werte sind auf allen Systemen vorhanden. Verwenden Sie IKnownFolderManager::GetFolderIds , um den Satz von KNOWNFOLDERID-Werten für das aktuelle System abzurufen.

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)