GetPrinterData
The GetPrinterData
function retrieves printer-configuration data for the specified printer.
DWORD GetPrinterData(
|
HANDLE hPrinter, |
// handle of
printer object |
|
LPTSTR pValueName, |
// address of data
type |
|
LPDWORD pType, |
// reserved |
|
LPBYTE pData, |
// address of array
of bytes that receives data |
|
DWORD nSize, |
// size, in bytes,
of array |
|
LPDWORD pcbNeeded |
// address of
variable with number of bytes retrieved (or required) |
|
); |
|
Parameters
hPrinter
Identifies
the printer for which configuration data should be retrieved.
pValueName
Points to a
null-terminated string that specifies the type of data that the function should
retrieve.
pType
Points to a
variable that receives the data type stored by the SetPrinterData function. GetPrinterData
passes pType on as the lpdwType parameter of a RegQueryValueEx function call. This
parameter may be NULL.
pData
Points to an
array of bytes that receives the configuration data.
nSize
Specifies the
size, in bytes, of the buffer pointed to by pData.
pcbNeeded
Points to a
value that specifies the number of bytes copied if the function succeeds or the
number of bytes required if nSize is too small.
Return Values
If the
function succeeds, the return value is ERROR_SUCCESS.
If the
function fails, the return value is an error value.
Remarks
The printer
handle identified by the hPrinter parameter is obtained by calling the OpenPrinter
function.
GetPrinterData retrieves printer-configuration data set by the SetPrinter
function.
See Also