IXpsOMObjectFactory::CreatePackageWriterOnStream メソッド (xpsobjectmodel.h)

[アーティクル]
12/22/2023

XPS OM の内容を XPS パッケージに書き込むためのストリームを開きます。

構文

HRESULT CreatePackageWriterOnStream(
  [in]          ISequentialStream         *outputStream,
  [in]          BOOL                      optimizeMarkupSize,
  [in]          XPS_INTERLEAVING          interleaving,
  [in]          IOpcPartUri               *documentSequencePartName,
  [in]          IXpsOMCoreProperties      *coreProperties,
  [in]          IXpsOMImageResource       *packageThumbnail,
  [in]          IXpsOMPrintTicketResource *documentSequencePrintTicket,
  [in]          IOpcPartUri               *discardControlPartName,
  [out, retval] IXpsOMPackageWriter       **packageWriter
);

パラメーター

[in] outputStream

書き込みに使用するストリーム。

[in] optimizeMarkupSize

ドキュメントがストリームに書き込まれるときに、ドキュメントマークアップがサイズに合わせて最適化されるかどうかを示すブール値。

値	意味
True	ストリームに書き込む場合、パッケージライターはマークアップの最小サイズの最適化を試みます。
False	パッケージに書き込む場合、パッケージライターは最適化を試みません。

[in] interleaving

ストリームに書き込まれるときに XPS OM のコンテンツをインターリーブするかどうかを指定します。

[in] documentSequencePartName

新しいファイル内のドキュメントシーケンスのパーツ名を含む IOpcPartUri インターフェイス。

[in] coreProperties

新しいファイルに指定するコアドキュメントプロパティを含む IXpsOMCoreProperties インターフェイス。このパラメーターは NULL に設定できます。

[in] packageThumbnail

新しいファイルに割り当てるサムネイルイメージを含む IXpsOMImageResource インターフェイス。このパラメーターは NULL に設定できます。

[in] documentSequencePrintTicket

新しいファイルに割り当てるパッケージレベルの印刷チケットを含む IXpsOMPrintTicketResource インターフェイス。このパラメーターは NULL に設定できます。

[in] discardControlPartName

破棄コントロールパーツの名前を含む IOpcPartUri インターフェイス。このパラメーターは NULL に設定できます。

[out, retval] packageWriter

このメソッドによって作成された新しい IXpsOMPackageWriter インターフェイスへのポインター。

戻り値

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

リターンコード	説明
S_OK	メソッドが成功しました。
E_POINTER	outputStream、 documentSequencePartName、または packageWriter が NULL です。
XPS_E_NO_CUSTOM_OBJECTS	coreProperties、 documentSequencePrintTicket 、 packageThumbnail は、認識されたインターフェイス実装を指していません。 XPS ドキュメント API インターフェイスのカスタム実装はサポートされていません。

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

注釈

ストリームを開いて初期化した後、返された IXpsOMPackageWriter インターフェイスを使用して、コンテンツタイプ、パッケージリレーションシップ、コアプロパティ、ドキュメントシーケンスリソース、およびドキュメントシーケンスリレーションシップを書き込みます。

documentSequencePrintTicket が NULL に設定され、インターリーブの値がXPS_INTERLEAVING_ON場合、このメソッドは空のジョブレベルの印刷チケットを作成し、空白の印刷チケットにリレーションシップを追加します。これは、パッケージのより効率的なストリーミング消費を提供するために行われます。

documentSequencePrintTicket が 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