Win32 API 日本語リファレンス
ホーム › System.TaskScheduler › ITaskHandlerStatus

ITaskHandlerStatus

COM
📘 Microsoft Learn (日本語) · English
IIDeaec7a8f-27a0-4ddc-8675-14726a01a38a継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

COM ハンドラーがハンドラーの状態を Task Scheduler に通知するために使用するメソッドを提供します。

解説(Remarks)

COM ハンドラーアクションの指定方法については、IComHandlerAction インターフェイスを参照してください。

ハンドラーが実装する必要がある必須インターフェイスについては、ITaskHandler インターフェイスを参照してください。

メソッド 2

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

vtbl 3 HRESULT UpdateStatus(SHORT percentComplete, LPWSTR statusMessage)

COM ハンドラーの完了率を Task Scheduler に通知します。

percentCompleteSHORTinCOM ハンドラーの完了率を示す値です。
statusMessageLPWSTRinTask Scheduler の UI に表示されるメッセージです。

戻り値

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

vtbl 4 HRESULT TaskCompleted(HRESULT taskErrCode)

COM ハンドラーが完了したことを Task Scheduler に通知します。

taskErrCodeHRESULTinTask Scheduler がイベントとして発生させるエラーコードです。

戻り値

このメソッドが成功した場合は 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_ITaskHandlerStatus "{EAEC7A8F-27A0-4DDC-8675-14726A01A38A}"
#usecom global ITaskHandlerStatus IID_ITaskHandlerStatus "{}"
#comfunc global ITaskHandlerStatus_UpdateStatus   3 int,wstr
#comfunc global ITaskHandlerStatus_TaskCompleted  4 int
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。