 Important: |
|---|
| This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist. |
This function receives information including the state of the input panel, the area of the desktop that is not obscured by the input panel, the screen coordinates of the input panel, and information about the input method (IM) that the input panel is currently using.
BOOL SipGetInfo( SIPINFO * pSipInfo );
Parameters
- pSipInfo
- [out] Pointer to the
SIPINFOstructure that
contains information about the current input panel.
Return Values
TRUE indicates success. FALSE indicates failure. To get extended error information, call GetLastError.
Remarks
The IM data that is part of the SIPINFOstructure 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 SipGetInfoto fail. To prevent a request to retrieve IM data and avoid an unnecessary failure, set the dwImDataSizemember of SIPINFOto 0 before calling SipGetInfo.
Requirements
Runs On Versions Defined in Include Link to Windows CE OS 2.10 and later Sipapi.h Coresip.lib Note This API is part of the complete Windows CE OS package as provided by Microsoft. The functionality of a particular platform is determined by the original equipment manufacturer (OEM) and some devices may not support this API.
See Also
GetLastError, SipSetInfo, SIPINFO