GetSecuritySystemStatus
- Last UpdatedOct 29, 2026
- 2 minute read
This function gets the status of the security system and its connection to the authentication server, when the security mode is either Distributed–Client or Local Plus Domain (LDAP).
|
Function |
Group |
Execution |
String Exp. |
Windows |
Windows Embedded |
IoT View |
Thin Clients |
Mobile Access |
|---|---|---|---|---|---|---|---|---|
|
GetSecuritySystemStatus |
Security |
Synchronous |
Yes |
Supported |
Supported |
Not supported |
Supported |
Not supported |
Syntax
GetSecuritySystemStatus(optNumType)
optNumType
The type of action to take to update the status.
|
Value |
Description |
|---|---|
|
0 |
Perform a fast check using either Ping or Bind (depending on the server settings), but take no other actions. |
|
1 |
Force reload of users and groups from the authentication server. |
|
2 |
Clear cached users and groups. |
This is an optional parameter; if no value is specified, then the default is 0.
Return value
This function returns one of the following values, depending on the security mode:
Security Mode is Distributed–Client
|
Value |
Description |
|---|---|
|
0 |
No cache |
|
1 |
Updated cache |
|
2 |
Outdated local cache |
|
3 |
Outdated server cache |
|
4 |
Disconnected from server |
Security Mode is Local Plus Domain (LDAP)
|
Value |
Description |
|---|---|
|
0 |
Connection timeout |
|
1 |
Bind timeout |
|
2 |
Query timeout |
|
3 |
Disconnected |
|
4 |
Connected |
|
5 |
No users or groups returned by query |
|
6 |
Invalid user or group |
|
7 |
Data corrupted |
|
8 |
Auto import disabled |
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 Synchronization Period for Distributed–Client or Retry Interval for Local Plus 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)