Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
A version of this page is also available for
4/8/2010

This function gets the file name of the IME associated with the specified keyboard layout.

Syntax 

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

Parameters

hKL

[in] Handle to the keyboard layout. Windows Embedded CE does not support keyboard layouts; however, hKLis used in this instance to distinguish between locale-specific IMEs.

lpszFileName

[out] Long pointer to the buffer that receives the file name.

uBufLen

[in] Size, in bytes, of the buffer. If zero, the function returns the buffer size in bytes needed to receive the file name, not including the terminating null character.

Return Value

The number of bytes in the file name copied to the buffer, or, if uBufLenis zero, the buffer size needed for the file name indicates success. In either case, the terminating null character is not included.

Remarks

In the registry, the system stores the file name as the IME name value in HKEY_LOCAL_MACHINEroot under the System\CurrentControlSet\Control\Layout\hKLkey.

Requirements

Header imm.h
Library Coreimm.lib
Windows Embedded CE Windows CE .NET 4.0 and later
Windows Mobile Windows Mobile Version 5.0 and later