SipSetInfo (Compact 2013)

3/28/2014

This function sets information including the state of the software-based input panel (SIP), the area of the desktop that is not obscured by the SIP, the screen coordinates of the SIP, and application-defined information about the input method (IM) that the SIP is currently using.

Syntax

BOOL SipSetInfo( 
  SIPINFO* pSipInfo
);

Parameters

  • pSipInfo
    [in] Pointer to the SIPINFO structure that contains information about the current SIP.

Return Value

TRUE indicates success. FALSE indicates failure. To get extended error information, call GetLastError.

Remarks

Use this function to set the SIP information to accommodate the current IM by setting information in the SIPINFO structure such as the SIP window position, size, and state. An application calling SipSetInfo cannot request that the SIP window be resized. The size of the SIP window is based on coordination between the SIP and IM.

To prevent undesirable information from being passed to SipSetInfo, clear the SIPINFO structure beforehand. The following code example shows how to clear the structure.

memset(pSipInfo, 0, sizeof(SIPINFO))

Use the SipGetInfo function to retrieve information the SIP.

Requirements

Header

sipapi.h

Library

coredll.lib

sysgen

SYSGEN_SOFTKB

See Also

Reference

Software-based Input Panel Functions
SipGetInfo
SIPINFO