Clear a personal contact list of a specified user.

 

Syntax

function mPersonalContactsClear(iUINOwner: integer): integer;

 

Parameters and return values

Parameter

Type

Value

iUINOwner

integer

user unique ID, >0;

 

Function result

0

user's personal contact list is cleared successfully;

-1

user's contact list is empty;

-2

user is not registered on the server;

-3

you can't use UIN = 0;

 

Example


const
  UIN_OWNER  = 6;
var
  iResult: integer;
  sMsg: string;
begin
  iResult := mPersonalContactsClear(UIN_OWNER);
   
    case iResult of
       0: begin
         sMsg := 'all ok';
         mPersonalContactsRefresh(UIN_OWNER);
       end;  
      -1: sMsg := 'personal contact list is empty';
      -2: sMsg := 'owner uin does not exist';
      -3: sMsg := 'you can''t use UIN = 0';
     end;
        
  mLogScript(sMsg, '');  
end.


Script work result

[18:37:46] (Log "mPersonalContactsClear"): personal contact list is empty

[18:37:46] (Run "mPersonalContactsClear"): Script operation time: 7 ms

[18:37:46] (Run "mPersonalContactsClear"): Script done successfully.

 

See also

mPersonalContactsRefresh

mLogScript