Share via

IIMCallback3::SetImInfo (Compact 2013)

  • Article

3/28/2014

This method changes the bitmaps shown on the Input Panel button when the input method calls it. You can use it to change the visible state of the software-based input panel (SIP) or to notify the SIP when the input method has changed the size, placement, or docked status of the SIP window.

Syntax

HRESULT SetImInfo( 
  IMINFO* pimi
);

Parameters

  • pimi
    Pointer to an IMINFO structure containing the new input method settings, including the size, placement, and state of the SIP window. The IMINFO structure also contains indexes to the bitmaps for the Input Panel button.

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

An input method displays the SIP window in a specific state by using this method. For example, an input method may include a user interface element that allows the user to toggle the SIP between a docked and floating state. To perform this toggle, the input method sets the SIPF_DOCKED flag in the fdwFlags member of the IMINFO structure and then calls this method. Because the SIP uses all values passed in the IMINFO structure, the input method must create and initialize an IMINFO structure that is identical to the current IMINFO structure.

Much of the information in the IMINFO structure is also contained in the SIPINFO structure. An input method receives this information upon initialization with the IInputMethod3::ReceiveSipInfo method.

To adjust to user-initiated changes in the SIP window, applications can query the SIPINFO structure for data on the window size, state, and visible client area of the SIP. Applications written for Windows Embedded Compact can access the SIPINFO structure using the SipSetInfo function.

An input method can set the rcSipRect member of the IMINFO structure to set the new position of the SIP window. If rcSipRect is set to 0 (zero), then rcSipRect is ignored and no position is altered.

Requirements

Header

sip.h

Library

uuid.lib

sysgen

SYSGEN_SOFTKB

See Also

Reference

IIMCallback3
SipSetInfo
IInputMethod3::ReceiveSipInfo
IMINFO
SIPINFO
IIMCallback3::GetInputContext
IIMCallback3::SendAlternatives2
IIMCallback3::SendCharEvents
IIMCallback3::SendString
IIMCallback3::SendVirtualKey