ImmGetIMEFileName

The ImmGetIMEFileName function gets the file name of the IME associated with the specified input locale.

UINT ImmGetIMEFileName(
  HKL hKL,               
  LPTSTR lpszFileName,   
  UINT uBufLen           
);

Parameters

hKL

[in] Input locale identifier.

lpszFileName

[out] Pointer to a buffer that receives the file name. It can be NULL when uBufLen is NULL.

uBufLen

[in] Specifies the size, in bytes, of the buffer. If zero, the function returns the buffer size needed to receive the file name, not including the terminating null character. If Unicode, uBufLen specifies the length in unicode characters, not including the terminating null character.

Return Values

The function returns the number of bytes in the file name copied to the buffer, or if uBufLen is zero, the return value is the buffer size needed for the file name. In either case, the terminating null character is not included.

If Unicode, it returns the number of Unicode characters copied into the buffer specified with lpszFileName not including the Unicode NULL terminator.

Remarks

In the registry, the system stores the file name as the IME name value in HKEY_LOCAL_MACHINE root under the \System\CurrentControlSet\control\keyboard layouts\hKL key.

Requirements

  Windows NT/2000: Requires Windows NT 4.0 or later.
  Windows 95/98: Requires Windows 95 or later.
  Header: Declared in Imm.h.
  Library: Use Imm32.lib.
  Unicode: Implemented as Unicode and ANSI versions on Windows NT/2000.

See Also

Input Method Editor Overview, Input Method Editor Functions