Compartir a través de


SipSetInfo

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

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

Syntax

BOOL SipSetInfo( 
  SIPINFO* pSipInfo
);

Parameters

  • pSipInfo
    [in] Pointer to the SIPINFO structure that contains information about the current software-based input panel.

Return Value

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

Remarks

Use this function to set the software-based input panel information to accommodate the current IM by setting information in the SIPINFO structure such as the software-based input panel window position, size, and state. An application calling SipSetInfo cannot request that the software-based input panel window be resized. The size of the software-based input panel window is based on coordination between the software-based input panel 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 software-based input panel.

Requirements

Header sipapi.h
Library coredll.lib
Windows Embedded CE Windows CE 2.10 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also

Reference

SipGetInfo
SIPINFO