IXpsOMObjectFactory::CreatePackageWriterOnFile method

Opens a file for writing the contents of an XPS OM to an XPS package.


HRESULT CreatePackageWriterOnFile(
  [in]          LPCWSTR                   fileName,
  [in, unique]  LPSECURITY_ATTRIBUTES     securityAttributes,
  [in]          DWORD                     flagsAndAttributes,
  [in]          BOOL                      optimizeMarkupSize,
  [in]          XPS_INTERLEAVING          interleaving,
  [in]          IOpcPartUri               *documentSequencePartName,
  [in]          IXpsOMCoreProperties      *coreProperties,
  [in]          IXpsOMImageResource       *packageThumbnail,
  [in]          IXpsOMPrintTicketResource *documentSequencePrintTicket,
  [in]          IOpcPartUri               *discardControlPartName,
  [out, retval] IXpsOMPackageWriter       **packageWriter


fileName [in]

The name of the file to be created.

securityAttributes [in]

The SECURITY_ATTRIBUTES structure, which contains two separate but related members:

  • lpSecurityDescriptor: an optional security descriptor
  • bInheritHandle: a Boolean value that determines whether the returned handle can be inherited by child processes

If lpSecurityDescriptor is NULL, the file or device associated with the returned handle is assigned a default security descriptor.

For more information about securityAttributes, see CreateFile.

flagsAndAttributes [in]

Specifies the settings and attributes of the file to be created. For most files, the FILE_ATTRIBUTE_NORMAL value can be used.

See CreateFile for more information about this parameter.

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.


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


The package writer will not try to perform any optimization.


interleaving [in]

Specifies whether the content of the XPS OM will be interleaved when it is written to the file.

documentSequencePartName [in]

The IOpcPartUri interface that contains the part name of the document sequence in the new file.

coreProperties [in]

The IXpsOMCoreProperties interface that contains the core document properties to be given to the new file. This parameter can be set to NULL.

packageThumbnail [in]

The IXpsOMImageResource interface that contains the thumbnail image to be assigned to the new file. This parameter can be set to NULL.

documentSequencePrintTicket [in]

The IXpsOMPrintTicketResource interface that contains the package-level print ticket to be assigned to the new file. This parameter can be set to NULL.

discardControlPartName [in]

The IOpcPartUri interface that contains the name of the discard control part. This parameter can be set to NULL.

packageWriter [out, retval]

A pointer to the new IXpsOMPackageWriter interface created by this method.

Return value

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 codeDescription

The method succeeded.


filename, documentSequencePartName, or packageWriter is NULL.


coreProperties, documentSequencePrintTicket, or packageThumbnail does not point to a recognized interface implementation. Custom implementation of XPS Document API interfaces is not supported.


This method calls the Packaging API. For information about the Packaging API return values, see Packaging Errors.


The file is opened and initialized and the IXpsOMPackageWriter interface that is returned is then used to write content types, package relationships, core properties, document sequence resources, and document sequence relationships.

If documentSequencePrintTicket is set to NULL and the value of interleaving is XPS_INTERLEAVING_ON, this method creates a blank job-level print ticket and adds a relationship to the blank print ticket. This is done to provide more efficient streaming consumption of the package.

If documentSequencePrintTicket is set to NULL and the value of interleaving is XPS_INTERLEAVING_OFF, no blank print ticket is created.


Minimum supported client

Windows 7, Windows Vista with SP2 and Platform Update for Windows Vista [desktop apps | Windows Store apps]

Minimum supported server

Windows Server 2008 R2, Windows Server 2008 with SP2 and Platform Update for Windows Server 2008 [desktop apps | Windows Store apps]





See also

Packaging Errors
XPS Document Errors
XML Paper Specification