18.01.2015 Views

Technical Reference Manual - InduSoft

Technical Reference Manual - InduSoft

Technical Reference Manual - InduSoft

SHOW MORE
SHOW LESS

Create successful ePaper yourself

Turn your PDF publications into a flip-book with our unique Google optimized e-Paper software.

Appendix: Built-in Scripting Language<br />

Value<br />

Description<br />

0 Specified user does not exist.<br />

1 Success; specified user exists.<br />

Examples<br />

Get the full name of the currently logged user (via the system tag UserName):<br />

GetUserFullName( UserName, "UserFullName" )<br />

Get the full name of the user "engineer1":<br />

GetUserFullName( "engineer1", "UserFullName" )<br />

GetUserNames<br />

Function Group Execution Windows Embedded Thin Client<br />

GetUserNames Security Synchronous Supported Supported Executed on Server<br />

Syntax<br />

GetUserNames( "tagUsers", optNumUserType, "opttagGroups" )<br />

tagUsers<br />

Name of the array tag that will receive users.<br />

optNumUserType<br />

0 Return all users<br />

1 Only users created during runtime<br />

2 Only users created using the development environment<br />

opttagGroups<br />

Name of the array tag that will receive the group for each specific user.<br />

Returned value<br />

The number of users, or a negative number that can be one of the following:<br />

−1<br />

−2<br />

−3<br />

−4<br />

−5<br />

Invalid number of parameters<br />

tagUsers is invalid<br />

optNumUserType is invalid<br />

opttagGroups is invalid<br />

Error, function cannot be called in the Thin Client<br />

Examples<br />

Tag Name<br />

NumberOfUsers<br />

Expression<br />

GetUserNames("UsersArray") // Retrieves all users, stores names in the UsersArray tag and the<br />

number of users in the NumberOfUsers tag.<br />

Page 590<br />

<strong>InduSoft</strong> Web Studio

Hooray! Your file is uploaded and ready to be published.

Saved successfully!

Ooh no, something went wrong!