Cicode Programming Reference > Cicode Function Categories > Task Functions > MsgBrdcst

MsgBrdcst

Broadcasts a message to all the clients of a server. You should call this function only on a Citect SCADA server. The message is only received by clients that have a current message session (opened with the MsgOpen() function).

Syntax

MsgBrdcst(Name, Type, Str [, sClusterName])

sName:

The name of the Citect SCADA server.

nType:

The message number.

Str:

The message text.

sClusterName:

The name of the cluster to which the server being communicated with belongs. This is optional if you have one cluster.

Return Value

0 (zero) if successful, otherwise an error is returned.

Related Functions

MsgOpen, MsgClose, MsgRead, MsgWrite, MsgRPC

Example

! Send a message to all alarm clients.
MsgBrdcst("Alarm",0,"Alarm Occurred");

See Also

Task Functions

Published June 2018