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

IIdleSettings

COMIDispatch (デュアル)
📘 Microsoft Learn (日本語) · English
✅ IDispatch を実装(デュアルインターフェース)。HSP では comobj 経由でメソッド名による遅延バインド呼び出しができます(vtableインデックス不要)。
IID84594461-0053-4342-a8fd-088fabf11f32継承元IDispatch呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl7

公式ドキュメント

コンピューターがアイドル状態にあるときに Task Scheduler がタスクをどのように実行するかを指定します。

解説(Remarks)

タスクの XML を読み書きする際、この設定は Task Scheduler スキーマの IdleSettings 要素で指定されます。

タスクがアイドルトリガーによって起動される場合、IIdleSettings インターフェイスの WaitTimeout プロパティは無視されます。

例

このインターフェイスの詳細情報とサンプルコードについては、Time Trigger Example (C++) を参照してください。

メソッド 8

vtbl = vtable インデックス(0始まり)。IDispatch 実装のため HSP ではメソッド名でも呼べます(上記)。低レベルの index 呼び出し用に vtbl も掲載。0〜2 は IUnknown。

vtbl 7 HRESULT get_IdleDuration(LPWSTR* pDelay)

タスクが実行される前にコンピューターがアイドル状態でなければならない時間の長さを示す値を取得または設定します。(Get)

pDelayLPWSTR*inoutアイドルと判定するまでの継続時間を表す文字列を受け取る文字列ポインタへのポインタである。

解説(Remarks)

タスクの XML を読み書きする際、この設定は Task Scheduler スキーマの Duration 要素で指定されます。

vtbl 8 HRESULT put_IdleDuration(LPWSTR delay)

タスクが実行される前にコンピューターがアイドル状態でなければならない時間の長さを示す値を取得または設定します。(Put)

delayLPWSTRinアイドルと判定するまでの継続時間を ISO8601 期間文字列で指定する。

解説(Remarks)

タスクの XML を読み書きする際、この設定は Task Scheduler スキーマの Duration 要素で指定されます。

vtbl 9 HRESULT get_WaitTimeout(LPWSTR* pTimeout)

Task Scheduler がアイドル状態の発生を待機する時間の長さを示す値を取得または設定します。(Get)

pTimeoutLPWSTR*inoutアイドル状態になるのを待機する最大時間を表す文字列を受け取る文字列ポインタへのポインタである。

解説(Remarks)

タスクの XML を読み書きする際、この設定は Task Scheduler スキーマの WaitTimeout 要素で指定されます。

タスクがアイドルトリガーによって起動される場合、IIdleSettings インターフェイスの WaitTimeout プロパティは無視されます。

vtbl 10 HRESULT put_WaitTimeout(LPWSTR timeout)

Task Scheduler がアイドル状態の発生を待機する時間の長さを示す値を取得または設定します。(Put)

timeoutLPWSTRinアイドル状態になるのを待機する最大時間を ISO8601 期間文字列で指定する。

解説(Remarks)

タスクの XML を読み書きする際、この設定は Task Scheduler スキーマの WaitTimeout 要素で指定されます。

タスクがアイドルトリガーによって起動される場合、IIdleSettings インターフェイスの WaitTimeout プロパティは無視されます。

vtbl 11 HRESULT get_StopOnIdleEnd(VARIANT_BOOL* pStop)

タスクが完了する前にアイドル状態が終了した場合に Task Scheduler がタスクを終了させることを示す Boolean 値を取得または設定します。アイドル状態は、コンピューターがアイドル状態でなくなったときに終了します。(Get)

pStopVARIANT_BOOL*inoutアイドル状態が終了した際にタスクを停止するかどうかを表す VARIANT_BOOL を受け取る出力先へのポインタである。

解説(Remarks)

タスクの XML を読み書きする際、この設定は Task Scheduler スキーマの TerminateOnIdleEnd 要素で指定されます。

vtbl 12 HRESULT put_StopOnIdleEnd(VARIANT_BOOL stop)

タスクが完了する前にアイドル状態が終了した場合に Task Scheduler がタスクを終了させることを示す Boolean 値を取得または設定します。アイドル状態は、コンピューターがアイドル状態でなくなったときに終了します。(Put)

stopVARIANT_BOOLinアイドル状態が終了した際にタスクを停止するかどうかを VARIANT_BOOL で指定する。

解説(Remarks)

タスクの XML を読み書きする際、この設定は Task Scheduler スキーマの TerminateOnIdleEnd 要素で指定されます。

vtbl 13 HRESULT get_RestartOnIdle(VARIANT_BOOL* pRestart)

コンピューターが複数回アイドル状態に入ったときにタスクを再起動するかどうかを示す Boolean 値を取得または設定します。(Get)

pRestartVARIANT_BOOL*inout再びアイドル状態になった際にタスクを再起動するかどうかを表す VARIANT_BOOL を受け取る出力先へのポインタである。

解説(Remarks)

このプロパティは、StopOnIdleEnd プロパティが True に設定されている場合にのみ使用されます。

タスクの XML を読み書きする際、この設定は Task Scheduler スキーマの RestartOnIdle 要素で指定されます。

vtbl 14 HRESULT put_RestartOnIdle(VARIANT_BOOL restart)

コンピューターが複数回アイドル状態に入ったときにタスクを再起動するかどうかを示す Boolean 値を取得または設定します。(Put)

restartVARIANT_BOOLin再びアイドル状態になった際にタスクを再起動するかどうかを VARIANT_BOOL で指定する。

解説(Remarks)

このプロパティは、StopOnIdleEnd プロパティが True に設定されている場合にのみ使用されます。

タスクの XML を読み書きする際、この設定は Task Scheduler スキーマの RestartOnIdle 要素で指定されます。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IIdleSettings "{84594461-0053-4342-A8FD-088FABF11F32}"
#usecom global IIdleSettings IID_IIdleSettings "{}"
#comfunc global IIdleSettings_get_IdleDuration   7 var
#comfunc global IIdleSettings_put_IdleDuration   8 wstr
#comfunc global IIdleSettings_get_WaitTimeout    9 var
#comfunc global IIdleSettings_put_WaitTimeout    10 wstr
#comfunc global IIdleSettings_get_StopOnIdleEnd  11 var
#comfunc global IIdleSettings_put_StopOnIdleEnd  12 int
#comfunc global IIdleSettings_get_RestartOnIdle  13 var
#comfunc global IIdleSettings_put_RestartOnIdle  14 int
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。