nf-immdev-immgetconversionlista.md

UID	title	description	helpviewer_keywords	old-location	tech.root	ms.assetid	ms.date	ms.keywords	req.header	req.include-header	req.target-type	req.target-min-winverclnt	req.target-min-winversvr	req.kmdf-ver	req.umdf-ver	req.ddi-compliance	req.unicode-ansi	req.idl	req.max-support	req.namespace	req.assembly	req.type-library	req.lib	req.dll	req.irql	targetos	req.typenames	req.redist	ms.custom	f1_keywords	dev_langs	topic_type	api_type	api_location	api_name
NF:immdev.ImmGetConversionListA	ImmGetConversionListA function (immdev.h)	The ImmGetConversionListA (ANSI) function (immdev.h) retrieves the conversion result list of characters or words without generating any IME-related messages.	GCL_CONVERSION GCL_REVERSECONVERSION GCL_REVERSE_LENGTH ImmGetConversionListA	intl\immgetconversionlist.htm	Intl	c38547fa-b9d8-41a0-8d73-21056212b775	08/04/2022	GCL_CONVERSION, GCL_REVERSECONVERSION, GCL_REVERSE_LENGTH, ImmGetConversionList, ImmGetConversionList function [Internationalization for Windows Applications], ImmGetConversionListA, ImmGetConversionListW, _win32_ImmGetConversionList, imm/ImmGetConversionList, imm/ImmGetConversionListA, imm/ImmGetConversionListW, intl.immgetconversionlist	immdev.h	Immdev.h, Windows.h	Windows	Windows XP [desktop apps only],East Asian language support installed.	Windows Server 2003 [desktop apps only]				ImmGetConversionListW (Unicode) and ImmGetConversionListA (ANSI)						Imm32.lib	Imm32.dll		Windows			19H1	ImmGetConversionListA immdev/ImmGetConversionListA	c++	APIRef kbSyntax	DllExport	Imm32.dll	ImmGetConversionList ImmGetConversionListA ImmGetConversionListW

ImmGetConversionListA function

-description

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

-parameters

-param HKL [in]

Input locale identifier.

-param HIMC [in]

Handle to the input context.

-param lpSrc [in]

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

-param lpDst [out]

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

-param dwBufLen [in]

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.

-param uFlag [in]

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.

-returns

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.

-see-also

CANDIDATELIST

Input Method Manager

Input Method Manager Functions

-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.