ImmGetConversionList

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

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

Syntax

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

Parameters

• hKL
  [in] Ignored; set to NULL. Windows Embedded CE does not support true keyboard layouts.

• hIMC
  [in] Handle to the input context.

• lpSrc
  [in] Long pointer to a null-terminated character string.

• lpDst
  [out] Long pointer to the CANDIDATELIST structure that receives the conversion result.

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

• uFlag
  [in] Action flag. The following table shows the values this parameter can take.

  Value	Description
  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 Value

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

Requirements

See Also

Reference

CANDIDATELIST