IPrintOemPrintTicketProvider::GetSupportedVersions method (prcomoem.h)

Article
02/22/2024

The IPrintOemPrintTicketProvider::GetSupportedVersions method retrieves major versions of the print schemas that are supported by the plug-in provider.

Syntax

HRESULT GetSupportedVersions(
  [in]  HANDLE   hPrinter,
  [out] INT * [] ppVersions,
  [out] INT      *cVersions
);

Parameters

[in] hPrinter

A handle to the print device.

[out] ppVersions

A pointer to a variable that receives the address of the first element of an array of version numbers. Version numbers in the array can appear in any order. For more information about this parameter, see the following Remarks section.

[out] cVersions

A pointer to a variable that receives the number of elements in the array that is pointed to by *ppVersions.

Return value

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

Remarks

IPrintOemPrintTicketProvider::GetSupportedVersions returns the major version numbers of the print schemas that are supported by the provider interface. (The only currently defined version number is 1.) Providers can omit intermediate versions.

The plug-in is responsible for allocating the array memory that is pointed to by the ppVersions parameter. The plug-in should allocate this memory by using the CoTaskMemAlloc function (described in the Microsoft Windows SDK documentation), but it is not responsible for freeing this memory.

IPrintOemPrintTicketProvider::GetSupportedVersions can be called before the IPrintOemPrintTicketProvider::BindPrinter method is called. As a result, the OEM plug-in provider should not close the printer handle that is associated with the hPrinter parameter.

Requirements

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