ITcHmiSrvExtAsyncHost.DeleteConfigValueAsync Method

Deletes a Value from the configuration of the TwinCAT HMI server extension as an asynchronous operation.

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

Syntax

C#

Task<ErrorValue> DeleteConfigValueAsync(
    Context context,
    string path
)

Parameters

context

Type: TcHmiSrv.Core.Context
A Context that contains information about the user who tries to delete the configuration Value.

path

Type: System.String
The path of the configuration Value to delete.

Return Value

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

Reference

ITcHmiSrvExtAsyncHost Interface

TcHmiSrv.Core Namespace