IRunningTask
COMIDispatch (デュアル)comobj 経由でメソッド名による遅延バインド呼び出しができます(vtableインデックス不要)。公式ドキュメント
実行中のタスクから情報を取得し、そのタスクを制御するためのメソッドを提供します。
メソッド 8
vtbl = vtable インデックス(0始まり)。IDispatch 実装のため HSP ではメソッド名でも呼べます(上記)。低レベルの index 呼び出し用に vtbl も掲載。0〜2 は IUnknown。
タスクの名前を取得します。
| pName | LPWSTR* | out | 実行中タスクの名前を受け取る出力ポインタである。SysFreeString で解放する。 |
解説(Remarks)
プロパティ値が返される前に IRunningTask::Refresh メソッドが呼び出されます。
このタスクのインスタンスの GUID 識別子を取得します。
| pGuid | LPWSTR* | out | 実行中タスクインスタンスを識別する GUID 文字列を受け取る出力ポインタである。SysFreeString で解放する。 |
解説(Remarks)
プロパティ値が返される前に IRunningTask::Refresh メソッドが呼び出されます。
タスクが格納されている場所へのパスを取得します。
| pPath | LPWSTR* | out | 実行中タスクの登録パスを受け取る出力ポインタである。SysFreeString で解放する。 |
解説(Remarks)
プロパティ値が返される前に IRunningTask::Refresh メソッドが呼び出されます。
実行中のタスクの状態を表す識別子を取得します。
| pState | TASK_STATE* | out | 実行中タスクの現在の状態を表す TASK_STATE 値を受け取る変数へのポインタである。 |
解説(Remarks)
プロパティ値が返される前に IRunningTask::Refresh メソッドが呼び出されます。
実行中のタスクが現在実行しているアクションの名前を取得します。
| pName | LPWSTR* | out | 現在実行中のアクションの名前を受け取る出力ポインタである。SysFreeString で解放する。 |
解説(Remarks)
プロパティ値が返される前に IRunningTask::Refresh メソッドが呼び出されます。
このタスクのインスタンスを停止します。
戻り値
このメソッドは、次のいずれかの値を返すことがあります。
| Return code | Description |
|---|---|
| タスクが停止されました。 | |
| ユーザーにタスクを停止する権限がない、タスクが無効になっている、またはタスクをオンデマンドで実行することが許可されていません。 |
タスクのすべてのローカルインスタンス変数を更新します。
戻り値
このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。
タスクを実行しているエンジン(プロセス)のプロセス ID を取得します。
| pPID | DWORD* | out | タスクをホストしているエンジンのプロセス ID を受け取る変数へのポインタである。 |
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
HSP用 COM定義
#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。
#define global IID_IRunningTask "{653758FB-7B9A-4F1E-A471-BEEB8E9B834E}" #usecom global IRunningTask IID_IRunningTask "{}" #comfunc global IRunningTask_get_Name 7 var #comfunc global IRunningTask_get_InstanceGuid 8 var #comfunc global IRunningTask_get_Path 9 var #comfunc global IRunningTask_get_State 10 var #comfunc global IRunningTask_get_CurrentAction 11 var #comfunc global IRunningTask_Stop 12 #comfunc global IRunningTask_Refresh 13 #comfunc global IRunningTask_get_EnginePID 14 var ; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。 ; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。 ; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。 ; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。#define global IID_IRunningTask "{653758FB-7B9A-4F1E-A471-BEEB8E9B834E}" #usecom global IRunningTask IID_IRunningTask "{}" #comfunc global IRunningTask_get_Name 7 sptr #comfunc global IRunningTask_get_InstanceGuid 8 sptr #comfunc global IRunningTask_get_Path 9 sptr #comfunc global IRunningTask_get_State 10 sptr #comfunc global IRunningTask_get_CurrentAction 11 sptr #comfunc global IRunningTask_Stop 12 #comfunc global IRunningTask_Refresh 13 #comfunc global IRunningTask_get_EnginePID 14 sptr ; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。 ; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。 ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。 ; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。