Função GetKeyboardLayoutNameA (winuser.h)

Artigo
07/21/2023

Recupera o nome do identificador de localidade de entrada ativo (anteriormente chamado de layout do teclado) para o thread de chamada.

Sintaxe

BOOL GetKeyboardLayoutNameA(
  [out] LPSTR pwszKLID
);

Parâmetros

[out] pwszKLID

Tipo: LPTSTR

O buffer (de pelo menos KL_NAMELENGTH caracteres de comprimento) que recebe o nome do identificador de local de entrada, incluindo o caractere nulo de terminação. Essa será uma cópia da cadeia de caracteres fornecida para a função LoadKeyboardLayout , a menos que a substituição de layout tenha ocorrido.

Para obter uma lista dos layouts de entrada fornecidos com o Windows, consulte Identificadores de teclado e Editores de Método de Entrada para Windows.

Valor retornado

Tipo: BOOL

Se a função for bem-sucedida, o valor retornado será diferente de zero.

Se a função falhar, o valor retornado será zero. Para obter informações de erro estendidas, chame GetLastError.

Comentários

O identificador de localidade de entrada é um conceito mais amplo do que um layout de teclado, pois também pode abranger um conversor de fala em texto, um IME (Editor de Método de Entrada) ou qualquer outra forma de entrada.

A partir do Windows 8: O método preferencial para recuperar o idioma associado ao layout de teclado atual ou ao método de entrada é uma chamada para Windows.Globalization.Language.CurrentInputMethodLanguageTag. Se o aplicativo passar marcas de idioma de CurrentInputMethodLanguageTag para qualquer função de Suporte à Linguagem Nacional , ele deverá primeiro converter as marcas chamando ResolveLocaleName.

Observação

O cabeçalho winuser.h define GetKeyboardLayoutName como um alias que seleciona automaticamente a versão ANSI ou Unicode dessa função com base na definição da constante de pré-processador UNICODE. Misturar o uso do alias neutro de codificação com código que não seja neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Convenções para protótipos de função.

Requisitos


Cliente mínimo com suporte	Windows 2000 Professional [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows 2000 Server [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	winuser.h (inclua Windows.h)
Biblioteca	User32.lib
DLL	User32.dll