IAppxBlockMapBlocksEnumerator
COM公式ドキュメント
単一ファイル内のブロックマップに含まれるブロックを列挙します。
メソッド 3
vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。
列挙子の現在位置にあるブロックを取得します。
| block | IAppxBlockMapBlock** | out | 現在のブロック。 |
戻り値
型: HRESULT
メソッドが成功した場合は S_OK を返します。それ以外の場合は、次の表に示すものを含む (ただしこれらに限定されない) エラーコードを返します。
| 戻り値 | 説明 |
|---|---|
| 列挙子がコレクションの最後の項目を通過しました。 |
解説(Remarks)
返される列挙子が空の場合もあります。その場合、GetHasCurrent の呼び出しは false を返します。列挙子が空でない場合は最初の要素を指しており、このメソッドは最初の項目を返します。以降は MoveNext を使用して項目間を移動し、GetCurrent で項目にアクセスする前に GetHasCurrent を呼び出してください。
列挙子の現在位置にブロックが存在するかどうかを判定します。
| hasCurrent | BOOL* | out | 列挙子の現在位置が項目を参照している場合は TRUE、列挙子がコレクションの最後の項目を通過している場合は FALSE です。 |
戻り値
型: HRESULT
このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。
列挙子の位置を次のブロックへ進めます。
| hasNext | BOOL* | out | 列挙子が正常に前進した場合は TRUE 列挙子がコレクションの末尾を通過した場合は FALSE です。 |
戻り値
型: HRESULT
メソッドが成功した場合は S_OK を返します。それ以外の場合はエラーコードを返します。
なお、列挙子が初めてコレクションの末尾を通過したときは hasNext = FALSE となりますが、メソッド自体は成功し S_OK を返します。ただし、すでに末尾を通過して hasNext = FALSE を受け取った後にさらに MoveNext を呼び出した場合、このメソッドは E_BOUNDS を返します。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
HSP用 COM定義
#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。
#define global IID_IAppxBlockMapBlocksEnumerator "{6B429B5B-36EF-479E-B9EB-0C1482B49E16}" #usecom global IAppxBlockMapBlocksEnumerator IID_IAppxBlockMapBlocksEnumerator "{}" #comfunc global IAppxBlockMapBlocksEnumerator_GetCurrent 3 sptr #comfunc global IAppxBlockMapBlocksEnumerator_GetHasCurrent 4 var #comfunc global IAppxBlockMapBlocksEnumerator_MoveNext 5 var ; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。 ; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。 ; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。 ; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_IAppxBlockMapBlocksEnumerator "{6B429B5B-36EF-479E-B9EB-0C1482B49E16}" #usecom global IAppxBlockMapBlocksEnumerator IID_IAppxBlockMapBlocksEnumerator "{}" #comfunc global IAppxBlockMapBlocksEnumerator_GetCurrent 3 sptr #comfunc global IAppxBlockMapBlocksEnumerator_GetHasCurrent 4 sptr #comfunc global IAppxBlockMapBlocksEnumerator_MoveNext 5 sptr ; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。 ; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。 ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。 ; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。