ITcHmiSrvExtAsyncHostSetConfigValueAsync Method

ITcHmiSrvExtAsyncHost.SetConfigValueAsync is obsolete. Use ITcHmiSrvExtAsyncHost.ReplaceConfigValueAsync instead.

Tries to add a Value to a map or vector in the configuration of the TwinCAT HMI server extension or update an existing configuration Value as an asynchronous operation. Since the configuration Value is set asynchronously, you cannot rely on the Value really being set after this method returned. Therefore, you must verify this by using OnChange or calling GetConfigValueAsync(Context, String).

Namespace: TcHmiSrv.Core
Assembly: TcHmiSrvExtNet.Core (in TcHmiSrvExtNet.Core.dll) Version: 3.1.7447.0+85f9b473a1dd11b8f3e5c9a182fd1901975e46f9

Syntax

C#

[ObsoleteAttribute("ITcHmiSrvExtAsyncHost.SetConfigValueAsync is obsolete. Use ITcHmiSrvExtAsyncHost.ReplaceConfigValueAsync instead.")]
Task<ErrorValue> SetConfigValueAsync(
    Context context,
    string path,
    Value value
)

Parameters

context Context	A Context that contains information about the user who tries to set the configuration Value.
path String	The path of the configuration Value to set.
value Value	The configuration Value to set.

Return Value

Task ErrorValue
A TaskTResult that represents the asynchronous operation. The Result of the TaskTResult returns HMI_SUCCESS if starting an asynchronous operation to set the configuration Value succeeded; otherwise, any ErrorValue that best describes which error has occurred.

Version Information

Obsolete (compiler warning) in 2.3.7447.0
Obsolete (compiler warning) in 1.10.7447.0

Reference

ITcHmiSrvExtAsyncHost Interface TcHmiSrv.Core Namespace