IIMCallbackEx::SendAlternatives

4/8/2010

The SendAlternatives method enables an input method (IM) to send information to an input method editor (IME).

Syntax

HRESULT SendAlternatives (
  LMDATA * plmd
);

Parameters

• plmd
  [in] Pointer to a Windows Embedded CE LMDATA structure that contains information that is to be sent from the IM to the IME. The plmd buffer must be allocated using LocalAlloc. When the call is complete, this routine uses LocalFree to free the buffer.

Return Value

This method supports the standard return values E_FAIL, E_INVALIDARG, E_OUTOFMEMORY, and E_UNEXPECTED, as well as the following:

• S_OK
  The information was successfully sent to the IME.

Remarks

An alternatives list is a list of choices provided to the IME for integration into the candidate list. This candidate list then can be presented to the end-user to enable the end-user to make the best choice.

When the alternatives are sent to the software-based input panel, they are packaged up and the software-based input panel 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 FALSE in response to a WM_SYSCOPYDATA message, this method resends the first candidate character.

Requirements

See Also

Reference

IIMCallbackEx