ITcHmiSrvExtAsyncHostRenameConfigValueAsync 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: 3.1.7447.0+85f9b473a1dd11b8f3e5c9a182fd1901975e46f9

Syntax

C#

Task<ErrorValue> RenameConfigValueAsync(
    Context context,
    string oldPath,
    string newPath
)

Parameters

context  Context

A Context that contains information about the user who tries to rename the configuration Value.

oldPath  String

The old path of the configuration Value.

newPath  String

The new path of the configuration Value.

Return Value

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

Version Information

Supported in: 3.1.7447.0, 2.3.7447.0, 1.10.7447.0

Reference

ITcHmiSrvExtAsyncHost Interface TcHmiSrv.Core Namespace

Copyright © Beckhoff Automation GmbH & Co. KG