Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
A version of this page is also available for
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 SIPINFOstructure. Because this method only provides information regarding the size, placement and docked status of the software-based input panel, only the rcSipRectmember and the SIPF_DOCKED flag, if set, of the fdwFlagsmember are valid in this SIPINFOstructure.

Return Value

Return S_OK to indicate success. Return the appropriate HRESULTvalue 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

Header sip.h
Library uuid.lib
Windows Embedded CE Windows CE 2.12 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also