Win32 API 日本語リファレンス
ホーム › Networking.BackgroundIntelligentTransferService › IBackgroundCopyJobHttpOptions2

IBackgroundCopyJobHttpOptions2

COM
📘 Microsoft Learn (日本語) · English
IIDb591a192-a405-4fc3-8323-4c5c542578fc継承元IBackgroundCopyJobHttpOptions自前メソッド開始 vtbl11

公式ドキュメント

BITS 転送で使用される HTTP メソッドを取得、またはオーバーライドするために、このインターフェイスを使用します。

メソッド 2

vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。

vtbl 11 HRESULT SetHttpMethod(LPWSTR method)

BITS 転送で使用される既定の HTTP メソッドをオーバーライドします。

methodLPWSTRinHTTP メソッド名を含む、null 終端のワイド文字定数文字列へのポインター。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

BITS では、開発者が既定以外の HTTP メソッドを選択できます。これにより、HTTP サーバーに対する通常の BITS の要件に従わないサーバーとも、BITS がやり取りできる可能性が高まります。既定とは異なる HTTP メソッドを選択する場合は、以下の点に注意してください。

渡したメソッド名が、その転送種別の既定の HTTP メソッドと一致する場合、SetHttpMethod は何も行いません。たとえば、ダウンロードジョブのメソッドに "GET" (既定値) を設定した場合、ジョブの優先度は変更されません。HTTP メソッドは、ジョブを開始する最初の IBackgroundCopyJob::Resume の呼び出しより前に設定する必要があります。
vtbl 12 HRESULT GetHttpMethod(LPWSTR* method)

BITS 転送の HTTP メソッド名を含むワイド文字列を取得します。既定では、ダウンロードジョブは "GET"、アップロードジョブおよびアップロード応答ジョブは "BITS_POST" になります。

methodLPWSTR*outnull 終端のワイド文字列へのポインターのアドレス。成功した場合、このメソッドはポインターを更新し、HTTP メソッド名を含む文字列を指すようにします。この文字列が不要になったら、CoTaskMemFree を呼び出して解放してください。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

HSP用 COM定義

#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。

出力引数: 
#define global IID_IBackgroundCopyJobHttpOptions2 "{B591A192-A405-4FC3-8323-4C5C542578FC}"
#usecom global IBackgroundCopyJobHttpOptions2 IID_IBackgroundCopyJobHttpOptions2 "{}"
#comfunc global IBackgroundCopyJobHttpOptions2_SetHttpMethod  11 wstr
#comfunc global IBackgroundCopyJobHttpOptions2_GetHttpMethod  12 var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。