logoutEx2

[ Function ]

public static logoutEx2(
    reload = true,
    requestOptions: Server.IRequestOptions,
    callback: null | (data: TcHmi.IResultObject) => void
): boolean;

Logs out the current user. If this is successful, the client is optionally reloaded.

Parameter

Name	Type	Description
reload	boolean	Specifies whether the client should be restarted.
requestOptions	Server.IRequestOptions	Options
callback [ optional ]	TcHmi.IResultObject	Asynchronous callback function that is triggered when the operation was terminated.

Return value

Type	Description
boolean	Returns confirmation as to whether the operation was successfully sent.

	Available from version 1.12

Sample - JavaScript

TcHmi.Server.logoutEx2(false, { timeout: 2000 }, function(data) {
    if (data.error === TcHmi.Errors.NONE) {
        // Success
    } else {
        // Error
    }
});