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

Artigo
03/01/2024

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

Sintaxe

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

Parâmetros

[in] pszFeatureKeyword

Um ponteiro para um buffer fornecido pelo chamador que contém uma cadeia de caracteres ANSI que especifica o recurso palavra-chave a ser consultado. Esse valor pode ser obtido de uma chamada anterior para IPrintCoreHelperPS::EnumFeatures.

[in] pszAttribute

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

[out] pdwDataType

Um ponteiro para uma 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 destinatário 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 recebe o tamanho, em bytes, do buffer apontado pelo parâmetro pbData .

Retornar valor

IPrintCoreHelperPS::GetFeatureAttribute 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. Esse valor também pode significar que o recurso palavra-chave não foi reconhecido.
E_OUTOFMEMORY	O valor em pcbSize era menor que o número de bytes a serem gravados no buffer de saída apontado por pbData. Esse valor também pode significar que o método foi chamado com pbData definido como NULL.

Comentários

Se IPrintCoreHelperPS::GetFeatureAttribute for chamado com seus parâmetros pszAttribute e pbData definidos como NULL, o método retornará com pcbSize definido como o número de bytes necessários para a lista de todos os nomes de atributo com suporte para o recurso. 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 nomes de atributo com suporte para o recurso. Essa lista é encerrada com dois caracteres nulos.