PTOpenProvider function (prntvpt.h)

Article
07/27/2022

Opens an instance of a print ticket provider.

Syntax

HRESULT PTOpenProvider(
  [in]  PCWSTR      pszPrinterName,
        DWORD       dwVersion,
  [out] HPTPROVIDER *phProvider
);

Parameters

[in] pszPrinterName

A pointer to the full name of a print queue.

dwVersion

The version of the Print Schema requested by the caller.

[out] phProvider

A pointer to a handle for the provider.

Return value

If the operation succeeds, the return value is S_OK, otherwise the HRESULT contains an error code.

For more information about COM error codes, see Error Handling.

Remarks

Note This is a blocking or synchronous function and might not return immediately. How quickly this function returns depends on run-time factors such as network status, print server configuration, and printer driver implementation—factors that are difficult to predict when writing an application. Calling this function from a thread that manages interaction with the user interface could make the application appear to be unresponsive.

pszPrinterName must be the full name, not the truncated name as it may appear in a DEVMODE.

The first version of the Print Schema was released with Windows Vista and is version 1. This operation fails if version is not supported. Contrast this with PTOpenProviderEx which opens a provider even if it supports only versions that are earlier than requested.

To avoid a resource leak, phProvider must be closed with PTCloseProvider.

Requirements

Requirement	Value
Minimum supported client	Windows XP [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	prntvpt.h
Library	Prntvpt.lib
DLL	Prntvpt.dll