ITcHmiSrvExtAsyncHost.RenameConfigValueAsync Method

Renames a Value in 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> RenameConfigValueAsync(
    Context context,
    string oldPath,
    string newPath
)

Parameters

context

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

oldPath

Type: System.String
The old path of the configuration Value.

newPath

Type: System.String
The new path of the configuration Value.

Return Value

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

Reference

ITcHmiSrvExtAsyncHost Interface

TcHmiSrv.Core Namespace