IXpsOMPackage::WriteToFile メソッド (xpsobjectmodel.h)

  • [アーティクル]

XPS パッケージを指定したファイルに書き込みます。

構文

HRESULT WriteToFile(
  [in] LPCWSTR               fileName,
  [in] LPSECURITY_ATTRIBUTES securityAttributes,
  [in] DWORD                 flagsAndAttributes,
  [in] BOOL                  optimizeMarkupSize
);

パラメーター

[in] fileName

作成するファイルの名前。 このパラメーターは NULL にすることはできません。

[in] securityAttributes

2 つの異なるが関連するデータ メンバーを含む SECURITY_ATTRIBUTES 構造体。

  • lpSecurityDescriptor: オプションのセキュリティ記述子
  • bInheritHandle: 返されたハンドルを子プロセスによって継承できるかどうかを決定するブール値
lpSecurityDescriptor が NULL の場合、返されるハンドルに関連付けられているファイルまたはデバイスには、既定のセキュリティ記述子が割り当てられます。

securityAttributes パラメーターの詳細については、「CreateFile」を参照してください。

[in] flagsAndAttributes

作成するファイルの設定と属性を指定します。 ほとんどのファイルでは、 FILE_ATTRIBUTE_NORMAL の値を使用できます。

flagsAndAttributes パラメーターの詳細については、「CreateFile」を参照してください。

[in] optimizeMarkupSize

ドキュメント マークアップをファイルに書き込むときに、サイズに合わせて最適化するかどうかを示すブール値。

値 意味
True
 パッケージ ライターは、最小サイズのマークアップの最適化を試みます。
False
 パッケージ ライターは最適化を試みません。

戻り値

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

リターン コード 説明
S_OK
 メソッドが成功しました。
E_POINTER
 fileName は NULL です。
 

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

注釈

optimizeMarkupSize 値は、個々のドキュメント パーツ内のマークアップを最適化するかどうかを決定します。 パーツのインターリーブ方法には影響しません。

メモ XPS OM をファイルに書き込んでも、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

こちらもご覧ください

CreateFile

IXpsOMPackage

パッケージ化エラー

SECURITY_ATTRIBUTES

XML Paper Specification

XPS ドキュメント エラー