Método IPrintCoreUI2::GetOptions (prcomoem.h)
O método IPrintCoreUI2::GetOptions
recupera as configurações de recurso atuais do driver no formato de uma lista de pares de palavras-chave de recurso/opção.
Sintaxe
HRESULT GetOptions(
[in] POEMUIOBJ poemuiobj,
[in] DWORD dwFlags,
[in] PCZZSTR pmszFeaturesRequested,
[in] DWORD cbIn,
[out] PZZSTR pmszFeatureOptionBuf,
[in] DWORD cbSize,
[out] PDWORD pcbNeeded
);
Parâmetros
[in] poemuiobj
Ponteiro para o contexto atual, uma estrutura de OEMUIOBJ.
[in] dwFlags
É reservado e deve ser definido como zero.
[in] pmszFeaturesRequested
Ponteiro para o buffer fornecido pelo chamador que contém uma lista de palavras-chave de recurso (no formato MULTI_SZ) cujas configurações são solicitadas. Defina esse parâmetro para NULL para obter configurações para todos os recursos.
[in] cbIn
Especifica o tamanho, em bytes, do buffer apontado por pmszFeaturesRequested. O tamanho inclui a última MULTI_SZ caractere nulo.
[out] pmszFeatureOptionBuf
Ponteiro para um buffer fornecido pelo chamador que recebe uma lista de pares de palavras-chave de recurso/opção (no formato MULTI_SZ) obtidos das configurações do driver. Cada par de palavras-chave de recurso/opção contém o nome da palavra-chave do recurso, um caractere nulo, o nome da palavra-chave da opção e outro caractere nulo. A lista é encerrada por dois caracteres nulos.
[in] cbSize
Especifica o tamanho, em bytes, do buffer apontado por pmszFeatureOptionBuf.
[out] pcbNeeded
Ponteiro para um local de memória que recebe o tamanho real, em bytes, dos pares de palavra-chave de recurso/opção.
Valor de retorno
O método deve retornar um dos valores a seguir.
Código de retorno | Descrição |
---|---|
|
O método foi bem-sucedido. |
|
O valor em cbSize era menor que o número de bytes a serem gravados no buffer de saída (o buffer apontado por pmszFeatureOptionBuf).
O método foi chamado com pmszFeatureOptionBuf definido como NULL. |
|
O buffer de entrada (o buffer apontado por pmszFeaturesRequested) foi fornecido, mas seu conteúdo não estava no formato MULTI_SZ.
O parâmetro poemuiobj apontou para um objeto de contexto inválido. |
|
Não há suporte para o método. |
|
Falha no método |
Observações
Esse método tem suporte apenas para plug-ins de interface do usuário do Windows XP Pscript5 que substituem totalmente as páginas de interface do usuário padrão do driver principal, e tem suporte apenas durante o IPrintOemUI::D ocumentPropertySheets e funções de IPrintOemUI::D evicePropertySheets e suas rotinas de retorno de chamada da folha de propriedades. Consulte Substituindo páginas da folha de propriedades Driver-Supplied para obter mais informações.
Se uma palavra-chave de recurso solicitada não for reconhecida ou reconhecida, mas não tiver suporte no modo autoadesível atual ( ou autoadesiva da impressora -- consulte Substituindo Driver-Supplied Páginas da Folha de Propriedades) ou a palavra-chave do recurso será reconhecida, mas atualmente não há nenhuma seleção de opção para ela, o recurso será simplesmente ignorado e o par de palavras-chave de recurso/opção não será colocado no buffer de saída.
Para reduzir a necessidade de fazer duas chamadas por acesso a dados, passe o método um buffer de saída de um tamanho fixo (1 KB, por exemplo) e verifique o valor retornado da função. Se o método retornar S_OK, o buffer já conterá os dados de interesse. Se o método retornar E_OUTOFMEMORY, o valor em *pcbNeeded será o tamanho do buffer necessário para manter os dados de interesse. Em seguida, o chamador deve alocar um buffer desse tamanho maior e continuar com uma segunda chamada para o método.
Para obter mais informações, consulte Usando GetOptions e SetOptions.
Requisitos
Requisito | Valor |
---|---|
da Plataforma de Destino | Área de trabalho |
cabeçalho | prcomoem.h (inclua Prcomoem.h) |
Consulte também
IPrintOemUI::D evicePropertySheets