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

IXpsOMStoryFragmentsResource

COM
📘 Microsoft Learn (日本語) · English
IIDc2b3ca09-0473-4282-87ae-1780863223f0継承元IXpsOMResource自前メソッド開始 vtbl5

公式ドキュメント

ページの StoryFragments パートのリソースストリームの内容へのアクセスを提供します。

解説(Remarks)

ページの StoryFragments パートには、単一の固定ページに関連付けられた 1 つ以上のストーリーの一部を記述する XML マークアップが格納されます。StoryFragments パートの XML マークアップで記述されるドキュメント内容には、そのページ上にあるストーリーのテーブルや段落などが含まれます。

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

メソッド 3

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

vtbl 5 HRESULT GetOwner(IXpsOMPageReference** owner)

このリソースを含む IXpsOMPage インターフェイスへのポインターを取得します。

ownerIXpsOMPageReference**outこのリソースを含む IXpsOMPage インターフェイスへのポインター。リソースがページの一部でない場合は、NULL ポインターが返されます。

戻り値

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

vtbl 6 HRESULT GetStream(IStream** stream)

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

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

戻り値

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

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

解説(Remarks)

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

StoryFragments パートの内容の詳細については、XML Paper Specification を参照してください。

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

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

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

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

戻り値

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

解説(Remarks)

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

StoryFragments パートの内容の詳細については、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_IXpsOMStoryFragmentsResource "{C2B3CA09-0473-4282-87AE-1780863223F0}"
#usecom global IXpsOMStoryFragmentsResource IID_IXpsOMStoryFragmentsResource "{}"
#comfunc global IXpsOMStoryFragmentsResource_GetOwner    5 sptr
#comfunc global IXpsOMStoryFragmentsResource_GetStream   6 sptr
#comfunc global IXpsOMStoryFragmentsResource_SetContent  7 sptr,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。