MsgBrdcst

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

MsgBrdcst

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

Syntax

MsgBrdcst(Name, Type, Str)

Name:

The name of the CitectSCADA server.

Type:

The message number.

Str:

The message text.

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");