IXpsOMPackageWriter::AddPage メソッド (xpsobjectmodel.h)

[アーティクル]
08/28/2023

パッケージ内の現在開いている FixedDocument パーツに新しい FixedPage パーツを書き込みます。

構文

HRESULT AddPage(
  [in] IXpsOMPage                   *page,
  [in] const XPS_SIZE               *advisoryPageDimensions,
  [in] IXpsOMPartUriCollection      *discardableResourceParts,
  [in] IXpsOMStoryFragmentsResource *storyFragments,
  [in] IXpsOMPrintTicketResource    *pagePrintTicket,
  [in] IXpsOMImageResource          *pageThumbnail
);

パラメーター

[in] page

現在開いているパッケージの FixedDocument にページコンテンツを書き込む IXpsOMPage インターフェイス。

[in] advisoryPageDimensions

ページディメンションを含む XPS_SIZE 構造体。

サイズは XPS 単位で説明されています。 1 インチあたり 96 個の XPS ユニットがあります。たとえば、8.5" x 11.0" ページのサイズは 816 x 1,056 XPS 単位です。

[in] discardableResourceParts

破棄可能なリソースパーツのコレクションを含む IXpsOMPartUriCollection インターフェイス。

[in] storyFragments

このページに使用する IXpsOMStoryFragmentsResource インターフェイス。

[in] pagePrintTicket

このページのページレベルの印刷チケットを含む IXpsOMPrintTicketResource インターフェイス。「解説」も参照してください。

[in] pageThumbnail

このページのサムネイル画像を含む IXpsOMImageResource インターフェイス。

戻り値

このメソッドは HRESULT を返します。使用可能な値には、次の表に含まれる値が含まれますが、これらに限定されません。この表に記載されていない XPS ドキュメント API の戻り値については、「 XPS ドキュメントエラー」を参照してください。

リターンコード	説明
S_OK	メソッドが成功しました。
XPS_E_MISSING_DISCARDCONTROL	ページは破棄可能なリソースを参照しますが、DiscardControl パーツ名は指定しません。
XPS_E_MISSING_DOCUMENT	このメソッドは、StartNewDocument の前に呼び出されました。
XPS_E_UNAVAILABLE_PACKAGE	重大なエラーが発生し、XPS OM の内容が回復できない可能性があります。 XPS OM の一部のコンポーネントは引き続き使用できますが、検証後にのみ使用できます。このエラーが返された後は XPS OM の状態を予測できないため、XPS OM のすべてのコンポーネントを解放して破棄する必要があります。

このメソッドは Packaging API を呼び出します。 Packaging API の戻り値の詳細については、「パッケージ化エラー」を参照してください。

注釈

StartNewDocument を呼び出した後、このメソッドを呼び出します。

このメソッドは、パッケージに新しい FixedPage パーツを作成し、ページパラメーターで渡される IXpsOMPage インターフェイスの内容をコピーし、 ページ がパッケージに書き込まれた後に新しい FixedPage パーツを閉じます。

pagePrintTicket にNULL ポインターが含まれており、パッケージライターがインターリーブを XPS_INTERLEAVING_ON に設定して作成された場合、このメソッドは空白のページレベルの印刷チケットを作成します (まだ存在しない場合)。 pagePrintTicket で NULL ポインターを使用してメソッドが呼び出されるたびに、新しいページから空白の印刷チケットにリレーションシップが追加されます。これは、パッケージのストリーミング消費をより効率的にするために行われます。

pagePrintTicket にNULL ポインターが含まれており、パッケージライターがインターリーブを XPS_INTERLEAVING_OFF に設定して作成された場合、空白の印刷チケットは作成されません。

要件

要件	値
サポートされている最小のクライアント	Windows 7、Windows Vista SP2 と Windows Vista 用プラットフォーム更新プログラム [デスクトップアプリ \|UWP アプリ]
サポートされている最小のサーバー	Windows Server 2008 R2、Windows Server 2008 SP2 および Windows Server 2008 用プラットフォーム更新プログラム [デスクトップアプリ \|UWP アプリ]
対象プラットフォーム	Windows
ヘッダー	xpsobjectmodel.h