ImmGetDescription

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

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

Parameters

hKL

[in] Input locale identifier.

lpszDescription

[out] Pointer to a buffer that receives the null-terminated string describing the IME.

uBufLen

[in] Specifies the 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/ 2000: The size of the buffer is in Unicode characters (each character is two bytes). If zero, the function returns the size of the buffer required in unicode characters, not including the Unicode NULL terminator.

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.

For Unicode, the function returns the number of Unicode characters, not including the Unicode NULL terminator.

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