ホーム › Networking.BackgroundIntelligentTransferService › IBackgroundCopyCallback1

IBackgroundCopyCallback1

COM

IID084f6593-3800-4e08-9b59-99fa59addf82継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

イベントが発生したときに通知を受け取るには、IBackgroundCopyCallback1 インターフェイスを実装します。

メソッド 3

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

vtbl 3 HRESULT OnStatus(IBackgroundCopyGroup* pGroup, IBackgroundCopyJob1* pJob, DWORD dwFileIndex, DWORD dwStatus, DWORD dwNumOfRetries, DWORD dwWin32Result, DWORD dwTransportResult)

グループが完了したとき、またはエラーが発生したときに通知を受け取るには、OnStatus メソッドを実装します。

pGroup	IBackgroundCopyGroup*	in	イベントを生成したグループへのインターフェイスポインター。
pJob	IBackgroundCopyJob1*	in	イベントに関連付けられたジョブへのインターフェイスポインター。イベントがジョブに関連付けられていない場合は NULL。
dwFileIndex	DWORD	in	エラーに関連付けられたファイルのインデックス、または -1。ファイルを取得するには、IBackgroundCopyJob1::GetFile メソッドを呼び出します。
dwStatus	DWORD	in	グループの状態。グループの状態は、完了(グループ内のすべてのジョブがダウンロードされた)またはエラーのいずれかです。QM_STATUS_GROUP_ERROR フラグが設定されている場合はエラーが発生しています。それ以外の場合、グループは完了しています。
dwNumOfRetries	DWORD	in	エラー発生後に QMGR がグループのダウンロードを試行した回数。dwStatus に QM_STATUS_GROUP_ERROR フラグが設定されている場合にのみ有効です。
dwWin32Result	DWORD	in	Win32 エラーコード。dwStatus に QM_STATUS_GROUP_ERROR フラグが設定されている場合にのみ有効です。
dwTransportResult	DWORD	in	HTTP エラーコード。dwStatus に QM_STATUS_GROUP_ERROR フラグが設定されている場合にのみ有効です。

戻り値

このメソッドは S_OK を返す必要があります。そうでない場合、S_OK が返されるまでサービスはこのメソッドを呼び出し続けます。実装が呼び出される間隔は任意です。

vtbl 4 HRESULT OnProgress(DWORD ProgressType, IBackgroundCopyGroup* pGroup, IBackgroundCopyJob1* pJob, DWORD dwFileIndex, DWORD dwProgressValue)

ProgressType	DWORD	in	報告される進捗の種類を示す値。
pGroup	IBackgroundCopyGroup*	in	進捗が報告されたグループを表すIBackgroundCopyGroupポインタ。
pJob	IBackgroundCopyJob1*	in	進捗が報告されたジョブを表すIBackgroundCopyJob1ポインタ。
dwFileIndex	DWORD	in	進捗に関連するファイルのインデックス。
dwProgressValue	DWORD	in	進捗の度合いを示す数値。

vtbl 5 HRESULT OnProgressEx(DWORD ProgressType, IBackgroundCopyGroup* pGroup, IBackgroundCopyJob1* pJob, DWORD dwFileIndex, DWORD dwProgressValue, DWORD dwByteArraySize, BYTE* pByte)

ProgressType	DWORD	in	報告される進捗の種類を示す値。
pGroup	IBackgroundCopyGroup*	in	進捗が報告されたグループを表すIBackgroundCopyGroupポインタ。
pJob	IBackgroundCopyJob1*	in	進捗が報告されたジョブを表すIBackgroundCopyJob1ポインタ。
dwFileIndex	DWORD	in	進捗に関連するファイルのインデックス。
dwProgressValue	DWORD	in	進捗の度合いを示す数値。
dwByteArraySize	DWORD	in	pByteが指す追加データのバイト数。
pByte	BYTE*	in	進捗に付随する追加バイトデータへのポインタ。

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