Función GetRoleTextA (oleacc.h)

Recupera la cadena localizada que describe el rol del objeto para el valor de rol especificado.

Sintaxis

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

Parámetros

[in] lRole

Tipo: DWORD de

Uno de los rol de objeto constantes.

[out] lpszRole

Tipo: LPTSTR de

Dirección de un búfer que recibe la cadena de texto del rol. Si este parámetro es NULL, la función devuelve la longitud de la cadena de rol, no incluido el carácter NULL.

[in] cchRoleMax

Tipo: UINT de

Tamaño del búfer al que apunta el parámetro lpszRole. Para las cadenas ANSI, este valor se mide en bytes; para las cadenas Unicode, se mide en caracteres.

Valor devuelto

Tipo: UINT de

Si se ejecuta correctamente y si lpszRole no esNULL, el valor devuelto es el número de bytes (cadenas ANSI) o caracteres (cadenas Unicode) copiados en el búfer, no incluido el carácter nulo de terminación. Si lpszRole es null, el valor devuelto representa la longitud de la cadena, no incluido el carácter NULL.

Si el recurso de cadena no existe o si el parámetro lpszRole no es un puntero válido, el valor devuelto es cero (0). Para obtener información de error extendida, llame a GetLastError.

Observaciones

Requisitos