Share via


IInputMethod3::ReceiveSipInfo (Compact 2013)

3/28/2014

Implement this method to receive information about the size, placement, and docked status of the software-based input panel (SIP) for the input method.

Syntax

HRESULT ReceiveSipInfo( 
  SIPINFO* psi
);

Parameters

  • psi
    [in] Pointer to a SIPINFO structure. Only the rcSipRect member and the SIPF_DOCKED flag, if set, of the fdwFlags member are valid in this SIPINFO structure.

Return Value

Returns S_OK to indicate success; otherwise, returns the appropriate HRESULT value to indicate that it was not successful.

Remarks

The SIP calls this method to provide the input method with the current size, placement, and docked status values of the SIP. The SIP calls this method whenever the user, an application, or the input method changes the SIP.

We recommend that the input method respond to these new values by changing its own state. However, you can set it to ignore these values.

The SIP also calls this method during the initialization of the input method, along with IInputMethod3::Select, IInputMethod3::GetInfo, and IInputMethod3::RegisterCallback3.

Requirements

Header

sip.h

Library

uuid.lib

sysgen

SYSGEN_SOFTKB

See Also

Reference

IInputMethod3
SIPINFO
IInputMethod3::Deselect
IInputMethod3::GetInfo
IInputMethod3::Hiding
IInputMethod3::InputContextChange
IInputMethod3::RegisterCallback
IInputMethod3::RegisterCallback2
IInputMethod3::RegisterCallback3
IInputMethod3::Select
IInputMethod3::SetImData
IInputMethod3::SetIMMActiveContext
IInputMethod3::Showing
IInputMethod3::UserOptionsDlg