IXpsOMPage1
COM公式ドキュメント
IXpsOMPage を継承します。
解説(Remarks)
メソッド 2
vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。
このページの初期化に使用された FixedPage マークアップの種類を取得します。このメソッドは、ドキュメントが XPS と OpenXPS のどちらの種類であるかを判別するために使用します。詳細については、「XPS Documents」を参照してください。
| documentType | XPS_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 インスタンスの初期化に使用されたストリームまたはファイルのドキュメントの種類が返されます。
IXpsOMPage1::Write1 メソッド (xpsobjectmodel_1.h) は、ページを指定されたストリームに書き込みます。
| stream | ISequentialStream* | in | ページのシリアル化された内容を受け取るストリーム。 | ||||||
| optimizeMarkupSize | BOOL | in | ページをストリームに書き込む際に、ページのドキュメントマークアップをサイズの観点で最適化するかどうかを示すブール値。
| ||||||
| documentType | XPS_DOCUMENT_TYPE | in | 書き出すページのドキュメント種別を示す XPS_DOCUMENT_TYPE を指定する。 |
戻り値
このメソッドは HRESULT を返します。取り得る値には次の表のものが含まれますが、これらに限定されません。この表に記載されていない XPS ドキュメント API の戻り値については、「XPS Document Errors」を参照してください。
| 戻り値 | 説明 |
|---|---|
| S_OK | メソッドは成功しました。 |
| E_POINTER | stream が NULL です。 |
解説(Remarks)
XPS パッケージに書き込まれる前のページの XPS マークアップを確認するには、アプリケーションから Write メソッドを呼び出して、ページの内容をストリームに書き込みます。その後、アプリケーションはそのストリームを読み取ることで、XPS パッケージに書き込まれる際にシリアル化されるとおりの XPS マークアップを確認できます。
このメソッドによってストリームに書き込まれる XPS マークアップには、ページのマークアップは含まれますが、ページのリソースは一切含まれません。
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 指定が可能。#define global IID_IXpsOMPage1 "{305B60EF-6892-4DDA-9CBB-3AA65974508A}" #usecom global IXpsOMPage1 IID_IXpsOMPage1 "{}" #comfunc global IXpsOMPage1_GetDocumentType 27 sptr #comfunc global IXpsOMPage1_Write1 28 sptr,int,int ; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。 ; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。 ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。 ; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。