SIPINFO

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This structure contains information about the current state of the software-based input panel, such as the software-based input panel size, screen location, docked status, and visibility status.

Syntax

typedef struct{
  DWORD cbSize;
  DWORD fdwFlags;
  RECT rcVisibleDesktop;
  RECT rcSipRect; 
  DWORD dwImDataSize;
  VOID* pvImData;
} SIPINFO;

Members

• cbSize
  Size, in bytes, of the SIPINFO structure. This member must be filled in by the application with the size of operator. Because the system can check the size of the structure to determine the operating system version number, this member allows for future enhancements to the SIPINFO structure while maintaining backward compatibility.

• fdwFlags
  Specifies flags representing state information of the software-based input panel. The following table shows the possible bit flags. These flags can be used in combination.

  Value	Description
  SIPF_DOCKED	The software-based input panel is docked, or not floating.
  SIPF_LOCKED	The software-based input panel is locked, meaning that the user cannot change its visible status.
  SIPF_OFF	The software-based input panel is off, or not visible.
  SIPF_ON	The software-based input panel is on, or visible.

• rcVisibleDesktop
  Rectangle, in screen coordinates, that represents the area of the desktop not obscured by the software-based input panel. If the software-based input panel is floating, this rectangle is equivalent to the working area. Full-screen applications that respond to software-based input panel size changes can set their window rectangle to this rectangle. If the software-based input panel is docked but does not occupy an entire edge, then this rectangle represents the largest rectangle not obscured by the software-based input panel. If an application wants to use the screen space around the software-based input panel, it needs to reference rcSipRect.

• rcSipRect
  Rectangle, in screen coordinates of the window rectangle and not the client area, the represents the size and location of the software-based input panel. An application does not generally use this information unless it needs to wrap around a floating or a docked software-based input panel that does not occupy an entire edge.

• dwImDataSize
  Specifies the size of the data pointed to by the pvImDatamember.

• pvImData
  Void pointer to IM-defined data. The IM calls the IInputMethod::GetImData and IInputMethod::SetImData methods to send and receive information from this structure.

Remarks

In Windows CE 2.10 and later, the SipSetInfo function can either set a SIPINFO structure with the current software-based input panel state or take a SIPINFO structure and use its values to set the current software-based input panel state.

In Windows CE 3.0 and later, you cannot use SipSetInfo to resize the software-based input panel window. Use an IM to resize the software-based input panel window.

SIPINFO is also used by an application and an IM to send and receive IM-specific information. The IM receives information about the SIPINFO structure through the IInputMethod::GetSipInfo method.

In Windows CE 3.0 and later, an application that calls SipSetInfo cannot resize the software-based input panel window. Only an IM can resize the software-based input panel window.

Requirements

See Also

Reference

SipSetInfo
IInputMethod::GetImData
IInputMethod::SetImData