Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
A version of this page is also available for
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 uBufLenis zero, the buffer size in characters needed to receive the description indicates success. Neither value includes the terminating null character.

Requirements

Header imm.h
Library Coreimm.lib
Windows Embedded CE Windows CE .NET 4.0 and later
Windows Mobile Windows Mobile Version 5.0 and later