Função ImmGetIMEFileNameW (imm.h)

Recupera o nome do arquivo do IME associado à localidade de entrada especificada.

Sintaxe

UINT ImmGetIMEFileNameW(
                  HKL    unnamedParam1,
  [out, optional] LPWSTR lpszFileName,
  [in]            UINT   uBufLen
);

Parâmetros

unnamedParam1

[out, optional] lpszFileName

Ponteiro para um buffer no qual a função recupera o nome do arquivo. Esse parâmetro contém NULL quando uBufLen é definido como NULL.

[in] uBufLen

Tamanho, em bytes, do buffer de saída. O aplicativo especifica 0 se a função deve retornar o tamanho do buffer necessário para receber o nome do arquivo, não incluindo o caractere nulo de encerramento. Para Unicode, uBufLen especifica o tamanho em caracteres Unicode, não incluindo o caractere nulo de terminação.

Valor de retorno

Retorna o número de bytes no nome do arquivo copiado para o buffer de saída. Se o aplicativo definir uBufLen como 0, a função retornará o tamanho do buffer necessário para o nome do arquivo. Em ambos os casos, o caractere nulo de terminação não está incluído.

Para Unicode, a função retorna o número de caracteres Unicode copiados para o buffer de saída, sem incluir o caractere nulo de terminação Unicode.

Observações

No registro, o sistema operacional armazena o nome do arquivo como o "valor do nome do IME" na chave do Registro HKEY_LOCAL_MACHINE\System\CurrentControlSet\Control\Keyboard Layouts\HKL.

Nota

O cabeçalho imm.h define ImmGetIMEFileName como um alias que seleciona automaticamente a versão ANSI ou Unicode dessa função com base na definição da constante do pré-processador UNICODE. A combinação do uso do alias neutro de codificação com código que não é neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Conventions for Function Prototypes.

Requisitos

Requisito	Valor
de cliente com suporte mínimo	Windows XP [somente aplicativos da área de trabalho], suporte à linguagem do Leste Asiático instalado.
servidor com suporte mínimo	Windows Server 2003 [somente aplicativos da área de trabalho]
da Plataforma de Destino	Windows
cabeçalho	imm.h (inclua Immdev.h, Windows.h)
biblioteca	Imm32.lib
de DLL	Imm32.dll

Consulte também

do Gerenciador de Métodos de Entrada

Funções do Gerenciador de Métodos de Entrada