IBackgroundCopyJobHttpOptions::GetCustomHeaders メソッド (bits2_5.h)
IBackgroundCopyJobHttpOptions::SetCustomHeaders の以前の呼び出しによって設定されたカスタム ヘッダーを取得します (つまり、BITS がリモートから受信するヘッダーではなく、リモートに送信する BITS のヘッダー)。
構文
HRESULT GetCustomHeaders(
[out] LPWSTR *pRequestHeaders
);
パラメーター
[out] pRequestHeaders
カスタム ヘッダーを含む Null で終わる文字列。 各ヘッダーは、復帰と改行 (CR/LF) 文字で終了します。 完了時に文字列を解放するには、 CoTaskMemFree 関数を呼び出します。
戻り値
次の表に、可能な戻り値の一部を示します。
| リターン コード | 説明 |
|---|---|
|
ヘッダーが正常に取得されました。 |
|
ジョブでカスタム ヘッダーが指定されていません。 |
|
カスタム ヘッダーを取得するアクセス許可がないか、[IBackgroundCopyJobHttpOptions3::MakeCustomHeadersWriteOnly](/windows/desktop/api/bits10_3/nf-bits10_3-ibackgroundcopyjobhttpoptions3-makecustomheaderswriteonly) がジョブで呼び出されました。 |
|
pRequestHeaders パラメーターは NULL です。 |
注釈
ジョブ所有者のみがカスタム ヘッダーを取得できます。 ヘッダーを指定するには、 IBackgroundCopyJobHttpOptions::SetCustomHeaders メソッドを 呼び出します。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows Vista |
| サポートされている最小のサーバー | Windows Server 2008 |
| 対象プラットフォーム | Windows |
| ヘッダー | bits2_5.h (Bits.h を含む) |
| Library | Bits.lib |