Método IPrintCoreUI2::GetOptions (prcomoem.h)

Artigo
02/26/2024

O IPrintCoreUI2::GetOptions método recupera as configurações atuais do recurso do driver no formato de uma lista de pares de recursos/opções palavra-chave.

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 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 como NULL para obter configurações para todos os recursos.

[in] cbIn

Especifica o tamanho, em bytes, do buffer apontado por pmszFeaturesRequested. O tamanho inclui o último MULTI_SZ caractere nulo.

[out] pmszFeatureOptionBuf

Ponteiro para um buffer fornecido pelo chamador que recebe uma lista de pares de recurso/opção palavra-chave (no formato MULTI_SZ) obtidos das configurações do driver. Cada recurso/opção palavra-chave par contém o nome palavra-chave do recurso, um caractere nulo, a opção palavra-chave nome 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, do recurso/opção palavra-chave pares.

Retornar valor

O método deve retornar um dos valores a seguir.

Código de retorno	Descrição
S_OK	O método foi bem-sucedido.
E_OUTOFMEMORY	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.
E_INVALIDARG	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.
E_NOTIMPL	O método não tem suporte.
E_FAIL	O método falhou

Comentários

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 só tem suporte durante as funções IPrintOemUI::D ocumentPropertySheets e IPrintOemUI::D evicePropertySheets e suas rotinas de retorno de chamada da folha de propriedades. Consulte Substituindo Driver-Supplied páginas de folha de propriedades para obter mais informações.

Se um recurso solicitado palavra-chave não for reconhecido ou reconhecido, mas não tiver suporte no modo autoadesiva atual (autoadesiva de documento ou impressora- consulte Substituindo Driver-Supplied páginas de folha de propriedades) ou o recurso palavra-chave é reconhecido, mas atualmente não há nenhuma seleção de opção para ele, o recurso é simplesmente ignorado e o recurso/opção palavra-chave O par não é colocado no buffer de saída.

Para reduzir a necessidade de fazer duas chamadas por acesso a dados, passe ao método um buffer de saída de um tamanho fixo (1 KB, por exemplo) e, em seguida, marcar 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 prosseguir com uma segunda chamada para o método .

Para obter mais informações, consulte Usando GetOptions e SetOptions.