EnumPrintProcessorDatatypes

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

BOOL EnumPrintProcessorDatatypes(
  LPTSTR pName,                // printer server name
  LPTSTR pPrintProcessorName,  // print processor name
  DWORD Level,                 // information level
  LPBYTE pDatatypes,           // processor data buffer
  DWORD cbBuf,                 // size of data buffer
  LPDWORD pcbNeeded,           // bytes received or required
  LPDWORD pcReturned           // number of processors
);

Parameters

pName

[in] 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] Pointer to a null-terminated string that specifies the name of the print processor whose data types are enumerated.

Level

[in] Specifies the type of information returned in the pDatatypes buffer. This parameter must be 1.

pDatatypes

[out] 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] Specifies the size, in bytes, of the buffer pointed to by pDatatypes.

pcbNeeded

[out] 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] Pointer to a variable that receives the number of structures returned in the pDatatypes buffer. This is the number of supported data types.

Return Values

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

If the function fails, the return value is zero. To get extended error information, call GetLastError.

Requirements

  Windows NT/2000: Requires Windows NT 3.5 or later.
  Windows 95/98: Requires Windows 95 or later.
  Header: Declared in Winspool.h; include Windows.h.
  Library: Use Winspool.lib.
  Unicode: Implemented as Unicode and ANSI versions on Windows NT/2000.

See Also

Printing and Print Spooler Overview, Printing and Print Spooler Functions, DATATYPES_INFO_1, EnumPrintProcessors