ImmGetDescription (Windows CE 5.0)

Send Feedback

This function copies the description of the IME to the specified buffer.

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


  • hKL
    [in] Handle to the keyboard layout.

  • lpszDescription
    [out] Long pointer to the buffer that receives the null-terminated string describing the IME.

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

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

Return Values

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


OS Versions: Windows CE .NET 4.0 and later.
Header: Imm.h.
Link Library: Coreimm.lib.

Send Feedback on this topic to the authors

Feedback FAQs

© 2006 Microsoft Corporation. All rights reserved.