На главную

On-line справка по Win32 API

Написать письмо
БЕСПЛАТНАЯ ежедневная online лотерея! Выигрывай каждый день БЕСПЛАТНО!
Список всех статей A-B-C-D-E-F-G-H-I-J-K-L-M-N-O-P-Q-R-S-T-U-V-W-X-Y-Z | Скачать Вниз

EnumPrinterData



[New - Windows NT]

The EnumPrinterData function enumerates configuration data for a specified printer.
A printer's configuration data consists of a set of named and typed values. The EnumPrinterData function obtains one of these values, and its name and a type code, each time you call it. Call the EnumPrinterData function several times in succession to obtain all of a printer's configuration data values.
Printer configuration data is stored in the registry. While enumerating printer configuration data, you should avoid calling registry functions that might change that data.

DWORD EnumPrinterData(

HANDLE hPrinter, // handle to printer of interest
DWORD dwIndex, // index of value to retrieve
LPTSTR pValueName, // pointer to buffer to receive value name
DWORD cbValueName, // size in bytes of value name buffer
LPDWORD pcbValueName, // pointer to variable to receive number of bytes stored into value name buffer
LPDWORD pType, // pointer to variable to receive value type code
LPBYTE pData, // pointer to buffer to receive value data
DWORD cbData, // size in bytes of value data buffer
LPDWORD pcbData // pointer to variable to receive number of bytes stored into value data buffer
);


Parameters

hPrinter

Handle to the printer whose configuration data is to be obtained.
You obtain this printer handle by calling the OpenPrinter function.

dwIndex

An index value that specifies the configuration data value to retrieve.
Set this parameter to zero for the first call to EnumPrinterData for a given printer handle. Then increment the parameter by one for subsequent calls involving the same printer, until the function returns ERROR_NO_MORE_ITEMS. See the following Remarks section for further information.
Note: If you use the technique mentioned in the descriptions of the cbValueName and cbData parameters to obtain adequate buffer size values, setting both those parameters to zero in a first call to EnumPrinterData for a given printer handle, the value of dwIndex does not matter for that call. Set dwIndex to zero in the next call to EnumPrinterData to start the actual enumeration process.

Configuration data values are not ordered. New values will have an arbitrary index. This means that the EnumPrinterData function may return values in any order.

pValueName

Pointer to a buffer that receives the name of the configuration data value, including a terminating null character.

cbValueName

Specifies the size, in bytes, of the buffer pointed to by pValueName.
If you want to have the operating system supply an adequate buffer size, set both this parameter and the cbData parameter to zero for the first call to EnumPrinterData for a given printer handle. When the function returns, the variable pointed to by pcbValueName will contain a buffer size that is large enough to successfully enumerate all of the printer's configuration data value names.

pcbValueName

Pointer to a variable that receives the number of bytes stored into the buffer pointed to by pValueName.

pType

Pointer to a variable that receives a type code for the value specified by dwIndex. The type code 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. This is equivalent to REG_DWORD.In little-endian format, a multi-byte value is stored in memory from the lowest byte (the "little end") to the highest byte. For example, the value 0x12345678 is stored as (0x78 0x56 0x34 0x12) in little-endian format.Windows NT and Windows 95 are designed to run on little-endian computer architectures. A user may connect to computers that have big-endian architectures, such as some UNIX systems.
REG_DWORD_BIG_ENDIAN A 32-bit number in big-endian format. In big-endian format, a multi-byte value is stored in memory from the highest byte (the "big end") to the lowest byte. For example, the value 0x12345678 is stored as (0x12 0x34 0x56 0x78) in big-endian format.Windows NT and Windows 95 are designed to run on little-endian computer architectures. A user may connect to computers that have big-endian architectures, such as some UNIX systems.
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.


The pType parameter can be NULL if the type code is not required.

pData

Pointer to a buffer that receives the configuration data value.
This parameter can be NULL if the configuration data value is not required.

cbData

Specifies the size, in bytes, of the buffer pointed to by pData.
If you want to have the operating system supply an adequate buffer size, set both this parameter and the cbValueName parameter to zero for the first call to EnumPrinterData for a given printer handle. When the function returns, the variable pointed to by pcbData will contain a buffer size that is large enough to successfully enumerate all of the printer's configuration data value names.

pcbData

Pointer to a variable that receives the number of bytes stored into the buffer pointed to by pData.
This parameter can be NULL if pData is NULL.



Return Values

If the function succeeds, the return value is ERROR_SUCCESS.
If the function fails, the return value is a Win32 error value.
The function returns ERROR_NO_MORE_ITEMS when there are no more configuration data values to retrieve for a given printer handle.

Remarks

EnumPrinterData retrieves printer configuration data set by the SetPrinterData function.
If you want to have the operating system supply an adequate buffer size, first call EnumPrinterData with both the cbValueName and cbData parameters set to zero, as noted earlier in the Parameters section. The value of dwIndex does not matter for this call. When the function returns, *pcbValueName and *
pcbData will contain buffer sizes that are large enough to enumerate all of the printer's configuration data value names and values. On the next call, allocate value name and data buffers, set cbValueName and cbData to the sizes in bytes of the allocated buffers, and set dwIndex to zero. Thereafter, continue to call the EnumPrinterData function, incrementing dwIndex by one each time, until the function returns ERROR_NO_MORE_ITEMS.

See Also

DeletePrinterData, GetPrinterData, OpenPrinter, SetPrinter, SetPrinterData


Пригласи друзей и счет твоего мобильника всегда будет положительным!
Предыдущая статья
 
Сайт Народ.Ру Интернет
Следующая статья
Пригласи друзей и счет твоего мобильника всегда будет положительным!

EnumPrinterData



[Новый - Windows NT]

Функция EnumPrinterData перечисляет данные конфигурации для определенного принтера.
Данные конфигурации принтера состоит из установки поименованных и напечатанных величин. Функция EnumPrinterData получает одну из этих величин, и имени и код типа, всякий раз, когда Вы называете это. Назовите функцию EnumPrinterData несколько раз последовательно, чтобы получать все величины данных конфигурации принтера.
Данные конфигурации Принтера загружены в регистрацию. Перечисляя данные конфигурации принтера, Вы должны избегать вызывать функции регистрации, которые могли изменить эти данные.

DWORD EnumPrinterData(

РУЧКА hPrinter, // оперируется в принтер интереса DWORD dwIndex, // ценного индекса, чтобы извлекать LPTSTR pValueName, // указатель, чтобы буферизоваться, чтобы получать имя величины DWORD cbValueName, // размер в буфере имени ценных байтов LPDWORD pcbValueName, // указателя в переменную, чтобы получать количество байтов загруженных в буфер имени величины LPDWORD pType, // указателя в переменную, чтобы получать код типа величины LPBYTE pData, // указателя, чтобы буферизоваться, чтобы получать данные величины DWORD cbData, // размера в буфере данных ценного указателя байтов LPDWORD pcbData // в переменную, чтобы получать количество байтов загруженных в буфер данных величины
);


Параметры

hPrinter

Прооперируйте принтер, чьи данные конфигурации должны быть получены.
Вы получаете эту ручку принтера вызывая функцию OpenPrinter.

dwIndex

Индексная величина, которая определяет величину данных конфигурации, чтобы извлекаться.
Установите этот параметр в нуль для первого вызова на EnumPrinterData для данной ручки принтера. Затем увеличьте параметр за последующих вызовов включая тот же принтер, пока функция не возвращает ERROR_NO_MORE_ITEMS. Смотри секцию Замечаний следующего для дальнейшей информации.
Примечание: Если Вы используете технику упомянутую в описаниях cbValueName и параметров cbData, чтобы получать требуемые буферные величины размера, установка оба тех параметра в нуль на первом вызове на EnumPrinterData для данного принтера оперируется, величина dwIndex не имеет значения для этого вызова. Установите dwIndex в нуль на следующем вызове на EnumPrinterData, чтобы запускать фактический процесс перечисления.

Величины данных Конфигурации не заказаны. Новые величины будут иметь произвольный индекс. Это означает, что функция EnumPrinterData может возвращать величины в любой порядок.

pValueName

Указатель в буфер, который получает имя величины данных конфигурации, включая завершающий недействительный символ.

cbValueName

Определяет размер, в байтах, буфера указанного, чтобы pValueName.
Если Вы хотите иметь операционную систему поставлять требуемый буферный размер, установивший как этот параметр так и параметр cbData в нуль для первого вызова на EnumPrinterData для данной ручки принтера. Когда функция возвращается, переменная указанная, чтобы pcbValueName будет содержать буферный размер, который - большой достаточно, чтобы успешно перечислять всю величину данных конфигурации имен принтера.

pcbValueName

Указатель в переменную, которая получает количество байтов загружался в буфер указанный, чтобы pValueName.

pType

