Skip to content

Latest commit

 

History

History
88 lines (67 loc) · 3.19 KB

nf-xpsobjectmodel_1-ixpsompackage1-writetostream1.md

File metadata and controls

88 lines (67 loc) · 3.19 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:xpsobjectmodel_1.IXpsOMPackage1.WriteToStream1
IXpsOMPackage1::WriteToStream1 (xpsobjectmodel_1.h)
Writes an XPS OM to a stream as an XPS package of a specified type.
IXpsOMPackage1 interface [XPS Documents and Packaging]
WriteToStream1 method
IXpsOMPackage1.WriteToStream1
IXpsOMPackage1::WriteToStream1
WriteToStream1
WriteToStream1 method [XPS Documents and Packaging]
WriteToStream1 method [XPS Documents and Packaging]
IXpsOMPackage1 interface
xps.ixpsompackage1_writetostream1
xpsobjectmodel_1/IXpsOMPackage1::WriteToStream1
xps\ixpsompackage1_writetostream1.htm
xps
7f430aa1-1570-44d6-9aec-a4b2fb55f2dc
12/05/2018
IXpsOMPackage1 interface [XPS Documents and Packaging],WriteToStream1 method, IXpsOMPackage1.WriteToStream1, IXpsOMPackage1::WriteToStream1, WriteToStream1, WriteToStream1 method [XPS Documents and Packaging], WriteToStream1 method [XPS Documents and Packaging],IXpsOMPackage1 interface, xps.ixpsompackage1_writetostream1, xpsobjectmodel_1/IXpsOMPackage1::WriteToStream1
xpsobjectmodel_1.h
Windows
Windows 8 [desktop apps \| UWP apps]
Windows Server 2012 [desktop apps \| UWP apps]
XpsObjectModel.idl
None
Windows
19H1
IXpsOMPackage1::WriteToStream1
xpsobjectmodel_1/IXpsOMPackage1::WriteToStream1
c++
APIRef
kbSyntax
COM
none
none.dll
IXpsOMPackage1.WriteToStream1

IXpsOMPackage1::WriteToStream1

-description

Writes an XPS OM to a stream as an XPS package of a specified type.

-parameters

-param outputStream

[in] The stream that receives the serialized contents of the package. This parameter must not be NULL.

-param optimizeMarkupSize

[in] A Boolean value that indicates whether the document markup will be optimized for size when the contents of the XPS OM are written to the XPS package.

TRUE: The package writer will try to optimize the markup for minimum size.

FALSE: The package writer will not try to perform any optimization.

-param documentType

[in] The XPS data format to write to outputStream. The value of this parameter cannot be XPS_DOCUMENT_TYPE_UNSPECIFIED.

-returns

The method returns an HRESULT. Possible values include, but are not limited to, the following values. For information about XPS Document API return values that are not listed in this table, see XPS Document Errors.

S_OK: The method succeeded.

E_POINTER: documentType is NULL.

E_INVALIDARG: documentType was set to XPS_DOCUMENT_TYPE_UNSPECIFIED.

XPS_E_INVALID_CONTENT_TYPE: An image resource in the package is of a type that is not supported by the document type specified in documentType.

-see-also

IXpsOMPackage1