ImmGetConversionListA function (immdev.h)

Article
02/09/2023

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

Syntax

DWORD ImmGetConversionListA(
        HKL             unnamedParam1,
        HIMC            unnamedParam2,
  [in]  LPCSTR          lpSrc,
  [out] LPCANDIDATELIST lpDst,
  [in]  DWORD           dwBufLen,
  [in]  UINT            uFlag
);

Parameters

unnamedParam1

unnamedParam2

[in] lpSrc

Pointer to a null-terminated character string specifying the source of the list.

[out] lpDst

Pointer to a CANDIDATELIST structure in which the function retrieves the list.

[in] dwBufLen

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.

[in] uFlag

Action flag. This parameter can have 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 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.

Remarks

Note

The immdev.h header defines ImmGetConversionList as an alias which automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

Requirements

Requirement	Value
Minimum supported client	Windows XP [desktop apps only],East Asian language support installed.
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	immdev.h (include Immdev.h, Windows.h)
Library	Imm32.lib
DLL	Imm32.dll