ホーム › Storage.Imapi › IProgressItems

IProgressItems

COMIDispatch (デュアル)

📘 Microsoft Learn (日本語) · English

✅ IDispatch を実装(デュアルインターフェース)。HSP では comobj 経由でメソッド名による遅延バインド呼び出しができます(vtableインデックス不要)。

IID2c941fd7-975b-59be-a960-9a2a262853a5継承元IDispatch呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl7

公式ドキュメント

結果イメージ内の進行状況項目を列挙するには、このインターフェイスを使用します。

解説(Remarks)

これはスクリプトにおける ProgressItems オブジェクトです。

メソッド 6

vtbl = vtable インデックス(0始まり)。IDispatch 実装のため HSP ではメソッド名でも呼べます(上記)。低レベルの index 呼び出し用に vtbl も掲載。0〜2 は IUnknown。

vtbl 7 HRESULT get__NewEnum(IEnumVARIANT** NewEnum)

コレクションから進行状況項目の一覧を取得します。(IProgressItems.get__NewEnum)

NewEnum

IEnumVARIANT**

out

コレクションに含まれる進行状況項目を列挙するために使用する IEnumVariant インターフェイスです。列挙の各項目は、型が VT_DISPATCH の VARIANT です。pdispVal メンバーを照会して IProgressItem インターフェイスを取得してください。

戻り値

要求した数の要素 (celt) が正常に返された場合、または返された項目数 (pceltFetched) が要求した要素数より少ない場合に、S_OK が返されます。celt および pceltFetched パラメーターは IEnumVariant によって定義されます。

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

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

解説(Remarks)

この列挙は、呼び出した時点でコレクションに含まれていた進行状況項目のスナップショットです。

単一の項目を取得するには、IProgressItems::get_Item プロパティを参照してください。

vtbl 8 HRESULT get_Item(INT Index, IProgressItem** item)

指定した進行状況項目をコレクションから取得します。

Index	INT	in	コレクション内の進行状況項目に対応する、0 から始まるインデックス番号です。
item	IProgressItem**	out	指定したインデックス値に関連付けられた IProgressItem インターフェイスです。

戻り値

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

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

解説(Remarks)

すべての進行状況項目を列挙するには、IProgressItems::get__NewEnum メソッドを呼び出します。

vtbl 9 HRESULT get_Count(INT* Count)

コレクション内の進行状況項目の数を取得します。

Count

INT*

out

コレクション内の進行状況項目の数です。

戻り値

戻り値	説明
E_POINTER	ポインターが有効ではありません。値: 0x80004003

vtbl 10 HRESULT ProgressItemFromBlock(DWORD block, IProgressItem** item)

指定したブロック番号に基づいて進行状況項目を取得します。

block	DWORD	in	取得する進行状況項目のブロック番号です。指定したブロック番号が項目の先頭ブロックから最終ブロックまでの範囲に含まれる場合、このメソッドはその進行状況項目を返します。
item	IProgressItem**	out	指定したブロック番号に関連付けられた IProgressItem インターフェイスです。

戻り値

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

vtbl 11 HRESULT ProgressItemFromDescription(LPWSTR description, IProgressItem** item)

指定したファイル名に基づいて進行状況項目を取得します。

description	LPWSTR	in	取得する進行状況項目のファイル名を格納した文字列です。この文字列が項目の description プロパティの値と一致する場合、このメソッドはその進行状況項目を返します。
item	IProgressItem**	out	指定したファイル名に関連付けられた進行状況項目の IProgressItem インターフェイスです。

戻り値

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

vtbl 12 HRESULT get_EnumProgressItems(IEnumProgressItems** NewEnum)

コレクションから進行状況項目の一覧を取得します。(IProgressItems.get_EnumProgressItems)

NewEnum

IEnumProgressItems**

out

コレクションに含まれる進行状況項目のコレクションを格納する IEnumProgressItems インターフェイスです。

戻り値

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

解説(Remarks)

このプロパティは IProgressItems::get__NewEnum プロパティと同じ結果を返し、C/C++ アプリケーションでの使用を想定しています。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IProgressItems "{2C941FD7-975B-59BE-A960-9A2A262853A5}"
#usecom global IProgressItems IID_IProgressItems "{}"
#comfunc global IProgressItems_get__NewEnum                 7 sptr
#comfunc global IProgressItems_get_Item                     8 int,sptr
#comfunc global IProgressItems_get_Count                    9 var
#comfunc global IProgressItems_ProgressItemFromBlock        10 int,sptr
#comfunc global IProgressItems_ProgressItemFromDescription  11 wstr,sptr
#comfunc global IProgressItems_get_EnumProgressItems        12 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。#define global IID_IProgressItems "{2C941FD7-975B-59BE-A960-9A2A262853A5}"
#usecom global IProgressItems IID_IProgressItems "{}"
#comfunc global IProgressItems_get__NewEnum                 7 sptr
#comfunc global IProgressItems_get_Item                     8 int,sptr
#comfunc global IProgressItems_get_Count                    9 sptr
#comfunc global IProgressItems_ProgressItemFromBlock        10 int,sptr
#comfunc global IProgressItems_ProgressItemFromDescription  11 wstr,sptr
#comfunc global IProgressItems_get_EnumProgressItems        12 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。