ImmGetDescription

The ImmGetDescription function copies the description of the IME to the specified buffer.

UINT ImmGetDescription(
  HKL hKL,                  
  LPTSTR lpszDescription,   
  UINT uBufLen              
);
 

Parameters

hKL

Handle to the keyboard layout.

lpszDescription

Pointer to the buffer that receives the null-terminated string describing the IME.

uBufLen

Size of the buffer, in characters. If zero, the function returns the buffer size needed for the complete description, not including terminating null character.

Windows NT: The size of the buffer is in Unicode characters (each character is two bytes).

Return Values

Returns the number of characters copied to the buffer or, if uBufLen is zero, the buffer size in characters needed to receive the description. Neither value includes the terminating null character.

QuickInfo

  Windows NT: Requires version 4.0 or later.
  Windows: Requires Windows 95 or later.
  Windows CE: Unsupported.
  Header: Declared in imm.h.
  Import Library: Use imm32.lib.
  Unicode: Implemented as Unicode and ANSI versions on Windows NT.

See Also

Input Method Editor Overview, Input Method Editor Functions