GetElementByIndex

Version 1.8

function GetElementByIndex<T>(array: T[] | string | null, arrayIndex: number | null): T | any

Version 1.10

function GetElementByIndex(ctx: Required<TcHmi.Context>, arraySymbol: TcHmi.Symbol | null, arrayIndex: number | null): void

Die Funktion GetElementByIndex liefert den Wert eines bestimmten Array-Indexes von einem Binding zurück.

Parameter

Name	Typ	Beschreibung
ctx Verfügbar ab Version 1.10	Required<TcHmi.Context>	Kontext Objekt Muss bei der Verwendung in einem Trigger oder einem Funktionsausdruck nicht vom Anwender angegeben werden. Die Übergabe und die Auswertung erfolgt in diesem Fall über den entsprechenden Parser. Wird vom Aufrufer verwendet, um dem Framework bei der Ausführung Erfolg oder Fehlschlag zu signalisieren. Bei direkter Verwendung der Funktion in JavaScript/TypeScript muss das Kontext-Objekt beim Aufruf übergeben und ggf. ausgewertet werden.
arraySymbol	Version 1.8 T[] \| string \| null Version 1.10 Symbol	Ein Binding auf das Symbol des Arrays.
index	number \| null	Der Index des Arrays, für welchen der Wert zurückgegeben werden soll.

Name

Typ

Beschreibung

ctx

Verfügbar ab Version 1.10

Required<TcHmi.Context>

Kontext Objekt

Muss bei der Verwendung in einem Trigger oder einem Funktionsausdruck nicht vom Anwender angegeben werden. Die Übergabe und die Auswertung erfolgt in diesem Fall über den entsprechenden Parser.

Wird vom Aufrufer verwendet, um dem Framework bei der Ausführung Erfolg oder Fehlschlag zu signalisieren.

Bei direkter Verwendung der Funktion in JavaScript/TypeScript muss das Kontext-Objekt beim Aufruf übergeben und ggf. ausgewertet werden.

arraySymbol

Version 1.8

T[] | string | null

Version 1.10

Symbol

Ein Binding auf das Symbol des Arrays.

index

number | null

Der Index des Arrays, für welchen der Wert zurückgegeben werden soll.

Rückgabewert

Typ	Beschreibung
Version 1.8 any Version 1.10 void	Version 1.8 Der Wert, der an der Stelle des Indexes in dem Array gespeichert ist. Version 1.10 Kein Rückgabewert. Das Ergebnis oder Fehlerinformationen werden über entsprechende Callback-Funktionen im Kontext Objekt kommuniziert.

Typ

Beschreibung

Version 1.8

any

Version 1.10

void

Version 1.8

Der Wert, der an der Stelle des Indexes in dem Array gespeichert ist.

Version 1.10

Kein Rückgabewert.

Das Ergebnis oder Fehlerinformationen werden über entsprechende Callback-Funktionen im Kontext Objekt kommuniziert.

NuGet Paket: Beckhoff.TwinCAT.HMI.Functions

	NuGet-Pakete sind verfügbar ab Version 1.12.

	Verfügbar ab Version 1.8