Skip to content

Latest commit

 

History

History
145 lines (114 loc) · 3.95 KB

nf-xpsobjectmodel-ixpsompage-write.md

File metadata and controls

145 lines (114 loc) · 3.95 KB
Raw
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.IXpsOMPage.Write
IXpsOMPage::Write (xpsobjectmodel.h)
Writes the page to the specified stream.
FALSE
IXpsOMPage interface [XPS Documents and Packaging]
Write method
IXpsOMPage.Write
IXpsOMPage::Write
TRUE
Write
Write method [XPS Documents and Packaging]
Write method [XPS Documents and Packaging]
IXpsOMPage interface
xps.ixpsompage_write
xpsobjectmodel/IXpsOMPage::Write
xps\ixpsompage_write.htm
xps
ab586c7d-69e6-4ad7-93f1-3e1437c04856
12/05/2018
FALSE, IXpsOMPage interface [XPS Documents and Packaging],Write method, IXpsOMPage.Write, IXpsOMPage::Write, TRUE, Write, Write method [XPS Documents and Packaging], Write method [XPS Documents and Packaging],IXpsOMPage interface, xps.ixpsompage_write, xpsobjectmodel/IXpsOMPage::Write
xpsobjectmodel.h
Windows
Windows 7, Windows Vista with SP2 and Platform Update for Windows Vista [desktop apps \| UWP apps]
Windows Server 2008 R2, Windows Server 2008 with SP2 and Platform Update for Windows Server 2008 [desktop apps \| UWP apps]
XpsObjectModel.idl
Windows
19H1
IXpsOMPage::Write
xpsobjectmodel/IXpsOMPage::Write
c++
APIRef
kbSyntax
COM
xpsobjectmodel.h
IXpsOMPage.Write

IXpsOMPage::Write

-description

Writes the page to the specified stream.

-parameters

-param stream [in]

The stream that receives the serialized contents of the page.

-param optimizeMarkupSize [in]

A Boolean value that indicates whether the document markup of the page is to be optimized for size when the page is written to the stream.

Value Meaning
TRUE
 The package writer will attempt to optimize the markup for minimum size when writing the page to the stream.
FALSE
 The package writer will not attempt any optimization when writing the page to the stream.

-returns

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

Return code Description
S_OK
 The method succeeded.
E_POINTER
 stream is NULL.

-remarks

To examine the XPS markup of a page before it is written to an XPS package, an application can call the Write method to write the page's contents to a stream. The application can then read that stream to examine the XPS markup as it would be serialized when it is written to the XPS package.

The XPS markup that is written to the stream by this method contains the page markup but none of the page's resources.

-see-also

ISequentialStream

IXpsOMPage

XML Paper Specification

XPS Document Errors