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

ISimilarityReportProgress

COM
IID96236a7a-9dbc-11da-9e3f-0011114ae311継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

RDC が類似性処理の現在の完了率を報告するためのメソッドを定義します。

メソッド 1

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

vtbl 3 HRESULT ReportProgress(DWORD percentCompleted)

進行中の類似性処理の現在の完了率を報告します。

percentCompletedDWORDinタスクの現在の完了率。有効な範囲は 0 から 100 までです。

戻り値

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

解説(Remarks)

ISimilarity::CopyAndSwap メソッドは、copy-and-swap 処理の進行状況を報告するために ReportProgress メソッドを呼び出します。進行状況の情報を受け取るには、RDC アプリケーションでこのメソッドを実装する必要があります。

このメソッドがどのくらいの頻度で呼び出されるか、また percentCompleted パラメーターが特定の値で呼び出されるかについては、何の保証もありません。たとえば、percentCompleted パラメーターは 0 から始まらない場合があり、100 に達しない場合もあり、同じ値を複数回受け取る場合もあります。ただし、各値は前の値以上であることが保証されています。

アプリケーションが E_FAIL などのエラーコードを返した場合、類似性処理は停止され、そのエラーコードが伝播されます。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_ISimilarityReportProgress "{96236A7A-9DBC-11DA-9E3F-0011114AE311}"
#usecom global ISimilarityReportProgress IID_ISimilarityReportProgress "{}"
#comfunc global ISimilarityReportProgress_ReportProgress  3 int
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。