Método IPrintCoreHelperUni::GetOption (prcomoem.h)

  • Artigo

O IPrintCoreHelperUni::GetOption método obtém uma opção especificada para um determinado recurso.

Sintaxe

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

Parâmetros

[in, optional] pDevmode

Um ponteiro para uma estrutura DEVMODEW . Se esse ponteiro for fornecido, IPrintCoreHelperUni::GetOption deverá usar a estrutura DEVMODEW que é apontada por pDevmode em vez da estrutura DEVMODEW padrão ou atual. Se esse método for chamado do provedor de plug-in ou de IPrintOemUni::D evMode, esse parâmetro será necessário. Na maioria das outras situações, o parâmetro deve ser NULL. Quando o driver principal define pDevmode como NULL, ele modifica seu estado interno em vez do da estrutura DEVMODEW passada. Isso é necessário durante operações como substituição completa da interface do usuário, em que a estrutura DEVMODEW retornada por uma DDI, como DrvDocumentPropertySheets, está sendo atendida pelo módulo de interface do usuário do driver principal.

[in] cbSize

O tamanho, em bytes, da estrutura DEVMODEW apontada pelo parâmetro pDevmode .

[in] pszFeatureRequested

Um ponteiro para a cadeia de caracteres ANSI que contém o nome do recurso como ele aparece no arquivo GPD.

[out] ppszOption

Um ponteiro para uma variável que contém o endereço de uma cadeia de caracteres ANSI. Quando IPrintCoreHelperUni::GetOption retorna, a cadeia de caracteres deve conter o palavra-chave para a opção selecionada no momento como ela aparece no arquivo de configuração. O chamador não deve modificar essa cadeia de caracteres e não deve liberar a memória associada a essa cadeia de caracteres.

Retornar valor

IPrintCoreHelperUni::GetOption deve retornar um dos valores a seguir.

Código de retorno Descrição
S_OK
 O método lê a opção para o recurso especificado.
E_FAIL
 O chamador forneceu informações que resultaram em uma solicitação inválida. Por exemplo, o recurso que foi solicitado não existe.
E_INVALIDARG
 Os argumentos eram inválidos. Esse valor pode significar que o recurso não tem suporte ou que muitas opções foram solicitadas para o recurso.
E_OUTOFMEMORY
 O driver principal não pôde atender à solicitação porque não havia memória suficiente.
E_UNEXPECTED ou outros códigos de retorno não listados aqui
 O driver principal parece estar em um estado inválido. O chamador deve retornar um código de falha.

Comentários

IPrintCoreHelperUni::GetOption não pode ser usado para recursos que permitem que várias opções sejam definidas simultaneamente.

As palavras-chave do recurso são definidas no arquivo GPD. Além disso, o driver Unidrv dá suporte a várias palavras-chave reservadas para opções armazenadas em sua estrutura DEVMODEW privada. Para obter a lista de recursos Unidrv, consulte Mapeamento de palavra-chave.

O chamador não deve liberar a cadeia de caracteres apontada por ppszOption e não deve modificar a cadeia de caracteres de forma alguma.

Requisitos

Requisito Valor
Plataforma de Destino Área de Trabalho
Cabeçalho prcomoem.h (inclua Prcomoem.h)

Confira também

IPrintCoreHelperUni

IPrintCoreHelperUni::SetOptions