IActiveIMMIME::GetCandidateWindow method

  • Article

Gets information about the candidate list window.

Syntax

HRESULT GetCandidateWindow(
  [in]  HIMC          hIMC,
  [in]  DWORD         dwIndex,
  [out] CANDIDATEFORM *pCandidate
);

Parameters

  • hIMC [in]
    A handle to the input context.

  • dwIndex [in]
    An unsigned long integer value that contains the size, in bytes, of the buffer.

  • pCandidate [out]
    The address of a CANDIDATEFORM structure that receives information about the candidate window.

Return value

Returns S_OK if successful, or an error value otherwise.

Remarks

This method maps to the ImmGetCandidateWindow function that is documented in the Windows Software Development Kit (SDK).

Requirements

Minimum supported client

 Windows XP

Minimum supported server

 Windows 2000 Server

Header

 Dimm.h

IDL

 Dimm.idl

See also

IActiveIMMIME