Функция GetPrinterDataEx

Функция GetPrinterDataEx извлекает данные конфигурации для указанного принтера или сервера печати. GetPrinterDataEx может извлекать значения, сохраненные функцией SetPrinterData . Кроме того, GetPrinterDataEx может извлекать значения, которые функция SetPrinterDataEx хранит в указанном ключе.

Синтаксис

DWORD GetPrinterDataEx(
  _In_  HANDLE  hPrinter,
  _In_  LPCTSTR pKeyName,
  _In_  LPCTSTR pValueName,
  _Out_ LPDWORD pType,
  _Out_ LPBYTE  pData,
  _In_  DWORD   nSize,
  _Out_ LPDWORD pcbNeeded
);

Параметры

hPrinter [in]

Дескриптор принтера или сервера печати, для которого функция извлекает данные конфигурации. Используйте функцию OpenPrinter, OpenPrinter2 или AddPrinter для получения дескриптора принтера.

pKeyName [in]

Указатель на строку, завершающуюся значением NULL, которая указывает ключ, содержащий извлекаемое значение. Используйте символ обратной косой черты ( \ ) в качестве разделителя, чтобы указать путь, имеющий один или несколько подразделов.

Если hPrinter является дескриптором принтера, а pKeyName имеет значение NULL или пустую строку, GetPrinterDataEx возвращает ERROR_INVALID_PARAMETER.

Если hPrinter является дескриптором сервера печати, pKeyName игнорируется.

pValueName [in]

Указатель на строку, завершающуюся значением NULL, которая определяет извлекаемые данные.

Для принтеров эта строка указывает имя значения в разделе pKeyName .

Для серверов печати эта строка является одной из предопределенных строк, перечисленных в следующем разделе Примечаний.

pType [out]

Указатель на переменную, которая получает тип данных, хранящихся в значении. Функция возвращает тип, указанный в вызове SetPrinterDataEx при хранении данных. Этот параметр может иметь значение NULL , если вам не нужны сведения. GetPrinterDataEx передает pType в качестве параметра lpdwType вызова функции RegQueryValueEx .

pData [out]

Указатель на буфер, который получает данные конфигурации.

nSize [in]

Размер (в байтах) буфера, на который указывает pData.

pcbNeeded [ out]

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

Возвращаемое значение

Если функция завершается успешно, возвращаемое значение будет ERROR_SUCCESS.

Если функция завершается сбоем, возвращается значение ошибки.

Комментарии

GetPrinterDataEx извлекает данные конфигурации принтера, которые были заданы функциями SetPrinterDataEx и SetPrinterData .

Вызов Метода GetPrinterDataEx с параметром pKeyName , равным PrinterDriverData, эквивалентен вызову функции GetPrinterData .

Если hPrinter является дескриптором сервера печати, pValueName может указать одно из следующих предопределенных значений.

Следующие значения pValueName указывают на поведение печати пула при возникновении ошибки.

Время, указанное в SPLREG_RESTART_JOB_ON_POOL_ERROR , — это минимальное время. Фактическое время может быть больше в зависимости от следующих параметров монитора портов, которые являются значениями реестра в этом разделе реестра:

HKLM\SYSTEM\CurrentControlSet\Control\Print\Monitors\<MonitorName>\Ports

Вызовите функцию RegQueryValueEx , чтобы запросить эти значения.

Если pKeyName является одним из предопределенных ключей службы каталогов (DS) (см . SetPrinter), а pValueName содержит запятую (','), то часть pValueName перед запятой является именем значения, а часть pValueName справа от запятой — идентификатором свойства DS. Создается подраздел с именем OID, и новое значение, состоящее из имени значения и идентификатора идентификатора, вводится под ключом OID. SetPrinterDataEx также добавляет имя значения и данные в ключ DS.

В Windows 7 и более поздних версиях Windows задания печати, отправляемые на сервер печати, по умолчанию отрисовываются на клиенте. Конфигурацию отрисовки на стороне клиента для принтера можно считать, задав для параметра pKeyName значение PrinterDriverData, а pValueName — значение параметра, указанное в следующей таблице.

Требования

См. также раздел

Вывод на печать

Функции API очереди печати принтера

OpenPrinter

SetPrinterDataEx