TagSendMessageTo Function

Introduction

Sends a message to a recipient using the SendMessageTo Tag Command.

Functions and Function Blocks

The TagSendMessageTo Function is intended for use in an Operator Action. Operator Actions run in response to user input gestures in the Operator Interface. In an Operator Action, code execution is suspended until the function completes.

If you want to send a message from a Program Tag, running on the SCADA Server, use the TagSendMessageToFB Function Block.

Syntax

Informal Syntax:

TagSendMessageTo( TagName, Recipient, Subject, Message )

Formal Syntax:

TagSendMessageTo( 
        TagName:=Expression,
        Recipient:=Expression,
        Subject:=Expression,
        Message:=Expression )

Parameters

Parameter	Type	Description
TagName	ANY_STRING	The full name of the SMTP Connector Tag.
Recipient	ANY_STRING	The email address of the user to send the message to.
Subject	ANY_STRING	The subject line of the message.
Message	ANY_STRING	The message to send. Note: In Fernhill SCADA, IEC 61131-3 Strings are limited to a maximum of 65535 characters. For this reason, the maximum length of message you can send using this function is limited to 65535 characters.

The TagSendMessageTo Function sends the SendMessageTo Tag Command to the database tag.

Return Value

None.

Further Information

SendMessageTo Tag Command

To learn about the SendMessageTo Tag Command.

TagSendMessageToFB Function Block

To learn how to send a message to a user from a Program Tag.

Operator Actions

To learn where you can use this function.

Structured Text Function Call

To learn about calling a function from IEC 61131-3 structured text.

IEC 61131-3 Expressions

To learn about the different types of expression to use as function parameters.

Glossary

For the meaning of terms used in Fernhill SCADA.