Share via

IMediaCenterInputCallback::DisplayCandidateList Method

  • Article

Enables an IME module to specify a candidate list for the shell to display.

Note   This method has been deprecated.

Syntax

  HRESULT DisplayCandidateList(
  INT  cCandidates,
  BSTRARRAY  rgCandidates,
  INT  iTopIndex
);

Parameters

cCandidates

[in] Integer indicating a count of the candidates in the rgCandidates array.

rgCandidates

[in] Array of strings containing the candidates to display.

iTopIndex

[in] Integer indicating the zero-based index of the top visible candidate.

Return Value

If the method succeeds, it returns S_OK. If it fails, it returns an HRESULT error code.

Remarks

The shell enables the user to select one of the candidates or to escape from the candidate selection UI. The shell delivers the user's selection to the IME module by calling the module's IMediaCenterInputField::ProcessCandidateSelection method.

Requirements

Header: ehinputmodule.idl

Platform: Windows XP Media Center Edition 2004 through Windows Vista

See Also