Equinox Online Help - Language Reference - A to Z

Home

UserDelete

Applies to
SyntaxUserDelete UserName [,DeleteIndexInstances]
Action[Statement] Deletes an Equinox application user.
ScopeUsable anywhere.
Notes

This statement deletes an Equinox application user.

If the user does not exist or is not deletable, SysError is set to a nonzero value. Otherwise the user is deleted and SysError is set to zero. The logged in user must have the User Management permission set in User Settings.

UserDelete has an additional optional parameter DeleteIndexInstances which defaults to false and if true deletes any index instances associated with the user.

CategoryUser, groups and ESS
See Also ChangePassword, FirstUserGroup, FirstUserName, UserCreate, NextUserGroup, NextUserName, SetUserGroup, UserAccountExpiry, UserDetails, UserGroup, UserName, UserPasswordExpiry, UserPermission
Example
UserDelete “JS”
if SysError then print “User JS not deleted!”