"For developers", "Server scripts", "Functions description", "Messages", mSendCustomMsgToClientConsoleByCID.

 

Sending a special message to MyChat Client console.

 

Syntax

function mSendCustomMsgToClientConsoleByCID(iCID: integer; sMsg, sSound: string; bFocus, bSaveToLog: boolean; iType: integer): integer;

 

Parametrs and return values

Parameter

Type

Value

iCID

integer

unique identifier of client connection in server online structure;

sMsg

string

message text. You can use line breaks (CRLF);

sSound

string

type of sound message (can be specified). If you specify an empty string, then there will be no sound in MyChat Client. If all sounds are disabled in client settings, there will be no sound notification too. You can find a list of available sounds in the list of MyChat Client sounds;

bFocus

boolean

forcibly switch a client program to console for showing the message;

bSaveToLog

boolean

save the message to client protocol on a disk (not only show it in the console);

iType

integer

message type, one of the variants.

 

Function result

0 — message successfully submitted; -1 — CID does not exist or the network error occurred.