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

Article
03/04/2024

Récupère une valeur de propriété pour un élément accessible.

Syntaxe

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

Paramètres

[in] pIDString

Type : const BYTE*

Contient une chaîne qui identifie la propriété demandée.

[in] dwIDStringLen

Type : DWORD

Spécifie la longueur de la chaîne d’identité spécifiée par le paramètre pIDString.

[in] idProp

Type : MSAAPROPID

Spécifie un GUID indiquant la propriété désirée.

[out] pvarValue

Type : VARIANT*

Spécifie la valeur de la propriété substituée. Ce paramètre est valide uniquement si pfHasProp a la valeur TRUE. Le serveur doit définir cette valeur sur VT_EMPTY si pfHasProp a la valeur FALSE.

[out] pfHasProp

Type : BOOL*

Indique si le serveur fournit une valeur pour la propriété demandée. Le serveur doit définir cette valeur sur TRUE s’il retourne une propriété de substitution ou sur FALSE s’il ne retourne pas de propriété (auquel cas il doit également définir pvarValue sur VT_EMPTY).

Valeur retournée

Type : HRESULT

Retournez S_OK, sauf dans des conditions d’erreur exceptionnelles telles que la mémoire insuffisante. Si la propriété spécifiée n’est pas remplacée, pfHasProp doit être défini sur FALSE et pvarValue doit être défini sur VT_EMPTY par le serveur.

Remarques

Si un seul objet de rappel est inscrit pour l’annotation de plusieurs éléments accessibles, la chaîne d’identité peut être utilisée pour déterminer à quel élément cette demande fait référence.

Si l’élément accessible est basé sur HWND, IAccPropServices ::D ecomposeHwndIdentityString peut être utilisé pour extraire le HWND/idObject/idChild de la chaîne d’identité.

Si le rappel a une valeur à retourner pour la propriété spécifiée, il doit la renvoyer dans pvarValue et définir pfHasProp sur TRUE. Sinon, il doit définir pvarValue sur VT_EMPTY et définir pfHasProp sur FALSE. Dans ce dernier cas, le pointeur d’interface IAccessible d’origine sera utilisé pour obtenir une valeur pour cette propriété.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows Vista ou Windows XP
Serveur minimal pris en charge	Windows Server 2003
Plateforme cible	Windows
En-tête	oleacc.h (incluez d’abord OleAcc.h Inclure Initguid.h))
DLL	Oleacc.dll
Composant redistribuable	Active Accessibility 2.0 RDK sur Windows NT 4.0 avec SP6 et versions ultérieures et Windows 98

Share via