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

MsgClose

Closes a message. After the message is closed, the message post function (the callback function specified in the MsgOpen() function) is not called if a message is received. When the server side is closed, all clients are closed. When the client side is closed, only the specified client is closed.

Syntax

MsgClose(Name, hMsg)

Name:

The name of the CitectSCADA server.

hMsg:

The message handle, returned from the MsgOpen() function. The message handle identifies the table where all data on the associated message is stored.

Return Value

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

Related Functions

MsgOpen, MsgRead, MsgWrite, MsgRPC

Example

MsgClose("Alarm",hMsg);

See Also

Task Functions