ForceLogoutEx

function ForceLogoutEx(ctx: TcHmi.SelectableRequired<TcHmi.Context, 'success' | 'error'>, username: string | null | undefined)

Die Funktion ForceLogoutEx loggt einen bestimmten Benutzer oder alle Benutzer auf allen Client Instanzen, die mit dem Server verbunden sind, aus. Die Funktion ForceLogoutEx stellt einen Kontext Parameter vom Typ TcHmi.Context zur Verfügung, der es dem Framework erlaubt bei der Ausführung innerhalb von Triggern oder Funktionsausdrücken auf die asynchrone Signalisierung des Endes der Aktion zu warten.

Siehe dazu auch die Beschreibungsseite der korrespondierenden API-Funktion.

Parameter

Name

Typ

Beschreibung

ctx

TcHmi.SelectableRequired<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.

username [ Optional ]

string | null | undefined

Der Benutzername, welcher auf allen Client-Instanzen, die mit dem Server verbunden sind, ausgeloggt werden soll.

Wenn der Parameter nicht angegeben wird, werden alle Benutzer ausgeloggt.

 

Rückgabewert

Typ

Beschreibung

void

Kein Rückgabewert.

NuGet Paket: Beckhoff.TwinCAT.HMI.Functions

ForceLogoutEx 1:

NuGet-Pakete sind verfügbar ab Version 1.12.

ForceLogoutEx 2:

Verfügbar ab Version 1.12