IKnownFolderManager::Redirect メソッド (shobjidl_core.h)
共通フォルダーとユーザー単位フォルダーのフォルダー要求をリダイレクトします。
構文
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
);
パラメーター
[in] rfid
型: REFKNOWNFOLDERID
リダイレクトするフォルダーの KNOWNFOLDERID への参照。
[in, optional] hwnd
型: HWND
flags パラメーターに KF_REDIRECT_WITH_UIが渡されたときに、コピー エンジンの進行状況 UI ダイアログを表示するために使用される親ウィンドウのハンドル。 進行状況ダイアログが必要ない場合は、この値を NULL にすることができます。
[in] flags
リダイレクトの KF_REDIRECT_FLAGS オプション。
[in, optional] pszTargetPath
種類: LPCWSTR
フォルダーの新しいパスへのポインター。 これは null で終わる Unicode 文字列です。 この値には NULL を指定できます。
[in] cFolders
型: UINT
pExclusion にある配列内の KNOWNFOLDERID 値の数。
[in] pExclusion
型: KNOWNFOLDERID const*
リダイレクトから除外する必要がある rfid のサブフォルダーを参照する KNOWNFOLDERID 値の配列へのポインター。 サブフォルダーが除外されていない場合、この値は NULL にすることができます。
[out] ppszError
種類: LPWSTR*
このメソッドが戻るときに、 には、null で終わる Unicode 文字列へのポインターのアドレスが格納されます。この文字列には、生成された場合にエラー メッセージが含まれます。 この値には NULL を指定できます。
戻り値
型: HRESULT
成功した場合はS_OKを返し、それ以外の場合は次のようなエラー値を返します。
リターン コード | 説明 |
---|---|
|
特に、この値は 、rfid パラメーターがシステムに存在しない KNOWNFOLDERID を 参照していることを示している可能性があります。 すべての KNOWNFOLDERID 値がすべてのシステムに存在するわけではありません。 現在のシステムの KNOWNFOLDERID 値のセットを取得するには、IKnownFolderManager::GetFolderIds を使用します。 |
要件
要件 | 値 |
---|---|
サポートされている最小のクライアント | Windows Vista [デスクトップ アプリのみ] |
サポートされている最小のサーバー | Windows Server 2008 [デスクトップ アプリのみ] |
対象プラットフォーム | Windows |
ヘッダー | shobjidl_core.h (Shobjidl.h を含む) |