ホーム › System.TaskScheduler › ITaskHandler

ITaskHandler

COM

📘 Microsoft Learn (日本語) · English

IID839d7762-5121-4009-9234-4f0d19394f04継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

タスクスケジューラサービスが COM ハンドラーを管理するために呼び出すメソッドを定義します。

メソッド 4

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

vtbl 3 HRESULT Start(IUnknown* pHandlerServices, LPWSTR data)

COM ハンドラーを開始するために呼び出されます。

pHandlerServices	IUnknown*	inoptional	タスクスケジューラと双方向に通信するために使用される IUnkown インターフェイスです。
data	LPWSTR	in	ハンドラーが必要とする引数です。これらの引数は、COM ハンドラーアクションの Data プロパティで定義されます。

戻り値

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

解説(Remarks)

このメソッドを実装する際、ハンドラーは(インプロセスの場合は独自のスレッドを開始したうえで)直ちに制御をタスクスケジューラに返す必要があります。

ハンドラーは処理を開始した後、UpdateStatus メソッドを呼び出して完了率を示したり、TaskCompleted メソッドを呼び出してハンドラーが処理を完了したことを示したりできます。これらのメソッドは ITaskHandlerStatus インターフェイスによって提供されます。

vtbl 4 HRESULT Stop(HRESULT* pRetCode)

COM ハンドラーを停止するために呼び出されます。

pRetCode

HRESULT*

out

COM ハンドラーアクションが完了したときに、タスクスケジューラがイベントとして発生させる戻りコードです。

戻り値

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

vtbl 5 HRESULT Pause()

COM ハンドラーを一時停止するために呼び出されます。

戻り値

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

vtbl 6 HRESULT Resume()

COM ハンドラーを再開するために呼び出されます。

戻り値

このメソッドが成功した場合は 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_ITaskHandler "{839D7762-5121-4009-9234-4F0D19394F04}"
#usecom global ITaskHandler IID_ITaskHandler "{}"
#comfunc global ITaskHandler_Start   3 sptr,wstr
#comfunc global ITaskHandler_Stop    4 var
#comfunc global ITaskHandler_Pause   5
#comfunc global ITaskHandler_Resume  6
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_ITaskHandler "{839D7762-5121-4009-9234-4F0D19394F04}"
#usecom global ITaskHandler IID_ITaskHandler "{}"
#comfunc global ITaskHandler_Start   3 sptr,wstr
#comfunc global ITaskHandler_Stop    4 sptr
#comfunc global ITaskHandler_Pause   5
#comfunc global ITaskHandler_Resume  6
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。