Removes a user from the system.
|
Function |
Group |
Execution |
Windows |
Embedded |
Thin Client |
| RemoveUser
|
Security |
Synchronous |
Supported |
Supported |
Supported |
Syntax
RemoveUser( strUserName )
- strUserName
- The name of the user to be removed.
Returned value
This function returns the following possible values:
|
Value |
Description |
| 0
|
User removed
successfully. |
| 1
|
Invalid
number of parameters. |
| 2
|
Wrong
parameter type. |
| 3
|
User
currently logged on does not have the rights to remove (i.e., user
does not have Edit Security
System). |
| 4
|
User cannot
be removed. |
| 5
|
Specified
user does not exist. |
| 6
|
Component-level failure. |
| 7
|
Failed to
save to configuration file. |
| 8
|
The current
Security Mode does not allow user to be removed. |
Examples
|
Tag Name |
Expression |
|
Tag |
RemoveUser( "Bob" )
|
|
Tag |
RemoveUser( "Albert" )
|
Note: You can
use this function to remove only those users you created using the
CreateUser( ) function.