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

Статья
08/07/2023

Метод IPrintCoreHelperPS::GetFeatureAttribute извлекает список атрибутов компонента или значение определенного атрибута признака.

Синтаксис

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

Параметры

[in] pszFeatureKeyword

Указатель на буфер, предоставленный вызывающим объектом, который содержит строку ANSI, указывающую ключевое слово функции для запроса. Это значение можно получить из предыдущего вызова IPrintCoreHelperPS::EnumFeatures.

[in] pszAttribute

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

[out] pdwDataType

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

[out] ppbData

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

[out] pcbSize

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

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

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

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

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