SHSipGetAutoDeploy (Compact 2013)
3/28/2014
This function retrieves the software-based input panel (SIP) auto-deploy state for a window when the text input control gains focus or the user taps the text input control.
Syntax
HRESULT SHSipGetAutoDeploy(
HWND hWnd,
pSIP_AUTODEPLOY_STATE lpState)
);
Parameters
- hWnd
[in] Handle of the window for which to enable or disable auto-deploy.
- lpState
[out] Pointer to the SIP_AUTODEPLOY_STATE, which represents the current SIP auto-deploy state for the window. The state can be one of the following values: SIP_AUTODEPLOY_ENABLE, SIP_AUTODEPLOY_DISABLE, or SIP_AUTODEPLOY_INHERIT.
Return Value
The following table shows the possible return values.
Value |
Description |
|---|---|
S_OK |
The function succeeded. |
E_INVALIDARG |
The input parameter is incorrect. The hWnd parameter is invalid or the state is not one of the three defined states: SIP_AUTODEPLOY_ENABLE, SIP_AUTODEPLOY_DISABLE, or SIP_AUTODEPLOY_INHERIT. |
E_FAIL |
An error occurred while the function was retrieving a window property. |
Requirements
Header |
sipapi.h |
Library |
ShellSDK.lib |
See Also
Reference
Software-based Input Panel Functions