ImmGetDescription function

Copies the description of the IME to the specified buffer.


UINT ImmGetDescription(
  _In_      HKL    hKL,
  _Out_opt_ LPTSTR lpszDescription,
  _In_      UINT   uBufLen


hKL [in]

Input locale identifier.

lpszDescription [out, optional]

Pointer to a buffer in which the function retrieves the null-terminated string describing the IME.

uBufLen [in]

Size, in characters, of the output buffer. The application sets this parameter to 0 if the function is to return the buffer size needed for the complete description, excluding the terminating null character.

Windows NT, Windows 2000, Windows XP: The size of the buffer is in Unicode characters, each consisting of two bytes. If the parameter is set to 0, the function returns the size of the buffer required in Unicode characters, excluding the Unicode terminating null character.

Return value

Returns the number of characters copied to the output buffer. If the application sets the uBufLen parameter to 0, the function returns the size of the buffer required 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 terminating null character.


Minimum supported client

Windows XP [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]


East Asian language support installed., East Asian language support installed.


Imm.h (include Windows.h)





Unicode and ANSI names

ImmGetDescriptionW (Unicode) and ImmGetDescriptionA (ANSI)

See also

Input Method Manager
Input Method Manager Functions