ImmGetConversionList

The ImmGetConversionList function retrieves the conversion result list of characters or words without generating any IME-related messages.

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

Parameters

hKL

[in] Input locale identifier.

hIMC

[in] Handle to the input context.

lpSrc

[in] Pointer to a null-terminated character string.

lpDst

[out] Pointer to a CANDIDATELIST structure that receives the conversion result.

dwBufLen

[in] Specifies the size of the destination buffer, in bytes. If this parameter is zero, the function returns the buffer size needed for the complete conversion result.

uFlag

[in] 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.

Requirements

  Windows NT/2000: Requires Windows NT 4.0 or later.
  Windows 95/98: Requires Windows 95 or later.
  Header: Declared in Imm.h.
  Library: Use Imm32.lib.
  Unicode: Implemented as Unicode and ANSI versions on Windows NT/2000.

See Also

Input Method Editor Overview, Input Method Editor Functions, CANDIDATELIST