Método IAccPropServer::GetPropValue (oleacc.h)

Recupera um valor de propriedade para um elemento acessível.

Sintaxe

HRESULT GetPropValue(
  [in]  const BYTE *pIDString,
  [in]  DWORD      dwIDStringLen,
  [in]  MSAAPROPID idProp,
  [out] VARIANT    *pvarValue,
  [out] BOOL       *pfHasProp
);

Parâmetros

[in] pIDString

Tipo: const BYTE*

Contém uma cadeia de caracteres que identifica a propriedade que está sendo solicitada.

[in] dwIDStringLen

Tipo: DWORD

Especifica o comprimento da cadeia de caracteres de identidade especificada pelo parâmetro pIDString.

[in] idProp

Tipo: MSAAPROPID

Especifica um GUID que indica a propriedade desejada.

[out] pvarValue

Tipo: VARIANT*

Especifica o valor da propriedade substituída. Esse parâmetro só será válido se pfHasProp for TRUE. O servidor deve definir isso como VT_EMPTY se pfHasProp estiver definido como FALSE.

[out] pfHasProp

Tipo: BOOL*

Indica se o servidor está fornecendo um valor para a propriedade solicitada. O servidor deve definir isso como TRUE se estiver retornando uma propriedade de substituição ou como FALSE se não estiver retornando uma propriedade (nesse caso, ele também deve definir pvarValue como VT_EMPTY).

Retornar valor

Tipo: HRESULT

Retornar S_OK, exceto em condições de erro excepcionais, como memória insuficiente. Se a propriedade especificada não for substituída, pfHasProp deverá ser definido como FALSE e pvarValue deverá ser definido como VT_EMPTY pelo servidor.

Comentários

Se um único objeto de retorno de chamada for registrado para anotar vários elementos acessíveis, a cadeia de caracteres de identidade poderá ser usada para determinar a qual elemento essa solicitação se refere.

Se o elemento acessível for baseado em HWND, IAccPropServices::D ecomposeHwndIdentityString poderá ser usado para extrair o HWND/idObject/idChild da cadeia de caracteres de identidade.

Se o retorno de chamada tiver um valor a ser retornado para a propriedade especificada, ele deverá retorná-lo em pvarValue e definir pfHasProp como TRUE. Caso contrário, ele deverá definir pvarValue como VT_EMPTY e definir pfHasProp como FALSE. Neste último caso, o ponteiro de interface IAccessible original será usado para obter um valor para essa propriedade.

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows Vista ou Windows XP
Servidor mínimo com suporte	Windows Server 2003
Plataforma de Destino	Windows
Cabeçalho	oleacc.h (inclua OleAcc.h Include Initguid.h primeiro.)
DLL	Oleacc.dll
Redistribuível	ACTIVE Accessibility 2.0 RDK no Windows NT 4.0 com SP6 e posterior e Windows 98