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

L’un des rôles d’objet constantes.

[out] lpszRole

Type : LPTSTR

Adresse d’une mémoire tampon qui reçoit la chaîne de texte du rôle. Si ce paramètre est 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 pointée par le paramètre lpszRole. Pour les chaînes ANSI, cette valeur est mesurée en octets ; pour les chaînes Unicode, elle est mesurée en caractères.

Valeur de retour

Type : UINT

Si elle réussit et si lpszRole n’est pasNULL, la valeur de retour correspond au 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 est NULL, la valeur de retour 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 égale à zéro (0). Pour obtenir des informations d’erreur étendues, appelez GetLastError.

Remarques

Exigences