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

Una de las constantes de rol de objeto .

[out] lpszRole

Tipo: LPTSTR

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

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

Valor devuelto

Tipo: UINT

Si se ejecuta correctamente y si lpszRole no es NULL, el valor devuelto es el número de bytes (cadenas ANSI) o caracteres (cadenas Unicode) copiadas 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.

Comentarios

Nota

El encabezado oleacc.h define GetRoleText como alias que selecciona automáticamente la versión ANSI o Unicode de esta función en función de la definición de la constante de preprocesador UNICODE. La combinación del uso del alias neutro de codificación con código que no es neutral de codificación puede provocar discrepancias que dan lugar a errores de compilación o en tiempo de ejecución. Para obtener más información, vea Convenciones para prototipos de función.

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows 2000 Professional [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows Server 2003 [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	oleacc.h
Library	Oleacc.lib
Archivo DLL	Oleacc.dll
Redistribuible	RDK de accesibilidad activa 1.3 en Windows NT 4.0 con SP6 y versiones posteriores y Windows 95