Technical Reference Manual - InduSoft

Appendix: Built-in Scripting Language
Value Security Mode is Distributed–Client Security Mode is Domain (LDAP)
5 N/A No users or groups returned by query
6 N/A Invalid user or group
Notes
This function returns the same value that is sent to the project tag configured in the Status Tag box, in the
security system server settings. However, this function returns the value immediately, while the project tag
configured in the Status Tag box is only updated periodically (according to Synchonization Period for Distributed–
Client or Retry Interval for Domain (LDAP)). As such, there may be times when this function's returned value and
the value of the project tag do not match.
Also, there are other actions besides calling this function that update the status:
• When a user logs on to the project. Specifically, if the user logs on via the built-in LogOn dialog (invoked by
either calling the LogOn function or selecting the LogOn menu command in the Viewer), then the status is
updated before the dialog is displayed.
• When the authentication server is offline and the retry interval (configured in the security system server
settings) has elapsed.
• When the security system settings are opened in the development application.
Whenever the status is updated, the new value is immediately sent to the project tag configured in the Status
Tag box.
Examples
Get the status of the security system:
GetSecuritySystemStatus()
Force the security system to reload all users and groups from the authentication server:
GetSecuritySystemStatus( 1 )
GetUserFullName
This function gets the full name (if any) of a specified user in the project security system.
Function Group Execution Windows Embedded Thin Client
GetUserFullNameSecurity Synchronous Supported Supported Supported
Syntax
GetUserFullName(strUserName,"tagUserFullName")
strUserName
The name of a user in the project security system.
tagUserFullName
The name of a tag (String type) that will receive the full name of the specified user. If the
specified user does not have a full name defined, then the tag will receive an empty string ("").
Note: The tag name must be enclosed in quotes, as shown in the syntax
diagram, or else the project will try to get the value of the named tag.
Returned value
This function returns the following possible values:
InduSoft Web Studio Page 589