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

Статья
02/07/2025

Метод 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 всех поддерживаемых глобальных имена атрибутов. Этот список завершается двумя пустыми символами.