Prev Next

ImmGetDescription info  Overview  Group

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 bytes. If zero, the function returns the buffer size needed for the complete description, not including terminating null character.

Return Values

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