ImmGetCandidateWindow function

Retrieves information about the candidates window.

Syntax


BOOL ImmGetCandidateWindow(
  _In_  HIMC            hIMC,
  _In_  DWORD           dwIndex,
  _Out_ LPCANDIDATEFORM lpCandidate
);

Parameters

hIMC [in]

Handle to the input context.

dwIndex [in]

Index of the candidates window.

lpCandidate [out]

Pointer to a CANDIDATEFORM structure in which this function retrieves information about the candidates window.

Return value

Returns a nonzero value if successful, or 0 otherwise.

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

See also

Input Method Manager
Input Method Manager Functions
CANDIDATEFORM

 

 

Show: