GetUserList

Returns information configured in the User List dialog. For more information, see User Access Settings Dialog.

GetUserList Inputs

Syntax: EV GetUserList()

GetUserList Outputs

Returns a status code, followed by the number of characters (in bytes) for the results, then the results in XML format. The status codes are:

Status Codes Description
1 The command was executed successfully.
0 Unrecognized command.
-2 The command could not be executed.
-6 User does not have Full Access to execute the command. For more information, see User Access Settings Dialog.

GetUserList Results

Parameters Description
Name Returns the user name.

Access

 

Returns the access level of the user.

  • 0 = Full
  • 1 = Protected
  • 2 = Locked
View

Returns whether or not the Custom View is displayed when the user logs on.

  • 0 = Custom
  • 1 = Normal (the Spreadsheet View or EasyBuilder View is displayed).

Read

 

Returns whether or not the user has FTP Read privilege.

  • 0 = No
  • 1 = Yes

Write

 

Returns whether or not the user has FTP Write privilege.

  • 0 = No
  • 1 = Yes
SaveJobOnline

Returns whether or not the user is allowed to save jobs while Online.

  • 0 = Disabled
  • 1 = Enabled

GetUserList Example

To retrieve information configured in the User List dialog, issue the following command: EV GetUserList()

Note: Count, in the first XML tag, represents the number of users in the User List.

The In-Sight sensor responds with a status code (1), followed by the number of characters, in bytes (568). Finally, the information configured in the User List dialog is returned.