EnumPrintProcessorDatatypes

 

Description

 

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

 

C++ Syntax

 

BOOL EnumPrintProcessorDatatypes(

__in  LPTSTR pName,

__in  LPTSTR pPrintProcessorName,

__in  DWORD Level,

__out LPBYTE pDatatypes,

__in  DWORD cbBuf,

__out LPDWORD pcbNeeded,

__out LPDWORD pcReturned

);

 

PowerBASIC Syntax

 

FUNCTION EnumPrintProcessorDatatypes ( _

BYREF pName AS ASCIIZ, _

BYREF pPrintProcessorName AS ASCIIZ, _

BYVAL Level AS DWORD, _

BYREF pDatatypes AS ANY, _

BYVAL cbBuf AS DWORD, _

BYREF pcbNeeded AS DWORD, _

BYREF pcReturned AS DWORD _

) AS LONG

 

Unicode version:

 

FUNCTION EnumPrintProcessorDatatypesW ( _

BYVAL pName AS DWORD, _

BYVAL pPrintProcessorName AS DWORD, _

BYVAL Level AS DWORD, _

BYREF pDatatypes AS ANY, _

BYVAL cbBuf AS DWORD, _

BYREF pcbNeeded AS DWORD, _

BYREF pcReturned AS DWORD _

) AS LONG

 

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 Value

 

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

 

If the function fails, the return value is zero.

 

Remarks

 

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

 

Valid XHTML 1.0 Transitional