ImmGetConversionList

The ImmGetConversionList function retrieves the list of characters or words from one character or word.

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

Parameters

hKL

Handle to the keyboard layout.

hIMC

Handle to the input context.

lpSrc

Pointer to a null-terminated character string.

lpDst

Pointer to the CANDIDATELIST structure that receives the conversion result.

dwBufLen

Size of the destination buffer, in bytes. If zero, the function returns the buffer size needed for the complete conversion result.

uFlag

Action flag. This parameter can be 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 that would be created if GCL_REVERSECONVERSION were specified.

Return Values

Returns the number of bytes copied to the specified buffer or, if dwBufLen is zero, the buffer size needed to receive the list.

Remarks

Windows CE: The hKL parameter must be NULL.

QuickInfo

  Windows NT: Requires version 4.0 or later.
  Windows: Requires Windows 95 or later.
  Windows CE: Requires version 2.0 or later (FE).
  Header: Declared in imm.h.
  Import Library: Use imm32.lib.
  Unicode: Implemented as Unicode and ANSI versions on Windows NT.

See Also

Input Method Editor Overview, Input Method Editor Functions, CANDIDATELIST