You're currently browsing the Ignition 8.0 docs. Click here to view the latest docs.

The following feature is new in Ignition version 8.0.8
Click here to check out the other new features
This function is used in Python Scripting.

Description

Removes one or more users from an existing roster. 

Syntax

system.roster.removeUsers(rosterName, [users])

  • Parameters

String rosterName- The name of the roster to modify.

List users - A list of user objects that will be removed from the the roster. User objects can be created with the system.user.getUser and system.user.addUser functions.

  • Returns

none  

  • Scope

Gateway, Perspective Session

Code Examples
Code Snippet
userSource = "default"
rosterName = "rosterEast"
	
# getUser() returns a user object, which is needed for removeUser()	
user = system.user.getUser(userSource, "joe")
	
system.roster.removeUsers(rosterName, [user])
Keywords

system roster removeUsers, roster.removeUsers

  • No labels