Función GetStateTextA (oleacc.h)

Recupera una cadena localizada que describe el estado de un objeto para una sola marca de bits de estado predefinida. Dado que los valores de estado son una combinación de una o varias marcas de bits, los clientes llaman a esta función más de una vez para recuperar todas las cadenas de estado.

Sintaxis

UINT GetStateTextA(
  [in]  DWORD lStateBit,
  [out] LPSTR lpszState,
  [in]  UINT  cchState
);

Parámetros

[in] lStateBit

Tipo: DWORD

Una de las constantes de estado del objeto.

[out] lpszState

Tipo: LPTSTR

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

[in] cchState

Tipo: UINT

Tamaño del búfer al que apunta el parámetro lpszStateBit . 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 lpszStateBit no es NULL, el valor devuelto es el número de bytes (cadenas ANSI) o caracteres (cadenas Unicode) que se copian en el búfer, no incluido el carácter terminado en null. Si lpszStateBit 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 lpszStateBit no es un puntero válido, el valor devuelto es cero (0). Para obtener información de error extendida, llame a GetLastError.

Comentarios

Esta función acepta solo un bit de estado a la vez, no una máscara de bits.

Nota:

El encabezado oleacc.h define GetStateText 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

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