ホーム › Storage.Imapi › IEnumProgressItems

IEnumProgressItems

COM

📘 Microsoft Learn (日本語) · English

IID2c941fd6-975b-59be-a960-9a2a262853a5継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

進行状況アイテムのコレクションを列挙するには、このインターフェイスを使用します。

解説(Remarks)

これはスクリプトでは EnumProgressItems オブジェクトです。

メソッド 4

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

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

列挙シーケンス内の指定した数のアイテムを取得します。(IEnumProgressItems.Next)

celt	DWORD	in	取得するアイテムの数。
rgelt	IProgressItem**	out	IProgressItem インターフェイスの配列。使用が終わったら、rgelt 内の各インターフェイスを解放する必要があります。
pceltFetched	DWORD*	out	rgelt に返される要素の数。celt が 1 の場合は pceltFetched に NULL を設定できます。それ以外の場合は、このメソッドを呼び出す前に pceltFetched の値を 0 に初期化してください。

戻り値

要求した数の要素 (celt) が正常に返された場合、または返されたアイテムの数 (pceltFetched) が要求した要素数より少ない場合、S_OK が返されます。

実装によっては、他の成功コードが返されることもあります。次のエラーコードは操作の失敗時に一般的に返されるものですが、返される可能性のあるエラー値はこれらだけではありません。

リターンコード	説明
E_POINTER	ポインターが有効ではありません。値: 0x80004003
E_OUTOFMEMORY	必要なメモリを割り当てられませんでした。値: 0x8007000E
E_INVALIDARG	1 つ以上の引数が有効ではありません。値: 0x80070057

解説(Remarks)

シーケンスに残っている要素が要求した数より少ない場合は、残りの要素を取得します。

vtbl 4 HRESULT Skip(DWORD celt)

列挙シーケンス内の指定した数のアイテムをスキップします。(IEnumProgressItems.Skip)

celt

DWORD

スキップするアイテムの数。

戻り値

成功した場合は S_OK が返されますが、実装によっては他の成功コードが返されることもあります。次のエラーコードは操作の失敗時に一般的に返されるものですが、返される可能性のあるエラー値はこれらだけではありません。

リターンコード	説明
S_FALSE	要求された要素数より少ない数だけスキップしました。

解説(Remarks)

スキップを要求された要素数よりもシーケンスに残っている要素が少ない場合は、シーケンスの最後の要素を越えた位置までスキップします。

vtbl 5 HRESULT Reset()

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

戻り値

成功した場合は S_OK が返されますが、実装によっては他の成功コードが返されることもあります。

vtbl 6 HRESULT Clone(IEnumProgressItems** ppEnum)

現在の列挙子と同じ列挙状態を持つ別の列挙子を作成します。(IEnumProgressItems.Clone)

ppEnum

IEnumProgressItems**

out

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

戻り値

リターンコード	説明
E_POINTER	ポインターが有効ではありません。値: 0x80004003
E_OUTOFMEMORY	必要なメモリを割り当てられませんでした。値: 0x8007000E

解説(Remarks)

このメソッドを使用すると、クライアントは列挙シーケンス内の特定の位置を記録し、後でその位置に戻ることができます。新しい列挙子は、元の列挙子と同じインターフェイスをサポートします。

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