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

Статья
02/26/2024

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

Синтаксис

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

Параметры

[in] pszFeatureKeyword

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

[in] pszOptionKeyword

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

[in] pszAttribute

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

[out] pdwDataType

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

[out] ppbData

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

[out] pcbSize

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

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

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

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

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