ImmGetCandidateListCount function

Retrieves the size of the candidate lists.

Syntax


DWORD ImmGetCandidateListCount(
  _In_  HIMC    hIMC,
  _Out_ LPDWORD lpdwListCount
);

Parameters

hIMC [in]

Handle to the input context.

lpdwListCount [out]

Pointer to the buffer in which this function retrieves the size of the candidate lists.

Return value

Returns the number of bytes required for all candidate lists if successful, or 0 otherwise.

Remarks

Applications typically call this function in response to an IMN_OPENCANDIDATE or IMN_CHANGECANDIDATE command.

Requirements

Minimum supported client

Windows XP [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

Version

East Asian language support installed.

Header

Imm.h (include Windows.h)

Library

Imm32.lib

DLL

Imm32.dll

Unicode and ANSI names

ImmGetCandidateListCountW (Unicode) and ImmGetCandidateListCountA (ANSI)

See also

Input Method Manager
Input Method Manager Functions
IMN_CHANGECANDIDATE
IMN_OPENCANDIDATE

 

 

Show: