Difference between revisions of "Group removeUser"

From Catglobe Wiki
Jump to: navigation, search
 
Line 21: Line 21:
 
'''Example'''
 
'''Example'''
  
''Group_removeUser(12345, 335689);''
+
''number userResourceId = 12345;''
 +
 
 +
''number groupResourceId = 335689;''
 +
 
 +
''Group_removeUser(12345, 335689);'' // User whose resource id is 12345 is removed from the group whose resource id is 335689
  
 
'''Availability'''
 
'''Availability'''

Latest revision as of 06:30, 27 December 2011


Group_removeUser

Remove a user from a group

Syntax

Group_removeUser(userResourceId, groupResourceId)

Arguments

  • userResourceId: is a number expression. It is the user's resource id
  • groupResourceId: is a number expression. It is the group's resource id

Return value

A bool value. It will return false when the user does not belong to the group, true otherwise

Example

number userResourceId = 12345;

number groupResourceId = 335689;

Group_removeUser(12345, 335689); // User whose resource id is 12345 is removed from the group whose resource id is 335689

Availability

Version 5.6