removeUser

[ Funktion ]

public static removeUser(
    userName: string,
    callback: null | ((this: void, data: TcHmi.IResultObject) => void) = null
): TcHmi.IErrorDetails;

Löscht einen Benutzer.

Parameter

Name

Typ

Beschreibung

userName

string

Name des Benutzers

callback [ Optional ]

(data: TcHmi.IResultObject) => void, null

Asynchrone Callback Funktion, die ausgelöst wird, wenn die Aktion abgeschlossen wurde.

Rückgabewert

Typ

Beschreibung

TcHmi.IErrorDetails

Liefert eine Rückmeldung, ob die Operation erfolgreich abgeschickt worden konnte.

removeUser 1:

Verfügbar ab Version 1.10.1018.48

Beispiel - JavaScript

TcHmi.Server.UserManagement.removeUser (
    'newUser',
    function(data) {
        if (data.error === TcHmi.Errors.NONE) {
            // Success
        } else {
            // Error
        }
    }
);