Указатель в переменную, которая получает код типа для величины определенной dwIndex. Код типа может быть одним из следующего величин:

Значение Величины
данные Двоичного кода REG_BINARY в любой форме.
REG_DWORD 32- битовое число.
REG_DWORD_LITTLE_ENDIAN 32- битовое число в немного-endian формате. Это - эквивалент REG_DWORD.In немного-endian формату, много-байтовая величина загружена в память из самого низкого байта ( "небольшой конец") в самый верхний байт. Например, величина 0x12345678 загружена как (0x78 0x56 0x34 0x12) в немного-endian формате.Windows NT и Windows 95 предназначены работать на небольшой-endian компьютерной архитектуре. Пользователь может подключить к компьютерам, что иметь архитектуру большого endian, как например, некоторые системы UNIX.
REG_DWORD_BIG_ENDIAN 32- битовое число в формате большого endian. В формате большого endian, много-байтовая величина загружена в память из самого верхнего байта ( "большой конец") в самый низкий байт. Например, величина 0x12345678 загружена как (0x12 0x34 0x56 0x78) в формате большого endian.Windows NT и Windows 95 предназначены работать на небольшой-endian компьютерной архитектуре. Пользователь может подключить к компьютерам, что иметь архитектуру большого endian, как например, некоторые системы UNIX.
REG_EXPAND_SZ недействительный расторгнутая строка, которая содержит unexpanded ссылки на переменные среды (например, "%ПУТЬ%"). Это будет Уникодом или строкой ANSI или Вы используете Уникод или функции ANSI.
REG_LINK символическая связь Уникода.
REG_MULTI_SZ массив недействительный расторгнутых строк, завершался двумя недействительными символами.
No REG_NONE определяло тип величины.
REG_RESOURCE_LIST устройство-драйверный список ресурса.
REG_SZ недействительный расторгнутая строка. Это будет Уникодом или строкой ANSI, или Вы используете Уникод или функции ANSI.


Параметр pType может быть НЕДЕЙСТВИТЕЛЕН если код типа не потребовался.

pData

Указатель в буфер, который получает величину данных конфигурации.
Этот параметр может быть НЕДЕЙСТВИТЕЛЕН если величина данных конфигурации не потребовалась.

cbData

Определяет размер, в байтах, буфера указанного, чтобы pData.
Если Вы хотите иметь операционную систему поставлять требуемый буферный размер, установивший как этот параметр так и параметр cbValueName в нуль для первого вызова на EnumPrinterData для данной ручки принтера. Когда функция возвращается, переменная указанная, чтобы pcbData будет содержать буферный размер, который - большой достаточно, чтобы успешно перечислять всю величину данных конфигурации имен принтера.

pcbData

Указатель в переменную, которая получает количество байтов загружался в буфер указанный, чтобы pData.
Этот параметр может быть НЕДЕЙСТВИТЕЛЕН если pData НЕДЕЙСТВИТЕЛЕН.



Обратные Величины

Если функция добивается успеха, обратная величина - ERROR_SUCCESS.
Если функция терпит неудачу, обратная величина является величиной ошибки Win32.
Функция возвращает ERROR_NO_MORE_ITEMS когда нет более величин данных конфигурации, чтобы извлекаться для данной ручки принтера.

Замечания

EnumPrinterData ИЗВЛЕКАЕТ данные конфигурации принтера установленные функцией SetPrinterData.
Если Вы хотите иметь операционную систему поставлять требуемый буферный размер, сначала называть EnumPrinterData с как cbValueName так и параметрами cbData был установлен в нуль, как отмечено раньше в секции Параметров. Величина dwIndex не имеет значения для этого вызова. Когда функция возвращается, *pcbValueName и * pcbData будет содержать буферные размеры, которые - большой достаточно, чтобы перечислять всю величину данных конфигурации имен принтера и величин. На следующем вызове, распределите имя величины и буферов данных, установившие cbValueName и cbData в размеры в байты размещенный буферы, и установившие dwIndex в нуль. Согласно этому, останьтесь называть функцию EnumPrinterData, увеличивающую dwIndex к одному всякий раз, когда, пока функция не возвращает ERROR_NO_MORE_ITEMS.

Смотри Также

DeletePrinterData, GetPrinterData, OpenPrinter, SetPrinter, SetPrinterData


Вверх Version 1.3, Oct 26 2010 © 2007, 2010, mrhx Вверх
 mrhx software  Русский перевод OpenGL  Русский перевод Win32 API
 
Используются технологии uCoz