readEx

[ Funktion ]

Version 1.10

public readEx(
    callback?: (data: Symbol.IReadResultObject | Symbol.IServerReadResultObject) => void
): void;

Version 1.12

public readEx<T = ST>(
    callback?: (data: Symbol.IReadResultObject<T> | Symbol.IServerReadResultObject<T>) => void
): DestroyFunction;

Liest den Wert des Symbols.

Der Aufruf der Callback Funktion erfolgt in Abhängigkeit des verwendeten Symbol Typs entweder synchron oder asynchron.

Version 1.12: Wird die API in TypeScript-Code benutzt, so kann beim Erstellen eines Symbols dem TypeScript-Compiler mitgeteilt, welchen Typ das Symbol (ST: SymbolType) hat. Dieser muss dann beispielsweise bei Nutzung dieser Funktion nicht mehr angegeben werden. Dies kann jedoch auch hier überschrieben werden.

Dies ist eine reine Hilfe für die Programmierung. Der Browser kennt diese „Typeannotation“ nicht. Es findet keine Prüfung oder Konvertierung zur Laufzeit statt.

Parameter

Rückgabewert

Verfügbar ab Version 1.10

Beispiel - JavaScript

var symbol = new TcHmi.Symbol('%s%PLC1.MAIN.sTest%/s%');
symbol.readEx(function (data) {
    if (data.error === TcHmi.Errors.NONE) {
        // Handle result value... 
        var value = data.value; 
        console.log(value); 
    } else {
        // Handle error... 
    }
});

Beispiel 1 - TypeScript

var symbol = new TcHmi.Symbol('%s%PLC1.MAIN.sTest%/s%');
symbol.readEx(function (data) {
    if (data.error === TcHmi.Errors.NONE) {
        // Handle result value... 
        var value = data.value; // TS does not know the variable type
        console.log(value); 
    } else {
        // Handle error... 
    }
});

Beispiel 2 - TypeScript

var symbol = new TcHmi.Symbol<string>('%s%PLC1.MAIN.sTest%/s%');
symbol.readEx(function (data) {
    if (data.error === TcHmi.Errors.NONE) {
        // Handle result value... 
        let thisIsAString = data.value; // TS knows this is a string
        console.log(thisIsAString); 
    } else {
        // Handle error... 
    }
});

Beispiel 3 - TypeScript

var symbol = new TcHmi.Symbol ('%s%PLC1.MAIN.sTest%/s%');
symbol.readEx<string> (function (data) {
    if (data.error === TcHmi.Errors.NONE) {
        // Handle result value... 
        let thisIsAString = data.value; // TS knows this is a string
        console.log(thisIsAString); 
    } else {
        // Handle error... 
    }
});