ホーム › Networking.BackgroundIntelligentTransferService › IEnumBackgroundCopyFiles

IEnumBackgroundCopyFiles

COM

IIDca51e165-c365-424c-8d41-24aaa4ff3c40継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

IEnumBackgroundCopyFiles インターフェイスは、ジョブに含まれるファイルを列挙するために使用します。IEnumBackgroundCopyFiles インターフェイスポインターを取得するには、IBackgroundCopyJob::EnumFiles メソッドを呼び出します。

メソッド 5

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

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

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

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

戻り値

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

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

vtbl 4 HRESULT Skip(DWORD celt)

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

celt

DWORD

スキップする要素の数。

戻り値

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

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

vtbl 5 HRESULT Reset()

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

戻り値

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

vtbl 6 HRESULT Clone(IEnumBackgroundCopyFiles** ppenum)

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

ppenum

IEnumBackgroundCopyFiles**

out

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

戻り値

このメソッドは、成功した場合は 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_IEnumBackgroundCopyFiles "{CA51E165-C365-424C-8D41-24AAA4FF3C40}"
#usecom global IEnumBackgroundCopyFiles IID_IEnumBackgroundCopyFiles "{}"
#comfunc global IEnumBackgroundCopyFiles_Next      3 int,sptr,var
#comfunc global IEnumBackgroundCopyFiles_Skip      4 int
#comfunc global IEnumBackgroundCopyFiles_Reset     5
#comfunc global IEnumBackgroundCopyFiles_Clone     6 sptr
#comfunc global IEnumBackgroundCopyFiles_GetCount  7 var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_IEnumBackgroundCopyFiles "{CA51E165-C365-424C-8D41-24AAA4FF3C40}"
#usecom global IEnumBackgroundCopyFiles IID_IEnumBackgroundCopyFiles "{}"
#comfunc global IEnumBackgroundCopyFiles_Next      3 int,sptr,sptr
#comfunc global IEnumBackgroundCopyFiles_Skip      4 int
#comfunc global IEnumBackgroundCopyFiles_Reset     5
#comfunc global IEnumBackgroundCopyFiles_Clone     6 sptr
#comfunc global IEnumBackgroundCopyFiles_GetCount  7 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。