ホーム › Networking.BackgroundIntelligentTransferService › IEnumBackgroundCopyJobs

IEnumBackgroundCopyJobs

COM

IID1af4f612-3b71-466f-8f58-7b6f73ac57ad継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

IEnumBackgroundCopyJobs インターフェイスは、転送キュー内のジョブの一覧を列挙するために使用します。IEnumBackgroundCopyJobs インターフェイスポインターを取得するには、IBackgroundCopyManager::EnumJobs メソッドを呼び出します。

メソッド 5

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

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

列挙シーケンス内の指定した数の項目を取得します。シーケンスに残っている要素が要求された数より少ない場合は、残りの要素を取得します。(IEnumBackgroundCopyJobs.Next)

celt	DWORD	in	要求する要素の数。
rgelt	IBackgroundCopyJob**	out	IBackgroundCopyJob オブジェクトの配列。使用後は rgelt 内の各オブジェクトを解放する必要があります。
pceltFetched	DWORD*	inout	rgelt に返された要素の数。celt が 1 の場合は pceltFetched に NULL を設定できます。それ以外の場合は、このメソッドを呼び出す前に pceltFetched の値を 0 に初期化してください。

戻り値

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

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

vtbl 4 HRESULT Skip(DWORD celt)

列挙シーケンス内の次の指定した数の要素をスキップします。シーケンスに残っている要素がスキップする要求数より少ない場合は、シーケンスの最後の要素を超えてスキップします。(IEnumBackgroundCopyJobs.Skip)

celt

DWORD

スキップする要素の数。

戻り値

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

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

vtbl 5 HRESULT Reset()

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

戻り値

このメソッドは、成功した場合に S_OK を返し、エラーの場合は標準の COM HRESULT 値のいずれかを返します。

vtbl 6 HRESULT Clone(IEnumBackgroundCopyJobs** ppenum)

現在の列挙子と同じ列挙状態を持つ、別の IEnumBackgroundCopyJobs 列挙子を作成します。

ppenum

IEnumBackgroundCopyJobs**

out

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

戻り値

このメソッドは、成功した場合に S_OK を返し、エラーの場合は標準の COM HRESULT 値のいずれかを返します。

vtbl 7 HRESULT GetCount(DWORD* puCount)

列挙内のジョブ数を取得します。

puCount

DWORD*

out

列挙内のジョブの数。

戻り値

このメソッドは、成功した場合に S_OK を返し、エラーの場合は標準の COM HRESULT 値のいずれかを返します。

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