IXpsOMPackage1::WriteToFile1 メソッド (xpsobjectmodel_1.h)
XPS OM を、指定した種類の XPS パッケージとしてファイルに書き込みます。
構文
HRESULT WriteToFile1(
LPCWSTR fileName,
LPSECURITY_ATTRIBUTES securityAttributes,
DWORD flagsAndAttributes,
BOOL optimizeMarkupSize,
XPS_DOCUMENT_TYPE documentType
);
パラメーター
fileName
[in, string]作成するファイルの名前。 このパラメーターは NULL にすることはできません。
securityAttributes
[入力、一意]2 つの異なるが関連するデータ メンバーを含むSECURITY_ATTRIBUTES構造体。
lpSecurityDescriptor: オプションのセキュリティ記述子
bInheritHandle: 返されたハンドルを子プロセスによって継承できるかどうかを決定するブール値
lpSecurityDescriptor が NULL の場合、返されるハンドルに関連付けられているファイルまたはデバイスには、既定のセキュリティ記述子が割り当てられます。
securityAttributes パラメーターの詳細については、「CreateFile」を参照してください。
flagsAndAttributes
[入力]作成するファイルの設定と属性を指定します。 ほとんどのファイルでは、FILE_ATTRIBUTE_NORMALの値を使用できます。
flagsAndAttributes パラメーターの詳細については、「CreateFile」を参照してください。
optimizeMarkupSize
[入力]XPS OM の内容が XPS パッケージに書き込まれるときに、ドキュメント マークアップがサイズに合わせて最適化されるかどうかを示すブール値。
TRUE: パッケージ ライターは、最小サイズのマークアップを最適化しようとします。
FALSE: パッケージ ライターは最適化の実行を試みません。
documentType
[入力]outputStream に書き込む XPS データ形式。 このパラメーターの値をXPS_DOCUMENT_TYPE_UNSPECIFIEDすることはできません。
戻り値
このメソッドは HRESULT を返します。 指定できる値には、次の値が含まれますが、これらに限定されません。 この表に記載されていない XPS ドキュメント API の戻り値の詳細については、「XPS ドキュメント エラー」を参照してください。
S_OK: メソッドが成功しました。
E_POINTER: documentType が NULL です。
E_INVALIDARG: ドキュメントの種類がXPS_DOCUMENT_TYPE_UNSPECIFIEDとして指定されました。
XPS_E_INVALID_CONTENT_TYPE: パッケージ内のイメージ リソースは、documentType で指定されたドキュメントの種類でサポートされていない型です。
解説
呼び出し元は、パッケージ内のすべてのイメージ リソースがパッケージの種類でサポートされていることを確認する必要があります。 たとえば、JPEGXR イメージは互換性がないため、MSXPS ドキュメントの種類では使用できません。
要件
サポートされている最小のクライアント | Windows 8 [デスクトップ アプリ |UWP アプリ] |
サポートされている最小のサーバー | Windows Server 2012 [デスクトップ アプリ |UWP アプリ] |
対象プラットフォーム | Windows |
ヘッダー | xpsobjectmodel_1.h |
Library | なし |