Partager via

SHSipSetAutoDeploy (Compact 2013)

  • Article

3/28/2014

This function sets the state to enable or disable software-based input panel (SIP) auto-deploy for a window when the text input control gains focus or the user taps the text input control.

Syntax

HRESULT SHSipSetAutoDeploy(
    HWND hWnd, 
    SIP_AUTODEPLOY_STATE st
);

Parameters

  • hWnd
    [in] Handle of the window for which to enable or disable SIP auto-deploy.
  • st
    [in] SIP auto-deploy state to set for the window. The state must 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

Success. SIP auto-deploy state set.

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_OUTOFMEMORY

Failed to allocate memory for a window property.

E_FAIL

Error occurred when setting a window property.

Remarks

The SIP status is not changed when this API is called. To change the current SIP status, call SipSetInfo or SipShowIM.

Requirements

Header

sipapi.h

Library

ShellSDK.lib

See Also

Reference

Software-based Input Panel Functions