ホーム › Networking.BackgroundIntelligentTransferService › IEnumBackgroundCopyJobs1

IEnumBackgroundCopyJobs1

COM

IID8baeba9d-8f1c-42c4-b82c-09ae79980d25継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

IEnumBackgroundCopyJobs1 インターフェイスは、グループ内のジョブの一覧を列挙するために使用します。IEnumBackgroundCopyJobs1 インターフェイスポインターを取得するには、IBackgroundCopyGroup::EnumJobs メソッドを呼び出します。

メソッド 5

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

vtbl 3 HRESULT Next(DWORD celt, GUID* rgelt, DWORD* pceltFetched)

Next メソッドは、列挙シーケンスから指定された数の項目を取得するために使用します。シーケンスに残っている要素が要求された数より少ない場合は、残りの要素をすべて取得します。(IEnumBackgroundCopyJobs1.Next)

celt	DWORD	in	要求する要素の数。
rgelt	GUID*	out	ジョブを識別する GUID の配列。ジョブを取得するには、その GUID を指定して IBackgroundCopyGroup::GetJob メソッドを呼び出します。
pceltFetched	DWORD*	out	rgelt 内の要素の数。celt が 1 の場合は、pceltFetched に NULL を指定できます。

戻り値

このメソッドは、以下の HRESULT 値のほか、その他の値を返します。

戻り値	説明
S_OK	要求された数の要素を正常に返しました。
S_FALSE	要求された数より少ない要素を返しました。

vtbl 4 HRESULT Skip(DWORD celt)

Skip メソッドは、列挙シーケンス内の次の指定された数の要素をスキップするために使用します。シーケンスに残っている要素がスキップを要求された数より少ない場合は、シーケンスの最後の要素を越えてスキップします。(IEnumBackgroundCopyJobs1.Skip)

celt

DWORD

スキップする要素の数。

戻り値

このメソッドは、以下の HRESULT 値のほか、その他の値を返します。

戻り値	説明
S_OK	要求された数の要素を正常にスキップしました。
S_FALSE	要求された数より少ない要素をスキップしました。

vtbl 5 HRESULT Reset()

Reset メソッドは、列挙シーケンスを先頭にリセットするために使用します。(IEnumBackgroundCopyJobs1.Reset)

戻り値

このメソッドは、成功すると S_OK を返します。

vtbl 6 HRESULT Clone(IEnumBackgroundCopyJobs1** ppenum)

Clone メソッドは、現在の列挙子と同じ列挙状態を持つ別の IEnumBackgroundCopyJobs1 列挙子を作成するために使用します。

ppenum

IEnumBackgroundCopyJobs1**

out

列挙オブジェクトへのインターフェイスポインターを受け取ります。メソッドが失敗した場合、この出力変数の値は未定義です。使用後は ppenum を解放する必要があります。

戻り値

このメソッドは、成功すると S_OK を返します。

vtbl 7 HRESULT GetCount(DWORD* puCount)

GetCount メソッドは、列挙に含まれるジョブの数を取得するために使用します。

puCount

DWORD*

out

列挙に含まれるジョブの数。

戻り値

このメソッドは、成功すると S_OK を返します。

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