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

IXpsOMDocumentStructureResource

COM
📘 Microsoft Learn (日本語) · English
IID85febc8a-6b63-48a9-af07-7064e4ecff30継承元IXpsOMResource自前メソッド開始 vtbl5

公式ドキュメント

DocumentStructure パートのリソースストリームの XML コンテンツへのアクセスを提供します。

解説(Remarks)

XPS ドキュメントの DocumentStructure パートにはドキュメントのアウトラインが含まれており、これは StoryFragments パートとともに、ドキュメントの固定ページに表示されるすべての要素の読み取り順序を定義します。

XPS ドキュメントの読み取り順序は、ストーリー (story) と呼ばれる意味的なブロックに整理されます。ストーリーは、雑誌における記事が単位であるのと同じように、ドキュメントの論理的な単位です。ストーリーは 1 つ以上の StoryFragments パートで構成されます。StoryFragments パートには、ストーリーの意味的なブロックを定義する XML マークアップが含まれており、これによってドキュメントのコンテンツの構造が記述されます。ストーリーの意味的なブロックの例としては、段落や表があります。

DocumentStructure パートおよび StoryFragments パートの XML マークアップについては、XML Paper Specification で説明されています。

メソッド 3

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

vtbl 5 HRESULT GetOwner(IXpsOMDocument** owner)

リソースを含む IXpsOMDocument インターフェイスへのポインターを取得します。(IXpsOMDocumentStructureResource.GetOwner)

ownerIXpsOMDocument**outリソースを含む IXpsOMDocument インターフェイスへのポインター。リソースがドキュメントの一部でない場合は、NULL ポインターが返されます。

戻り値

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

vtbl 6 HRESULT GetStream(IStream** stream)

このリソースに関連付けられたストリームの、新しい読み取り専用のコピーを取得します。(IXpsOMDocumentStructureResource.GetStream)

streamIStream**outこのリソースに関連付けられたストリームの、新しい読み取り専用のコピー。

戻り値

メソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。XPS ドキュメント API の戻り値については、XPS Document Errors を参照してください。

このメソッドは Packaging API を呼び出します。Packaging API の戻り値については、Packaging Errors を参照してください。

解説(Remarks)

このメソッドが返す IStream オブジェクトは E_PENDING エラーを返す場合があります。これは、ストリームの長さがまだ確定していないことを示します。この動作は、標準的な IStream オブジェクトの動作とは異なります。

DocumentStructure パートのコンテンツの詳細については、XML Paper Specification を参照してください。

このメソッドは、stream で返されるストリームを作成するために、ストリームの Clone メソッドを呼び出します。そのため、このメソッドのパフォーマンスは、ストリームの Clone メソッドのパフォーマンスに依存します。

vtbl 7 HRESULT SetContent(IStream* sourceStream, IOpcPartUri* partName)

このリソースに関連付ける読み取り専用ストリームを設定します。(IXpsOMDocumentStructureResource.SetContent)

sourceStreamIStream*inこのリソースに関連付ける読み取り専用ストリーム。
partNameIOpcPartUri*inこのリソースに割り当てるパート名。

戻り値

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

解説(Remarks)

呼び出し側のメソッドは、このストリームをシングルスレッドアパートメント (STA) モデルのオブジェクトとして扱い、ストリームインターフェイスのいずれのメソッドにも再入しないようにしてください。

DocumentStructure パートのコンテンツの詳細については、XML Paper Specification を参照してください。

GetStream はこのメソッドで設定されたストリームのクローンを取得するため、指定するストリームには効率的なクローンメソッドが実装されている必要があります。クローンメソッドの効率が悪いストリームは、GetStream のパフォーマンスを低下させます。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IXpsOMDocumentStructureResource "{85FEBC8A-6B63-48A9-AF07-7064E4ECFF30}"
#usecom global IXpsOMDocumentStructureResource IID_IXpsOMDocumentStructureResource "{}"
#comfunc global IXpsOMDocumentStructureResource_GetOwner    5 sptr
#comfunc global IXpsOMDocumentStructureResource_GetStream   6 sptr
#comfunc global IXpsOMDocumentStructureResource_SetContent  7 sptr,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。