ImmGetIMEFileName

A version of this page is also available for

Windows Embedded CE 6.0 R3

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, hKL is 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 uBufLen is 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_MACHINE root under the System\CurrentControlSet\Control\Layout\hKL key.

Requirements