This topic has not yet been rated - Rate this topic

ImmGetConversionList function

Applies to: desktop apps only

Retrieves the conversion result list of characters or words without generating any IME-related messages.

Syntax

Copy

DWORD ImmGetConversionList(
  __in   HKL hKL,
  __in   HIMC hIMC,
  __in   LPCTSTR lpSrc,
  __out  LPCANDIDATELIST lpDst,
  __in   DWORD dwBufLen,
  __in   UINT uFlag
);

Parameters

hKL [in]

Input locale identifier.

hIMC [in]

Handle to the input context.

lpSrc [in]

Pointer to a null-terminated character string specifying the source of the list.

lpDst [out]

Pointer to a CANDIDATELIST structure in which the function retrieves the list.

dwBufLen [in]

Size, in bytes, of the output buffer. The application sets this parameter to 0 if the function is to return the buffer size required for the complete conversion result list.

uFlag [in]

Action flag. This parameter can have one of the following values.

Value	Meaning
GCL_CONVERSION	Source string is the reading string. The function copies the result string to the destination buffer.
GCL_REVERSECONVERSION	Source string is the result string. The function copies the reading string to the destination buffer.
GCL_REVERSE_LENGTH	Source string is the result string. The function returns the size, in bytes, of the reading string created if GCL_REVERSECONVERSION is specified.

Return value

Returns the number of bytes copied to the output buffer. If the application sets the dwBufLen parameter to 0, the function returns the size, in bytes, of the required output buffer.

Requirements

Minimum supported client	Windows XP
Minimum supported server	Windows Server 2003
Version	East Asian language support installed.
Header	Imm.h (include Windows.h)
Library	Imm32.lib
DLL	Imm32.dll
Unicode and ANSI names	ImmGetConversionListW (Unicode) and ImmGetConversionListA (ANSI)

ImmGetConversionList function

Syntax

Parameters

Return value

Requirements

See also