Win32 API 日本語リファレンス
ホーム › UI.Shell › IIOCancelInformation

IIOCancelInformation

COM
📘 Microsoft Learn (日本語) · English
IIDf5b0bf81-8cb5-4b1b-9449-1a159e0c733c継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

進捗ダイアログからプロセススレッドへキャンセルウィンドウメッセージをポストするためのメソッドを公開します。

メソッド 2

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

vtbl 3 HRESULT SetCancelInformation(DWORD dwThreadID, DWORD uMsgCancel)

ユーザーが進捗 UI で [キャンセル] を選択したときにポストされる情報を設定します。

dwThreadIDDWORDinキャンセル対象のプロセススレッドの ID です。
uMsgCancelDWORDinスレッドにポストするキャンセルメッセージです。

戻り値

型: HRESULT

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

解説(Remarks)

ユーザーが進捗 UI で [キャンセル] を選択すると、dwThreadID は保留中または将来の入出力 (I/O) 要求をすべてキャンセルします。また、進捗ダイアログから受け取った uMsgCancel メッセージがスレッドにポストされ、非同期 I/O が保留中の場合にスレッドへ待機状態を抜けるよう通知します。

vtbl 4 HRESULT GetCancelInformation(DWORD* pdwThreadID, DWORD* puMsgCancel)

ユーザーが進捗 UI で [キャンセル] を選択したときにポストされる情報を返します。

pdwThreadIDDWORD*outoptionalこのメソッドが返るときに、プロセススレッドの ID へのポインターが格納されます。
puMsgCancelDWORD*outoptionalこのメソッドが返るときに、操作がキャンセルされた場合にプロセススレッドがポストすべき uMsgCancel へのポインターが格納されます。

戻り値

型: 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_IIOCancelInformation "{F5B0BF81-8CB5-4B1B-9449-1A159E0C733C}"
#usecom global IIOCancelInformation IID_IIOCancelInformation "{}"
#comfunc global IIOCancelInformation_SetCancelInformation  3 int,int
#comfunc global IIOCancelInformation_GetCancelInformation  4 var,var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。