Admin: 1 revision imported

2023-04-25T09:29:29Z

1 revision imported

1>Admin at 18:14, 15 April 2023

2023-04-15T18:14:23Z

New page

{{infobox function
|name=BroadcastGlobalMessage
|object=[[Функции общего назначения]]
|caption=Доставка сообщений
|type=1
|status=1
|db=0
|exception=Невозможно превратить в число, строку, неверный аргумент
|visual=1}}
{{HeadLinks|
* [[Main_Page|Начальная страница]]
* [[Общее_описание_языка|Общее описание]]
* [[Объекты]]
* [[Функции общего назначения]]}}
Функция рассылает пакеты, которые вызывают исполнения событий ''OnMessage'' для всех открытых форм (в момент когда они активны или когда они станут активными), в текущей системе или глобально всем клиентам сервера. В последнем случае, нужно быть осторожным, чтобы не перегружать сервер внезапным большим количеством запросов, даже с учетом того, что серверная часть использует особую систему замедления отправки запросов клиентам. Для форм будет вызвано [[Студия/Визуальные события|прерывающее]] визуальное событие [[Студия/OnMessage|OnMessage]]. Функция возвращается сразу после успешной отправки сообщения или ошибке при отправке. Если функция выполнена успешно, доставка сообщения будет гарантирована, если форма не будет закрыта до того, как ее удастся осуществить.

== Синтаксис ==
<code>
'''BroadcastGlobalMessage'''(''<Код сообщения (INT)>'',''<Содержимое сообщения (STRING)>''{{Optional|,<Для всех пользователей (INT)>{{Default|{{Eq}}0}}}}):''<Сообщение успешно отправлено (INT)>''
</code>
==== Аргументы ====
* <code>''<Код сообщения (INT)>''</code> - Произвольный код сообщения, коды 1-10000 рекомендуется использовать для нужд проекта, остальные для нужд внешних обработок.
* <code>''<Содержимое сообщения (STRING)>''</code> - {{Optional}} Текстовый параметр, котрый будет получен обработчиком события ''OnMessage'' в виде переменной '''Param'''. Переменная '''Option''' при этом будет всегда пустой.
* <code>''<Для всех пользователей (INT)>''</code> - {{Optional}} Режим отправки сообщения, может принимать значения:
** '''0''' (по умолчанию) -- отправка сообщения только для форм текущего клиента.
** '''1''' -- отправка сообщения всем формам всем пользователям сервера. Сообщения такого рода отправляются каждому клиенту по очереди с небольшим периодом ожидания, чтобы исключить внезапную загрузку сервера.

==== Возвращаемое значение ====
Возвращает 0 если сообщение не было доставлено (ошибка сервера и пр.), в ином случае возвращает 1.

== Примеры ==
<pre>
//Отослать всем формам всех клиентов сообщение с кодом 15000 и параметром "Сообщение".
BroadcastGlobalMessage(15000,"Сообщение",1);
</pre>

← Older revision	Revision as of 09:29, 25 April 2023
(No difference)

BroadcastGlobalMessage - Revision history

Admin: 1 revision imported

1>Admin at 18:14, 15 April 2023