SetPrinterData
The SetPrinterData
function sets the configuration data for a printer.
DWORD SetPrinterData(
|
HANDLE hPrinter, |
// handle of
printer object |
|
LPTSTR pValueName, |
// address of data
type |
|
DWORD Type, |
// flag for value
type |
|
LPBYTE pData, |
// address of array
that specifies printer data |
|
DWORD cbData |
// size, in bytes,
of array |
|
); |
|
Parameters
hPrinter
Identifies
the printer for which the configuration data should be set.
pValueName
Points to a
null-terminated string that specifies the type of data to be set.
Type
Specifies the
type of information to be stored as the value s data. This parameter can be one
of the following values:
|
Value |
Meaning |
|
REG_BINARY |
Binary data
in any form. |
|
REG_DWORD |
A 32-bit
number. |
|
REG_DWORD_LITTLE_ENDIAN |
A 32-bit
number in little-endian format (same as REG_DWORD). In little-endian format,
the most significant byte of a word is the high-order byte. This is the most
common format for computers running Windows NT and Windows 95. |
|
REG_DWORD_BIG_ENDIAN |
A 32-bit
number in big-endian format. In big-endian format, the most significant byte
of a word is the low-order byte. |
|
REG_EXPAND_SZ |
A
null-terminated string that contains unexpanded references to environment
variables (for example, %PATH% ). It will be a Unicode or ANSI string
depending on whether you use the Unicode or ANSI functions. |
|
REG_LINK |
A Unicode
symbolic link. |
|
REG_MULTI_SZ |
An array of
null-terminated strings, terminated by two null characters. |
|
REG_NONE |
No defined
value type. |
|
REG_RESOURCE_LIST |
A
device-driver resource list. |
|
REG_SZ |
A
null-terminated string. It will be a Unicode or ANSI string depending on
whether you use the Unicode or ANSI functions. |
pData
Points to an
array of bytes that contains the printer configuration data.
cbData
Specifies the
size, in bytes, of the array.
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 handle hPrinter
is obtained by calling the OpenPrinter function.
Existing
configuration data for a printer can be retrieved by calling the GetPrinter
function.
See Also