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

Статья
08/07/2023

Метод 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 по умолчанию или текущую. Если этот метод вызывается из поставщика подключаемого модуля или из 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 или другие коды возврата, не перечисленные здесь	Основной драйвер, кажется, в недопустимом состоянии. Вызывающий объект должен вернуть код сбоя.

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

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