read

[ Funktion ]

Version 1.8

public static read(name: string, type: TcHmi.SymbolType): any;

Version 1.12

public static read<T = any>(name: string, type: TcHmi.SymbolType): T;

Liest den Wert eines Symbols adressiert über den Namen und Symboltyp.

read 1:

Ab Version 1.10 werden Symbol-Abfragen direkt gegen die Komponente ausgeführt, welche die Daten zur Verfügung stellt. Da eine synchrone Abfrage von Symbolen aus dem Server nicht möglich ist, verwenden Sie zum Abfragen von Server-Symbolen bitte die Funktion readEx2.

read 2:

Version 1.12: Wird die API in TypeScript-Code benutzt, so kann dem TypeScript-Compiler mitgeteilt werden, welchen Typ der Symbolwert hat.

read 3:

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

Name

Typ

Beschreibung

name

string

Name des Symbols

type

TcHmi.SymbolType

Typ des Symbols

Rückgabewert

Typ

Beschreibung

Version 1.8

any

Version 1.12

T

Aktueller Wert des Symbols, kann beliebigen Typ haben.

read 4:

Verfügbar ab Version 1.8

Beispiel - JavaScript

var symVal = TcHmi.Symbol.read('myInternalSym', TcHmi.SymbolType.Internal);

Beispiel 1 - TypeScript


var symVal = TcHmi.Symbol.read('myInternalSym', TcHmi.SymbolType.Internal); // TS does not know the variable type

Beispiel 2 - TypeScript


let thisIsABoolean = TcHmi.Symbol.read<boolean>('myInternalSym', TcHmi.SymbolType.Internal); // TS knows this is a boolean