ImmGetDescriptionA function (imm.h)

Copies the description of the IME to the specified buffer.

Syntax

UINT ImmGetDescriptionA(
                  HKL   unnamedParam1,
  [out, optional] LPSTR lpszDescription,
  [in]            UINT  uBufLen
);

Parameters

unnamedParam1

[out, optional] lpszDescription

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

[in] uBufLen

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.

Remarks

Requirements

See also

Input Method Manager

Input Method Manager Functions