updateEx2

[ Function ]

public static updateEx2(
    symbolName: string,
    settings: TcHmi.Server.Historize.IEntrySettings,
    options: TcHmi.Server.Historize.ISetting | null,
    requestOptions: TcHmi.Server.IRequestOptions | null,
    callback?: null | ((this: void, data: TcHmi.IResultObject) => void)
): TcHmi.IErrorDetails;

Updates the settings of a symbol in the server's Historize configuration.

Parameter

Name

Type

Description

SymbolName

string,

The name of the symbol.

settings

TcHmi.Server.Historize.IEntrySettings

The settings of the recording.

options

TcHmi.Server.Historize.ISetting, null

Options

requestOptions

TcHmi.Server.IRequestOptions, null

Server request options

callback [ optional ]

null | (data: TcHmi.IResultObject) => void

Asynchronous callback function that is triggered once the action is completed.

Return value

Type

Description

TcHmi.IErrorDetails

Returns confirmation as to whether the operation was successfully sent.

updateEx2 1:

Available from version 1.10.670.0

Sample - JavaScript

var settings = {
    RECORDINGENABLED: false,
};
TcHmi.Server.Historize.updateEx2('PLC1.MAIN.nInt2', settings, {}, {timeout: 2000}, function (data) {
    if (data.error === TcHmi.Errors.NONE) {
        // Success
    } else {
        // Error
    }
});