ITcHmiSrvExtAsyncHost.SetConfigValueAsync Method

Adds a Value to a map or vector in the configuration of the TwinCAT HMI server extension or updates an existing configuration Value as an asynchronous operation.

Namespace: TcHmiSrv.Core
Assembly: TcHmiSrvExtNet.Core (in TcHmiSrvExtNet.Core.dll) Version: 1.3.0.0

Syntax

C#

Task<ErrorValue> SetConfigValueAsync(
    Context context,
    string path,
    Value value
)

Parameters

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

Return Value

Type: Task.ErrorValue.
A Task.TResult. that represents the asynchronous operation. The Result of the Task.TResult. returns HMI_SUCCESS if setting the configuration Value succeeded; otherwise, any ErrorValue that best describes which error has occurred.

Reference

ITcHmiSrvExtAsyncHost Interface

TcHmiSrv.Core Namespace