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

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

パッケージの FixedDocumentSequence で新しい FixedDocument を開いて初期化します。

構文

HRESULT StartNewDocument(
  [in] IOpcPartUri                            *documentPartName,
  [in] IXpsOMPrintTicketResource              *documentPrintTicket,
  [in] IXpsOMDocumentStructureResource        *documentStructure,
  [in] IXpsOMSignatureBlockResourceCollection *signatureBlockResources,
  [in] IXpsOMPartUriCollection                *restrictedFonts
);

パラメーター

[in] documentPartName

新しいドキュメントのパーツ名を含む IOpcPartUri インターフェイスへのポインター。

[in] documentPrintTicket

ドキュメントレベルの印刷チケットを含む IXpsOMPrintTicketResource インターフェイスへのポインター。このパッケージにドキュメントレベルの印刷チケットがない場合は、このパラメーターを NULL に設定できます。「解説」も参照してください。

[in] documentStructure

リソースが使用可能な場合は、最初のドキュメント構造リソースを含む IXpsOMDocumentStructureResource インターフェイスへのポインター。使用できない場合は、このパラメーターを NULL に設定できます。

[in] signatureBlockResources

ドキュメントに添付するデジタル署名のコレクションを含む IXpsOMSignatureBlockResourceCollection インターフェイスへのポインター。アタッチするデジタル署名がない場合は、このパラメーターを NULL に設定できます。

[in] restrictedFonts

IXpsOMPartUriCollection インターフェイスへのポインター。それらに対して書き込まれるフォントリレーションシップが制限されている必要があるフォントが含まれています。フォントデータは、 AddResource または Close が呼び出されるまで書き込まれません。

ドキュメントに制限付きフォントが含まれていない場合は、このパラメーターを NULL に設定できます。

戻り値

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

リターンコード	説明
S_OK	メソッドが成功しました。
XPS_E_UNAVAILABLE_PACKAGE	重大なエラーが発生し、XPS OM の内容が回復できない可能性があります。 XPS OM の一部のコンポーネントは、検証後にのみ使用できる場合があります。このエラーが返された後に XPS OM の状態を予測できないため、XPS OM のすべてのコンポーネントを解放して破棄する必要があります。
XPS_E_UNEXPECTED_RESTRICTED_FONT_RELATIONSHIP	restrictedFonts で渡される制限付きフォントコレクションには、無制限のフォントが含まれています。

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

注釈

IXpsOMPage インターフェイスの内容を書き込むには、AddPage を呼び出す前に、このメソッドを呼び出す必要があります。

IXpsOMPackageWriter インターフェイスがインスタンス化された直後に、パッケージには空の固定ドキュメントシーケンスパーツのみが含まれます。このメソッドを初めて呼び出すと、FixedDocument パーツが Fixed Document Sequence パーツに追加され、 AddPage メソッドによってその FixedDocument パーツにページが追加されます。このメソッドが初めて呼び出されるたびに、現在の FixedDocument パーツが閉じられ、新しい FixedDocument パーツが開き、固定ドキュメントシーケンスパーツに追加されます。 以降の AddPage メソッドの呼び出しはすべて、最後に開いた FixedDocument パーツにページを追加します。このインターフェイスでは、閉じた FixedDocument パーツへのページの追加はサポートされていません。

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

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

メモパッケージに新しいドキュメントを作成しても、XPS ドキュメントのサムネイルは自動的には作成されません。 XPS ドキュメントのサムネイルを作成するには、 IXpsOMThumbnailGenerator インターフェイスを使用します。

要件

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