Win32 API 日本語リファレンス
ホームStorage.Packaging.Appx › IAppxFilesEnumerator

IAppxFilesEnumerator

COM
IIDf007eeaf-9831-411c-9847-917cdc62d1fe継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

パッケージ内のペイロードファイルを列挙します。

解説(Remarks)

フットプリントファイルを取得するには、IAppxPackageReader::GetFootprintFile メソッドを使用します。

メソッド 3

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

vtbl 3 HRESULT GetCurrent(IAppxFile** file)

列挙子の現在位置にあるペイロードファイルを取得します。

fileIAppxFile**out現在のペイロードファイル。

戻り値

型: HRESULT

メソッドが成功した場合は S_OK を返します。それ以外の場合は、次の表に示すもの(ただしこれらに限定されません)を含むエラーコードを返します。

戻り値 説明
E_BOUNDS
列挙子がコレクションの最後の項目を通過しました。

解説(Remarks)

返される列挙子が空の場合があります。この場合、GetHasCurrent を呼び出すと false が返ります。列挙子が空でない場合は最初の要素を指しており、このメソッドは最初の項目を返します。以降は MoveNext を使用して項目を順に移動し、GetCurrent で項目にアクセスする前に GetHasCurrent を呼び出してください。

vtbl 4 HRESULT GetHasCurrent(BOOL* hasCurrent)

列挙子の現在位置にペイロードファイルが存在するかどうかを判定します。

hasCurrentBOOL*out現在位置がペイロードファイルを参照している場合は TRUE。列挙子がコレクションの末尾を通過している場合は FALSE

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 5 HRESULT MoveNext(BOOL* hasNext)

列挙子の位置を次のペイロードファイルへ進めます。

hasNextBOOL*out

列挙子が正常に次へ進んだ場合は TRUE

列挙子がコレクションの末尾を通過した場合は FALSE

戻り値

型: HRESULT

メソッドが成功した場合は S_OK を返します。それ以外の場合はエラーコードを返します。

なお、列挙子が初めてコレクションの末尾を通過したときは hasNext = FALSE となりますが、メソッド自体は成功し S_OK を返します。ただし、すでに末尾を通過して hasNext = FALSE を受け取った後にさらに MoveNext を呼び出した場合、このメソッドは E_BOUNDS を返します。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IAppxFilesEnumerator "{F007EEAF-9831-411C-9847-917CDC62D1FE}"
#usecom global IAppxFilesEnumerator IID_IAppxFilesEnumerator "{}"
#comfunc global IAppxFilesEnumerator_GetCurrent     3 sptr
#comfunc global IAppxFilesEnumerator_GetHasCurrent  4 var
#comfunc global IAppxFilesEnumerator_MoveNext       5 var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。