次の方法で共有

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

SECURITY_ATTRIBUTES 構造体。2 つの個別のデータ メンバーが含まれていますが、関連するデータ メンバーは次のとおりです。

  • 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 アプリ]
ターゲット プラットフォーム の ウィンドウズ
ヘッダー xpsobjectmodel.h

関連項目

CreateFile の

IXpsOMPackage の

パッケージ化エラーの を する

SECURITY_ATTRIBUTES

XML Paper Specification

XPS ドキュメント エラー の