Partilhar via


Método IPrintCoreHelperPS::GetGlobalAttribute (prcomoem.h)

O método IPrintCoreHelperPS::GetGlobalAttribute recupera a lista de atributos globais ou o valor de um atributo global específico.

Sintaxe

HRESULT GetGlobalAttribute(
  [in]  PCSTR  pszAttribute,
  [out] PDWORD pdwDataType,
  [out] PBYTE  *ppbData,
  [out] PDWORD pcbSize
);

Parâmetros

[in] pszAttribute

Um ponteiro para um buffer fornecido pelo chamador que contém uma cadeia de caracteres ANSI que especifica o atributo solicitado. Se esse parâmetro for NULL, o chamador solicitará uma lista de todos os nomes de atributo global com suporte em vez de especificar um nome de atributo global específico.

[out] pdwDataType

Um ponteiro para a variável que recebe um valor que especifica o tipo de dados do atributo solicitado. Esse valor é um enumerador do tipo de enumeração EATTRIBUTE_DATATYPE, que é definido em printoem.h.

[out] ppbData

Um ponteiro para um buffer alocado pelo chamador que contém os dados solicitados. Após a conclusão desse método, o chamador não precisa liberar esse buffer.

[out] pcbSize

Um ponteiro para uma variável que especifica o tamanho, em bytes, do buffer que é apontado pelo parâmetro pbData.

Valor de retorno

IPrintCoreHelperPS::GetGlobalAttribute deve retornar um dos seguintes valores.

Código de retorno Descrição
S_OK O método foi bem-sucedido.
E_FAIL O método falhou.
E_INVALIDARG O método tentou consultar um atributo inexistente.
E_OUTOFMEMORY O valor em pcbSize era menor do que o número de bytes a serem gravados no buffer de saída apontado por pbData.

Observações

Se IPrintCoreHelperPS::GetGlobalAttribute for chamado com seu pszAttribute e parâmetro pbData definido como NULL, o método retorna com pcbSize definido como o número de bytes necessários para a lista de todos os nomes de atributos globais com suporte. Se esse método for chamado uma segunda vez, com pszAttribute definido como NULL e pbData apontando para um buffer do tamanho especificado em pcbSize na chamada anterior, o método retorna com pdwDataType definido como kADT_ASCII (um enumerador do tipo de enumeração EATTRIBUTE_DATATYPE) e pbData apontando para uma lista delimitada por NULL de todos os globais compatíveis nomes de atributo. Essa lista é encerrada com dois caracteres nulos.

Para obter mais informações sobre IPrintCoreHelperPS::GetGlobalAttribute, consulte Using GetGlobalAttribute.

Requisitos

Requisito Valor
da Plataforma de Destino Área de trabalho
cabeçalho prcomoem.h (inclua Prcomoem.h)

Consulte também

IPrintCoreHelperPS

IPrintCoreHelperPS::GetFeatureAttribute

IPrintCoreHelperPS::GetOptionAttribute