vtk_usergroup

vtk_usergroup_add

Usage:         
vtk_usergroup_add userGroupName userList

Description:   
Adds the specified users to the specified user group. If the user group with than name does not exist, it is created. 

Example: 
Adds users 'andy' and 'barney' to the user group called 'designers'. 

vtk_usergroup_add designers andy barney


vtk_usergroup_contains

Usage:         
vtk_usergroup_contains userGroupName userName

Description:   
Returns 1 or 0 if the user group contains the user. 

Example: 
vtk_usergroup_populate designers joe bob sally ralph 
set isContained [vtk_usergroup_contains designers joe];  # Returns 1. 
set isContained [vtk_usergorup_contains designers cathy]; # Returns 0.


vtk_usergroup_delete

Usage:         
vtk_usergroup_delete userGroupName

Description:   
Deletes the named user group. 

Example: 
vkt_usergroup_delete designers

vtk_usergroup_get

Usage:         
vtk_usergroup_get userGroupName array

Description:   
Returns information about the specified user group. 

Example:
vtk_usergroup_populate designers joe bob sally ralph
vtk_usergroup_get designers array
parray array
array(usergroup) = designers
array(count)     = 4
array(id)        = 000047193
array(0,user)    = joe
array(1,user)    = bob
array(2,user)    = sally
array(3,user)    = ralph


vtk_usergroup_getgroups

Usage:         
vtk_usergroup_getgroups array

Description:   
Returns the list of all user groups. 

Example:
vtk_usergroup_populate designers joe bob sally ralph
vtk_usergroup_populate coders brian swami
vtk_usergroup_getgroups array
parray array
array(count)  = 2
array(0,usergroup) = designers
array(1,usergorup) = coders


vtk_usergroup_populate

Usage:         
vtk_usergroup_populate userGroupName userList

Description:   
Populates a new user group with the list of users provided. If a user group with that name already exists, the specified set of users overwrites any existing users in the user group. 

Example: 
vtk_usergroup_populate designers joe bob sally ralph

vtk_usergroup_remove

Usage:         
vtk_usergroup_remove userGroupName userList

Description:   
Removes specified users from user group. 

Example: 
Removes user 'ralph' from the user group named 'designers'. 

vtk_usergroup_remove designers ralph