Метод IPrintCoreUI2::EnumOptions (prcomoem.h)

Статья
03/14/2023

Метод IPrintCoreUI2::EnumOptions перечисляет доступные параметры определенного компонента.

Синтаксис

HRESULT EnumOptions(
  [in]  POEMUIOBJ poemuiobj,
  [in]  DWORD     dwFlags,
  [in]  PCSTR     pszFeatureKeyword,
  [out] PZZSTR    pmszOptionList,
  [in]  DWORD     cbSize,
  [out] PDWORD    pcbNeeded
);

Параметры

[in] poemuiobj

Указатель на текущий контекст, структуру OEMUIOBJ .

[in] dwFlags

Зарезервировано и должно быть равно нулю.

[in] pszFeatureKeyword

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

[out] pmszOptionList

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

Задайте для этого параметра значение NULL , чтобы просто запросить размер (*pcbNeeded) списка параметров без заполнения списка.

[in] cbSize

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

[out] pcbNeeded

Указатель на расположение памяти, которое получает фактический размер списка параметров в байтах.

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

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

Код возврата	Описание
S_OK	Метод выполнен успешно.
E_OUTOFMEMORY	Значение в cbSize было меньше числа байтов, записываемых в выходной буфер (буфер, на который указывает pmszOptionList). Метод был вызван с параметром pmszOptionList со значением NULL.
E_INVALIDARG	Строка, на которую указывает pszFeatureKeyword , не является распознанной функцией. Параметр poemuiobj указывает на недопустимый объект контекста.
E_NOTIMPL	(только Pscript) Функция драйвера Pscript5 не поддерживается в текущей конфигурации. Функция драйвера Pscript5 поддерживается в текущей конфигурации, но параметры драйвера Pscript5 не перечисляются.
E_FAIL	Сбой метода

Чтобы уменьшить потребность в двух вызовах для каждого доступа к данным, передайте методу выходной буфер фиксированного размера (например, 1 КБ), а затем проверка возвращаемое значение функции. Если метод возвращает S_OK, буфер уже содержит интересующие данные. Если метод возвращает E_OUTOFMEMORY, значение в *pcbNeeded — это размер буфера, необходимый для хранения интересующих данных. Затем вызывающий объект должен выделить буфер большего размера и продолжить второй вызов метода .

Дополнительные сведения см. в разделе Использование EnumOptions.