MyChat Scripts Engine: mRemoveUserFromGroup, delete a user from a group
Remove a specified user from a group.
Syntax
function mRemoveUserFromGroup(iUIN: integer; sGroupName: string): integer;
Parameters and return values
|
Parameter |
Type |
Value |
|
iUIN |
integer |
user numeric ID; |
|
sGroupName |
string |
users group name. The letter case is important. |
Function result
|
0 |
all ok; |
|
-1 |
such user does not exist; |
|
-2 |
group with such name does not exist; |
|
-3 |
user does not exist in this group. |
Example
const
USER = 6;
GROUP_NAME = 'Test Group';
var
x: integer;
s: string;
begin
mCreateUsersGroup(GROUP_NAME);
x := mRemoveUserFromGroup(USER, GROUP_NAME);
case x of
0: s := 'all ok';
-1: s := 'user doesn''t exist';
-2: s := 'group doesn''t exist';
-3: s := 'user is not in the group';
end;
mLogScript(s, '');
end.
Script work result
[19:07:38] (Log "mRemoveUserFromGroup"): everything is OK
[19:07:38] (Run "mRemoveUserFromGroup"): Script operation time: 13 ms
[19:07:38] (Run "mRemoveUserFromGroup"): Script done successfully.