Función GetKeyboardLayoutNameA (winuser.h)

Artículo
07/21/2023

Recupera el nombre del identificador de configuración regional de entrada activo (anteriormente denominado diseño de teclado) para el subproceso que llama.

Sintaxis

BOOL GetKeyboardLayoutNameA(
  [out] LPSTR pwszKLID
);

Parámetros

[out] pwszKLID

Tipo: LPTSTR

El búfer (de al menos KL_NAMELENGTH caracteres de longitud) que recibe el nombre del identificador de configuración regional de entrada, incluido el carácter nulo de terminación. Se trata de una copia de la cadena proporcionada a la función LoadKeyboardLayout , a menos que se realice la sustitución del diseño.

Para obtener una lista de los diseños de entrada que se proporcionan con Windows, vea Identificadores de teclado y Editores de métodos de entrada para Windows.

Valor devuelto

Tipo: BOOL

Si la función se realiza correctamente, el valor devuelto es distinto de cero.

Si la función no se realiza correctamente, el valor devuelto es cero. Para obtener información de error extendida, llame a GetLastError.

Comentarios

El identificador de configuración regional de entrada es un concepto más amplio que un diseño de teclado, ya que también puede abarcar un convertidor de voz a texto, un Editor de métodos de entrada (IME) o cualquier otra forma de entrada.

A partir de Windows 8: El método preferido para recuperar el idioma asociado al diseño de teclado o al método de entrada actual es una llamada a Windows.Globalization.Language.CurrentInputMethodLanguageTag. Si la aplicación pasa etiquetas de idioma de CurrentInputMethodLanguageTag a cualquier función de compatibilidad con lenguaje nacional , primero debe convertir las etiquetas mediante una llamada a ResolveLocaleName.

Nota:

El encabezado winuser.h define GetKeyboardLayoutName 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 neutral de codificación con código que no es neutral de codificación puede dar lugar a errores de coincidencia que dan lugar a errores de compilación o 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 2000 Server [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	winuser.h (incluir Windows.h)
Library	User32.lib
Archivo DLL	User32.dll