MyChat Scripts: функция mSendCustomMsgToClientConsoleByCID, отправка custom-сообщения клиенту
"Для разработчиков", "Серверные скрипты", "Описание функций", "Сообщения", "mSendCustomMsgToClientConsoleByCID".
Функция для отправки специального сообщения в консоль MyChat Client.
Синтаксис
function mSendCustomMsgToClientConsoleByCID(iCID: integer; sMsg, sSound: string; bFocus, bSaveToLog: boolean; iType: integer): integer;
Параметры и возвращаемые значения
Параметр |
Тип |
Значение |
iCID |
integer |
уникальный идентификатор подключения клиента в онлайн-структуре сервера; |
sMsg |
string |
текст сообщения. Можно использовать переносы строк (CRLF); |
sSound |
string |
тип звукового уведомления, которое можно указать. Если будет задана пустая строка — никакого звука на клиенте не будет. Если в настройках клиентской программы отключены все звуки, то звукового уведомления также не будет. Список возможных звуков указан в справочнике звуков MyChat Client; |
bFocus |
boolean |
принудительно переключить программу клиента на консоль для показа сообщения; |
bSaveToLog |
boolean |
сохранять сообщение в протоколе клиента на диск, а не только отображать его в консоли; |
iType |
integer |
тип сообщения, один из вариантов. |
Результат функции
Число 0, если отправка произошла успешно, -1 — если CID не существует или произошла сетевая ошибка.