Share via


IMsTscAdvancedSettings::put_allowBackgroundInput

Other versions of this page are also available for the following:

Windows Mobile Not SupportedWindows Embedded CE Supported

8/28/2008

This method sets the value of the allowBackgroundInput property, which determines whether or not background-input mode is enabled. When background input is enabled the client can accept input when the client does not have focus.

Syntax

HRESULT put_allowBackgroundInput(
  long allowBackgroundInput
);

Parameters

  • allowBackgroundInput
    [in] The value the allowBackgroundInput property is to be set to. If set to zero, background input-mode is disabled. If set to any other value, the mode is enabled.

Return Value

If the method succeeds, the return value is S_OK.

If it fails, the method returns a nonzero error code.

Requirements

Header discodlg.h, mstsax.idl
Library Mstsax.lib
Windows Embedded CE Windows CE .NET 4.0 and later

See Also

Reference

IMsTscAdvancedSettings
IMsTscAdvancedSettings::get_allowBackgroundInput