Win32 API 日本語リファレンス
ホーム › Storage.OfflineFiles › IOfflineFilesProgress

IOfflineFilesProgress

COM
📘 Microsoft Learn (日本語) · English
IIDfad63237-c55b-4911-9850-bcf96d4c979e継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

時間のかかるオフラインファイル操作の呼び出し元に対して、進行状況を報告するために使用します。(IOfflineFilesProgress)

メソッド 3

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

vtbl 3 HRESULT Begin(BOOL* pbAbort)

操作が開始されたことを報告します。

pbAbortBOOL*out操作を取り消すには、この値に TRUE を設定します。 続行する場合は FALSE を設定します。

戻り値

戻り値は無視されます。

vtbl 4 HRESULT QueryAbort(BOOL* pbAbort)

時間のかかる操作の実行中に呼び出され、操作を取り消すべきかどうかを判断します。

pbAbortBOOL*out操作を取り消すには、この値に TRUE を設定します。 続行する場合は FALSE を設定します。

戻り値

戻り値は無視されます。

解説(Remarks)

このメソッドは、他の進行状況メソッドの呼び出し頻度が低い場合に、実装側で使用できます。このメソッドの唯一の目的は、操作を直ちに取り消すべきかどうかを判断することです。

vtbl 5 HRESULT End(HRESULT hrResult)

操作が終了したことを報告します。

hrResultHRESULTin操作全体の結果を示します。操作が正常に完了した場合は S_OK、操作が取り消された場合は HRESULT_FROM_WIN32(ERROR_CANCELLED)、それ以外の場合はエラー値が格納されます。

戻り値

戻り値は無視されます。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IOfflineFilesProgress "{FAD63237-C55B-4911-9850-BCF96D4C979E}"
#usecom global IOfflineFilesProgress IID_IOfflineFilesProgress "{}"
#comfunc global IOfflineFilesProgress_Begin       3 var
#comfunc global IOfflineFilesProgress_QueryAbort  4 var
#comfunc global IOfflineFilesProgress_End         5 int
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。