ImmGetConversionList function

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

Syntax


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.

ValueMeaning
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 [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

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)

See also

Input Method Manager
Input Method Manager Functions
CANDIDATELIST

 

 

Community Additions

ADD
Show:
© 2014 Microsoft