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

Статья
02/07/2025

Метод IPrintCoreHelper::GetOption получает указанный параметр для данной функции.

Синтаксис

HRESULT GetOption(
  [in]  const DEVMODE *pDevmode,
  [in]  DWORD         cbSize,
  [in]  PCSTR         pszFeatureRequested,
  [out] PCSTR         *ppszOption
);

Параметры

[in] pDevmode

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

[in] cbSize

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

[in] pszFeatureRequested

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

[out] ppszOption

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

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

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

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

Замечания

IPrintCoreHelper::GetOption нельзя использовать для функций, позволяющих одновременно задавать несколько параметров.

Ключевые слова функций определены в файлах GPD и PPD. Кроме того, драйверы Unidrv и Pscript5 поддерживают несколько зарезервированных ключевых слов для параметров, хранящихся в своих частных структурах DEVMODEW.

Вызывающий объект не должен освободить строку, на которую указывает ppszOption и не изменять строку каким-либо образом.