Share via

IIMCallback3::SendAlternatives2 (Compact 2013)

  • Article

3/28/2014

This method sends an alternatives list to an input method editor (IME) when the input method calls it.

Syntax

HRESULT SendAlternatives2(
  LMDATA* plmd
);

Parameters

  • plmd
    A pointer to an LMDATA structure that contains information to be sent from the input method to the IME.

Return Value

The following table shows the possible return values.

Value

Description

S_OK

Success.

E_INVALIDARG

Invalid method parameter.

E_FAIL

Other failure. To get more information, call GetLastError.

Remarks

The input method calls this method to send a list of alternatives to the active window. The IME is provided a list of alternative choices for integration into the candidate list, and a list is presented to the end user. For more information, see Input Method Editor (IME).

When the input method sends the alternatives to the software-based input panel (SIP) they are packaged up, and the SIP sends the structure in a WM_SYSCOPYDATA message to the active control, with the wParam set to WMSCD_CHAR_RANKED_ALTS. If the active control does not handle the message, the message is forwarded to the IME for processing.

If an application or IME returns TRUE in response to a WM_SYSCOPYDATA message, this method resends the first candidate character.

Requirements

Header

sip.h

Library

uuid.lib

sysgen

SYSGEN_SOFTKB

See Also

Reference

IIMCallback3
WM_SYSCOPYDATA
IIMCallback3::GetInputContext
IIMCallback3::SendCharEvents
IIMCallback3::SendString
IIMCallback3::SendVirtualKey
IIMCallback3::SetImInfo