Win32 API 日本語リファレンス
ホーム › Storage.Xps › IXpsOMPage1

IXpsOMPage1

COM
📘 Microsoft Learn (日本語) · English
IID305b60ef-6892-4dda-9cbb-3aa65974508a継承元IXpsOMPage自前メソッド開始 vtbl27

公式ドキュメント

IXpsOMPage を継承します。

解説(Remarks)

その他の参考情報

ベースとなるインターフェースは、Windows 7 SDK で定義およびドキュメント化されています。

IXpsOMPage インターフェース

メソッド 2

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

vtbl 27 HRESULT GetDocumentType(XPS_DOCUMENT_TYPE* documentType)

このページの初期化に使用された FixedPage マークアップの種類を取得します。このメソッドは、ドキュメントが XPS 型と OpenXPS 型のどちらであるかを判別するために使用します。詳細については、「XPS Documents」を参照してください。

documentTypeXPS_DOCUMENT_TYPE*out[out, retval] このパッケージの初期化に使用されたソースデータのドキュメントの種類。パッケージがメモリ内で作成された場合は、ドキュメントの種類として XPS_DOCUMENT_TYPE_UNSPECIFIED が返されます。

戻り値

このメソッドは HRESULT を返します。返される値には次のものが含まれますが、これらに限定されるわけではありません。この表に記載されていない XPS Document API の戻り値については、「XPS Document Errors」を参照してください。

S_OK: メソッドは成功しました。

E_POINTER: documentType が NULL です。

解説(Remarks)

IXpsOMPage1 インスタンスがストリームまたはファイルから読み込まれたものでない場合、ドキュメントの種類は未指定 (XPS_DOCUMENT_TYPE_UNSPECIFIED) となります。それ以外の場合は、IXpsOMPage1 インスタンスの初期化に使用されたストリームまたはファイルのドキュメントの種類が返されます。

vtbl 28 HRESULT Write1(ISequentialStream* stream, BOOL optimizeMarkupSize, XPS_DOCUMENT_TYPE documentType)

IXpsOMPage1::Write1 メソッド (xpsobjectmodel_1.h) は、指定されたストリームにページを書き込みます。

streamISequentialStream*inページのシリアル化された内容を受け取るストリーム。
optimizeMarkupSizeBOOLin

ページをストリームに書き込むときに、ページのドキュメントマークアップをサイズについて最適化するかどうかを示すブール値。

値 意味
TRUE パッケージライターは、ページをストリームに書き込む際に、マークアップをできるだけ小さいサイズになるよう最適化を試みます。
FALSE パッケージライターは、ページをストリームに書き込む際に最適化を行いません。
documentTypeXPS_DOCUMENT_TYPEin書き出すページのドキュメント種別を示す XPS_DOCUMENT_TYPE を指定する。

戻り値

このメソッドは HRESULT を返します。返される値には次の表のものが含まれますが、これらに限定されるわけではありません。この表に記載されていない XPS ドキュメント API の戻り値については、XPS Document Errors を参照してください。

戻り値 説明
S_OK メソッドは成功しました。
E_POINTER stream が NULL です。

解説(Remarks)

ページの XPS マークアップを XPS パッケージに書き込む前に確認するには、アプリケーションで Write メソッドを呼び出して、ページの内容をストリームに書き込むことができます。その後、そのストリームを読み取ることで、XPS パッケージに書き込まれる際にシリアル化されるのと同じ XPS マークアップを確認できます。

このメソッドによってストリームに書き込まれる XPS マークアップには、ページのマークアップは含まれますが、ページのリソースは含まれません。

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