SIPINFO (Compact 2013)

3/28/2014

This structure contains information about the current state of the software-based input panel (SIP) such as its 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 sizeof operator.

• fdwFlags
  Specifies flags representing state information of the SIP. The following table shows the possible bit flags. These flags can be combined.

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

• rcVisibleDesktop
  Rectangle, in screen coordinates, that represents the area of the desktop not obscured by the SIP. If the SIP is floating, this rectangle is equivalent to the working area. Full-screen applications that respond to SIP size changes can set their window rectangle to this rectangle. If the SIP is docked but does not occupy an entire edge, then this rectangle represents the largest rectangle not obscured by the SIP. If an application wants to use the screen space around the SIP, 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 SIP. An application does not generally use this information unless it needs to wrap around a floating or a docked SIP that does not occupy an entire edge.

• dwImDataSize
  Specifies the size of the data pointed to by the pvImData member.

• pvImData
  Void pointer to data defined by the input method. The input method calls the IInputMethod::GetImData and IInputMethod::SetImData methods to send and receive information from the SIPINFO structure.

Remarks

The SipSetInfo function can either set a SIPINFO structure with the current SIP state or take a SIPINFO structure and use its values to set the current SIP state.

You cannot use SipSetInfo to resize the SIP window. Use an input method to resize the SIP window.

SIPINFO is also used by an application and an input method to send and receive input method-specific information by using the IInputMethod::SetImData and IInputMethod::GetImData methods.

Requirements

Header	sipapi.h
sysgen	SYSGEN_SOFTKB

See Also

Reference

Software-based Input Panel Structures
SipSetInfo
IInputMethod::GetImData
IInputMethod::SetImData