ホーム › Networking.BackgroundIntelligentTransferService › IBackgroundCopyCallback3

IBackgroundCopyCallback3

COM

IID98c97bd2-e32b-4ad8-a528-95fd8b16bd42継承元IBackgroundCopyCallback2自前メソッド開始 vtbl7

公式ドキュメント

クライアントは、ファイルの範囲 (レンジ) のダウンロードが完了したことの通知を受け取るために IBackgroundCopyCallback3 インターフェイスを実装します。

メソッド 1

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

vtbl 7 HRESULT FileRangesTransferred(IBackgroundCopyJob* job, IBackgroundCopyFile* file, DWORD rangeCount, BG_FILE_RANGE* ranges)

1 つ以上のファイル範囲がダウンロードされると、BITS は実装した FileRangesTransferred メソッドを呼び出します。ファイル範囲は IBackgroundCopyFile6::RequestFileRanges メソッドを使用してジョブに追加します。

job	IBackgroundCopyJob*	in	ジョブのプロパティ、進行状況、状態の情報にアクセスするためのメソッドを含む IBackgroundCopyJob オブジェクト。pJob を解放しないでください。メソッドが戻るときに BITS がインターフェイスを解放します。
file	IBackgroundCopyFile*	in	範囲が変更されたファイルに関する情報を含む IBackgroundCopyFile オブジェクト。pFile を解放しないでください。メソッドが戻るときに BITS がインターフェイスを解放します。
rangeCount	DWORD	in	ranges 配列内のエントリ数。
ranges	BG_FILE_RANGE*	in	前回の FileRangesTransferred の呼び出し、または前回の IBackgroundCopyFile6::RequestFileRanges メソッドの呼び出し以降に転送されたファイル範囲の配列。ranges を解放しないでください。FileRangesTransferred メソッドが戻るときに BITS が ranges のメモリを解放します。

戻り値

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

解説(Remarks)

このメソッドで返される範囲は、要求した範囲と一致しない場合があります。これは、BITS が同じバイト範囲を 2 回ダウンロードしないためであり、また BITS が範囲の一部がダウンロードされた時点で報告できるためです。

リソース負荷が最大となる条件下では、実装がすべての変更イベントを受け取れない場合があります。

BITS は大量のイベントを生成します。タイマーを作成して状態と進行状況の情報をポーリングするか、このコールバックの使用を制限することを検討してください。このコールバックを使用する場合は、実装を短く保ってください。BITS_JOB_PROPERTY_MINIMUM_NOTIFICATION_INTERVAL プロパティは、要件を満たす範囲でできるだけ大きい値に設定してください。これにより、不要なコールバックの数を減らせます。

注 BITS は、ユーザーごとに最大 4 つの同時通知をサポートします。1 つ以上のアプリケーションがユーザーの 4 つの通知すべてをブロックして戻らない場合、同じユーザーとして実行されているアプリケーションは、ブロックしている通知のいずれかが戻るまで通知を受け取れません。

例

この関数の使用例については、IBackgroundCopyCallback3 インターフェイスのサンプルコードを参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IBackgroundCopyCallback3 "{98C97BD2-E32B-4AD8-A528-95FD8B16BD42}"
#usecom global IBackgroundCopyCallback3 IID_IBackgroundCopyCallback3 "{}"
#comfunc global IBackgroundCopyCallback3_FileRangesTransferred  7 sptr,sptr,int,var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_IBackgroundCopyCallback3 "{98C97BD2-E32B-4AD8-A528-95FD8B16BD42}"
#usecom global IBackgroundCopyCallback3 IID_IBackgroundCopyCallback3 "{}"
#comfunc global IBackgroundCopyCallback3_FileRangesTransferred  7 sptr,sptr,int,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。