"For developers", "Server scripts", "Functions description", "Dialogues",  "mGetUserTotalUnreadPrivateMessagesCount".

 

Get the total number of unread private messages of the specified user in all dialogues.

 

Syntax

function mGetUserTotalUnreadPrivateMessagesCount(const iUINOwner: integer): integer;

 

Parameters and return values

Parametrr

Type

Value

iUINOwner

integer

numeric ID of a registered user on a server (UIN).

 

Function resulr

-1, no such a user on a serverесли ;

0, no unread messages;

>0, if there are unread messages, the function returns their total number.
 

Example

Get the number of unread private messages from all people for a user with UIN = 6.

var
  iCount: integer;
begin
  iCount := mGetUserTotalUnreadPrivateMessagesCount(6);
  mLogScript(IntToStr(iCount), 'uin 6');
end.

Script work result

[16:31:15] (Log "CountUnreadPrivateMessages"): [uin 6] 7

[16:31:15] (Run "CountUnreadPrivateMessages"): Script operation time: 5 ms

[16:31:15] (Run "CountUnreadPrivateMessages"): Script done successfully.