ホーム › Storage.Packaging.Appx › IAppxBundleWriter

IAppxBundleWriter

COM

📘 Microsoft Learn (日本語) · English

IIDec446fe8-bfec-4c64-ab4f-49f038f0c6d2継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

バンドルパッケージ用の書き込み専用オブジェクトモデルを提供します。(IAppxBundleWriter)

解説(Remarks)

IAppxBundleWriter オブジェクトを取得するには、IAppxBundleFactory インターフェイスの CreateBundleWriter メソッドを使用します。

ライターに追加できるのはアプリパッケージのみです。バンドルのマニフェストやブロックマップなどのフットプリントファイルは、ライターが自動的に生成します。

メソッド 2

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

vtbl 3 HRESULT AddPayloadPackage(LPWSTR fileName, IStream* packageStream)

新しいアプリパッケージをバンドルに追加します。(IAppxBundleWriter.AddPayloadPackage)

fileName	LPWSTR	in	ペイロードファイルの名前。ファイル名のパスは、パッケージのルートからの相対パスである必要があります。
packageStream	IStream*	in	fileName の内容を提供する IStream。このストリームは Read、Seek、Stat をサポートしている必要があります。

戻り値

型: HRESULT

メソッドが成功した場合は S_OK を返します。それ以外の場合は、次の表に示すものを含む(ただしこれらに限定されない)エラーコードを返します。OPC_E_DUPLICATE_PART 以外の OPC エラーコードが返されることもあります。メソッドが失敗した場合、バンドルライターは失敗状態でクローズされ、以降は使用できません。

戻り値	説明
E_NOT_VALID_STATE	ライターはクローズされています。
HRESULT_FROM_WIN32(ERROR_INVALID_NAME)	指定されたファイル名が有効なファイル名ではないか、フットプリントファイル用に予約された名前です。
OPC_E_DUPLICATE_PART	指定されたファイル名は、バンドル内で既に使用されています。

解説(Remarks)

AddPayloadFile メソッドが成功すると、指定された fileName の内容がパッケージに書き込まれ、パッケージのブロックマップに対応するエントリが作成されます。

AddPayloadPackage は、packageStream からアプリパッケージの内容を読み取り、その内容を指定された fileName でバンドル内に格納します。

AddPayloadPackage は、次の場合に失敗することがあります。

packageStream が有効なアプリパッケージを提供していない場合
packageStream が提供するアプリパッケージが、バンドルに既に追加されているアプリパッケージとは異なるパッケージファミリに属している場合
packageStream が提供するアプリパッケージの対象アーキテクチャが、バンドルに既に追加されているアプリパッケージと同じバンドルには格納できないものである場合
packageStream が提供するアプリパッケージのブロックマップが、バンドルに既に追加されているアプリパッケージとは異なるハッシュ方式を使用している場合
fileName が有効なファイル名でない場合、予約された名前である場合、またはバンドルに追加済みの別のアプリパッケージで既に使用されている場合

vtbl 4 HRESULT Close()

パッケージの末尾にフットプリントファイルを書き込んでバンドルパッケージを確定し、ライターの出力ストリームを閉じます。(IAppxBundleWriter.Close)

戻り値

型: HRESULT

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

戻り値	説明
E_NOT_VALID_STATE	ライターはクローズされています。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IAppxBundleWriter "{EC446FE8-BFEC-4C64-AB4F-49F038F0C6D2}"
#usecom global IAppxBundleWriter IID_IAppxBundleWriter "{}"
#comfunc global IAppxBundleWriter_AddPayloadPackage  3 wstr,sptr
#comfunc global IAppxBundleWriter_Close              4
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。