IXpsOMDocument::GetPrintTicketResource method (xpsobjectmodel.h)

Article
02/22/2024

Gets the IXpsOMPrintTicketResource interface of the document-level print ticket.

Syntax

HRESULT GetPrintTicketResource(
  [out, retval] IXpsOMPrintTicketResource **printTicketResource
);

Parameters

[out, retval] printTicketResource

A pointer to the IXpsOMPrintTicketResource interface of the document-level print ticket that is associated with the document. If no print ticket has been assigned, a NULL pointer will be returned.

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 code	Description
S_OK	The method succeeded.
E_POINTER	printTicketResource is NULL.

Remarks

After loading and parsing the resource into the XPS OM, this method might return an error that applies to another resource. This occurs because all of the relationships are parsed when a resource is loaded.

Requirements

Requirement	Value
Minimum supported client	Windows 7, Windows Vista with SP2 and Platform Update for Windows Vista [desktop apps \| UWP apps]
Minimum supported server	Windows Server 2008 R2, Windows Server 2008 with SP2 and Platform Update for Windows Server 2008 [desktop apps \| UWP apps]
Target Platform	Windows
Header	xpsobjectmodel.h