LoginEx
function LoginEx(ctx: Required<TcHmi.Context>, username: string | null, password: string | null, persistent: boolean = true, reload: boolean = true)
Die Funktion LoginEx loggt einen Benutzer auf dem Server ein. Die Funktion LoginEx 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 | 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 | Benutzername | |
password | Benutzerpasswort | |
persistent [ Optional ] | Definiert ob der Login persistiert werden soll. Standardwert ist true. | |
reload [ Optional ] Verfügbar ab Version 1.12 | Definiert ob ein Reload nach dem Logout stattfinden soll. Standardwert ist true. |
Rückgabewert
Typ | Beschreibung |
---|---|
void | Kein Rückgabewert. |
NuGet Paket: Beckhoff.TwinCAT.HMI.Functions
NuGet-Pakete sind verfügbar ab Version 1.12. |
Verfügbar ab Version 1.12 |