listUsernamesEx

[ Function ]

public static listUsernamesEx(
    options?: TcHmi.Server.UserManagement.IUserManagementOptions | null,
    requestOptions: TcHmi.Server.IRequestOptions | null = null,
    callback: null | ((this: void, data: TcHmi.Server.UserManagement.IUsernameListResultObject) => void) = null
): TcHmi.IErrorDetails;

Supplies a list of all existing system users.

Parameter

Name

Type

Description

options

TcHmi.Server.UserManagement.IUserManagementOptions, null

User management options

requestOptions

TcHmi.Server.IRequestOptions, null

Server request options

callback [ optional ]

(data: TcHmi.Server.UserManagement.IUsernameListResultObject) => void, null

Asynchronous callback function that is triggered once the action is completed.

Return value

Type

Description

TcHmi.IErrorDetails

Returns confirmation as to whether the operation was successfully sent.

listUsernamesEx 1:

Available from version 1.10.1018.48

Sample - JavaScript

TcHmi.Server.UserManagement.listUsernamesEx(
    null,
    {timeout: 2000},
    function(data) {
        if (data.error === TcHmi.Errors.NONE) {
            console.log(data.userList); // ["__SystemAdministrator", "__SystemGuest"]
        } else {
            // Error
        }
    }
);