Função wiasReadPropStr (wiamdef.h)

A função wiasReadPropStr recupera um valor de propriedade de cadeia de caracteres de um item WIA.

Sintaxe

HRESULT wiasReadPropStr(
  [in]            BYTE   *pWiasContext,
                  PROPID propid,
  [out]           BSTR   *pbstr,
  [out, optional] BSTR   *pbstrOld,
                  BOOL   bMustExist
);

Parâmetros

[in] pWiasContext

Ponteiro para um contexto de item WIA.

propid

Especifica o identificador de propriedade.

[out] pbstr

Ponteiro para um local de memória que recebe o primeiro byte do valor da cadeia de caracteres da propriedade.

[out, optional] pbstrOld

Ponteiro para um local de memória que recebe o primeiro byte do valor anterior da propriedade. Se essas informações não forem necessárias, defina esse parâmetro como NULL.

bMustExist

Indica se a propriedade deve existir. Se definido como TRUE, a propriedade deverá existir; se definido como FALSE, a propriedade não precisa existir.

Retornar valor

Em caso de êxito, a função retorna S_OK. Se a função falhar, ela retornará um erro COM padrão ou um dos erros de WIA_ERROR_XXX (descritos na documentação do SDK do Microsoft Windows).

Comentários

Quando o minidriver for concluído usando a cadeia de caracteres recebida dessa função, ele deverá desalocar a memória usada para a cadeia de caracteres.

Requisitos

Confira também

wiasReadPropBin

wiasReadPropFloat

wiasReadPropGuid

wiasReadPropLong

wiasWritePropStr