IInputMethod2::ReceiveSipInfo

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This method is implemented for the IM to receive information about the size, placement, and docked status of the software-based input panel.

Syntax

HRESULT ReceiveSipInfo( 
  SIPINFO* psi
);

Parameters

• psi
  Pointer to a SIPINFO structure. Because this method only provides information regarding the size, placement and docked status of the software-based input panel, only the rcSipRect member and the SIPF_DOCKED flag, if set, of the fdwFlagsmember are valid in this SIPINFO structure.

Return Value

Return S_OK to indicate success. Return the appropriate HRESULT value to indicate failure.

Remarks

The software-based input panel calls this method to provide the IM with the current size, placement, and docked status of the software-based input panel. This method is called whenever the user, an application, or the IM changes the software-based input panel state. The IM should respond to these new values by changing its own state. However, it could also ignore these values. For example, a developer can implement an IM that is larger or smaller than the standard size for an IM. These values have either been selected by the user, or have been recommended as expected software-based input panel values for that platform.

The software-based input panel also calls this method during the initialization of the IM, along with Select, GetInfo, and RegisterCallback.

Requirements

See Also

Reference

IInputMethod2::GetInfo
IInputMethod2::RegisterCallback
IInputMethod2::Select
SIPINFO