Метод IPrintCoreHelperPS::GetGlobalAttribute (prcomoem.h)

Статья
08/07/2023

Метод IPrintCoreHelperPS::GetGlobalAttribute извлекает глобальный список атрибутов или значение определенного глобального атрибута.

Синтаксис

HRESULT GetGlobalAttribute(
  [in]  PCSTR  pszAttribute,
  [out] PDWORD pdwDataType,
  [out] PBYTE  *ppbData,
  [out] PDWORD pcbSize
);

Параметры

[in] pszAttribute

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

[out] pdwDataType

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

[out] ppbData

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

[out] pcbSize

Указатель на переменную, указывающую размер (в байтах) буфера, на который указывает параметр pbData .

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

IPrintCoreHelperPS::GetGlobalAttribute должен возвращать одно из следующих значений.

Код возврата	Описание
S_OK	Метод выполнен успешно.
E_FAIL	Сбой метода.
E_INVALIDARG	Метод попытался запросить несуществующий атрибут.
E_OUTOFMEMORY	Значение в pcbSize было меньше числа байтов, записываемых в выходной буфер, на который указывает pbData.

Если вызывается IPrintCoreHelperPS::GetGlobalAttribute с параметрами pszAttribute и pbData со значением NULL, метод возвращает значение с параметром pcbSize , равным количеству байтов, необходимых для списка всех поддерживаемых имен глобальных атрибутов. Если этот метод вызывается во второй раз с параметром pszAttribute со значениемNULL и значением pbData , указывающим на буфер размера, указанного в pcbSize в предыдущем вызове, метод возвращает значение pdwDataType со значением kADT_ASCII (перечислитель типа перечисления EATTRIBUTE_DATATYPE ) и pbData , указывающий на список всех поддерживаемых глобальных атрибутов с разделителями NULL. Этот список завершается двумя символами NULL.