Метод IPrintCoreHelper::EnumConstrainedOptions (prcomoem.h)

Статья
08/07/2023

Метод IPrintCoreHelper::EnumConstrainedOptions предоставляет список всех параметров, ограниченных определенным компонентом, в зависимости от текущих параметров.

Синтаксис

HRESULT EnumConstrainedOptions(
  [in, optional] IN const DEVMODE *pDevmode,
  [in]           IN DWORD         cbSize,
  [in]           IN PCSTR         pszFeatureKeyword,
  [out]          OUT PCSTR * []   pConstrainedOptionList,
  [out]          OUT DWORD        *pdwNumOptions
);

Параметры

[in, optional] pDevmode

Указатель на структуру DEVMODEW . Если указан этот указатель, IPrintCoreHelper::EnumConstrainedOptions должен использовать структуру DEVMODEW, на которую указывает pDevmode , вместо структуры DEVMODEW по умолчанию или текущей. Если этот метод вызывается из поставщика подключаемых модулей или из IPrintOemPS::D evMode , IPrintOemUni::D evMode или из поставщика билетов печати, этот параметр является обязательным. В большинстве других ситуаций параметр должен иметь значение NULL. Когда основной драйвер устанавливает для pDevmodeзначение NULL, он изменяет его внутреннее состояние, а не переданную в DEVMODEW структуру. Это необходимо при выполнении таких операций, как полная замена пользовательского интерфейса, когда структура DEVMODEW, возвращаемая DDI, например DrvDocumentPropertySheets, обслуживается модулем пользовательского интерфейса основного драйвера.

[in] cbSize

Размер структуры DEVMODEW в байтах, на которую указывает параметр pDevmode .

[in] pszFeatureKeyword

Строка символов ANSI, содержащая имя компонента.

[out] pConstrainedOptionList

Указатель на массив строк символов ANSI. При возврате IPrintCoreHelper::EnumConstrainedOptions эти строки будут содержать имена всех параметров, ограниченных в пределах указанной функции. Вызывающий объект не несет ответственности за освобождение массива или отдельных строк в массиве.

[out] pdwNumOptions

Указатель на переменную, получающую количество ограниченных параметров в массиве, на который указывает параметр pConstrainedOptionList .

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

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

Код возврата	Описание
S_OK	Ограниченные параметры были заданы для указанной функции.
E_FAIL	Вызывающий объект предоставил сведения, которые привели к недопустимому запросу, например запрос на несуществующую функцию.
E_INVALIDARG	Один или несколько аргументов были недопустимыми. Это значение может означать, что функция не поддерживается.
E_OUTOFMEMORY	Недостаточно памяти для создания массива параметров или драйвер ядра не смог обслужить запрос из-за нехватки памяти.
E_UNEXPECTED или другие сбои, не перечисленные здесь явным образом	Возникло непредвиденное условие. Основной драйвер, вероятно, находится в недопустимом состоянии. Вызывающий объект должен выйти с кодом сбоя.

Требования

Требование	Значение
Целевая платформа	Персональный компьютер
Верхняя часть	prcomoem.h (включая Prcomoem.h)

См. также раздел

IPrintCoreHelper

IPrintCoreHelper::EnumOptions

IPrintCoreHelper::WhyConstrained

Поделиться через