getEx

[ Function ]

public static getEx(
    symbolName: string, 
    requestOptions: TcHmi.Server.IRequestOptions | null,
    callback?: null | ((this: void, data: TcHmi.Server.Historize.IEntryResultObject) => void)
): TcHmi.IErrorDetails;

Returns the settings for a symbol from the server's Historize configuration.

Parameter

Name	Type	Description
SymbolName	string,	The name of the symbol to be recorded.
requestOptions	TcHmi.Server.IRequestOptions, null	Server request options
callback [ optional ]	null \| (data: TcHmi.Server.Historize.IEntryResultObject) => 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

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