MXDC_PRINTTICKET_ESCAPE_T structure

The MXDC_PRINTTICKET_ESCAPE_T structure is a MXDC_ESCAPE_HEADER_T structure concatenated with a MXDC_PRINTTICKET_DATA_T structure.

Syntax

typedef struct tagMxdcPrintTicketEscape {
  MXDC_ESCAPE_HEADER_T    mxdcEscape;
  MXDC_PRINTTICKET_DATA_T printTicketData;
} MXDC_PRINTTICKET_ESCAPE_T, *P_MXDC_PRINTTICKET_ESCAPE_T;

Members

mxdcEscape

A MXDC_ESCAPE_HEADER_T structure with its opCode member set to MXDCOP_PRINTTICKET_FIXED_PAGE, MXDCOP_PRINTTICKET_FIXED_DOC, or MXDCOP_PRINTTICKET_FIXED_DOC_SEQ.

printTicketData

A MXDC_PRINTTICKET_DATA_T structure containing the print ticket.

Remarks

This structure is passed in the lpszInData parameter of the ExtEscape function when that function is called with the MXDC_ESCAPE escape and the opCode member of the MXDC_ESCAPE_HEADER_T structure is MXDCOP_PRINTTICKET_FIXED_PAGE, MXDCOP_PRINTTICKET_FIXED_DOC, or MXDCOP_PRINTTICKET_FIXED_DOC_SEQ. The result is to write the print ticket to the XPS document file.

Allocate memory for the escape as shown below, set the fields as needed, and then call ExtEscape.

// Compute size of buffer required adding the
//  size of the escape structure to the size
//  of the resource data buffer.
SIZE_T iTotalDataSize = sizeof(MXDC_PRINTTICKET_ESCAPE_T) + 
                        iS0PageDataSize - 1;

// Allocate the memory buffer.
P_MXDC_PRINTTICKET_ESCAPE_T pS0PageEscapeData = 
                        (P_MXDC_PRINTTICKET_ESCAPE_T)HeapAlloc(
                            GetProcessHeap(),
                            0,
                            iTotalDataSize);

If the opCode is set to MXDCOP_PRINTTICKET_FIXED_PAGE, the call to ExtEscape must occur between a call to StartPage and a call to EndPage. If the opCode set to either MXDCOP_PRINTTICKET_FIXED_DOC or MXDCOP_PRINTTICKET_FIXED_DOC_SEQ, the call to ExtEscape must occur between a call to StartDoc and a call to EndDoc.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2008 [desktop apps only]
Header	Mxdc.h

See also

Printing

Print Spooler API Structures

GDI Printer Escape Functions

ExtEscape

MXDC_ESCAPE