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

IObjectWithCancelEvent

COM
IIDf279b885-0ae9-4b85-ac06-ddecf9408941継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

サポートされていません。呼び出し元に対して、タスクのキャンセルを通知するために呼び出し先オブジェクトによってシグナル状態にされるイベントを提供します。

メソッド 1

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

vtbl 3 HRESULT GetCancelEvent(HANDLE* phEvent)

操作がキャンセルされたときに送信されるイベントを取得します。

phEventHANDLE*outこのメソッドが正常に終了したときに、キャンセルイベントのハンドルとなるハンドルへのポインター。呼び出し元は、このハンドルが不要になった時点でクローズする責任があります。

戻り値

型: HRESULT

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

解説(Remarks)

呼び出し先オブジェクトが実行中の操作をキャンセルしたときにシグナル状態になるイベントを取得するには、この関数を呼び出します。呼び出し元は、返されたハンドルをクローズする責任があります。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IObjectWithCancelEvent "{F279B885-0AE9-4B85-AC06-DDECF9408941}"
#usecom global IObjectWithCancelEvent IID_IObjectWithCancelEvent "{}"
#comfunc global IObjectWithCancelEvent_GetCancelEvent  3 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。