IShellTaskScheduler
COM公式ドキュメント
IShellTaskScheduler は変更されるか、利用できなくなる可能性があります。
解説(Remarks)
このインターフェイスは、キュー内の項目がスケジューラおよびタスクスケジューラが作成されたメインの実行スレッドの両方とやり取りする場合を除き、フリースレッド化されている必要はありません。
このインターフェイスのクラス識別子 (CLSID) は CLSID_ShellTaskScheduler で、その IID は IID_IShellTaskScheduler です。
Windows Server 2003 および Windows XP: IShellTaskScheduler は Shlobj.h で宣言されていました。
メソッド 4
vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。
スケジューラのバックグラウンドキューにタスクを追加します。
| prt | IRunnableTask* | in | キューに追加するタスクを表す IRunnableTask インターフェイスのインスタンスへのポインター。 |
| rtoid | GUID* | in | タスクの所有者を識別する GUID。この情報は、後で所有者別にタスクをカウントしたり削除したりするためにタスクをグループ化する目的で使用できます。 |
| lParam | UINT_PTR | in | rtoid が所有するタスクの中でタスクを識別できるようにする、ユーザー定義の DWORD 値へのポインター。これは、個々のタスクを識別したり、それらをサブグループ化したりするために使用します。たとえば、ListView 内の項目などの特定の項目とタスクを関連付ける場合などです。このパラメーターは 0 でもかまいません。 |
| dwPriority | DWORD | in | タスクの優先度を割り当てる次の値のいずれか。この優先度への対応は、実行中の他のタスクの協調に依存します。新しいタスクは優先度順にキューへ挿入されます。低い優先度のタスクが実行中に、より高い優先度のタスクが追加された場合、スケジューラは実行中のタスクを中断しようとします。その低い優先度のタスクは、より高い優先度のタスクが完了したときに再開されます。 ITSAT_DEFAULT_PRIORITYスケジューラがタスクに割り当てる既定の優先度を受け入れます。 ITSAT_MAX_PRIORITY高優先度。 ITSAT_MIN_PRIORITY低優先度。 |
戻り値
型: HRESULT
このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。
スケジューラのバックグラウンドキューからタスクを削除します。
| rtoid | GUID* | in | 削除するタスクの所有者を識別する GUID。 |
| lParam | UINT_PTR | in | rtoid が所有するタスクの中でタスクを識別できるようにする、ユーザー定義の DWORD 値へのポインター。rtoid で指定された所有者のすべてのタスクを削除するには、この値を 0 に設定します。 |
| bWaitIfRunning | BOOL | in | 実行中のタスクを削除する前に完了させたい場合は TRUE、そうでない場合は FALSE。 |
戻り値
型: HRESULT
このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。
スケジューラのキュー内で同じ所有者 ID を持つタスクをカウントします。
| rtoid | GUID* | in | タスクの所有者を識別する GUID。特定の ID を指定すると、その所有者 ID でタグ付けされたタスクのみがカウントされます。キュー内のすべての項目をカウントするには、TOID_NULL を渡します。 |
戻り値
型: HRESULT
このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。
現在のタスクのリリースステータスとバックグラウンドスレッドのタイムアウトを設定します。
| dwReleaseStatus | DWORD | in | 次のフラグまたは 0。 ITSSFLAG_KILL_ON_DESTROYIShellTaskScheduler インスタンスが解放されたときに、現在のタスクの実行を直ちに停止します。 |
| dwThreadTimeout | DWORD | in | 使用されません。 |
戻り値
型: HRESULT
このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
HSP用 COM定義
#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。
#define global IID_IShellTaskScheduler "{6CCB7BE0-6807-11D0-B810-00C04FD706EC}" #usecom global IShellTaskScheduler IID_IShellTaskScheduler "{}" #comfunc global IShellTaskScheduler_AddTask 3 sptr,var,sptr,int #comfunc global IShellTaskScheduler_RemoveTasks 4 var,sptr,int #comfunc global IShellTaskScheduler_CountTasks 5 var #comfunc global IShellTaskScheduler_Status 6 int,int ; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。 ; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。 ; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。 ; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_IShellTaskScheduler "{6CCB7BE0-6807-11D0-B810-00C04FD706EC}" #usecom global IShellTaskScheduler IID_IShellTaskScheduler "{}" #comfunc global IShellTaskScheduler_AddTask 3 sptr,sptr,sptr,int #comfunc global IShellTaskScheduler_RemoveTasks 4 sptr,sptr,int #comfunc global IShellTaskScheduler_CountTasks 5 sptr #comfunc global IShellTaskScheduler_Status 6 int,int ; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。 ; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。 ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。 ; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。