EnumPrintProcessorDatatypes function

The EnumPrintProcessorDatatypes function enumerates the data types that a specified print processor supports.

Syntax


BOOL EnumPrintProcessorDatatypes(
  _In_   LPTSTR pName,
  _In_   LPTSTR pPrintProcessorName,
  _In_   DWORD Level,
  _Out_  LPBYTE pDatatypes,
  _In_   DWORD cbBuf,
  _Out_  LPDWORD pcbNeeded,
  _Out_  LPDWORD pcReturned
);

Parameters

pName [in]

A pointer to a null-terminated string that specifies the name of the server on which the print processor resides. If this parameter is NULL, the data types for the local print processor are enumerated.

pPrintProcessorName [in]

A pointer to a null-terminated string that specifies the name of the print processor whose data types are enumerated.

Level [in]

The type of information returned in the pDatatypes buffer. This parameter must be 1.

pDatatypes [out]

A pointer to a buffer that receives an array of DATATYPES_INFO_1 structures. Each structure describes an available data type. The buffer must be large enough to receive the array of structures and any strings or other data to which the structure members point.

To determine the required buffer size, call EnumPrintProcessorDatatypes with cbBuf set to zero. EnumPrintProcessorDatatypes fails, GetLastError returns ERROR_INSUFFICIENT_BUFFER, and the pcbNeeded parameter returns the size, in bytes, of the buffer required to hold the array of structures and their data.

cbBuf [in]

The size, in bytes, of the buffer pointed to by pDatatypes.

pcbNeeded [out]

A pointer to a variable that receives the number of bytes copied to the pDatatypes buffer if the function succeeds. If the buffer is too small, the function fails and the variable receives the number of bytes required.

pcReturned [out]

A pointer to a variable that receives the number of structures returned in the pDatatypes buffer. This is the number of supported data types.

Return value

If the function succeeds, the return value is a nonzero value.

If the function fails, the return value is zero.

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.

v

Starting with Windows Vista, the data type information from remote print servers is retrieved from a local cache.

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Winspool.h (include Windows.h)

Library

Winspool.lib

DLL

Winspool.drv

Unicode and ANSI names

EnumPrintProcessorDatatypesW (Unicode) and EnumPrintProcessorDatatypesA (ANSI)

See also

Printing
Print Spooler API Functions
DATATYPES_INFO_1
EnumPrintProcessors

 

 

Community Additions

ADD
Show:
© 2014 Microsoft