ImmGetDescription

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

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

Syntax

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

Parameters

• 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 Value

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.

Requirements