IIMCallback::SetImInfo (Compact 2013)

  • Article

3/28/2014

This method is called by the input method (IM) to change the bitmaps shown on the Input Panel button to change the visible state of the software-based input panel (SIP), or to notify the SIP when the IM 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 IM 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

An appropriate HRESULT value is returned.

Remarks

IMs use this method to alter part of the SIP state. For example, an IM may include a user interface element that allows the user to toggle the SIP between a docked and floating state. However, the SIP uses all values passed in the IMINFO structure. Therefore, the IM must create and initialize an IMINFO structure that is identical to the current IMINFO structure. The IM should toggle the SIPF_DOCKED flag in the fdwFlags member, and use the altered IMINFO structure in this method. Much of the information in the IMINFO structure is also contained in the SIPINFO structure. An IM receives this information upon initialization, with the IInputMethod::ReceiveSipInfo method.

Applications written for Windows Embedded Compact can access the SIPINFO structure using the SipSetInfo function.

An IM can set the rcSipRect member of the IMINFO structure to set the new position of the SIP window. If rcSipRect is zeroed-out, then rcSipRect is ignored and no position is altered.

Requirements

Header

sip.h

Library

uuid.lib

sysgen

SYSGEN_SOFTKB

See Also

Reference

IIMCallback
SipSetInfo
IInputMethod::ReceiveSipInfo
IMINFO
SIPINFO