ImmGetConversionList

This 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
    [in] Ignored; set to NULL. Windows 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] Specifies the 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. This parameter can be one of the following values:
    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 Values

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

Runs on Versions Defined in Include Link to
Windows CE OS 2.10 and later (Japanese version 1.0 and later) Imm.h   Coreimm.lib

Note   This API is part of the complete Windows CE OS package as provided by Microsoft. The functionality of a particular platform is determined by the original equipment manufacturer (OEM) and some devices may not support this API.

See Also

CANDIDATELIST

 Last updated on Tuesday, July 13, 2004

© 1992-2000 Microsoft Corporation. All rights reserved.