update

[ Function ]

public static update(
    symbolName: string, 
    settings: TcHmi.Server.Historize.IEntrySettings,
    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.
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.

	Available from version 1.10

Sample - JavaScript

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