ホーム › System.TaskScheduler › IEnumWorkItems

IEnumWorkItems

COM

📘 Microsoft Learn (日本語) · English

IID148bd528-a2ab-11ce-b11f-00aa00530503継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

Scheduled Tasks フォルダー内のタスクを列挙するためのメソッドを提供します。

メソッド 4

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

vtbl 3 HRESULT Next(DWORD celt, LPWSTR** rgpwszNames, DWORD* pceltFetched)

列挙シーケンス内の次の指定した数のタスクを取得します。

celt

DWORD

取得するタスクの数。

rgpwszNames

LPWSTR**

out

列挙シーケンスから返されるタスクのファイル名を格納した、null 終端文字列へのポインター配列(LPWSTR)へのポインター。これらのファイル名は Scheduled Tasks フォルダーから取得され、".job" 拡張子を持ちます。

rgpwszNames で返された名前を処理した後は、まず配列内の各文字列を解放し、続いて CoTaskMemFree を使用して配列自体を解放する必要があります。

pceltFetched

DWORD*

out

rgpwszNames で返されたタスクの数へのポインター。celt パラメーターが 1 の場合、このパラメーターは NULL にできます。

戻り値

次のいずれかの値を返します。

戻り値	説明
S_OK	取得したタスクの数が要求された数と等しい。
S_FALSE	返された数が要求された数より少ない。(したがって、これ以上列挙するタスクはありません。)
E_INVALIDARG	パラメーターが無効です。
E_OUTOFMEMORY	十分なメモリがありません。

解説(Remarks)

IEnumWorkItems インターフェイスは、列挙のリセット、タスクのスキップ、および列挙の現在の状態のコピーの作成を行うメソッドも提供します。

例

Scheduled Tasks フォルダー内のタスクを列挙するために Next を使用する方法の例については、Enumerating Tasks Example を参照してください。

vtbl 4 HRESULT Skip(DWORD celt)

列挙シーケンス内の次の指定した数のタスクをスキップします。

celt

DWORD

スキップするタスクの数。

戻り値

次のいずれかの値を返します。

戻り値	説明
S_OK	スキップした要素の数が celt と等しい。
S_FALSE	シーケンス内に残っている要素の数が celt で指定した値より少ない。
E_INVALIDARG	celt の値が 0 以下です。

解説(Remarks)

IEnumWorkItems インターフェイスは、タスクのセットの取得、列挙シーケンスのリセット、および列挙の現在の状態のコピーの作成を行うメソッドも提供します。

vtbl 5 HRESULT Reset()

列挙シーケンスを先頭にリセットします。(IEnumWorkItems.Reset)

戻り値

次のいずれかの値を返します。

戻り値	説明
S_OK	列挙シーケンスがリストの先頭にリセットされます。
E_OUTOFMEMORY	使用可能なメモリが不足しています。

解説(Remarks)

このメソッドを呼び出しても、列挙シーケンスのリセット後に同じタスクのセットが列挙される保証はありません。リストを列挙している間に、タスクがコレクションに追加されたり削除されたりしている可能性があります。

IEnumWorkItems インターフェイスは、タスクのセットの取得、タスクのセットのスキップ、および列挙の現在の状態のコピーの作成を行うメソッドも提供します。

vtbl 6 HRESULT Clone(IEnumWorkItems** ppEnumWorkItems)

現在の列挙と同じ列挙状態を持つ新しい列挙オブジェクトを作成します。

ppEnumWorkItems

IEnumWorkItems**

out

新しい IEnumWorkItems インターフェイスへのポインターへのポインター。このポインターは新しく作成された列挙を指します。メソッドが失敗した場合、このパラメーターは未定義です。

戻り値

次のいずれかの値を返します。

戻り値	説明
S_OK	操作は成功しました。
E_INVALIDARG	引数が無効です。
E_OUTOFMEMORY	使用可能なメモリが不足しています。
E_UNEXPECTED	エラーが発生しました。

解説(Remarks)

IEnumWorkItems インターフェイスは、タスクのセットの取得、タスクのセットのスキップ、および列挙シーケンスのリセットを行うメソッドも提供します。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IEnumWorkItems "{148BD528-A2AB-11CE-B11F-00AA00530503}"
#usecom global IEnumWorkItems IID_IEnumWorkItems "{}"
#comfunc global IEnumWorkItems_Next   3 int,var,var
#comfunc global IEnumWorkItems_Skip   4 int
#comfunc global IEnumWorkItems_Reset  5
#comfunc global IEnumWorkItems_Clone  6 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_IEnumWorkItems "{148BD528-A2AB-11CE-B11F-00AA00530503}"
#usecom global IEnumWorkItems IID_IEnumWorkItems "{}"
#comfunc global IEnumWorkItems_Next   3 int,sptr,sptr
#comfunc global IEnumWorkItems_Skip   4 int
#comfunc global IEnumWorkItems_Reset  5
#comfunc global IEnumWorkItems_Clone  6 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。