WWField Script Function Library

Posted on 335 views

The WWField script functions can write directly to InTouch’s tagname dictionary file. Click the appropriate link below to download the WWField script function library:

Note: When a WWField script function executes, it will not generate any type of data change event. However, once a tagname field is accessed, it will be displayed with its new value. For instance, if a tagname’s Comment field has been changed and it is included in an Alarm window, any new alarms will display the new Comment field.

Click below to view the description for each script function and its use:

  • SetCommentField()
  • SetDiscOnMsg()
  • SetDiscOffMsg()
  • GetEUDesc()

Download the WWFieldScriptFunctionLib.zip file for InTouch 6.0 for Windows NT, InTouch 7.x, and InTouch 7.11.

The set functions write directly to the tagname dictionary file.  It is
important to note that when they are written they do not generate any type
of data change event.  However, once when the field is accessed it will be
displayed using the new value which was just written.  For instance, once
the comment field has been changed, if it is included in an alarm window, any
new alarms will display the new comment field.

Windows NT users may use the 32-bit version of this dll.

Function Syntax:
value = SetCommentField( Tagname, Comment );

Arguments:
Tagname:        Name of a tag
Comment:        Value to save as the comment

Returns:
0 no error
1 could not initialize
2 tagname not defined
3 open failed
4 seek failed
5 write failed

Function Syntax:
value = SetDiscOnMsg( Disc_Tag, OnMessage );

Arguments:
Tagname:        Name of a discrete tag
Comment:        Value to save as the “On Message”

Returns:
0 no error
1 could not initialize
2 tagname not defined
3 open failed
4 seek failed
5 write failed
6 wrong tag type

Function Syntax:
value = SetDiscOffMsg( Disc_Tag, OffMessage );

Arguments:
Tagname:        Name of a discrete tag
Comment:        Value to save as the “Off Message”

Returns:
0 no error
1 could not initialize
2 tagname not defined
3 open failed
4 seek failed
5 write failed
6 wrong tag type

Function Syntax:
value = GetEUDesc( Analog_Tag.Name );

Arguments:
Tagname:        Name of an analog tag

Returns:
All error messages are returned in the string and
take the form “Error: Message!”  This should not
conflict with any Engineering Unit Descriptions

Leave a Reply

Your email address will not be published. Required fields are marked *

91 − = 88