IPrintOemPrintTicketProvider::ConvertDevModeToPrintTicket method (prcomoem.h)

Article
08/23/2022

The IPrintOemPrintTicketProvider::ConvertDevModeToPrintTicket method converts a DEVMODEW structure into a print ticket.

Syntax

HRESULT ConvertDevModeToPrintTicket(
  [in]      ULONG            cbDevmode,
  [in]      PDEVMODE         pDevmode,
  [in]      ULONG            cbDrvPrivateSize,
  [in]      PVOID            pPrivateDevmode,
  [in, out] IXMLDOMDocument2 *pPrintTicket
);

Parameters

[in] cbDevmode

The size, in bytes, of the input DEVMODEW structure. The size includes both the public and private portions of this structure.

[in] pDevmode

A pointer to the input DEVMODEW structure.

[in] cbDrvPrivateSize

The size, in bytes, of the plug-in's private DEVMODEW structure.

[in] pPrivateDevmode

A pointer to the plug-in's private DEVMODEW structure.

[in, out] pPrintTicket

A pointer to the partially-completed print ticket. When IPrintOemPrintTicketProvider::ConvertDevModeToPrintTicket returns, all of the entries in the print ticket should be filled in.

Return value

IPrintOemPrintTicketProvider::ConvertDevModeToPrintTicket should return S_OK if the operation succeeds. Otherwise, this method should return a standard COM error code.

Remarks

The core driver calls the IPrintOemPrintTicketProvider::ConvertDevModeToPrintTicket method with an input print ticket that is populated with public and Unidrv-private or Pscript5-private features. The plug-in is free to set DEVMODEW settings in the public part or in the plug-in's private part, based on settings in the input print ticket. In addition to setting new DEVMODEW items, the plug-in can modify existing settings in the public portion of the DEVMODEW structure.

The DEVMODEW structure fields that correlate with the part of the DEVMODEW structure of interest to the client will already have been populated before IPrintOemPrintTicketProvider::ConvertDevModeToPrintTicket is called, including the public portion of the DEVMODEW structure and excluding the privately-defined values in the public portion of the DEVMODEW structure.

Requirements

Requirement	Value
Target Platform	Desktop
Header	prcomoem.h (include Prcomoem.h)