SipGetInfo
A version of this page is also available for
4/8/2010
This function receives 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 information about the input method (IM) that the software-based input panel is currently using.
Syntax
BOOL SipGetInfo(
SIPINFO* pSipInfo
);
Parameters
- pSipInfo
[out] 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
The IM data that is part of the SIPINFO structure is defined by an IM, not by the Corsip component. Request this information only if you know specifically that the IM has data and only if you know how to use such data. If no IM data is available, a request to retrieve IM data causes SipGetInfo to fail. To prevent a request to retrieve IM data and avoid an unnecessary failure, set the dwImDataSize member of SIPINFO to 0 before calling SipGetInfo.
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 |