GetRoleTextA, fonction (oleacc.h)

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

Configuration requise