IXpsOMObjectFactory::CreatePackageWriterOnStream メソッド (xpsobjectmodel.h)
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
ドキュメントがストリームに書き込まれるときに、ドキュメント マークアップがサイズに合わせて最適化されるかどうかを示すブール値。
| 値 | 意味 |
|---|---|
|
ストリームに書き込む場合、パッケージ ライターはマークアップの最小サイズの最適化を試みます。 |
|
パッケージに書き込む場合、パッケージ ライターは最適化を試みません。 |
[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 ドキュメント エラー」を参照してください。
| リターン コード | 説明 |
|---|---|
|
メソッドが成功しました。 |
|
outputStream、 documentSequencePartName、または packageWriter が NULL です。 |
|
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 |