GetRoleTextA, fonction (oleacc.h)

  • Article

Récupère la chaîne localisée qui décrit le rôle de l’objet pour la valeur de rôle spécifiée.

Syntaxe

UINT GetRoleTextA(
  [in]  DWORD lRole,
  [out] LPSTR lpszRole,
  [in]  UINT  cchRoleMax
);

Paramètres

[in] lRole

Type : DWORD

Une des constantes de rôle d’objet .

[out] lpszRole

Type : LPTSTR

Adresse d’une mémoire tampon qui reçoit la chaîne de texte de rôle. Si ce paramètre a la valeur NULL, la fonction retourne la longueur de la chaîne de rôle, sans inclure le caractère null.

[in] cchRoleMax

Type : UINT

Taille de la mémoire tampon vers laquelle pointe le paramètre lpszRole . Pour les chaînes ANSI, cette valeur est mesurée en octets ; pour les chaînes Unicode, il est mesuré en caractères.

Valeur retournée

Type : UINT

En cas de réussite et si lpszRole n’a pas la valeur NULL, la valeur renvoyée est le nombre d’octets (chaînes ANSI) ou de caractères (chaînes Unicode) copiés dans la mémoire tampon, sans inclure le caractère null de fin. Si lpszRole a la valeur NULL, la valeur renvoyée représente la longueur de la chaîne, sans inclure le caractère null.

Si la ressource de chaîne n’existe pas ou si le paramètre lpszRole n’est pas un pointeur valide, la valeur de retour est zéro (0). Pour obtenir des informations détaillées sur l’erreur, appelez GetLastError.

Remarques

Notes

L’en-tête oleacc.h définit GetRoleText comme un alias qui sélectionne automatiquement la version ANSI ou Unicode de cette fonction en fonction de la définition de la constante de préprocesseur UNICODE. Le mélange de l’utilisation de l’alias neutre en encodage avec du code qui n’est pas neutre en encodage peut entraîner des incompatibilités qui entraînent des erreurs de compilation ou d’exécution. Pour plus d’informations, consultez Conventions pour les prototypes de fonction.

Configuration requise

Condition requise Valeur
Client minimal pris en charge Windows 2000 Professionnel [applications de bureau uniquement]
Serveur minimal pris en charge Windows Server 2003 [applications de bureau uniquement]
Plateforme cible Windows
En-tête oleacc.h
Bibliothèque Oleacc.lib
DLL Oleacc.dll
Composant redistribuable Active Accessibility 1.3 RDK sur Windows NT 4.0 avec SP6 et versions ultérieures et Windows 95