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

IAppxPackageWriter

COM
📘 Microsoft Learn (日本語) · English
IID9099e33b-246f-41e4-881a-008eb613f858継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

アプリパッケージ用の書き込み専用オブジェクトモデルを提供します。(IAppxPackageWriter)

解説(Remarks)

このオブジェクトは、IAppxFactory インターフェイスの CreatePackageWriter メソッドを使用して取得できます。

例

例については、「アプリパッケージを作成する方法」を参照してください。

メソッド 2

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

vtbl 3 HRESULT AddPayloadFile(LPWSTR fileName, LPWSTR contentType, APPX_COMPRESSION_OPTION compressionOption, IStream* inputStream)

アプリパッケージに新しいペイロードファイルを追加します。

fileNameLPWSTRinペイロードファイルの名前。ファイル名のパスは、パッケージのルートからの相対パスである必要があります。
contentTypeLPWSTRinfileName のコンテンツタイプを指定する文字列。
compressionOptionAPPX_COMPRESSION_OPTIONinfileName をパッケージに格納する際に使用する圧縮の種類。
inputStreamIStream*infileName の内容を提供する IStream。 このストリームは Read、Seek、および Stat をサポートしている必要があります。

戻り値

型: HRESULT

メソッドが成功した場合は S_OK を返します。それ以外の場合は、次の表に示すものを含む (ただしこれらに限定されない) エラーコードを返します。OPC_E_DUPLICATE_PART に加えて、その他の OPC エラーコードが返されることもあります。メソッドが失敗した場合、パッケージライターは失敗状態で閉じられ、それ以降は使用できなくなります。

戻り値 説明
E_INVALIDARG
compressionOption で指定された圧縮オプションが、APPX_COMPRESSION_OPTION 列挙型の値のいずれでもありません。
E_NOT_VALID_STATE
ライターが閉じられています。
HRESULT_FROM_WIN32(ERROR_INVALID_NAME)
 指定されたファイル名が有効なファイル名でないか、フットプリントファイル用の予約名です。
OPC_E_DUPLICATE_PART
 指定されたファイル名は、そのパッケージ内で既に使用されています。

解説(Remarks)

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

メモ 次の予約済みファイル名を持つファイルは、AddPayloadFile メソッドでパッケージに追加できません。

AppxManifest.xml、AppxBlockMap.xml、AppxStreamMap.xml、および AppxSignature.p7x。

また、次の予約済みフォルダープレフィックスを持つファイルも、AddPayloadFile メソッドでパッケージに追加できません: \AppxMetadata\ および \Microsoft.System.Package.Metadata\。

例

例については、「アプリパッケージを作成する方法」を参照してください。

vtbl 4 HRESULT Close(IStream* manifest)

アプリパッケージの末尾にフットプリントファイルを書き込み、パッケージライターオブジェクトの出力ストリームを閉じます。

manifestIStream*inパッケージのマニフェストの内容を提供するストリーム。このストリームは Read、Seek、および Stat をサポートしている必要があります。

戻り値

型: HRESULT

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

戻り値 説明
E_NOT_VALID_STATE
ライターが閉じられています。
APPX_E_INVALID_MANIFEST
 入力ストリームに含まれるマニフェストが有効ではありません。

解説(Remarks)

Close メソッドは、すべてのペイロードファイルをパッケージに追加した後にのみ呼び出してください。

例

例については、「アプリパッケージを作成する方法」を参照してください。

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