ImmGetCandidateList function

Retrieves a candidate list.

Syntax


DWORD ImmGetCandidateList(
  _In_       HIMC hIMC,
  _In_       DWORD dwIndex,
  _Out_opt_  LPCANDIDATELIST lpCandList,
  _In_       DWORD dwBufLen
);

Parameters

hIMC [in]

Handle to the input context.

dwIndex [in]

Zero-based index of the candidate list.

lpCandList [out, optional]

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

dwBufLen [in]

Size, in bytes, of the buffer to receive the candidate list. The application can specify 0 for this parameter if the function is to return the required size of the output buffer only.

Return value

Returns the number of bytes copied to the candidate list buffer if successful. If the application has supplied 0 for the dwBufLen parameter, the function returns the size required for the candidate list buffer.

The function returns 0 if it does not succeed.

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

ImmGetCandidateListW (Unicode) and ImmGetCandidateListA (ANSI)

See also

Input Method Manager
Input Method Manager Functions
CANDIDATELIST

 

 

Community Additions

ADD
Show:
© 2014 Microsoft