CitectSCADA Cicode Reference

v7.
10
Cicode Reference Guide
November 2008
Legal Notice
DISCLAIMER
Citect Pty Ltd makes no representations or warranties with respect to this manual and, to the maximum extent
permitted by law, expressly limits its liability for breach of any warranty that may be implied to the replace-
ment of this manual with another. Further, Citect Pty Ltd reserves the right to revise this publication at any
time without incurring an obligation to notify any person of the revision.
COPYRIGHT
© Copyright 2008 Citect Pty Ltd All rights reserved.
TRADEMARKS
Citect Pty Ltd has made every effort to supply trademark information about company names, products and
services mentioned in this manual.
Citect, CitectHMI, and CitectSCADA are registered trademarks of Citect Pty. Ltd.
IBM, IBM PC and IBM PC AT are registered trademarks of International Business Machines Corporation.
MS-DOS, Windows, Windows NT, Microsoft, and Excel are either registered trademarks or trademarks of Mi-
crosoft Corporation in the United States and/or other countries.
DigiBoard, PC/Xi and Com/Xi are trademarks of Digi International Inc.
Novell, Netware and Netware Lite are are either registered trademarks or trademarks of Novell, Inc. in the
United States and other countries..
dBASE is a trademark of dataBased Intelligence, Inc.
All other brands and products referenced in this document are acknowledged to be the trademarks or regis-
tered trademarks of their respective holders.
GENERAL NOTICE
Some product names used in this manual are used for identification purposes only and may be trademarks of
their respective companies.
November 2008 edition for CitectSCADA Version v7.10

Manual Revision Version v7.10.
Contact Citect today at www.Citect.com

Contents
Legal Notice.....................................................................................2
Introduction .................................................................................11
Chapter: 1 Introducing Cicode....................................................13

Getting Started......................................................................................13
Using Cicode Files ................................................................................13
Using Cicode ...............................................................................15
Chapter: 2 Using Cicode Commands.........................................17

Setting Variables...................................................................................17
Performing Calculations........................................................................18
Using Multiple Command Statements...................................................18
Using Include (Text) Files .....................................................................19
Getting Runtime Operator Input............................................................20
Chapter: 3 Using Cicode Expressions.......................................23

Displaying Data Using Expressions ......................................................23
Decision-Making ...................................................................................23
Logging Expression Data......................................................................24
Triggering Events Using Expressions ...................................................24
Chapter: 4 Using Cicode Functions ...........................................25

Calling Functions from Commands and Expressions ...........................25
Triggering Functions via Runtime Operator Input .................................25
Evaluating Functions.............................................................................25
Combining Functions with Other Statements........................................26
Passing Data to Functions (Arguments) ...............................................26
Using String Arguments ........................................................................26
String assignment.....................................................................26
Using the Caret Escape Sequence Character ......................................27
Using Multiple Arguments .....................................................................27
Using Numeric Arguments ....................................................................28
Using Variable Arguments ....................................................................28
Using Operator Input in Functions ........................................................28
Returning Data from Functions .............................................................28
Chapter: 5 Working with Commonly Used Functions ..............31

Alarm Functions ....................................................................................31
Page Functions .....................................................................................31
3
Contents
Keyboard Functions ..............................................................................32

Report Functions...................................................................................32
Time/date Functions .............................................................................32
Miscellaneous Functions.......................................................................32
Chapter: 6 Writing Functions......................................................35

Cicode Function Structure ....................................................................35
Function Uses .......................................................................................36
Writing Groups of Functions .................................................................36
Cicode Function Libraries .....................................................................37
Creating a Function Outline ..................................................................37
Pseudocode ..........................................................................................37
Using Comments in Cicode ..................................................................38
Using Comments for Debugging Functions ..........................................39
Following Cicode Syntax.......................................................................39
Cicode Function Syntax ........................................................................40
End of line markers...................................................................41
Function Scope .....................................................................................41
Declaring the Return Data Type ...........................................................42
Declaring Functions ..............................................................................43
Naming Functions .................................................................................44
Function Argument Structure ................................................................44
Declaring Argument Data Type.............................................................46
Naming Arguments ...............................................................................47
Setting Default Values for Arguments...................................................48
Returning Values from Functions..........................................................49
Chapter: 7 Using Variables .........................................................51

Declaring Variable Properties ...............................................................51
Declaring the Variable Data Type .........................................................51
Naming Variables..................................................................................52
Setting Default Variable Values ............................................................52
Using Variable Scope ...........................................................................52
Using Database Variables ....................................................................54
Chapter: 8 Using Arrays..............................................................55

Declaring Array Properties....................................................................55
Declaring the Array Data Type..............................................................55
Naming Arrays ......................................................................................56
Declaring the Variable Array Size .........................................................56
Setting Default (Initial) Array Values .....................................................57
Passing Array Elements as Function Arguments..................................57
Using One-dimensional Arrays .............................................................57
Using Two-dimensional Arrays .............................................................58
Using Three-dimensional Arrays...........................................................58
Using Array Elements in Loops.............................................................59
Using the Table (Array) Functions ........................................................59
4
Contents
Chapter: 9 Using Cicode Macros................................................61

IFDEF....................................................................................................61
IFDEFAdvAlm .......................................................................................62
IFDEFAnaAlm .......................................................................................63
IFDEFDigAlm ........................................................................................63
Macro Arguments..................................................................................64
Chapter: 10 Converting and Formatting Cicode Variables ......67

Converting Variable Integers to Strings ................................................67
Converting Real Numbers to Strings ....................................................68
Converting Strings to Integers ..............................................................68
Converting Strings to Real Numbers ....................................................68
Formatting Text Strings.........................................................................69
Escape Sequences (String Formatting Commands).............................70
Chapter: 11 Working with Operators..........................................73

Using Mathematical Operators .............................................................73
Using Bit Operators...............................................................................74
Using Relational Operators...................................................................74
Using Logical Operators .......................................................................75
Order of Precedence of Operators........................................................76
Chapter: 12 Working with Conditional Executors.....................77

Setting IF ... THEN Conditions..............................................................77
Using FOR ... DO Loops .......................................................................78
Using WHILE ... DO Conditional Loops ................................................78
Nested Loops........................................................................................79
Using the SELECT CASE statement ....................................................79
Chapter: 13 Performing Advanced Tasks..................................81

Handling Events....................................................................................81
How Cicode is Executed .......................................................................82
Multitasking ...........................................................................................82
Foreground and background tasks .......................................................83
Controlling tasks ...................................................................................83
Pre-emptive multitasking.......................................................................83
Chapter: 14 Editing and Debugging Code.................................85

The Cicode Editor .................................................................................85
Starting the Cicode Editor.........................................................86
Changing the default Cicode Editor..........................................86
Creating Cicode files ................................................................87
Creating functions.....................................................................87
Saving files ...............................................................................87
Opening Cicode files ................................................................88
Deleting Cicode files.................................................................88
Finding text in Cicode files........................................................89
5
Contents
Compiling Cicode files ..............................................................89

Viewing errors detected by the Cicode Compiler .....................89
Cicode Editor Options ...........................................................................89
Docking the Windows and Toolbars .....................................................90
Displaying the Editor Options Properties dialog .......................90
Windows and Bars Tab.........................................................................91
Toolbar options.........................................................................91
Window options ........................................................................91
Viewing Editor windows............................................................92
Options Properties Tab .........................................................................96
Language Formatter Properties Tab.....................................................97
Debugging Cicode ................................................................................98
Using debug mode ...................................................................98
Debugging functions.................................................................98
Debugging functions remotely ..................................................99
Using breakpoints .................................................................................99
Inserting or removing breakpoints ..........................................100
Enabling/disabling breakpoints...............................................100
Stepping through code........................................................................100
Chapter: 15 Using Cicode Programming Standards ..............101

Variable Declaration Standards ..........................................................101
Variable Scope Standards ..................................................................102
Variable Naming Standards ................................................................102
Standards for Constants, Variable Tags, and Labels .........................103
Formatting Simple Declarations..........................................................104
Formatting Executable Statements.....................................................104
Formatting Expressions ......................................................................105
Cicode Comments ..............................................................................106
Formatting Functions ..........................................................................106
Function Naming Standards ...............................................................107
Modular Programming ........................................................................109
Defensive Programming .....................................................................112
Function Error handling.......................................................................113
Debug Error Trapping .........................................................................114
Functions Reference.................................................................117
Chapter: 16 Accumulator Functions ........................................119

Accumulator Functions .......................................................................119
Chapter: 17 ActiveX Functions.................................................125

ActiveX Functions ...............................................................................125
Chapter: 18 Alarm Functions....................................................137

Alarm Functions ..................................................................................137
6
Contents
Chapter: 19 Clipboard Functions .............................................219

Clipboard Functions ............................................................................219
Chapter: 20 Cluster Functions..................................................223

Cluster Functions ................................................................................223
Chapter: 21 Color Functions.....................................................231

Color Functions...................................................................................231
Chapter: 22 Communication Functions...................................235

Communication Functions ..................................................................235
Chapter: 23 Dynamic Data Exchange Functions ....................243

DDE Functions....................................................................................243
Chapter: 24 Device Functions...................................................255

Device Functions ................................................................................255
Chapter: 25 Display Functions .................................................279

Display Functions................................................................................279
Chapter: 26 DLL Functions .......................................................351

DLL Functions.....................................................................................351
Chapter: 27 Error Functions .....................................................357

Error Functions ...................................................................................357
Chapter: 28 Event Functions ....................................................369

Event Functions ..................................................................................369
Chapter: 29 File Functions........................................................379

File Functions......................................................................................379
Chapter: 30 Form Functions .....................................................395

Form Functions ...................................................................................395
Chapter: 31 Format Functions..................................................427

Format Functions ................................................................................427
Chapter: 32 FTP Functions .......................................................433

FTP Functions.....................................................................................433
7
Contents
Chapter: 33 FuzzyTech Functions............................................437

FuzzyTech Functions..........................................................................437
Chapter: 34 Group Functions ...................................................443

Group Functions .................................................................................443
Chapter: 35 I/O Device Functions.............................................451

I/O Device Functions...........................................................................451
Chapter: 36 Keyboard Functions..............................................461

Keyboard Functions ............................................................................461
Chapter: 37 Mail Functions .......................................................473

Mail Functions.....................................................................................473
Chapter: 38 Math and Trigonometry Functions ......................479

Math/Trigonometry Functions .............................................................479
Chapter: 39 Miscellaneous Functions......................................493

Miscellaneous Functions.....................................................................493
Chapter: 40 Page Functions......................................................537

Page Functions ...................................................................................537
Chapter: 41 Plot Functions .......................................................561

Plot Functions .....................................................................................561
Chapter: 42 Report Functions...................................................579

Report Functions.................................................................................579
Chapter: 43 Security Functions................................................585

Security Functions ..............................................................................585
Chapter: 44 Statistical Process Control Functions ................605

SPC Functions ....................................................................................605
Chapter: 45 SQL Functions.......................................................619

SQL Functions ....................................................................................619
Chapter: 46 String Functions....................................................639

String Functions ..................................................................................639
8
Contents
Chapter: 47 Super Genie Functions.........................................661

Super Genie Functions .......................................................................661
Chapter: 48 Table (Array) Functions........................................683

Table (Array) Functions ......................................................................683
Chapter: 49 Tag Functions........................................................687

Tag Functions .....................................................................................687
Chapter: 50 Task Functions......................................................703

Task Functions....................................................................................703
Chapter: 51 Time and Date Functions......................................735

Time/Date Functions...........................................................................735
Chapter: 52 Trend Functions ....................................................753

Trend Functions ..................................................................................753
Chapter: 53 Window Functions ................................................831

Window Functions...............................................................................831
Technical Reference .................................................................859
Chapter: 54 Cicode Errors.........................................................861

Hardware/Cicode Errors .....................................................................861
Cicode and General Errors .................................................................862
MAPI Errors ........................................................................................882
Chapter: 55 Browse Function Field Reference .......................885
Index.............................................................................................897
9
Contents
10
Part: 1
Introduction
This section provides some introductory material for CitectSCADA:
Introducing Cicode
12
Chapter: 1 Introducing Cicode
Cicode is a programming language designed for use in CitectSCADA to monitor and con-
trol plant equipment. It is a structured language similar to Visual Basic or ’C’. You need no
previous programming experience to use it.
Using Cicode, you can access all real-time data (variables) in the CitectSCADA project, and
all CitectSCADA facilities: variable tags, alarms, trends, reports, and so on. You can use
Cicode to interface to various facilities on the computer, such as the operating system and
communication ports. Cicode supports advanced features including pre-empted multi-
tasking, multi threads, and remote procedure calls.
Getting Started
Use the following sections as a quick start to using Cicode in your CitectSCADA projects:
 Cicode can be stored in procedures called functions for multiple reuse and centralized
maintenance. For details, see Using Cicode Files.
 Cicode can be typed directly into command fields in online CitectSCADA forms. For de-
tails, see Using Cicode Commands.
 Cicode expressions are used to display and log data for monitoring and analysis, and to
trigger various elements in your system, such as alarms, events, reports, and data log-
ging. For information on using expressions, see Using Cicode Expressions.
 A Cicode function is a small program, a collection of statements, variables, operators,
conditional executors, and other functions. A Cicode function can perform complex
tasks and give you access to CitectSCADA graphics pages, alarms, trend data, and so
on. For information on using functions, see the section titled Using Cicode Functions.
Cicode has many pre-defined functions that perform a variety of tasks. For details on
commonly used functions, see the section titled Working with Commonly Used Func-
tions. Where system functionality cannot be achieved with built-in functions, you can
write your own functions. See Writing Functions.
 The Cicode Editor is the code editing tool provided with CitectSCADA for the writing,
editing and debugging of your Cicode code. For details, see The Cicode Editor.
See Also
Performing Advanced Tasks
Using Cicode Programming Standards
Using Cicode Files

You write all your Cicode functions in Cicode source files, stored on your hard disk. Cicode
files are identified by having a *.CI extension.
To minimize potential future problems with maintaining your Cicode files, adopt a pro-
gramming standard as early as possible (see Using Cicode Programming Standards). Main-
tain structured Cicode files, by logically grouping your Cicode functions within the files,
and by choosing helpful descriptive names. For details about modular programming meth-
ods, see Modular Programming. For details about using and debugging Cicode functions,
see Formatting Functions and Debugging Cicode respectively.
13
Chapter: 1 Introducing Cicode
When you compile your CitectSCADA project, the compiler reads all the functions in your
Cicode source files. Your system can then use these functions in the same way as it uses
built-in functions. You can use as many Cicode files as required. Cicode files reside in the
same directory as your CitectSCADA project. When you back up your project, all Cicode
source files in the project directory are also backed up.
See Also
The Cicode Editor
Creating Cicode files
Opening Cicode files
14
Part: 2
Using Cicode
This section contains information for Users and describes the following:
Using Cicode Commands Using Cicode Macros
Using Cicode Expressions Converting and Formatting Cicode Variables
Using Cicode Functions Working with Operators
Working with Commonly Used Functions Working with Conditional Executors
Writing Functions Performing Advanced Tasks
Using Variables Editing and Debugging Code
Using Arrays Using Cicode Programming Standards
16
Chapter: 2 Using Cicode Commands
Cicode commands extend the control element of a CitectSCADA control and monitoring
system. You use commands to control your CitectSCADA system and therefore the pro-
cesses in your plant.
Each command has a mechanism to activate it. Commands can be issued manually,
through an operator typing a key sequence, or by clicking on a button (or object) on a
graphics page. You can also configure commands to execute automatically:
 When an operator logs into or out of the runtime system
 When a graphics page is displayed or closed
 When an alarm is triggered
 In a report
 When an event is triggered
To define a Cicode command, you enter a statement (or group of statements) in the com-
mand field (Input category) for an object.
Each statement in a command usually performs a single task, such as setting a variable to
a value, calculating a value, displaying a message on the screen, or running a report. For
information on using variables, see the section titled Using Variables.
If you want to evaluate a condition, like checking the state of your plant rather than per-
form an action or command upon your plant, use an expression instead. See the section ti-
tled Using Cicode Expressions.
See Also
Setting Variables
You can set a Variable in CitectSCADA within a Command field, an Expression field, or in
a Cicode Function, by using the mathematical ’equals’ sign ( = ) assignment operator. The
value on the right is assigned (set) to the variable on the left, as shown in the following
Cicode example :
<VAR_TAG> = Val;
where:
<VAR_TAG> is the name of the variable, and Val is the value being assigned to the variable.
Examples
To set a digital variable (named BIT_1) to ON (1), use the command:
BIT_1 = 1;
To set a digital variable (named BIT_1) to OFF (0), use the command:
17
BIT_1 = 0;
To set a digital variable (named B1_PUMP_101_M) to ON (1), use the command:

B1_PUMP_101_M = 1;
To set a digital variable (named B1_PUMP_101_M) to OFF (0), use the command:
B1_PUMP_101_M = 0;
To set an analog variable (named B1_TIC_101_SP) to a value of ten (10), use the command:
B1_TIC_101_SP = 10;
You can copy a variable to another by assigning (setting) the value of a variable to the value
of another variable, for example:
B1_PUMP_101_COUNT = B1_PUMP_101_CLIMIT;
The value of B1_PUMP_101_COUNT is set to the value of B1_PUMP_101_CLIMIT only

when that command is issued.
Note: The value of B1_PUMP_101_CLIMIT could change immediately after, but
B1_PUMP_101_COUNT remains unchanged and storing the original value, until this com-
mand is issued again.
Performing Calculations
Mathematical calculations can be performed between variables in a Cicode statement. For
example:
B1_TIC_101_SP = B1_TIC_101_PV + B1_TIC_102_PV - 100;
When this command is executed, the variable B1_TIC_101_SP is set to a value that is the
sum of variables B1_TIC_101_PV and B1_TIC_102_PV minus 100.
Using Multiple Command Statements

A single statement in a Cicode command usually performs a single task. When the Cit-
ectSCADA runtime system is in operation, the statement executes whenever the command
is requested. For example, if the statement is linked to a keyboard command, the task is per-
formed when an operator presses the keyboard key defined as that command.
To perform several tasks at the same time, you combine statements in a command proper-
ty:
B1_PUMP_101_COUNT = B1_PUMP_101_CLIMIT;
BATCH_NAME = "Bread";
18
B1_TIC_101_SP = 10;
The example above uses three statements, separated by semi-colons ( ; ). The first statement
sets the variable B1_PUMP_101_COUNT to the value of the variable
B1_PUMP_101_CLIMIT; the second statement sets the variable BATCH_NAME to the
string "Bread"; and the third statement sets the variable B1_TIC_101_SP to 10. Each state-
ment is executed in order.
Note: Separate each statement in a command with a semicolon (;). If you don’t, CitectSCA-
DA will not recognize the end of a statement, and errors will result when the project is com-
piled.
The number of statements you can enter in a command property is limited only by the size
of the field. However, for clarity, don’t use too many statements; enter the statements into
an Include File or write a Cicode Function. You then refer to the include file or call the func-
tion in the command property field.
Using Include (Text) Files

There is a maximum number of characters that you can type in a Command or Expression
field (usually 128). If you need to include many commands (or expressions) in a property
field, you can define a separate include file that contains the commands or expressions.
An include file is a separate and individual ASCII text file containing only one sequence of
CitectSCADA commands or expressions that would otherwise be too long or complicated
to type into the Command or Expression field within CitectSCADA. The include file name
is entered instead, and the whole file is activated when called.
Note: Be careful not to confuse include files and includedprojects. Include files contain Cit-
ectSCADA commands and/or expressions and are used as substitutions in a CitectSCADA
command or expression property field. Included projects are separate (usually smaller) Ci-
tectSCADA projects that can be included in another CitectSCADA project so that they ap-
pear together as one project.
When you compile the project, the commands (or expressions) in the include file are sub-
stituted for the property field, just as if you had typed them directly into the field.
Use a text editor such as Notepad to create the text file.
Enter the name of the include file (either upper- or lower case) in the property, in the fol-
lowing format:
@<filename>
where <filename> is any valid DOS file name. Be aware that the bracket characters (< >) are
part of the syntax.
You can use include files with most properties (except record names), but they are most
commonly used for commands and expressions, for example:
 Key sequence: F5 ENTER
 Command: @<setvars.cii>
19
In the above example, the setvars.cii include file would contain commands to be substi-
tuted for the Command property when you compile your project, for example:
PV12 = 10;
PV22 = 20;
PV13 = 15;
PV23 = 59;
PageDisplay("Mimic");
Notes
 The include file name can contain a maximum of 64 characters, or 253 characters includ-
ing a path, and can consist of any characters other than the semi-colon (;) or the single
quote(’). You do not need to include the .cii extension, but if the file is not in the project
directory, you must enter the full path to the file. If the file is not in the project directory,
it will not be backed up with the Backup facility.
 If modifying an Include file with the Cicode Editor, when you save your changes a .ci
file extension will be appended to the file name. Change this to a .cii file extension in
Windows Explorer.
Getting Runtime Operator Input

You can define a keyboard command as a key sequence, to perform a specific task each time
the key sequence is pressed, for example:
 Key sequence: F2 ENTER
 Command: B1_TIC_101_SP = 10;
A key sequence can include provision for the operator to enter data. In the following exam-
ple, the operator can set the value of the variable B1_TIC_101_SP:
The operator issues the command by pressing the F2 key, up to three characters, and the
Enter key. The three character sequence (identified by the three hash (#) characters) is called
an argument. The argument is passed into the command (as Arg1) when the command is
completed (when the operator presses the Enter key).
The operator might type:
The value 123 is passed to the command, and B1_TIC_101_SP is set to 123.
Always use a specific key (for example, Enter) to signal the end of a key sequence. If, for
example, you use the key sequence F2 ####, the operator must enter 4 characters for the
command to be executed - CitectSCADA waits for the fourth character. But if you use F2
#### Enter, the operator can enter between one and four characters as necessary. The com-
mand executes as soon as the Enter key is pressed.
20
To use more than one argument in a command, separate the arguments with commas ( , ):
 Key sequence: F2 ###,## Enter
 Command: B1_TIC_101_SP = Arg1; B1_TIC_101_PV = Arg2;
To set both variables, the operator can type:
The values 123 and 18 are passed to the command. B1_TIC_101_SP is set to 123 and
B1_TIC_101_PV is set to 18.
21
22
Chapter: 3 Using Cicode Expressions
Cicode expressions are the basic elements of the Cicode language. An expression can be a
constant, the value of a variable tag, or the result of a complex equation. You can use ex-
pressions to display and log data for monitoring and analysis, and to trigger various ele-
ments in your system, such as alarms, events, reports, and data logging.
You can enter a Cicode expression in any CitectSCADA editor form or graphic object that
contains an expression property. Unlike a command, an expression does not execute a spe-
cific task - it is evaluated. The evaluation process returns a value that you can use to display
information on the screen (for example, as a bar graph) or to make decisions. The following
expression returns a result of 12:
 Numeric expression: 8 + 4
In the above example, the value of the expression is a constant (12) because the elements of
the expression are constants (8 and 4).
See Also
Displaying Data Using Expressions
Logging Expression Data
Triggering Events Using Expressions
Using Cicode Files
Displaying Data Using Expressions

In the following example, the value of the expression is the value of the variable
B1_TIC_101_PV. As its value changes, the value of the expression also changes. You can
use this expression to display a number on a graphics page.
 Numeric expression: B1_TIC_101_PV
As the expression changes, the number also changes.
Expressions can also include mathematical calculations. For example, you can add two
variables together and display the combined total:
 Numeric expression: B1_TIC_101_PV + B1_TIC_102_PV
In this case, the value of the expression is the combined total. As the value of one variable
(or both variables) changes, the value of the expression changes.
See Also
Using Cicode Expressions
Decision-Making
Some expressions return only one of two logical values, either TRUE(1) or FALSE(0). You
can use these expressions to make decisions, and to perform one of two actions, depending
on whether the return value is TRUE or FALSE. For example, you can configure a text ob-
ject with appearance as follows:
23
Chapter: 3 Using Cicode Expressions
 On text when: B1_PUMP_102_CMD

 ON text: Pump Running
 OFF text: "Pump Stopped"
In this example, if B1_PUMP_102_CMD is a digital tag (variable), it can only exist in one of
two states (0 or 1). When your system is running and the value of B1_PUMP_102_CMD
changes to 1, the expression returns TRUE and the message "Pump Running" is displayed.
When the value changes to 0, the expression returns FALSE and the message "Pump
Stopped" is displayed.
See Also
Logging Expression Data

You can log the value of an expression to a file for trending, by defining it as a trend tag:
Trend Tag Name B1_TIC
Expression B1_TIC_101_PV + B1_TIC_102_PV
File Name [log]:B1_TIC
When the system is running, the value of the expression B1_TIC_101_PV + B1_TIC_102_PV
is logged to the file [log]:B1_TIC.
See Also
Triggering Events Using Expressions

Logical expressions - those that return either TRUE (1) or FALSE (0) -can be used as trig-
gers.
For example, you might need to log the expression in the above example only when an as-
sociated pump is running.
Trend Tag Name B1_TIC
Expression B1_TIC_101_PV + B1_TIC_102_PV
File Name [log]:B1_TIC
Trigger B1_PUMP_101_CMD
In this example, the trigger is the expression B1_PUMP_101_CMD (a digital variable tag).
If the pump is ON, the result of the trigger is TRUE, and the value of the expression
(B1_TIC_101_PV + B1_TIC_102_PV) is logged. If the pump is OFF, the result is FALSE, and
logging ceases.
See Also
24
Chapter: 4 Using Cicode Functions
A Cicode function can perform more complex tasks than a simple command or expression
allows. Functions give you access to CitectSCADA graphics pages, alarms, trend data, and
so on.
CitectSCADA has several hundred built-in functions that display pages, acknowledge
alarms, make calculations, and so on. You can also write your own functions to meet your
specific needs.
See Also
Working with Commonly Used Functions
Writing Functions
Calling Functions from Commands and Expressions

You can call a function by entering its name in any command or expression property. The
syntax is as follows:
Command FunctionName ( Arg1, Arg2, ... );
where:
FunctionName is the name of the function
Arg1, Arg2, ... are the arguments you pass to the function
Triggering Functions via Runtime Operator Input

In the following command, the PageNext() function displays the next graphics page when
the Page Down keyboard key is pressed by the Runtime operator.
Key Sequence Page_Down
Command PageNext();
Evaluating Functions
You can use a function in any expression. For example, the AlarmActive() function returns
TRUE (1) if any alarms are active, and FALSE (0) if no alarms are active. In the following
text object, either "Alarms Active" or "No Alarms Active" is displayed, depending on the
return value of the expression.
ON text when AlarmActive(0)
ON Text "Alarms Active"
OFF Text "No Alarms Active"
Note: All functions return a value. This value either indicates the success of the function,
or provides information on an error that has occurred. In many cases (for example, when
used in a command) the return value can be ignored. You must use the parentheses () in
the function name, even if the function uses no arguments. Function names are not case-
sensitive: PageNext(), pagenext() and PAGENEXT() call the same function.
25
Combining Functions with Other Statements

In expressions and commands you can use functions alone or in combination with other
functions, operators, and so on.
The following example uses three statements:
Command Report("Shift"); B1_TIC_101_PV = 10; PageDisplay("Boiler 1")
Each statement is executed in order. The "Shift" report is started first, the variable
B1_TIC_101_PV is set to 10 next, and finally, the "Boiler 1" page is displayed.
Functions combine with operators and conditional executors to give you specific control
over your processes, for example, you can test for abnormal operating conditions and act
on them.
Passing Data to Functions (Arguments)

The parentheses ( ) in the function name identify the statement as a function and enclose its
arguments. Arguments are the values or variables that are passed into the function when
it executes.
Note: Some functions (such as PageNext()) do not require any arguments. However you
must include the parentheses ( ) or CitectSCADA will not recognize that it is a function, and
an error could result when the project is compiled.
Using String Arguments

Functions can require several arguments or, as in the following example, a single argu-
ment:
Command PageDisplay("Boiler 1");
This function displays the graphics page called "Boiler 1". Be aware that when you pass a
string to a function, you must always enclose the string in double quotes.
You can use the PageDisplay() function to display any graphics page in your system - in
each case, only the argument changes. For example, the following command displays the
graphics page "Boiler 2":
Command PageDisplay("Boiler 2");
You can use the Report() function to run a report (for example, the "Shift" report) when the
command executes:
Command Report("Shift");
The following example uses the Prompt() function to display the message "Press F1 for
Help" on the screen when the command executes:
Command Prompt("Press F1 for Help");
String assignment
You can also assign string variables in commands. For example, if BATCH_NAME is a vari-
able tag defined as a string data type, you can use the following command to set the tag to
the value "Bread":
26
BATCH_NAME = "Bread";
Note: You must enclose a string in double quotation marks ( " ).
Using the Caret Escape Sequence Character

The caret character ( ^ ) signifies a special instruction in Cicode, called an escape sequence,
primarily used in the formatting of text strings. Escape sequences include formatting in-
structions such as new line, form feed, carriage return, backspace, horizontal and vertical
tab-spaces, single and double quote characters, the caret character, and hexadecimal num-
bers.
Strings are commonly represented in Cicode between double quote characters ( " ) known
as delimiters. If you want the string to contain a double quote character itself as part of the
string, you must precede the double quote character with the caret character ( ^" ) so that
Cicode doesn’t interpret the double quote in the string as the delimiter indicating the end
of the string. The caret character is interpreted as a special instruction, and together with
the characters immediately following it, are treated as an escape sequence instruction. See
the section titled Formatting Text Strings for the list of escape sequences used in Cicode.
In the following Cicode example, both of these message functions will display the follow-
ing message.
Message("Info", "P29 has a ^"thermal overload^".", 0);
sCurrentAlmText = "Thermal Overload";
Message("Info", "P29 has a ^""+sCurrentAlmText+"^".", 0);
Using Multiple Arguments

Some functions require several arguments. You must list all arguments between the paren-
theses, and separate each argument with a comma ( , ) as in the following example:
Command Login("Manager", "ABC");
The order of the arguments is important to the operation of any function. The Login() func-
tion logs a user into your runtime system. The first argument ( "Manager" ) indicates the
name of the user, and the second argument ( "ABC" ) is the user’s password. If you reverse
the order of the arguments, the function would attempt to login a user called "ABC" - if a
user by this name does not exist, an error message displays.
27
Using Numeric Arguments

You can pass numbers (integers and floating point numbers) directly to a function, for ex-
ample:
Command AlarmAck(2, 35);
Using Variable Arguments

When variables (such as real-time data) are used as arguments, the value of the variable is
passed, not the variable itself. The following example uses the DspStr() function to display
the value of a process variable at AN25:
Command DspStr(25, "TextFont", B1_TIC_101_PV);
In this instance, the value of B1_TIC_101_PV displays. If it is a real-time variable, the num-
ber that displays depends on its value at the time.
Note: Do not use double quotes around variables, for example, "B1_TIC_101_PV", other-
wise the text string B1_TIC_101_PV displays, not the value of the variable.
Using Operator Input in Functions

You can pass operator input to functions at runtime. For example, you can define a System
Keyboard Command to let the operator select a page:
Key Sequence F10 ######## Enter
Command PageDisplay(Arg1);
When the command executes, the page name is passed to the function as Arg1. The opera-
tor can then display any page, for example:
Returning Data from Functions

All functions return data to the calling statement (a command or expression). Some func-
tions simply return a value that indicates whether the function was successful. For exam-
ple, both the PageNext() and PageDisplay() functions return 0 (zero) if the page displays
successfully, otherwise they return an error number. For most simple applications, you can
ignore this return value.
Some functions return data that you can use in an expression or command. For example,
the Date() function returns the current date as a string. To display the current date on a
graphics page, use the following expression in a text object display value property:
Numeric expression Date();
The following example shows an entry command event for a graphics page, using a com-
bination of two functions. The FullName() function returns the name of the user who is cur-
rently logged in to the run-time system, passing this name to the calling function, Prompt().
When the page is opened, a welcome message displays in the prompt line.
On page entry Prompt("Hello, " + FullName())
28
For example, if the current user is John Citizen, the message "Hello, John Citizen" displays.
29
30
Chapter: 5 Working with Commonly Used Functions
Cicode has many functions that perform a variety of tasks. Many of these are used for
building complex CitectSCADA systems. The functions you will most often use are divided
into six categories:
 Alarm Functions
 Page Functions
 Keyboard Functions
 Report Functions
 Time/date Functions
 Miscellaneous Functions
See Also
Functions Reference
Alarm Functions
You can use alarm functions to display alarms and their related alarm help pages, and to
acknowledge, disable, and enable alarms. You can assign a privilege to each command that
uses an alarm function, so that only an operator with the appropriate privilege can perform
these commands. However, you should assign privileges to commands only if you have
not assigned privileges to individual alarms.
 AlarmAck: Acknowledges an alarm. The alarm where the cursor is positioned (when
the command is executed) is acknowledged. You can also use this function to acknowl-
edge multiple alarms.
 AlarmComment: Adds a comment to the alarm summary entry at run time. The com-
ment is added to the alarm where the cursor is positioned when the command is execut-
ed. A keyboard argument passes the comment into the function. Verify that the length
of the comment does not exceed the length of the argument, or an error results.
 AlarmDisable: Disables an alarm. The alarm where the cursor is positioned (when the
command is executed) is disabled. You can also use this function to disable multiple
alarms.
 AlarmEnable: Enables an alarm. The alarm where the cursor is positioned (when the
command is executed) is enabled. You can also use this function to enable multiple
alarms.
 AlarmHelp: Displays an alarm help page for the alarm. Each alarm in your system can
have an associated help page. The help page for the alarm at the position of the cursor
(when the command is executed) is displayed.
 AlarmSplit: Duplicates an entry in the alarm summary display. You can use this func-
tion to add additional comments to the alarm entry.
Page Functions
With the page functions, you can display your graphics pages and the standard alarm pag-
es.
Note: The following page functions are not supported in the server process in a multipro-
cessor environment. Calling page functions from the server process results in a hardware
alarm being raised.
31
 PageAlarm: Displays current alarms on the alarm page configured in the project.
 PageDisabled: Displays disabled alarms on the alarm page configured in the project.
 PageDisplay: Displays a new page on the screen. The Page name or number is required
as an argument. (Use the PageLast() function to go back to the last page - the page that
this new page replaced).
 PageFile: Displays a file on the file page configured in the project.
 PageGoto: Displays a new page on the screen. This function is similar to the PageDis-
play() function, except that if PageLast() is called, it does not return to the last page.
 PageHardware: Displays hardware alarms on the alarm page configured in the project.
 PageLast: Displays the graphics page that was displayed before the current one. You
can use this function to ’step back’ through the last ten pages.
 PageNext: Displays the next graphics page (defined in the Next Page property of the
Pages form).
 PagePrev: Displays the previous graphics page (defined in the Prev Page property of the
Pages form).
 PageSummary: Displays summary alarm information on the alarm page configured in
the project.
 PageTrend: Displays a standard trend page.
Keyboard Functions
Keyboard functions control the processing of keyboard entries and the movement of the
keyboard cursor on the graphics page.
 KeyBs: Backspaces (removes) the last key from the key command line. Use this function
with a ’Hotkey’ command. It is normally used to erase keyboard characters during runt-
ime command input.
 KeyDown: Moves the cursor down the page to the closest animation point number
(AN).
 KeyLeft: Moves the cursor left (across the page) to the closest animation point number
(AN).
 KeyRight: Moves the cursor right (across the page) to the closest animation point num-
ber (AN).
 KeyUp: Moves the cursor up the page to the closest animation point number (AN).
Report Functions
To run a report by operator action, use the following function:
 Report: Runs the report on the report server.
Time/date Functions
The following functions return the current date and time:
 Date: Returns the current date as a string.
 Time: Returns the current time as a string.
Miscellaneous Functions
 Beep: Beeps the speaker on the CitectSCADA computer.
 FullName: Returns the full name of the user who is currently logged in to the system.
 InfoForm: Displays the animation information form. This form displays the real-time
data that is controlling the current animation.
32
 Login: Allows a user access to the CitectSCADA system.

 LoginForm: Displays a dialog box to allow a user to log in to the system.
 Logout: Logs the current user out of the CitectSCADA system.
 Name: Returns the user name of the user who is currently logged in to the system.
 Prompt: Displays a message on the screen. The message String is supplied as an argu-
ment to the function.
 Shutdown: Terminates CitectSCADA. Always use this function, or the Shutdown-
Form() function, to shut down your system. Otherwise buffered data may be lost.
 ShutdownForm: Displays a dialog box to allow a user to shut down your CitectSCADA
system.
33
34
Chapter: 6 Writing Functions
CitectSCADA is supplied with over 600 built-in functions. One of these functions (or sev-
eral functions in combination) can usually perform most tasks in your system. However,
where system functionality cannot be achieved with built-in functions, you can write your
own functions.
A Cicode function is a small program: a collection of statements, variables, operators, con-
ditional executors, and other functions.
While you do not have to be an experienced programmer to write simple Cicode functions,
do not attempt to write large, complex functions unless you are familiar with computer
programming, and have experience with Cicode. Functions are equivalent to the subrou-
tines of BASIC and assembly language, and the subroutines and functions used in Pascal
and C.
Note: The Cicode Editor is designed specifically for editing and debugging Cicode func-
tions.
See Also
The Cicode Editor
Using Cicode Files
Cicode Function Structure

A function in Cicode can be described as a collection or list of sequential statements that
CitectSCADA can perform (execute) in the logical order that they exist within the function.
A Cicode function starts with the FUNCTION statement and finishes with the END state-
ment. All other statements that lie between the FUNCTION and END statements, will be
executed by the function, when called to do so.
A typical Cicode function is structured like the following example:
FUNCTION
FunctionName ( )
! The exclamation point indicates that the rest of this line contains a comment.
! Further Cicode statements go here, between the function name and the END.
END
The line immediately following the FUNCTION statement, contains the name of the func-
tion, which is used to identify the function to CitectSCADA. This name is referred to when
the function is called upon (called) to be executed (perform the statements it contains) by
some other event, action, or function in CitectSCADA.
Note: Functions can contain statements that call other functions. These functions are then
executed before returning to the rest of the statements within the calling function.
The function name always ends with parentheses ( ), which may or may not contain one or
more arguments required by the function. Arguments are explained in the section titled
Function Argument Structure.
35
All the lines between the function name line and the END statement line contain the state-
ments that will be executed when the function is called in CitectSCADA. These statements
are executed one at a time in logical order from top to bottom within the function. For de-
tails about function structure, see Formatting Functions. For details about Cicode function
syntax, see Following Cicode Syntax.
For details about using comments in Cicode and in Cicode functions, see Using Comments
in Cicode.
Function Uses
Cicode functions can have many purposes. Most often, functions are used to store a com-
mon set of commands or statements that would otherwise require repetitious typing and
messy command or expression fields.
Some functions are simple, created to avoid a long command or expression. For example,
the following command increments the variable tag COUNTER:
Command IF COUNTER < 100 THEN COUNTER = COUNTER + 1; ELSE COUNTER
= 0; END;
This command would be easier to use (and re-use) if it was written as a function that can
be called in the command:
Command IncCounter ( );
To be able to use the function like this, you must write it in a Cicode file, and declare it with
the FUNCTION keyword:
FUNCTION
IncCounter ( )
IF COUNTER < 100 THEN
COUNTER = COUNTER + 1;
ELSE
COUNTER = 0;
END
END
Be aware that the indented code is identical in functionality to the long command above.
By placing the command code inside a function, and using the function name in the com-
mand field as in the previous example, this function need only to be typed once. It can then
be called any number of times, from anywhere in CitectSCADA that requires this function-
ality. Because the code exists in the one location, rather than repeated wherever needed (in
potentially many places), it can be easily maintained (altered if necessary).
Writing Groups of Functions

To perform complex tasks you need careful design. Large, complex functions are not only
more difficult to understand and debug than short functions, but they can also hide tasks
that are common to other activities.
Cicode functions allow a modular approach - the most complex task can be organized into
small functions, each with a single, clear purpose. These small functions can then be called
36
by other functions, or called directly in commands and expressions. In fact, any function
can call - and be called by - any other function.
For example, you might need to write a set of functions for handling alarms. To perform
any action on an alarm, you first need to know which alarm. You would identify the alarm
in a separate function, and call this function from the other functions.
Cicode Function Libraries

Cicode functions are stored within Cicode files. You can use a separate file for each stand-
alone function, or group several functions together into a common file. For easy mainte-
nance, store functions that perform related tasks in the same file - for example, store all the
functions that act on alarm data in an Alarms.CI file.
Note: All Cicode files in your project directory will be included when you compile your
project.
Creating a Function Outline

First, define the purpose of the function group, and create an outline of the tasks to be per-
formed. The following example shows an outline for a group of functions that change the
threshold values of analog alarms during run time. The outline describes the workings of
the function group, and is written in pseudocode (also called Program Design Language).
/*
This file contains functions to allow the operator to make runtime
changes to Analog Alarm thresholds.
This file has 4 functions. The master function calls the other
functions.
ChangeAnalogAlarmThresholds ( )
This calls in turn:
1:GetVariableTag ( )
Argument: cursor position
Return: name of variable tag at cursor
2:GetAlarmThresholds ( )
Argument: tag name
Return: threshold value of alarm
3:DisplayAlarmThresholds ( )
Argument: threshold value of alarm
Displays threshold values in prompt line
Return: success or error code
*/
Pseudocode
The pseudocode above is a Cicode comment, enclosed between the comment markers /*
and */, and is ignored by the compiler. With pseudocode, you can get the logic of the func-
tion correct in a more readable structure, before you write it in Cicode syntax, leaving the
pseudocode within the finished code as comments.
It is good practice to use comments as file headers at the start of each Cicode file, to describe
the functions in the file - their common purpose, a broad description of how they achieve
that purpose, special conditions for using them, and so on. You can also use the header to
37
record maintenance details on the file, such as its version number and date of revision. For
example:
/*
** FILE: Recipe Download.Ci
**
** AUTHOR: AJ Smith
**
** DATE: March 2008
**
** REVISION: 1.0 for CitectSCADA v7.1
**
** This file contains functions to allow the operator to load the
** recipe data from the SQL server to the PLC.
*/
Following the file header are the functions in series:

/*
** Main function
*/
FUNCTION
RecipeDownload ( )
! {body of function}
! .
END
/*
** Function to open the SQL connection.
*/
FUNCTION
RecipeConnectSQL ( )
! {body of function}
! .
END
! (and so on)
Using Comments in Cicode

It is good programming practice to include comments in all your Cicode files. Comments
allow you to quickly understand how a function works next time you (or another designer)
need to modify it.
The Cicode compiler recognizes the following single line, C style, and C++ style comments:
! A single line comment
WHILE DevNext ( hDev ) DO
Counter = Counter + 1 ; ! An in-line comment
END
/* A block comment is a C-style comment, and can
extend over several lines. Block comments must
finish with a delimiter, but delimiters at the
start of each line are optional only. */
// A double-slash comment is a C++ style comment, for example:
Variable = 42; // This is a comment
38
Single line ( ! ) and C++ style ( // ) comments can have a line of their own, where they refer
to the block of statements either before or after it. It is good practice to set a convention for
these comments. These comments can also be on the same line as a statement, to explain
that statement only. All characters after the ! or // (until the end of the line) are ignored by
the compiler.
Block (C style) comments begin with /* and end with */. These C style comments need no
punctuation between the delimiters.
Using Comments for Debugging Functions

You can use comments to help with the debugging of your functions. You can use com-
ments to temporarily have the compiler ignore blocks of statements by changing them to
comments. C style and C++ style comments can be nested, for example.
FUNCTION
IncCounter ( )
IF COUNTER < 100 THEN
COUNTER = COUNTER + 1 ;
/* ELSE // Comment about statement
COUNTER = 0; // Another comment
*/
END
END
The complete ELSE condition of the IF conditional executor will be ignored (and not exe-
cute) so long as the block comment markers are used in this example.
Note: The inline ( // ) comments have no effect within the block ( /* and */ ) comments (as
the whole section is now one big comment), and should remain unchanged, so that when
you do remove the block comments, the inline comments will become effective again.
Following Cicode Syntax

Some programming languages have strict rules about how the code must be formatted, in-
cluding the indenting and positioning of the code structure. Cicode has no indenting or po-
sitioning requirements, allowing you to design your own format - provided only that you
follow the correct syntax order for each statement. However, it is a good idea to be consis-
tent with your programming structure and layout, so that it can be easily read and under-
stood.
For details about programming standards, see the section titled Using Cicode Program-
ming Standards, which includes sections on:
 Standards for constants, variable tags, and labels
 Standards variables: declaration, scope, and naming
 Standards for functions: naming , file headers, headers
 Formatting of: declarations, statements, expressions, and functions
 Use of comments
For information on problem solving, see the sections onModular Programming, Defensive
Programming, Function Error handling, or Debugging Cicode.
The following is an example of a simple Cicode function:
39
/*
This function is called from a keyboard command. The operator
presses the key and enters the name of the page to be displayed. If
the page cannot be displayed, an error message is displayed at the
prompt AN.
*/
INT
FUNCTION
MyPageDisplay ( STRING sPage ) ! pass in the name of the page to be displayed
! declare a local integer to hold the results of the pagedisplay function
INT Status;
! call the page Cicode pagedisplay function and store the result
Status = PageDisplay ( sPage ) ;
! determine if the page display was successful
IF Status < > 0 THEN ! error was detected
! display an error message at the prompt AN
DspError ( "Cannot Display " + sPage ) ;
END
! return the status to the caller
RETURN Status;
END
The rules for formatting statements in Cicode functions are simple, and help the compiler
in interpreting your code.
It is good practice to use white space to make your code more readable. In the example
above, all code between the FUNCTION and END statements is indented, and the state-
ment within the IF THEN conditional executor is further indented to make the conditions
and actions clear. Develop a pattern of indentation - and stick to it. Extra blank lines in the
code make it easier to read (and understand).
Cicode Function Syntax

Note: In the following function syntax example:
 Every placeholder shown inside arrow brackets ( <placeholder> ) should be replaced in
any actual code with the value of the item that it describes. The arrow brackets and the
word they contain should not be included in the statement, and are shown here only for
your information.
 Statements shown between square brackets ( [ ] ) are optional. The square brackets
should not be included in the statement, and are shown here only for your information.
Cicode functions have the following syntax:
[ <Scope> ]
[ <ReturnDataType> ]
FUNCTION
<FunctionName> ( <Arguments> )
<Statement> ;
<Statement> ;
<Statement> ;
RETURN <ReturnValue> ;
END
where:
40
 <Scope> = Scope Statement: optional, PRIVATE or PUBLIC, default PUBLIC, no semi-

colon. See the section titled Function Scope.
 <ReturnDataType> = Return Data Type Statement: optional and one of INT, REAL,
STRING or OBJECT. No default, no semicolon. If no return type is declared, the func-
tion cannot return any data. See the section titled Declaring the Return Data Type.
 FUNCTION = FUNCTION Statement: required, indicates the start of the function, key-
word, no semicolon. See the section titled Declaring Functions.
 <FunctionName> = Name statement: required, up to 32 ASCII text characters, case in-
sensitive, no spaces, no reserved words, no default, no semicolon. See the section titled
Naming Functions.
 ( <Arguments> ) = Argument statement: surrounding brackets required even if no argu-
ments used, if more than one argument - each must be separated by a comma, can con-
tain constants or variables of INT or REAL or STRING data type, default can be defined
in declaration, can be spread over several lines to aid readability, no semicolon. See the
section titled Function Argument Structure.
 <Statement> = Executable Statement: required, one or more executable statements that
perform some action in CitectSCADA, often used to manipulate data passed into the
function as arguments, semicolon required.
 RETURN = RETURN Statement: optional, used to instruct Cicode to return a value to
the caller of the function - usually a manipulated result using the arguments passed in
to the function by the caller, must be followed by Return Value Statement, keyword, no
semicolon.
 <ReturnValue> = Return Value Statement; required if RETURN Statement used in func-
tion, must be either a constant or a variable, the data type must have been previously
declared in the function Return Data Type Statement - or does not return a value, semi-
colon required. See the section titled Returning Values from Functions.
 END = END Statement: required, indicates the end of the function, keyword, no semi-
colon. See the section titled Declaring Functions.
End of line markers

Most statements within the function are separated by semicolons ( ; ) but some exceptions
exist. The FUNCTION and END Statements (the start and end of the function) have no
semicolons, nor does the Scope or Return Data Type Statements, nor any statement that
ends with a reserved word.
Where a statement is split over several lines (for example, within the IF THEN conditional
executor), each line ends with a semicolon - unless it ends in a reserved word.
Function Scope
The optional Scope Statement of a function (if used), precedes all other statements of a func-
tion declaration in Cicode, including the FUNCTION Statement.
The scope of a function can be either PRIVATE or PUBLIC, and is declared public by de-
fault. That is, if no Scope Statement is declared, the function will have public scope.
Both PRIVATE and PUBLIC are Cicode keywords and as such, are reserved.
A private scope function is only accessible (can be called) within the file in which it is de-
clared.
Public scope functions can be shared across Cicode files, and can be called from pages and
CitectSCADA databases (for example, Alarm.dbf).
41
Because functions are public by default, to make a function public requires no specific dec-
laration. To make a function private however, you must prefix the FUNCTION Statement
with the word PRIVATE.
PRIVATE
FUNCTION
FunctionName ( <Arguments> )
<Statement> ;
<Statement> ;
<Statement> ;
END
Declaring the Return Data Type

For information about the RETURN Statement, see the section titled Returning Values from
Functions.
The optional Return Data Type Statement of a function (if used), follows the optional Scope
Statement (if used), and precedes the FUNCTION Statement declaration in Cicode.
The return data type of a function can be only one of four possible data types: INT (32 bits),
REAL (32 bits), STRING (255 bytes), or OBJECT (32 bits). If no Return Data Type Statement
is declared, the function will not be able to return any type of data.
INT, REAL, STRING, and OBJECT are Cicode keywords and as such, are reserved.
Note: In the following function syntax example, every placeholder shown inside arrow
brackets ( <placeholder> ) should be replaced in the actual code with the value of the item
that it describes. The arrow brackets and the word they contain should not be included in
the statement, and are shown only for your information.
To declare the data type that will be returned to the calling code, prefix the FUNCTION
Statement with one of the Cicode data type keywords, in the <ReturnDataType> placehold-
er in the following example.
<ReturnDataType>
FUNCTION
<Statement> ;
<Statement> ;
<Statement> ;
END
The following example returns an integer of value 5:

INT
FUNCTION
<Statement> ;
INT Status = 5;
<Statement> ;
RETURN Status;
END
42
If the RETURN Statement within the function encounters a different data type to that de-
clared in the return data type statement, the value is converted to the declared return data
type.
In the example below, the variable Status is declared as a real number within the function.
However, Status is converted to an integer when it is returned to the caller, because the
data type of the return was declared as an integer type in the return data type statement:
INT ! declare return value as integer
FUNCTION
<Statement> ;
REAL Status = 5; ! declare variable as a REAL number
<Statement> ;
RETURN Status; ! returned as an integer number
END
If you do not specify a return data type, the function does not return a value.
Declaring Functions
The required FUNCTION Statement follows the optional Scope Statement (if used) and the
optional Return Data Type Statement (if used), and precedes all other statements of a func-
tion declaration in Cicode. Everything between it and the END Statement, contains the
function.
Both FUNCTION and END are Cicode keywords and, as such, are reserved.
You declare the start of a function with the FUNCTION Statement, and declare the end of
a function with the END Statement:
FUNCTION
<Statement> ;
<Statement> ;
<Statement> ;
END
The FUNCTION Statement must be followed by the Name Statement, then the Argument
Statement, before any code statements that will be processed by the function.
For information on the Name and Argument Statements, see the sections titled Naming Ar-
guments and Function Argument Structure.
All code (as represented by the <Statement> placeholders) located between the FUNCTION
and END Statements, will be executed (processed by the function) when called to do so.
Functions can execute a large variety of statements, and are commonly used to process and
manipulate data, including the arguments passed when the function was called, plant-floor
and other CitectSCADA data, Windows data, and so on. CitectSCADA provides many
built-in functions. For more information, see the section titled Working with Commonly
Used Functions.
43
Naming Functions
The required name statement follows the FUNCTION Statement and precedes the argu-
ments statement in a CitectSCADA function. The function name is used elsewhere in Cit-
ectSCADA to activate (call) the function to have it perform the statements it contains.
Replace the <FunctionName> placeholder in the following function example with an ap-
propriate name for your function. See the section Function Naming Standards for details.
FUNCTION
<Statement> ;
<Statement> ;
<Statement> ;
END
You can use up to 32 ASCII text characters to name your functions. You can use any valid
name except for a reserved word. The case is not important to the CitectSCADA compiler,
so you can use upper and lower case to make your names clear. For example, Mixer-
RoomPageDisplay is easier to read than mixerroompagedisplay or MIXERROOMPAGE-
DISPLAY.
FUNCTION
MixerRoomPageDisplay ( <Arguments> )
<Statement> ;
<Statement> ;
<Statement> ;
END
Your functions take precedence over any other entity in CitectSCADA with the same name:
 Variable tags. When you call a function by the same name as a variable tag, the function
has precedence. The variable tag can not be referred to because the function executes
each time the name is used.
 Built-in functions. You can give your function the same name as any built-in Cicode
function. Your function takes precedence over the built-in function - the built-in func-
tion cannot be called. Because built-in Cicode functions cannot be changed, this pro-
vides a method of ’modifying’ any built-in function to suit an application. For example,
you might want to display the message "Press F1 for Help" whenever you display a
page. You could simply write a new function called PageDisplay ( ). The body of the
function would be the statements that display the page and prompt message:
Prompt ( "Press F1 for Help" ) ;PageDisplay ( <Arguments> ) ;
Your function is invoked whenever you use the function name in CitectSCADA.
Function Argument Structure

The optional Arguments Statement follows the required FUNCTION Statement and pre-
cedes the executable statements of a function in Cicode.
Note: The maximum number of arguments you can have in a function is 128.
44
When you call a function, you can pass one or more arguments to the function, enclosed
within the parentheses ( ) located after the function name statement. Replace the <Argu-
ments> placeholder in the following function example with your Argument Statement.
FUNCTION
<Statement> ;
<Statement> ;
<Statement> ;
END
For your function to perform tasks with data, it requires accessibility to the data. One way
to achieve this, is to pass the data directly to the function when the function is being called.
To enable this facility, Cicode utilizes arguments in its function structure. An argument in
Cicode is simply a variable that exists in memory only as long as its function is processing
data, so the scope of an argument is limited to be local only to the function. Arguments can-
not be arrays.
Arguments are variables that are processed within the body of the function only. You can-
not use an argument outside of the function that declares it.
As arguments are variables used solely within functions, they must be declared just as you
would otherwise declare a variable in Cicode. See the section titled Declaring Variable
Properties. An argument declaration requires a data type, a unique name, and may contain
an initial value which also behaves as the default value for the argument.
Notes: In the following function syntax example:
 Every placeholder shown inside arrow brackets ( <placeholder> ) should be replaced in
any actual code with the value of the item that it describes. The arrow brackets and the
word they contain should not be included in the statement, and are shown here only for
your information.
Cicode function argument statements have the following syntax:
<ArgumentDataType>
<ArgumentName>
[ = <InitialDefaultValue> ]
where:
 <ArgumentDataType> = Argument Data Type Statement: required, INT or REAL or
STRING. See the section titledDeclaring Argument Data Type.
 <ArgumentName> = Argument Name Statement: required, up to 32 ASCII text charac-
ters, case insensitive, no spaces, no reserved words. See the section titled Naming Argu-
ments.
 <InitialDefaultValue> = Argument Initialization Statement: optional, preceded by
equals ( = ) assignment operator, a value to assign to the argument variable when first
initialized, must be the same data type as that declared in the argument <Argument-
DataType> parameter, defaults to this value if no value passed in for this argument
when the function was called.
See the section titled Setting Default Values for Arguments.
45
The Argument Statement in a Cicode function can have only one set of surrounding paren-
theses ( ), even if no arguments are declared in the function.
If more than one argument is used in the function, each must also be separated by a comma.
Argument Statements can be separated over several lines to aid in their readability.
When you call a function, the arguments you pass to it are used within the function to pro-
duce a resultant action or return a value. For information on passing data to functions, see
the section titled Passing Data to Functions (Arguments). For information on returning re-
sults from functions, see the section titled Returning Data from Functions.
Arguments are used in the function and referred to by their names. For instance, if we name
a function AddTwoIntegers, and declare two integers as arguments naming them FirstInt-
eger and SecondInteger respectively, we would end up with a sample function that looks
like the following:
INT
FUNCTION
AddTwoIntegers ( INT FirstInteger, INT SecondInteger )
INT Solution ;
Solution = FirstInteger + SecondInteger ;
RETURN Solution ;
END
In this example, the function would accept any two integer values as its arguments, add
them together, and return them to the caller as one integer value equal to the summed total
of the arguments values passed into the function.
This functionality of passing values into a function as arguments, manipulating the values
in some way, then being able to return the resultant value, is what makes functions poten-
tially very powerful and time saving. The code only needs to written once in the function,
and can be utilized any number of times from any number of locations in CitectSCADA.
Write once, use many.
Declaring Argument Data Type

If an argument is listed in a Cicode function declaration, the Argument Data Type State-
ment is required, and is listed first before the required Argument Name Statement and the
optional Argument Initialisation Statement.
The argument data type of a function can be only one of four possible data types: INT (32
bits), REAL (32 bits), STRING (255 bytes), or OBJECT (32 bits).
INT, REAL, STRING, and OBJECT are Cicode keywords and as such, are reserved.
 Every placeholder shown inside arrow brackets ( <placeholder> ) should be replaced
in any actual code with the value of the item that it describes. The arrow brackets and
the word they contain should not be included in the statement, and are shown here only
for your information.
46
To declare the argument data type that will be used in the function, you must prefix the
Argument Name Statement with one of the Cicode data type keywords, in the <Argument-
DataType> placeholder in the following example.
FUNCTION
FunctionName ( <ArgumentDataType> <ArgumentName> [ =
<InitialDefaultValue> ] )
<Statement> ;
<Statement> ;
<Statement> ;
END
The Argument Statement in a Cicode function must have only one set of surrounding pa-
rentheses ( ) brackets, even if no arguments are declared in the function.
If more than one argument is used in the function, each must also be separated by a comma.
Naming Arguments
If an argument is listed in a Cicode function declaration, the Argument Name Statement is
required, and is listed second, after the required Argument Data Type Statement, and be-
fore the optional Argument Initialization Statement.
The argument name is used only within the function to refer to the argument value that
was passed into the function when the function was called. The name of the argument vari-
able should be used in the executable statements of the function in every place where you
want the argument variable to be used by the statement.
Replace the <ArgumentName> placeholder in the following function example with an ap-
propriate name for your Argument variable. See the section titled Function Argument
Structure for details.
FUNCTION
FunctionName ( <ArgumentDataType> <ArgumentName> [ = <InitialDefaultValue> ] )
<Statement> ;
<Statement> ;
<Statement> ;
END
You can use up to 32 ASCII text characters to name your arguments. You can use any valid
name except for a reserved word. The case is not important to the CitectSCADA compiler,
so you can use upper and lower case to make your names clear. For example, iPacketQnty
is easier to read than ipacketqnty or IPACKETQNTY .
47
FUNCTION
FunctionName ( INT iPacketQnty )
<Statement> ;
<Statement> ;
<Statement> ;
END
To refer to the argument (in the body of your function) you use the name of the argument
in an executable statement:
INT
FUNCTION
AddTwoIntegers ( INT FirstInteger, INT SecondInteger )
INT Solution ;
Solution = FirstInteger + SecondInteger ;
RETURN Solution ;
END
Setting Default Values for Arguments

If an argument is listed in a Cicode function declaration, the Argument Initialisation State-
ment is optional, and if used, is listed last in the Argument Statement after the required Ar-
gument Data Type and the Argument Name Statements. The Argument Initialization
Statement must be preceded by an equals ( = ) assignment operator.
Replace the <InitialDefaultValue> placeholder in the following function example with an
appropriate value for your Argument variable.
FUNCTION
FunctionName ( <ArgumentDataType> <ArgumentName> [ =
<InitialDefaultValue> ] )
<Statement> ;
<Statement> ;
<Statement> ;
END
The default value for an argument must be of the same data type as declared for the argu-
ment in the Argument Data Type Statement.
You assign a default argument variable value in the same manner that you assign a Cicode
variable value, by using the equals ( = ) assignment operator. For example:
FUNCTION
PlotProduct ( INT iPackets = 200 , STRING sName = "Packets" )
48
<Statement> ;
<Statement> ;
<Statement> ;
END
If you assign a default value for an argument, you do not have to pass a value for that ar-
gument when you call the function, (because the function will use the default value from
the declaration.) To pass an empty argument to a function, omit any value for the argument
in the call. For example, to call the PlotProduct function declared in the previous example,
and accept the default string value of "Packets", a Cicode function call would look like:
PlotProduct ( 500 , )
Notice that the second argument for the function was omitted from the calling code. In this
instance, the default value for the second argument ( "Packets" ) would remain unchanged,
and so would be used as the second argument value in this particular function call.
If you do call that function and pass in a value for that argument in the call, the default val-
ue is replaced by the argument value being passed in. However, the arguments are reini-
tialized every time the function is called, so each subsequent call to the function will restore
the default values originally declared in the function.
If more than one argument is used in a function, each must also be separated by a comma.
Equally, if a function containing more than one argument is called, each argument must be
accounted for by the caller. In this case, if an argument value is to be omitted from the call,
(to utilise the default value), comma placeholders must be used appropriately in the call to
represent the proper order of the arguments.
For more information on function calls, callers, and calling, see the section titled Calling
Functions from Commands and Expressions.
Returning Values from Functions

Most built-in Cicode functions supplied with CitectSCADA return a data value to their call-
ing statement. Mathematical functions return a calculated value. The Date ( ) and Time ( )
functions return the current date and time. Other functions, like PageDisplay ( ), perform
an action, and return a value indicating either the success of the action or the type of error
that occurred.
You can also use return values in your own functions, to return data to the calling state-
ment. The return value is assigned in the RETURN Statement:
The optional RETURN Statement of a function (if used), must be placed in the executable
Statements section of a Cicode function between the FUNCTION and END Statements. Be-
cause the RETURN Statement is used to return data values that have usually been manip-
ulated by the function, they are usually placed last just before the END Statement.
<ReturnDataType>
FUNCTION
<Statement> ;
<Statement> ;
49
<Statement> ;
END
The RETURN Statement consists of the RETURN keyword followed by a value to be re-
turned and finished with the semicolon (;) end-of-line marker.
The RETURN value must be of the same data type as was declared in the Return Data Type
Statement at the start of the function declaration. The return data type of a function can be
only one of four possible data types: INT (32 bits), REAL (32 bits), STRING (255 bytes), or
OBJECT (32 bits). If no Return Data Type Statement is declared, the function will not be able
to return any type of data.
If the RETURN Statement within the function encounters a different data type to that de-
clared in the Return Data Type Statement, the value is converted to the declared return data
type. For information about the Return Data Type Statement, see the section titled Declar-
ing the Return Data Type.
FUNCTION, INT, REAL, STRING, and OBJECT are Cicode keywords and as such, are re-
served.
Note: In the following function syntax example every placeholder shown inside arrow
brackets ( <placeholder> ) should be replaced in any actual code with the value of the item
that it describes. The arrow brackets and the word they contain should not be included in
the statement, and are shown here only for your information.
To declare the value that will be returned to the calling code, you must replace the <Return-
Value> placeholder in the following example with an appropriate data value to match the
Return Data Type as declared in the function.
<ReturnDataType>
FUNCTION
<Statement> ;
<Statement> ;
END
The following example returns an integer of value 5:

INT
FUNCTION
<Statement> ;
INT Status = 5;<Statement> ;
RETURN Status;END
The RETURN statement passes a value back to the calling procedure (either another func-
tion, command or expression). Outside of the function, the return value can be read by the
calling statement. For example, it can be used by the caller as a variable (in a command), or
animated (in an expression).
50
Chapter: 7 Using Variables
A variable is a named location in the computer’s memory where data can be stored. Cicode
variables can store the basic data types (such as strings, integers, and real numbers) and
each variable is specific for its particular data type. For example, if you set up a Cicode vari-
able to store an integer value, you cannot use it for real numbers or strings.
Note: Each data type uses a fixed amount of memory: integers use 4 bytes of memory, real
numbers use 4 bytes, and strings use 1 byte per character. PLC INT types use only 2 bytes.
The computer allocates memory to variables according to the data type and the length of
time you need the variable to be stored.
Real-time variables (such as PLC variables) are already permanently stored in database
files on your hard disk. Any variable you use in a database field command or expression
must be defined as a variable tag, or the compiler will report an error when the system is
compiled.
Note: Cicode variables can handle a wide range of CitectSCADA variable tag data types.
For example, a Cicode variable of INT data type can be used to store I/O device data types:
BCD, BYTE, DIGITAL, INT, LONG, LONGBCD, and UINT.
See Also
Using Arrays
Variable Declaration Standards
Variable Naming Standards
Variable Scope Standards
Using Cicode Files
Declaring Variable Properties

You must declare each variable used in your functions (except for variables that are config-
ured as variable tags). In the declaration statement, you specify the name and data type of
the variable. You can also set a default value for the variable.
Declaring the Variable Data Type

You can use variables of the following data types:
INT Integer (32 bits) -2,147,483,648 to
2,147,483,647
REAL Floating point (32 bits) -3.4E38 to 3.4E38
STRING Text string (128 bytes maximum, including null ASCII (null terminated)
termination character)
OBJECT ActiveX control
If you want to specify a digital data type, use the integer type. Digital types can either be
TRUE(1) or FALSE(0), as can integer types.
51
Note: Cicode may internally store floating point values as 64 bit to minimize the loss of data
during floating point calculations.
Naming Variables
Throughout the body of the function, the variable is referred to by its name. You can name
a variable any valid name except for a reserved word, for example:
STRING sStr;
REAL Result;
INT x, y;
OBJECT hObject;
The first 32 characters of a variable name must be unique.

See Also
Setting Default Variable Values

When you declare variables, you can set them to an initial (startup) value; for example:
STRING Str = "Test";
REAL Result = ;
INT x = 20, y = 50;
Using Variable Scope

Scope refers to the accessibility of a function and its values. A Cicode variable can be de-
fined as any one of three types of scope - global, module, and local. By default, Cicode vari-
ables are module scope, unless they are declared within a function.
All variables have the following format:
DataType Name [=Value];
Global variables
A global Cicode variable can be shared across all Cicode files in the system (as well as
across include projects). They cannot be accessed on pages or databases (for example,
Alarm.dbf).
Global Cicode variables are prefixed with the keyword GLOBAL, and must be declared at
the start of the Cicode file. For example:
GLOBAL STRING sDefaultPage = "Mimic";
INT
FUNCTION
MyPageDisplay(STRING sPage)
INT iStatus;
iStatus = PageDisplay(sPage);
IF iStatus <> 0 THEN
52
PageDisplay(sDefaultPage);
END
RETURN iStatus;
END
The variable sDefaultPage could then be used in any function of any Cicode file in the sys-
tem.
Note: Use global variables sparingly if at all. If you have many such variables being used
by many functions, finding bugs in your program can become time consuming. Use local
variables wherever possible. Global Cicode STRING types are only 128 bytes, instead of 256
bytes.
Module variables
A module Cicode variable is specific to the file in which it is declared. This means that it
can be used by any function in that file, but not by functions in other files.
By default, Cicode variables are defined as module, therefore prefixing is not required
(though a prefix of MODULE could be added if desired). Module variables should be de-
clared at the start of the file. For example:
STRING sDefaultPage = "Mimic";
INT
FUNCTION
MyPageDisplay(STRING sPage)
INT Status;
Status = PageDisplay(sPage);
IF Status <> 0 THEN
END
RETURN Status;
END
INT
FUNCTION
DefaultPageDisplay()
END
Note: Use module variables sparingly if at all. If you have many such variables being used
by many functions, finding bugs in your program can become time-consuming. Use local
variables wherever possible.
Local variables
A local Cicode variable is only recognized by the function within which it is declared, and
can only be used by that function. You must declare local variables before you can use
them.
Any variable defined within a function (that is, after the function name) is a local variable,
therefore no prefix is needed. Local variables are destroyed when the function exits.
Local variables always take precedence over global and module variables. If you define a
local variable in a function with the same name as a global or module variable, the local
variable is used; the global/module variable is unaffected by the function. This situation
should be avoided, however, as it is likely to cause confusion.
53
See Also
Using Database Variables

You can use any variable that you have defined in the database (with the Variable Tags
form) in your functions. To use a database variable, specify the tag name:
<Tag>
where Tag is the name of the database variable. For example, to change the value of the da-
tabase variable "LT131" at run time, you would use the following statement in your func-
tion:
LT131=1200; !Changes the value of LT131 to 1200
54
Chapter: 8 Using Arrays
A Cicode variable array is a collection of Cicode variables of the same data type, in the form
of a list or table. You name and declare an array of variables in the same way as any other
Cicode variable. You can then refer to each element in the array by the same variable name,
with a number (index) to indicate its position in the array.
See Also
Declaring Array Properties
Declaring the Array Data Type
Naming Arrays
Declaring the Variable Array Size
Setting Default (Initial) Array Values
Passing Array Elements as Function Arguments
Using One-dimensional Arrays
Using Two-dimensional Arrays
Using Three-dimensional Arrays
Using Array Elements in Loops
Using the Table (Array) Functions
Using Cicode Files
Declaring Array Properties

Arrays have several properties that you must declare to the compiler along with the array
name: data type, size and dimension. You can also set default values for individual ele-
ments of the array. An array declaration has the following syntax:
DataType Name[Dim1Size,{Dim2Size},{Dim3Size}]{=Values};
See Also
Using Arrays
Using Cicode Files
Declaring the Array Data Type

As with any other Cicode variable, arrays can have four Data Types:
INT Integer (32 bits)
REAL Floating point (32 bits)
STRING Text string (255 bytes)
55
OBJECT ActiveX object (32 bits)
See Also
Using Arrays
Using Cicode Files
Naming Arrays
Throughout the body of a Cicode function, a Cicode variable array is referred to by its
name, and individual elements of an array are referred to by their index. The index of the
first element of an array is 0 (that is a four element array has the indices 0,1,2, and 3). You
can name a variable any valid name except for a reserved word; for example:
STRING StrArray[5]; ! list
REAL Result[5][2]; ! 2-D table
INT IntArray[4][3][2]; ! 3-D table
See Also
Using Arrays
Using Cicode Files
Declaring the Variable Array Size

You must declare the size of the array (the number of elements the array contains), for ex-
ample:
STRING StrArray[5];
This single dimension array contains 5 elements. The compiler multiplies the number of el-
ements in the array by the size of each element (dependent upon the Data Type), and allo-
cates storage for the array in consecutive memory locations.
You cannot declare arrays local to a function. However, they can be declared as Module
(that is at the beginning of the Cicode file), or Global. When referring to the array within
your function, you must not exceed the size you set when you declared the array. The ex-
ample below would cause an error:
STRINGStrArray[5];
...
StrArray[10] = 100;
...
The compiler allows storage for 5 strings. By assigning a value to a 10th element, you cause
a value to be stored outside the limits of the array, and you could overwrite another value
stored in memory.
See Also
Using Arrays
Using Cicode Files
56
Setting Default (Initial) Array Values

When you declare an array, you can (optionally) set the individual elements to an initial (or
start-up) value within the original declaration statement. For instance, naming a string ar-
ray "ArrayA", sizing it to hold 5 elements, and initializing the array with string values,
would look like the following example:
STRING ArrayA[5]="This","is","a","String","Array";
This array structure would contain the following values:

ArrayA[0]="This"
ArrayA[1]="is"
ArrayA[2]="a"
ArrayA[3]="String"
ArrayA[4]="Array"
See Also
Using Arrays
Using Cicode Files
Passing Array Elements as Function Arguments

To pass a Cicode variable array element to a Cicode function, you must provide the ele-
ment’s address; for example:
/* Pass the first element of ArrayA. */
MyFunction (ArrayA[0])
/* Pass the second element of ArrayA. */
/* Pass the fifth element of ArrayA. */
See Also
Using Arrays
Using Cicode Files
Using One-dimensional Arrays

To use a one-dimensional array:
This array sets the following values:
ArrayA[0]="This"
ArrayA[1]="is"
ArrayA[2]="a"
ArrayA[3]="String"
ArrayA[4]="Array"
57
See Also
Using Arrays
Using Cicode Files
Using Two-dimensional Arrays

To use a two-dimensional array:
REAL ArrayA[5][2]=1,2,3,4,5,6,7,8.3,9.04,10.178;

ArrayA[0][0]=1 ArrayA[0][1]=2
ArrayA[3][0]=7 ArrayA[3][1]=8.3
ArrayA[4][0]=9.04 ArrayA[4][1]=10.178
See Also
Using Arrays
Using Cicode Files
Using Three-dimensional Arrays

To use a three-dimensional array:
INT ArrayA[4][3][2]=1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,
16,17,18,19,20,21,22,23,24;

ArrayA[0][0][0]=1 ArrayA[0][0][1]=2 ArrayA[0][1][0]=3
You use arrays in your functions in the same way as other variables, but arrays have special
properties that, in many situations, reduce the amount of code you must write.
See Also
Using Arrays
Using Cicode Files
58
Using Array Elements in Loops

You can set up loops that deal efficiently with arrays by incrementing the index number.
The following example shows a method of initializing an array:
REAL Array[10]
:
FOR Counter = 0 TO 9 DO
Array[Counter] = 0
END
RETURN Total
:
See Also
Working with Conditional Executors
Using Arrays
Using Cicode Files
Using the Table (Array) Functions

Cicode has built-in functions for processing Cicode variable arrays:
 To perform calculations (max, min, total, etc.) on array elements.
 To look up the index number of an array element.
 To shift the elements of an array left or right.
See Also
Table (Array) Functions
Using Arrays
Using Cicode Files
59
60
Chapter: 9 Using Cicode Macros
Cicode has the following macros:
 IFDEF: Determines one of two possible outcomes based on the existence of a specified
non-alarm tag at compile time. Use one of the macros below for alarm tags.
 IFDEFAdvAlm: Determines one of two possible outcomes based on the existence of a
specified advanced alarm tag at compile time.
 IFDEFAnaAlm: Determines one of two possible outcomes based on the existence of a
specified analog alarm tag at compile time.
 IFDEFDigAlm: Determines one of two possible outcomes based on the existence of a
specified digital alarm tag at compile time.
IFDEF
The IFDEF macro allows you to define two possible outcomes based on whether or not a
specified tag exists within a project at the time of compiling. The macro can be implement-
ed anywhere a simple expression is used, including fields within relevant CitectSCADA di-
alogs.
The macro was primarily created to avoid the "Tag not found" compile error being gener-
ated whenever a genie was missing an associated tag. By allowing a "0" or "1" to be gener-
ated within the Hidden When field of a Genie’s properties, elements could simply be
hidden if a required tag was missing, allowing the genie to still be pasted onto a graphics
page.
The macro accepts three arguments: the first specifies the tag that requires confirmation,
the second defines the outcome if the tag exists, the third defines the outcome if it does not
exist. In the case of a genie being pasted on a graphics page, the IFDEF function would be
configured as follows in the Hidden When field of the object properties dialog:
IFDEF("Bit_1",0,1)
If the tag "Bit_1" is defined in the tag database, the value in the Hidden When field will be
0. If Bit_1 is undefined, the value will be 1. Since the object is hidden when the value is
TRUE (1), the object will be hidden when Bit_1 is undefined. See Hiding Graphics Objects
for details.
Beyond this purpose, the IFDEF macro can be broadly used as a conditional variable. The
[<value if defined>] and <value if not defined> arguments can support any variable, expres-
sion, or constant. The [<value if defined>] argument is optional; if you leave it blank it will
generate the current variable. You can also use nested IFDEF macros.
Note: As different types of alarms can share the same name, you have to use a variation of
IFDEF to check for the existence of alarm tags. See IFDEFAnaAlm for analog alarms, IF-
DEFDigAlm for digital alarms, or IFDEFAdvAlm for advanced alarms.
Syntax
IFDEF(TagName, [<value if defined>], <value if not defined>)
61
Return Value
If the tag specified in the first argument exists, the value defined by the second argument
is returned. This could be a variable, expression, or constant, or the current tag value if the
argument has been left blank. If the specified tag does not exist, the variable, expression, or
constant defined by the third argument is returned.
Example
! Generate the tag value if tag "Bit_1" is defined
! Generate an empty string if "Bit_1" is not defined
IFDEF("Bit_1",," ")
! Generate a zero value (0) if tag "Bit_1" is defined
! Generate a true value (1) if "Bit_1" is not defined
IFDEF("Bit_1",0,1)
For more examples of how to implement the IFDEF macro, see the CitectSCADA Knowl-
edge Base article Q3461.
See Also
IFDEFAnaAlm, IFDEFDigAlm, IFDEFAdvAlm, Hiding Graphics Objects, IFDEF macro
IFDEFAdvAlm
Based on the IFDEF macro, IFDEFAdvAlm allows you to define two possible outcomes
based on whether or not a specified advanced alarm tag exists within a project at the time
of compiling. The macro can be implemented anywhere a simple expression is used, in-
cluding fields within relevant CitectSCADA dialogs.
The macro accepts three arguments: the first specifies the advanced alarm tag that requires
confirmation, the second defines the outcome if the alarm exists, the third defines the out-
come if it does not exist.
IFDEF to check for the existence of alarm tags. See IFDEFAnaAlm for analog alarms, or IF-
DEFDigAlm for digital alarms.
Syntax
IFDEFAdvAlm(TagName, [<value if defined>], <value if not defined>)
Return Value
If the advanced alarm tag specified in the first argument exists, the value defined by the
second argument is returned. This could be a variable, expression, or constant, or the cur-
rent tag value if the argument has been left blank. If the specified alarm does not exist, the
variable, expression, or constant defined by the third argument is returned.
Example
! Generate tag value if advanced alarm "AdvAlarm_1" is defined
! Generate an empty string if "AdvAlarm_1" is not defined
IFDEFAdvAlm("AdvAlarm_1",,"")
! Generate a zero value (0) in Hidden When field if advanced alarm
"AdvAlarm_1" is defined
! Generate a true value (1) in Hidden When field if "AdvAlarm_1"
is not defined
IFDEFAdvAlm("AdvAlarm_1",0,1)
62
See Also
IFDEFAnaAlm, IFDEFDigAlm, IFDEF
IFDEFAnaAlm
Based on the IFDEF macro, IFDEFAnaAlm allows you to define two possible outcomes
based on whether or not a specified analog alarm tag exists within a project at the time of
compiling. The macro can be implemented anywhere a simple expression is used, includ-
ing fields within relevant CitectSCADA dialogs.
The macro accepts three arguments: the first specifies the analog alarm tag that requires
IFDEF to check for the existence of alarm tags. See IFDEFDigAlm for digital alarms, or IF-
DEFAdvAlm for advanced alarms.
Syntax
IFDEFAnaAlm(TagName, [<value if defined>], <value if not defined>)
Return Value
If the analog alarm tag specified in the first argument exists, the value defined by the sec-
ond argument is returned. This could be a variable, expression, or constant, or the current
tag value if the argument has been left blank. If the specified alarm does not exist, the vari-
able, expression, or constant defined by the third argument is returned.
See Also
IFDEF, IFDEFDigAlm, IFDEFAdvAlm
Example
! Generate tag value if analog alarm "AnaAlarm_1" is defined
! Generate an empty string if "AnaAlarm_1" is not defined
IFDEFAnaAlm("AnaAlarm_1",,"")
! Generate a zero value (0) in Hidden When field if analog alarm
"AnaAlarm_1" is defined
! Generate a true value (1) in Hidden When field if "AnaAlarm_1"
is not defined
IFDEFAnaAlm("AnaAlarm_1",0,1)
For further examples of how to implement the IFDEF macro, see the CitectSCADA Knowl-
See Also
IFDEF, IFDEFDigAlm, IFDEFAdvAlm
IFDEFDigAlm
Based on the IFDEF macro, IFDEFDigAlm allows you to define two possible outcomes
based on whether or not a specified digital alarm tag exists within a project at the time of
63
compiling. The macro can be implemented anywhere a simple expression is used, includ-
ing fields within relevant CitectSCADA dialogs.
The macro accepts three arguments: the first specifies the digital alarm tag that requires
IFDEF to check for the existence of alarm tags. See IFDEFAnaAlm for analog alarms or IF-
DEFAdvAlm for advanced alarms.
Syntax
IFDEFDigAlm(TagName, [<value if defined>], <value if not defined>)
Return Value
If the digital alarm tag specified in the first argument exists, the value defined by the second
argument is returned. This could be a variable, expression, or constant, or the current tag
value if the argument has been left blank. If the specified alarm does not exist, the variable,
expression, or constant defined by the third argument is returned.
Example
! Generate tag value if digital alarm "DigAlarm_1" is defined
! Generate an empty string if "DigAlarm_1" is not defined
IFDEFDigAlm("DigAlarm_1",,"")
! Generate a zero value (0) in Hidden When field if digital alarm
"DigAlarm_1" is defined
! Generate a true value (1) in Hidden When field if "DigAlarm_1"
is not defined
IFDEFDigAlm("DigAlarm_1",0,1)
Related macros
IFDEFAnaAlm, IFDEFAdvAlm, IFDEF
Macro Arguments
The Cicode macros use the following arguments.
 TagName
 [<value if defined>]
 <value if not defined>
TagName
The name of the tag you would like the IFDEF macro to confirm the existence of. The Cit-
ectSCADA compiler will check the current project database for a tag matching this name.
[<value if defined>]
Defines the outcome of the macro if the specified tag exists in the current project. This ar-
gument is optional, which means you can:
 Generate any variable, constant, or expression.
 Generate the current value for the specified tag by leaving the argument blank.
64
<value if not defined>

Defines the outcome of the macro if the specified tag does not exist in the current project.
This will generate any variable, constant, or expression, including a blank string (" ") if you
want nothing to be presented.
65
66
Chapter: 10 Converting and Formatting Cicode Vari-
ables
CitectSCADA provides four functions for converting integers and real numbers into
strings, and vice versa.
 IntToStr: converts an integer variable into a string
 RealToStr: converts a floating-point variable into a string
 StrToInt: converts a string into an integer variable
 StrToReal: converts a string into a floating-point variable
You can convert data types without using these Cicode functions, but the result of the for-
mat conversion might not be what you expect. If you want more control over the conver-
sion process, use the appropriate Cicode functions.
Note: Variables of type object cannot be converted to any other type.
When variables are automatically converted, or when the return value from a function call
is converted, specific rules apply.
See Also
Converting Variable Integers to Strings
Converting Real Numbers to Strings
Converting Strings to Integers
Converting Strings to Real Numbers
Formatting Text Strings
Escape Sequences (String Formatting Commands)
Using Cicode Files
Converting Variable Integers to Strings

To convert an integer variable to a string:
IntVar=5;
StringVar=IntVar;
The value of StringVar is set to "5".

The format of the string is specified when the variable is defined in the database. However
you can override this default format with the string format (:) operator, and use the # for-
mat specifier to set a new format. For example:
IntVar=5;
StringVar=IntVar:####
The value of StringVar = " 5". (The ’#’ formatting characters determine the size and number
of decimal places contained in the string, that is a length of 4 with no decimal places.)
67
Chapter: 10 Converting and Formatting Cicode Variables
See Also
Converting and Formatting Cicode Variables
Using Cicode Files
Converting Real Numbers to Strings

To convert a real number variable to a string:
RealVar=5.2;
StringVar=RealVar;
The value of StringVar is set to "5.2".

Note: Unpredictable results may occur if you use large numbers with a large number of
decimal places.
The format of the string is specified when the variable is defined in the database. However
you can override this default format with the string format (:) operator, and use the # for-
mat specifier to set a new format. For example:
StrTag1=RealTag1:######.###
The value of StringVar = " 5.200". (The ’#’ formatting characters determine the size and
number of decimal places contained in the string, that is a length of 10 including a decimal
point and three decimal places.)
See Also
Using Cicode Files
Converting Strings to Integers

To convert a string variable to an integer:
StringVar="50.25";
IntVar=StringVar;
The value of IntVar is set to 50. If StringVar contains any characters other than numeric
characters, IntVar is set to 0.
See Also
Using Cicode Files
Converting Strings to Real Numbers

To convert a string variable to a real number:
68
StringVar="50.25";
RealVar=StringVar;
The value of RealVar is set to 50.25. If StringVar contains any characters other than numeric
characters, RealVar is set to 0.
See Also
Using Cicode Files
Formatting Text Strings

A string in Cicode is always represented as text positioned between double quote ( " ) de-
limiters. For example:
"This is my text string."
A string value can be assigned to a string variable. For example:

STRING sMyStringVariable;
sMyStringVariable = "This is my text string.";
More than one string can be joined together (concatenated) using the Cicode ’plus’ mathe-
matical operator ( + ). For example:
sMyStringVariable = "This is my text string." + "This is my second
text string.";
The two strings would be joined together and assigned to the string variable sMyString-
Variable. However, if subsequently displayed somehow, like in the following MESSAGE
example, the concatenated string would look wrong because there is no space character po-
sitioned between the string sentences.
sMyStringVariable = "This is my text string." + "This is my second
text string.";
MESSAGE("String Concatenation Example",sMyStringVariable,32);
69
To overcome this potential formatting problem, you could include an extra space as the last
character in the strings, or include the space as a third string in the concatenation. For ex-
ample:
sMyStringVariable = "This is my text string. " + "This is my
second text string. ";
or
sMyStringVariable = "This is my text string." + " " + "This is my
second text string. ";
However, these are considered poor programming practices and not recommended. In-
stead, you can use special string formatting commands known as escape sequences.
If the two strings (as used in the previous example), were formatted using appropriate es-
cape sequences positioned within the strings, and subsequently displayed somehow, like
in the following MESSAGE example, the concatenated string would look different, For ex-
ample:
STRING sNewLine = "^n";
sMyStringVariable = "This is my text string." + sNewLine + "This
is my second text string.";
MESSAGE("String Concatenation Example",sMyStringVariable,32);
Strings and string variables can also be concatenated as in the previous example. Notice
how the newline escape sequence ( ^n ) was assigned to the string variable sNewLine, and
how this value was concatenated between the other strings and assigned to the string vari-
able sMyStringVariable for display in the MESSAGE function.
See Also
Using Cicode Files
Escape Sequences (String Formatting Commands)

Cicode supports several escape sequences that you can use in text strings for custom for-
matting of the string. By using the appropriate Cicode escape sequences listed below you
70
can format the string display to do such things as break into separate lines at specific posi-
tions, insert tab spaces, insert quotes, or to display Hexadecimal numbers.
All Cicode escape sequences are preceded by a caret ( ^ ) character. The caret character is
interpreted as a special instruction, and together with the characters immediately following
it, are treated as an Cicode escape sequence formatting command. The escape sequences
used in Cicode are:
^b backspace
^f form feed
^n new line
^t horizontal tab
^v vertical tab
^’ single quote
^" double quote
^^ caret
^r carriage return
^0xhh where hh is a hexadecimal number (for example, ^0x1A)
See Also
Using Cicode Files
71
72
Chapter: 11 Working with Operators
With Cicode, you can use the data operators that are standard in most programming lan-
guages: mathematical, bit, relational, and logical operators.
See Also
Using Mathematical Operators
Using Bit Operators
Using Relational Operators
Using Logical Operators
Order of Precedence of Operators
Using Mathematical Operators

Standard mathematical operators allow you to perform arithmetic calculations on numeric
variables - integers and floating point numbers.
Operator Description
+ Addition
- Subtraction
* Multiplication
/ Division
MOD Modulus (Remainder)
Example
The following are examples of mathematical operators
Command PV12 = PV10 + PV11;
Comment PV12 is the sum of PV10 and PV11
Command Counter = Counter - 1;
Comment The value of Counter is decreased by 1
Command PV12 = Speed * Counter;
Comment PV12 is the product of Speed and Counter
Command Average = Total / ShiftHrs;
Comment Average is Total divided by ShiftHrs
Command Hold = PV12 MOD PV13;
Comment If PV12 = 10 and PV13 = 8, Hold equals 2 (the remainder when PV12 is
divided by PV13)
Command Hold = PV12 MOD PV13;
Comment If PV12 = 10 and PV13 = 8, Hold equals 2 (the remainder when PV12 is
divided by PV13)
Note: Cicode uses the standard order of precedence, that is multiplication and division are
calculated before addition and subtraction. In the statement A=1+4/2, 4 is divided by 2 be-
73
fore it is added to 1, and the result is 3. In the statement A=(1+4)/2 , 1 is first added to 4 be-
fore the division, and the result is 2.5.
You can also use the addition operator (+) to concatenate (join) two strings.
+ Concatenate
Command Message = "For info see " + "Supervisor";

Comment Message now equals "For info see Supervisor"
For example:
See Also
Working with Operators
Using Cicode Files
Using Bit Operators

With a bit operator, you can compare the corresponding bits in two numeric expressions.
(A bit is the smallest unit of data a computer can store.)
BITAND AND
BITOR OR
BITXOR Exclusive OR
For example
Command Tag3 = Tag1 BITAND Tag2;
Command Tag3 = Tag1 BITAND 0xFF;
Command Tag3 = Tag1 BITOR Tag2;
Command Tag3 = Tag1 BITXOR Tag2;
See Also
Using Cicode Files
Using Relational Operators

Relational operators describe the relationship between two values. The relationship is ex-
pressed as one value being larger than, the same as, or smaller than another. You can use
relational operators for both numeric and string variables, however you can only test vari-
ables of the same type. A numeric variable cannot be compared with a string variable.
= Is equal to
<> Is not equal to
< Is less than
> Is greater than
<= Is less than or equal to
74
>= Is greater than or equal to
For example:
Command IF Message = "Alarm Active" THEN ...
Expression PV12 <> PV10;
Command IF (Total + Count) / Avg < 10 THEN ...
Expression Counter > 1;
Command IF PV12 <= PV10 THEN ...
Expression Total >= Shift * Hours;
See Also
Using Cicode Files
Using Logical Operators

With logical operators, you can test several conditions as either TRUE or FALSE.
AND Logical AND
OR Logical OR
NOT Logical NOT
Examples:
Command Result = (PV12 = 10 AND PV13 = 2);
Comment If PV12 equals 10 and PV13 equals 2 then Result is TRUE(1)
Expression Motor_1 AND Motor_2;
Comment If both Motor_1 and Motor_2 are TRUE, that is Digital bits are 1 or ON,
then the expression is TRUE
Expression PV12 = 1 OR PV13 > 2 OR Counter <> 0;
Comment If either PV12 equals 1 or PV13 is greater than 2 or Counter is not equal
to 0, then the expression is TRUE
Command Result = (Motor1_Ol OR Motor2_Ol);
Comment If either Motor1_Ol or Motor2_Ol is TRUE, that is Digital bit is 1 or ON,
then Result is TRUE (1)
Command IF NOT PV12 = 10 THEN ...
Comment If PV12 does not equal 10 then the result is TRUE. This is functionally
identical to IF PV12 <> 10 THEN . . .
Expression NOT Tag_1;
Comment This expression is TRUE if Tag_1 = 0. This is most commonly used for
testing digital variables
See Also
Using Cicode Files
75
Order of Precedence of Operators

The table below shows the order of precedence of operators.
All operators have a set of rules that govern the order in which operations are performed.
These rules are called the order of precedence. The precedence of Cicode operators from
highest to lowest is:
1. ()
2. NOT
3. *, /, MOD
4. :
5. +, -
6. >, <, <=, >=
7. =, <>
8. AND
9. OR
10. BITAND, BITOR, BITXOR
See Also
Using Cicode Files
76
Chapter: 12 Working with Conditional Executors
The statements that control decisions and loops in your functions are called conditional ex-
ecutors. Cicode uses four conditional executors: If, For, While, and select case.
See Also
Formatting Executable Statements
Setting IF ... THEN Conditions
Using FOR ... DO Loops
Using WHILE ... DO Conditional Loops
Using the SELECT CASE statement
Using Cicode Files
Setting IF ... THEN Conditions

The IF statement executes one or more statements based on the result of an expression. You
can use If in one of two formats: If Then and If Then Else.
If Expression Then
Statement(s);
END
-or-
If Expression Then
Statement(s);
Else
Statement(s);
END
When you use the If Then format, the statement(s) following are executed only if the ex-
pression is TRUE, for example:
INT Counter;
IF PV12 = 10 THEN
Counter = Counter + 1;
END
In this example, the Counter increments only if the tag PV12 is equal to 10, otherwise the
value of Counter remains unchanged. You can include several statements (including other
IF statements), within an IF statement, for example:
INT Counter;
IF PV12 = 10 THEN
IF Counter > 100 THEN
Report("Shift");
END
END
77
In this example, the report runs when the Counter increments, that is when PV12 = 10, and
the value of the counter exceeds 100.
You can use the If Then Else format for branching. Depending on the outcome of the ex-
pression, one of two actions are performed, for example:
INT Counter;
IF PV12 = 10 THEN
Report("Shift");
ELSE
END
In this example, the report runs if PV12 is equal to 10 (TRUE), or the counter increments if
PV12 is anything but 10 (FALSE).
See Also
Using FOR ... DO Loops

A For loop executes a statement or statements a specified number of times.
FOR Variable=Expression To Expression DO
Statement(s);
END
The following function uses a For loop:

INT
FUNCTION
DisplayArray()
INT Counter;
FOR Counter = 0 TO 4 DO
Prompt(ArrayA[Counter]);
Sleep(15);
END
END
This function displays the single message "This is a String Array" on the screen one word
at a time pausing for 15 seconds between each word.
See Also
Using WHILE ... DO Conditional Loops

A While loop executes a statement or statements in a loop as long as a given condition is
true.
78
WHILE Expression DO
Statement(s);
END
The following code fragment uses a WHILE loop:

INT Counter;
WHILE DevNext(hDev) DO
END
/* Count the number of records in the device (hDev)*/
Be careful when using WHILE loops in your Cicode functions: WHILE loops can cause ex-
cessive loading of the CPU and therefore reduce system performance. If you use a WHILE
loop to loop forever, you should call the Cicode function Sleep() so that CitectSCADA can
schedule other tasks. The Sleep() function increases the performance of your CitectSCADA
system if you use many WHILE loops.
See Also
Nested Loops
You can "nest" one loop inside the other. That is, a conditional statement can be placed com-
pletely within (nested inside) a condition of another statement.
See Also
Using the SELECT CASE statement

The select case statement executes on several groups of statements, depending on the result
of an expression. SELECT CASE statements are a more efficient way of writing code that
would otherwise have to be done with nested IF THEN statements.
SELECT CASE Expression
CASE CaseExpression1,CaseExpression2
Statement(s);
CASE CaseExpression3 TO CaseExpression4
Statement(s);
CASE IS >CaseExpression5,IS<CaseExpression6
Statement(s);
CASE ELSE
Statement(s);
END SELECT
Where CaseExpressionn is any one of the following forms:

- expression
- expression TO expression
79
Where the TO keyword specifies an inclusive range of values. The smaller value must be
placed before TO.
- IS <relop> expression.
Use the IS keyword with relational operators (<relop>). Relational operators that may be
used are <, <=, =, <>, >, >= .
If the Expression matches any CaseExpression, the statements following that CASE clause
are executed up to the next CASE clause, or (for the last clause) up to the END SELECT. If
the Expression matches a CaseExpression in more than one CASE clause, only the state-
ments following the first match are executed.
The CASE ELSE clause is used to indicate the statements to be executed if no match is found
between the Expression and any of the CaseExpressions. When there is no CASE ELSE
statement and no CaseExpressions match the Expression, execution continues at the next
Cicode statement following END SELECT.
You can use multiple expressions or ranges in each CASE clause. For example, the follow-
ing line is valid:
CASE 1 To 4, 7 To 9, 11, 13, Is > MaxNumber
You can also specify ranges and multiple expressions. In the following example, CASE
matches strings that are exactly equal to "everything", strings that fall between "nuts" and
"soup" in alphabetical order, and the current value of "TestItem":
CASE "everything","nuts" To "soup",TestItem
SELECT CASE statements can be nested. Each SELECT CASE statement must have a
matching END SELECT statement.
For example, if the four possible states of a ship are Waiting, Berthed, Loading, and Load-
ed, the Select Case statement could be run from a button to display a prompt detailing the
ship’s current state.
select case iStatus
CASE 1
Prompt("Waiting");
CASE 2
Prompt("Berthed");
CASE 3
Prompt("Loading");
CASE 4
Prompt("Loaded");
CASE Else
Prompt("No Status");
END SELECT
See Also
80
Chapter: 13 Performing Advanced Tasks
This section introduces and explains event handling, CitectSCADA tasks, CitectSCADA
threads, how CitectSCADA executes, and multitasking - including foreground and back-
ground tasks, controlling tasks, and pre-emptive multitasking.
See Also
Handling Events
How CitectSCADA Executes
Multitasking
Foreground and background tasks
Controlling tasks
Pre-emptive multitasking
Handling Events
Cicode supports event handling. You can define a function that is called only when a par-
ticular event occurs. Event handling reduces the overhead that is required when event trap-
ping is executed by using a loop. The following example illustrates the use of the OnEvent()
function:
INT
FUNCTION MouseCallback()
INT x, y;
DspGetMouse(x,y);
Prompt("Mouse at "+x:####+","+y:####);
RETURN 0;
END
OnEvent(0,MouseCallback);
The function MouseCallBack is called when the mouse is moved - you do not need to poll
the mouse to check if it has moved. CitectSCADA watches for an event with the OnEvent()
function.
Because these functions are called each time the event occurs, you should avoid complex
or time consuming statements within the function. If the function is executing when anoth-
er call is made, the function can be blocked, and some valuable information may be lost. If
you do wish to write complex event handling functions, you should use the queue han-
dling functions provided with Cicode.
See Also
81
How Cicode is Executed

Your multi-tasking operating system gives CitectSCADA access to the CPU through
threads. However, this access time is not continuous, as CitectSCADA must share the CPU
with other applications and services.
Note: Be careful when running other applications at the same time as CitectSCADA. Some
applications place high demands on the CPU and reduce the execution speed of Cit-
ectSCADA.
The CitectSCADA process has many operations to perform, including I/O processing,
alarm processing, display management, and Cicode execution - operations that are per-
formed continuously. And, because CitectSCADA is a real-time system, it needs to perform
all necessary tasks within a minimum time - at the expense of others. For this reason, Cit-
ectSCADA is designed to be multitasking, so it can efficiently manage it’s own tasks.
CitectSCADA performs all of its tasks in a specific order in a continuous loop (cycle). Cit-
ectSCADA’s internal tasks are scheduled at a higher priority than that of Cicode and have
access to the CPU before the Cicode. For example, the Alarms, Trends, and I/O Server tasks
all get the CPU before any of your Cicode tasks. The reports are scheduled at the same pri-
ority as your Cicode. CitectSCADA background spoolers and other idle tasks are lower pri-
ority than your Cicode.
For Cicode, which consists of many tasks, CitectSCADA uses round-robin single priority
scheduling. With this type of scheduling each task has the same priority. When two or more
Cicode tasks exist, they each get a CPU turn in sequence. This is a simple method of CPU
scheduling.
Note: If a Cicode task takes longer than its designated CPU time to execute, it is preempted
until the next cycle - continuing from where it left off.
See Also
Multitasking
Multitasking is when you can run more than one task at the same time. Windows supports
this feature at the application level. For example you can run MS-Word and MS-Excel at the
same time.
CitectSCADA also supports multitasking internally; that is you can tell CitectSCADA to do
something, and before CitectSCADA has completed that task you can tell CitectSCADA to
start some other task. CitectSCADA will perform both tasks at the same time. CitectSCADA
automatically creates the tasks, all you have to do is call the functions.
Multitasking is a feature of CitectSCADA not the operating system. Most applications can-
not do this, for example if you start a macro in Excel, while that macro is running you can-
not do any other operation in Excel until that macro completes.
A multitasking environment is useful when designing your Cicode. It allows you to be flex-
ible, allowing the operator to perform one action, while another is already taking place. For
example, you can use Cicode to display two different input forms at the same time, while
allowing the operator to continue using the screen in the background.
82
See Also
Foreground and background tasks

Cicode tasks (or threads) can be executing in either foreground or background mode. A
foreground task is one that displays and controls animations on your graphics pages. Any
expression (not a command) entered in a property field (that is Text, Rectangle, Button, etc.)
is executed as a foreground task. All other commands and expressions are executed in
background mode.
The difference between a background and foreground task is that a background task can
be pre-empted. That is, if system resources are limited, the task (for example, the printing
of a report) can pause to allow a more important task to be executed. When the task is com-
pleted (or when system resources become available) the original task resumes. Foreground
tasks are considered critical and can not be pre-empted.
See Also
Controlling tasks
You can use the Task functions to control the execution of Cicode tasks, and use the Cit-
ectSCADA Kernel at runtime to monitor the tasks that are executing. Since CitectSCADA
automatically creates new tasks (whenever you call a keyboard command, etc.), schedules
them, and destroys them when they are finished, most users will not need to consider these
activities in detail.
Sometimes it is desirable to manually ’spawn’ a new task. For example, suppose your
Cicode is polling an I/O Device (an operation which must be continuous), but a situation
arises that requires operator input. To display a form would temporarily halt the polling.
Instead you can spawn a new task to get the operator input, while the original task contin-
ues polling the device.
Note: The TaskNew Cicode function is used to spawn new tasks.
See Also
"Using the CitectSCADA Kernel" in the CitectSCADA User Guide
Task Functions
Pre-emptive multitasking
Cicode supports pre-empted multitasking. If a Cicode task is running, and a more impor-
tant task is scheduled, CitectSCADA will suspend the original task, complete the more im-
portant task and return to the original task.
Preemption is supported between Cicode threads and other internal processes performed
by CitectSCADA. You can, therefore, write Cicode that runs forever (for example, a contin-
uous while loop) without halting other Cicode threads or CitectSCADA itself. For example:
83
INT FUNCTION MyLoopFunction()

WHILE TRUE DO
// Whatever is required in the continuous loop
Sleep(1); // Optional
END
END
In the above example, the function Sleep() is used to force preemption. The Sleep() function
is optional, however it will reduce the load on the CPU, because the loop is suspended each
second (it will not repeat at a high rate).
See Also
84
Chapter: 14 Editing and Debugging Code
This section describes how to edit and debug your Cicode using the Cicode Editor.
The Cicode Editor

You use the Cicode Editor to write, edit, and debug your Cicode code. The Cicode Editor
behaves similarly to other code editing tools like Microsoft Dev Studio, and contains many
advanced editing features such as:
 Dockable windows and toolbars.
 Syntax highlighting - color highlighting of syntax functions.
 IntelliSense AutoPrompt - function definition tooltips.
 IntelliSense AutoComplete - automatic inline prompting and completion of functions
with all parameters.
 AutoCaseCorrect - automatic case correction of function keywords.
 AutoIndent - automatic indent alignment of code.
 AutoScroll - automatic mouse middle button support.
 Drag and Drop - copy or move of selected text.
 Bookmark and Breakpoint indicator bar - single click set and reset of bookmarks and
breakpoints.
 Keyboard Shortcuts support.
Cicode Editor starts automatically when you double-click a Cicode file object in Citect Ex-
plorer, or click the Cicode Editor button in Citect Explorer. See the topic Starting the Cicode
Editor.
Cicode files are stored as text files. For more information see the Introducing Cicode and
the section Using Cicode Files.
Note: Be careful not to confuse a Cicode file (*.ci) with an Include file (*.cii).
You could use any text editor to view or edit the Cicode files, however, the Cicode Editor
provides integrated views specific to Cicode. As well as the features listed above, it in-
cludes:
 Breakpoint window
 Output window,
 Global Variable Window
 Stack window
 Thread window
 Compile Errors window
 CitectVBA Watch window
 Files window
To minimize potential future problems with maintaining your Cicode files, you should
adopt a programming standard as early as possible, as discussed in the section Using
Cicode Programming Standards. Maintain structured Cicode files, by logically grouping
your Cicode functions within the files, and by choosing helpful descriptive names.
Modular programming methods are discussed in the section Modular Programming.
Cicode functions are introduced in the section titled Using Cicode Functions. Suggestions
for debugging your Cicode is included in the section titled Debugging Cicode.
85
Starting the Cicode Editor

To start the Cicode Editor:
 Click the Citect Explorer button.
 Open the Cicode Files folder in the project list area of your project.
 Do either of the following:
 Double click a Cicode file (*.ci).
 Choose Tools | Cicode Editor in a CitectSCADA application.
 Click the Cicode Editor button.
Changing the default Cicode Editor

CitectSCADA allows you to use any text editor supported by Windows (for example, ED
for Windows, Windows Notepad, or Microsoft Word), instead of the default Cicode Editor.
To change the default Cicode Editor:
 Click the Project Editor button.
 Choose Tools | Options.
 Enter the editor application file name in the Cicode Editor field.
Note: The application name of the default Cicode Editor is ctcicode.exe located in the
CitectSCADAbin folder. The application name for Notepad is notepad.exe, located in
the Microsoft Windows c:\windows\ folder. The relative path to the editor application
must be included if the application is not stored in the CitectSCADAbin folder.
 Click OK to save the changes and close the form, or Cancel to abort changes without
saving.
86
Creating Cicode files

To create a new Cicode file:
 Start the Cicode Editor.
 Choose File | New, or click New.
Save the Cicode file after creating it. The file is only stored on disk after you save it.
Creating functions
To create a new Cicode function:
 Choose File | New, or click New.
 Type in your new Cicode function in the blank space, or at the end of the file. Format
the Cicode function correctly, following the documented syntax.
 Save the Cicode file.
Saving files
To save a Cicode file:
 Choose File | Save, or click Save.
 If the file is new, you will be prompted by the Save as dialog. CitectSCADA automati-
cally suggests a name.
 Type in a new name in the File name field.
 Click Save to save the file, or Cancel to abort the save.
To save your Cicode file under a new name, choose Save as instead of Save. The original
file will remain in your project under the original filename, until you delete it. All source
files in your project directory will be included when you compile your project.
87
Opening Cicode files

To open a Cicode file:
 Choose File | Open, or click Open.
 Select a file from the list. You can use the dialog controls to open other projects and di-
rectories.
 Click the Open button to open the file, or Cancel to abort.
Note: Double clicking on any Cicode file (*.ci) in the Citect Explorer will launch the
Cicode Editor and open the Cicode file. However, be careful not to confuse a Cicode file
with an Include file (*.cii).
Deleting Cicode files

To delete a Cicode file:
88
 Run the Cicode Editor.

 Choose File | Open, or click the Open button.
 Select the target file from the list. You can use the dialog controls to open other projects
and directories.
 Press the Delete key.
 Click the Yes button to confirm delete, or No to abort.
 Click the Cancel button to close the Open form.
Finding text in Cicode files

To find text in a Cicode file:
 Choose Edit | Find, or click the Find button.
 Complete the Find dialog, filling in the Find what field.
 Click the Find Next button to begin searching, or Cancel to abort. The search is per-
formed down the file from the cursor. Hits are highlighted.
Compiling Cicode files

To compile Cicode:
 Choose File | Compile, or click the Compile button.
Note: You cannot compile Cicode functions individually. When you compile CitectSCA-
DA, it automatically compiles the entire contents of the project.
Viewing errors detected by the Cicode Compiler

To view errors detected by the Cicode compiler:
Do either of the following:
 From the Compile Errors in the File menu of the Project Editor, click Goto. This launch-
es the Cicode Editor and opens the appropriate file at the correct line.
 Choose View | Compile Errors, then double-click the compile error you want to view.
Cicode Editor Options

Cicode error handling behavior is controlled through the Cicode Editor Options Properties
Dialog. These allow you to set (and change) what should happen when errors occur in run-
ning Cicode, under which circumstances the debugger should be started, and how the de-
bugger behaves when in debug mode.
There are three tabbed property pages of options within the Debugger Options Properties
dialog:
 View Windows and ToolBars tab
 Options Properties tab
 Language Formatter Properties tab
See Also
Debugging Cicode
89
Docking the Windows and Toolbars

The view windows and toolbars of the Cicode Editor can be docked or free floating within
the editing and debugging environment.
Toolbars are docked by default within the toolbar area at the top of the Cicode Editor. Win-
dows are docked by default in the document display area at the lower portion of the Cicode
Editor, beneath the toolbar area.
Docked windows are those that resize themselves to fit totally within the Cicode Editor dis-
play area, by docking (attaching) themselves to an internal edge of the display area. Docked
windows cannot be resized manually, and will share the display space with the Editor tool-
bars and other docked windows. Docked windows and toolbars share the display space
side-by-side, and do not obscure the view of each other.
Free floating windows are those that are not docked to the editor, nor are necessarily con-
strained by the editor boundaries. Free floating windows can be resized manually, and are
subject to layering (Z-order), in which they can be partly or wholly obscured by another
window, and they could partly or wholly obscure the view of another window themselves.
The window or toolbar with the current focus, is the one completely visible at the top of all
other display window layers, partly or wholly obscuring all those beneath it in the Z-order.
Windows and toolbars can be moved about in the Cicode Editor environment by clicking
and dragging the titlebar of a window, or non-button area of a button bar. Docking behav-
iour is by default, and can be overridden by holding down the CTRL key during the drag-
and-drop to force the window or bar to be free floating.
The position of the mouse during the drop action determines which side the window or
toolbar docks to. Docking outlines of the window or toolbar are displayed with gray lines
during the drag action to indicate the potential docked position.
Debugging Cicode
Displaying the Editor Options Properties dialog

To view/hide the Editor Options properties dialog:
 Choose Debug | Options, or press Ctrl + T and then select the appropriate Window
from the dialog.
Note: You can also choose View | Options, and then select the appropriate Window
from the dialog.
90
Windows and Bars Tab
The Windows and Bars tab displays the current display state of the listed Toolbars and De-
bug Windows within the Cicode Editor. A check mark in the checkbox next to the Window
or Toolbar name enables the display of that Window or Toolbar in the Cicode Editor. A
grayed-out checkbox indicates that the window is disabled (presently unable to be dis-
played). For example: Many of the debug windows which display the active state of project
Cicode variables are disabled when a Cicode project is not running, and therefore the
Cicode Editor cannot be in debug mode).
Note: Right-click in the toolbar area to view a menu of available toolbars and debug win-
dows. For a description the buttons, see The Cicode Editor.
Toolbar options
Click the button on the toolbar to display the tool bar you want; for example, click Edit to
display the Edit tool bar.
Window options
The Cicode Editor has several editing and debug windows that you can use to display in-
formation about running Cicode and CitectVBA.
The Cicode Editor windows available are:
 Breakpoint window
 Output window
 Global Variable window
 Stack window
 Thread window
 Compile Errors window
 CitectVBA Watch window
 Files window
91
Viewing Editor windows

You can choose to view Editor windows or hide them to give you more room on your
screen.
To view/hide an Editor Window:
 From the View menu, select the appropriate Window, or click the toggle button you
want in the View toolbar.
Breakpoint window
Displays the Breakpoint Window, which is used to list all breakpoints that are currently set
within the project. Double clicking an item in the list loads the file into the editor and jumps
to the breakpoint position. Right-clicking an item allows the enable/disable/removal of the
list item.
The Breakpoint Window has the following fields:

 File: the full name and location of the code file in which the breakpoint exists.
 Line: the line number (in the code file) where the breakpoint is located.
 Enabled: indicates if the breakpoint is enabled or not. Yes indicates it is active, No indi-
cates it is not.
Output window
Displays the Output Window, which lists the output messages sent by CitectSCADA dur-
ing debugging. It states when threads start and terminate, and if a break occurs. This win-
dow will show messages sent by the TraceMsg() function.
The Output window shows entries in the order that they occur:
Note: You must be in debug mode to view the messages.
Global Variable Window

Displays the Global Variables Window, which lists the names and values of all global vari-
ables processed to date in the running project during debugging. A global variable is added
92
to the list when it is first assigned a value. Each time the Global variable is processed, its
value will be updated in the Global Variable Window.
Note: You must be in debug mode to view global variable values in this window.
Stack window
Displays the Call Stack window, which lists the stack values of the current thread. The stack
consists of the functions called (including the arguments), any variables used in the func-
tions, and return values. This is especially useful during debugging to trace the origin of
the calling procedures.
A stack is a section of memory that is used to store temporary information. For example,
when you call a Cicode function, the variables used inside the function exist only as long
as the function runs.
To view the values of arguments and variables in a procedure, place a breakpoint within
the procedure under watch. When that breakpoint is reached, the Stack Window will dis-
play the current call stack of the procedure containing the breakpoint. The values of the
stack are updated as the values change.
Note: You must be in debug mode to view this window.
Thread window
Displays the Threads History window.
93
The Thread Window has the following fields:

 Name: The name of the Cicode thread. This is the name of the function called to start the
thread (from the TaskNew() function for example).
If you click on the Name of the Cicode thread, you will make the selected thread the current
focus of the Debugger. The Debugger will change the display to show the source of the new
thread.
Note: If the thread was not started from TaskNew(), the Name shown will be Com-
mand.
 Hnd: The Cicode thread handle.
 CPU: The amount of CPU the Cicode thread is currently using, as a percentage of the
total CPU usage. Cicode is efficient and this value should be quite small (0-25%). If this
value is large it can indicate a problem with the Cicode program you have created. For
example, values over 60% can indicate that your thread is running in ’hard’ loops, and
needs a Sleep() function inserted.
 State: The state of the Cicode thread. The states are defined as follows:
 Ready: The Cicode is ready to be run.
 Sleep: Suspended using the Sleep() function.
 Run: The thread is running.
 CPU_Time: The total amount of CPU time that the Cicode thread has consumed. This
tracks how much CPU time the thread has used over its lifetime.
Compile Errors window

Displays the Compile Errors window, which lists any code errors that have occurred dur-
ing compile. You can double-click on the file name in the list, to open that code file in the
Cicode Editor, and jump to the line of code that caused the compile error.
94
CitectVBA Watch window

Displays the CitectVBA Watch window. During debugging mode, you can use the CitectV-
BA Watch window to watch the value of any CitectVBA variables in the current scope.
Click in the Variable column and type in the name of the variable under watch. As it comes
into scope, its value is updated and appears in the Value column.
Files window
Displays the Files window containing three tabs.
 The ’All Projects’ tab displays a tree hierarchy view of all projects and their Cicode and
CitectVBA files available within Citect Explorer.
 The ’Open Project’ tab displays a tree hierarchy view of the currently selected project,
and all included projects. The currently selected project will be the top entry.
 The ’Open Files’ tab lists the names of all files currently open for editing in the Cicode
Editor.
Note: Clicking any of the file names displayed in the tree will open that file in the editor
and give it the focus.
95
Options Properties Tab
The Options properties tab has the following features:

[Dynamic properties] Break on all hardware errors
Stops a Cicode thread if a hardware error is detected. A Cicode error will be generated and
the thread will terminate (without executing the rest of the function).
[Dynamic properties] Suspend all Cicode threads while stepping
All Cicode threads will be suspended while the debugger is stepping (or when the debug-
ger reaches a breakpoint, or the user performs a manual break). If you try to run any Cicode
thread at such a time (by pressing a button at runtime, and so on), the Command paused
while in debug mode message will display in the runtime prompt line.
This option allows better isolation of any software errors that are detected, especially those
that occur when your Cicode thread interacts with other threads. Foreground Cicode can-
not be suspended and will continue running when this option is set.
Note: This option will prevent all new Cicode threads from running (including keyboard
and touch commands), and should not be used on a running plant.
[Dynamic properties] Warning on break in foreground Cicode
If a break point is ’hit’ in a foreground Cicode task, the Foreground Cicode cannot break
(343) error message is generated, and will be displayed on the Hardware Alarm page. Dis-
able this option to stop the alarm message from displaying.
[CitectSCADA startup options] CitectSCADA will start debugger on hardware errors
CitectSCADA will automatically start the debugger when a Cicode generated hardware er-
ror is detected. The debugger will display the Cicode source file, and mark the location of
the error.
Note: This option will interrupt normal runtime operation, and should only be used during
testing and commissioning of systems.
[CitectSCADA startup options] Notify debugger of errors in foreground Cicode
CitectSCADA will automatically start the debugger if an error is detected in a foreground
task. The debugger will display the Cicode source file, and mark the location of the error.
96
This option is overridden by the CitectSCADA will start debugger on hardware errors op-
tion. That is, if the above option is disabled, then this option is disabled also.
Note: Foreground Cicode cannot be suspended. The break point will be marked, but you
will not be able to step through the function.
[CitectSCADA startup options] Allow remote debugging
Allows debugging of Cicode on this computer from a remote CitectSCADA computer.
[CitectSCADA startup options] Remote IP Address
The Windows Computer Name or TCP/IP address of the remote CitectSCADA computer.
The Windows Computer Name is the same as specified in the Identification tab, under the
Network section of the Windows Control Panel. You specify this name on the computer
from which you are debugging.
The TCP/IP address (for example, 10.5.6.7 or plant.yourdomain.com) can be determined as
follows:
 Go to the Command Prompt, type IPCONFIG, and press Enter.
[Debugger options] Save breakpoints between sessions
Save the location and states of breakpoints between running sessions of the Cicode Editor
and Debugger. This means breakpoints inserted using the Cicode Editor can later be re-
called when an error is detected - even though the file (and application) has been closed.
[Compile options] Incremental compile
Enables the incremental compilation of the project.
See Also
Debugging Cicode
Language Formatter Properties Tab
This dialog displays the currently selected programming language that the editor will use
to format the syntax of the file being edited in the code window. If you open a Cicode file
(with a .Ci extension), the current language formatter changes to Cicode. If you open a Ci-
tectVBA file (with a .bas extension), the current language formatter changes to CitectVBA.
97
Similarly, if you open a file with neither a Cicode nor a CitectVBA extension, say a text file
(with a .txt extension), the editor will not know which language type you intend to use, and
will not apply any formatting to the file. You can use this dialog to select which program-
ming language the file contains, and it will format the file appropriately for display in the
code window.
Note: The Cicode Editor can be used to edit any ASCII text based file, including Microsoft
JScript. The editor recognizes JScript files (with a .jav extension) and will change the current
language formatter to JScript. CitectSCADA does not support JScript, and will not compile
it into your project. However, the editor can still be used separately to edit or create a
JScript file or any other ASCII text based file.
Current
Displays the currently selected programming language formatter for appropriate syntax
coloring of the file displayed in the code window.
Selection
Displays the range of possible programming languages that can be chosen as the current
language for formatting and display in the code window.
Debugging Cicode
To help you locate Cicode errors, you can switch the Cicode Editor to debug mode to ana-
lyze running Cicode. You can toggle debugging on and off as required, but CitectSCADA
must be running for the debugger to work.
Note: The Cicode Editor cannot debug foreground Cicode. A break in a foreground Cicode
will result in the Foreground Cicode cannot break message.
See Also
Cicode Editor Options | Function Error handling | Debug Error Trapping
Using debug mode

To switch to debug mode:
 Choose Debug | Start Debugging, or click the Toggle Debug button.
Note: If the current project is not running, CitectSCADA compiles and runs it automatical-
ly. The bug in the bottom right-hand corner is green when debugging.
Debugging functions
To debug a function:
 Open the file containing the function you wish to debug.
 Click the Toggle Debug button, or choose Debug | Start Debugging.
Note: If the current project is not running, CitectSCADA compiles and runs it automat-
ically. The bug in the bottom right-hand corner is green when debugging.
 Insert a breakpoint where you want to start debugging.
98
 From the View menu, select any debug windows you want to use. If you are unsure,
you can use them all.
 Initiate the thread by calling the function. You can do this directly from the Cicode win-
dow in the Kernel, or by using a function, etc.
 The function will break at the specified breakpoint. You can then use the step tools to
step through and trace your function.
 Click the Toggle Debug button to stop debugging, or choose Debug | Stop Debugging.
Debugging functions remotely

You can debug functions remotely if both computers are running identical projects and the
CitectSCADA Path is the same on both machines.
To remotely debug Cicode:
 Click the Cicode Editor button on the computer that will be running CitectSCADA (the
remote).
 Choose Debug | Options.
 Check (tick) the Allow remote debugging option.
 Click OK.
 Click the Run button (you can close the Cicode Editor first), or choose File | Run.
 On the computer that will be debugging CitectSCADA, click the Cicode Editor button.
 Choose Debug | Options.
 Enter the Windows Computer Name or TCP/IP address of the remote CitectSCADA
computer.
The Windows Computer Name is specified on the Computer Name tab of the System Prop-
erties dialog (go to Control Panel and select System).
The TCP/IP address (for example, 10.5.6.7 or plant.yourdomain.com) can be determined by
going to the Command Prompt, typing IPCONFIG, and pressing Enter.
 Click OK.
 Click the debug button to start remote debugging.
Note:CitectSCADA uses Named Pipes for remote debugging. To enable the Windows
Named Pipe service, you must enable the Server service. Select Administrative Tools from
Control Panel, then select Services. Locate the Server service in the list that appears, and
confirm that it is running. You can start and stop a service by right-clicking on it.
Using breakpoints
There are three ways for a processing thread to halt:
 Manually inserting a breakpoint.
 Using the DebugBreak() Cicode function.
 If a hardware error is detected.
To debug a function, you must first be able to stop it at a particular point in the code. You
can place a breakpoint on any line in the source code functions. Breakpoints may be insert-
ed or removed while editing or debugging and do not need to be saved with the file.
For a detected hardware error to halt a function, you must have either the Break on all
hardware errors or Break on hardware errors in active thread option set (Debug menu -
Options). When the break occurs, the default Cicode Editor will be launched (if it is not
open already), with the correct code file, function, and break point line displayed. To
99
launch the debugger in this case, you must have the CitectSCADA will start debugger on
hardware errors option set.
Inserting or removing breakpoints

You can insert and remove breakpoints to halt processing.
To insert/remove a breakpoint:
 Open the Cicode Editing window.
 Position the cursor on the line where you want the breakpoint to be placed or removed.
 Click the Debug indicator bar. Alternatively, you can press F9 or choose Debug | Insert/
Remove Breakpoint.
The breakpoint appears as a large red dot at the beginning of the line.
Enabling/disabling breakpoints
You can enable or disable breakpoints you have inserted into your Cicode.
To enable/disable a breakpoint:
 Open the Cicode Editing Window.
 Position the cursor on the line where the breakpoint is located.
 Press Ctrl + F9, or choose Debug | Enable/Disable Breakpoint.
Note: A disabled breakpoint appears as a large dark gray (disabled) dot at the beginning
of the line.
Stepping through code

Once you have halted a thread, the debugger marks the position in the code with an arrow.
Now you can step through the function, line by line, and watch what happens in the debug
window (see below). The following tools are provided in the Cicode Editor, to control step-
ping through functions.
Step Into Advances the current Cicode thread by one statement. If the statement is
a user defined function, the debugger steps into it (the pointer jumps to the
first line of the source code).
Step Over Advances the current Cicode thread by one statement. If the statement is
a user defined function, the debugger steps over it (the function is not ex-
panded).
Step Out Advances to the end of the current function and return. If there is no calling
function, the thread terminates.
Continue Re-starts normal execution of the current Cicode thread. If there are no
more breaks, the thread terminates normally.
100
Chapter: 15 Using Cicode Programming Standards
Implementing programming practices results in Cicode that is more robust, manageable,
and predictable in execution, regardless of the author. Using programming standards en-
tails:
 Adopting modular programming techniques.
 Ensuring that programs are adequately described by suitable module headers.
 Formatting code to improve readability.
The following topics are presented as a suggested means of achieving good programming
standards:
 Variable Declaration Standards
 Variable Scope Standards
 Variable Naming Standards
 Standards for Constants, Variable Tags, and Labels
 Formatting Simple Declarations
 Formatting Executable Statements
 Formatting Expressions
 Cicode Comments
 Formatting Functions
 Modular Programming
 Defensive Programming
 Function Error handling
 Debug Error Trapping
See Also
Using Cicode Functions

When declaring variables you should use consistent formatting. A variable declaration has
up to five parts. Each part is separated by at least one tab stop:
Note: Parts contained within square brackets are optional. For example, you do not have to
specify the variable scope (it defaults to local if you do not). Parts contained within greater
than ( < ) and less than ( > ) signs should be replaced with the relevant text/value. For ex-
ample, you would replace <initial value> with an actual value. (You would not bracket
your value with greater than and less than signs.)
101
When declaring your variables, all parts of each should align vertically (the scope part of
each should be vertically aligned, the type part of each should be aligned, etc.). Each part
of the declaration is allotted a set amount of space. If one part is missing, its space should
be left blank. The missing part should not affect the positioning of the next part:
ModuleintmiRecipeMax=100;
intiRecipeMax;
stringsRecipeDefault="Tasty";
See Also

Local variable standards
Local Variables should be initialized, for example:
INTiFile = 0;
STRINGsName = "";
INTbSuccess = FALSE;
Module variable standards

Module Variables should be initialized, for example:
MODULEINTmhForm = -1;
MODULESTRINGmsPageName = "Loop";
Global variable standards

Global variables should be initialized, for example:
GLOBALINTghTask = -1;
GLOBALSTRINGgsLastPage = "Menu";

The following naming conventions should be applied to variables:
 Variable names should have a small case letter prefix as follows:
Type Prefix Used for
INT (32 bits) i index, loop counter
INT (32 bits) and OBJECT h handle
(32 bits)
INT (32 bits) b boolean (TRUE/
FALSE)
REAL (32 bits) r real type variables
STRING (255 bytes) s string type variables
 Variable names typically consist of up to three words. Each word in a variable name
should start with a capital letter, for example:
iTrendType, rPeriod, sFileName
 Module variable names should be prefixed with an "m", for example:
miTrendType, mrPeriod, msFileName
 Global variable names should be prefixed with a "g", for example:
102
giTrendType, grPeriod, gsFileName

 Local variable names should not be prefixed (when you declare a variable without spec-
ifying the scope, it is considered a Local variable by default):
iTrendType, rPeriod, sFileName
See Also
Standards for Constants, Variable Tags, and Labels

When coding constants, variable tags and labels in Cicode you should try to use the follow-
ing standards:
 Constants
 Variable tags
 Labels
Constants
In Cicode there is no equivalent of #defines of C language, or a type that will force variables
to be constants (read-only variables). However, the variable naming convention makes
constants easily identifiable so developers will treat those variables as read-only variables.
 Constants must have the prefix ‘c’.
 Constants must be declared and initialized at the beginning of the Cicode file and never
assigned a value again.
For example:
INT ciTrendTypePeriodic = 1;
INT ciTrendTypeEvent = 2;
STRING csPageName = "Mimic";
Variable tags
Variable tags that have been defined in the database (with the Variable Tags form) can be
used in all functions in the Cicode files. Variable tags are identifiable because they will not
have a prefix (also, they are generally in uppercase letters).
Labels
Labels, like variable tags, can be used in all functions in the Cicode files. They can be either
all upper case letters or mixed case. In order to differentiate them from the variable tags and
other Cicode variables they should have an ‘_’ (underscore) in front of them. For example:
_BILLING_EVENT, _UNIT_OFFLINE, _AfterHoursEvent
Note: There are a few labels without an underscore defined in the Labels form in the IN-
CLUDE project. Although they do not follow the guidelines set in this document their wide
usage makes changing those labels impractical. These labels are: TRUE, FALSE,
BAD_HANDLE, XFreak, XOutsideCL, XAboveUCL, XBelowLCL, XOutsideWL, XUp-
Trend, XDownTrend, XGradualUp, XGradualDown, XErratic, XStratification, XMixture,
ROutsideCL, RAboveUCL, RBelowLCL
103
See Also
Formatting Simple Declarations

The following conventions should be observed when formatting simple Cicode declara-
tions:
 Only one item should be declared per declaration; there should be no comma separated
list of variables.
 Tab stops should be used for declarations and indentation.
For example:
INThFile,hForm;// WRONG
INThFile;// RIGHT
INThForm;// RIGHT
The reasons for this are:

 All but the first identifier in the WRONG case are hidden and are often missed in a quick
glance;.
 It is harder to add a comment or initialization to an item in the WRONG case.
 All types, items, and initialization within a group of declarations should be vertically
aligned.
For example:
STRING sFileName = "temp.dat";// WRONG
INT iOffset = -1; // WRONG
INT iState = 3; // WRONG
STRINGsFileName= "temp.dat";// RIGHT
INTiOffset= -1;// RIGHT
INTiState= 3;// RIGHT
See Also
Using Cicode Commands
Formatting Executable Statements

The following conventions should be observed when formatting executable statements:
 Statements are placed on new lines, indented one tab stop from the level of their sur-
rounding block.
Note: Do not place more than one statement on a single line. While this practice is permit-
ted in other programming languages, in Cicode the subsequent statements will not be in-
terpreted and will effectively be lost, potentially affecting your program’s runtime
behavior.
Although it may be argued that some statements are logically related, this is not sufficient
justification. If they are logically related, place the statements on consecutive lines and sep-
arate the statements by a blank line before and after. For example:
104
hFile = -1; hForm = -1;// WRONG

hFile = -1;// RIGHT
hForm = -1;// RIGHT
 IF statements can be used in one of the formats below. When indenting the IF state-
ments, a tab stop should be used. For example:
 Simple IF block
IF <expression> THEN
...
END
 IF-THEN-ELSE block
...
ELSE
...
END
 To simulate ELSEIF blocks, use nested statements. For example:

...
ELSE
...
ELSE
...
ELSE
...
END
END
END
 For WHILE and FOR statements see Working with Conditional Executors.
See Also
Formatting Expressions
The following conventions should be observed when formatting Cicode functions:
 When an expression forms a complete statement, it should, like any other statement, oc-
cupy one or more lines of its own and be indented to the current level. Operators should
be surrounded by spaces. For example:
i= i*10+c-’0’; // WRONG
i = i * 10 + c - ’0’; // RIGHT
 When a sub-expression is enclosed in brackets, the first symbol of the sub-expression

should be placed hard against the opening bracket. The closing bracket should be
placed immediately after the last character for the sub-expression. For example:
105
a = b * ( c - d ); // WRONG
a = b * (c - d); // RIGHT
 The round brackets which surround the arguments of a function all attract no spaces,
for example:
DisplayText( "hello" ); // WRONG
DisplayText("hello"); // RIGHT
 Commas, whether used as operators or separators, would be placed hard against the
previous symbol and followed by a space. For example:
DevSeek(hDev ,Offset); // WRONG
DevSeek(hDev, Offset); // RIGHT
See Also
Cicode Comments
Comments are designed to to aid understanding and maintenance of code. You should
place comments in the notes of the function header so as not to clutter up the code. Small
one-line comments are acceptable to explain some small part of the code which may be
hard to understand in the normal header comment.
See Also
Formatting Functions
Cicode functions have up to seven parts: Scope, Type, Keyword, Name, Argument(s),
Statement(s), Keyword.
[Scope]
The scope of the function. If you do not specify a scope, the function will be Public by de-
fault. That is, it will be available to all Cicode files, pages, and CitectSCADA databases (for
example, Alarm.dbf). To make a function Private (that is only available within the file in
which it is declared), you must prefix it with the word PRIVATE.
[Type]
The return type of the function. This should be on a separate line.
Keyword
The keyword FUNCTION. This should be on a separate line.
Name
The function name. Function names should follow the Function Naming Standards. This
should be on a separate line.
106
Argument(s)
The argument list. The arguments are separated by commas and they can have default val-
ues. The argument list is normally on the same line as the function name but multiple line
argument list is also acceptable if it improves readability.
Statement(s)
The statements. Each statement should be on a separate line.
Keyword
The keyword END which marks the end of the function. This should be on a separate line.
Note: Parts contained within square brackets - [ ] - are optional. For example, you do not
have to specify the function scope (it will default to Public if you do not). Parts contained
within greater than & less than signs - < > - should be replaced with the relevant text/value.
For example, you would replace <initial value> with an actual value. You would not brack-
et your value with greater than & less than signs.
For example:
FUNCTION
PlotInit()
<statements>
END
INT
FUNCTION
PlotOpen(STRING sName, INT nMode)
INThPlot = _BAD_HANDLE;
...
hPlot = .....;
...
RETURN hPlot;
END
PRIVATE
STRING
FUNCTION
WasteInfoName(INT nType, INT nMode)
STRINGsName = "Sydney";
...
sName = .....;
...
RETURN sName;
END
See Also
Writing Functions
Using Cicode Functions
Function Naming Standards

Function names should contain at least the following information:
 A three-to-five letter description of the function type (Trend, Plot, Win).
 A one or two word description of the data to be operated on (Info, ClientInfo, Mode).
107
 A one word action to be taken (Get, Set, Init, Read).

For example:
PlotInit();TrendClientOpen();TrendClientInfoRead();
See Also
Naming Functions
Source file headers

Source files (the files that contain your Cicode) should have a header to provide a basic
overview of the file. This header should be formatted as follows:
//** FILE: <name of file.CI>
//**
//** DESCRIPTION: <description of basically what is in the file>
//**
//** FUNCTIONS: PUBLIC
//** <list of the PUBLIC functions contained
//** in this file>
//**
//** PRIVATE
//** <list of the PRIVATE functions contained
//** in this file>
//**
//*************** MODULE CONSTANTS***********************
<module constants> //<comments (optional)>
//**************** MODULE VARIABLES ***********************
<module variables> //<comments (optional)>
//*********************************************************
Note: Declare all module variables at the MODULE VARIABLES section at the beginning
of the file and initialize the module variables.
For example:
//** FILE: Recipe.CI
//**
//** DESCRIPTION: Contains all functions for gathering recipe data.
//**
//** FUNCTIONS: PUBLIC
//** OpenRecipeDatabase
//** CloseRecipeDatabase
//** ReadRecipeData
//** WriteRecipeData
//** GatherRecipeData
//** RecipeForm
//** OpenRecipeDatabase
//**
//** PRIVATE
//** ButtonCallback
//**
//*************** MODULE CONSTANTS***********************
module int cmiRecipeMax =100; //Maximum number of recipes
//**************** MODULE VARIABLES ***********************
module int miRecipeNumber =0; //Minimum number of recipes
//*********************************************************
108
Function headers
Functions should have a descriptive header, formatted as follows:
//** FUNCTION : <name of function>
//**
//** DESCRIPTION : <suggests the operation, application source and
//** multi-tasking issues>
//** REVISION DATE BY COMMENTS
//** <revision number> <date> <author> <comments about the change>
//**
//** ARGUMENTS: <argument description>
//**
//** RETURNED VALUE: < description of possible return values>
//**
//** NOTES:
The order of functions in a file is important for efficient operation.

Initialization and shutdown functions should be placed at the top of the file. Command
functions should be next. Local utility functions should be at the bottom of the file.
For example:
//** FUNCTION : OpenRecipeDatabase
//**
//** DESCRIPTION : Opens the specified database.
//**
//** REVISION DATE BY COMMENTS
//** 1 28/09/97 BS Original
//** 2 05/10/97 SFA Added INI checking
//**
//** ARGUMENTS:
//**
//** STRING sName Name of the recipe database.
//**
//** INT dwMode Mode to open the recipe database.
//** 0 for read only, 1 for read/write.
//**
//** RETURNED VALUE: Handle if successful, otherwise -1.
//**
//** NOTES:
INT
FUNCTION
OpenRecipeDatabase(STRING sName, INT dwMode)
...
END
Modular Programming
One of the more effective programming practices involves partitioning large, complex pro-
gramming challenges into smaller and more manageable sub-tasks and reusable functions.
A similar approach should be taken when using a programming language like Cicode to
109
complete a task. Reducing the task to smaller tasks (or functions) has the following advan-
tages:
 Reduced Complexity - Once the function is created and tested, the detailed operation
about how it works need not be revisited. Users need only focus on the results produced
by the function.
 Avoids Duplicate Code - Creating a generic function instead of copying similar code
reduces the total amount of code in the system. It also means the function can be reused
by separate code areas. This makes the code more maintainable because it is smaller in
size, and only one instance needs to be modified.
 Hides Information - Information can be in the form of operations, data, or resources.
Access to information can be controlled when functions are written that provide a lim-
ited set of actions to be performed on the information. For example, if a user wishes to
log a message to a database, he or she should only send the message to a function, say
LogDBaseMessage("hello world"), and the function should control the database re-
source. The function then becomes the single interface to the database resource. Re-
sources that have multiple interfaces to them are harder to control. This is because in a
multitasking environment, the user cannot control or even know in advance the order
of code execution, and hence a resource may be modified at the same time by different
tasks. Information hiding can also smooth out any wrinkles in standard functions, min-
imizing possible misuse of resources such as semaphores, queues, devices, and files.
Functions that do this are often called ‘wrapper’ functions as they add a protective shell
to existing functions.
 Improves Performance - Optimizing code that resides in one place immediately in-
creases the performance of code that calls this function. Scattered code will require all
areas to be modified should any optimization be necessary.
 Isolates Complex Code - Code that requires complex operations such communications
protocols, complex algorithms, boolean logic, or complex data manipulation is suscep-
tible to errors. Placing this code in a separate function reduces the possibility of this code
corrupting or halting other code.
 Improves Readability - A small function with meaningful parameter names assists
readability as it is a step towards self-documenting code and reduces the need to scan
multiple pages of code to establish what the operation is meant to achieve.
Modular programming has a few rules that define how functions should be structured -
Cohesion - and how they are related to other functions - Coupling.
See Also
Defensive Programming
Cohesion
A goal of modular programming is to create simple functions that perform a single task,
but perform that task well. This can be described as how ’cohesive’ a function is.
Two factors that affect the level of cohesion are:
 Number of tasks the function performs.
 Similarity of the tasks.
110
The following table illustrates the different levels of cohesion:

Number of tasks Similarity Cohesion Example
level
1 Not appli- High Sin(x)
cable
More than 1 Similar Moderate SinAndTan(x)
More than 1 Dissimilar Low SinAndLength(x)
Many Radically None SinAndDateAndTimeAndSQLNext(x)
different
For example, the function Sin(x) will perform one task - return the trigonometric Sine value
of x. This is an example of a highly cohesive function. The function SinAndTan(x) performs
two tasks - calculate the trigonometric Sine and Tan of the value X. This function has lower
cohesion than Sin(x) because it performs two tasks.
Highly cohesive functions are more dependable, easier to modify, and easier to debug than
functions that have lower levels of cohesion and are hence acceptable and encouraged.
Low cohesion functions are typically complex, prone to errors, and are more costly to fix.
Low cohesion functions are regarded as poor programming practice and discouraged.
Coupling
Another rule of modular programming is to reduce the number of relationships between
functions. This is referred to as function coupling. Functions that have few, or no, relation-
ships between them are loosely coupled. Loosely coupled functions provide simple, visible
interfaces to the function. This makes the functions easier to use and modify. For example,
the Cicode function TimeCurrent() is a loosely coupled function. To use this function, a
user need only call its name, and the function will return with the desired result. The user
does not need to be aware of any relationships because there are no parameters passed to
the function, and it does not read from, or write to, any global data. There is very little like-
lihood of error with this function; it only returns a time/date variable and does not support
error codes. In the unlikely event that the function did not return the time/date variable, it
would be through no error of the calling function because it has no relationship to it.
Functions that have many relationships between them are tightly coupled. For example, a
user written function like AddCustomerRecord(hDatabase, sFirstName, sSurname, sAd-
dress, sAge, sPhone) has a higher level of coupling than the function TimeCurrent(). Tight-
ly coupled functions are inflexible in their use, less robust, and harder to maintain. The
AddCustomerRecord() function is less robust because it could experience an error of its
own accord, or if the function calling it passes bad data to it. Tightly coupled functions are
harder to maintain because modifying a function with many relationships in it may result
in modifications to other functions to accept the data.
The different types of function relationships are listed below:
 Passed parameters. A simple, visible form of loose coupling that is encouraged. Once
the number of parameters passed to a function exceeds seven, you should consider par-
titioning the function into two smaller functions. These types of relationships are ac-
ceptable.
 Control information. Control information causes the called function to behave in a dif-
ferent way. For example, the function ChangeData(iMode), behaves differently de-
pending on the value of the variable iMode that is passed into it. It may be responsible
for deleting, inserting, or updating data. In addition to being a tightly coupled function,
111
it has low cohesion because it performs multiple tasks. This function could be broken
up into three separate functions to perform the separate tasks. These types of relation-
ships are moderately acceptable.
 Shared common data. This is often referred to as global variable data. This is an invisi-
ble form of tight coupling that, particularly in pre-emptive, multi-tasking environ-
ments, can result in an unpredictable, hard-to-maintain program. When functions write
to the global variable data there is no monitoring of or restriction on who is writing to
the variable. Hence the value can be indeterminate. Global variables are acceptable
when they are used for read-only purposes, otherwise their use is discouraged. Similar-
ly, module variable data in CitectSCADA should be treated the same way. The use of
local function variables is encouraged to decrease function coupling.
Defensive Programming
Defensive programming is an approach to improve software and source code. It aims to
improve general quality by reducing the number of software bugs and problems. It pro-
motes making the source code readable and understandable. It aims to make your code be-
have in a predictable manner despite unexpected input or user actions.
You should try to:
 Verify that your code does not produce unexplained hardware alarms.
 Check that denominators in division are not zero.
 Check that array indexes cannot go out of range.
 Check that arguments from external sources are valid.
 Check that loop terminations are obvious and achievable.
 Do not write the same code twice. If you find that two sections of code look identical or
almost identical it is worth spending the time to re-write or re-design it. This will gen-
erally reduce the size of the code in question by a third or more, which reduces complex-
ity and therefore maintenance and debugging time. The most effective method to
achieve this is to convert the identical code to a new function.
 Do not access the module data in any function other than the member functions.
 Write the member functions whenever an array is defined. Do not try to pass arrays be-
tween functions, make the arrays the centre piece of the object.
 Cicode is a multitasking language. Several tasks (commands, expressions and tasks cre-
ated by TaskNew function) can be executed concurrently. This powerful feature of
Cicode should be used with care as some of the functions may be modifying module da-
ta. It is important that the number of tasks running at any point in time be minimized.
This may require the use of semaphores to protect the module data from interference
and corruption. (For the use of semaphores, refer to SemOpen, SemClose, SemSignal
and SemWait functions in on-line help or the Cicode Reference manual).
See Also
Modular Programming
Function Error handling
112
Function Error handling

Errors are handled by examining the return values of the functions. The Cicode functions
can be classified as regards their return value as follows:
Functions returning Calling functions should check for
Error code only 0 no error (success)
> 0 error code
Handles -1 bad handle
>= 0 valid handle
Random values the return of IsError()
The following Cicode functions can halt the current task:

DevOpen, DevHistory, DevNext, DevPrev, DevSeek, DevFind, DevFlush, DevRecNo,
DevRead, DevReadLn, DevAppend, DevDelete, DevZap, DevControl , DevPrint , DevModify,
ErrTrap; FileOpen, FileClose, FileReadBlock, FileWriteBlock, FileSeek, FileDelete,
FileReName, FileSize, FileReadLn, FileCopy; FormNew; SQLConnect, SQLTraceOn, SQLTra-
ceOff, SQLErrMsg.
If an error is detected in one of these functions, your Cicode task will generate a hardware
error and be halted. You may stop your Cicode task from being halted by using the ErrSet()
function and checking for errors using IsError().
The parameter [Code]HaltOnError allows you to stop any errors detected in these functions
from halting your Cicode. If you set. . .
[code]
HaltOnError=0
then your Cicode will continue to run after a hardware error is detected in these functions.
For example:
 Example of error code only
INT
FUNCTION
ExampleInit()
INTnError = 0;
nError = ExampleOpen("MyForm");
IF nError = 0 THEN
...
END
END
INT
FUNCTION
ExampleOpen(STRING sName)
INTnError = 0;
...
IF <an error has been detected> THEN
nError = 299;
END
RETURN nError;
END
 Example of handles
INT
FUNCTION
ExampleInit()
113
INThFile= BAD_HANDLE;
...
hFile = ExampleFileOpen("MyFile.txt");
IF hFile <> BAD_HANDLE THEN
...
END
END
FUNCTION
ExampleFileOpen(STRING sName)
INThFile = BAD_HANDLE;
hFile = FileOpen(sName, "r+");
IF hFile = BAD_HANDLE THEN
hFile = FileOpen(sName, "r");
END
RETURN hFile;
END
 Example of random values

INT
FUNCTION
ExampleInit()
INTnSamples= 0;
...
ErrSet(1);
nSamples = ExampleSamples();
IF IsError() = 0 THEN
...
END
ErrSet(0);
END
INT
FUNCTION
ExampleSamples()
INTnSamples = 0;
INTnError = 0;
...
ErrTrap(nError);
RETURN nSamples;
END
See Also
Debugging Cicode
Debug Error Trapping

The functions listed below can also be used during normal project execution to trap run-
time problems:
 DebugMsg function
 Assert function
114
DebugMsg function
DebugMsg() internally calls the TraceMsg() function if the debug switch is on. The imple-
mentation of this function can be found in DEBUG.CI in the INCLUDE project. You can
turn the debug switch on or off by doing any of the following:
 Calling DebugMsgSet(INT bDebugMsg) on the Kernel Cicode window. (Or, this function
can be called from a keyboard command or something similar.)
 Changing the [Code]DebugMessage parameter in the INI file.
For example:
INT
FUNCTION
FilePrint(STRING sDeviceName, STRING sFileName)
INT hFile;
INT hDev;
STRING Str1;
hDev = DevOpen(sDeviceName, 0);

IF (hDev = -1) THEN
DebugMsg("Invalid arg to FilePrint - ’DeviceName’");
RETURN 261; /* File does not exist */
END
hFile = FileOpen(sFileName, "r");
IF (hFile = -1) THEN
DebugMsg("Invalid arg to FilePrint - ’FileName’");
DevClose(hDev);
RETURN 261; /* File does not exist */
END
WHILE NOT FileEof(hFile) DO
Str1 = FileReadLn(hFile);
DevWriteLn(hDev, Str1);
END
FileClose(hFile);
DevClose(hDev);
RETURN 0;
END
Assert function
Assert reports an error if the test passed by the argument does not return the expected val-
ue. The implementation of this function can be found in DEBUG.CI in the INCLUDE
project.
For example:
INT
FUNCTION
FileDisplayEx(STRING sFileName)
INThFile;

ASSERT(hFile <> -1);
...
FileClose(hFile);
RETURN 0;
END
115
See Also
Debugging Cicode
116
Part: 3
Functions Reference
Cicode includes the following function categories:
Accumulator Functions I/O Device Functions
ActiveX Functions Keyboard Functions
Alarm Functions Mail Functions
Clipboard Functions Math/Trigonometry Functions
Cluster Functions Miscellaneous Functions
Color Functions Page Functions
Communication Functions Plot Functions
DDE Functions Report Functions
Device Functions Security Functions
Display Functions SPC Functions
DLL Functions SQL Functions
Error Functions String Functions
Event Functions Super Genie Functions
File Functions Table (Array) Functions
Form Functions Tag Functions
Format Functions Task Functions
FTP Functions Time/Date Functions
FuzzyTech Functions Trend Functions
Group Functions Window Functions
118
Chapter: 16 Accumulator Functions
Accumulator functions enable you to programmatically browse and control Accumulators
and retrieve information from them.
Accumulator Functions
Following are functions relating to accumulators.
AccControl Controls accumulators for example, motor run
hours.
AccumBrowseClose Closes an accumulator browse session.
AccumBrowseFirst Gets the oldest accumulator entry.
AccumBrowseGetField Gets the field indicated by the cursor position in the
browse session.
AccumBrowseNext Gets the next accumulator entry in the browse ses-
sion.
AccumBrowseNumRecords Returns the number of records in the current browse
session.
AccumBrowseOpen Opens an accumulator browse session.
AccumBrowsePrev Gets the previous accumulator entry in the browse
session.
See Also
Functions Reference
AccControl
Controls accumulators, for example, motor run hours. You can reset the values of Run
Time, Totalizer Inc, and No. of Starts (defined in the Accumulator database), re-read these
values from the I/O device, or flush pending writes of these values to the I/O device.
Syntax
AccControl(sName, nMode [, ClusterName] )
sName:
The name of the accumulator or a mask for the names of accumulators. You can
use the following wildcards:
 * matches all following characters, for example, "Motor*" matches all accumu-
lators starting with the word "Motor"
 ? matches any single character, for example, "Motor?10" matches "MotorA10"
and "MotorB10"
This argument can be prefixed by the name of the cluster for example Cluster-
Name.AccumulatorName.
nMode:
The mode of the control:
1 - Reset Run Time and Totalizer value
2 - Reset No. of Starts
119
3 - Reset Run Time, Totalizer value, and No. of Starts

4 - Flush pending writes to the I/O device
5 - Re-read Run Time, Totalizer value, and No. of Starts from the I/O device
ClusterName:
Name of the cluster in which the accumulator resides. This is optional if you have
one cluster or are resolving the reports server via the current cluster context. The
argument is enclosed in quotation marks "".
Return Value
0 (zero) if successful, otherwise an error is returned.
Example
! Reset all accumulator variables for accumulator "MCC123".
AccControl("MCC123", 3, "ClusterXYZ");
See Also
AccumBrowseClose
The AccumBrowseClose function terminates an active data browse session and cleans up
all resources associated with the session.
This function is a non-blocking function. It does not block the calling Cicode task.
Syntax
AccumBrowseClose(iSession)
iSession:
The handle to a browse session previously returned by a AccumBrowseOpen call.
Return Value
0 (zero) if the accumulator browse session exists, otherwise an error is returned.
Related Functions
AccumBrowseFirst, AccumBrowseGetField, AccumBrowseNext, AccumBrowseNum-
Records, AccumBrowseOpen, AccumBrowsePrev
See Also
AccumBrowseFirst
The AccumBrowseFirst function places the data browse cursor at the first record.
This function is a blocking function. It blocks the calling Cicode task until the operation is
complete.
120
Syntax
AccumBrowseFirst(iSession)
iSession:
Return Value
Related Functions
AccumBrowseClose, AccumBrowseGetField, AccumBrowseNext, AccumBrowseNum-
See Also
AccumBrowseGetField
The AccumBrowseGetField function retrieves the value of the specified field from the
record the data browse cursor is currently referencing.
Syntax
AccumBrowseGetField(iSession, sFieldName)
iSession:
sFieldName:
The name of the field that references the value to be returned. Supported fields
are:
COMMENT, TAGGENLINK.
See Browse Function Field Reference for information about fields.
Return Value
The value of the specified field as a string. An empty string may or may not be an indication
that an error has been detected. The last error should be checked in this instance to deter-
mine if an error has actually occurred.
Related Functions
AccumBrowseClose, AccumBrowseFirst, AccumBrowseNext, AccumBrowseNum-
Example
STRING fieldValue = "";
STRING fieldName = "TYPE";
INT errorCode = 0;
...
fieldValue = AccumBrowseGetField(iSession, sFieldName);
IF fieldValue <> "" THEN
// Successful case
121
ELSE
// Function returned an error
END
...
See Also
AccumBrowseNext
The AccumBrowseNext function moves the data browse cursor forward one record. If you
call this function after you have reached the end of the records, error 412 is returned
(Databrowse session EOF).
complete.
Syntax
AccumBrowseNext(iSession)
iSession
Return Value
Related Functions
AccumBrowseClose, AccumBrowseFirst, AccumBrowseGetField, AccumBrowseNum-
See Also
AccumBrowseNumRecords
The AccumBrowseNumRecords function returns the number of records that match the fil-
ter criteria.
Syntax
AccumBrowseNumRecords(iSession)
iSession:
Return Value
The number of records that have matched the filter criteria. A value of 0 denotes that no
records have matched. A value of -1 denotes that the browse session is unable to provide a
fixed number. This may be the case if the data being browsed changed during the browse
session.
122
Related Functions
AccumBrowseClose, AccumBrowseFirst, AccumBrowseGetField, AccumBrowseNext, Ac-
cumBrowseOpen, AccumBrowsePrev
Example
INT numRecords = 0;
...
numRecords = AccumBrowseNumRecords(iSession);
IF numRecords <> 0 THEN
// Have records
ELSE
// No records
END
...
See Also
AccumBrowseOpen
The AccumBrowseOpen function initiates a new browse session and returns a handle to
the new session that can be used in subsequent data browse function calls.
complete.
Syntax
AccumBrowseOpen( [sFilter] [, sFields] [, sClusters] )
sFilter:
A filter expression specifying the records to return during the browse. An empty
string indicates that all records will be returned. Where a fieldname is not speci-
fied in the filter, it is assumed to be tagname. For example, the filter "AAA" is
equivalent to "name=AAA".
Note: Use the following fields with care in filters since they return the actual val-
ue of the variable tag which they refer to.
RUNNING, STARTS, TOTALISER, TRIGGER, VALUE.
sFields:
Specifies via a comma delimited string the columns to be returned during the
browse. An empty string indicates that the server will return all available col-
umns. Supported fields are:
COMMENT, TAGGENLINK.
sClusters:
An optional parameter that specifies via a comma delimited string the subset of
the clusters to browse. An empty string indicates that all connected clusters will
be browsed.
Return Value
Returns an integer handle to the browse session. Returns -1 when an error is detected.
123
Related Functions
cumBrowseNumRecords, AccumBrowsePrev
Example
INT iSession;
...
iSession = AccumBrowseOpen("NAME=ABC*", "NAME,AREA",
"ClusterA,ClusterB");
IF iSession <> -1 THEN
// Successful case
ELSE
END
...
See Also
AccumBrowsePrev
The AccumBrowsePrev function moves the data browse cursor back one record. If you call
this function after you have reached the beginning of the records, error 412 is
returned (Databrowse session EOF).
Syntax
AccumBrowsePrev(iSession)
iSession:
Return Value
Related Functions
cumBrowseNumRecords, AccumBrowseOpen
See Also
124
Chapter: 17 ActiveX Functions
ActiveX functions enable you to create and interact with ActiveX objects, using CitectSCA-
DA as an ActiveX container.
ActiveX Functions
Following are functions relating to ActiveX objects:
_ObjectCallMethod Calls a specific method for an ActiveX object.
_ObjectGetProperty Retrieves a specific property of an ActiveX ob-
ject.
_ObjectSetProperty Sets a specific property of an ActiveX object.
AnByName Retrieves the animation point number of an
ActiveX object.
CreateControlObject Creates a new instance of an ActiveX object.
CreateObject Creates the automation component of an Ac-
tiveX object.
ObjectAssociateEvents Allows you to change the ActiveX object’s
event class.
ObjectAssociatePropertyWithTag Establishes an association between a variable
tag and an ActiveX object property.
ObjectByName Retrieves an ActiveX object.
ObjectHasInterface Queries the ActiveX component to determine if
its specific interface is supported.
ObjectIsValid Determines if the given handle for an object is
valid.
ObjectToStr Converts an object handle to a string.
See Also
Functions Reference
_ObjectCallMethod
Calls a specific method for an ActiveX object. (See the documentation for your ActiveX ob-
ject for details on methods and properties.)
Note: The parameter list passed to the control can only have Cicode variables or variable
tags; it cannot use values returned directly from a function because an ActiveX control may
modify parameters passed to it.
For example:
//Calculate a value and pass to ActiveX control
_ObjectCallMethod(hControl, "DoSomething" CalcValue());
is not allowed because the return value of a function cannot be modified. The following
should be used instead:
125
INT nMyValue;
//Calculate Value
nMyValue = CalcValue();
//Pass Value to ActiveX control
_ObjectCallMethod(hControl, "DoSomething" nMyValue);
Syntax
_ObjectCallMethod(hObject, sMethod, vParameters)
hObject:
The handle for the object (as returned by the ObjectByName() function).
sMethod:
The name of the method.
vParameters:
A variable length parameter list of method arguments. The variables will be
passed however you enter them, and will then be coerced into appropriate auto-
mation types. Likewise, any values modified by the automation call will be writ-
ten back - with appropriate coercion - into the passed Cicode variable.
Return Value
The return value from the method - if successful, otherwise an error is returned.
Related Functions
ObjectByName, DspAnCreateControlObject, CreateObject, CreateControlObject
Example
See CreateControlObject.
See Also
ActiveX Functions
_ObjectGetProperty
Gets a specific property of an ActiveX object.
Syntax
_ObjectGetProperty(hObject, sProperty)
hObject:
sProperty:
The name of the property you want to get.
Return Value
The value of the property - if successful, otherwise an error is returned.
Related Functions
126
Example
See CreateControlObject
See Also
ActiveX Functions
_ObjectSetProperty
Sets a specific property of an ActiveX object.
Syntax
_ObjectSetProperty(hObject, sProperty, vValue)
hObject:
sProperty:
The name of the property you want to set.
vValue:
The value to which the property will be set. This value can be of any data type.
Appropriate coercion will take place when creating the equivalent automation
parameter.
Return Value
Related Functions
Example
See Also
ActiveX Functions
AnByName
Retrieves the animation point number of an ActiveX object.
Syntax
AnByName(sName)
sName:
The name for the object in the form of "AN" followed by its AN number, for ex-
ample, "AN35". This name is used to access the object.
Return Value
The animation point number of the object - if successful, otherwise an error is returned.
127
Related Functions
CreateControlObject
See Also
ActiveX Functions
CreateControlObject
Creates a new instance of an ActiveX object.
An object created using this function remains in existence until the page is closed or the as-
sociated Cicode Object is deleted. This function does not require an existing animation
point. When the object is created, an animation point is created internally. This animation
point is freed when the object is destroyed.
Syntax
CreateControlObject(sClass, sName, x1, y1, x2, y2, sEventClass)
sClass:
The class of the object. You can use the object’s human readable name, its pro-
gram ID, or its GUID. If the class does not exist, the function will return an error
message.
For example:
 "Calendar Control 8.0" - human readable name
 "MSCAL.Calendar.7" - Program ID
 "{8E27C92B-1264-101C-8A2F-040224009C02}" - GUID
sName:
x1:
The x coordinate of the object’s top left hand corner as it will appear in your Cit-
ectSCADA window.
y1:
The y coordinate of the object’s top left hand corner as it will appear in your Cit-
ectSCADA window.
x2:
The x coordinate of the object’s bottom right hand corner as it will appear in your
CitectSCADA window.
y2:
The y coordinate of the object’s bottom right hand corner as it will appear in your
CitectSCADA window.
sEventClass:
The string you would like to use as the event class for the object.
Return Value
The newly created object, if successful, otherwise an error is generated.
128
Related Functions
DspAnCreateControlObject, CreateObject, AnByName
Example
// This function creates a single instance of the calendar control
at the designated location with an object name of "CalendarEvent"
and an event class of "CalendarEvent"//
FUNCTION
CreateCalendar()
OBJECT Calendar;
STRING sCalendarClass;
STRING sEventClass;
STRING sObjectName;
sCalendarClass = "MSCal.Calendar.7";
sEventClass = "CalendarEvent";
sObjectName = "MyCalendar";
Calendar = CreateControlObject(sCalendarClass, sObjectName, 16,
100, 300, 340, sEventClass);
END
// This function shows how to change the title font of the
calendar//
FUNCTION
CalendarSetFont(STRING sFont)
OBJECT Font;
OBJECT Calendar;
Calendar = ObjectByName("MyCalendar");
Font = _ObjectGetProperty(Calendar, "TitleFont");
_ObjectSetProperty(Font, "Name", sFont);
END
// This function shows how to change the background color of the
calendar//
FUNCTION
CalendarSetColour(INT nRed, INT nGreen, INT nBlue)
OBJECT Calendar;
_ObjectSetProperty(Calendar, "BackColor",
PackedRGB(nRed,nGreen,nBlue));
END
// This function shows how to call the NextDay method of the
calendar//
FUNCTION
CalendarNextDay()
OBJECTCalendar;
_ObjectCallMethod(Calendar, "NextDay");
END
// This function shows you how to write a mouse click event
handler for the calendar//
FUNCTION
CalendarEvent_Click(OBJECT This)
INT nDay;
INT nMonth;
INT nYear;
nDay = _ObjectGetProperty(This, "Day");
nMonth = _ObjectGetProperty(This, "Month");
nYear = _ObjectGetProperty(This, "Year");
...
Your code goes here...
...
129
END
See Also
ActiveX Functions
CreateObject
Creates a new instance of an ActiveX object. If you use this function to create an ActiveX
object, it will have no visual component (only the automation component will be created).
If you assign an object created with the CreateObject() function to a local variable, that ob-
ject will remain in existence until the variable it is assigned to goes out of scope. This means
that such an object will only be released when the Cicode function that created it ends.
If you assign an object created with the CreateObject() function to a module or global scope
variable, then that object will remain in existence until the variable either has another object
assigned or is set to NullObject, provided the CreateObject() call is not made within a loop.
Objects created by calls to CreateObject() within WHILE or FOR loops are only released on
termination of the Cicode function in which they are created, regardless of the scope of the
variable to which the object is assigned. The use of CreateObject() within a loop may there-
fore result in the exhaustion of system resources, and is not generally recommended unless
performed as shown in the examples below.
Syntax
CreateObject(sClass)
sClass:
gram ID, or its GUID. If the class does not exist, the function will return an error.
For example:
 "{8E27C92B-1264-101C-8A2F-040224009C02}" - GUID
Return Value
Related Functions
DspAnCreateControlObject, CreateControlObject
Example
The following examples show correct techniques for calling CreateObject() within a loop.
/* In the example below, the variable objTest is local. Resources
associated with calls to ProcessObject() will be released each
time that function ends. */
FUNCTION Forever()
WHILE 1 DO
ProcessObject();
Sleep(1);
END
130
END
FUNCTION ProcessObject()
.OBJECT objTest;
objTest=CreateObject("MyObject");
- do something
END
/* In the example below, the variable objTest is global. Resources
associated with calls to ProcessObject() will be released when
objTest is set to NullObject. */
FUNCTION Forever()
WHILE 1 DO
ProcessObject();
Sleep(1);
END
END
FUNCTION ProcessObject()
objTest=CreateObject("MyObject");
- do something
objTest=NullObject;
END
See Also
ActiveX Functions
ObjectAssociateEvents
Allows you to change the ActiveX object’s event class. If you have inserted an object on a
graphics page using Graphics Builder, it allows you to change the event class to something
other than the default of PageName_ObjectName
Syntax
ObjectAssociateEvents(sEventClass, hSource)
sClass:
gram ID, or its GUID. If the class does not exist, the function will report an error.
hSource:
The source object firing the events which are to be handled by the event handler.
For example:
 "{8E27C92B-1264-101C-8A2F-040224009C02}" - GUID
Return Value
Related Functions
DspAnCreateControlObject, CreateControlObject
Example
Inserting ActiveX objects using Cicode
131
If you have created an ActiveX object using Cicode (for example, by calling the function
CreateControlObject()), the parameter ’sEventClass’ would have required you to define
an event class for the object to enable event handling. If you want to change the class you
used, you can call ObjectAssociateEvents().
Inserting ActiveX objects via Graphics Builder
If you have inserted an ActiveX object in Graphics Builder, runtime will automatically cre-
ate an event class for the object in the form PageName_ObjectName. If this is the case, you
may want to change the object’s event class.
Using the example of an ActiveX sludge tank controller, the default event class for the ob-
ject could be "PageName_AN35". This means any events handlers for the object would take
the form "PageName_AN35_Click" (presuming this example relates to a click event). You
may want to define this more clearly, in which case you can call the following:
// This function redefines the event class for the ActiveX sludge
tank controller at AN35 to "SludgeTank". //
ObjectAssociateEvents ("SludgeTank", ObjectByName(AN35));
..
With the event class for the object now defined as "SludgeTank", the event handlers can
take the form "SludgeTank_Click".
This would be useful if you define event handlers in relation to an object that will eventu-
ally be copied to other graphics pages, as it will reduce the need to redefine the event han-
dlers to identify the default event class associated with each new placement of the object.
See Also
ActiveX Functions
ObjectAssociatePropertyWithTag
Establishes an association between an ActiveX property and a variable tag. This means that
any changes made to an ActiveX object property will be mirrored in the variable tag.
Generally, ActiveX objects issue "property change notifications" to CitectSCADA whenev-
er a change occurs to a specific property value. This notification tells CitectSCADA when
to read the property value.
Note: An association will not succeed if property change notifications are not supported
and the OnChangeEvent argument is left blank. Verify that the scaling and units of the as-
sociated tag are compatible with the ActiveX property values. However, some property
changes do not trigger property change notifications. If this is the case, you need to choose
an appropriate "on change" event instead - an event fired by the ActiveX object in response
to a change. An "appropriate" event is one that happens to be fired whenever the property
value changes. For example, the MS Calendar Control fires an AfterUpdate event whenev-
er a day button is pressed.
Syntax
ObjectAssociatePropertyWithTag(sObject, sPropertyName, sTagName [, sOnChangeEvent] )
sObject:
The object instance that associates a property with a tag.
132
sPropertyName:
The name of the ActiveX property to associate with the tag.
sTagName:
The name of the CitectSCADA variable tag to associate with the property.
sOnChangeEvent:
The name of the "on change" event that informs CitectSCADA of a change to the
ActiveX object. This is required where the ActiveX object does not automatically
generate a property change notification. Choose an event that happens to be fired
whenever the ActiveX object property changes, for example, the MS Calendar
Control fires an AfterUpdate event whenever a day button is pressed.
Return Value
Related Functions
DspAnCreateControlObject, CreateObject, CreateControlObject
See Also
ActiveX Functions
ObjectByName
Retrieves an ActiveX object. This is useful when you know the object by name only (this
will often be the case for objects created during configuration, rather than those created at
runtime using a Cicode function).
Syntax
ObjectByName(sName)
sName:
Return Value
The requested object, if successful, otherwise an error is generated.
Related Functions
DspAnCreateControlObject, CreateObject, CreateControlObject
Example
See Also
ActiveX Functions
ObjectHasInterface
Queries the ActiveX component to determine if its specific interface is supported. (Refer to
the ActiveX object’s documentation for details of its interfaces.)
133
Syntax
ObjectHasInterface(hObject, sInterface)
hObject:
sInterface:
The name of the interface (case sensitive).
Return Value
0 if the interface is not supported, otherwise 1.
Related Functions
ObjectByName, CreateObject, CreateControlObject
Example
hPen = _ObjectGetProperty(hControl, "Pen");
IF ObjectHasInterface(hPen, "IDigitalPen") THEN
//Fill is only supported on digital pen
_ObjectSetProperty(hPen, "Fill", 0)
END
See Also
ActiveX Functions
ObjectIsValid
Determines if the given handle for an object is a valid handle. This function is useful for
programmatically checking that an object was returned for a call.
Syntax
ObjectIsValid(hObject)
hObject:
Return Value
0 if the handle is not valid, otherwise 1.
Related Functions
Example
hFont = _ObjectGetProperty(hControl, "Font");
IF ObjectIsValid(hFont) THEN
_ObjectSetProperty(hFont, "Size", 22)
END
134
See Also
ActiveX Functions
ObjectToStr
Converts an object handle to a string.
Syntax
ObjectToStr(hObject)
hObject:
Return Value
A string containing the converted object handle
Related Functions
See Also
ActiveX Functions
135
136
Chapter: 18 Alarm Functions
Alarm functions display alarms and their related alarm help pages, and acknowledge, dis-
able, and enable alarms. They provide information about alarms and allow your operators
to add comments to alarm records. You can also access alarms at the record level (on the
alarms server) for more complex operations.
Alarm Functions
Following are functions relating to alarms:
AlarmAck Acknowledges alarms.
AlarmAckRec Acknowledges alarms by record number.
AlarmActive Determines if any alarms are active in the user’s area.
AlarmClear Clears acknowledged, inactive alarms from the active
alarm list.
AlarmClearRec Clear an alarm by its record number.
AlarmComment Allows users to add comments to alarm summary en-
tries.
AlarmDelete Deletes alarm summary entries.
AlarmDisable Disables alarms.
AlarmDisableRec Disables alarms by record number.
AlarmDsp Displays alarms.
AlarmDspLast Displays the most recent, unacknowledged alarms.
AlarmDspNext Displays the next page of alarms.
AlarmDspPrev Displays the previous page of alarms.
AlarmEnable Enables alarms.
AlarmEnableRec Enables alarms by record number.
AlarmEventQue Opens the alarm event queue.
AlarmFirstCatRec Searches for the first occurrence of an alarm category
and type.
AlarmFirstPriRec Searches for the first occurrence of an alarm priority
and type.
AlarmFirstTagRec Searches for the first occurrence of an alarm tag,
name, and description.
AlarmGetDelay Gets the delay setting for an alarm.
AlarmGetDelayRec Gets the delay setting for an alarm via the alarm
record number.
AlarmGetDsp Gets field data from the alarm record that is displayed
at the specified AN.
AlarmGetFieldRec Gets alarm field data from the alarm record number.
AlarmGetInfo Gets information about an alarm list displayed at an
AN.
AlarmGetOrderbyKey Retrieves the list of key(s) used to determine the or-
der of the alarm list.
AlarmGetThreshold Gets the thresholds of analog alarms.
137
AlarmGetThresholdRec Gets the thresholds of analog alarms by the alarm

record number.
AlarmHelp Displays the help page for the alarm where the cursor
is positioned.
AlarmNextCatRec Searches for the next occurrence of an alarm category
and type.
AlarmNextPriRec Searches for the next occurrence of an alarm priority
and type.
AlarmNextTagRec Searches for the next occurrence of an alarm tag,
name, and description.
AlarmNotifyVarChange Activates a time-stamped digital or time-stamped an-
alog alarm
AlarmQueryFirstRec Searches for the first occurrence of an alarm category
(or priority) and type.
AlarmQueryNextRec Searches for the next occurrence of an alarm category
(or priority) and type.
AlarmSetDelay Changes the delay setting for an alarm.
AlarmSetDelayRec Changes the delay set for an alarm via the alarm
record number.
AlarmSetInfo Changes the display parameters for the alarm list dis-
played at an AN.
AlarmSetQuery Specifies a query .to be used in selecting alarms for
display.
AlarmSetThreshold Changes the thresholds of analog alarms.
AlarmSetThresholdRec Changes the thresholds of analog alarms by the alarm
record number.
AlarmSplit Duplicates an alarm summary entry where the cursor
is positioned.
AlarmSumAppend Appends a new blank record to the alarm summary.
AlarmSumCommit Commits the alarm summary record to the alarm
summary device.
AlarmSumDelete Deletes alarm summary entries.
AlarmSumFind Finds an alarm summary index for an alarm record
and alarm on time.
AlarmSumFirst Gets the oldest alarm summary entry.
AlarmSumGet Gets field information from an alarm summary entry.
AlarmSumLast Gets the most recent alarm summary entry.
AlarmSumNext Gets the next alarm summary entry.
AlarmSumPrev Gets the previous alarm summary entry.
AlarmSumSet Sets field information in an alarm summary entry.
AlarmSumSplit Duplicates an alarm summary entry.
AlarmSumType Retrieves a value that indicates a specified alarm’s
type.
AlmSummaryAck Acknowledges the alarm at the current cursor position
in an active data browse session.
AlmSummaryClear Clears the alarm at the current cursor position in an
active data browse session.
AlmSummaryClose Closes an alarm summary browse session.
138
AlmSummaryCommit Commits the alarm summary record to the alarm

summary device.
AlmSummaryDelete Deletes alarm summary entries from the browse ses-
sion.
AlmSummaryDeleteAll Deletes all alarm summary entries from the browse
session.
AlmSummaryDisable Disables the alarm at the current cursor position in an
AlmSummaryEnable Enables the alarm at the current cursor position in an
AlmSummaryFirst Gets the oldest alarm summary entry.
AlmSummaryGetField Gets the field indicated by the cursor position in the
browse session.
AlmSummaryLast Places the data browse cursor at the most recent sum-
mary record from the last cluster of the available
browsing cluster list.
AlmSummaryNext Gets the next alarm summary entry in the browse ses-
sion.
AlmSummaryOpen Opens an alarm summary browse session.
AlmSummaryPrev Gets the previous alarm summary entry in the browse
session.
AlmSummarySetFieldValue Sets the value of the field indicated by the cursor po-
sition in the browse session.
AlmTagsAck Acknowledges the alarm tag at the current cursor po-
sition in an active data browse session.
AlmTagsClear Clears the alarm tag at the current cursor position in
an active data browse session.
AlmTagsClose Closes an alarm tags browse session.
AlmTagsDisable Disables the alarm tag at the current cursor position
in an active data browse session.
AlmTagsEnable Enables the alarm tag at the current cursor position in
AlmTagsFirst Gets the oldest alarm tags entry.
AlmTagsGetField Gets the field indicated by the cursor position in the
browse session.
AlmTagsNext Gets the next alarm tags entry in the browse session.
AlmTagsNumRecords Returns the number of records in the current browse
session.
AlmTagsOpen Opens an alarm tags browse session.
AlmTagsPrev Gets the previous alarm tags entry in the browse ses-
sion.
See Also
Functions Reference
AlarmAck
Acknowledges alarms. You can acknowledge the alarm where the cursor is positioned, one
or more alarm lists on the active page, a whole category of alarms, or alarms of a particular
priority.
139
You would normally call this function from a keyboard command. No action is taken if the
specified alarms have already been acknowledged.
Syntax
AlarmAck(Mode, Value [, ClusterName])
Mode:
The type of acknowledgment:
0 - Acknowledge a single alarm where the cursor is positioned. Set Value to 0 (ze-
ro) - it is not used.
1 - Acknowledge a page of alarms. AN alarm page can contain more than one
alarm list:
 Set Value to the AN where the alarm list is displayed.
 Set Value to 0 to acknowledge the (displayed) alarm list (on the active
page) where the cursor is positioned.
 Set Value to -1 to acknowledge all (displayed) alarm lists on the active
page.
2 - Acknowledge a category of alarms:
 Set Value to the alarm category (0 to 16376) of the alarms to be acknowl-
edged. Please be aware that Alarm category 0 indicates all categories;
alarm category 255 indicates hardware alarms.
 Set Value to the group number to acknowledge a group of categories.
3 - Acknowledge alarms of a specific priority.
 Set Value to the alarm priority (0-255) of the alarms to be acknowledged.
Alarm priority 0 indicates all priorities.
Hardware alarms are not affected by priority.
Set Value to the group handle to acknowledge a group of alarms of differ-
ent priorities.
Value:
Used with Mode 1 and 2 to specify which alarms to acknowledge.
ClusterName:
Used with Mode 2 or 3 to specify the name of the cluster in which the alarms be-
ing acknowledged reside. This argument is optional if the client is connected to
only one cluster containing an Alarm Server or are resolving the alarm server via
the current cluster context.
This argument is not required where:
 the mode is 2 and the value is 255 (hardware alarm category).
This argument is enclosed in quotation marks "".
Return Value
Related Functions
GrpOpen
140
Example
System Keyboard
Key Sequence LeftButton
Command AlarmAck(0, 0)
Comment Acknowledge the alarm where the cursor is positioned
System Keyboard
Key Sequence ShiftLeftButton
Command AlarmAck(1, -1)
Comment Acknowledge a page of alarms
System Keyboard
Key Sequence AlarmAck ### Enter
Command AlarmAck(2, Arg1, "clusterXYZ")
Comment Acknowledge all alarms of a specified category in cluster XYZ
System Keyboard
Key Sequence AckPri ############# Enter
Command AlarmAck(3,Arg1, "clusterXYZ")
Comment Acknowledge all alarms of a specific priority in cluster XYZ
! Acknowledge all alarms of the specified group of categories.

FUNCTION
AckGrp(STRING CategoryGroup)
INT hGrp;
hGrp=GrpOpen("CatGroup",1);
StrToGrp(hGrp,CategoryGroup);
AlarmAck(2,hGrp, "clusterXYZ");
GrpClose(hGrp);
END
See Also
Alarm Functions
AlarmAckRec
Acknowledges alarms by record number on both the Primary and Standby Alarm Servers.
This function can be called from Alarm Server or Client and should not be used with a
MsgRPC() call to the Alarm Server.
Syntax
AlarmAckRec(Record [, ClusterName] )
Record:
The alarm record number, returned from any of the following alarm functions:
 AlarmFirstCatRec() or AlarmNextCatRec(): used to search for a record by
alarm category, area, and type (acknowledged, disabled, etc.).
 AlarmFirstPriRec() or AlarmNextPriRec(): used to search for a record by
alarm priority, area, and type (acknowledged, disabled, etc.).
 AlarmFirstTagRec() or AlarmNextTagRec(): used to search for a record by
alarm tag, name, and description.
141
 AlarmGetDsp(): used to find the record that is displayed at a specified AN, for
either an alarm list or alarm summary entry. Set the sField argument in
AlarmGetDsp() to "RecNo".
To store this value, use data type Int in Cicode or Long for variable tags (Long
needs 4 bytes).
ClusterName:
Specifies the name of the cluster in which the Alarm Server resides. This is option-
al if you have one cluster or are resolving the alarm server via the current cluster
context. The argument is enclosed in quotation marks "".
Return Value
Related Functions
AlarmFirstCatRec, AlarmFirstTagRec, AlarmNextTagRec, AlarmGetDelayRec, MsgRPC
Example
/* Acknowledge all unacknowledged (Type 1) alarms of the specified
alarm category. */
FUNCTION
AutoAccept(INT Category)
INT Current;
INT Next;
Current=AlarmFirstCatRec(Category,1);
WHILE Current<>-1 DO
Next=AlarmNextCatRec(Current,Category,1);
AlarmAckRec(Current);
Current=Next;
END
END
See Also
Alarm Functions
AlarmActive
Determines if any alarms are active in the user’s area. Call this function from the Page
Strings database, to display an alarm message at a specified AN on a graphics page. You
can specify the type of alarms, for example, active hardware alarms or disabled non-hard-
ware alarms.
Syntax
AlarmActive(Type [, ClusterName] )
Type:
The type of alarms to check:
Non-hardware alarms
0 - Active alarms
1 - Unacknowledged alarms, ON and OFF
3 - Disabled alarms
142
Hardware alarms
5 - Active alarms
6 - Unacknowledged alarms, ON and OFF
ClusterName:
The name of the cluster to check for active alarms. If this argument is blank or
empty, the function will check all connected clusters.
Return Value
 1 or 0 for Non-hardware alarms (modes 0, 1, and 3).
 The number of active alarms for Hardware alarms (modes 5 and 6).
Example
Strings
AN 9
Expression AlarmActive(5)
True Text "Hardware Alarms Active"
False Text "No Active Hardware Alarms"
Comment Display the alarm status at AN 9
See Also
Alarm Functions
AlarmClear
Clears an acknowledged (and off) alarm from the active alarm list. You can clear the alarm
where the cursor is positioned, one or more alarm lists on the active page, a whole category
of alarms, or alarms of a particular priority.
If you set the [Alarm]AckHold parameter to 1, alarms that go off and have been acknowl-
edged are not removed from the active list until this function is called.
Syntax
AlarmClear(Mode, Value [, ClusterName] )
Mode:
The type of clear:
0 - Clear a single alarm where the cursor is positioned:
 Set Value to 0 (zero) - it is not used.
1 - Clear a page of alarms. AN alarm page can contain more than one alarm list:
 Set Value to 0 to clear the (displayed) alarm list (on the active page) where
the cursor is positioned.
 Set Value to -1 to clear all (displayed) alarm lists on the active page.
2 - Clear a category of alarms:
 Set Value to the alarm category (0 to 16376) of the alarms to clear. Please be
aware that alarm category 0 indicates all categories; alarm category 255 in-
dicates hardware alarms.
 Set Value to the group number to clear a group of categories.
143
3 - Clear alarms of a specific priority.

 Set Value to the alarm priority (0-255) of the alarms to be cleared.
Alarm priority 0 indicates all priorities. Hardware alarms are not affect-
ed by priority. Set Value to the group handle to clear a group of alarms
of different priorities.
Value:
Used with Mode 1 or 2 to specify which alarms to clear.
ClusterName:
ing cleared reside. This argument is optional if the client is connected to only one
cluster containing an Alarm Server or you are resolving the alarm server via the
current cluster context.
Return Value
Related Functions
AlarmAck
Example
System Keyboard
Key Sequence Clear
Command AlarmClear(0, 0)
Comment Clear the alarm where the cursor is positioned
System Keyboard
Key Sequence ClearAll
Command AlarmClear(1, -1)
Comment Clear a page of alarms
System Keyboard
Key Sequence AlarmClear ### Enter
Command AlarmClear(2, Arg1, "clusterXYZ")
Comment Clear all alarms of a specified category in cluster XYZ
System Keyboard
Key Sequence CtrlClear
Command AlarmClear(2, 0, "clusterXYZ")
Comment Clear all categories of inactive alarms in cluster XYZ
System Keyboard
Key Sequence ClearPri ########### Enter
Command AlarmClear(3,Arg1, "clusterXYZ")
Comment Clear all alarms of a specific priority in cluster XYZ
See Also
Alarm Functions
144
AlarmClearRec
Clears an alarm by its record number on both the Primary and Standby Alarms Servers.
This function can be called from Alarm Server or Client and should not be used with a
Syntax
AlarmClearRec(Record [, ClusterName] )
Record:
 AlarmFirstCatRec() or AlarmNextCatRec() - used to search for a record by
 AlarmFirstPriRec() or AlarmNextPriRec() - used to search for a record by
 AlarmFirstTagRec() or AlarmNextTagRec() - used to search for a record by
 AlarmGetDsp() - used to find the record that is displayed at a specified AN,
for either an alarm list or alarm summary entry. Set the sField argument in
needs 4 bytes).
ClusterName:
Return Value
Related Functions
AlarmFirstCatRec, AlarmAck, AlarmFirstTagRec, AlarmNextTagRec, AlarmGetDelayRec,
MsgRPC
See Also
Alarm Functions
AlarmComment
Allows an operator to add a comment to a selected alarm summary entry during runtime.
You would normally call this function from a keyboard command.
Comments can only be added to alarm summary (Alarm Type 10) alarms.
Syntax
AlarmComment(sComment)
sComment:
The comment to add to the alarm summary entry. Comments have a maximum
of 128 characters.
145
Return Value
Related Functions
AlarmDsp
Example
System Keyboard
Key Sequence Com ################## Enter
Command AlarmComment(Arg1)
Comment Add an alarm comment to the alarm where the cursor is positioned
See Also
Alarm Functions
AlarmDelete
Deletes alarm summary entries that are currently displayed. You can delete the alarm
where the cursor is positioned, one or more alarm lists on the active page, a whole category
of alarms, or alarms of a particular priority.
You would normally call this function from a keyboard command.
Syntax
AlarmDelete(Mode, Value [, ClusterName] )
Mode:
The type of deletion:
0 - Delete a single alarm where the cursor is positioned.
1 - Delete a page of alarms. AN alarm page can contain more than one alarm list:
 Set Value to 0 to delete the (displayed) alarm list (on the active page) where
 Set Value to -1 to delete all (displayed) alarm lists on the active page.
2 - Delete a category of alarms.
 Set Value to the alarm category (0-16376) of the alarms to delete. Please be
aware that alarm category 0 indicates all categories; alarm category 255 in-
dicates hardware alarms.
 Set Value to the group number to delete a group of categories.
3 - Delete alarms of a specific priority.
 Set Value to the alarm priority (0-255) of the alarms to be deleted.
ed by priority. Set Value to the group handle to delete a group of alarms
of different priorities.
Value:
Used with Mode 1 or 2 to specify which alarms to delete.
ClusterName:
146
ing deleted reside. This argument is optional if the client is connected to only one
cluster containing an Alarm Server or you are resolving the alarm server via the
current cluster context. This argument is enclosed in quotation marks "".
Return Value
Related Functions
GrpOpen
Example
System Keyboard
Key Sequence DelSum
Command AlarmDelete(0, 0)
Comment Delete the alarm summary entry where the cursor is positioned
System Keyboard
Key Sequence ShiftDelSum
Command AlarmDelete(1, -1)
Comment Delete a page of alarm summary entries
System Keyboard
Key Sequence SumDelete ### Enter
Command AlarmDelete(2, Arg1, "clusterXYZ")
Comment Delete all alarm summary entries of a specified category in cluster XYZ
System Keyboard
Key Sequence DelSum ############# Enter
Command AlarmDelete(3,Arg1, "clusterXYZ")
Comment Delete all alarm summary entries of a specified priority in cluster XYZ
See Also
Alarm Functions
AlarmDisable
Disables alarms. You can disable the alarm where the cursor is positioned, one or more
alarm lists on the active page, a whole category of alarms, or alarms of a particular priority.
You would normally call this function from a keyboard command. No action is taken if the
alarms are already disabled. Use the AlarmEnable() function to re-enable an alarm.
After you disable an alarm, it does not display on the alarm page, alarm summary page, or
alarm log. If you set the [Alarm]DisplayDisable parameter to 1, logging of disabled alarms
continues, but the disabled alarms are not displayed on the alarm display or alarm summa-
ry pages.
Syntax
AlarmDisable(Mode, Value [, ClusterName] )
Mode:
147
The type of disable:

0 - Disable a single alarm where the cursor is positioned.
1 - Disable a page of alarms. AN alarm page can contain more than one alarm list:
 Set Value to 0 to disable the (displayed) alarm list (on the active page)
where the cursor is positioned.
 Set Value to -1 to disable all (displayed) alarm lists on the active page.
2 - Disable a category of alarms.
 Set Value to the alarm category (0-16376) of the alarms to be disabled.
Please be aware that alarm category 0 indicates all categories; alarm cate-
gory 255 indicates hardware alarms.
 Set Value to the group number to disable a group of categories.
3 - Disable alarms of a specific priority.
 Set Value to the alarm priority (0-255) of the alarms to be disabled.
ed by priority. Set Value to the group handle to disable a group of
alarms of different priorities.
Value:
Used with Mode 1 and 2 to specify which alarms to disable.
ClusterName:
Used with Mode 2 or 3 to specify the name of the cluster where the alarms being
disabled reside in. This argument is optional if the client is connected to only one
cluster containing an Alarm Server or are resolving the alarm server via the cur-
rent cluster context.
Return Value
Related Functions
GrpOpen, AlarmEnable, AlarmDisableRec
148
Example
System Keyboard
Key Sequence Disable
Command AlarmDisable(0, 0)
Comment Disable the alarm where the cursor is positioned
System Keyboard
Key Sequence ShiftDisable
Command AlarmDisable(1, -1)
Comment Disable a page of alarms
System Keyboard
Key Sequence AlarmDisable ### Enter
Command AlarmDisable(2, Arg1, "clusterXYZ")
Comment Disable all alarms of a specified category in cluster XYZ
System Keyboard
Key Sequence DisPri ############# Enter
Command AlarmDisable(3,Arg1,"clusterXYZ")
Comment Disable all alarms of a specific priority in cluster XYZ
See Also
Alarm Functions
AlarmDisableRec
Disables alarms by record number on both the Primary and Standby Alarms Servers. This
function can be called from Alarm Server or Client and should not be used with a
Syntax
AlarmDisableRec(Record [, ClusterName] )
Record:
needs 4 bytes).
ClusterName:
149
Return Value
Related Functions
AlarmFirstTagRec, AlarmNextTagRec, AlarmDisable, MsgRPC
Example
/* Disable/enable the specified "Pump" alarm. Flag determines
whether the alarm is disabled (Flag=0) or enabled (Flag=1). */
FUNCTION
DisablePumps(STRING sTag, INT Flag)
INT Current;
INT Next;
Current=AlarmFirstTagRec(sTag,"Pump","");
WHILE Current<>-1 DO
Next=AlarmNextTagRec(Current,sTag,"Pump","");
IF Flag=0 THEN
AlarmDisableRec(Current);
ELSE
AlarmEnableRec(Current);
END
Current=Next;
END
END
See Also
Alarm Functions
AlarmDsp
Displays an alarm list, starting at a specified AN and then on subsequent ANs. You specify
the number of alarms to display, the type of alarms and the name of the cluster the alarms
belong to, for example, active hardware alarms or disabled non-hardware alarms in cluster
XYZ. Before you call this function, you must first add animation points to the graphics page
for each alarm to be displayed.
If you only need to display the standard alarm page, use the PageAlarm function - it uses
this AlarmDsp() function to display alarms. If you need more control over the display of
alarms you can use this function, but only to display alarms on the alarm page. Use the
AlarmDspLast function to display alarms on another graphics page (it uses less memory).
Syntax
AlarmDsp(AN, Count [, Type] [, ClusterName] )
AN:
The AN where the first alarm is to display.
Count:
The number of alarms to display.
Type:
The type of alarms to display:
Non-hardware alarms
150
0 - All active alarms, that is Types 1 and 2

1 - All unacknowledged alarms, ON and OFF
2 - All acknowledged ON alarms
3 - All disabled alarms
4 - All configured (non-hardware) alarms, that is Types 0 to 3, plus ac-
knowledged OFF alarms.
Hardware alarms
9 - All configured alarms, that is Types 5 to 8
Alarm Summary
10 - All summary alarms
Alarm General
11 - All ON alarms
12 - All OFF alarms
13 - All ON hardware alarms
14 - All OFF hardware alarms
If you do not specify a Type, the default is 0.
ClusterName:
The cluster name to which the alarms belong. This is optional if you have one
cluster or are resolving the alarm server via the current cluster context. The argu-
ment is enclosed in quotation marks "".
If the client is connected to only one cluster containing an Alarms Server then this
argument is optional, the list returned will be limited to alarms within this clus-
ter.
If the client is connected to clusters containing more than one Alarms Server then
the Cluster Name must be specified or an error will be returned.
Return Value
Related Functions
AlarmDspNext, AlarmDspPrev, AlarmDspLast, AlarmGetInfo, PageAlarm
Example
Advanced Animation
Command AlarmDsp(20,15,3)
Comment Display 15 disabled alarms at AN 20
See Also
Alarm Functions
AlarmDspLast
Displays the most recent unacknowledged alarms, at a specified AN with the cluster
named. Use this function to display the last alarms on all (or selected) pages. You can spec-
151
ify the number of alarms to display of a specified type, for example, active hardware alarms
or disabled non-hardware alarms.
Syntax
AlarmDspLast(AN [, Count] [, Type] [, ClusterName] )
AN:
The AN where the last alarms are to be displayed.
Count:
The number of alarms to display. If you do not specify a Count, the default is 1.
Type:
The type of alarms to display:
Non-hardware alarms
4 - All configured (non-hardware) alarms, that is Types 0 to 3, plus acknowledged
OFF alarms.
Hardware alarms
9 - All configured alarms, that is Types 5 to 8
Alarm Summary
10 - All summary alarms
Alarm General
11 - All ON alarms
12 - All OFF alarms
13 - All ON hardware alarms
14 - All OFF hardware alarms
If you do not specify a Type, the default is 1.
ClusterName:
The cluster name to which the alarms belong. This is optional if you have one
cluster or are resolving the alarm server via the current cluster context. The argu-
If a cluster name is not specified, alarms are returned for all clusters.
Return Value
Related Functions
AlarmDsp
152
Example
Advanced Animation
Command AlarmDspLast(11, ’ClusterXYZ’)
Comment Display the last alarm at AN 11
Advanced Animation
Command AlarmDspLast(21,3, ’ClusterXYZ’)
Comment Display the last 3 alarms at AN 21
See Also
Alarm Functions
AlarmDspNext
Displays the next page of alarms. This function pages down (scrolls) the alarms displayed
by the AlarmDsp() function. You would normally call this function from a keyboard com-
mand.
Syntax
AlarmDspNext(AN)
AN:
The AN where the alarm list is displayed, or:
-1 - Scroll all alarm lists displayed on the page.
0 - Scroll the alarm list where the cursor is positioned.
Note: An alarm page can contain more than one alarm list.
Return Value
Related Functions
AlarmDsp, AlarmDspPrev
Example
System Keyboard
Key Sequence NextAlarm
Command AlarmDspNext(20)
Comment Display the next page of alarms (from the alarm list) at AN20
See Also
Alarm Functions
AlarmDspPrev
Displays the previous page of alarms. This function pages up (scrolls) the alarms displayed
by the AlarmDsp() function. You would normally call this function from a keyboard com-
mand.
153
Syntax
AlarmDspPrev(AN)
AN:
The AN where the alarm list is displayed, or:
-1 - Scroll all alarm lists displayed on the page.
0 - Scroll the alarm list where the cursor is positioned.
Note: An alarm page can contain more than one alarm list.
Return Value
Related Functions
AlarmDsp, AlarmDspNext
Example
System Keyboard
Key Sequence PrevAlarm
Command AlarmDspPrev(20)
Comment Display the previous page of alarms (from the alarm list) at AN20
See Also
Alarm Functions
AlarmEnable
Enables an alarm on the active alarm list. You can enable the alarm where the cursor is po-
sitioned, one or more alarm lists on the active page, a whole category of alarms, or alarms
of a particular priority.
No action is taken if the alarms are already enabled. You would normally call this function
from a keyboard command.
Syntax
AlarmEnable(Mode, Value [, ClusterName] )
Mode:
The type of enable:
0 - Enable a single alarm where the cursor is positioned.
1 - Enable a page of alarms. AN alarm page can contain more than one alarm list:
 Set Value to 0 to enable the (displayed) alarm list (on the active page) where
 Set Value to -1 to enable all (displayed) alarm lists on the active page.
2 - Enable a category of alarms.
 Set Value to the alarm category (0-16376) of the alarms to be enabled. Please
be aware that alarm category 0 indicates all categories; alarm category 255
indicates hardware alarms.
154
 Set Value to the group number to enable a group of categories.

3 - Enable alarms of a specific priority.
 Set Value to the alarm priority (0-255) of the alarms to be enabled.
Alarm priority 0 indicates all priorities. Hardware alarms are not affected by pri-
ority. 3) Set Value to the group handle to enable a group of alarms of differ-
ent priorities.
Value:
Used with Mode 1 and 2 to specify which alarms to enable.
ClusterName:
Used with Mode 2 or 3 to specify the name of the cluster where the alarms being
enabled reside in. This argument is optional if the client is connected to only one
cluster containing an Alarm Server or are resolving the alarm server via the cur-
rent cluster context.
Return Value
Related Functions
GrpOpen, AlarmDisable, AlarmEnableRec
Example
System Keyboard
Key Sequence Enable
Command AlarmEnable(0, 0)
Comment Enable the alarm where the cursor is positioned
System Keyboard
Key Sequence ShiftEnable
Command AlarmEnable(1, -1)
Comment Enable a page of alarms
System Keyboard
Key Sequence AlarmEnable ### Enter
Command AlarmEnable(2, Arg1, "clusterXYZ")
Comment Enable all alarms of a specified category in cluster XYZ
System Keyboard
Key Sequence EnPri ############# Enter
Command AlarmEnable(3,Arg1, "clusterXYZ")
Comment Enable all alarms of a specific priority in cluster XYZ
See Also
Alarm Functions
AlarmEnableRec
155
Enables alarms by record number on both the Primary and Standby Alarms Servers. This
function can be called from Alarm Server or Client and should not be used with a
Syntax
AlarmEnableRec(Record [, ClusterName])
Record:
needs 4 bytes).
ClusterName:
Return Value
Related Functions
AlarmFirstTagRec, AlarmNextTagRec, AlarmEnable, AlarmDisableRec, MsgRPC
Example
See AlarmDisableRec
See Also
Alarm Functions
AlarmEventQue
Opens the alarm event queue. The Alarms Server writes events into this queue as they are
processed. These events include all activated, reset, acknowledged, enabled and disabled
alarms. To read events from this queue, use the QueRead() or QuePeek() functions. The
data put into the queue is the alarm record identifier (into the Type field) and the alarm
event format (into the Str field). The function puts all state changes into the queue and Ci-
tectSCADA does not use this queue for anything.
To use this function, you must enable the alarm event queue with the [Alarm]EventQue pa-
rameter. This parameter will tell the Alarms Server to start placing events into the queue.
The [Alarm]EventFmt parameter defines the format of the data placed into the string field.
You can enable the EventQue parameter without setting the event format so that the
Alarms Server does not place a formatted string into the queue.
156
Enabling this formatting feature can increase CPU loading and reduce performance of the
Alarms Server as every alarm is formatted and placed in the queue. You should reconsider
using this feature if a decrease in performance is noticeable.
The maximum length of each queue is controlled by the [Code]Queue parameter. You may
need to adjust this parameter so as not to miss alarm events. When the queue is full, the
Alarms Server will discard events.
Syntax
AlarmEventQue()
Return Value
The handle of the alarm event queue, or -1 if the queue cannot be opened.
Related Functions
QueRead, QuePeek, TagWriteEventQue
Example
hQue = AlarmEventQue()
WHILE TRUE DO
QueRead(hQue, nRecord, sAlarmFmt, 1);
/* do what ever with the alarm event */
...
Sleep(0);
END
See Also
Alarm Functions
AlarmFirstCatRec
Searches for the first occurrence of an alarm category and type. You can search all areas, the
current area only, or specify an area to limit the search. If calling this function from a re-
mote client, use the MsgRPC() function.
This function returns an alarm record identifier that you can use in other alarm functions,
for example, to acknowledge, disable, or enable the alarm, or to get field data on that alarm.
Note: Record numbers obtained from AlarmGetDsp must not be used with this function.
When the Alarm Server is not in the calling process, this function will become blocking and
cannot be called from a foreground task. In this case, the return value will be undefined and
a Cicode hardware alarm will be raised.
Syntax
AlarmFirstCatRec(Category, Type [, Area] [, ClusterName] )
Category:
The alarm category or group number to match. Set Category to 0 (zero) to match
all alarm categories.
Type:
157
The type of alarms to find:

Non-hardware alarms
0 - All active alarms, that is Types 1 and 2.
1 - All unacknowledged alarms, ON and OFF.
2 - All acknowledged ON alarms.
3 - All disabled alarms.
4 - All configured alarms, that is, types 0 to 3, plus acknowledged OFF alarms. If
you do not specify a type, the default is 0.
Area:
The area in which to search for alarms. If you do not specify an area, or if you set
Area to -1, only the current area will be searched.
ClusterName:
Return Value
The alarm record identifier or -1 if no match is found.
Related Functions
GrpOpen, AlarmNextCatRec, AlarmFirstPriRec, AlarmNextPriRec, AlarmGetFieldRec,
AlarmAckRec, AlarmDisableRec, AlarmEnableRec, AlarmGetThresholdRec, Alarm-
SetThresholdRec, MsgRPC
Example
See AlarmAckRec
See Also
Alarm Functions
AlarmFirstPriRec
Searches for the first occurrence of an alarm priority and type. You can search all areas, the
current area only, or specify an area to limit the search. If calling this function from a re-
mote client, use the MsgRPC() function.
Note: This function will return a match for an Acknowledge Off alarm with [Alarm]Ack-
Hold=1 even after it has been cleared using AlarmClear or AlarmClearRec.
158
Syntax
AlarmFirstPriRec(Priority, Type [, Area] [, ClusterName] )
Priority:
The alarm Priority or group handle of a group of alarm priorities. Set Priority to
0 (zero) to match all alarm priorities.
Type:
Non-hardware alarms
4 - All configured alarms, that is types 0 to 3, plus acknowledged OFF alarms. If
you do not specify a type, the default is 0.
Area:
ClusterName:
Return Value
The alarm record identifier or -1 if no match is found. If you do not specify an area, only
alarms in the current area on the alarms server are searched.
Related Functions
GrpOpen, AlarmNextCatRec, AlarmFirstPriRec, AlarmNextPriRec, AlarmGetFieldRec,
Example
/* Acknowledge all unacknowledged (Type 1) alarms of the specified
alarm priority. */
FUNCTION
AutoAccept(INT iPriority)
INT iCurrent;
INT iNext;
iCurrent=AlarmFirstPriRec(iPriority,1,-1);
WHILE iCurrent <>-1 DO
iNext=AlarmNextPriRec(iCurrent,iPriority,1,-1);
AlarmAckRec(iCurrent);
iCurrent=iNext;
END
END
159
See Also
Alarm Functions
AlarmFirstTagRec
Searches for the first occurrence of an alarm tag, name, and description. If calling this func-
tion from a remote client, use the MsgRPC() function.
Note: This function will return a match for an Acknowledge Off alarm with [Alarm]Ack-
Hold=1 even after it has been cleared using AlarmClear or AlarmClearRec.
Syntax
AlarmFirstTagRec(Tag, Name, Description [, ClusterName] )
Tag:
The alarm tag to be matched. Specify an empty string (" ") to match all alarm tags.
Name:
The alarm name to be matched. Specify an empty string (" ") to match all alarm
names.
Description:
The alarm description to be matched. Specify an empty string (" ") to match all
alarm descriptions.
ClusterName:
Return Value
Related Functions
AlarmNextTagRec, AlarmGetFieldRec, AlarmAckRec, AlarmDisableRec, AlarmEna-
bleRec, AlarmGetThresholdRec, AlarmSetThresholdRec, MsgRPC
Example
See AlarmDisableRec
See Also
Alarm Functions
AlarmGetDelay
160
Gets the delay setting for the alarm the cursor is currently positioned over.
Syntax
AlarmGetDelay(Type)
Type:
The type of delay:
0 - Delay (digital alarm/advancedalarm)
1 - High high delay (analog alarm)
2 - High delay (analog alarm)
3 - Low delay (analog alarm)
4 - Low low delay (analog alarm)
5 - Deviation delay (analog alarm)
Return Value
The alarm delay if successful, otherwise -1 is returned. Use IsError() to retrieve extended
error information.
Related Functions
AlarmNotifyVarChange, AlarmSetDelayRec, AlarmGetDelayRec
See Also
Alarm Functions
AlarmGetDelayRec
Gets the delay setting for an alarm via the alarm record number.
Syntax
AlarmGetDelayRec(Record, Type [, ClusterName] )
Record:
Type:
The type of delay:
0 - Delay (digital alarm/advancedalarm)
161

ClusterName:
Return Value
The alarm delay if successful, otherwise -1 is returned. Use IsError() to retrieve extended
error information.
Related Functions
AlarmNotifyVarChange, AlarmSetDelayRec, AlarmGetDelay
See Also
Alarm Functions
AlarmGetDsp
Gets field data from the alarm record that is displayed at the specified AN. You can use this
function for both Alarm Pages and Alarm Summaries (an Alarm Page or Alarm Summary
must be displayed before this function can be used).
You can call this function on an Alarms Server or a client to get the contents of any field in
the alarm record at that AN.
You can return the record number of the alarm record for use in other alarm functions, for
example, to acknowledge, disable, or enable an alarm (on an Alarms Server).
The AlarmGetDsp() function does not support hardware alarms.
Syntax
AlarmGetDsp(AN, sField)
AN:
The AN where the alarm entry is displayed.
sField:
The name of the field from which the data is retrieved. The contents of the follow-
ing fields can be retrieved when the Alarm Page is displayed:
Field Description
Category Alarm category
Desc Alarm description
Help Alarm help page
Name Alarm name
Tag Alarm tag
Time The time that the alarm changed state (hh:mm:ss)
162
Field Description
RecNo The alarm record number
Comment Operator comments attached to the Alarm Log entry (if any)
Date The date that the alarm changed state (mm/dd/yyyy)
DateExt The date that the alarm changed state in extended format
Type The type of alarm or condition
State The current state of the alarm
Value The current value of the alarm variable
High High Alarm trigger value (Only Valid on Analog Alarms)
HighHigh High High Alarm trigger value (Only Valid on Analog Alarms)
Low Low Alarm trigger value (Only Valid on Analog Alarms)
LowLow Low Low Alarm trigger value (Only Valid on Analog Alarms)
Rate Rate of change trigger value (Only Valid on Analog Alarms)
Deviation Deviation Alarm trigger value (Only Valid on Analog Alarms)
Deadband Deadband (Only Valid on Analog Alarms)
LogState The last state that the alarm passed through
AlmComment The text entered into the Comment field of the alarm properties
dialog.
Custom1..8 Custom Filter Fields
State_desc The configured description (for example, healthy or stopped) of
a particular state
The contents of the any of the above fields (except for State) and the following fields can
be retrieved when the Alarm Summary is displayed:
Field Description
UserName The name of the user (User Name) who was logged on
and performed some action on the alarm (for example,
acknowledging the alarm or disabling the alarm, etc.).
Note that when the alarm is first activated, the user
name is set to "system" (because the operator did not
trip the alarm).
FullName The full name of the user (Full Name) who was logged
on and performed some action on the alarm (for exam-
ple, acknowledging the alarm or disabling the alarm,
etc.). Note that when the alarm is first activated, the full
trip the alarm).
UserDesc The text related to the user event
OnDate The date when alarm was activated
OnDateExt The date (in extended format) when the alarm was ac-
tivated (dd/mm/yyyy)
OffDate The date when the alarm returned to its normal state
OffDateExt The date (in extended format) when the alarm returned
to its normal state (dd/mm/yyyy)
OnTime The time when the alarm was activated
OffTime The time when the alarm returned to its normal state
DeltaTime The time difference between OnDate/OnTime and Off-
Date/OffTime, in seconds
163
Field Description
OnMilli Adds milliseconds to the time the alarm was activated.
OffMilli Adds milliseconds to the time the alarm returned to its
normal state.
AckTime The time when the alarm was acknowledged
AckDate The date when the alarm was acknowledged
AckDateExt The date (in extended format) when the alarm was ac-
knowledged (dd/mm/yyyy)
SumState Describes the state of the alarm when it occurred
SumDesc A description of the alarm summary
Native_SumDesc A description of the alarm summary, in the native lan-
guage
Native_Comment Native language comments the operator adds to an
Alarm Summary entry during runtime.
Return Value
Field data from the alarm entry (as a string).
Related Functions
AlarmDsp
Example
! Display the tag and category for the alarm at the specified AN.
FUNCTION
AlarmData(INT AN)
STRING Category;
STRING Tag;
Category=AlarmGetDsp(AN,"Category");
Tag=AlarmGetDsp(AN,"Tag");
Prompt("Alarm "+Tag+" is Category "+Category);
END
See Also
Alarm Functions
AlarmGetFieldRec
Gets the contents of the specified field in the specified alarm record. If calling this function
from a remote client, use the MsgRPC() function.
Syntax
AlarmGetFieldRec(Record, sField [, nVer] [, ClusterName] )
Record:
164
needs 4 bytes).
sField:
The name of the field from which the data is retrieved.
Field Description
Help Alarm help page
Name Alarm name
Tag Alarm tag
Time The time that the alarm changed state (hh:mm:ss)
Comment Operator comments attached to the Alarm Log entry (if
any)
Date The date that the alarm changed state (mm/dd/yyyy)
DateExt The date that the alarm changed state in extended for-
mat
Type The type of alarm or condition
State The current state of the alarm
Value The current value of the alarm variable
High High Alarm trigger value (Only Valid on Analog Alarms)
HighHigh High High Alarm trigger value (Only Valid on Analog
Alarms)
Low Low Alarm trigger value (Only Valid on Analog Alarms)
LowLow Low Low Alarm trigger value (Only Valid on Analog
Alarms)
Rate Rate of change trigger value (Only Valid on Analog
Alarms)
Deviation Deviation Alarm trigger value (Only Valid on Analog
Alarms)
Deadband Deadband (Only Valid on Analog Alarms)
LogState The last state that the alarm passed through
AlmComment The text entered into the Comment field of the alarm
properties dialog.
Custom1..8 Custom Filter Fields
State_desc The configured description (for example, healthy or
stopped) of a particular state
165
Field Description
UserName The name of the user (User Name) who was logged on
and performed some action on the alarm (for example,
acknowledging the alarm or disabling the alarm, etc.).
Note that when the alarm is first activated, the user
trip the alarm).
FullName The full name of the user (Full Name) who was logged
on and performed some action on the alarm (for exam-
ple, acknowledging the alarm or disabling the alarm,
etc.). Note that when the alarm is first activated, the full
trip the alarm).
UserDesc The text related to the user event
OnDate The date when alarm was activated
OnDateExt The date (in extended format) when the alarm was ac-
tivated (dd/mm/yyyy)
OffDate The date when the alarm returned to its normal state
OffDateExt The date (in extended format) when the alarm returned
to its normal state (dd/mm/yyyy)
OnTime The time when the alarm was activated
OffTime The time when the alarm returned to its normal state
DeltaTime The time difference between OnDate/OnTime and Off-
Date/OffTime, in seconds
OnMilli Adds milliseconds to the time the alarm was activated.
OffMilli Adds milliseconds to the time the alarm returned to its
normal state.
AckTime The time when the alarm was acknowledged
AckDate The date when the alarm was acknowledged
AckDateExt The date (in extended format) when the alarm was ac-
knowledged (dd/mm/yyyy)
SumState Describes the state of the alarm when it occurred
SumDesc A description of the alarm summary
Native_SumDesc A description of the alarm summary, in the native lan-
guage
Native_Comment Native language comments the operator adds to an
Alarm Summary entry during runtime.
nVer:
The version of an alarm.
If an alarm has been triggered more than once in a given period, the version lets
you distinguish between different instances of the alarm’s activity.
The version is used in filtering alarms for display. A query function passes a val-
ue to this parameter in order to get field information for a particular alarm.
This parameter is not needed when you use AlarmGetFieldRec() for purposes
other than filtering. It will default to 0 if you do not set a value.
ClusterName:
166
Return Value
The alarm field data (as a string).
Related Functions
AlarmFirstTagRec, AlarmNextTagRec, MsgRPC
Example
FUNCTION
GetNameFromTag(STRING sTag)
INT record;
STRING sName
record = AlarmFirstTagRec(sTag, "", "");
IF record <> -1 THEN
sName = AlarmGetFieldRec(record,"NAME");
ELSE
sName = "";
END
RETURN sName;
END
See Also
Alarm Functions
AlarmGetInfo
Gets data on the alarm list displayed at a specified AN. Use this function to display the cur-
rent alarm list information on an alarm page. If only one alarm list has been configured on
an alarm page, modes 2 and 3 of this function return the current alarm page information.
Note: You cannot retrieve the order by key setting for an alarm list using this function, as
it can only returns numeric values. To retrieve this information, use the function AlarmGe-
tOrderbyKey
Syntax
AlarmGetInfo(AN, Type)
AN:
The AN where the alarm list (with the required information) is displayed. Set the
AN to 0 (zero) to get information on the alarm list where the cursor is positioned.
Type:
The type of data:
0 - Alarm page number. The vertical offset (in pages) from the AN where the
alarm list commenced. The alarm list must have scrolled off the first page
for this type to return a non-zero value.
1 - Alarm list offset. The vertical offset (in lines) from the AN where the alarm list
commenced. You must have scrolled off the first page of alarms for this
type to return a non zero value.
2 - Category of alarms displayed on the alarm list. You can use a group number
to display a group of categories.
3 - Type of alarms displayed on the alarm list. See AlarmDsp() for a list of these
types.
167
7 - Priority of alarms displayed on the alarm list. The return value may be a group
number if the alarm list contains alarms of more than one priority.
8 - Display mode of the alarm list.
9 - Sorting mode of the alarm list.
Return Value
Alarm list data as a numeric value.
Related Functions
AlarmDsp, AlarmSetInfo, AlarmGetOrderbyKey.
Example
/* In all of the following examples, data is returned on the alarm
list where the cursor is positioned. */
page = AlarmGetInfo(0,0);
! returns the alarm page number.
offset = AlarmGetInfo(0,1);
! returns the alarm list offset.
cat = AlarmGetInfo(0,2);
! returns the alarm category displayed.
type = AlarmGetInfo(0,3);
! returns the type of alarms displayed.
See Also
Alarm Functions
AlarmGetOrderbyKey
Retrieves the list of key(s) that are used to determine the order of the alarm list. These keys
can be set by the AlarmSetInfo() function.
Syntax
AlarmGetOrderbyKey(AN)
AN:
The AN where the alarm list (with the required information) is displayed.
Return Value
Order-by key (as a string).
Example
page = AlarmGetOrderbyKey(21);
! returns the order-by key string of the alarm list at AN ’21’.
See Also
Alarm Functions
168
AlarmGetThreshold
Gets the threshold of the analog alarm where the cursor is positioned.
Syntax
AlarmGetThreshold(Type)
Type:
The type of threshold:
0 - High high
1 - High
2 - Low
3 - Low low
4 - Deadband
5 - Deviation
6 - Rate of change
Return Value
The alarm threshold.
Related Functions
AlarmGetThresholdRec, AlarmSetThreshold, AlarmSetThresholdRec
See Also
Alarm Functions
AlarmGetThresholdRec
Gets the threshold of analog alarms by the alarm record number. If calling this function
from a remote client, use the MsgRPC() function.
Syntax
AlarmGetThresholdRec(Record, Type [, ClusterName] )
Record:
169

needs 4 bytes).
Type:
0 - High high
1 - High
2 - Low
3 - Low low
4 - Deadband
5 - Deviation
6 - Rate of change
ClusterName:
Return Value
The alarm threshold.
Related Functions
AlarmGetThreshold, AlarmSetThreshold, AlarmSetThresholdRec, MsgRPC
See Also
Alarm Functions
AlarmHelp
Displays the alarm help page (associated with the alarm) where the cursor is positioned.
You can assign a help page to each alarm when you define it (using the Digital Alarms or
the Analog Alarms database, depending on the type of alarm). You must also define the
help page in the Pages database.
Syntax
AlarmHelp()
Return Value
Related Functions
PageAlarm
170
Example
System Keyboard
Key Sequence AlmHelp
Command AlarmHelp()
Comment Display the alarm help page
See Also
Alarm Functions
AlarmNextCatRec
Searches for the next occurrence of an alarm category and type, commencing with the spec-
ified alarm record identifier (returned from the previous search through the AlarmFirstC-
atRec function). You can search all areas, the current area only, or specify an area to limit
the search. If calling this function from a remote client, use the MsgRPC() function.
Syntax
AlarmNextCatRec(Record, Category, Type [, Area] [, ClusterName] )
Record:
AlarmGetDsp() to "RecNo". To store this value, use data type Int in Cicode or
Long for variable tags (Long needs 4 bytes).
Category:
The alarm category or group number to match. Set Category to 0 (zero) to match
all alarm categories.
Type:
Non-hardware alarms
171
4 - All configured alarms, that is Types 0 to 3, plus acknowledged OFF alarms. If

you do not specify a Type, the default is 0.
Area:
ClusterName:
Return Value
Related Functions
GrpOpen, AlarmFirstCatRec, AlarmFirstPriRec, AlarmNextPriRec, AlarmGetFieldRec,
Example
See AlarmAckRec
See Also
Alarm Functions
AlarmNextPriRec
Searches for the next occurrence of an alarm of a specified priority and type, commencing
with the specified alarm record identifier (returned from the previous search through the
AlarmFirstPriRec() function). You can search all areas, the current area only, or specify an
area to limit the search. If calling this function from a remote client, use the
MsgRPC() function.
Syntax
AlarmNextPriRec(Record, Priority, Type [, Area] [, ClusterName] )
Record:
172

needs 4 bytes).
Priority:
The alarm Priority or group handle of a group of alarm priorities. Set Priority to
0 (zero) to match all alarm priorities.
Type:
Non-hardware alarms
4 - All configured alarms, that is Types 0 to 3, plus acknowledged OFF alarms. If
you do not specify a Type, the default is 0.
Area:
The area in which to search for alarms. Set Area to -1 to search all areas. If you do
not specify an area, only alarms in the current area on the Alarms Server are
searched.
ClusterName:
Return Value
Related Functions
GrpOpen, AlarmFirstCatRec, AlarmFirstPriRec, AlarmNextCatRec, AlarmGetFieldRec,
SetThresholdRec, AlarmSetInfo, MsgRPC
See Also
Alarm Functions
AlarmNextTagRec
Searches for the next occurrence of an alarm tag, name, and description, starting with the
alarm record identifier (returned from the previous search through the AlarmFirstTagRec()
function). If calling this function from a remote client, use the MsgRPC() function.
173
Syntax
AlarmNextTagRec(Record, Tag, Name, Description [, ClusterName] )
Record:
needs 4 bytes).
Tag:
The alarm tag to be matched. Specify an empty string (" ") to match all alarm tags.
Name:
The alarm name to be matched. Specify an empty string (" ") to match all alarm
names.
Description:
The alarm description to be matched. Specify an empty string (" ") to match all
alarm descriptions.
ClusterName:
Return Value
Related Functions
AlarmFirstTagRec, AlarmGetFieldRec, AlarmAckRec, AlarmDisableRec, AlarmEna-
bleRec, AlarmGetDelayRec, AlarmGetThresholdRec, AlarmSetThresholdRec, MsgRPC
Example
See AlarmDisableRec.
See Also
Alarm Functions
174
AlarmNotifyVarChange
This function is used to provide time-stamped digital and time-stamped analog alarms
with data. When called, it notifies the alarm server that the specified variable tag has
changed.
The alarm server will then check all time-stamped digital and time-stamped analog alarms
that use the variable tag to see if their alarm states need to be updated as a result of the
change. Any alarm state changes that result from this check will be given the timestamp
passed into this function as their time of occurrence.
Note: Although you can hardcode a value into the setpoint when using analog alarms, you
cannot use hardcoded values with time-stamped analog alarms. If the setpoint is hardcod-
ed, this function cannot be used to notify the alarm when the variable changes.
Syntax
AlarmNotifyVarChange(Tag, Value, Timestamp [, TimestampMS] [, ClusterName] )
Tag:
Name of the variable tag that has changed as a string. This name may include the
name of the tag’s cluster in the form cluster.tagname. This cluster name may be
different from the cluster of the alarm server indicated by ClusterName below.
The Tag parameter is resolved on the alarm server, so the alarm server should be
configured to connect to the tag’s cluster.
Value:
Value of the variable tag at the time of the change as a floating-point number
Timestamp:
Time/date at which the variable tag changed in the standard CitectSCADA time/
date variable format (Seconds since 1970).
TimestampMS:
Millisecond portion of the time at which the variable tag changed.
ClusterName:
Name of the cluster of the alarm server. This is optional if you have one cluster or
are resolving the alarm server via the current cluster context. The argument is en-
closed in quotation marks "".
Return Value
The error that was detected when the function was called.
Example
AlarmNotifyVarChange("LOOP_1_SP", 50.0, TimeCurrent() - 10, 550,
"ClusterXYZ");
This will tell the alarm server in cluster XYZ that the value of
variable tag LOOP_1_SP changed to 50.0 at 9.450 seconds ago.
See Also
Time-stamped Digital Alarm Properties, Time-stamped Analog Alarm Properties
Alarm Functions
175
AlarmQueryFirstRec
Searches for the first occurrence of an alarm category (or priority) and type. This is a wrap-
per function of AlarmFirstCatRec and AlarmFirstPriRec.
Syntax
AlarmQueryFirstRec(Group, Type, Area, QueryType [, ClusterName] )
Group:
Alarm category if QueryType is 0 or alarm priority if QueryType is 1.
Type:
Type of alarms to find:
Non-hardware alarms
0 - All active alarms; that is, types 1 and 2.
4 - All configured alarms; that is, types 0 to 3, plus acknowledged OFF alarms.
Area:
Area in which to search for alarms. Set Area to -1 to search all areas.
QueryType:
Query type.
0 - Search by category.
1 - Search by priority.
ClusterName:
Return Value
Related Functions
AlarmQueryNextRec
See Also
Alarm Functions
AlarmQueryNextRec
Searches for the next occurrence of an alarm category (or priority) and type, commencing
with the specified alarm record identifier (returned from the previous search through the
alarm query functions).
176
This is wrapper function of AlarmNextCatRec and AlarmNextPriRec.
Syntax
AlarmQueryNextRec(Record, Group, Type, Area, QueryType [, ClusterName] )
Record:
Alarm record number.
Group:
Alarm Category if QueryType is 0 or alarm priority if QueryType is 1.
Type:
Type of alarms to find:
Non-hardware alarms
0 - All active alarms; that is, types 1 and 2.
4 - All configured alarms; that is, types 0 to 3, plus acknowledged OFF alarms.
Area:
Area in which to search for alarms. Set Area to -1 to search all areas.
QueryType:
Query type.
0 - Search by category.
1 - Search by priority.
ClusterName:
Return Value
Related Functions
AlarmQueryFirstRec
See Also
Alarm Functions
AlarmSetDelay
Changes the delay setting for an alarm (that is Delay, High High Delay, Deviation Delay,
etc.). This function acts on the alarm that the cursor is positioned over. Use this function
during runtime to change the delay values that were specified in the alarms database. De-
lay changes made using this process are permanent (that is they are saved to the project).
177
Syntax
AlarmSetDelay(Type, Value)
Type:
The type of delay:
0 - Delay (digital alarm/advanced alarm)
Value:
The new value for the delay. Enter a blank value " " to remove the delay setting.
Return Value
Related Functions
AlarmGetDelay, AlarmSetDelayRec, AlarmGetDelayRec
See Also
Alarm Functions
AlarmSetDelayRec
Changes the delay setting for an alarm (that is Delay, High High Delay, Deviation Delay,
etc.) by the alarm record number. You can only call this function on an alarms server for
local alarms, or on a redundant server if one has been configured. However, a client can call
this function remotely by using the MsgPRC() function.
Syntax
AlarmSetDelayRec(Record, Type, Value)
Record:
Type:
The type of delay:
0 - Delay (digital alarm/advanced alarm)
178

Value:
The new value for the delay. Enter a blank value " " to remove the delay setting.
Related Functions
AlarmGetDelay, AlarmNotifyVarChange, AlarmGetDelayRec
See Also
Alarm Functions
AlarmSetInfo
Controls different aspects of the alarm list displayed at a specified AN.
Syntax
AlarmSetInfo(AN, Type, Value)
AN:
The AN where the alarm list originally commenced. (AN alarm page can contain
more than one alarm list). You can also specify:
-1 - Change the display parameters of all alarm lists displayed on the page.
0 - Change the display parameters of the alarm list where the cursor is positioned.
Type:
The type of data. The aspects and related types are listed below:
Display aspect Types
Change display line and page offset 0, 1
Formatting of alarms in the alarm list 4, 5, 6
Filtering of alarms 2, 3, 7, 8
Sorting of alarms - to control the sorting as- 9, 10
pect of the alarm list, type 9 and 10 should
be used together.
0 - Alarm page number. The vertical offset (in pages) from the AN where the
alarm list commenced.
1 - Alarm list offset. The vertical offset (in lines) from the AN where the alarm list
commenced.
2 - Category of alarms displayed on the alarm list. To specify all categories use a
value of 0.
You can use a group handle to display a group of categories. (A group can be de-
fined using Groups - from the Project Editor System menu - or by using the
GrpOpen() function.) Before you can display a group of categories, you
must first open the group using the GrpOpen() function. You would usu-
ally do this by entering the GrpOpen() function as the Page entry com-
mand for your alarm page (set using Page Properties). Note, however, that
you should not close the group until you close the display page. If you do,
179
the group will be destroyed and the group handle will become invalid. The
page would then be unable to continue displaying the desired group. The
handle may be reused for another group, which means the page may dis-
play a different category, or display all alarms.
You would normally close the group by entering the GrpClose() function as the
Page exit command.
3 - Type of alarms displayed on the alarm list. See AlarmDsp() for a list of these
types.
4 - Display all alarms according to the format and fonts specified for one category
(specified in Value).
5 - The display format for all alarms specified by a format handle. All of the alarm
categories will display in the same format.
6 - The display font for all user alarms specified by a font handle. All of the user
alarms will appear in the same font and color.
7 - The priority of the alarms to be displayed in the alarm list. You can use a group
number to display a group of priorities.
You can use a group handle to display a group of priorities. (A group can be de-
fined using Groups - from the Project Editor System menu - or by using the
GrpOpen() function.) Before you can display a group of priorities, you
must first open the group using the GrpOpen() function. You would usu-
ally do this by entering the GrpOpen() function as the Page entry com-
mand for your alarm page (set using Page Properties). Note, however, that
you should not close the group until you close the display page. If you do,
the group will be destroyed and the group handle will become invalid. The
page would then be unable to continue displaying the desired group. You
would normally close the group by entering the GrpClose() function as the
Page exit command.
8 - Use the Value argument of the AlarmSetInfo() function to specify whether the
display mode of the alarm list is based on Alarm Category or Priority:
 Set the Value argument to 0 (zero) to display by Category.
 Set the Value argument to 1 to display by Priority.
9 - Use the Value argument of the AlarmSetInfo() function to specify the sorting
mode of the alarm list:
 Set the Value argument to 0 (zero) to display alarms sorted by ON time
within their groups.
 Set the Value argument to 1 to display alarms sorted by the order-by keys.
Please be aware that this option will only be meaningful if you have al-
ready called the AlarmSetInfo() function with a Type of 10 to set the order-
by keys.
10 - Use the Alarm Order-by key specified in the Value argument of the Alarm-
SetInfo() function to determine the order in which the alarm list will be dis-
played.
The AlarmSetInfo() function should then be called again using a Type of 9 and a
Value of 1 for CitectSCADA to sort the alarms in the order specified.
Value:
The meaning of the Value argument depends on the data type specified in the
Type argument.
180
 If you set Type = 8, the Value argument determines whether alarms are dis-
played by category or priority:
 0 - Alarm list displayed by Category.
 1 - Alarm list displayed by Priority.
 If you set Type = 10, the Value argument specifies the order-by keys to be used
in sorting. Up to sixteen keys may be specified:
{KeyName [,SortDirection]}[ {KeyName [,SortDirection]}]

The Keyname argument specifies the name of the pre-defined order-by key to be
used. The valid options are a subset of the alarm display fields: Tag, Name, Cat-
egory, Priority, Area, Priv, Time, State.
The SortDirection argument is optional, and indicates whether the sort will be as-
cending or descending. Valid options are: 0 Descending (default), 1 Ascending.
For example:
{Time,0} : sorts by <Time> (descending)
{Tag,1} : sorts by <Tag> (ascending)
{Tag,1}{Time} : sorts by <Tag> (ascending), then <Time> (descending)
Return Value
Related Functions
GrpOpen, AlarmDsp, AlarmGetInfo
Examples
In the following example, the alarm list is set to display in the order of the order-by key.
Please be aware that this is a two-step process requiring two calls to the AlarmSetInfo()
function, and that it applies only to non-hardware alarm lists.
! Set the order-by key.
AlarmSetInfo(21,10,"{Time}");
! Set the sorting mode.
AlarmSetInfo(21,9,1);
Type 8 of the function is used to set the display mode to either category or priority. This is
helpful when filtering based on either of these fields. So In order to filter on category 2 we
should use:
AlarmSetInfo(21, 8, 0);
Once we do this the alarms with category 2 will be displayed in the alarm list and remain-
ing although active will not be displayed.
Similarly if we want to filter on priority we set the mode to priority and then use type 7. For
example to filter on priority 4 we should use:
AlarmSetInfo(21, 8, 1); ! priority mode
AlarmSetInfo(21, 7, 4); ! apply filter
In the following examples, the display parameters of the alarm list where the cursor is po-
sitioned are changed.
! Change the vertical offset (pages) to 2.
181
! Change the vertical offset (lines) to 15.

Change the alarm category to 10.

Change the type of alarms displayed to type 5 (all hardware alarms).

In the following examples, the display parameters of the alarm list at AN 20 are changed.
! Display all alarms with category 120 format and fonts
! Display all alarms with a new format
hFmt=FmtOpen("MyFormat","{Name}{Desc,20}",0);
AlarmSetInfo(20, 5, hFmt);
! Display all alarms with a new font
hFont = DspFont("Times",-60,black,gray);
AlarmSetInfo(20, 6, hFont);
The following example displays all alarms with categories 1-10, 20, or 25. Before AlarmSet-
Info() is run, the page entry command for the alarm display page is configured as follows:
On page entry command hGrp=GrpOpen("MyGrp",1); StrToGrp(hGrp,"1..10,20,25");
Note: hGrp is defined in the variables database. The page exit command for the alarm dis-
play page is configured as follows:
On page exit command GrpClose(hGrp)
AlarmSetInfo(20, 2, hGrp);
See Also
Alarm Functions
AlarmSetQuery
Allows you to choose which alarms display on a page, by calling a user-defined query func-
tion to filter the alarms on specific criteria. The query function is called for each alarm, and
only alarms matching the criteria are displayed on the page.
There are two steps involved in using a query to display alarms:
 Write the Cicode function that will be used as the query function.
 Specify the query function and its arguments in a call to AlarmSetQuery().
Note: You can also use AlarmSetQuery() to remove filtering from an alarm list. Alarm-
SetQuery( -1, "", "" ) stops the query function filtering the display of alarms.
Syntax
AlarmSetQuery(AN, QueryFunction [, sArgs] [, iAlways] )
AN:
The AN where the alarm list originally commenced. (AN alarm page can contain
more than one alarm list). You can also specify:
-1 - Change the display parameters of all alarm lists displayed on the page.
182
0 - Change the display parameters of the alarm list where the cursor is positioned.
QueryFunction:
The name of the Cicode query function written by the user. Once this function has
been specified, it is called for each alarm, and determines whether or not the
alarm should be displayed.
The QueryFunction returns an INT value of 1 (TRUE) or 0 (FALSE). If a value of
TRUE is returned, the alarm will be displayed. If the query function returns
FALSE, the alarm will be ignored and not displayed.
The query function’s first parameter must be an INT. This parameter is initialized
with the record ID of the current alarm, providing the query function with infor-
mation about the alarm.
The query function’s second parameter must also be an INT. It represents the in-
stance or event of an alarm, and is used in filtering the alarms for display.
sArgs:
A list of arguments to be passed to the Cicode query function. The arguments are
enclosed by double quotes ("") and separated by commas. This parameter is op-
tional. If the query function does not require parameters other than the default
INT parameter, then the list of arguments may be left out as follows:
AlarmSetQuery(0, "AlarmQueryDate");
In this case, the default value of an empty string will be used for the third param-
eter.
If the query function requires values to be passed in by the user, the following
rules apply to determine the types of arguments:
 Digits are interpreted as INT
 Digits with decimals are interpreted as REAL
 Anything enclosed by ^" ^" is interpreted as a STRING
For example, to pass an INT of 23, a string of "23/12/1999", and a REAL value of
23.45 to the query function MyQueryDate(), AlarmSetQuery() should be invoked
in the following way:
AlarmSetQuery(0, 1 ,"MyQueryDate", "23, ^"23/12/1999^", 23.45");
The query function MyQueryDate() would be defined as follows:
INT
FUNCTION
MyQueryDate(INT nRID, INT nVer, INT iOne, STRING sOne, REAL rOne)
..
..
END
The types of the arguments listed in AlarmSetQuery() should match the types of
the arguments defined in the query function.
iAlways:
Set to TRUE to so that the query is performed whenever it is called (no optimiza-
tion). Default value is 0 (FALSE).
Return Value
Related Functions
AlarmGetFieldRec, AlarmSetInfo, QueryFunction
183
Example
!Sets MyQueryDate() as the query function and provides the
arguments 23, 23/12/1999, and 23.45
AlarmSetQuery(0, "MyQueryDate", "23, ^"23/12/1999^", 23.45");
!Removes filtering by the current query function from all alarm
lists on the page
AlarmSetQuery(-1, "", "");
See Also
Alarm Functions
AlarmSetThreshold
Changes the thresholds (that is High High, Low etc.) of analog alarms. This function acts
on the analog alarm where the cursor is positioned. Use this function to change (at run
time) the threshold values that were specified in the Analog Alarms database. Threshold
changes made using this function are permanent (that is they are saved to the project). The
display format currently specified for the record (in the Analog Alarms form) will be ap-
plied to these values.
Syntax
AlarmSetThreshold(Type, Value)
Type:
0 - High high
1 - High
2 - Low
3 - Low low
4 - Deadband
5 - Deviation
6 - Rate of change
Value:
The new value of the threshold. Enter a blank value "" to remove the threshold.
Return Value
Related Functions
AlarmSetThresholdRec
184
Example
System Keyboard
Key Sequence SetHighHigh ### Enter
Command AlarmSetThreshold(0, Arg1)
Comment Change the threshold of a high high alarm
System Keyboard
Key Sequence SetHigh ### Enter
Comment Change the threshold of a high alarm
System Keyboard
Key Sequence SetLow ### Enter
Comment Change the threshold of a low alarm
System Keyboard
Key Sequence SetlowLow ### Enter
Comment Change the threshold of a low low alarm
See Also
Alarm Functions
AlarmSetThresholdRec
Changes the threshold (that is High High, Low etc.) of analog alarms by the alarm record
number. You can call this function only on an Alarms Server for alarms on that server, or
on the redundant server (if a redundant server is configured). If calling this function from
a remote client, use the MsgRPC() function.
Threshold changes made using this function are permanent (that is they are saved to the
project). The display format currently specified for the record (in the Analog Alarms form)
will be applied to these values.
Syntax
AlarmSetThresholdRec(Record, Type, Value)
Record:
185

needs 4 bytes).
Type:
0 - High high
1 - High
2 - Low
3 - Low low
4 - Deadband
5 - Deviation
6 - Rate of change
Value:
The new value of the threshold. Enter a blank value "" to remove the threshold.
Return Value
Related Functions
AlarmSetThreshold, MsgRPC
See Also
Alarm Functions
AlarmSplit
Duplicates an entry (where the cursor is positioned) in the alarm summary display. You
can use this function to add another comment to an alarm summary entry. You would nor-
mally call this function from a keyboard command.
Syntax
AlarmSplit()
Return Value
Related Functions
AlarmSumSplit
186
Example
System Keyboard
Key Sequence Split
Command AlarmSplit()
Comment Duplicates an alarm summary entry
See Also
Alarm Functions
AlarmSumAppend
Appends a new blank record to the alarm summary. Use this function to add new alarm
summary entries, either for actual alarms or as special user summary entries.
If you specify a valid alarm tag in the sTag field, the summary entry is linked to the actual
alarm. If you specify an asterisk ’*’ as the first letter of the tag, the summary entry becomes
a user event.
User events are not attached to alarm records, so their status will not change. You must
manually change the status of the user event, by calling the AlarmSumSet() function with
the index returned by AlarmSumAppend(). As user events are not attached to alarms, they
don’t have the alarm fields - so the AlarmSumGet() function will not return any field data.
You can use user events to keep a record of logins, or control operations that you need to
display in the alarm summary etc. To set the {ONTIME} {OFFTIME} etc. data, use the
AlarmSumSet() function.
This function can only be used if the Alarm Server is on the current machine. When the
Alarm Server is not in the calling process, this function will become blocking and cannot be
called from a foreground task. In this case, the return value will be undefined and a Cicode
hardware alarm will be raised.
Syntax
AlarmSumAppend(sTag [, ClusterName] )
sTag:
The alarm tag to append. Use an asterisk ’*’ as the first letter to append a user
event to the alarm summary. Please be aware that if you using this ’user event
mode’ the AlarmSumAppend function returns the alarm summary index - not
the error code.
ClusterName:
Return Value
The index of the alarm summary entry, or -1 if the record could not be appended.
Related Functions
AlarmSumSet
187
Example
! Append alarm to summary display
AlarmSumAppend("CV101");
! Append user event
iIndex = AlarmSumAppend("*MyEvent");
AlarmSumSet(iIndex, "Comment", "My event comment");
AlarmSumSet(iIndex, "OnTime", TimeCurrent());
See Also
Alarm Functions
AlarmSumCommit
This command is deprecated in this version of CitectSCADA. Use the AlmSummaryCom-
mit command instead.
Commits the alarm summary record to the alarm summary device. Alarm summaries are
normally written to the alarm summary device just before they are deleted from the sum-
mary queue. The length of time that alarm summary entries remain in the alarm summary
queue is controlled by [Alarm]SummaryTimeout parameter.
This function allows you to commit the alarm summary records now, rather than when
they are deleted from the queue.
Syntax
AlarmSumCommit(Index [, ClusterName] )
Index:
The alarm summary index (returned from the AlarmSumFirst(), AlarmSum-
Next(), AlarmSumLast(), AlarmSumPrev(), AlarmSumAppend(), or AlarmSum-
Find() function).
ClusterName:
Return Value
Related Functions
AlarmSumFirst, AlarmSumNext, AlarmSumLast, AlarmSumPrev, AlarmSumGet, Alarm-
SumFind
188
Example
/* This function commits all alarm summary entries that match the
specified tag. */
FUNCTION
SumCommitTag(STRING sTag)
INT Next;
INT Index;
STRING Name;
Index=AlarmSumFirst();
WHILE Index<>-1 DO
Name=AlarmSumGet(Index,"Tag");
Next=AlarmSumNext(Index);
IF Name=sTag THEN
AlarmSumCommit(Index);
END
Index=Next;
END
END
See Also
Alarm Functions
AlarmSumDelete
This command is deprecated in this version of CitectSCADA. Use the AlmSummaryDelete
command instead.
Deletes an alarm summary entry. You identify the alarm summary entry by the Index, re-
turned by one of the alarm summary search functions.
By embedding this function in a loop, you can delete a series of alarm summary entries. To
start deleting from the oldest entry, call the AlarmSumFirst() function to get the index, and
then call AlarmSumNext() in a loop. To delete back from the most recent entry, call Alarm-
SumLast() and then AlarmSumPrev() in a loop.
You can also get the Index from the AlarmSumFind() function, which finds an alarm sum-
mary entry by its alarm record identifier and time of activation.
Syntax
AlarmSumDelete(Index [, ClusterName] )
Index:
Find() function).
ClusterName:
189
Return Value
0 (zero) if the specified alarm entry exists, otherwise an error is returned.
Related Functions
AlarmSumFirst, AlarmSumNext, AlarmSumLast, AlarmSumPrev, AlarmSumGet, Alarm-
SumFind
Example
/* This function deletes all alarm summary entries that match the
specified tag. */
FUNCTION
SumDelTag(STRING sTag)
INT Next;
INT Index;
STRING Name;
WHILE Index<>-1 DO
Next=AlarmSumNext(Index);
IF Name=sTag THEN
AlarmSumDelete(Index);
END
Index=Next;
END
END
See Also
Alarm Functions
AlarmSumFind
This command is deprecated in this version of CitectSCADA. Use the AlmSummary com-
mands instead.
Finds the alarm summary index for an alarm that you specify by the alarm record identifier
and alarm activation time (OnTime). You can use this index in the AlarmSumGet() function
to get field data from an alarm record, in the AlarmSumSet() function to change the existing
data in that record, or in the AlarmSumDelete() function to delete the record. If calling this
function from a remote client, use the MsgRPC() function.
To work with a series of alarm summary records, call this function to get the index, and
then call either AlarmSumNext() to move forwards in the summary, or AlarmSumPrev() to
move backwards in the summary.
Syntax
AlarmSumFind(Record, OnTime [, ClusterName] )
190
Record:
needs 4 bytes).
OnTime:
The ON time of the alarm associated with the Record, that is, the time that the
alarm was activated.
AlarmSumFind() requires that the OnTime argument contains the number of sec-
onds from Midnight, so the formulation:
iOnTime = StrToTime(AlarmSumGet(iIndex, "OnTime"));
will NOT yield the correct result. The correct formulation for this calculation is:
"OnTime")) + TimeMidnight(TimeCur-
rent());
ClusterName:
Return Value
The index of the alarm summary entry, or -1 if no alarm summary entry is found.
Related Functions
AlarmSumNext, AlarmSumSet, AlarmSumDelete, AlarmSumFirst, AlarmSumNext,
AlarmSumLast, AlarmSumPrev, MsgRPC
Example
/* This function sets the summary comment from the alarm record
number and the ontime of the summary event. */
FUNCTION
SumSetComment(INT AN, STRING sComment)
INT nRecord;
INT iOnTime;
INT Index;
iOnTime=StrToDate(AlarmGetDsp(AN,"OnDate"))+StrToTime(AlarmGetDsp(AN,"On-
Time"));
nrecord=StrToInt(AlarmGetDsp(AN,"RecNo"));
Index = AlarmSumFind(nRecord, iOnTime);
IF Index<>-1 THEN
AlarmSumSet(Index,"Comment", sComment);
END
END
191
See Also
Alarm Functions
AlarmSumFirst
This command is deprecated in this version of CitectSCADA. Use the AlmSummaryFirst
command instead.
Gets the index of the oldest alarm summary entry. You can use this index in the Alarm-
SumGet() function to get field data from an alarm record, in the AlarmSumSet() function to
change the existing data in that record, or in the AlarmSumDelete() function to delete the
record.
then call AlarmSumNext() within a loop, to move forwards in the alarm summary.
Syntax
AlarmSumFirst( [ClusterName] )
ClusterName:
Return Value
The index of the oldest alarm summary entry, or -1 if no alarm summary entry is found.
Related Functions
AlarmSumGet, AlarmSumSet, AlarmSumDelete, AlarmSumNext, AlarmSumLast, Alarm-
SumPrev
Example
/* This function finds all alarm summary entries that match the
specified tag and sets the "OffTime" to the time specified. The
alarm entry is not acknowledged or set to the off state, the alarm
summary "OffTime" field is all that is affected. */
FUNCTION
SumSetTime(STRING sTag, INT Time)
INT Index;
STRING Name;
WHILE Index<>-1 DO
IF Name=sTag THEN
AlarmSumSet(Index,"OffTime",Time);
END
Index=AlarmSumNext(Index);
END
END
192
See Also
Alarm Functions
AlarmSumGet
This command is deprecated in this version of CitectSCADA. Use the AlmSummaryGet-
Field command instead.
Gets field data from an alarm summary entry. The data is returned as a string. You identify
the alarm summary entry by the Index, returned by one of the alarm summary search
functions. If calling this function from a remote client, use the MsgRPC() function.
By embedding this function in a loop, you can get data from a series of alarm summary en-
tries. To start from the oldest entry, call the AlarmSumFirst() function to get the index, and
then call AlarmSumNext() in a loop. To work back from the most recent entry, call Alarm-
SumLast() and then AlarmSumPrev() in a loop.
Syntax
AlarmSumGet(Index, sField [, ClusterName] )
Index:
Find() function).
sField:
The name of the field from which to extract the data:
Tag Alarm tag
AckDate Alarm acknowledged date
AckTime Alarm acknowledged time
Comment Alarm comment
DeltaTime Alarm active time
Help Help page
Name Alarm name
OffDate Alarm OFF date
OffTime Alarm OFF time
OnDate Alarm ON date
OnTime Alarm ON time
193
State Alarm state
ClusterName:
Return Value
Field data from the alarm summary entry (as a string).
Related Functions
AlarmSumSet, AlarmSumFirst, AlarmSumNext, AlarmSumLast, AlarmSumPrev, Alarm-
SumFind, MsgRPC
Example
See AlarmSumFirst
See Also
Alarm Functions
AlarmSumLast
This command is deprecated in this version of CitectSCADA. Use the AlmSummaryLast
command instead.
Gets the index of the most recent alarm summary entry. You can use this index in the
AlarmSumGet() function to get field data from an alarm record, in the AlarmSumSet()
function to change the existing data in that record, or in the AlarmSumDelete() function to
delete the record.
then call AlarmSumPrev() within a loop, to move backwards in the alarm summary.
Syntax
AlarmSumLast( [ClusterName] )
ClusterName:
Return Value
The index of the most recent alarm summary entry, or -1 if no alarm summary entry is
found.
194
Related Functions
AlarmSumGet, AlarmSumSet, AlarmSumDelete, AlarmSumPrev, AlarmSumFirst, Alarm-
SumNext
Example
/* This function finds all alarm summary entries that match the
specified tag and sets the "OffTime" to the time specified. The
alarm entry is not acknowledged or set to the off state, the alarm
summary "OffTime" field is all that is affected. */
FUNCTION
SumSetTime(STRING sTag, INT Time)
INT Index;
STRING Name;
Index=AlarmSumLast();
WHILE Index<>-1 DO
IF Name=sTag THEN
AlarmSumSet(Index,"OffTime",Time);
END
Index=AlarmSumPrev(Index);
END
END
See Also
Alarm Functions
AlarmSumNext
This command is deprecated in this version of CitectSCADA. Use the AlmSummaryNext
command instead.
Gets the index of the next alarm summary entry, that is, the entry that occurred later than
the entry specified by Index. You can use this index in the AlarmSumGet() function to get
field data from an alarm record, in the AlarmSumSet() function to change the existing data
in that record, or in the AlarmSumDelete() function to delete the record.
You can use this function to work with a series of alarm summary records. Call the Alarm-
SumFirst() or AlarmSumFind() function to get the index, and then call AlarmSumNext()
within a loop, to move forwards in the alarm summary.
You can also get the index of an entry as soon as it displays on the alarm summary. Alarm
summary entries are recorded with the most recent entry at the end of the list. Call Alarm-
SumLast() to get the index for the most recent entry, and then call AlarmSumNext() to get
the index for the next entry that occurs.
Syntax
AlarmSumNext(Index [, ClusterName] )
Index:
195

Find() function).
ClusterName:
Return Value
The index of the next alarm summary entry or -1 if no more alarm summary entries are
found.
Related Functions
AlarmSumGet, AlarmSumSet, AlarmSumDelete, AlarmSumFirst, AlarmSumLast, Alarm-
SumPrev, AlarmSumFind
Example
See AlarmSumFirst
See Also
Alarm Functions
AlarmSumPrev
This command is deprecated in this version of CitectSCADA. Use the AlmSummaryPrev
command instead.
Gets the index of the previous alarm summary entry, that is, the entry that occurred before
the entry specified by Index. You can use this index in the AlarmSumGet() function to get
field data from an alarm record, in the AlarmSumSet() function to change the existing data
in that record, or in the AlarmSumDelete() function to delete the record.
You can use this function to work with a series of alarm summary records. Call the Alarm-
SumLast() or AlarmSumFind() function to get the index, and then call AlarmSumPrev()
within a loop, to move backwards in the alarm summary.
Syntax
AlarmSumPrev(Index [, ClusterName] )
Index:
Find() function).
ClusterName:
196
Return Value
0 (zero) if the alarm summary entry exists, otherwise an error is returned.
Related Functions
AlarmSumGet, AlarmSumSet, AlarmSumDelete, AlarmSumFirst, AlarmSumNext, Alarm-
SumLast, AlarmSumFind
Example
See AlarmSumLast.
See Also
Alarm Functions
AlarmSumSet
This command is deprecated in this version of CitectSCADA. Use the AlmSummarySet-
FieldValue command instead.
Sets field information in an alarm summary entry. You identify the alarm summary entry
by the Index, returned by one of the alarm summary search functions.
By embedding this function in a loop, you can change field data in a series of alarm sum-
mary entries. To start from the oldest entry, call the AlarmSumFirst() function to get the in-
dex, and then call AlarmSumNext() in a loop. To work back from the most recent entry, call
AlarmSumLast() and then AlarmSumPrev() in a loop.
Syntax
AlarmSumSet(Index, sField, sData [, ClusterName] )
Index:
Find() function).
sField:
The name of the field in which data is to be set:
AckTime Alarm acknowledged time
Comment Alarm comment
OffMilli Alarm millisecond off time
OffTime Alarm OFF time
OnMilli Alarm millisecond on time
OnTime Alarm ON time
State Alarm state
sData:
197
The new value of the field.

ClusterName:
Return Value
0 (zero) if the alarm summary entry exists, otherwise an error is returned.
Related Functions
AlarmSumGet, AlarmSumFirst, AlarmSumNext, AlarmSumLast, AlarmSumPrev, Alarm-
SumFind
Example
See AlarmSumFirst
See Also
Alarm Functions
AlarmSumSplit
Duplicates the alarm summary entry identified by Index. You can use this function to add
another comment to an alarm summary entry.
To duplicate an alarm summary entry on a Control Client, use the AlarmSplit() function -
the entry at the cursor position is duplicated.
Syntax
AlarmSumSplit(Index [, ClusterName] )
Index:
Find() function).
ClusterName:
Return Value
The Index of the new entry, or -1 on error.
Related Functions
SumFind, AlarmSplit
198
Example
/* This function finds the first alarm summary entry that matches
the specified tag, splits that entry and then adds the specified
comment to the new entry. */
FUNCTION
AlarmSplitAdd(STRING Tag, STRING Comment)
INT Index;
STRING Name;
WHILE Index<>-1 DO
IF Name=sTag THEN
AlarmSumSplit(Index);
AlarmSumSet(Index,"Comment",Comment);
Index=-1;
ELSE
Index=AlarmSumNext(Index);
END
END
END
See Also
Alarm Functions
AlarmSumType
This command is deprecated in this version of CitectSCADA. Use the AlmSummary com-
mands instead.
Retrieves a value that indicates a specified alarm’s type, that is whether it’s a digital alarm,
an analog alarm, hardware alarm, etc.
Syntax
AlarmSumType(Index [, ClusterName] )
Index:
Find() function).
ClusterName:
Return Value
A number that represents one of the following alarm types:
 0 = digital alarm
199
 1 = analog alarm
 2 = advanced alarm
 3 = Multi-Digital alarm
 4 = Argyle analog alarm
 5 = user-generated event
 6 = high resolution alarm
 8 = time-stamped digital alarm
 9 = time-stamped analog alarm
 -1 indicates an invalid response to the request.
Related Functions
SumFind, AlarmSplit
See Also
Alarm Functions
AlmSummaryAck
The AlmSummaryAck function acknowledges the alarm at the current cursor position in
Syntax
AlmSummaryAck(iSession)
iSession:
The handle to a browse session previously returned by a AlmSummaryOpen call.
Return Value
0 (zero) if the alarm browse session exists, otherwise an error is returned.
Related Functions
AlmSummaryClear, AlmSummaryClose, AlmSummaryCommit, AlmSummaryDelete,
AlmSummaryDeleteAll, AlmSummaryDisable, AlmSummaryEnable, AlmSummaryFirst,
AlmSummaryGetField, AlmSummaryLast, AlmSummaryNext, AlmSummaryOpen, Alm-
SummaryPrev, AlmSummarySetFieldValue
See Also
Alarm Functions
AlmSummaryClear
The AlmSummaryClear function clears the alarm at the current cursor position in an active
data browse session.
Syntax
AlmSummaryClear(iSession)
200
iSession:
Return Value
Related Functions
AlmSummaryAck, AlmSummaryClose, AlmSummaryCommit, AlmSummaryDelete,
See Also
Alarm Functions
AlmSummaryClose
The AlmSummaryClose function terminates an active data browse session and cleans up
all resources associated with the session.
Syntax
AlmSummaryClose(iSession)
iSession:
Return Value
Related Functions
AlmSummaryAck, AlmSummaryClear, AlmSummaryCommit, AlmSummaryDelete,
See Also
Alarm Functions
AlmSummaryCommit
The AlmSummaryCommit function triggers the actual write of the value for the field pre-
viously specified by AlmSummarySetFieldValue.
complete.
Syntax
AlmSummaryCommit(iSession)
iSession:
201
Return Value
Related Functions
AlmSummaryAck, AlmSummaryClear, AlmSummaryClose, AlmSummaryDelete, Alm-
SummaryDeleteAll, AlmSummaryDisable, AlmSummaryEnable, AlmSummaryFirst,
Example
INT errorCode = 0;
...
errorCode = AlmSummaryCommit(iSession);
IF errorCode = 0 THEN
// Successful case
ELSE
END
...
See Also
Alarm Functions
AlmSummaryDelete
The AlmSummaryDelete function deletes the record that the browse cursor is currently ref-
erencing.
complete.
Syntax
AlmSummaryDelete(iSession)
iSession:
Return Value
Related Functions
AlmSummaryAck, AlmSummaryClear, AlmSummaryClose, AlmSummaryCommit, Alm-
SummaryDeleteAll, AlmSummaryDisable, AlmSummaryEnable, AlmSummaryFirst,
202
Example
INT errorCode = 0;
...
errorCode = AlmSummaryDelete(iSession);
// Successful case
ELSE
END
...
See Also
Alarm Functions
AlmSummaryDeleteAll
The AlmSummaryDeleteAll function deletes all of the records from the data browse source.
complete.
Syntax
AlmSummaryDeleteAll(iSession)
iSession:
Return Value
Related Functions
SummaryDelete, AlmSummaryDisable, AlmSummaryEnable, AlmSummaryFirst, Alm-
SummaryGetField, AlmSummaryLast, AlmSummaryNext, AlmSummaryOpen,
AlmSummaryPrev, AlmSummarySetFieldValue
Example
INT errorCode = 0;
...
errorCode = AlmSummaryDeleteAll(iSession);
// Successful case
ELSE
END
...
See Also
Alarm Functions
203
AlmSummaryDisable
The AlmSummaryDisable function disables the alarm at the current cursor position in an
Syntax
AlmSummaryDisable(iSession)
iSession:
Return Value
Related Functions
SummaryDelete, AlmSummaryDeleteAll, AlmSummaryEnable, AlmSummaryFirst, Alm-
See Also
Alarm Functions
AlmSummaryEnable
The AlmSummaryEnable function enables the alarm at the current cursor position in an ac-
tive data browse session.
Syntax
AlmSummaryEnable(iSession)
iSession:
Return Value
Related Functions
SummaryDelete, AlmSummaryDeleteAll, AlmSummaryDisable, AlmSummaryFirst, Alm-
See Also
Alarm Functions
AlmSummaryFirst
204
The AlmSummaryFirst function places the data browse cursor at the first record.
complete.
Syntax
AlmSummaryFirst(iSession)
iSession:
Return Value
Related Functions
SummaryDelete, AlmSummaryDeleteAll, AlmSummaryDisable, AlmSummaryEnable,
See Also
Alarm Functions
AlmSummaryGetField
The AlmSummaryGetField function retrieves the value of the specified field from the
record the data browse cursor is currently referencing.
Syntax
AlmSummaryGetField(iSession, sFieldName)
iSession:
sFieldName:
are:
CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5, CUSTOM6,
CUSTOM7, CUSTOM8, DATEEXT, ERRDESC, ERRPAGE, FORMAT,
GROUP, LOCALTIMEDATE, LOGSTATE, NATIVE_DESC,
NATIVE_NAME, NODE, OFFTIMEDATE, ONTIMEDATE, ORATO-
DATE, ORATOOFFDATE, ORATOONDATE, PRIV, SUMTYPE, TAGEX,
TIMEDATE, TYPE, TYPENUM.
Return Value
205
Related Functions
AlmSummaryFirst, AlmSummaryLast, AlmSummaryNext, AlmSummaryOpen, AlmSum-
maryPrev, AlmSummarySetFieldValue
Example
INT errorCode = 0;
...
fieldValue = AlmSummaryGetField(iSession, sFieldName);
// Successful case
ELSE
END
...
See Also
Alarm Functions
AlmSummaryLast
The AlmSummaryLast function places the data browse cursor at the most recent summary
record from the last cluster of the available browsing cluster list.
complete.
Syntax
AlmSummaryLast(iSession)
iSession:
Return Value
Related Functions
AlmSummaryFirst, AlmSummaryGetField, AlmSummaryNext, AlmSummaryOpen, Alm-
See Also
Alarm Functions
AlmSummaryNext
206
The AlmSummaryNext function moves the data browse cursor forward one record. If you
call this function after you have reached the end of a summary, error 412 is
complete.
Syntax
AlmSummaryNext(iSession)
iSession:
Return Value
Related Functions
AlmSummaryFirst, AlmSummaryGetField, AlmSummaryLast, AlmSummaryOpen, Alm-
See Also
Alarm Functions
AlmSummaryOpen
The AlmSummaryOpen function initiates a new browse session and returns a handle to the
new session that can be used in subsequent data browse function calls.
complete.
Syntax
AlmSummaryOpen( [sFilter] [, sFields] [, sClusters] )
sFilter:
equivalent to "TAG=AAA".
sFields:
ACKDATE, ACKDATEEXT, ACKTIME, ALARMTYPE, ALMCOMMENT, AR-
EA, CATEGORY, CLUSTER, COMMENT, CUSTOM1, CUSTOM2,
DATE, DATEEXT, DEADBAND, DELTATIME, DESC, DEVIATION, ER-
RDESC, ERRPAGE, FORMAT, FULLNAME, GROUP, HELP, HIGH,
HIGHHIGH, LOCALTIMEDATE, LOGSTATE, LOW, LOWLOW, MIL-
207
LISEC, NAME, NATIVE_COMMENT, NATIVE_DESC, NATIVE_NAME,

NATIVE_SUMDESC, NODE, OFFDATE, OFFDATEEXT, OFFMILLI,
OFFTIME, OFFTIMEDATE, OLD_DESC, ONDATE, ONDATEEXT, ON-
MILLI, ONTIME, ONTIMEDATE, ORATODATE, ORATOOFFDATE, OR-
ATOONDATE, PAGING, PAGINGGROUP, PRIORITY, PRIV, RATE,
STATE, STATE_DESC, STATE_DESC0, STATE_DESC1, STATE_DESC2,
STATE_DESC3, STATE_DESC4, STATE_DESC5, STATE_DESC6,
STATE_DESC7, SUMDESC, SUMSTATE, SUMTYPE, TAG, TAGEX,
TIME, TIMEDATE, TYPE, TYPENUM, USERDESC, USERNAME, VAL-
UE.
sClusters:
be browsed.
Return Value
Returns an integer handle to the browse session. Returns -1 on error.
Related Functions
AlmSummaryFirst, AlmSummaryGetField, AlmSummaryLast, AlmSummaryNext, Alm-
Example
INT iSession;
...
iSession = AlmSummaryOpen("NAME=ABC*", "NAME,TYPE",
// Successful case
ELSE
END
...
See Also
Alarm Functions
AlmSummaryPrev
The AlmSummaryPrev function moves the data browse cursor back one record. If you call
this function after you have reached the beginning of a summary, error 412 is
complete.
208
Syntax
AlmSummaryPrev(iSession)
iSession:
Return Value
Related Functions
SummaryOpen, AlmSummarySetFieldValue
See Also
Alarm Functions
AlmSummarySetFieldValue
The AlmSummarySetFieldValue function sets a new value for the specified field for the
record the data browse cursor is currently referencing. The value is not committed until a
call to AlmSummaryCommit is made.
complete.
Syntax
AlmSummarySetFieldValue(iSession, sFieldname, sFieldValue)
iSession:
sFieldName:
The name of the field whose value is to be updated. Supported fields are:
ACKTIME, COMMENT, OFFMILLI, OFFTIME, ONMILLI, ONTIME.
sFieldValue:
The field value to update.
Return Value
Related Functions
SummaryOpen, AlmSummaryPrev
209
Example
STRING sFieldValue = "NEW_COMMENT";
STRING sFieldName = "COMMENT";
INT errorCode = 0;
...
errorCode = AlmSummarySetFieldValue(iSession, sFieldname,
sFieldValue);
// Successful case
ELSE
END
...
See Also
Alarm Functions
AlmTagsAck
The AlmTagsAck function acknowledges the alarm tag at the current cursor position in an
Syntax
AlmTagsAck(iSession)
iSession:
The handle to a browse session previously returned by a AlmTagsOpen call.
Return Value
Related Functions
AlmTagsClear, AlmTagsDisable, AlmTagsEnable, AlmTagsClose, AlmTagsFirst,
AlmTagsGetField, AlmTagsNext, AlmTagsNumRecords, AlmTagsOpen, AlmTagsPrev
See Also
Alarm Functions
AlmTagsClear
The AlmTagsClear function clears the alarm tag at the current cursor position in an active
data browse session.
Syntax
AlmTagsClear(iSession)
iSession:
210
Return Value
Related Functions
AlmTagsAck, AlmTagsDisable, AlmTagsEnable, AlmTagsClose, AlmTagsFirst, AlmTags-
GetField, AlmTagsNext, AlmTagsNumRecords, AlmTagsOpen, AlmTagsPrev
See Also
Alarm Functions
AlmTagsClose
The AlmTagsClose function terminates an active data browse session and cleans up all re-
sources associated with the session.
Syntax
AlmTagsClose(iSession)
iSession:
Return Value
Related Functions
AlmTagsAck, AlmTagsClear, AlmTagsDisable, AlmTagsEnable, AlmTagsFirst, AlmTags-
See Also
Alarm Functions
AlmTagsDisable
The AlmTagsDisable function disables the alarm tag at the current cursor position in an ac-
Syntax
AlmTagsDisable(iSession)
iSession:
Return Value
211
Related Functions
AlmTagsAck, AlmTagsClear, AlmTagsEnable, AlmTagsClose, AlmTagsFirst, AlmTags-
See Also
Alarm Functions
AlmTagsEnable
The AlmTagsEnable function enables the alarm tag at the current cursor position in an ac-
Syntax
AlmTagsEnable(iSession)
iSession:
Return Value
Related Functions
AlmTagsAck, AlmTagsClear, AlmTagsDisable, AlmTagsClose, AlmTagsFirst, AlmTags-
See Also
Alarm Functions
AlmTagsFirst
The AlmTagsFirst function places the data browse cursor at the first record.
complete.
Syntax
AlmTagsFirst(iSession)
iSession:
Return Value
Related Functions
AlmTagsAck, AlmTagsClear, AlmTagsDisable, AlmTagsEnable, AlmTagsClose,
AlmTagsGetField, AlmTagsNext, AlmTagsNumRecords, AlmTagsOpen, AlmTagsPrev
212
See Also
Alarm Functions
AlmTagsGetField
The AlmTagsGetField function retrieves the value of the specified field from the record the
data browse cursor is currently referencing.
Syntax
AlmTagsGetField(iSession, sFieldName)
iSession:
sFieldName:
are:
CUSTOM7, CUSTOM8, DATEEXT, ERRDESC, ERRPAGE, FORMAT,
GROUP, LOCALTIMEDATE, LOGSTATE, NATIVE_DESC,
NATIVE_NAME, NODE, OFFTIMEDATE, ONTIMEDATE, ORATO-
DATE, ORATOOFFDATE, ORATOONDATE, PRIV, SUMTYPE, TAGEX,
TIMEDATE, TYPE, TYPENUM.
Return Value
Related Functions
AlmTagsFirst, AlmTagsNext, AlmTagsNumRecords, AlmTagsOpen, AlmTagsPrev
Example
INT errorCode = 0;
...
fieldValue = AlmTagsGetField(iSession, sFieldName);
// Successful case
ELSE
END
...
See Also
Alarm Functions
213
AlmTagsNext
The AlmTagsNext function moves the data browse cursor forward one record. If you call
this function after you have reached the end of the records, error 412 is returned
complete.
Syntax
AlmTagsNext(iSession)
iSession:
Return Value
0 (zero) if the browse has successfully been moved to the next record, otherwise an error is
returned.
Related Functions
AlmTagsFirst, AlmTagsGetField, AlmTagsNumRecords, AlmTagsOpen, AlmTagsPrev
See Also
Alarm Functions
AlmTagsNumRecords
The AlmTagsNumRecords function returns the number of records that match the filter cri-
teria.
Syntax
AlmTagsNumRecords(iSession)
iSession:
Return Value
session.
Related Functions
AlmTagsFirst, AlmTagsGetField, AlmTagsNext, AlmTagsOpen, AlmTagsPrev
Example
INT numRecords = 0;
...
214
numRecords = AlmTagsNumRecords(iSession);
// Have records
ELSE
// No records
END
...
See Also
Alarm Functions
AlmTagsOpen
The AlmTagsOpen function initiates a new browse session and returns a handle to the new
session that can be used in subsequent data browse function calls.
complete.
Syntax
AlmTagsOpen( [sFilter] [, sFields] [, sClusters] )
sFilter:
sFields:
ACKDATE, ACKDATEEXT, ACKTIME, ALARMTYPE, ALMCOMMENT, AR-
EA, CATEGORY, CLUSTER, COMMENT, CUSTOM1, CUSTOM2,
DATE, DATEEXT, DEADBAND, DELTATIME, DESC, DEVIATION, ER-
RDESC, ERRPAGE, FORMAT, FULLNAME, GROUP, HELP, HIGH,
HIGHHIGH, LOCALTIMEDATE, LOGSTATE, LOW, LOWLOW, MIL-
LISEC, NAME, NATIVE_COMMENT, NATIVE_DESC, NATIVE_NAME,
NATIVE_SUMDESC, NODE, OFFDATE, OFFDATEEXT, OFFMILLI,
OFFTIME, OFFTIMEDATE, OLD_DESC, ONDATE, ONDATEEXT, ON-
MILLI, ONTIME, ONTIMEDATE, ORATODATE, ORATOOFFDATE, OR-
ATOONDATE, PAGING, PAGINGGROUP, PRIORITY, PRIV, RATE,
STATE, STATE_DESC, STATE_DESC0, STATE_DESC1, STATE_DESC2,
STATE_DESC3, STATE_DESC4, STATE_DESC5, STATE_DESC6,
STATE_DESC7, SUMDESC, SUMSTATE, SUMTYPE, TAG, TAGEX,
TIME, TIMEDATE, TYPE, TYPENUM, USERDESC, USERNAME, VAL-
UE.
sClusters:
215
be browsed.
Return Value
Returns an integer handle to the browse session. Returns -1 when an error is detected.
Related Functions
AlmTagsFirst, AlmTagsGetField, AlmTagsNext, AlmTagsNumRecords, AlmTagsPrev
Example
INT iSession;
...
iSession = AlmTagsOpen("NAME=ABC*", "NAME,TYPE",
// Successful case
ELSE
END
...
See Also
Alarm Functions
AlmTagsPrev
The AlmTagsPrev function moves the data browse cursor back one record. If you call this
function after you have reached the beginning of the records, error 412 is
Syntax
AlmTagsPrev(iSession)
iSession:
Return Value
Related Functions
AlmTagsFirst, AlmTagsGetField, AlmTagsNext, AlmTagsNumRecords, AlmTagsOpen
See Also
Alarm Functions
216
QueryFunction
The user-defined query function set in AlarmSetQuery. Called for each active alarm, the
query function can be written to display an alarm based on specific information (for exam-
ple, OnDate). To examine the information in an alarm field, call the function AlarmGetFiel-
dRec from within your query function.
Note: The function name "QueryFunction" can be any valid Cicode function name specified
by the user.
Syntax
QueryFunction(nRID, nVer [, Arg01, Arg02, ....] )
nRID:
The record number of the alarm currently being filtered. This provides the query
function with access to information about the alarm. This parameter is represent-
ed with an INT, and must be the first parameter of your query function.
nVer:
The version of an alarm.
If an alarm is triggered more than once in a given period, the version lets you dis-
tinguish between different instances of the alarm’s activity.
Since you may wish to display on a page alarms which have more than one in-
stance, this parameter must be passed to AlarmGetFieldRec in order to correctly
filter the alarms.
The version is represented with an INT, and must be the second parameter of
your query function.
Arg01, Arg02:
A list of arguments, separated by commas.
The query function is passed the arguments specified in the call to AlarmSetQue-
ry(). For this reason, the arguments listed in AlarmSetQuery() must be of the
same type as those defined in the query function.
Return Value
The return value must be defined as an INT with a value of either 1 (TRUE) or 0 (FALSE).
If the function returns a value of TRUE, the alarm being filtered is displayed, otherwise it
is excluded from the alarms list.
Related Functions
AlarmSetQuery, AlarmGetFieldRec, AlarmSetInfo
Example
! The query function AlarmQueryDate() compares sDate with the
OnDate of each alarm.AlarmGetFieldRec() is used to check the
contents of the "OnDate" field for each alarm.
! If they are the same, the alarm is displayed.
INT
FUNCTION
AlarmQueryDate(INT nRID, INT nVer, STRING sDate)
INT bResult;
IF sDATE = AlarmGetFieldRec(nRID, "OnDate", nVer) THEN
bResult = TRUE;
ELSE
217
bResult = FALSE;
END
RETURN bResult;
END
See Also
Alarm Functions
218
Chapter: 19 Clipboard Functions
With the Clipboard functions, you can copy data to, and paste data from, the Windows
Clipboard.
Clipboard Functions
Following are functions relating to the Windows clipboard:
ClipCopy Copies a string to the Windows clipboard.
ClipPaste Pastes a string from the Windows clipboard.
ClipReadLn Reads a line of text from the Windows clipboard.
ClipSetMode Sets the format of data sent to the Windows clipboard.
ClipWriteLn Writes a line of text to the Windows clipboard.
See Also
Functions Reference
ClipCopy
Copies a string to the Windows clipboard. When the string is in the clipboard, you can
paste it to any Windows program.
Syntax
ClipCopy(sText)
sText:
The string to copy to the clipboard.
Return Value
Related Functions
ClipWriteLn
Example
ClipCopy("put this in clipboard");
See Also
Clipboard Functions
ClipPaste
Pastes a string from the Windows clipboard.
219
Syntax
ClipPaste()
Return Value
The contents of the clipboard (as a string). If the clipboard is empty, an empty string is re-
turned.
Related Functions
ClipReadLn
Example
/* Get string from clipboard into sText. */
sText = ClipPaste();
See Also
Clipboard Functions
ClipReadLn
Reads a single line of text from the Windows clipboard. With this function, you can read a
block of text from the clipboard - line by line. Call the function once to read each line of text
from the clipboard. When the end of the clipboard is reached, an empty string is returned.
Syntax
ClipReadLn()
Return Value
One line of text from the clipboard (as a string). If the clipboard is empty, an empty string
is returned.
Related Functions
ClipPaste
Example
/* Get first line of text from clipboard. */
sText = ClipReadLn();
WHILE StrLength(sText) > 0 DO
! Do something with text
...
! Read next line of clipboard
sText = ClipReadLn();
END
See Also
Clipboard Functions
220
ClipSetMode
Sets the format of data sent to the Windows clipboard.
Syntax
ClipSetMode(nMode)
nMode:
The mode of the data:
1 - ASCII Text
2 - CSV (Comma separated values) format
You can select multiple modes by adding modes together.
Return Value
The value of the previous mode.
Related Functions
ClipCopy, ClipWriteLn
Example
/* Set the clipboard to CSV mode, write two values, and reset the
clipboard to the original mode. */
nOldMode = ClipSetMode(2);
ClipCopy("100,200");
ClipSetMode(nOldMode);
See Also
Clipboard Functions
ClipWriteLn
Writes a line of text to the Windows clipboard. With this function, you can write any
amount of text to the clipboard. Call this function once for each line of text. To terminate
the block of text, call this function and pass an empty string.
Syntax
ClipWriteLn(sText)
sText:
The line of text to write to the clipboard, or an empty string ("") to end the write
operation.
Return Value
Related Functions
ClipCopy
221
Example
ClipWriteLn("first line of text");
ClipWriteLn("second line of text");
ClipWriteLn(""); ! End of write operation
See Also
Clipboard Functions
222
Chapter: 20 Cluster Functions
This section describes functions for manipulating clusters, checking their status, getting in-
formation, activating and deactivating them.
Cluster Functions
Following are functions relating to clusters:
ClusterActivate Allows the user to activate an inactive cluster.
ClusterDeactivate Allows the user to deactivate an active cluster.
ClusterFirst Allows the user to retrieve the first configured cluster in the
project.
ClusterGetName Returns the names of the primary and standby cluster serv-
ers.
ClusterIsActive Allows the user to determine if a cluster is active.
ClusterNext Allows the user to retrieve the next configured cluster in the
project.
ClusterSetName Connects to a specific cluster server.
ClusterServerTypes Allows the user to determine which servers are defined for a
given cluster.
ClusterStatus Allows the user to determine the connection status from the
client to a server on a cluster.
ClusterSwapActive Allows the user to deactivate an active cluster at the same
time as activating a deactive cluster.
See Also
Functions Reference
ClusterActivate
This function allows the user to activate an inactive cluster. When a cluster is made active,
all data associated with that cluster is available to the client, and hardware alarms will oc-
cur if no connections can be made to the servers in the cluster.
Syntax
ClusterActivate(ClusterName)
ClusterName:
The name of the cluster to activate enclosed in quotation marks "".
Return Value
Related Functions
ClusterDeactivate, ClusterFirst, ClusterGetName, ClusterIsActive, ClusterNext, Clus-
terServerTypes, ClusterSetName, ClusterStatus, ClusterSwapActive, TaskCluster
223
See Also
Cluster Functions
"About cluster context" in the CitectSCADA User Guide
ClusterDeactivate
This function allows the user to deactivate an active cluster. When a cluster is made inac-
tive, no data associated with that cluster is available to the client, and hardware alarms will
not occur if no connections can be made to the servers in the cluster.
Syntax
ClusterDeactivate(ClusterName)
ClusterName:
The name of the cluster to deactivate enclosed in quotation marks "".
Return Value
Related Functions
ClusterActivate, ClusterFirst, ClusterGetName, ClusterIsActive, ClusterNext, ClusterServ-
erTypes, ClusterSetName, ClusterStatus, ClusterSwapActive, TaskCluster
See Also
Cluster Functions
ClusterFirst
This function allows the user to retrieve the first configured cluster in the project.
Syntax
ClusterFirst()
Return Value
The name of the first configured cluster.
Related Functions
ClusterActivate, ClusterDeactivate, ClusterGetName, ClusterIsActive, ClusterNext, Clus-
See Also
Cluster Functions
ClusterGetName
ClusterGetName is deprecated in this version of CitectSCADA.
224
Syntax
ClusterGetName(sPrimary, sStandby, nMode)
sPrimary:
The variable containing the name of the cluster’s primary server (that is that
which was set as sPrimary using the ClusterSetName() function).
sStandby:
The variable containing the name of the cluster’s standby server (that is that
which was set as sStandby using the ClusterSetName() function).
nMode:
The mode is for future expansion of the function - set to 0 (zero).
Return Value
The status of the get name.
Related Functions
ClusterActivate, ClusterDeactivate, ClusterFirst, ClusterIsActive, ClusterNext, Clus-
Example
// Return and display the server names.//
ClusterGetName(sPrimary, sStandby, 0);
Prompt("Name of Cluster" + sPrimary);
See Also
Cluster Functions
ClusterIsActive
This function allows the user to determine if a cluster is active.
Syntax
ClusterIsActive(ClusterName)
ClusterName:
The name of the cluster to query enclosed in quotation marks "".
Return Value
TRUE if active, FALSE otherwise. If the cluster name was invalid, this function will return
FALSE and a hardware alarm will be generated.
Related Functions
ClusterActivate, ClusterDeactivate, ClusterFirst, ClusterGetName, ClusterNext, Clus-
225
See Also
Cluster Functions
ClusterNext
This function allows the user to retrieve the next configured cluster in the project.
Syntax
ClusterNext(ClusterName)
ClusterName:
Any configured cluster name enclosed in quotation marks "", this will usually be
the name of the previous cluster as returned from ClusterFirst, or a previous call
to ClusterNext.
Return Value
The name of the next configured cluster or an empty string if there is no more clusters.
Related Functions
ClusterActivate, ClusterDeactivate, ClusterFirst, ClusterGetName, ClusterIsActive, Clus-
See Also
Cluster Functions
ClusterServerTypes
This function allows the user to determine which servers are defined for a given cluster.
Syntax
ClusterServerTypes(ClusterName)
ClusterName:
Return Value
Logical OR of the following server flags:
 0001 - 1st bit set means an Alarm Server is configured
 0010 - 2nd bit set means a Trend Server is configured
 0100 - 3rd bit set means a Report Server is configured
 1000 - 4th bit set means an IO Server is configured
For example, a return value of 14 indicates an IO Server, a Report Server, and a Trend Serv-
er are configured.
Related Functions
terNext, ClusterSetName, ClusterStatus, ClusterSwapActive, TaskCluster
226
See Also
Cluster Functions
ClusterSetName
ClusterSetName is deprecated in this version of CitectSCADA.
Syntax
ClusterSetName(sPrimary, sStandby, nMode)
sPrimary:
The name of the cluster’s primary server (Reports Server, Alarms Server etc.), as
defined using the Computer Setup Wizard. When the ClusterSetName() function
is used, CitectSCADA will attempt to connect to this server.
sStandby:
The name of the cluster’s standby server (Reports Server, Alarms Server etc.), as
defined using the Computer Setup Wizard. If the sPrimary server is unavailable
when the ClusterSetName() function is used, CitectSCADA will attempt to con-
nect to this server.
If there is no standby server, enter an empty string for sStandby.
nMode:
The mode of the connection:
0 - If you select this mode, CitectSCADA will renew the last connection. If it was
connected to the sPrimary server, when this function was last used, it will
attempt to connect to it again. If it was last connected to the sStandby serv-
er, it will attempt to connect to it again.
This mode is useful when a server is known to be unavailable, as it facilitates fast-
er cluster switching.
1 - CitectSCADA will attempt to connect to the sPrimary server first, each time
this function is used. If the sPrimary server is unavailable, CitectSCADA
will try the sStandby server.
Return Value
Related Functions
terNext, ClusterServerTypes, ClusterStatus, ClusterSwapActive, TaskCluster
Example
// Connect to Cluster A, with server CITECTA1 as primary server,
and CITECTA2 as standby.//
ClusterSetName("CITECTA1", "CITECTA2", 0);
// Display the menu page for Cluster A Project.//
PageDisplay("MenuA");
227
See Also
Cluster Functions
ClusterStatus
This function allows the user to determine the connection status from the client to a server
on a cluster.
Syntax
ClusterStatus(clusterName, serverType)
clusterName:
serverType:
The type of server (not a bit mask):
 1 - Alarm Server
 2 - Trend Server
 4 - Report Server
 8 - IO Server
Return Value
One of the following values:
 -1 - if the cluster does not contain a server of the given type.
 -2 - if the cluster does not exist"
 0 - if the cluster contains the server but the cluster is inactive.
 1 - if the cluster is active but the connection to the server is offline.
 2 - if the cluster is active and the connection to the server is online.
Related Functions
terNext, ClusterServerTypes, ClusterSetName, ClusterSwapActive, TaskCluster
See Also
Cluster Functions
ClusterSwapActive
This function allows the user to deactivate an active cluster at the same time as activating
an inactive cluster. The arguments may be passed in any order, but one cluster must be ac-
tive and the other must be inactive.
Syntax
ClusterSwapActive(clusterNameA, clusterNameB)
clusterNameA:
The name of the cluster to activate or deactivate enclosed in quotation marks "".
clusterNameB:
228
The name of the cluster to activate or deactivate enclosed in quotation marks "".
Return Value
Related Functions
terNext, ClusterServerTypes, ClusterSetName, ClusterStatus, TaskCluster
See Also
Cluster Functions
229
230
Chapter: 21 Color Functions
Allow manipulation of colors (for example, to convert CitectSCADA colors to the format
required by ActiveX objects).
Color Functions
Following are functions relating to colors:
CitectColourToPackedRGB Converts a CitectSCADA color into a packed RGB color
value that can be used by an ActiveX object.
GetBlueValue Returns the Blue component of a packed RGB color.
GetGreenValue Returns the Green component of a packed RGB color.
GetRedValue Returns the Red component of a packed RGB color.
MakeCitectColour Creates a color from red, green and blue component
parts.
PackedRGB Returns a packed RGB color based on specified red,
green, and blue values.
PackedRGBToCitectColour Converts a packed RGB color into the nearest equiva-
lent CitectSCADA color.
See Also
Functions Reference
CitectColourToPackedRGB
Converts a CitectSCADA color value into a packed RGB color value that can be understood
by an ActiveX object.
Syntax
CitectColourToPackedRGB(nCitectColour)
nCitectColour:
The CitectSCADA color value to be converted into a packed RGB color. Cit-
ectSCADA colors are defined in the labels database, or calculated by the function
MakeCitectColour
Return Value
The packed RGB color value - if successful, otherwise an error is returned.
Related Functions
PackedRGBToCitectColour
See Also
Color Functions
GetBlueValue
Returns the Blue component of a packed RGB color.
231
Syntax
GetBlueValue(nPackedRGB)
nPackedRGB:
The packed RGB color.
Return Value
The red value (0-255) - if successful, otherwise an error is returned.
Related Functions
GetRedValue, GetGreenValue
See Also
Color Functions
GetGreenValue
Returns the green component of a packed RGB color.
Syntax
GetGreenValue(nPackedRGB)
nPackedRGB:
Return Value
Related Functions
GetRedValue, GetBlueValue
See Also
Color Functions
GetRedValue
Returns the red component of a packed RGB color.
Syntax
GetRedValue(nPackedRGB)
nPackedRGB:
Return Value
Related Functions
GetGreenValue, GetBlueValue
232
See Also
Color Functions
MakeCitectColour
Creates a color from red, green and blue component parts.
Note: To define a transparent color, use the label TRANSPARENT.
Syntax
MakeCitectColour(nRed,nGreen,nBlue)
nRed:
The color value for red, from 0-255
nGreen:
The color value for green, from 0-255
nBlue:
The color value for blue, from 0-255
Return Value
An integer that is an encoded representation of the color created.
Examples
! creates the color red
MakeCitectColour(255,0,0)
! creates the color white
MakeCitectColour(255,255,255)
See Also
Color Functions
PackedRGB
Returns a packed RGB color based on specified red, green, and blue values.
Syntax
PackedRGB(nRed, nGreen, nBlue)
nRed:
The red component of the desired packed RGB color.
nGreen:
The green component of the desired packed RGB color.
nBlue:
The blue component of the desired packed RGB color.
Return Value
The packed RGB color value - if successful, otherwise an error is returned.
233
Related Functions
See Also
Color Functions
PackedRGBToCitectColour
Converts a packed RGB color into a calculated CitectSCADA color value.
Syntax
PackedRGBToCitectColour(nPackedRGB)
nPackedRGB:
Return Value
The CitectSCADA color value if successful; otherwise an error is returned.
Related Functions
See Also
Color Functions
234
Chapter: 22 Communication Functions
The communication functions give you direct access to the communication ports on your
computer(s). You can use these functions to communicate with external equipment, such
as low speed devices (e.g. bar code readers), serial keyboards, and dumb terminals.
You should not use these functions to communicate with high speed PLCs, as they are de-
signed for low-level communication on a COM port and the performance may not be ade-
quate. To communicate with a PLC, a standard I/O device setup should be configured
using the required driver.
Note: The Communication functions can only be called from an I/O server.
Communication Functions
Following are functions relating to communications:
ComClose Closes a communication port.
ComOpen Opens a communication port for access.
ComRead Reads characters from a communication port.
ComReset Resets the communication port.
ComWrite Writes characters to a communication port.
SerialKey Redirects all serial characters from a port to the keyboard.
See Also
Functions Reference
ComClose
Closes a communication port. Any Cicode tasks that are waiting for a read or write opera-
tion to complete (or that are retrying to read or write) return with a range error. CitectSCA-
DA automatically closes all communication ports at shutdown.
This function can only be called from an I/O Server.
Syntax
ComClose(hPort)
hPort:
The communication port handle, returned from the ComOpen() function. This
handle identifies the table where all data on the associated communication port
is stored.
Return Value
0 if the port is successfully closed, or an error if the port is already closed or if the port num-
ber is invalid.
Related Functions
ComOpen, ComRead, ComWrite
235
Example
See ComOpen
See Also
ComOpen
Opens a communication port for access. The board and port must both be defined in the
database (using the Boards and Ports forms from the Communication menu).
If you try to open the same COM port twice with ComOpen(), the second open will not suc-
ceed and return -1. If this is passed without checking other Com functions, the COM port
may not do anything. For this reason, do not open COM ports twice, and always check the
return value from ComOpen().
The communication system should be used for low speed communications only. You
should not use the communication functions to communicate with high speed PLCs - the
performance may not be adequate. If you need high speed communication (for communi-
cating with PLCs, etc.), you should write a protocol driver. Refer to the CitectSCADA
"Driver Development Kit".
Syntax
ComOpen(sPort, iMode)
sPort:
The port name as specified in the Ports database.
iMode:
The mode of the open:
0 - Take control of the port from CitectSCADA. In this non-shared mode, you
have complete access to the port - CitectSCADA cannot use the port. Com-
munication will be restored when the port is closed.
1 - Share the port with CitectSCADA. In this mode, you can write to the port, and
CitectSCADA can also use it. Please be aware that ComRead will be unre-
liable if the communication port is opened as shared.
Return Value
A communication port handle if the communication system is opened successfully, other-
wise -1 is returned. The handle identifies the table where all data on the associated port is
stored. You can use the handle in the other communication functions, to send and receive
characters from the port.
Related Functions
ComClose, ComRead, ComWrite
Example
INT
FUNCTION
StartSerial(STRING sPort)
236
INT hPort;
hPort = ComOpen(sPort, 0);
IF hPort < 0 THEN
Prompt("Cannot open port " + sPort);
RETURN -1;
END
TaskNew("SerialRead", hPort, 0);
TaskNew("SerialWrite", hPort, 0);
ComClose(hPort);
RETURN 0;
END
INT
FUNCTION
SerialWrite(INT hPort)
STRING buffer;
INT SerialWriteError;
INT length;
WHILE 1 DO
! put data into buffer and set length
.
.
SerialWriteError = ComWrite(hPort, buffer, length, 2);
IF SerialWriteError THEN
Prompt("Error Writing port");
ComReset(hPort);
END
END
RETURN 0;
END
INT
FUNCTION
SerialRead(INT hPort)
STRING buffer;
INT length;
INT total;
INT SerialReadError;
total = 0;
WHILE 1 DO
length = 128; ! must set length as read modifies
SerialReadError = ComRead(hPort, buffer, length, 2);
IF SerialReadError THEN
Prompt("Error from port " + SerialReadError : ####);
ComReset(hPort);
ELSE
! get data from buffer, length is set to number read
.
.
END
END
RETURN 0;
END
See Also
ComRead
237
Reads characters from a communication port. The characters are read from the communi-
cation port into a string buffer. If no characters have arrived after the specified timeout, the
function returns with a timeout error. If the timeout is 0, the function gets any characters
that have arrived from the last call, and returns immediately.
You use the iLength variable to specify the length of the buffer, or the maximum number
of characters to read when ComRead() is called. When ComRead() returns, iLength is set to
the actual number of characters read. Because iLength is modified by this function, you
must reset it before each call.
You should not treat the string buffer as a normal string - it has no string terminator. Use
the StrGetChar() function to extract characters from the buffer.
Do not call ComRead() while another ComRead() is still pending on the same port, because
it can produce unexpected results.
complete. This function can only be called from an I/O Server.
Syntax
ComRead(hPort, sBuffer, iLength, iTimeOut)
hPort:
is stored.
sBuffer:
The buffer into which to put the characters. The actual number of characters read
is returned in iLength.
iLength:
The number of characters to read into the buffer. The maximum length you may
read in one call is 128 characters. When the function returns, this variable is set to
the actual number of characters read.
iTimeOut:
The timeout for the read to complete:
 If iTimeOut = 0 (zero), the function checks for characters in the buffer and re-
turns.
 If iTimeOut > 0, the function returns after this number of seconds - if no char-
acters have been received.
 If iTimeOut < 0, the function waits forever for characters.
Return Value
0 (zero) if the read is successful, otherwise an error is returned.
Related Functions
ComOpen, ComClose, ComWrite, StrGetChar
Example
See ComOpen
238
See Also
ComReset
Resets the communication port. This function can only be called from an I/O Server.
Syntax
ComReset(hPort)
hPort:
is stored.
Return Value
0 (zero) if the write is successful, otherwise an error is returned.
Related Functions
ComOpen, ComClose, ComRead, StrGetChar
Example
See ComOpen
See Also
ComWrite
Writes characters to a communication port. The characters are written from the string buff-
er to the port. If the characters have not been transmitted after the specified timeout, the
function returns with a timeout error. If the timeout is 0, the function returns immediately
and the characters are transmitted in the background.
ComWrite() does not treat the buffer as a true string, but rather as an array of characters of
the length specified - you can send any character to the communication port. Use the StrSet-
Char() function to build the buffer. Do not call ComWrite() while another ComWrite() is
still pending on the same port, because it can produce unexpected results.
You use the iLength variable to specify the length of the buffer, or the maximum number
of characters to write when ComWrite() is called. When ComWrite() returns, iLength is re-
set to zero.
complete.
Syntax
ComWrite(hPort, sBuffer, iLength, iTimeOut)
hPort:
239
is stored.
sBuffer:
The buffer from which to write the characters.
iLength:
The number of characters to write from the buffer. The maximum number of
characters you can write is 128.
iTimeOut:
The timeout for the write to complete.
 If iTimeOut = 0 (zero), the characters are copied to the communication buffer
and the function returns immediately - the characters are transmitted in the
background.
 If iTimeOut > 0, the function returns after this number of seconds - if the char-
acters cannot be transmitted.
 If iTimeOut < 0, the function waits forever to transmit the characters.
Return Value
0 (zero) if the write is successful, otherwise an error is returned.
Related Functions
ComOpen, ComClose, ComRead, StrGetChar
Example
See ComOpen
See Also
SerialKey
Redirects all serial characters from a port to the keyboard. If using a keyboard attached to
a serial port, you should call this function at startup, so that CitectSCADA copies all char-
acters (read from the port) to the keyboard. The Port must be defined in the Ports database.
If the port is not on an I/O server, you must create a dummy I/O server record (for example,
name the server DServer1). Complete the Boards and Ports records. Set the following pa-
rameters in the CITECT.INI file:
[IOServer]Name to the server name (for example, DServer1)
[IOServer]Server to 0
This method enables the port without making the computer an I/O server. (If the I/O server
is enabled (and not required as an I/O server), extra overhead and memory are used.)
This function can only be called from an I/O server.
Syntax
SerialKey(sPort)
240
sPort:
The name of the port connected to the serial keyboard.
Return Value
Related Functions
ComOpen
Example
SerialKey("Port1"); ! enable the serial keyboard
See Also
241
242
Chapter: 23 Dynamic Data Exchange Functions
The Cicode DDE (Dynamic Data Exchange) functions permit you to exchange data be-
tween CitectSCADA and other Windows applications running on the same computer in
real time, continuously, and with no operator intervention. For example, you can send your
run-time data to a DDE compliant spreadsheet or word processing application, either by
posting the data to memory for DDE access by other applications, or by writing the data
directly into another application. Conversely, you could read data from a DDE compliant
application like a spreadsheet or document directly into a CitectSCADA variable.
You could also run processes in any DDE compliant Windows application running on the
same computer by using the Cicode DDEExec() function to send commands to that appli-
cation. Similarly, you can call any Cicode function (built-in or user-written) in CitectSCA-
DA from any Windows application (running on the same computer), that supports a DDE
Execute command.
The DDERead(), DDEPost(), DDEWrite(), and DDEExec() functions each perform a single
exchange of data. Each of these functions starts a DDE conversation with the external ap-
plication, sends or receives the data (or command), and ends the conversation - all in one
operation.
The DDE handle (DDEh...) functions return a handle to the conversation - a DDE channel
number. You should use the DDE handle functions for Network DDE, in particular for Ac-
cess DDE.
Note:CitectSCADA runtime automatically behaves as a DDE Server and makes its variable
tag database available for DDE Client applications to link with.
DDE Functions
Following are functions relating to Dynamic Data Exchange:
DDEExec Executes a command in an external DDE compliant Windows ap-
plication.
DDEPost Makes a CitectSCADA variable available for DDE linking by other
DDE compliant Windows applications.
DDERead Reads a variable from a DDE compliant Windows application.
DDEWrite Writes a variable to a DDE compliant Windows application.
DDEhExecute Executes a command in an external DDE compliant Windows ap-
plication.
DDEhGetLastError Gets the most recent Windows DDE error code.
DDEhInitiate Starts a DDE conversation with an external DDE compliant Win-
dows application.
DDEhPoke Writes data to a DDE compliant Windows application.
DDEhReadLn Reads a line of text from a DDE Conversion.
DDEhRequest Requests data from a DDE compliant Windows application.
DDEhSetMode Set the mode of a DDE conversation.
DDEhTerminate Closes a DDE conversation with a Windows application.
DDEhWriteLn Writes a line of text to the DDE conversation.
243
See Also
Functions Reference
DDEExec
Executes a command in an external Windows application running on the same computer.
With this function, you can control other applications that support DDE. Refer to the doc-
umentation provided with the external Windows application to determine if DDE is sup-
ported and what functions can be called.
You cannot use DDEExec() to call macros on a remote computer or to call Access SQLs. For
these calls, Network DDE needs to pass the sDocument argument, so you must use the
DDEh... functions, passing sDocument in the DDEhInitiate() function.
Syntax
DDEExec(sApplication, sCommand)
sApplication:
Application name (.EXE filename), for example, "WinWord".
sCommand:
The command that the application will execute.
Return Value
1 (one) if successful, otherwise an error is returned.
Related Functions
DDEPost, DDERead, DDEWrite, DDEhExecute
Example
/* Instruct the Excel application to recalculate its spreadsheet
immediately. */
DDEExec("Excel","[Calculate.Now()]");
See Also
DDE Functions
DDEhExecute
Executes a command in an external Windows application. You must first start a conversa-
tion with the DDEhInitiate function, and use the handle returned by that function to iden-
tify the conversation.
With this function, you can control other applications that support DDE. Refer to the doc-
umentation provided with your other Windows application to determine if DDE is sup-
ported and what functions can be called.
This function is a blocking function. It will block the calling Cicode task until the operation
is complete.
244
Syntax
DDEhExecute(Handle, sCommand)
Handle:
The integer handle that identifies the DDE conversation, returned from the DDE-
hInitiate function.
sCommand:
The command that the application will execute.
Return Value
Related Functions
DDEhInitiate, DDEhRequest, DDEhPoke, DDEhTerminate, DDEhGetLastError
Example
See DDEhInitiate
See Also
DDE Functions
DDEhGetLastError
Gets the latest error code issued from Windows for the conversation identified by the han-
dle.
Syntax
DDEhGetLastError(Handle)
Handle:
hInitiate function.
Return Value
The error code last issued from Windows DDEML (for that conversation):
DMLERR_ADVACKTIMEOUT 0x4000
DMLERR_BUSY 0x4001
DMLERR_DATAACKTIMEOUT 0x4002
DMLERR_DLL_NOT_INITIALIZED 0x4003
DMLERR_DLL_USAGE 0x4004
DMLERR_EXECACKTIMEOUT 0x4005
DMLERR_INVALIDPARAMETER 0x4006
DMLERR_LOW_MEMORY 0x4007
DMLERR_MEMORY_ERROR 0x4008
DMLERR_NOTPROCESSED 0x4009
DMLERR_NO_CONV_ESTABLISHED 0x400a
DMLERR_POKEACKTIMEOUT 0x400b
245
DMLERR_POSTMSG_FAILED 0x400c
DMLERR_REENTRANCY 0x400d
DMLERR_SERVER_DIED 0x400e
DMLERR_SYS_ERROR 0x400f
DMLERR_UNADVACKTIMEOUT 0x4010
DMLERR_UNFOUND_QUEUE_ID 0x4011
Related Functions
DDEhInitiate, DDEhExecute, DDEhRequest, DDEhPoke, DDEhTerminate
Example
See DDEhInitiate
See Also
DDE Functions
DDEhInitiate
Starts a conversation with an external Windows application. When the data exchange is
complete, you should terminate the conversation to free system resources.
Syntax
DDEhInitiate(sApplication, sDocument)
sApplication:
The application name (.EXE filename), for example, "WinWord".
sDocument:
The document, topic, or file name.
Return Value
An integer handle for the conversation between CitectSCADA and the other application, or
-1 if the conversation is not started successfully. The handle is used by the other DDEh...
functions, to identify the conversation.
Related Functions
DDEhExecute, DDEhRequest, DDEhPoke, DDEhTerminate, DDEhGetLastError
Example
! Read from Excel spreadsheet
STRING FUNCTION GetExcelData();
INT hChannel;
STRING sData;
hChannel = DDEhInitiate("EXCEL", "DATA.XLS");
IF hChannel > -1 THEN
sData = DDEhRequest(hChannel, "R1C1");
DDEhTerminate(hChannel);
hChannel = -1;
END;
RETURN sData;
END
246
! Write to Excel spreadsheet

FUNCTION SetExcelData(STRING sData);
INT hChannel;
DDEhPoke(hChannel, "R1C1", sData);
hChannel = -1;
END;
END
! Execute Excel Macro
FUNCTION DoExcelMacro();
INT hChannel;
DDEhExecute(hChannel, "[RUN(^"TestMacro^")]");
hChannel = -1;
END;
END
See Also
DDE Functions
DDEhPoke
Writes a value to an external Windows application, for example, an Excel spreadsheet. The
value is written once to the application. (To write the value dynamically, you must call this
function at the rate at which the data must be updated.)
You must first start a conversation with the DDEhInitiate function, and use the handle re-
turned by that function to identify the conversation.
is complete.
Syntax
DDEhPoke(Handle, sItem, sValue)
Handle:
hInitiate function.
sItem:
A unique name for the item; for example, the variable name, field name, or
spreadsheet cell position.
sValue:
The value of the item.
Return Value
247
Related Functions
DDEhInitiate, DDEhExecute, DDEhRequest, DDEhTerminate, DDEhGetLastError
Example
See DDEhInitiate
See Also
DDE Functions
DDEhReadLn
Reads a line of text from a DDE Conversion, for example, from an Excel spreadsheet. You
must first start a conversation with the DDEhInitiate function, and use the handle returned
by that function to identify the conversation. This function allows you to read a large
amount of data via DDE. Keep calling the function until an empty string is returned to ver-
ify that all the data has been read.
is complete.
Syntax
DDEhReadLn(Handle, sTopic)
Handle:
hInitiate function.
sTopic:
A unique topic name for the item; for example, the variable name, field name, or
Return Value
A line of data, or an empty string when all data has been read.
Related Functions
DDEhSetMode, DDEhWriteLn, DDEhInitiate, DDEhExecute, DDEhRequest, DDEhTermi-
nate, DDEhGetLastError
Example
See DDEhWriteLn
See Also
DDE Functions
DDEhRequest
Reads a value from an external Windows application, for example, from an Excel spread-
sheet. You must first start a conversation with the DDEhInitiate function, and use the han-
dle returned by that function to identify the conversation.
is complete.
248
Syntax
DDEhRequest(Handle, sItem)
Handle:
hInitiate function.
sItem:
Return Value
A string of data, or an empty string if the function cannot read the value.
Related Functions
DDEhInitiate, DDEhExecute, DDEhPoke, DDEhTerminate, DDEhGetLastError
Example
See DDEhInitiate
See Also
DDE Functions
DDEhSetMode
Set the mode of the DDE conversation. The default mode of a DDE conversation is to use
TEXT data format - a simple string of data. This function allows you to set the mode to CSV
(Comma Separated Values). Some Windows applications support this mode of data as it
helps them to separate the data. For example, when you send CSV format to Excel, each val-
ue will be placed into a unique cell. If you use TEXT mode all the data will be placed into
the same cell.
Syntax
DDEhSetMode(Handle, sMode)
Handle:
hInitiate function.
sMode:
The mode of the DDE conversation:
1 - Text (default)
2 - CSV
Return Value
The error code.
Related Functions
DDEhInitiate, DDEhExecute, DDEhRequest, DDEhTerminate, DDEhGetLastError, DDEh-
Poke, DDEhReadLn, DDEhWriteLn, DDEhSetMode
249
Example
See DDEhWriteLn
See Also
DDE Functions
DDEhTerminate
Closes the conversation identified by the handle, and frees the resources associated with
that conversation. After you call this function, the handle is no longer valid.
With Network DDE, you might need to terminate and re-initiate a conversation. For exam-
ple, if you delete rows on an MS Access sheet, the deleted rows display as #DELETED until
you terminate and re-initiate the conversation.
Syntax
DDEhTerminate(Handle)
Handle:
hInitiate function.
Return Value
Related Functions
DDEhInitiate, DDEhExecute, DDEhPoke, DDEhRequest, DDEhGetLastError
Example
See DDEhInitiate
See Also
DDE Functions
DDEhWriteLn
Writes a line of text to the DDE conversation. With this function, you can write any amount
of text to the DDE conversation. Call this function once for each line of text. To terminate
the block of text, call this function and pass an empty string.
Syntax
DDEhWriteLn(Handle, sTopic, sData)
Handle:
hInitiate function.
sTopic:
A unique name for the topic the data will be written to; for example, the spread-
sheet cell position. The topic is only used when you complete the write by passing
an empty string for data.
250
sData:
The line of data to write. To terminate the data and make CitectSCADA send the
data, set the data to an empty string.
Return Value
Related Functions
DDEhInitiate, DDEhExecute, DDEhRequest, DDEhTerminate, DDEhGetLastError, DDEh-
Poke, DDEhReadLn, DDEhWriteLn, DDEhSetMode
Example
! Write to Excel spreadsheet
! write the numbers 1..8 into 8 unique cells in Excel.
FUNCTION WriteExcelData(STRING sData);
INT hChannel;
// set to CSV mode so EXCEL will put each value in a cell
DDEhSetMode(hChannel, 2);
DDEhWriteLn(hChannel, "", "1,2,3,4");
DDEhWriteLn(hChannel, "R1C1:R2C4", "5,6,7,8");
DDEhWriteLn(hChannel,"R1C1:R2C4","");
hChannel = -1;
END;
END
See Also
DDE Functions
DDEPost
Makes a CitectSCADA variable value available for DDE linking (that is posts a DDE link so
that it can be read by other DDE compliant applications running on the same computer).
This sets-up CitectSCADA to behave as a DDE Server for this DDE channel.
After a value is posted, other Windows applications running on the same computer can
read the value by using their own DDE Client functions. If the value of the posted variable
changes, any linked applications are informed of the new value.
To link to this value from any DDE Client applications running on the same computer, they
must appropriately use the DDE Client syntax with:
 "Citect" as the <DDE Server application name>
 "Data" as the <DDE Topic name>
 The name used for the first parameter sItem in this DDEPost() function as the <DDE
data item name>.
Unlike the DDERead() and DDEWrite() Cicode functions which are static, the DDEPost()
function can be used to create a dynamic DDE link, providing the DDE Client applications
appropriately set their side of the DDE channel to be automatically updated.
251
Syntax
DDEPost(sItem, sValue)
sItem:
sValue:
Return Value
The value that is posted, or 0 (zero) if the function does not succeed in posting the link.
Related Functions
DDEExec, DDERead, DDEWrite
Example
! In Citect Project Editor, create a variable tag named PV1
! In Cicode, post a link to the tag PV1 for external DDE
applications to connect with DDEPost("TAGONE",PV1);
/* To link to this posted tag from a cell in Excel, set the cell to
=Citect|Data!TAGONE. This will set the value of the Excel cell to
the value of tag PV1. */
/* To link to this posted tag from a field in Word, set the field
to{DDEAuto Citect Data TAGONE}. This will set the value of the
field link to the value of tag PV1. */
See Also
DDE Functions
DDERead
Reads values from an external DDE compliant Windows application running on the same
computer, (for example, from an Excel spreadsheet cell or a Word document).
This is a one-way static communication which is read once from the application per call. To
read the value dynamically, call this function at the rate at which the data is required to be
updated.
Use this function when you want precise control over exactly what you want from the DDE
exchange.
Syntax
DDERead(sApplication, sDocument, sItem [, Mode] )
sApplication:
sDocument:
sItem:
252
Mode:
A flag that tells the application whether or not to set up an advise loop:
0 - Do not set up advise loop.
1 - Set up advise loop (default).
Return Value
The value (from the external application) as a string, or an empty string if the function can-
not read the desired values.
Related Functions
DDEExec, DDEPost, DDEWrite
Example
/* Read the value from R1C1 (Row1,Column1) of an Excel spreadsheet
named "Sheet1". */
DDERead("Excel","Sheet1","R1C1");
/* Read the value from the Item1 bookmark of the Word document
named "Recipes.doc". */
DDERead("Winword","Recipes","Item1");
See Also
DDE Functions
DDEWrite
Writes a value to an external Windows application, for example, to an Excel spreadsheet.
The value is written once to the application. To write the value dynamically, you must call
this function at the rate at which the data must be updated.
Use DDEWrite() to cause CitectSCADA runtime to initiate the DDE conversation with a
DDE compliant application running on the same computer.
Syntax
DDEWrite(sApplication, sDocument, sItem, sValue)
sApplication:
sDocument:
sItem:
sValue:
253
Return Value
The value that is sent to the other application, or an empty string if the function does not
successfully write the value.
Related Functions
DDEExec, DDEPost, DDERead
Example
/* Write the value of a CitectSCADA variable named
TAGONE to R1C1 (Row1,Column1) of an Excel spreadsheet named
"Sheet1". The value is in string format. */
DDEWrite("Excel","Sheet1","R1C1",TAGONE);
See Also
DDE Functions
254
Chapter: 24 Device Functions
The device functions provide access to devices. They allow access to SQL, dBASE, and
ASCII files through database-like operations, and provide more control over output to
printers.
With these functions you can open and close any device, and read from and write to any
record or field in the device. You can store recipes or any other data in a database, and then
down-load or up-load the data as required to an I/O device on the plant floor, or to the op-
erator. You can also update the database with real-time data for data exchange with other
applications.
Device Functions
Following are functions relating to devices:
DevAppend Appends a blank record to the end of a device.
DevClose Closes a device.
DevControl Controls a dBASE or SQL device.
DevCurr Gets the current device number.
DevDelete Deletes the current record in a database device.
DevDisable Disables (and re-enables) a device from any access.
DevEOF Checks for the end of a file.
DevFind Finds a record in a device.
DevFirst Finds the first record in a device.
DevFlush Flushes buffered data to a device.
DevGetField Gets field data from the current record.
DevHistory Renames a device file and any subsequent history files.
DevInfo Gets device information.
DevModify Modifies the attributes of a device.
DevNext Gets the next record in a device.
DevOpen Opens a device for access.
DevOpenGrp Opens a group of devices.
DevPrev Gets the previous record in a device.
DevPrint Prints free-format data to a group of devices.
DevRead Reads characters from a device.
DevReadLn Reads a line of characters from a device.
DevRecNo Gets the current record number of a device.
DevSeek Moves to any record in a device.
DevSetField Sets new field data in the current record.
DevSize Gets the size of a device.
DevWrite Writes a string to a device.
DevWriteLn Writes a string with a newline character to a device.
DevZap Zaps a device.
Print Prints a string in a report.
255
PrintLn Prints a string with a newline character in a report.

PrintFont Changes the printing font on the current device.
See Also
Functions Reference
DevAppend
Appends a blank record to the end of a device. After the record is appended, you can use
the DevSetField() function to add data to fields in the record.
You must first call the DevOpen() function to get the device handle (hDev).
Syntax
DevAppend(hDev)
hDev:
The device handle, returned from the DevOpen() function. The device handle
identifies the table where all data on the associated device is stored.
Return Value
0 (zero) if the record is successfully appended, otherwise an error is returned.
Related Functions
DevOpen, DevSetField
Example
INT
FUNCTION WriteAlarmCount( INT hDevice, STRING sAlarm,
INT iCount, INT iTime )
DevAppend(hDevice);
DevSetField(hDevice, "ALARM", sAlarm);
DevSetField(hDevice, "TIME", IntToStr(iTime));
DevSetField(hDevice, "COUNT", IntToStr(iCount));
END
See Also
Device Functions
DevClose
Closes a device. Any data in the buffer is flushed to the device before it is closed. After a
device is closed, its device handle becomes invalid and cannot be used.
Syntax
DevClose(hDev, Mode)
hDev:
256
Mode:
Set to TRUE to keep logging or FALSE to remove logging. Default value is 0
(FALSE).
Return Value
Related Functions
DevOpen
Example
DevClose(hDev);
See Also
Device Functions
DevControl
Controls a dBASE or SQL device. You can pack a dBASE device to physically remove de-
leted records, or re-index a dBASE device to regenerate the keys. You can issue queries to
an SQL device, or get the error status of the last SQL query.
Syntax
DevControl(hDev, Type [, sData])
hDev:
Type:
The type of command:
0 - Re-index the device based on the key defined in the device record (dBASE de-
vices only).
1 - Pack the database file - all deleted records are removed (dBASE devices only).
2 - Issue a direct SQL query to the device (SQL devices only).
3 - Get error status of the last SQL query (SQL devices only).
Note: ASCII files and printers are not supported.
sData:
The command data, that is the SQL query to be issued. Used only for Type 2 com-
mands.
Return Value
Related Functions
DevOpen, DevZap
257
Example
! pack a dBASE file device
DevControl(hDev, 1, "");
See Also
Device Functions
DevCurr
Gets the current device handle. You can only call this function in a report, to get the handle
of the device where the report is logging. You can then use the other device functions (for
example, DevPrint()) to access that logging device. (To get the handle of a device other than
a logging device, you must use the DevOpen() function.)
If the report is logging to a group of devices, this function will return the group handle.
However, not all device functions support group handles, for example, you cannot read
from a group of devices.
Syntax
DevCurr()
Return Value
The current device handle or group handle. If no device is configured, -1 is returned.
Related Functions
DevOpen, DevPrint
Example
! Get the report device number.
hDev=DevCurr();
See Also
Device Functions
DevDelete
Deletes the current record in a dBASE database device. The record is not physically deleted,
but is marked for deletion. You can physically delete the record by packing the database
with the DevControl() function.
Syntax
DevDelete(hDev)
hDev:
258
Return Value
0 (zero) if the record is successfully deleted, otherwise an error is returned.
Related Functions
DevOpen, DevClose, DevControl
Example
! Delete the current record.
DevDelete(hDev);
See Also
Device Functions
DevDisable
Disables (and re-enables) a device from all access, and discards any data written to the de-
vice. When a device is disabled, it cannot be opened, and data cannot be read from the de-
vice. Use this function to disable logging to a database or printer.
The State argument is a toggle. A State of 1 disables the device(s), but you can then re-enable
the device(s) by repeating the function with State = 0.
Syntax
DevDisable(sName, State)
sName:
The device name, or * (asterisk) for all devices.
State:
The disable state:
0 - Enable the device.
1 - Disable the device.
Return Value
Related Functions
DevOpen
Example
! Disable the AlarmLog device.
DevDisable("AlarmLog",1);
:
DevDisable("AlarmLog",0); ! Re-enable the device.
See Also
Device Functions
259
DevEOF
Gets the status of the end of file (EOF) flag for a device. When you use the DevPrev(),
DevNext(), or DevSeek() function, the start or end of the device will eventually be reached,
and the EOF flag will be set. Use this function to test the EOF flag.
Syntax
DevEOF(hDev)
hDev:
Return Value
1 if the EOF flag has been set, otherwise 0 (zero).
Related Functions
DevOpen, DevPrev, DevNext, DevSeek, DevReadLn
Example
hDev = DevOpen("Log", 0);
WHILE NOT DevEOF(hDev) DO
Prompt(DevGetField(hDev,"Tag"));
DevNext(hDev);
END
DevClose(hDev);
See Also
Device Functions
DevFind
Searches a device for a record that contains specified data in a specified field. The search
starts at the current record and continues forward until the matched data is found or the
end of the database is reached. If the file has a keyed index, an indexed search is used.
Syntax
DevFind(hDev, sFind, sField)
hDev:
sFind:
The data to find in sField, as a string.
For SQL devices: The DevFind() function can distinguish between numbers,
strings, and dates, so you do not need to enclose the data in quote marks. Dates
and times must be in the correct format:
 Date: YYYY-MM-DD
 Time: HH:MM:SS
 DateTime: YYYY-MM-DD HH:MM:SS[.F...] (The fraction .F... is optional.)
260
sField:
The field name to match.
Return Value
Related Functions
DevOpen, DevSeek
Example
! Find the Ice cream recipe.
DevNotFount=DevFind(hDev,"Ice cream","Recipe");
IF DevNotFount=0 THEN
! Get the recipe values.
..
ELSE
Prompt("Ice cream not found");
END
See Also
Device Functions
DevFirst
Finds the first record in a device.
Syntax
DevFirst(hDev)
hDev:
Return Value
The first indexed record (if the device is an indexed database), otherwise the first record in
the device.
Related Functions
DevOpen, DevClose
Example
! Find the first record.
FirstRec = DevFirst(hDev);
See Also
Device Functions
261
DevFlush
Flushes all buffered data to the physical device. CitectSCADA normally optimizes the writ-
ing of data for maximum performance, so use this function only if it is really necessary.
Syntax
DevFlush(hDev)
hDev:
Return Value
Related Functions
DevOpen, DevClose
Example
! Flush device to disk.
DevFlush(hDev);
See Also
Device Functions
DevGetField
Gets field data from the current record in a device.
Syntax
DevGetField(hDev, Field)
hDev:
Field:
The field name, as a string of up to 10 characters. (The dBASE file format limits
all field names to a maximum of 10 characters.)
Return Value
The field data (as a string). If the field is not found an empty string is returned.
Related Functions
DevOpen, DevSetField
Example
INT
FUNCTION
262
GetRecipe(STRING sName)
INT hDev;
hDev = DevOpen("Recipe", 0);
IF hDev >= 0 THEN
DevSeek(hDev, 1);
IF DevFind(hDev, sName, "NAME") = 0 THEN
PLC_FLOUR = DevGetField(hDev, "FLOUR");
PLC_WATER = DevGetField(hDev, "WATER");
PLC_SALT = DevGetField(hDev, "SALT");
PLC_MILK = DevGetField(hDev, "MILK");
ELSE
DspError("Cannot Find Recipe " + sName);
END
DevClose(hDev);
ELSE
DspError("Cannot open recipe database");
END
END
See Also
Device Functions
DevHistory
Renames a device file and any subsequent history files. The current device is closed and re-
named as the first history file. For example, the device file ’Templog.txt’ is renamed as
’Templog.001’. If a history file ’Templog.001’ already exists, it is renamed as ’Templog.002’,
and so on. The next time data is written to the device, a new device file is created.
Note: If the device file has not been created (that is data has not been written to the device),
only existing history files are renamed. Use this function for direct control of the device his-
tory process.
Syntax
DevHistory(hDev)
hDev:
Return Value
Related Functions
DevOpen, DevControl
Example
! Create history file
DevHistory(hDev);
263
See Also
Device Functions
DevInfo
Gets information on a device.
Syntax
DevInfo(hDev, Type)
hDev:
Type:
Type of information:
-n: Name of field n (where n is any number up to the total number of fields). For
example, if there are 10 fields, -7 will return the name of field 7.
- (Total no. of fields + n): Length of field n (where n is any number up to the total
number of fields). For example, if there are 10 fields, -15 will return the length of
field 5.
0: Device Name
1: Format
2: Header
3: File Name
4: Number of history files
5: Form length
6: Number of fields
7: Disable flag
8: Device type
9: Record size
10: Format number
11: Type of history schedule:
0: Event triggered
1: Daily
2: Weekly
3: Monthly
4: Yearly
12: The history period, in seconds, or week day, month or year, for example, if his-
tory is weekly then this is the day of the week, that is 1 to 7
13: Synchronisation time of day of the history in seconds, for example, 36000 (that
is, 10:00:00)
14: The time the next history file will be created in seconds
Return Value
The device information as a string if successful, otherwise an empty string is returned.
Related Functions
DevControl
264
Example
! Get the number of fields in a device.
NoFields=DevInfo(hDev,6);
FOR I=1 TO NoFields DO
! Get and display the name of each field.
sField=DevInfo(hDev,-I);
nLength=DevInfo(hDev,-I - NoFields);
Prompt("Field Name "+sField + "Length " + nLength:##);
END
See Also
Device Functions
DevModify
Modifies the attributes of a device. The device must be closed before you can modify a de-
vice.
This function allows you to dynamically change the file name or other attributes of a device
at run time. You can use a single device to access many files. For example, you can create a
device called Temp with a file name of TEMP.DBF. Using this function you could dynam-
ically change the file name to access any dBASE file.
This function is useful in conjunction with the FormOpenFile() or FormSaveAsFile() func-
tions. (These functions allow the operator to select file names easily.)
When using this function, you should be careful that no other Cicode function is already
using the same device. Always check the return value of this function before opening the
device or you will destroy the data in the device to which it is already attached. Use a sema-
phore to protect your Cicode.
When using this function, you should be careful that no other Cicode function is already
using the same device. Always check the return value of this function before opening the
device or you will destroy the data in the device to which it is already attached. If the device
is already open, calling DevModify will return an error (and raise a hardware alarm to no-
tify user).
If DevModify returns error, it means it has not modified the device and the device param-
eters will remain as they were before the call to DevModify.
Use a semaphore to protect your Cicode.
Syntax
DevModify(Name, Format, Header, FileName, Type)
Name:
The name of the device.
Format:
A new format for the device or "*" to use the existing format.
Header:
A new header for the device or "*" to use the existing header.
FileName:
265
A new file name for the device or "*" (asterisk) to use the existing filename.
Type:
A new device type.
Device Type Device
ASCII_DEV ASCII file
PRINTER_DEV Printer
dBASE_DEV dBASE file
SQL_DEV SQL database
or -1 to use the existing device type.
Return Value
Related Functions
DevOpen, DevClose, DevSetField, DevInfo, DevAppend, FormOpenFile
Example
! change the file name of MyDev
DevModify("MyDev", "*", "*", "c:\data\newfile.dbf", -1);
! change the fields and file name of MyDev
DevModify("MyDev", "{time}{date}{tags}", "*",
"C:\DATA\OLDFILE.DBF", -1);
! change the device to TXT file
DevModify("MyDev", "*", "*", "C:\DATA\OLDFILE.TXT", ASCII_DEV);
See Also
Device Functions
DevNext
Gets the next record in a device. If the end of the database is reached, the EOF flag is set and
an error code is returned.
Syntax
DevNext(hDev)
hDev:
Return Value
0 if the next record is read, or an error if the end of the database is reached.
Related Functions
DevEOF, DevPrev
266
Example
Status=0;
I = 0;
WHILE Status = 0 DO
DspText(20 + I, 0, DevGetField(hDev,"Tag"));
I = I + 1;
Status = DevNext(hDev);
END
DevClose(hDev);
See Also
Device Functions
DevOpen
Opens a device and returns the device handle. The device must be defined in the Cit-
ectSCADA database. If the device cannot be opened, and user error checking is not en-
abled, the current Cicode task is halted.
You can use this function to return the handle of a device that is already open. The De-
vOpen() function does not physically open another device - it returns the same device han-
dle as when the device was opened. The mode of the second open call is ignored. To re-
open an open device in a different mode, you must first close the device and then re-open
it in the new mode.
When using an ODBC driver to connect to an SQL server or database, experience has
shown that connecting only once on startup and not closing the device yields the best per-
formance. ODBC connection is slow and if used on demand may affect your system’s per-
formance. Also, some ODBC drivers may leak memory on each connection and may cause
errors after a number of re-connects.
Note: If you are opening a database device in indexed mode (nMode=2), an index file will
automatically be created by CitectSCADA if one does not already exist. If you feel a device
index has become corrupt, delete the existing index file and a new one will be created the
next time the DevOpen function is run.
Syntax
DevOpen(Name [, nMode] )
Name:
The name of the device.
nMode:
0 - Open the device in shared mode - the default mode when opening a device if
none is specified.
1 - Open the device in exclusive mode. In this mode only one user can have the
device open. The open will return an error if another user has the device
open in shared or exclusive mode.
2 - Open the device in indexed mode. In this mode the device will be accessed in
index order. This mode is only valid if the device is a database device and
267
has an index configured in the Header field at the Devices form. Please be
aware that specifying mode 2 when opening an ASCII device is ignored in-
ternally.
4 - Open the device in ’SQL not select’ mode. If opened in this mode, you must
not attempt to read from an SQL device.
8 - Open the device in logging mode. In this mode the history files will be created
automatically.
16 - Open the device in read only mode. In this mode data can be viewed, but not
written. This mode is supported only by DBF and ASCII files - it is ignored
by printers and SQL/ODBC databases.
Return Value
The device handle. If the device cannot be opened, -1 is returned. The device handle iden-
tifies the table where all data on the associated device is stored.
Related Functions
DevClose, DevOpenGrp
Example
INT
FUNCTION
PrintRecipe(STRING sCategory)
STRING sRecipe;
INT hRecipe, hPrinter;
ErrSet(1); ! enable user error checking
hRecipe = DevOpen("Recipe", 0);
IF hRecipe = -1 THEN
DspError("Cannot open recipe");
RETURN FALSE;
END
hPrinter = DevOpen("Printer1", 0);
IF hPrinter = -1 THEN
DspError("Cannot open printer");
RETURN FALSE;
END
ErrSet(0); ! disable user error checking
WHILE NOT DevEof(hRecipe) DO
sRecipe = DevReadLn(hRecipe);
DevWriteLn(hPrinter, sRecipe);
END
DevClose(hRecipe);
DevClose(hPrinter);
RETURN TRUE;
END
See Also
Device Functions
DevOpenGrp
Opens a group of devices.
268
Syntax
DevOpenGrp(hGrp [, nMode] )
hGrp:
The handle to a database containing a group of devices.
nMode:
0 - Open the device in shared mode - the default mode when opening a device.
1 - Open the device in exclusive mode. In this mode only one user can have the
device open. The open will return an error if another user has the device
open in shared or exclusive mode.
2 - Open the device in indexed mode. In this mode the device will be accessed in
index order. This mode is only valid if the device is a database device and
has an index configured in the Header field at the Devices form. Please be
aware that specifying mode 2 when opening an ASCII device is ignored in-
ternally.
4 - Open the device in ’SQL not select’ mode. If opened in this mode, you must
not attempt to read from an SQL device.
8 - Open the device in logging mode. In this mode the history files will be created
automatically.
16 - Open the device in read only mode. In this mode data can be viewed, but not
written. This mode is supported only by DBF and ASCII files - it is ignored
by printers and SQL/ODBC databases.
Return Value
Returns 0 if successful or -1 if the function is provided with a bad handle and cannot open
the group.
Related Functions
DevClose, DevOpen
DevPrev
Gets the previous record in a device. If the start of the database is reached, the EOF flag is
set and an error code is returned.
Syntax
DevPrev(hDev)
hDev:
Return Value
0 if the record is read successfully, or an error if the start of the database is reached.
Related Functions
DevOpen, DevEOF, DevNext
269
Example
Status=0;
I = 0;
iError = DevSeek(hDev, DevSize(hDev)); ! seek to end
WHILE iError = 0 DO
DspText(20 + I, 0, DevGetField(hDev,"Tag"));
I = I + 1;
iError = DevPrev(hDev);
END
DevClose(hDev);
See Also
Device Functions
DevPrint
Prints free-format data to groups of devices. Using this function, you can write data to
many devices at the same time. You would normally use this function in a report.
Syntax
DevPrint(hGrp, sData, NewLine)
hGrp:
The device handle, or the group handle for a group of devices.
sData:
The data to print to the group of devices.
NewLine:
The newline flag:
0 - Do not insert a newline character.
1 - Insert a newline character.
Return Value
Related Functions
DevWriteLn, DevCurr
Example
! Get the report device number or group number (for a group of
devices).
hGrp=DevCurr();
! Print PV123 to a group of devices.
DevPrint(hGrp,"PV123="+PV123:###,1);
See Also
Device Functions
270
DevRead
Reads characters from a device. If the device is record-based, the current field is read. If the
device is free-format, the specified number of characters is read. If the number of characters
specified is greater than the number of characters remaining in the device, only the remain-
ing characters are read.
Syntax
DevRead(hDev, Length)
hDev:
Length:
The number of characters to read.
Return Value
The data (in string format). If the end of the device is found, an empty string is returned.
Related Functions
DevOpen, DevReadLn, DevFind
Example
! Read 20 characters from a device.
Str=DevRead(hDev,20);
See Also
Device Functions
DevReadLn
Reads data from the current record of a device until the end of the line, or end of the record.
If the device is record-based, the record number is incremented. The carriage return and
newline characters are not returned.
Syntax
DevReadLn(hDev)
hDev:
Return Value
The data (in string format). If the end of the device is found, an empty string is returned
and the EOF flag is set.
Related Functions
DevOpen, DevRead, DevEOF, DevFind
271
Example
Str=DevReadLn(hDev);
See Also
Device Functions
DevRecNo
Gets the current record number of a device. If the device is record-based, the record number
ranges from 1 to the maximum size of the file. If the device is free-format, the record num-
ber ranges from 0 to the maximum byte size -1.
Syntax
DevRecNo(hDev)
hDev:
Return Value
The record number. If an error is detected while getting the record number, -1 is returned.
Related Functions
DevOpen, DevSeek
Example
! Get the current record number.
Rec=DevRecNo(hDev);
See Also
Device Functions
DevSeek
Moves the device pointer to a specified position in the device. If the device is a database,
and it is opened in indexed mode, DevSeek will seek to the record number - not through
the index. To locate the first record in an indexed device, call the DevFirst() function.
Syntax
DevSeek(hDev, Offset)
hDev:
Offset:
272
The offset in the device. If the device is a database device, the offset is the record
number. If the device is a binary device, the offset is in bytes (from 0 to the max-
imum file size -1).
Note: If offset causes a seek past the end of the file, DevSeek returns no error, but
sets the EOF flag (that is, a subsequent DevEOF() call will return true).
Return Value
0 (zero) if the seek was successful, otherwise an error code is returned.
Related Functions
DevOpen, DevEOF, DevRecNo, DevFirst
Example
hDev=DevOpen("Log", 0);
DevSeek(hDev,100);
DevGetField(hDev,"Tag");
! Gets the value of the "Tag" field at record 100.
See Also
Device Functions
DevSetField
Sets new field data in the current record in a device.
Syntax
DevSetField(hDev, Field, sData)
hDev:
Field:
The field name, as a string of up to 10 characters. (The dBASE file format limits
all field names to a maximum of 10 characters.)
sData:
New field data, in string format. CitectSCADA converts any other data type into
a string before setting the data.
Return Value
0 (zero) if the data is successfully set, otherwise an error is returned.
Related Functions
DevOpen, DevAppend, DevGetField
Example
! Set the fields in the "Recipe" device.
hDev=DevOpen("Recipe", 0);
DevSeek(hDev, 1);
273
DevSetField(hDev,"Name", "WhiteBread");
DevSetField(hDev,"Flour", IntToStr(iFlour));
DevSetField(hDev,"Water", iWater:####);
DevSetField(hDev,"Salt", iSalt);
DevClose(hDev);
See Also
Device Functions
DevSize
Gets the size of a physical device.
Syntax
DevSize(hDev)
hDev:
Return Value
If the device is a database device, the number of records is returned. If the device is a binary
device, the number of bytes in the file is returned. If an error is detected, -1 is returned.
Related Functions
DevRecNo, DevSeek
Example
INT NoRec;
NoRec=DevSize(hDev);
! Seek to the last record.
DevSeek(hDev,NoRec);
See Also
Device Functions
DevWrite
Writes a string to a device. If the device is free-format, the data is written to the device as
specified. If the device is record-based, the data is written to the current field, and the field
pointer is moved to the next field.
Writing to a DBF device appends the data to the device.
DevWrite(hDev, sData)
hDev:
sData:
274
The data to write, as a string.
Return Value
Related Functions
DevOpen, DevWriteLn
Example
! Write PV123 to the device.
DevWrite(hDev,"PV123="+PV123:###.#);
For SQL devices: The DevWrite() function can distinguish between numbers, strings, and
dates, so you do not need to enclose the data in quote marks. Dates and times must be in
the correct format:
 Date: YYYY-MM-DD
 Time: HH:MM:SS
 DateTime: YYYY-MM-DD HH:MM:SS[.F...] (The fraction .F... is optional.)
See Also
Device Functions
DevWriteLn
Writes a string to a device. If the device is free-format, the data is written to the device, fol-
lowed by a newline character. If the device is record-based, a new record is appended to
the device and the data is written to this record. The record pointer is then moved to the
next record.
Syntax
DevWriteLn(hDev, sData)
hDev:
sData:
The data to write, as a string.
Return Value
Related Functions
DevOpen, DevWrite
Example
/* Write PV123 to the device followed by a newline character */
DevWriteLn(hDev,"PV123="+PV123:###.#);
275
See Also
Device Functions
DevZap
Zaps a device. If a database device is zapped, all records are deleted. If an ASCII file is
zapped, the file is truncated to 0 (zero) length. Use this function when you want to delete
all records in a database or file without deleting the actual file.
Syntax
DevZap(hDev)
hDev:
Return Value
Related Functions
DevDelete
Example
! Delete all records in the alarm log database.
hDev = DevOpen("AlarmLog", 0);
DevZap(hDev);
See Also
Device Functions
Print
Prints a string on the current device. You should call this function only in a report. The out-
put is sent to the device (or group of devices) defined in the Reports database (in the output
device field).
Note: To print a new line in an RTF report, use the "\par" special character. For example,
Print("String" + "\par").
Syntax
Print(String)
String:
The string (data) to print.
Return Value
276
Related Functions
PrintLn
Example
! Print "Testvar" and stay on the same line.
Print("Value of Testvar="+Testvar:##.#);
See Also
Device Functions
PrintFont
Changes the printing font on the current device. You should call this function only in a re-
port. It will change the font style for the device (or group of devices) defined in the Reports
database (output device field). It has effect only on reports being printed to a
PRINTER_DEV - it has no effect on other types of devices, such as ASCII_DEV and
dBASE_DEV.
Syntax
PrintFont(Font)
Font:
The CitectSCADA font (defined in the Fonts database).
Return Value
Related Functions
Print
Example
The following report file...
{! example.rpt }
-------------------------------------
AN example Report
-------------------------------------
{CICODE}
PrintFont("HeadingFont");
{END}
Plant Area 1
{CICODE}
PrintFont("ReportFont");
{END}
{Time(1) } {Date(2) }
PV_1 {PV_1:#####.##}
PV_2 {PV_2:#####.##}
----------End of Report---------------
...will print as...
277
-------------------------------------
AN example Report
-------------------------------------
Plant Area 1
04:41:56 19-10-93
PV_1 49.00
PV_2 65.00
----------End of Report---------------
See Also
Device Functions
PrintLn
Prints a string on the current device, followed by a newline character. You should call this
function only in a report. The output will be sent to the device or group of devices defined
in the Reports database (in the output device field).
Note: To print a new line in an RTF report, use the "\par" special character. For example,
PrintLn("String" + "\par").
Syntax
PrintLn(String)
String:
The string (data) to print.
Return Value
Related Functions
Print
Example
! Print "Testvar" followed by a new line.
PrintLn("Value of Testvar="+Testvar:##.#);
See Also
Device Functions
278
Chapter: 25 Display Functions
Display functions control the display and processing of graphics pages and objects. You
can use these functions to display graphics pages, print them on your printer, send them to
a file, or copy them to the Windows Clipboard. You can also display text files on screen.
Note: The properties defined for an object will override any conflicting Cicode Display
functions.
You can create and move ANs (animation-point numbers), and obtain runtime information
about graphics pages and their associated ANs.
Display Functions
Following are functions relating to the display of graphics pages and objects:
DspAnCreateControlObject Creates a new instance of an ActiveX object. If the ob-
ject already exists for the given Animation Point Num-
ber, then that object will be used (a new object is not
created).
DspAnFree Frees (removes) an AN from the current page.
DspAnGetArea Gets the area configured for an object at a specific AN
(animation-point number).
DspAnGetPos Gets the x and y coordinates of an AN (animation-point
number).
DspAnGetPrivilege Gets the privileges configured for an object at a specific
AN (animation-point number).
DspAnInfo Gets information on the state of the animation at an
AN.
DspAnInRgn Checks if an AN is within a specified region.
DspAnMove Moves an AN.
DspAnMoveRel Moves an AN relative to its current position.
DspAnNew Creates an AN.
DspAnNewRel Creates an AN relative to another AN.
DspBar Displays a bar graph at an AN.
DspBmp Displays a bitmap at a specified AN.
DspButton Displays a button at an AN and puts a key into the key
command line (when the button is selected).
DspButtonFn Displays a button at an AN and calls a function when
the button is selected.
DspChart Displays a chart at an AN.
DspCol DspCol is deprecated in this version.
DspDel Deletes all objects at an AN.
DspDelayRenderBegin Delays screen updating until DspDelayRenderEnd() is
called.
DspDelayRenderEnd Ends the screen update delay set by DspDelayRender-
Begin().
DspDirty Forces an update to an AN.
279
DspError Displays an error message at the prompt AN.

DspFile Defines the screen attributes for displaying a text file.
DspFileGetInfo Gets the attributes of a file to screen display.
DspFileGetName Gets the name of the file being displayed in the display
"window".
DspFileScroll Scrolls a file (displayed in the display "window") by a
number of characters.
DspFileSetName Sets the name of the file to display in the display "win-
dow".
DspFont Creates a font.
DspFontHnd Gets a font handle.
DspFullScreen Enables or disables the full screen mode of the active
window.
DspGetAnBottom Gets the bottom extent of the object at the specified
AN.
DspGetAnCur Gets the current AN.
DspGetAnExtent Gets the extent of the object at a specified AN.
DspGetAnFirst Returns the first AN on the current page.
DspGetAnFromPoint Gets the AN of the object at a specified set of screen
coordinates.
DspGetAnHeight Gets the height of the object at a specified AN.
DspGetAnLeft Gets the left extent of the object at the specified AN.
DspGetAnNext Returns the AN following a specified AN.
DspGetAnRight Gets the right extent of the object at the specified AN.
DspGetAnTop Gets the top extent of the object at the specified AN.
DspGetAnWidth Gets the width of the object at a specified AN.
DspGetEnv Gets a page environment variable.
DspGetMouse Gets the mouse position.
DspGetMouseOver Determines if the mouse is within the boundaries of a
given AN.
DspGetNearestAn Gets the nearest AN.
DspGetParentAn Gets the parent animation number (if any), for the
specified AN.
DspGetSlider Gets the current position (value) of a slider at an AN.
DspGetTip Gets the tool tip text associated with an AN.
DspGrayButton Greys and disables a button.
DspInfo Gets object display information from an AN.
DspInfoDestroy Deletes an object information block created by DspIn-
foNew().
DspInfoField Gets stored and real-time data for a variable tag.
DspInfoNew Creates an object information block for an AN.
DspInfoValid Checks if an object information block is still valid.
DspIsButtonGray Gets the current status of a button.
DspKernel Displays the Kernel window.
DspMarkerMove Moves a trend or chart marker to a specified position.
DspMarkerNew Creates a new trend marker.
280
DspMCI Controls a multimedia device.

DspPlaySound Plays a waveform (sound).
DspPopupMenu Creates a menu consisting of a number of menu items.
DspRichText Creates a Rich Text object at the animation point.
DspRichTextEdit Enables/disables editing of the contents of a rich text
object.
DspRichTextEnable Enables/disables a rich text object.
DspRichTextGetInfo Returns size information about a rich text object.
DspRichTextLoad Loads a copy of a rich text file into a rich text object.
DspRichTextPgScroll Scrolls the contents of a rich text object by one page
length.
DspRichTextPrint Prints the contents of a rich text object.
DspRichTextSave Saves the contents of a rich text object to a file.
DspRichTextScroll Scrolls the contents of a rich text object by a user de-
fined amount.
DspRubEnd Ends a rubber band selection.
DspRubMove Moves a rubber band selection to the new position.
DspRubSetClip Sets the clipping region for the rubber band display.
DspRubStart Starts a rubber band selection (used to rescale a trend
with the mouse).
DspSetSlider Sets the current position of a slider at the specified AN.
DspSetTip Sets tool tip text associated with an AN.
DspSetTooltipFont Sets the font for tool tip text.
DspStatus Sets the communication status error for a specified an-
imation number.
DspStr Displays a string at an AN.
DspSym Displays a symbol at an AN.
DspSymAnm Displays a series of animated symbols at an AN.
DspSymAnmEx Displays a series of animated symbols at an AN.
DspSymAtSize Displays a symbol at a scale and offset from an AN.
DspText Displays text at an AN.
DspTipMode Switches the display of tool tips on or off.
DspTrend Displays a trend at an AN.
DspTrendInfo Gets information on a trend definition.
See Also
Functions Reference
DspAnCreateControlObject
Creates a new instance of an ActiveX object. If the object already exists for the given Ani-
mation Point Number, then that object will be used, that is a new object will not be created,
the existing object will merely be refreshed.
AN object created using this function remains in existence until the page is closed or the
associated Cicode Object is deleted.
281
Syntax
DspAnCreateControlObject(AN, sClass, Width, Height [, sEventClass] )
AN:
The animation-point number.
sClass:
gram ID, or its GUID. If the class does not exist, the function will return an error.
For example:
 "{8E27C92B-1264-101C-8A2F-040224009C02}" - GUID
Width:
The width of the ActiveX object.
Height:
The height of the ActiveX object.
sEventClass:
The string you would like to use as the event class for the object.
Return Value
Related Functions
CreateObject, CreateControlObject
Example
See Also
Display Functions
DspAnFree
Note: This function is only used for V3.xx and V4.xx animations, and will be superseded in
future releases.
Frees (removes) an AN from the current page. If an animation exists at the animation num-
ber, it is deleted before the AN is freed. Use this function to free existing ANs or ANs cre-
ated with the DspAnNew() function. Please be aware that the ANs are only freed in
memory - the change is not permanent. The next time the page is opened it will display the
AN.
Syntax
DspAnFree(AN)
AN:
282
Return Value
Related Functions
DspAnNew
Example
/* Remove AN20 from the current page. */
DspAnFree(20);
See Also
Display Functions
DspAnGetArea
Gets the area configured for an object at a specific AN (animation-point number). The area
is returned as an integer.
Note: This function does not return the areas of keyboard commands associated with the
object.
Syntax
DspAnGetArea(AN)
AN:
Return Value
The area if successful, otherwise an error is returned. If the object is configured with ’Same
area as page’ checked, the area of the page will be returned. AN area of 0 (zero) means no
areas are configured for the object.
Related Functions
DspAnGetPrivilege
Example
/* Get the area configured for the object at AN60. /
DspAnGetArea(60);
See Also
Display Functions
DspAnGetPos
Gets the x and y coordinates of an AN, in pixels, relative to the top-left corner of the win-
dow.
283
Syntax
DspAnGetPos(AN, X, Y)
AN:
X, Y:
The variables used to store the x and y pixel coordinates of the AN, returned from
this function.
Return Value
0 (zero) if successful, otherwise an error is returned. The X and Y variables are set to the
AN’s position if successful, or to -1 if an error has been detected.
Related Functions
DspAnMove, DspAnInRgn, DspGetAnCur, DspGetMouse, DspGetNearestAn
Example
/* Get the position of AN20 into X and Y. /
DspAnGetPos(20,X,Y);
See Also
Display Functions
DspAnGetPrivilege
Gets the privileges configured for an object at a specific AN (animation-point number). The
privilege is returned as an integer.
Note: This function does not return the privileges of keyboard commands associated with
the object.
Syntax
DspAnGetPrivilege(AN)
AN:
Return Value
The privilege if successful, otherwise an error is returned. A privilege of 0 (zero) means no
privileges are configured for the object.
Related Functions
DspAnGetArea
Example
/* Get the privileges of the object at AN45. /
DspAnGetPrivilege(45);
284
See Also
Display Functions
DspAnInfo
Note: This function is only used for V3.xx and V4.xx animations, and has been superseded
by future releases.
Gets information on an AN - the type or state of the animation that is currently displayed.
Syntax
DspAnInfo(AN, Type)
AN:
Type:
The type of information:
0 - The type of animation currently displayed at the AN. The following is re-
turned:
1 - No animation is displayed.
2 - Color is displayed.
3 - A bar graph is displayed.
4 - Text is displayed.
5 - A symbol is displayed.
6 - AN animation symbol is displayed.
7 - A trend is displayed.
8 - A button is displayed.
9 - A slider is displayed.
10 - A plot is displayed.
11 - The state of the animation currently displayed. If color is displayed, the color
is returned. If a bar graph, trend, or symbol is displayed, the bar, trend, or
symbol name is returned. If text is displayed, the font handle is returned.
Return Value
The animation information, as a string.
Related Functions
DspGetAnCur
Example
IF DspAnInfo(25,0) = "1" THEN
/* If color on AN 25, then get the color */
col = DspAnInfo(25,1);
END
285
See Also
Display Functions
DspAnInRgn
Checks if an AN is within a region bounded by two ANs.
Syntax
pAnInRgn(AN, One, Two)
AN:
One, Two:
One - the AN at a corner of the region; two - the AN at the opposite corner of the
region.
Return Value
1 if the AN is within the region, or 0 (zero) if it is not.
Example
DspGetMouse(X,Y);
DspAnMove(250,X,Y);
IF DspAnInRgn(250,20,30) THEN
Prompt("Mouse in region bounded by AN20 and AN30");
ELSE
Prompt("Mouse not in region");
END
See Also
Display Functions
DspAnMove
Note: This function is only used for V3.xx and V4.xx animations, and was superseded by
future releases.
Moves an AN to a new position. Any animation at this AN is also moved.
Syntax
DspAnMove(AN, X, Y)
AN:
X:
The x pixel coordinates of the new position.
Y:
The y pixel coordinates of the new position.
286
Return Value
Related Functions
DspAnMoveRel
Example
DspAnMove(25,100,200);
! Moves AN25 to pixel location 100,200.
See Also
Display Functions
DspAnMoveRel
Note: This function is only used for V3.xx and V4.xx animations, and was superseded by
future releases.
Moves an AN relative to its current position. Any animation at this AN is also moved.
Syntax
DspAnMoveRel(AN, X, Y)
AN:
X:
The number of pixels to move the AN in the x plane.
Y:
The number of pixels to move the AN in the y plane.
Return Value
Related Functions
DspAnMove
Example
DspAnMoveRel(25,10,20);
/* Moves AN25 by 10 pixels to the right and 20 pixels downward,
relative to its current position. */
See Also
Display Functions
DspAnNew
287
Note: This function is only used for V3.xx and V4.xx animations, and was superseded in
later releases.
Creates an AN at the specified x and y coordinates.
Syntax
DspAnNew(X, Y)
X:
The x pixel coordinate where the new AN is created.
Y:
The y pixel coordinate where the new AN is created.
Return Value
If successful, the new AN is returned. If the AN cannot be created, -1 is returned. If an AN
already exists at this location, that AN is returned.
Related Functions
DspAnNewRel, DspAnFree
Example
AN=DspAnNew(100,200);
DspSym(AN,20);
/* Displays symbol 20 at pixel location 100,200 */
See Also
Display Functions
DspAnNewRel
later releases.
Creates an AN at a distance of x,y pixels from a specified AN.
Syntax
DspAnNewRel(AN, X, Y)
AN:
The AN used as a reference for the new AN.
X:
The distance in the x plane (in pixels) from the reference AN to the new AN.
Y:
The distance in the y plane (in pixels) from the reference AN to the new AN.
Return Value
If successful, the new AN is returned. If the AN cannot be created, -1 is returned. If an AN
already exists at this location, that AN is returned.
288
Related Functions
DspAnNew, DspGetAnCur
Example
AN=DspAnNewRel(20,100,200);
/* Creates an AN at 100x and 200y pixels from AN20 */
See Also
Display Functions
DspBar
Displays a bar graph (on a graphics page) at a specified AN. To scale a tag into the correct
range, use the EngToGeneric() function.
later releases.
Syntax
DspBar(AN, Bar, Value)
AN:
The AN where the bar graph will be displayed.
Bar:
The name of the bar graph to display in the format <[LibName.]BarName>. If you
do not specify the library name, a bar graph from the Global library displays (if it
exists). To display a Version 1.xx bar graph, specify the bar definition (1 to 255).
For example, if you specify bar 1, CitectSCADA displays the bar graph Glo-
bal.Bar001.
Value:
The value to display on the bar graph. The value must be from 0 to 32000 to give
0 to full-scale range on the bar.
Return Value
Related Functions
EngToGeneric
Example
DspBar(25,"Bars.Loops",320);
/* Displays a value of 320 (that is 10%) on the loops bar (from the
bars library) at AN25. */
DspBar(25,3,320);
/* Displays a value of 320 (that is 10%) on bar definition 3
(CitectSCADA Version 1.xx) at AN25. */
DspBar(26,"Loops_Bar",EngToGeneric(Tag1,0,100));
/* Displays Tag1 on the loops_bar (from the global library) at
AN26. Tag1 has an engineering scale of 0 to 100. */
289
See Also
Display Functions
DspBmp
Displays a bitmap at a specified AN. This function allows you to display any bitmap file at
run time. (You can get a new bitmap file from operator input or from the plant, and display
it dynamically.)
later releases.
Syntax
DspBmp(AN, sFile, Mode)
AN:
sFile:
The name of the bitmap (.BMP) file. The file must be in the user project path.
(Does not support 1 bit, 24 bit or OS/2 bitmaps.)
Mode:
The mode of bitmap display:
0 - Erase the existing bitmap and display this bitmap.
1 - Do not erase the existing bitmap, just draw the new bitmap. (This mode pro-
vides smoother animation than Mode 0, but the bitmaps must be the same
size).
2 - Do not erase the existing bitmap, just draw the new bitmap. This mode is sim-
ilar to mode 1, but it displays the bitmap about 3 times faster. However, the
bitmap should not contain any transparent color, or it will display as a ran-
dom color. Use this mode for fast, smooth animation.
Return Value
Related Functions
DspDel
Example
// Display the bitmap "MyImage.bmp" at AN 60
DspBMP(60, "MyImage.bmp", 0)
See Also
Display Functions
DspButton
290
Displays a button at a specified AN. When the button is selected, the key definition is put
into the key command line. The font, width, height, and down and repeat keys of the button
are optional. If you do not specify a width and height, the button adjusts to the size of the
button Name.
later releases.
Syntax
DspButton(AN, UpKey, Name [, hFont] [, Width] [, Height] [, DownKey] [, RepeatKey] [, Style])
AN:
UpKey:
The key generated when the command button is selected (when the mouse but-
ton is released after being clicked down). This is the default operation for com-
mands activated by a button.
Name:
The name to display on the button.
hFont:
The handle of the font used to display the button name. Use the DspFont() func-
tion to create a new font and return the font handle. Use the DspFontHnd() func-
tion to return the font handle of an existing font. The Windows button font is used
if the font is omitted or is not defined in the database.
Width:
The width of the button in pixels.
Height:
The height of the button in pixels.
DownKey:
The key generated when the mouse button is clicked down (over the command
button). Normally this parameter is not used, because most buttons are config-
ured to activate a command when the mouse button is released (returning to the
‘up’ position).
RepeatKey:
The key generated repetitively, while the mouse button is being held down (over
the command button).
Style:
A number indicating the visibility style of the button:
 0 - NORMAL: The button appears as a standard button.
 1 - BORDER_3D: The button is drawn with only the 3-D border (transparent
face).
 2 - BORDER: The button is drawn with only a thin line border.
 3 - TARGET: The button is totally transparent - this constitutes a screen target.
Return Value
291
Related Functions
DspButtonFn, KeySetSeq, DspFont, DspFontHnd
Example
/* Display a self-sizing button at AN20 using the default font.
The button is named "Help". When selected, the Key Code "KEY_F1"
is put into the key command line. */
DspButton(20,KEY_F1,"Help");
/* Display the same button at AN20, but in an existing font called
"BigFont". */
DspButton(20,KEY_F1,"Help",DspFontHnd("BigFont");
See Also
Display Functions
DspButtonFn
Displays a button at a specified AN. When the button is selected, a user function is called.
If the width and height are 0 (zero), then the button adjusts to the size of the button Name.
later releases.
Syntax
DspButtonFn(AN, UpFunction, Name [, hFont] [, Width] [, Height] [, DownFunction] [, Repeat-
Function] )
AN:
UpFunction:
The user function called when the command button is selected (when the mouse
button is released after being clicked down). This is the default operation for com-
mands activated by a button. This callback function can have no arguments, so
specify the function with no parentheses (). The callback function must return
INT as its return data type. You cannot specify a CitectSCADA built-in function
for this argument.
Name:
The name to display on the button.
hFont:
The handle of the font used to display the button name. Use the DspFont() func-
tion to create a new font and return the font handle. Use the DspFontHnd() func-
tion to return the font handle of an existing font. The Windows button font is used
if the font is omitted or is not defined in the database.
Width:
The width of the button in pixels.
Height:
The height of the buton in pixels.
292
DownFunction:
The user function called when the mouse button is clicked down (over the com-
mand button). Normally this parameter is not used, because most buttons are
configured to activate when the mouse button is released (returning to the ‘up’
position). The callback function must have no arguments, so specify the function
with no parentheses (). The callback function must return INT as its return data
type. You cannot specify a CitectSCADA built-in function for this argument.
RepeatFunction:
The user function called repetitively, while the mouse button is being held down
(over the command button) The callback function must have no arguments, so
specify the function with no parentheses (). The callback function must return
INT as its return data type. You cannot specify a CitectSCADA built-in function
for this argument.
Return Value
Related Functions
DspButton, DspFont, DspFontHnd
Example
DspButtonFn(20,MyFunc,"Help",0,50,10);
! Call this function when the button is selected.
INT
FUNCTION
MyFunc()
PageDisplay("Help");
RETURN 0;
END
See Also
Display Functions
DspChart
Displays a chart at an AN. Charts are trend lines with markers on them. Values are plotted
on the chart pens. You must specify Value1, but Value2 to Value8 are optional.
If more values (than the configured pens) are specified, the additional values are ignored.
If fewer values (than the configured pens) are specified, the pens that have no values are
not displayed.
You should use this function only if you want to control the display of charts directly.
Syntax
DspChart(AN, Chart, Value1 [, Value2 ... Value8] )
AN:
The AN where the chart will be displayed.
Chart:
293
The chart to display.

Value1:
The value to display on Pen 1 of the chart.
Value2 ... 8:
The values to display on Pen 2...Pen 8 of the chart. These values are optional.
Return Value
Related Functions
DspDel, DspTrend
Example
/* Using chart definition 5 at AN25, display a value of 10 on
Pen1, 20 on Pen2, 30 on Pen3 and 40 on Pen4 of the chart. */
DspChart(25,5,10,20,30,40);
/* Using chart definition 6 at AN26, display a value of 100 on Pen1
and 500 on Pen2 of the chart. */
DspChart(26,6,100,500);
See Also
Display Functions
DspCol
DspCol is deprecated in this version of CitectSCADA.
Syntax
DspCol(AN, Color)
AN:
Color:
The color to display at the AN.
Return Value
Related Functions
DspDel
Example
DspCol(25,RED);
/* Displays the color red at AN25. */
294
See Also
Display Functions
DspDel
Deletes all objects from a specified AN.
later releases.
Syntax
DspDel(AN)
AN:
Return Value
Related Functions
DspDirty
Example
DspDel(25);
! Deletes all animation at AN25.
See Also
Display Functions
DspDelayRenderBegin
Delays screen updating until DspDelayRenderEnd is called. This function should be used
with DspDelayRenderEnd() to "sandwich" Cicode that will modify the appearance of a
page. The code should be preceded by DspDelayRenderBegin(), and followed by DspDe-
layRenderEnd(). This will reduce screen update times, because the modifying code is given
time to execute before the page is updated with the changes, and the changes are all made
in a single re-draw.
Note: If you have not changed the [Page]DelayRenderAll parameter from its default
(TRUE), then you do not need to use this function.
You can call this function as many times in a row as you like, as long as each is ended with
a call to DspDelayRenderEnd.
Because your display will stop updating while the "sandwiched" code runs, you should try
to make that code as efficient as possible. Do not call Sleep() or any other Cicode functions
that will take a long time to run.
Do not call WinSelect within the "sandwiched" code. Do not call this function directly from
the Kernel.
295
Syntax
DspDelayRenderBegin()
Related Functions
DspDelayRenderEnd
Example
/* Begin delay so the following code can be executed before the
images are re-drawn. */
DspDelayRenderBegin();
DspBMP(50, "Image1.bmp", 0) ! Display the bitmap "Image1.bmp"
at AN 50
at AN 100
at AN 150
at AN 200
at AN 250
/* End delay so the images can be re-drawn. */
DspDelayRenderEnd();
See Also
Display Functions
DspDelayRenderEnd
Ends the screen update delay set by DspDelayRenderBegin. This function should be used
with DspDelayRenderBegin() to "sandwich" Cicode that will modify the appearance of a
page. The code should be preceded by DspDelayRenderBegin(), and followed by DspDe-
layRenderEnd(). This will reduce screen update times, because the modifying code is given
time to execute before the page is updated with the changes, and the changes are all made
in a single re-draw.
Because your display will stop updating while the "sandwiched" code runs, you should try
to make that code as efficient as possible. Do not call Sleep() or any other Cicode functions
that will take a long time to run.
Do not call WinSelect within the "sandwiched" code. Do not call this function directly from
the Kernel.
Note: If you have not changed the [Page]DelayRenderAll parameter from its default
(TRUE), then you do not need to use this function.
Syntax
DspDelayRenderEnd()
Return Value
No value is returned.
296
Related Functions
DspDelayRenderBegin
Example
/* Begin delay so the following code can be executed before the
images are re-drawn. */
DspDelayRenderBegin();
at AN 50
at AN 100
at AN 150
at AN 200
at AN 250
/* End delay so the images can be re-drawn. */
DspDelayRenderEnd();
See Also
Display Functions
DspDirty
Forces CitectSCADA to update an AN. Normally, CitectSCADA updates the animation on
the AN only if the data has changed. This function tells CitectSCADA to update the AN the
next time it animates the AN - even if the data has not changed.
Use this function when you have complex animations that overlap. If two or more anima-
tions overlap, you should use the DspDel() or DspDirty() function on their ANs, and then
display them in the same order (when they need to be updated).
later releases.
Syntax
DspDirty(AN)
AN:
Return Value
Related Functions
DspDel
Example
DspDirty(20);
! Forces an update of AN20.
297
See Also
Display Functions
DspError
Displays an error message at the prompt AN on the operator’s computer. You can disable
the error message display (of this function) by setting the Cicode execution mode in the
CodeSetMode() function.
Syntax
DspError(String)
String:
The message to be displayed.
Return Value
Related Functions
CodeSetMode, Prompt
Example
DspError("Error found");
! Displays "Error found" at the prompt AN.
See Also
Display Functions
DspFile
Defines the screen attributes for displaying a text file. This function defines a "window"
where the file will be displayed. You should call this function before any file-to-screen
function.
You must define sequential ANs for each line of text in the display. The file is displayed
starting at the specified AN, then the next (highest) AN, and so on. You should not use pro-
portionally-spaced fonts, because the columns of text might not be aligned.
You would normally call this function as the entry function for a graphics page. Use the
DspFileSetName() function to specify the file to be displayed. This function is a low level
animation function - it controls exactly how the file is to display. If you just want to display
a file, use the PageFile() function.
Syntax
DspFile(AN, hFont, Height, Width)
AN:
298
The AN where the file display window will be positioned. When this is set to -2,
the window will be created in the Citect Kernel. However, the hFont argument is
ignored.
hFont:
The handle for the font that is used to display the file, returned from the Dsp-
Font() or DspFontHnd() function. The font handle identifies the table where all
data on the associated font is stored.
Height:
The maximum number of lines to display on one page of the file display window.
Width:
The width of the file display window, in characters.
Return Value
Related Functions
PageFile, DspFileGetInfo, DspFileGetName, DspFileScroll, DspFileSetName, DspFont,
DspFontHnd
Example
DspFile(20,0,20,80);
/* Defines the attributes of a screen display to start at AN20,
using the default font, with a window size of 20 lines x 80
columns. */
See Also
Display Functions
DspFileGetInfo
Gets the attributes of a file-to-screen display (used for displaying text files).
Syntax
DspFileGetInfo(AN, Type)
AN:
The AN where the file display window will be located. This AN must be the same
as the AN specified with the DspFile() function.
Type:
The type of data required:
0 - The width of the file display window, in characters.
1 - The maximum number of lines that can display in one page of the file display
window.
2 - The file-to-screen row offset number.
3 - The file-to-screen column offset number.
4 - The number of lines in the displayed file.
299
Return Value
The attributes of the "window" as an integer. If an incorrect AN is specified, an error is re-
turned.
Related Functions
DspFile, DspFileGetName, DspFileScroll, DspFileSetName
Example
! Display the page number of the file display.
PageNumber=IntToStr(DspFileGetInfo(20,2)/DspFileGetInfo(20,1)+1);
DspText(12,0,"Page No "+PageNumber);
See Also
Display Functions
DspFileGetName
Gets the name of the file being displayed in the display "window". You can use this func-
tion to display the file name on the screen.
Syntax
DspFileGetName(AN)
AN:
Return Value
The name of the file (as a string). If an incorrect AN is specified, an error is returned.
Related Functions
DspFile, DspFileGetInfo, DspFileScroll, DspFileSetName
Example
DspText(11,0,DspFileGetName(20));
! Displays the name of the file displayed at AN20.
See Also
Display Functions
DspFileScroll
Scrolls a file (displayed in the display "window") by a number of characters.
Syntax
DspFileScroll(AN, Direction, Characters)
AN:
300

Direction:
The direction in which to scroll:
1 - Left
2 - Right
3 - Up
4 - Down
Characters:
The number of characters to scroll. To page up or page down through the file,
scroll by the height of the file-to-screen window (returned by DspFileGetIn-
fo(AN, 1)).
Return Value
Related Functions
DspFile, DspFileGetInfo, DspFileSetName, DspFileGetName
Example
Page Keyboard
Key Sequence PgUp
Command DspFileScroll(20,3,10)
Comment Scroll up 10 lines
See Also
Display Functions
DspFileSetName
Sets the name of the file to display in the display "window". You should call the DspFile()
function first (as the entry function for a graphics page) to define the attributes of the dis-
play. You can then use the DspFileSetName() function (as a keyboard command) to display
a user-specified file. When you call this function, the specified file name is read from disk
and displayed on the screen.
Syntax
DspFileSetName(AN, sName)
AN:
sName:
The name of the file to display.
Return Value
301
Related Functions
DspFile, DspFileGetInfo, DspFileGetName, DspFileScroll
Example
Pages
Page Name FilePage
Entry Command DspFile(20,0,20,80)
Comment Defines a file to screen display to commence at AN20
Page Keyboard
Key Sequence ######## Enter
Command DspFileSetName(20, Arg1)
Comment Displays a specified file on the page
DspFile(20,0,20,80);
/* Defines the file-to-screen display to commence at AN20 using
the default font, with a window size of 20 lines x 80 columns. */
DspFileSetName(20,"C:\AUTOEXEC.BAT");
! Displays file C:\AUTOEXEC.BAT.
See Also
Display Functions
DspFont
Creates a font and returns a font handle. If the requested font already exists, its font handle
is returned. You can use this font handle in the functions that display text, buttons, and text
files.
If the exact font size does not exist, the closest font size is used.
later releases.
Syntax
DspFont(FontType, PixelSize, ForeOnColour, BackOnColour [, ForeOffColour] [, BackOffColour]
)
FontType:
The font type, for example, "Helv".
PixelSize:
The font size, as a positive number for pixels, or a negative number for points.
ForeOnColour:
The foreground color used for the text. If implementing flashing color, this is the
initial color that will be used. Select a color from the list of Predefined Color
Names and Codes or create an RGB-based color using the function MakeCitect-
Colour.
BackOnColour:
302
The color used for the background of text. If implementing flashing color, this is
the initial color that will be used. Select a color from the list of Predefined Color
Names and Codes or create an RGB-based color using the function MakeCitect-
Colour.
ForeOffColour:
An optional argument only required if implementing flashing color for the font
foreground. It represents the secondary color used. Select a color from the list of
Predefined Color Names and Codes or create an RGB-based color using the func-
tion MakeCitectColour.
BackOffColour:
An optional argument only required if implementing flashing color for the font
background. It represents the secondary color used. Select a color from the list of
Predefined Color Names and Codes or create an RGB-based color using the func-
tion MakeCitectColour.
Return Value
The font handle as an integer. If the font cannot be created, -1 is returned. The font handle
identifies the table where all data on the associated font is stored.
Related Functions
DspFontHnd, DspText, DspButton, DspButtonFn, DspFile
Example
Font=DspFont("Helv",-12,"White","Red");
DspText(20,Font,"Text in Helv Font");
/* Displays "Text in Helv Font" in 12-point Helvetica font in
white on red at AN20. */
Font=DspFont("Helv",24,"White","Red","White");
DspText(20,Font,"Text in Helv Font");
/* Displays "Text in Helv Font" in 24 pixel Helvetica font in
flashing black and white on red at AN20. */
See Also
Display Functions
DspFontHnd
Gets the font handle of a font that is defined in the Fonts database. You can use this font
handle in the functions that display text, buttons, and text files.
later releases.
Syntax
DspFontHnd(Name)
Name:
The font name in the fonts database.
303
Return Value
The font handle as an integer. If the font cannot be found, -1 is returned. The font handle
identifies the table where all data on the associated font is stored.
Related Functions
DspFont, DspText, DspButton, DspButtonFn, DspFile
Example
Fonts
Font Name BigFont
Font Type Helv
Pixel Size 24
Foreground Color Blue
Background Color -1
Comment Defines a font
hBigFont=DspFontHnd("BigFont");
DspText(20,hBigFont,"Text in Big Font");
/* Displays "Text in Big Font" in 24-point Helvetica font in blue
on an unchanged background at AN20. */
See Also
Display Functions
DspFullScreen
Disables or enables the full screen mode of the currently active window. This function does
not resize the window when it is called; it merely sets the mode flag. The next time the win-
dow is displayed, its size (on screen) changes to reflect the setting of the flag. This function
overrides the [Animator]FullScreen parameter setting.
If [Page]DynamicSizing is turned on, a page in full screen state takes up the entire display
area (assuming this does not affect its aspect ratio), and it cannot be resized. Also, a full
screen page will display without a title bar unless Title Bar is checked in Page Properties
(or was checked when the page was created). Resizing pages can result in degraded picture
quality. If this is unacceptable, you should re-design the page using the desired resolution.
If [Page]DynamicSizing is turned off, full screen will have the same limitations as it had in
versions of CitectSCADA prior to V5.10. In other words, for a page to be displayed in full
screen, the size of the page must be the same size as the display (or bigger). If the page is
smaller than the display, the title bar will still display even if full screen mode is enabled.
Check the size of the graphic pages in CtDraw Tools|Page Attributes Dialog to verify that
it is the same as the display resolution. For example 640x480 for VGA, 800x600 for SVGA
and 1024x768 for XGA.
Syntax
DspFullScreen(Mode)
Mode:
304
Full screen mode:

0 - Disable full screen mode.
1 - Enable full screen mode.
Return Value
Related Functions
WinMode
Example
/*Minimize the Window, Enable full screen mode and then maximize
the window.*/
WinMode(6);
DspFullScreen(1);
WinMode(3);
See Also
Display Functions
DspGetAnBottom
Gets the bottom extent of the object at the specified AN.
Syntax
DspGetAnBottom(AN)
AN:
Return Value
The y coordinate of the bottom extent of the object at the AN. If no object exists at the AN,
-1 is returned.
Related Functions
DspGetAnBottom, DspGetAnWidth, DspGetAnHeight, DspGetAnLeft, DspGetAnRight,
DspGetAnTop, DspGetAnNext, DspGetAnExtent
Example
nBottom = DspGetAnBottom(30);
See Also
Display Functions
DspGetAnCur
305
Gets the number of the current graphics AN. You should only call this function from the
database, by using one of the Page forms (for example, the Page Number, Page String, and
Page Trend forms). This function is useful for writing general functions and macros that ap-
ply to graphics pages.
You cannot call this function from the Button or Keyboard forms.
Syntax
DspGetAnCur()
Return Value
The AN associated with the current record in the associated Page database. If this function
is called outside the page animation system then -1 will be returned.
Example
Numbers
AN 20
Expression MyFunc(PV_10)
Comment Display the value of PV_10 at AN20
/* Function displays a number at the current AN and returns the

value supplied in the call */
INT
FUNCTION
MyFunc(INT value)
INT AN, hNew;
AN = DspGetAnCur();
hNew = DspAnNewRel(AN, 0, 20);
DspStr(hNew, "Default", VALUE:###.#);
RETURN value;
END
See Also
Display Functions
DspGetAnExtent
Gets the extent of the object (the enclosing boundary) at the specified AN.
Syntax
DspGetAnExtent(AN, Top, Left, Bottom, Right)
AN:
The AN at which the object is positioned.
Top:
A buffer that contains the top-most extent of the object.
Left:
A buffer that contains the left-most extent of the object.
Bottom:
306
A buffer that contains the bottom-most extent of the object.

Right:
A buffer that contains the right-most extent of the object.
Return Value
0 (zero) if successful, otherwise an error is returned. The Top, Left, Bottom, and Right argu-
ments contain the extents of the object, in pixels.
Related Functions
DspGetAnWidth, DspGetAnHeight, DspGetAnLeft, DspGetAnRight, DspGetAnBottom,
DspGetAnTop
Example
// Get extents at AN 25.
DspGetAnExtent(25, Top, Left, Bottom, Right);
See Also
Display Functions
DspGetAnFirst
Gets the first AN on the current page, based on the order in which the ANs were stored by
Graphics Builder.
Syntax
DspGetAnFirst()
Return Value
The value for the first AN, otherwise an error is returned.
Related Functions
DspGetAnNext
See Also
Display Functions
DspGetAnFromPoint
Gets the AN of the object at a specified set of screen coordinates. If the X and Y coordinates
given are within the extents of an object, then the AN number of the object will be returned.
For example, if there is a button at coordinates (300, 140), and it is 100 wide, 50 high, this
function would return the AN if it uses X between 300 & 400 and Y between 140 and 190,
such as DspGetAnFromPoint(325,180).
307
Hint: If you are using groups and the specified coordinates point to an object that is part of
a group, the AN of the object is returned, not the AN of the group.
Syntax
DspGetAnFromPoint(X, Y [, PrevAN] )
X:
The x coordinate of the screen point.
Y:
The y coordinate of the screen point.
PrevAN:
Retrieves the previous AN (in z-order) in situations where a number of objects
overlap at the specified point. The default of 0 (zero) specifies no previous AN. A
non-zero value should only ever be passed if it is the result of a previous call to
DspGetAnFromPoint.
Return Value
The AN or 0 (zero) if no object exists at the point.
Example
DspGetMouse(X,Y);
// GetMouse position
AN = DspGetAnFromPoint(X,Y);
// Gets AN if mouse is over the object
Prompt("AN of object ="+AN:###);
!Displays the object’s AN at the prompt line
If several objects overlap each other at the specified point, the PrevAN argument can be
used to produce a list of the associated ANs. This is achieved by using PrevAN to pass the
previous result into another call of the function until a zero return is given.
INT nAn;
nAn = DspGetAnFromPoint(100,100)
WHILE nAn <> 0 DO
//Do Something
nAn = DspGetAnFromPoint(100,100,nAn);
END
See Also
Display Functions
308
DspGetAnHeight
Gets the height of the object at a specified AN.
Syntax
DspGetAnHeight(AN)
AN:
Return Value
The height of the object (in pixels). If no object exists at the AN, -1 is returned.
Related Functions
DspGetAnWidth, DspGetAnLeft, DspGetAnRight, DspGetAnBottom, DspGetAnTop
Example
nHeight = DspGetAnHeight(30);
See Also
Display Functions
DspGetAnLeft
Gets the left extent of the object at the specified AN.
Syntax
DspGetAnLeft(AN)
AN:
Return Value
The x coordinate of the left extent of the object at the AN. If no object exists at the AN, -1 is
returned.
Related Functions
DspGetAnWidth, DspGetAnHeight, DspGetAnRight, DspGetAnBottom, DspGetAnTop,
DspGetAnExtent
Example
nLeft = DspGetAnLeft(30);
See Also
Display Functions
309
DspGetAnNext
Returns the AN that follows the specified AN, based on the order in which the ANs were
stored on a page by Graphics Builder.
Syntax
DspGetAnNext(AN)
AN:
Return Value
The value for the next AN. If -1 is returned, it means the specified AN is invalid or it is the
last AN on the page.
Related Functions
DspGetAnFirst
See Also
Display Functions
DspGetAnRight
Gets the right extent of the object at the specified AN.
Syntax
DspGetAnRight(AN)
AN:
Return Value
The x coordinate of the right extent of the object at the AN. If no object exists at the AN, -1
is returned.
Related Functions
DspGetAnWidth, DspGetAnHeight, DspGetAnLeft, DspGetAnBottom, DspGetAnTop,
DspGetAnExtent
Example
nRight = DspGetAnRight(30);
See Also
Display Functions
DspGetAnTop
Gets the top extent of the object at the specified AN.
310
Syntax
DspGetAnTop(AN)
AN:
Return Value
The y coordinate of the top extent of the object at the AN. If no object exists at the AN, -1 is
returned.
Related Functions
DspGetAnWidth, DspGetAnHeight, DspGetAnLeft, DspGetAnRight, DspGetAnBottom,
DspGetAnExtent
Example
nTop = DspGetAnTop(30);
See Also
Display Functions
DspGetAnWidth
Gets the width of the object at a specified AN.
Syntax
DspGetAnWidth(AN)
AN:
Return Value
The width of the object (in pixels). If no object exists at the AN, -1 is returned.
Related Functions
DspGetAnHeight, DspGetAnLeft, DspGetAnRight, DspGetAnBottom, DspGetAnTop,
DspGetAnExtent
Example
nWidth = DspGetAnWidth(30);
See Also
Display Functions
DspGetEnv
Gets a page environment variable.
311
Syntax
DspGetEnv(sName)
sName:
The name of the variable (set using the page environment dialog)
Return Value
The value of the variable (as a string).
Example
FUNCTION
PageGroup()
PageDisplay(DspGetEnv("GroupMenu"));
END
See Also
Display Functions
DspGetMouse
Gets the x and y coordinates of the mouse position, relative to the top left corner of the win-
dow.
Syntax
DspGetMouse(X, Y)
X:
The variables used to store the x pixel coordinate of the mouse position, returned
from this function.
Y:
The variables used to store the y pixel coordinate of the mouse position, returned
from this function.
Return Value
0 (zero) if successful, otherwise an error is returned. The X and Y variables are set to the
mouse position.
Related Functions
KeyGetCursor, DspAnGetPos, DspGetMouseOver, DspGetNearestAn
Example
! If the mouse cursor is at x,y pixel coordinate 43,20;
DspGetMouse(X,Y);
! Sets X to 43 and Y to 20.
See Also
Display Functions
312
DspGetMouseOver
Determines if the mouse is within the boundaries of a given AN.
Syntax
DspGetMouseOver(AN)
AN
The AN of the animation you wish to check, or -1 for the current AN. Defaults to
-1.
Return Value
1 if within the specified AN, 0 if not.
Related Functions
KeyGetCursor, DspAnGetPos, DspGetMouse, DspGetNearestAn
See Also
Display Functions
DspGetNearestAn
Gets the AN nearest to a specified x,y pixel location.
If using groups and the nearest object to the specified coordinates is part of a group, the AN
of the object is returned, not the AN of the group.
Syntax
DspGetNearestAn(X, Y)
X:
The x coordinate (in pixels).
Y:
The y coordinate (in pixels).
Return Value
The animation point number (AN). A value of -1 is returned if no AN is found.
Related Functions
DspGetMouse, DspAnGetPos, DspGetAnFromPoint
Example
DspGetMouse(X,Y);
! Gets mouse position.
AN=DspGetNearestAn(X,Y);
! Gets AN nearest to the mouse.
Prompt("Mouse At AN"+AN:###);
! Displays AN nearest to the mouse.
313
See Also
Display Functions
DspGetParentAn
Gets the parent animation number (if any), for the specified animation number. AN anima-
tion point will have a parent animation point if it corresponds to an object in a group.
Syntax
DspGetParentAn(AN)
AN:
Return Value
The parent animation point number (AN). If no parent animation exists or an invalid ani-
mation number is passed, 0 (zero) is returned.
Related Functions
DspGetAnCur
Example
// Get the parent animation for object 89 (part of a symbol set)
AN = DspGetParentAn(89);
See Also
Display Functions
DspGetSlider
Gets the current position (value) of a slider at an AN. You can call this function in the slider
event to find the new position of the slider.
later releases.
Syntax
DspGetSlider(AN)
AN:
Return Value
The value of the slider from 0 to 32000. If no animation exists at the AN, -1 is returned.
Related Functions
DspSetSlider
314
Example
// Get the position of the slider at AN 30
nPos = DspGetSlider(30);
See Also
Display Functions
DspGetTip
Gets the tool tip text associated with an AN.
Syntax
DspGetTip(AN, Mode)
AN:
The AN from which to get the tool tip text. If no object is configured at the AN,
the function will return an empty string.
Mode:
0 - Tool tips from all animation records configured at the AN. Tips are concate-
nated with a newline character between each string. (This mode is only used for
V3.xx and V4.xx animations, and has been subsequently superseded.)
1 - The tool tip from the object configured at the AN.
Return Value
The tool tip text (as a string). If no user tip is available, an empty string is returned.
Related Functions
DspSetTip, DspTipMode
Example
!Display the tool tip text on AN19
DspText(19, 0, DspGetTip(KeyGetCursor(), 1));
See Also
Display Functions
DspGrayButton
Grays and disables a button. If the button is a symbol, the symbol is overwritten with a gray
mask. (When a button is grayed, it cannot be selected.) If the Disabled field in the Buttons
database is blank, the button is enabled unless you use this function. If the Disabled field
in the Buttons database contains an expression, this function will not override the expres-
sion.
later releases.
315
Syntax
DspGrayButton(AN, nMode)
AN:
The AN where the button is located.
nMode:
The mode of the operation:
0 - Ungray the button.
1 - (GRAY_SUNK) Recess the text or symbol (the text or symbol on the button is
recessed and shadowed).
2 - (GRAY_PART) This mode is now obsolete - it now has the same effect as
GRAY_ALL.
3 - (GRAY_ALL) - Mask the entire button (a gray mask displays over the face of
the button).
Return Value
0 (zero) if successful, otherwise, -1 (if no AN is found).
Related Functions
DspButton, DspButtonFn, DspIsButtonGray
Example
! Disable button at AN21
DspGrayButton(21, GRAY_SUNK);
See Also
Display Functions
DspInfo
Extracts individual pieces of object information from an AN. Each AN can have multiple
expressions associated with it, and each expression can have multiple variables associated
with it. You use an index to refer to each individual expressions or variables. Typically, you
would query the number of expressions, then the number of variables in a given expres-
sion, then the details of a given variable tag.
Note: Before calling this function you must first use DspInfoNew() to create a handle to
the information block from which you want to extract information.
Syntax
DspInfo(hInfo, Type, Index)
hInfo:
The object information block handle, as returned by DspInfoNew(). This handle
identifies the table (or block) where all object data is stored.
Type:
The type of data to extract:
316
0 - Object title (the name of the object type)

1 - Object expression text
2 - Object expression result text
3 - The variable tag name
4 - Not supported.
Note: Getting the raw value using DspInfo is no longer supported. To
get the raw value of a tag, use the TagSubscribe function, specifying a
value of “Raw” for the sScaleMode parameter. When using TagSub-
scribe, you can either call SubscriptionGetAttribute to obtain the value
whenever required or register a callback cicode function to run when
the value changes. See TagSubscribe for more details.
5 - The engineering value associated with the variable
6 - The Cicode context. Calling DspInfo with this Type will return a string de-
scribing the context in which the Cicode expression is contained. For exam-
ple, if it appears on the horizontal movement tab it would return "Move X".
7 - The number of Cicode expressions. Calling DspInfo with this Type will return
the number of Cicode expressions associated with this animation point.
8 - The number of tags in the expression. Calling DspInfo with this Type will re-
turn the number of tags that appear in the given Cicode expression.
9 - Name of the cluster in which the variable tag resides.
10 - Full name of the variable tag in the form cluster.tagname.
Index:
An index to the variable within the information block. The required index chang-
es according to the Type as follows:
 For Types 0 to 2, 6 and 8, the index must be set to the index of the expression
that you wish to query.
 For Types 3 to 5, the index must be set to the index of the tag that you wish to
query. When one of these types is used, DspInfo will query the tag in the most
recently queried expression (otherwise expression 0).
 For Type 7, the index is ignored.
Return Value
The object information (as a string). A blank string is returned if you specify a non-existent
expression or variable.
Related Functions
DspInfoNew, DspInfoField, DspInfoDestroy, TagSubscribe, SubscriptionAddCallback,
SubscriptionGetAttribute
Example
INT hInfo;
INT iEngineeringValue;
INT iNumberOfExpressions;
INT iNumberOfTags;
INT iExpressionIndex;
INT iTagIndex;
STRING sObjectType;
STRING sExpressionText;
317
STRING sExpressionResult;
STRING sExpressionContext;
STRING sTagName;
hInfo = DspInfoNew(AN);
IF (hInfo > -1) THEN
sObjectType = DspInfo(hInfo, 0, 0);
iNumberOfExpressions = StrToInt(DspInfo(hInfo, 7, 0));
FOR iExpressionIndex = 0 TO iExpressionIndex < iNumberOfExpressions DO
sExpressionText = DspInfo(hInfo, 1, iExpressionIndex);
sExpressionResult = DspInfo(hInfo, 2, iExpressionIndex);
sExpressionContext = DspInfo(hInfo, 6, iExpressionIndex);
iNumberOfTags = StrToInt(DspInfo(hInfo, 8, iExpressionIndex));
FOR iTagIndex = 0 TO iTagIndex < iNumberOfTags DO
sTagName = DspInfo(hInfo, 3, iTagIndex);
iEngineeringValue = StrToInt(DspInfo(hInfo, 5, iTagIndex));
..
END
..
END
END
See Also
Display Functions
DspInfoDestroy
Destroys an object information block created by DspInfoNew(). You should destroy an ob-
ject information block when you no longer need it, to free CitectSCADA resources.
When the page (with which the object is associated) is closed, CitectSCADA automatically
destroys the object information block.
Syntax
DspInfoDestroy(hInfo)
hInfo:
Return Value
Related Functions
DspInfo, DspInfoNew, DspInfoField, DspInfoValid
Example
hInfo=DspInfoNew(20);
! Do animation operation
DspInfoDestroy(hInfo);
318
See Also
Display Functions
DspInfoField
Obtains static and real-time data from a variable tag. You get static data from the Variable
Tags database. The additional field "Eng_Value", returns dynamic real-time data for the
variable tag. To get this real-time data, you must first call the DspInfoNew() function to get
the information block handle hInfo.
Getting the raw value of a variable tag using DspInfoField is no longer supported. To get
the raw value of a tag, use the TagSubscribe function, specifying a value of “Raw” for the
sScaleMode parameter. When using TagSubscribe, you can either call SubscriptionGetAt-
tribute to obtain the value whenever required or register callback cicode function to run
when the value changes. See TagSubscribe for more details.
Syntax
DspInfoField(hInfo, sTag, sField [, ClusterName] )
hInfo:
identifies the table (or block) where all data on the object is stored. Set this handle
to 0 (zero) if you do not require real-time data.
sTag:
The name of the variable tag. The name of the tag can be prefixed by the name of
the cluster that is "ClusterName.Tag". This argument does not support arrays. If
array syntax is used, the information will be retrieved for only the tag name.
sField:
The name of the field from which to extract the data:
Cluster - Name of the cluster in which the Tag resides
Comment - Variable tag comment
Eng_Full - Engineering Full Scale
Eng_Zero - Engineering Zero Scale
Eng_Units - Engineering Units
Eng_Value - Scaled engineering value - Dynamic
Field - Description
FullName - Full name of the tag in the form cluster.tagname.
Name - Variable Tag Name
Type - Data Type
Unit - I/O Device Name
ClusterName:
Specifies the name of the cluster in which the Tag resides. This is optional if you
have one cluster or are resolving the tag via the current cluster context. The argu-
Return Value
The data (as a string).
319
Related Functions
DspInfo, DspInfoNew, DspInfoDestroy, SubscriptionGetAttribute, SubscriptionAddCall-
back, TagSubscribe
Example
! Get the I/O device that Variable Tag "PV123" belongs to.
IODev=DspInfoField(0,"PV123","Unit");
! Get the real-time engineering value of a tag.
hInfo=DspInfoNew(20);
sTag=DspInfo(hInfo,3,0);
EngValue=DspInfoField(hInfo,sTag,"Eng_Value");
See Also
Display Functions
DspInfoNew
Creates an object information block. Use this function with the associated low-level anima-
tion information functions to get and process object information on an AN.
Note: When you have finished with the object information block, you must destroy it with
the DspInfoDestroy() function. There are limited number of info 383 blocks that can be al-
located, if they are not freed properly DspInfoNew will return -1.
If you need simple animation help, use the InfoForm() or the InfoFormAn() functions.
Syntax
DspInfoNew(AN)
AN:
The AN for which object information is provided.
Return Value
The object information block handle. If no object data is available, then -1 is returned.
Related Functions
DspInfo, DspInfoField, DspInfoDestroy, InfoForm, InfoFormAn
Example
/*This example creates a form, with the title "Tag Info" and a
size of 25 x 5 characters. It creates an information block for the
AN closest to the mouse cursor and then extracts the name, I/O
device, and engineering value for the first tag in the object
expression.*/
INT hInfo;
STRING sTag;
hInfo=DspInfoNew(DspGetNearestAN());
IF hInfo>-1 THEN
FormNew("Tag Info",25,5,2);
sTag=DspInfo(hInfo,3,0);
FormPrompt(0,0,sTag);
FormPrompt(0,16,DspInfoField(hInfo,sTag,"Unit"));
320
FormPrompt(0,32,DspInfoField(hInfo,sTag,"Eng_Value"));
FormRead(0);
DspInfoDestroy(hInfo);
END
See Also
Display Functions
DspInfoValid
Checks if an object information block handle is valid. An object information block handle
becomes invalid after it is destroyed, or if the user closes the page it is associated with. Use
this function if background Cicode is using the object information block, and the operator
closes the page.
Syntax
DspInfoValid(hInfo)
hInfo:
Return Value
1 if the information block handle is valid, otherwise 0 (zero).
Related Functions
DspInfoNew, DspInfoField, DspInfoDestroy
Example
IF DspInfoValid(hInfo) THEN
EngValue=DspInfoField(hInfo,sTag,"Eng_Value");
END
See Also
Display Functions
DspIsButtonGray
Gets the current status of a button.
Note: This function is only used for V3.xx and V4.xx animations, and has been superseded.
Syntax
DspIsButtonGray(AN)
AN:
The AN for which object information is provided.
321
Return Value
The current mode of the button:
 0 - The button is active (not grayed).
 1 - (SUNK_GRAY) The button is inactive (the text or symbol on the button is recessed).
 2 - (PART_GRAY) This mode is now obsolete. The button will be inactive even if
part_gray is returned.
 3 - (ALL_GRAY) The button is inactive (the entire button is masked).
Related Functions
DspButton, DspButtonFn, DspGrayButton
Example
! Check the status of the button at AN21
status = DspIsButtonGray(21);
See Also
Display Functions
DspKernel
Displays the Kernel window. You should restrict the use of this function because once you
are in the Kernel, you can execute any Cicode function with no privilege restrictions. You
therefore have total control of CitectSCADA (and subsequently your plant and equip-
ment). Please be aware that you can also open the Kernel by setting the Citect [De-
bug]Menu parameter to 1 and, when your system is running, selecting Kernel from the
control-menu box.
Note: You should be experienced with CitectSCADA and Cicode before attempting to use
the Kernel as these facilities are powerful, and if used incorrectly, can corrupt your system.
Note: You should only use the Kernel for diagnostics and debugging purposes, and not for
normal CitectSCADA operation.
You should restrict access to the Kernel, because once you are in the Kernel, you can exe-
cute any Cicode function with no privilege restrictions. You therefore have total control of
CitectSCADA (and subsequently your plant and equipment).
Syntax
DspKernel(iMode)
iMode:
The display mode of Kernel:
1 - Display the Kernel. If the Kernel is already displayed and iMode=1, the key-
board focus is changed to the Kernel.
0 - Hide the Kernel
Return Value
322
Related Functions
KerCmd, TraceMsg
Example
DspKernel(1);
!Display the Citect Kernel window
See Also
Display Functions
DspMarkerMove
Moves a trend or chart marker to a specified position.
Syntax
DspMarkerMove(AN, hMarker, Offset)
AN:
The AN where the trend or chart is positioned.
hMarker:
The marker handle, as returned from the DspMarkerNew() function. The marker
handle identifies the table where all data on the associated marker is stored.
Offset:
The offset by which to move the marker. Vertical markers have an offset from 0
(zero) to the maximum number of samples in the trend. Horizontal markers have
a offset of 0 (zero) to 32000.
Return Value
Related Functions
DspMarkerNew, OnEvent
Example
See DspMarkerNew
See Also
Display Functions
DspMarkerNew
Creates a new trend marker. A trend marker is used to show cursor values or limits on a
trend. You can use up to 10 markers on a single trend or chart.
If you add markers to a trend or chart that CitectSCADA is animating, you must repaint
them using the trend paint event (OnEvent(Window,22)). (Otherwise CitectSCADA will de-
lete any markers displayed when the trend is updated.)
323
Syntax
DspMarkerNew(AN, Mode, Color)
AN:
Mode:
The mode of the marker:
0 - A vertical marker
1 - A horizontal marker
Color:
The color of the marker (flashing color not supported). Select a color from the list
of Predefined Color Names and Codes or create an RGB color using the function
MakeCitectColour.
Return Value
The marker handle, or -1 if the function is unsuccessful. The marker handle identifies the
table where all data on the associated marker is stored.
Related Functions
DspMarkerMove, OnEvent
Example
INT offset; ! offset of marker
INT hMarker; ! marker handle
hMarker = DspMarkerNew(40, 0, WHITE);
! create a new marker, vertical WHITE
offset = 100;
DspMarkerMove(40, hMarker, offset);
! Moves marker to offset 100
OnEvent(22, MyTrendPaint);
! set trend paint event, must stop event when change pages
! this function is called when CitectSCADA updates the trend
INT
FUNCTION
MyTrendPaint()
DspMarkerMove(40, hMarker, offset);
RETURN 0;
END
See Also
Display Functions
DspMCI
Controls a multimedia device. The Media Control Interface (MCI) is a high-level command
interface to multimedia devices and resource files. MCI provides applications with device-
independent capabilities for controlling audio and visual peripherals (for example, for
playing multimedia devices and recording multimedia resource files).
324
Using this function, you can control multimedia devices by using simple commands like
open, play, and close. MCI commands are a generic interface to multimedia devices. You
can control any supported multimedia device, including audio playback and recording.
For a full overview of MCI, see the Windows Multimedia Programmer’s Guide.
Syntax
DspMCI(sCommand)
sCommand:
The MCI command. See the Microsoft Windows Multimedia Programmer’s
Guide for details.
Return Value
A string message with the status of the MCI command.
Related Functions
DspPlaySound
Example
DspMCI("open cdaudio")
DspMCI("set cdaudio time format tmsf")
DspMCI("play cdaudio from 6 to 7")
DspMCI("close cdaudio")
/*Plays track 6 of an audio CD*/
DspMCI("open c:\mmdata\purplefi.wav type waveaudio alias finch")
DspMCI("set finch time format samples")
DspMCI("play finch from 1 to 10000")
DspMCI("close finch")
/*Plays the first 10,000 samples of a waveform audio file*/
See Also
Display Functions
DspPlaySound
Plays a waveform (sound). Wave form sound files *.WAV are provided with Windows and
by third-party developers, or you can record them yourself to play long (and complex)
sound sequences.
This function searches the [Sounds] section of the WIN.INI file for an entry with the speci-
fied name, and plays the associated waveform. If the name does not match an entry in the
WIN.INI file, a waveform filename is assumed. The function will then search the following
directories for the waveform file (directories are listed in search order):
 The current directory
 The Windows directory
 The Windows system directory
 The directories listed in the PATH environment variable
 The list of directories mapped in the network.
325
If the file is not in one of the aforementioned directories, you must include the full path to
the sound file. If the file doesn’t exist in one of the above directories or at a location speci-
fied with a full path, the sound will not be played.
Syntax
DspPlaySound(sSoundname, nMode)
sSoundname:
The waveform to be played. Predefined sounds (in the WIN.INI file) are:
 SystemAsterisk
 SystemExclamation
 SystemQuestion
 SystemDefault
 SystemHand
 SystemExit
 SystemStart
nMode:
Not used. Must be 0 (zero).
Return Value
TRUE if successful, otherwise FALSE (if an error is detected).
Related Functions
Beep
Example
DspPlaySound("C:\WINNT\MEDIA\Notify.wav",0);
DspPlaySound("SystemStart",0);
See Also
Display Functions
DspPopupMenu
Creates a popup menu consisting of a number of menu items. Multiple calls to this function
enable you to add new items and create sub menus, building a system of linked, Windows-
style menus.
Menu items can be displayed as checked and/or disabled. You can also specify a bitmap to
display as a menu icon.
This function is first called to build the menu’s items and links, and then called again to dis-
play it on the screen. In this final call, you have the option to specify the coordinates at
which the menu will display, or let it default to the current cursor position.
Syntax
DspPopupMenu(iMenuNumber, sMenuItems [, XPos] [, YPos] )
iMenuNumber:
326
An integer representing the menu you are adding items to. The first menu created
is Menu 0. If left unspecified, this parameter defaults to -1, causing the menu to
be displayed on the screen.
Multiple function calls with the same iMenuNumber allow you to build up en-
tries in a particular menu. For example, the following four function calls with iM-
enuNumber = 1 build up 8 entries in Menu 1:
 DspPopupMenu(1, "Selection A>2, Selection B>3");
 DspPopupMenu(1, "Selection C>2, Selection D");
 DspPopupMenu(1, "Selection E>2, Selection F>3");
 DspPopupMenu(1, "Selection G>2, Selection H");
sMenuItems:
A comma-separated string defining the items in each menu. The default value for
this parameter is an empty string, which will get passed to the function in the call
to display the menu.
The (!), (~), and (,) symbols control display options for menu items.
For example, !Item1 disables Item1; ~Item2 checks Item2; and ,Item3 inserts a sep-
arator above Item3. To insert a link from a menu item to a sub menu, use the (>)
symbol. For example, : Item4>1 means Item4 links to menu 1.
To insert a bitmap to the left of a menu item as its icon, use the following notation:
[Icon]Item5 Inserts the bitmap Icon.BMP to the left of Item5. [Icon] must be
placed before the Item name, but after any disable (!) or check (~) symbols you
may wish to specify.
Bitmap files used for menu icons must be saved in the project directory so that
they can be found by CitectSCADA.
XPos:
The x-coordinate at which the menu will be displayed. This parameter is option-
al. If it is left unspecified, the menu will display at the cursor’s current position.
YPos:
The y-coordinate at which the menu will be displayed. This parameter is option-
al. If it is left unspecified, the menu will display at the cursor’s current position.
Return Value
The selected menu item as an integer. This comprises the menu number (return value div
100), and the position of the item in the menu (return value mod 100). For example, a return
value of 201 indicates that the first item in Menu 2 was selected, and a return value of 3 in-
dicates that the third item in Menu 0 was selected.
Note: Links to sub menus are not counted as menu items. For example, if your menu con-
sists of 10 links and one unlinked item, the function will return only when the unlinked
item is selected.
Example1
!Example 1 illustrates one menu with three menu items.
FUNCTION BuildPopupMenus()
INT iSelection;
DspPopupMenu(0, "Item 1,!Item 2,~Item 3");
iSelection = DspPopupMenu(-1, "", 150, 300);
! The above builds a menu with three items:
! ’Item 1’ will be shown as normal, ’Item 2’ will be shown as disabled,
! and ’Item 3’ will be shown as checked.
! The menu will be displayed at position (150, 300).
327
END
Example 2
!Example 2 illustrates the creation of two menus which are linked.
FUNCTION BuildLinkedPopupMenus()
INT iSelection;
DspPopupMenu(0, "Item A,Item B>1,Item C");
DspPopupMenu(1, "Item B1,,[Trend]Item B2,,Item B3");
iSelection = DspPopupMenu();
! The above will build two menus - Menu 0 and Menu 1
! Item B on Menu 0 links to Menu 1.
! ’Item B2’ will be shown with Trend.BMP at its left.
! The menu will be displayed at the cursor’s position.
! If ’Item A’ is selected, iSelection will equal 1
! If ’Item C’ is selected, iSelection will equal 2
! If ’Item B1’ is selected, iSelection will equal 101
END
See Also
Display Functions
DspRichText
Creates a Rich Text object of the given dimensions at the animation point AN. This object
can then be used to display an RTF file (like an RTF report) called using the DspRichText-
Load function.
Syntax
DspRichText(AN, iHeight, iWidth, iMode)
AN:
The AN at which the rich text object will display when the DspRichText com-
mand is run.
iHeight:
The height of the rich text object in pixels. The height is established by measuring
down from the animation point.
iWidth:
The width of the rich text object in pixels. The width is established by measuring
across to the right from the animation point.
iMode:
The display mode for the rich text object. The mode can be any combination of:
0 - Disabled - should be used if the rich text object is to be used for display pur-
poses only.
1 - Enabled - allows you to select and copy the contents of the RTF object (for in-
stance an RTF report), but you will not be able to make changes.
328
2 - Read/Write - allows you to edit the contents of the RTF object. Remember,
however, that the object must be enabled before it can be edited. If it has
already been enabled, you can just enter Mode 2 as your argument. If it is
not already enabled, you will need to enable it. By combining Mode 1 and
Mode 2 in your argument (3), you can enable the object, and make it read/
write at the same time.
Because the content of the rich text object is just a copy of the original file, changes
will not affect the actual file, until saved using the DspRichTextSave function.
Return Value
0 if successful, otherwise an error is returned.
Related Functions
DspRichTextLoad, PageRichTextFile
Example
//This will produce a rich text object at animation point 57,
which is 200 pixels high, and 200 pixels wide. This object will be
for display purposes only (that is read only)//
DspRichText(57,200,200,0);
See Also
Display Functions
DspRichTextEdit
Enables editing of the contents of the rich text object at AN if nEdit = TRUE, and disables
editing if nEdit = FALSE.
Syntax
DspRichTextEdit(AN, bEdit)
AN:
The reference AN for the rich text object.
bEdit:
The value of this argument determines whether you will be able to edit the con-
tents of the rich text object at AN. Enter TRUE to enable editing, or enter FALSE
to make the contents read-only.
Changes made to the contents of the object will not be saved until the DspRich-
TextSave function is used.
Return Value
Related Functions
PageRichTextFile, DspRichTextEnable, DspRichTextSave
329
Example
// Enables editing of the rich text object at AN 25 - if one
exists. Otherwise an error will be returned to iResult //
iResult = DspRichTextEdit(25,TRUE);
See Also
Display Functions
DspRichTextEnable
Enables the rich text object at AN if nEnable = TRUE, and disables the object if nEnable =
FALSE. When the object is disabled, its contents cannot be selected or copied etc.
Syntax
DspRichTextEnable(AN, bEnable)
AN:
bEnable:
The value of this argument determines whether the rich text object at AN will be
enabled or disabled. Enter TRUE to enable the object (that is you can select and
copy the contents of the RTF object, but you can’t make changes). Enter FALSE to
disable the object (that is make it display only).
Return Value
Related Functions
DspRichTextEdit
Example
// This line disables the rich text object at AN 25 - if one
exists. Otherwise an error will be returned to iResult //
iResult = DspRichTextEnable(25,FALSE);
See Also
Display Functions
DspRichTextGetInfo
Retrieves size information about the rich text object at animation point AN.
Syntax
DspRichTextGetInfo(AN, iType)
AN:
330
iType:
The following size information (in pixels) can be returned about the specified rich
text object:
0 - Height
1 - Width
Return Value
The requested information as a string (units = pixels).
Related Functions
PageRichTextFile
Example
! Gets the height of the rich text object at AN 25 - if one exists.
iHeight = DspRichTextGetInfo(25,0);
! Gets the width of the rich text object at AN 423.
iWidth = DspRichTextGetInfo(423,1);
See Also
Display Functions
DspRichTextLoad
Loads a copy of the file Filename into the rich text object) at animation point AN. (The rich
text object may have been created using either the DspRichTextLoad function or the PageR-
ichTextFile function.)
Syntax
DspRichTextLoad(AN, sFilename)
AN:
The animation point at which a copy of the rich text file (for example, an RTF re-
port) will display. This AN must match that of a rich text object (created using ei-
ther the DspRichText function, or the PageRichTextFile function), or the copy of
the file will not be loaded into anything, and will not display.
sFilename:
The name of the file to be copied and loaded into the rich text object at the speci-
fied animation point. The filename must be entered in quotation marks "".
The maximum file size that can be loaded is 512kb.
If you are loading a copy of an RTF report, the report must already have been run
and saved to a file. Remember that the filename for the saved report comes from
the File Name field in the Devices form. The location of the saved file must also
be included as part of the filename. For example, if the filename in the Devices
form listed [Data];RepDev.rtf, then you would need to enter "[Data]\repdev.rtf"
as your argument. Alternatively, you can manually enter the path, for example,
"c:\MyApplication\data\repdev.rtf".
331
If you are keeping a number of history files for the report, instead of using the ex-
tension rtf, you must change it to reflect the number of the desired history file, for
example, 001.
Return Value
Related Functions
DspRichText, PageRichTextFile
Example
// This will look in the [Data] path (as specified in the
Citect.ini file), and load a copy of the file DayRep.rtf into the
rich text object at animation point 57. //
DspRichTextLoad(57,"[Data]\DayRep.rtf");
// This will look in the [Data] path (as specified in the
Citect.ini file), and load a copy of the history file DayRep.003
into the rich text object at animation point 908. //
DspRichTextLoad(908, "[Data]\DayRep.003");
// This will load a copy of the history file
f:\MyApplication\data\DayRep.006, into the rich text object at animation
point 908. //
DspRichTextLoad(908, "f:\MyApplication\data\DayRep.006");
See Also
Display Functions
DspRichTextPgScroll
Scrolls the contents of the rich text object displayed at AN, by one page length in the direc-
tion given in direction.
Syntax
DspRichTextPgScroll(AN, iDirection)
AN:
iDirection:
The direction in which you want to scroll each time this function is run. You can
choose from the following:
1 - Left
2 - Right
3 - Up
4 - Down
8 - Scroll to top
16 - Scroll to bottom
332
Return Value
Related Functions
PageRichTextFile, DspRichTextEdit, DspRichTextScroll
Example
// This line scrolls the contents of the rich text object at AN 25
down one page. Otherwise an error will be returned to iResult //
iResult = DspRichTextPgScroll(25,4);
// This line scrolls the contents of the rich text object at AN 423
right one page. Otherwise an error will be returned to iResult //
iResult = DspRichTextPgScroll(423,2);
See Also
Display Functions
DspRichTextPrint
Prints the contents of the rich text object at animation point AN, to the port PortName.
Syntax
DspRichTextPrint(AN, sPortName)
AN:
sPortName:
The name of the printer port to which the contents of the rich text object will be
printed. This name must be enclosed within quotation marks "". For example
"LPT1", to print to the local printer, or "\\Pserver\canon1" using UNC to print to
a network printer.
Return Value
Related Functions
DspRichText, FileRichTextPrint
Example
! This lines prints
DspRichTextPrint(25,"LPT1:");
See Also
Display Functions
DspRichTextSave
333
Saves the contents of the rich text object at animation point AN, to the file Filename.
Syntax
DspRichTextSave(AN, sFilename)
AN:
sFilename:
The name under which the contents of the rich text object will be saved. This
name must be enclosed within quotation marks "", and must include the destina-
tion path. For example "[Data]\saved.rtf".
Return Value
Related Functions
DspRichText, PageRichTextFile, DspRichTextLoad, DspRichTextEdit
Example
// These lines show two different ways of saving the contents of
the rich text object (at AN 25) to file DayRep.rtf//
DspRichTextSave(25,"[Data]\DayRep.rtf");
DspRichTextSave(25,"c:\MyApplication\data\DayRep.rtf");
See Also
Display Functions
DspRichTextScroll
Scrolls the contents of the rich text object displayed at AN, in the direction given in direction,
by the number of lines/units given in amount. Remember that the height of a line varies ac-
cording to the font used, therefore if you need to scroll absolute distances, it might be ad-
visable to use the DspRichTextPgScroll function.
Syntax
DspRichTextScroll(AN, iDirection, iAmount)
AN:
iDirection:
The direction in which you want to scroll each time this function is run. You can
choose from the following:
1 - Left
2 - Right
3 - Up
4 - Down
8 - Scroll to top
334
16 - Scroll to bottom
iAmount:
The amount by which you would like to scroll each time this function is run. En-
ter the number of lines (for a vertical direction) or units (for a horizontal direc-
tion) by which you would like to scroll.
Return Value
Related Functions
PageRichTextFile, DspRichTextEdit, DspRichTextPgScroll
Example
DspRichTextScroll(25,4,8);
DspRichTextScroll(423,2,1);
See Also
Display Functions
DspRubEnd
Ends the rubber band selection, and returns the coordinates of the rubber band selection.
The meaning of the cx and cy values depend on the nMode you specify in the DspRubStart()
function.
Syntax
DspRubEnd(x, y, cx, cy)
x,y:
The x and y coordinates of the start position.
cx,cy:
The x and y coordinates of the end position.
Return Value
Related Functions
DspRubStart, DspRubMove, DspRubSetClip
Example
See DspRubStart
See Also
Display Functions
DspRubMove
335
Moves the rubber band selection to the new position. You must first have defined a rubber
band selection using the DspRubStart() and DspRubEnd() functions.
This function will erase the existing rubber band and then redraw it in the new position.
You would normally move the rubber band by mouse input, but you can get input from
the keyboard or any other Cicode to control the rubber band.
Syntax
DspRubMove(x, y)
x,y:
The x and y coordinates of the current position.
Return Value
Related Functions
DspRubStart, DspRubEnd, DspRubSetClip
Example
See DspRubStart
See Also
Display Functions
DspRubSetClip
Sets the clipping region for the rubber band display. If you enable the clipping region, the
rubber band will not move outside of the clip region. This allows you to restrict the rubber
band to within some constrained region. (For example, to prevent an operator from drag-
ging the rubber band outside of the trend display when zooming the trend.)
You must call this function (to enable the clipping region) before you can start the rubber
band selection (with the DspRubStart() function).
Syntax
DspRubSetClip(x1, y1, x2, y2)
x1,y1,x2,y2:
The x and y coordinates of the clipping region.
Return Value
Related Functions
DspRubStart, DspRubEnd, DspRubMove
Example
// Set the clipping region to a rectangle starting at 100, 100 to
200, 300
DspRubSetClip(100, 100, 200, 300);
336
// Start the rubber band display with clipping mode on

DspRubStart(x, y, 4);
See Also
Display Functions
DspRubStart
Starts the rubber band selection. Call this function when the left mouse button is pressed -
the rubber band is displayed at the starting position. Call the DspRubEnd() function to end
the selection, when the mouse button is released. The DspRubMove() function moves the
selection to the new position.
This function is used by the trend templates for the trend zoom function. Use the rubber
band functions whenever you want the operator to select a region on the screen or display
a dynamic rectangle on the screen.
You can only display one rubber band per page. If you display a second rubber band, the
first rubber band is erased. To move a rubber band with the mouse, use the OnEvent() func-
tion to get notification of the mouse movement, and then the DspRubMove() function. Be-
cause these are generic rubber-band display functions, you can get input from the
keyboard, Cicode variables, the I/O device, and the mouse.
Syntax
DspRubStart(x, y, nMode)
x,y:
The x and y coordinates of the current position.
nMode:
The mode of the rubber banding operation:
0 - cx,cy as absolute pixel positions
1 - cx,cy in pixels relative to x,y
2 - (x,y) the distance from top left to (cx,cy)
4 - enable the rubber band selection using the clipping region defined by DspRub-
SetClip().
Return Value
Related Functions
DspRubEnd, DspRubMove, DspRubSetClip, OnEvent
Example
See also the ZOOM.CI file in the Include project for details.
INT xRub,yRub,cxRub,cyRub;
/* Call this function on left mouse button down. */
FUNCTION
StartSelection()
INT x,y;
337
DspGetMouse(x,y); ! Get the current mouse position

DspRubStart(x,y,0); ! Start the rubber banding
OnEvent(0,MouseEvent); ! Attach mouse move event
END
/* Call this function on left mouse button up. */
FUNCTION
EndSelection()
! Stop the rubber banding and get sizes into the ..Rub variables
DspRubEnd(xRub,yRub,cxRub,cyRub);
OnEvent(0,0); ! Stop mouse move event
END
INT
FUNCTION
MouseEvent()
INT x,y;
DspGetMouse(x,y); ! Get mouse position
DspRubMove(x,y); ! Move the rubber band
RETURN 0
END
See Also
Display Functions
DspSetSlider
Sets the current position of a slider at the specified AN. You can use this function to move
a slider, and adjust the value of the variable associated with the slider.
later releases.
Syntax
DspSetSlider(AN, nPos)
AN:
nPos:
The position of the slider from 0 to 32000 where 0 is the zero position of the slider
and 32000 if full position of the slider.
Return Value
Related Functions
DspGetSlider
Example
// Set the position of the slider at AN 30 to 1/2 scale
DspSetSlider(30, 16000);
338
See Also
Display Functions
DspSetTip
Sets tool tip text associated with an AN. Any existing text associated with the AN will be
replaced with the new text.
Syntax
DspSetTip(AN, sText)
AN:
sText:
The tool tip text to set for the AN.
Return Value
Related Functions
DspGetTip, DspTipMode
Example
!Set a tool tip for AN19
DspSetTip(19, "Start Slurry Pump");
See Also
Display Functions
DspSetTooltipFont
Sets the font for tool tip text.
The parameter [Animator]TooltipFont also specifies the tool tip font. The parameter is
checked at startup, and if it is set, the font is set accordingly. You can then use DspSetTool-
tipFont() to override the parameter until the next time you start CitectSCADA.
Syntax
DspSetTooltipFont(sName [, nPointSize] [, sAttribs] )
sName:
The name of the Windows font to be used, enclosed by quotation marks " ". A val-
ue for this parameter is required, however specifying an empty string "" will set
the tooltip font to the default of MS Sans Serif.
nPointSize:
The size of the font in points. If you do not specify a value, the point size defaults
to 12.
sAttribs:
339
A string specifying the format of the font. Use one or all of the following, enclosed
by quotation marks " ":
 B to specify Bold
 I to specify Italics
 U to specify Underline
If you don’t specify a value for this parameter, it will default to an empty string
and no formatting will be applied.
Return Value
No return value.
Related Functions
DspGetTip, DspTipMode
Example
!Set the tool tip font to Bold, Italic, Times New Roman, with a
point size of 12
DspSetTooltipFont("Times New Roman", 12, "BI");
See Also
Display Functions
DspStatus
Determines whether the object at the specified AN will be grayed (hatch pattern) in the
event communication attempts are unsuccessful.
Syntax
DspStatus(AN, nMode)
AN:
nMode:
0 - Normal display when communication attempts are unsuccessful
1 - Gray the object (with a hatch pattern) when communication attempts are un-
successful
Return Value
Example
DspStatus(67, 1)
// Disable the animation at AN 67
See Also
Display Functions
340
DspStr
Displays a string at a specified AN.
later releases.
Syntax
DspStr(AN, sFont, sText)
AN:
The AN where the text will be displayed.
sFont:
The name of the font that is used to display the text. The Font Name must be de-
fined in the Fonts database. If the font is not found, the default font is used.
sText:
The text to display.
Return Value
Related Functions
DspText
Example
DspStr(25,"RedFont","Display this text");
/* Displays "Display this text" using "RedFont" at AN25. "RedFont"
must be defined in the Fonts database. */
See Also
Display Functions
DspSym
Note: This function is only used for V3.xx and V4.xx animations. In later releases this func-
tion is redundant. The same functionality can be achieved using objects.
Displays a symbol at a specified AN. If the symbol number is 0, any existing symbol (at the
AN) is erased.
Syntax
DspSym(AN, Symbol [, Mode] )
AN:
The AN where the symbol will be displayed.
Symbol:
The name of the symbol to display in the format <[LibName.]SymName>. If you
do not specify the library name, a symbol from the Global library will display (if
it exists).
341
Mode:
Not used. The mode is always set to 1, which means do not erase the existing
symbol, just draw the new symbol.
Return Value
Related Functions
DspDel
Example
! Display the centrifuge symbol (from the pumps library) at AN25.
DspSym(25,"Pumps.Centrifuge");
! Display the centrifuge symbol (from the global library) at AN26.
DspSym(26,"Centrifuge");
See Also
Display Functions
DspSymAnm
Animates a series of symbols at an AN. Sym1 displays first, then Sym2, Sym3 . . . Sym8 and
then Sym1 displays again, etc. When the next symbol in the sequence is displayed, the cur-
rent symbol is not erased, but is overwritten to provide a smoother animation. The symbols
should all be the same size.
The frequency of changing the symbols is determined by the [Page]AnmDelay parameter.
You only need to call this function once to keep the animation going. To stop the animation
call the DspDel() function, or call this function again with different symbols (to change the
animation).
Syntax
DspSymAnm(AN, Sym1 [, Sym2 ... Sym8] [, iDisplayMode] [, sSym9] )
AN:
The AN where the animation will occur.
Sym1:
The name of the first symbol to animate in the format <[LibName.]SymName>. If
you do not specify the library name, a symbol from the Global library will display
(if it exists). Sym1 must be specified.
Sym2..Sym8:
The names of the symbols to animate in frames 2 to 8 in the format <[Lib-
Name.]SymName>. If you do not specify the library name, a symbol from the
Global library will display (if it exists).
iDisplayMode:
342
Not used. Always set to -1, which means Soft animation. The background screen
(a rectangular region beneath the symbol) is restored with the original image.
Any objects that are within the rectangular region are destroyed when the back-
ground is restored. Use this mode when each animation symbol is a different size.
Sym9:
Not all symbols have to be specified. If for example, only two symbols are to dis-
play, specify Sym1 and Sym2.
Return Value
Related Functions
DspSym
Example
DspSymAnm(25,"Pumps.Centrifuge","Pumps.Floatation");
! Alternately displays the centrifuge symbol and the flotation symbol(from the pumps
library) at AN25.
See Also
Display Functions
DspSymAnmEx
Animates a series of symbols at an AN. Sym1 displays first, then Sym2, Sym3 . . . Sym9 and
then Sym1 displays again, etc. When the next symbol in the sequence is displayed, the cur-
rent symbol is not erased, but is overwritten to provide a smoother animation. The symbols
should all be the same size.
The frequency of changing the symbols is determined by the [Page]AnmDelay parameter.
You only need to call this function once to keep the animation going. To stop the animation
call this function again with a different Mode.
Syntax
DspSymAnmEx(AN, Mode, Sym1 [, Sym2 ... Sym9] )
AN:
The AN where the animation will occur.
Mode:
Not used. Always set to -1, which means Soft animation. The background screen
(a rectangular region beneath the symbol) is restored with the original image.
Any objects that are within the rectangular region are destroyed when the back-
ground is restored. Use this mode when each animation symbol is a different size.
Sym1:
The name of the first symbol to animate in the format <[LibName.]SymName>. If
you do not specify the library name, a symbol from the Global library will display
(if it exists). Sym1 must be specified.
343
Sym2..Sym9:
The names of the symbols to animate in frames 2 to 9 in the format <[Lib-
Name.]SymName>. If you do not specify the library name, a symbol from the
Global library will display (if it exists).
Not all symbols have to be specified. If for example, only two symbols are to dis-
play, specify Sym1 and Sym2.
Return Value
Related Functions
DspSym
Example
DspSymAnmEx(25,-1,"Pumps.Centrifuge","Pumps.Floatation");
! Alternately displays the centrifuge symbol and the flotation symbol(from the pumps
library) at AN25.
See Also
Display Functions
DspSymAtSize
Displays a symbol at the specified scale and offset from the AN position.
By calling this function continuously, you can move symbols around the screen and change
their size and shape, to simulate trippers, elevators, and so on. You change the PositionX,
PositionY values to change the position of the symbol, the SizeX, SizeY values to change its
size, or the symbol itself to change its shape.
You can only use this function at a blank AN, or an AN with a symbol defined without sym-
bols configured. The AN must not be attached to any other animation object.
later releases.
Syntax
DspSymAtSize(AN, sSym, PositionX, PositionY, SizeX, SizeY, Mode)
AN:
The AN where the symbol will be animated.
sSym:
The name of the symbol to display, move, or size. If sSym is 0 (zero), any existing
symbol at the AN is erased.
PositionX:
The horizontal offset position (from the AN) of the symbol (in pixels).
PositionY:
The vertical offset position (from the AN) of the symbol (in pixels).
SizeX, SizeY:
344
The horizontal and vertical scaling factors for the symbol (0 - 32000). For example,
if PositionX and PositionY are both 32000, the symbol is displayed at its normal
size. Please be aware that symbols can only be reduced in size.
Mode:
The mode of the display:
-1 - Soft animation. The background screen (a rectangular region beneath the
symbol) is restored with the original image. Any objects that are within the
rectangular region are destroyed when the background is restored. Use
this mode when each animation symbol is a different size.
0 - Overlap animation. The background screen (beneath the symbol) is not erased
- the next symbol is displayed on top. Transparent color is supported in
this mode, allowing for symbol overlap. For this mode to display correctly,
each symbol must be the same size.
1 - Animate animation. The background screen (beneath the symbol) is not
erased - the next symbol is displayed on top. This mode provides the fast-
est animation. For this mode to display correctly, each symbol must be the
same size. Transparent color is not supported in this mode.
8 - Stops animation at last symbol displayed. Use this mode where you want to
freeze your animation at the end of the sequence.
16 - Stops animation at current symbol displayed. Use this mode where you
want to freeze your animation instantly.
Return Value
Related Functions
DspAnMove, DspAnMoveRel, DspSym
Example
! Display tripper moving in x axis at normal size.
DspSymAtSize(21, "lib.tripper", x, 0, 32000, 32000, 0);
! Display elevator going up and down.
DspSymAtSize(22, "lib.elevator", 0, y, 32000, 32000, 0);
! Display can getting bigger and smaller.
DspSymAtSize(23, "lib.can", 0, 0, size, size, 0);
See Also
Display Functions
DspText
Displays text at an AN. This function does the same operation as DspStr(), however it uses
a font number rather than a font name.
later releases.
345
Syntax
DspText(AN, Font, Text)
AN:
The AN where the text will be displayed.
Font:
The font number that is used to display the text. (To use the default font, set to -1.)
Text:
The text to display.
Return Value
Related Functions
DspStr, DspFont, DspFontHnd
Example
/* Displays "Display this text" at AN25 using the font defined as
BigFont. */
hBigFont=DspFontHnd("BigFont");
DspText(25,hBigFont,"Display this text");
See Also
Display Functions
DspTipMode
Switches the display of tool tips on or off. This function overrides the setting in the
[Page]TipHelp parameter.
Syntax
DspTipMode(nMode)
nMode:
The display mode:
0 - Off
1 - On
2 - Toggle the tool tip mode
3 - Do not change the mode, just return the current value
Return Value
The old mode.
Related Functions
DspSetTip, DspGetTip
346
Example
DspTipMode(1); //Switch on tool tips
See Also
Display Functions
DspTrend
Displays a trend at an AN. Values are plotted on the trend pens. You must specify Value1,
but Value2 to Value8 are optional. If more values (than configured pens) are specified, the
additional values are ignored. If fewer values (than configured pens) are specified, the pens
that have no values are not displayed.
DspTrend() is optimized so that it will not display the trend until a full set of samples has
been collected. For example, if you have defined 100 samples for your trend, the trend will
not display until value 100 is entered.
You should use this function only if you want to control the display of trends directly. If
you use the standard Trends (defined in the Trends database) this function is called auto-
matically.
Syntax
DspTrend(AN,Trend,Value1 [,Value2 ... Value8] )
AN:
The AN where the trend will be displayed.
Trend:
The name of the trend to display in the format <[LibName.]TrnName>. If you do
not specify the library name, a trend from the Global library will display (if it ex-
ists).
To display a Version 1.xx trend, specify the trend number (0 to 255). For example,
if you specify trend 1, CitectSCADA displays the trend Global.Trn001.
Value1:
The value to display on Pen 1 of the trend.
Value2...8:
The values to display on Pen 2...Pen 8 of the trend (optional).
Return Value
Related Functions
DspDel
Example
/* Using the main_loop trend (from the trends library) at AN25,
display a value of 10 on Pen1, 20 on Pen2, 30 on Pen3 and 40 on
Pen4 of the trend. */
DspTrend(25,"Trends.Main_Loop",10,20,30,40);
347
/* Using trend definition 5 (CitectSCADA Version 1.xx)

at AN25, display a value of 10 on Pen1, 20 on Pen2, 30 on Pen3 and
40 on Pen4 of the trend. */
DspTrend(25,5,10,20,30,40);
/* Using the loops trend (from the global library) at AN26,
display a value of 100 on Pen1 and 500 on Pen2 of the trend. */
DspTrend(26,"Loops",100,500);
/* Display a trend configured with 100 samples immediately. The
data for the first 100 samples is stored in an array -
MyData[100]. On first display, grab all the data and call
DspTrend().*/
FOR i = 0 to 100 DO
DspTrend(AN, "Loops", MyData[i]);
END
// display new samples every 300ms
WHILE TRUE DO
// Shift MyData down and grab new sample
TableShift(MyData, 100, 1);
MyData[99] = MyFastData;
DspTrend(AN, "Loops", MyData[99]);
SleepMS(300);
END
/* Display a trend configured with 100 samples immediately. Dummy
data is pushed into the first 100 samples to fill the trend. Once
these values are entered, the trend will be updated each time a
new sample value is entered.*/
// fill up the trend.
FOR i = 0 to 100 DO
DspTrend(AN, "Loops", 0);
END
// display new samples every 300ms
WHILE TRUE DO
DspTrend(AN, "Loops", MyFastData);
SleepMS(300);
END
See Also
Display Functions
DspTrendInfo
Get information on a trend definition.
Syntax
DspTrendInfo( hTrend, Type, AN)
hTrend:
The name of the trend in the format <[LibName.]TrnName>. If you do not specify
the library name, a trend from the Global library is assumed.
To get information on a Version 1.xx trend, specify the trend number (0 to 255).
For example, if you specify trend 1, CitectSCADA obtains information from the
trend Global.Trn001.
Type:
Type of trend info:
0 - Type of trend:
348
 0 = line
 1 = bar
1 - Number of samples in trend
2 - Height of trend (in pixels)
3 - Width of trend sample (in pixels)
4 - Number of trend pens
11 - Color of pen 1. If the pen uses flashing color, the initial color used. (Use type
19 to determine the secondary flashing color for pen 1.)
19 - The secondary color used for pen 1, if flashing color is used.
AN:
The AN where the trend is displayed.
Return Value
The trend information (as an integer). If Pen Color (Types 11 - 18) is requested from a bar
trend, the return value is -1.
Related Functions
DspTrend
Example
! get the number of samples for the main_loop trend (from the
trends library).
nSamples = DspTrendInfo("Trends.Main_Loop", 1);
! get the number of samples for trend 3 (CitectSCADA
349
Version 1.xx).
nSamples = DspTrendInfo(3, 1);
See Also
Display Functions
350
Chapter: 26 DLL Functions
The DLL (Dynamic Link Library) functions allow you to call any DLL, including the Win-
dows standard functions, any third-party library, or your own library.
With the DLL functions, you can write functions in ’C’, Pascal, or any other language that
supports DLLs, and then call those functions from CitectSCADA.
DLL Functions
Following are functions relating to DLLs:
DLLCall Calls a DLL function.
DLLCallEx Calls a DLL function, and passes the specified arguments to that function.
DLLClose Closes a link to a DLL function.
DLLOpen Opens a link to a DLL function.
See Also
Functions Reference
DLLCall
Calls a DLL function, and passes a string of arguments to that function. CitectSCADA con-
verts these arguments (where required) into the type specified in the DLLOpen() call. If an
argument cannot be converted, it is set to zero (0) or an empty string "".
You must first open the DLL with the DLLOpen() function.
Only one call to the DLLCall() function can be made at a time, which means runtime will
wait for the called function to return before doing anything else. If the called function takes
too long to return, it won’t let other tasks execute. Therefore, care must be taken so that one
call returns before the next is made.
Good programming practice requires that functions which are not expected to complete in
a short time are run as separate Windows threads and return a value immediately to Cit-
ectSCADA.
Syntax
DLLCall(hFunction, sArgs)
hFunction:
The DLL function handle, returned from DLLOpen().
sArgs:
The string of arguments to pass to the DLL function. The argument string con-
tains all the arguments for the function, separated by commas (,). Enclose string
arguments in quote marks "", and use the string escape character (^) to put a
string delimiter within a string. This syntax is the same as the syntax for the
TaskNew() function
351
Return Value
The result of the function, as a string.
Related Functions
DLLOpen, DLLClose
Example
See DLLOpen
See Also
DLL Functions
DLLCallEx
Calls a DLL function, and passes the specified arguments to that function.
You must first open the DLL with the DLLOpen function.
Only one call to the DLLCallEx() function can be made at a time, which means runtime will
wait for the called function to return before doing anything else. If the called function takes
too long to return, it won’t let other tasks execute. Therefore, care must be taken so that one
call returns before the next is made.
Good programming practice requires that functions which are not expected to complete in
a short time are run as separate Windows threads and return a value immediately to Cit-
ectSCADA.
Syntax
DLLCallEx(hFunction,vParameters)
hFunction:
vParameters:
A variable length parameter list of method arguments. The parameters will be
passed to the function in the order that you enter them. Specifying too few or too
many parameters will generate an Invalid Argument hardware error. An Invalid
Argument hardware error will also be generated if you specify a parameter to the
DLL function with the wrong type.
Return Value
The result of the function. If the DLL function returns a string then your Cicode return vari-
able should be of type STRING. All other types will be INT.
Related Functions
DLLOpen, DLLClose
Example
/* This function is called when CitectSCADA starts up,
to initialize all the DLLs that are called */
INT hAnsiUpper;
INT hGlobalAlloc;
352
FUNCTION InitMyDLLs()
! Open DLL to AnsiUpper
hAnsiUpper = DLLOpen("USER.DLL", "AnsiUpper", "CC");
hGlobalAlloc = DLLOpen("Kernel", "GlobalAlloc", "IIJ");
END
/* This is the Cicode entry point into the DLL function call. This
function hides the DLL interface from the rest of CitectSCADA. *
STRING
FUNCTION AnsiUpper(STRING sString)
STRING sResult;
sResult = DLLCallEx(hAnsiUpper, sString);
RETURN sResult;
END
/* Allocate memory and return memory handle */
INT
FUNCTION GlobalAlloc(INT Mode, INT Length)
INT hMem;
hMem = DLLCallEx(hGlobalAlloc, Mode, Length);
RETURN hMem;
END
See Also
DLL Functions
DLLClose
Closes the link to a DLL function, and frees the memory allocated for that function link.
When the link is closed, you cannot call the function. CitectSCADA automatically closes all
function links at shutdown.
Syntax
DLLClose(hFunction)
hFunction:
Return Value
Related Functions
DLLOpen, DLLCall
Example
See DLLOpen
See Also
DLL Functions
DLLOpen
Opens a link to a DLL function, by loading the specified DLL library into memory and at-
taching it to the named function. After you open the function link, you can call the function
353
with the DLLCall() function. You pass the function number returned from the DLLOpen()
function as an argument in the DLLCall() function.
One accepted method for interfacing with a DLL function is to write a Cicode function file.
This file contains the DLLOpen() function to initialize the functions, and one Cicode func-
tion for each DLL function, as an interface. In this way, you can hide the DLL interface in
this file. Any other Cicode function will call the Cicode interface, and the call to the DLL
remains transparent.
Please be aware that DLLs must be on the path. The file extension is not required.
Note: You must specify the arguments to the function correctly. CitectSCADA has no way
of checking the number and type of arguments to the function. If you specify the number
of arguments incorrectly, your computer will crash. You should test your interface thor-
oughly before using it on a live system.
Syntax
DLLOpen(sLib, sName, sArgs)
sLib:
The DLL library name.
sName:
The function name. An underscore (_) is required in the function name for a ’C’
function, but not for a Pascal function. When you call a DLL from a Cicode func-
tion, sName must be the same as the name defined in the .DEF file used to link
the DLL. The file extension is not required.
sArgs:
The string specifying the function arguments. The first character in the string is
the return value of the function.
A - Logical.
B - IEEE 8 byte floating point number.
C - Null terminated string. Maximum string length 255 characters.
D - Byte counted string. First byte contains the length of the string, maximum
string length 255 characters.
H - Unsigned 2 byte integer.
I - Signed 2 byte integer.
J - Signed 4 byte integer.
Return Value
The DLL function handle, or -1 if the library or function could not be found or loaded.
Related Functions
DLLCall, DLLClose
Example
/* This function is called when CitectSCADA starts up,
to initialize all the DLLs that are called */
INT hAnsiUpper;
INT hGlobalAlloc;
354
FUNCTION InitMyDLLs()
! Open DLL to AnsiUpper
hAnsiUpper = DLLOpen("USER.DLL", "AnsiUpper", "CC");
hGlobalAlloc = DLLOpen("Kernel", "GlobalAlloc", "IIJ");
END
/* This is the Cicode entry point into the DLL function call. This
function hides the DLL interface from the rest of CitectSCADA. */
STRING
FUNCTION AnsiUpper(STRING sString)
STRING sResult;
sResult = DLLCall(hAnsiUpper, "^"" + sString + "^"");
RETURN sResult;
END
/* Allocate memory and return memory handle */
INT
FUNCTION GlobalAlloc(INT Mode, INT Length)
STRING sResult;
INT hMem;
sResult = DLLCall(hGlobalAlloc, Mode : #### + "," + Length : ####);
hMem = StrToInt(sResult);
RETURN hMem;
END
See Also
DLL Functions
355
356
Chapter: 27 Error Functions
The error functions trap and process errors. You can use these functions to check the status
of any other function.
Error Functions
Following are functions relating to errors:
ErrCom Gets the communication status for the current Cicode task.
ErrDrv Gets a protocol-specific error message.
ErrGetHw Gets a hardware error code.
ErrHelp Displays help information about a hardware error.
ErrInfo Gets error information.
ErrLog Logs a system error.
ErrMsg Gets the error message associated with a hardware error.
ErrSet Sets the error mode.
ErrSetHw Sets a hardware error.
ErrSetLevel Sets the error level.
ErrTrap Generates an error trap.
IsError Checks for an error.
See Also
Functions Reference
ErrCom
Gets the communication status for the current Cicode task. You can call this function in re-
ports, Cicode that is associated with an object, and in any Cicode task.
Syntax
ErrCom()
Return Value
0 (zero) if all I/O device data associated with the task is valid, otherwise an error is returned.
Related Functions
CodeSetMode
Example
IF ErrCom()<>0 THEN
Prompt("I/O device data is bad");
END
In a report format:
357
{CICODE}
IF ErrCom()<>0 THEN
PrintLn("This Report contains bad data");
END
{END}
See Also
Error Functions
ErrDrv
Gets a protocol-specific error message and native error code.
Syntax
ErrDrv(sProtocol, sField, nError)
sProtocol:
The CitectSCADA protocol.
sField:
The field in the PROTERR.DBF database:
 PROTOCOL
 MASK
 ERROR
 MESSAGE
 REFERENCE
 ACTION
 COMMENT
nError:
The protocol specific error code. This field must be a variable as it also the place
where the returned error code is stored.
Since the first 34 specific error codes are standard for all protocols, CitectSCADA
may add ’masking’ to make the error code unique. For example, if an I/O device
returns errors 1 to 10 (which are already used), the driver may add 0x100000 to
its error codes. When this function is called, the mask will be removed before the
result is returned to this variable.
Return Value
The error message (as a string), or an empty string ("") if the error is not found. The error
code is returned into the nError variable.
Related Functions
ErrInfo, ErrHelp
Example
// Get the error message and number associated with error 108
nError = 108;
sError = ErrDrv("TIWAY", "MESSAGE", nError);
358
See Also
Error Functions
ErrGetHw
Gets the current hardware error status for an I/O device.
I/O devices can be grouped into 2 distinct categories: Those that are created by the system
engineer, and those that are created by CitectSCADA itself.
I/O devices that are created by the system engineer include any I/O device listed in the Ci-
tectSCADA I/O devices database, and any device visible as a record in the I/O Device form
in the Project Editor.
I/O devices that are created by CitectSCADA include Generic, LAN, Cicode, Animation,
Reports Server, Alarms Server, Trends Server, and I/O Server, and are those specifically not
created by the system engineer.
The argument’s values you supply in this function are used by CitectSCADA to determine
which type of device hardware alarm you want to work with.
Note: Do not use this function if you have more than 511 I/O devices in your project and
the flag [Code]BackwardCompatibleErrHw is set to 1. You may retrieve the hardware error
status for the wrong I/O device.
Syntax
ErrGetHw(Device, DeviceType)
Device:
For I/O devices that are created by the system engineer, select the IODevNo as
the argument value.
To determine the IODevNo of a physical I/O device in your project, use the I/O
device record number from the I/O Device form in the Citect Project Editor. When
using an IODevNo, the DeviceType argument must be set to 2.
For I/O devices that are created by CitectSCADA itself, select one of the following
options as the argument value:
 Generic
 LAN
 Cicode
 Animation
 Reports Server
 Alarms Server
 Trends Server
 I/O Server
DeviceType:
Select a value from the following options to indicate the ’Type of Device’ used in
the Device argument:
0 - for I/O devices that are created by CitectSCADA itself (Generic, LAN, Cicode,
Animation, etc).
2 - for I/O devices that are created by the system engineer.
The DeviceType argument was added to this function in CitectSCADA V5.40
and later. Earlier versions of CitectSCADA did not pass a value for the Device-
359
Type argument (as it did not exist). CitectSCADA versions prior to V5.40 identi-
fied an I/O device by passing the IODevNo (masked with the value of 8192) to the
function as the Device argument, in the structure:
IODevNo + 8192
This was for versions of CitectSCADA permitting a maximum limit of 4095 I/O
devices.
Versions of CitectSCADA prior to V5.20 masked the IODevNo with a value of
512. The backward compatibility flag for using this mask must be set in the Cit-
ect.INI file (see code parameter BackwardCompatibleErrHw.).
Return Value
The detected error.
Related Functions
ErrHelp, ErrInfo, ErrMsg, ErrSetHw
Example
Error=ErrGetHw(3,0);
! Sets Error to the current error status for the animation device.
IF Error=0 THEN
DspText(4,0,"");
ELSE
DspText(4,0,"Hardware error");
END
See Also
Error Functions
ErrHelp
Displays information about a hardware error.
Syntax
ErrHelp(Error)
Error:
The Cicode hardware error string (as returned by ErrMsg()).
Return Value
0 (zero) if successful, otherwise an error (274) is returned.
Related Functions
ErrInfo, IsError, ErrMsg
360
Example
! Invokes the CitectSCADA Help with help on the
hardware alarm.
iResult = ErrHelp(ErrMsg(IsError()));
See Also
Error Functions
ErrInfo
Gets extended error information on the last error that was detected.
Syntax
ErrInfo(Type)
Type:
The type of error information. If type is 0 (zero), function returns the animation
number where the error occurred.
Return Value
The error information.
Example
! Get the animation number where the last error occurred
AN = ErrInfo(0);
See Also
Error Functions
ErrLog
Logs a message to the CitectSCADA system log file.
This function is useful for logging errors in user functions, and for debugging user func-
tions. The CitectSCADA system log file ’SYSLOG.DAT’ is created in the local Windows di-
rectory of the computer, eg C:\WINDOWS.
Syntax
ErrLog(Message)
Message:
The message to log. This field can also contain control (such as /n) and formatting
characters.
Return Value
361
Related Functions
DebugMsg, DebugMsgSet, CodeTrace, TraceMsg, Halt
Example
FUNCTION MyFunc(INT Arg)
IF Arg<0 THEN
ErrLog("Invalid arg in Myfunc");
Halt();
END
END
See Also
Error Functions
ErrMsg
Gets the error message associated with a detected hardware error.
Syntax
ErrMsg(nError)
nError:
The hardware error number returned from the IsError() function.
Return Value
The error message (as a string). A null value is returned if nError is not in the range of
Cicode errors.
Related Functions
IsError, ErrHelp, ErrInfo, ErrTrap
Example
//Get the message of the last hardware error
sMsg = ErrMsg(IsError());
See Also
Error Functions
ErrSet
Sets the error-checking mode. When Mode is set to 0 and an error occurs that causes a com-
ponent to stop executing, CitectSCADA halts the execution of the Cicode task that caused
the error, and generates a hardware error.
You can perform error checking by setting Mode to 1 and using the IsError() function to trap
errors. When the type of error is determined, you can control what happens under partic-
ular error conditions.
362
The operation of the ErrSet() function is unique to each Cicode task. If you enable user error
checking for one task, it does not enable error checking for any other tasks.
Note: This has changed from previous versions of CitectSCADA where this feature used to
affect all Cicode tasks.
Syntax
ErrSet(Mode)
Mode:
Error-checking mode:
0 - default - CitectSCADA will check for errors.
1 - The user must check for errors.
Return Value
Related Functions
IsError, ErrSetHw, ErrSetLevel
Example
ErrSet(1);
Test=Var/0;
Error=IsError();
! Sets Error to 273 (divide by zero).
See Also
Error Functions
ErrSetHw
Sets the hardware error status for a hardware device. Call this function to generate a hard-
ware error.
I/O devices can be grouped into two distinct categories: those created by the system engi-
neer, and those created by CitectSCADA itself.
I/O devices that are created by the system engineer, are any I/O device listed in the Cit-
ectSCADA I/O devices database, visible as records in the I/O Device form in the Project Ed-
itor.
I/O devices that are created by CitectSCADA, including Generic, LAN, Cicode, Animation,
Reports Server, Alarms Server, Trends Server, and I/O Server (are those specifically not cre-
ated by the system engineer).
The arguments values you supply in this function are used by CitectSCADA to determine
the type of device hardware alarm you want to work with.
Note: To use this function, you must set [Code]BackwardCompatibleErrHw to 1. You can-
not use this function if you have more than 511 I/O devices in your project.
363
Syntax
ErrSetHw(Device, Error, DeviceType)
Device:
For I/O devices that are created by the system engineer, select the IODevNo as
the argument value.
To determine the IODevNo of a physical I/O device in your project, use the I/O
device record number from the I/O Device form in the Citect Project Editor. When
using an IODevNo, the DeviceType argument must be set to 2.
For I/O devices that are created by CitectSCADA itself, select one of the following
options as the argument value:
0 - Generic
1 - LAN
2 - Cicode
3 - Animation
4 - Reports Server
5 - Alarms Server
6 - Trends Server
7 - I/O Server
Error:
The error code.
DeviceType:
Select a value from the following options to indicate the ’Type of Device’ used in
the Device argument:
0 - For I/O devices that are created by CitectSCADA itself (Generic, LAN, Cicode,
Animation, etc).
2 - For I/O devices that are created by the system engineer.
The DeviceType argument was added to this function in CitectSCADA V5.40
and later. Earlier versions of CitectSCADA did not pass a value for the Device-
Type argument (as it did not exist). CitectSCADA versions prior to V5.40 identi-
fied an I/O device by passing the IODevNo (masked with the value of 8192) to the
function as the Device argument, in the structure:
IODevNo + 8192
This was for versions of CitectSCADA that permitted a maximum limit of 4095 I/
O devices.
Versions of CitectSCADA prior to V5.20 masked the IODevNo with a value of
512. The backward compatibility flag for using this mask must be set in the Cit-
ect.INI file (see code parameter BackwardCompatibleErrHw).
Return Value
Related Functions
ErrHelp ErrMsg ErrSet ErrSetHw
364
Example
ErrSetHw(4,273,0);
! Generates a divide by zero error (273) on the report device.
ErrSetHw(3,0,0)
! Resets any error on the animation device.
See Also
Error Functions
ErrSetLevel
Sets the nesting error level to enable CitectSCADA error checking inside a nested function
(when CitectSCADA error checking has been disabled). This function returns the old error
level and sets a new error level.
The nesting error level is incremented every time the ErrSet(1) function is called.
Syntax
ErrSetLevel(Level)
Level:
The nesting error level.
Return Value
Related Functions
ErrSet
Example
! ErrorLevel 0 defaults to ErrSet(0) - enables CitectSCADA error-checking.
FUNCTION MainFn()
ErrSet(1);
! ErrorLevel 1 - disables CitectSCADA error checking.
Fn1();
ErrSet(0);
! Enables CitectSCADA error checking.
END
FUNCTION Fn1()
ErrSet(1);
! ErrorLevel 2 - disables CitectSCADA error checking.
Test=Var/0;
Error=IsError();
! Sets Error to 273 (divide by zero).
Fn2();
ErrSet(0);
! Enables CitectSCADA error checking.
END
FUNCTION Fn2()
OldErrorLevel=ErrSetLevel(0);
! Sets nesting error level to 0 to enable CitectSCADA error-checking.
Test=Var/0;
! Cicode halts and a hardware alarm is generated.
365
ErrSetLevel(OldErrorLevel)
! Resets nesting error level to disable CitectSCADA error-checking.
END
See Also
Error Functions
ErrTrap
Generates an error trap. If CitectSCADA error checking is enabled, this function will gen-
erate a hardware error and may halt Cicode execution (see bHalt argument). If user error
checking is enabled, the user function specified in OnEvent(2,Fn) is called.
Syntax
ErrTrap(Error, bHalt)
Error:
The error number to trap.
bHalt:
Determines whether the Cicode execution will be halted.
0 - Cicode execution is not halted
1 - Cicode execution is halted
Return Value
ErrSetHw, ErrSet, ErrSetLevel, OnEvent
Example
IF Tag=0 THEN
ErrTrap(273); ! Traps a divide by zero error.
ELSE
Value=10/Tag;
END
See Also
Error Functions
IsError
Gets the current error value. The error value is set when any error is detected, and is reset
after this function is called. You can call this function if user error-checking is enabled or
disabled.
You should call this function as soon as possible after the operation to be checked, because
the error code could be changed by the next error.
Syntax
IsError()
366
Return Value
The current error value. The current error is reset to 0 after this function is called.
Related Functions
ErrSet
Example
! Enable user error-checking.
ErrSet(1);
! Invalid ArcSine.
Ac=ArcSin(20.0);
! Sets ErrorVariable to 274 (invalid argument passed).
ErrorVariable=IsError()
See Also
Error Functions
367
368
Chapter: 28 Event Functions
The event functions trap and process asynchronous events.
Event Functions
Following are functions used to trap and process asynchronous events:
CallEvent Calls the event function for an event type.
ChainEvent Calls an event function, by function number.
GetEvent Gets the function number of the current callback event.
OnEvent Sets an event callback function, by event type.
SetEvent Sets an event callback function, by function number.
See Also
Functions Reference
CallEvent
Simulates an event, triggering any OnEvent() function that has the same Type argument
specified.
CitectSCADA starts running the function immediately, without reading any data from the
I/O devices. Any I/O device variable that you use will contain either 0 (zero) or the last val-
ue read.
Syntax
CallEvent(Window, Type)
Window:
The number of the window, returned from the WinNew(), WinNewAt(), or Win-
Number() function.
Type:
The type of event:
0 - The mouse has moved. When the mouse moves the callback function is called.
The return value must be 0.
1 - A key has been pressed. When the user presses a key, the callback function is
called after CitectSCADA checks for hot keys. If the return value is 0, Cit-
ectSCADA checks for key sequences. If the return value is not 0, Cit-
ectSCADA assumes that you will process the key and does not check the
key sequence. It is up to you to remove the key from the key command line.
If you are using a right mouse button click as an event, you should read about the
ButtonOnlyLeftClick parameter.
2 - Error event. This event is called if an error is detected in Cicode, so you can
write a single error function to check for your errors. If the return value is
0, CitectSCADA continues to process the error and generates a hardware
error - it may then halt the Cicode task. If the return value is not 0, Cit-
369
ectSCADA assumes that you will process the error, and continues the
Cicode without generating a hardware error.
3 - Page user communication error. A communication error has been detected in
the data required for this page. If the return value is 0 (zero), CitectSCADA
still animates the page. If the return value is not zero, it does not update the
page.
4 - Page user open. A new page is being opened. This event allows you to define
a single function that is called when all pages are opened. The return value
must be 0.
5 - Page user close. The current page is being closed. This event allows you to de-
fine a single function that is called when all pages are closed. The return
value must be 0.
6 - Page user always. The page is active. This event allows you to define a single
function that is called when all pages are active. The return value must be
0.
7 - Page communication error. A communication error has been detected in the
data required for this page. Reserved for use by CitectSCADA.
8 - Page open. This event is called each time a page is opened. Reserved for use
by CitectSCADA.
9 - Page close. This event is called each time a page is closed. Reserved for use by
CitectSCADA.
10 - Page always. This event is called while a page is active. Reserved for use by
CitectSCADA.
11..17 - Undefined.
18 - Report start. The report server is about to start a new report. This event is
called on the report server. The return value must be 0.
19 - Device history. A device history has just completed. The return value must
be 0.
20 - Login. A user has just logged in.
21 - Logout. A user has just logged out.
22 - Trend needs repainting. This event is called each time CitectSCADA re-ani-
mates a real-time trend or scrolls an historical trend. You should use this
event to add additional animation to a trend, because CitectSCADA de-
letes all existing animation when a trend is re-drawn. (For example, if you
want to display extra markers, you must use this event.)
23 - Hardware error detected.
24 - Keyboard cursor moved. This event is called each time the keyboard com-
mand cursor moves. The cursor can be moved by the cursor keys, the
mouse, or the Cicode function KeySetCursor(). Please be aware that you
can find where the keyboard command cursor is located by calling the
function KeyGetCursor().
25 - Network shutdown. A Shutdown network command has been issued.
26 - Runtime system shutdown and restart. (Required because of configuration
changes.)
27 - Event. An event has occurred.
28 - Accumulator. An accumulator has logged a value.
370
29 - Slider. A slider has been selected.

30 - Slider. A slider has moved.
31 - Slider. A slider has been released (that is stopped moving).
While responding to slider events 29, 30, and 31, you can set any variables but
you cannot call functions that cause immediate changes to animations on
the page (for example, DspText() and DspSym()).
Types 29, 30, & 31 relate only to V3.xx and V4.xx animations, and will be super-
seded in future releases.
32 - Shutdown. CitectSCADA is being shutdown.
33 - Time changed. The Windows system time has been changed.
34... 127 - Reserved for future CitectSCADA use.
128... 256 - User defined events. These events are for your own use.
Return Value
0 (zero) if successful, otherwise an error is set. To view the error, use the IsError() function.
Related Functions
OnEvent, GetEvent, WinNew, WinNewAt, WinNumber, IsError
Example
! Call Event Type 1 - key has been pressed in the current window.
Number=WinNumber();
CallEvent(Number,1);
See Also
Event Functions
ChainEvent
Calls an event function using the function handle. This creates a chain of event handlers
from a single event. Use the GetEvent() function to get the function number of the current
event handler.
Syntax
ChainEvent(hFn)
hFn:
The function handle, as returned from the GetEvent() function.
Return Value
The return value of the called event function.
Related Functions
OnEvent, GetEvent
371
Example
See GetEvent
See Also
Event Functions
GetEvent
Gets the function handle of the existing callback event handler. You can use this function
handle in the ChainEvent() function to chain call the existing event function, or in the Set-
Event() function to restore the event handler.
Syntax
GetEvent(Type)
Type:
The type of event:
page.
must be 0.
value must be 0.
0.
by CitectSCADA.
372
CitectSCADA.
CitectSCADA.
11 - 17 Undefined.
be 0.
23 - Hardware error detected.
mouse, or the Cicode function KeySetCursor(). Note that you can find
where the keyboard command cursor is located by calling the function
KeyGetCursor().
changes.)
the page (for example, DspText() and DspSym()).
Types 29, 30, & 31 relate only to V3.xx and V4.xx animations, and will be super-
seded in future releases.
33 - 127 - Reserved for future CitectSCADA use.
128 - 256 - User defined events. These events are for your own use.
Return Value
The function handle of the existing callback event handler, or -1 if there are no event han-
dlers.
Related Functions
OnEvent, CallEvent, ChainEvent, SetEvent
373
Example
! Get existing event handler.
hFn=GetEvent(0);
! Trap mouse movements.
OnEvent(0,MouseFn);
..
! Restore old event handler.
SetEvent(0,hFn);
INT
FUNCTION MouseFn()
..
! Chain call old event handler.
RETURN ChainEvent(hFn);
END
See Also
Event Functions
OnEvent
Sets an event callback function for an event type. The callback function is called when the
event occurs.
Using callback functions saves polling or checking for events. Callback functions have no
arguments and must return an integer.
CitectSCADA starts running the function immediately, without reading any data from the
I/O devices. Any I/O device variable that you use will contain either 0 (zero) or the last val-
ue read. The return value of the callback will depend on the type of the event. Set the Fn
argument to 0 (zero) to disable the event.
Syntax
OnEvent(Type, Fn)
Type:
The type of event:
374

page.
must be 0.
value must be 0.
0.
by CitectSCADA.
CitectSCADA.
CitectSCADA.
11..17 - Undefined.
be 0.
23 - Hardware error has been detected.
mouse, or the Cicode function KeySetCursor(). Note that you can find
where the keyboard command cursor is located by calling the function
KeyGetCursor().
changes.)
375

the page (for example, DspText() and DspSym()). Types 29, 30, & 31 relate
only to V3.xx and V4.xx animations, and will be superseded in future re-
leases.
33 - 127 - Reserved for future CitectSCADA use.
128 - 256 - User-defined events. These events are for your own use.
Fn:
The function to call when the event occurs. This callback function must have no
arguments, so you specify the function with no parentheses (). The callback func-
tion must return INT as its return data type. You cannot specify a CitectSCADA
built-in function as a callback function.
Set Fn to 0 to disable the event.
Return Value
Related Functions
GetEvent, CallEvent, ChainEvent
Example
OnEvent(1,KeyFn);
! Calls a function named KeyFn().
INT
FUNCTION KeyFn()
INT Key;
Key=KeyPeek(0);
IF Key=27 THEN
Prompt("ESC pressed");
RETURN 1;
ELSE
RETURN 0;
END
END
OnEvent(0,MouseFn);
! Calls a function named MouseFn().
INT
FUNCTION MouseFn()
INT X,Y;
DspGetMouse(X,Y);
RETURN 0;
END
See Also
Event Functions
SetEvent
376
Sets an event callback function by specifying a function handle. You can use this function
with the GetEvent() function to restore an old event handler.
Syntax
SetEvent(Type, hFn)
Type:
The type of event:
page.
must be 0.
value must be 0.
0.
by CitectSCADA.
CitectSCADA.
CitectSCADA.
11..17 - Undefined.
377
be 0.
23 - Hardware error has been detected.
mouse, or the Cicode function KeySetCursor(). Please be aware that you
can find where the keyboard command cursor is located by calling the
function KeyGetCursor().
changes.)
the page (for example, DspText() and DspSym()). Types 29, 30, & 31 relate
only to V3.xx and V4.xx animations, and will be superseded in future re-
leases.
33... 127 - Reserved for future CitectSCADA use.
128... 256 - User-defined events. These events are for your own use.
hFn
The function handle, as returned from the GetEvent() function.
Return Value
Related Functions
GetEvent
Example
See GetEvent.
See Also
Event Functions
378
Chapter: 29 File Functions
The file functions provide access to standard ASCII files. You can open or create files and
then read and write data in free format. Use these functions when you require more com-
plex file operations than are possible with the device functions. For example, importing
and exporting data to and from other programs (that support ASCII files).
You can build complex I/O functionality by combining these functions with the format
functions.
File Functions
Following are functions relating to file operations:
FileClose Closes a file.
FileCopy Copies a file or group of files.
FileDelete Deletes a file.
FileEOF Checks for the end of a file.
FileExist Checks if a file exists.
FileFind Finds a file that matches a specified search criteria.
FileFindClose Closes a find (started with FileFind) that did not run to comple-
tion.
FileGetTime Gets the time on a file.
FileMakePath Creates a file path string from individual components.
FileOpen Opens or creates an ASCII file.
FilePrint Prints a file on a device.
FileRead Reads characters from a file.
FileReadBlock Reads a block of characters from a file.
FileReadLn Reads a line from a file.
FileRename Renames a file.
FileRichTextPrint Prints a rich text file.
FileSeek Seeks a position in a file.
FileSetTime Sets the time on a file.
FileSize Gets the size of a file.
FileSplitPath Splits a file path into individual string components.
FileWrite Writes characters to a file.
FileWriteBlock Writes a block of characters to a file.
FileWriteLn Writes a line to a file.
See Also
Functions Reference
FileClose
Closes a file. All data written to the file is flushed to disk when the file is closed, and the file
number becomes invalid.
379
Syntax
FileClose(File)
File:
The file number.
Return Value
Related Functions
FileOpen
Example
File=FileOpen("C:\Data\Report.Txt","r");
..
! Do file operations.
..
! Close the file.
FileClose(File);
See Also
File Functions
FileCopy
Copies a file. You can use the DOS wild card characters (*) and (?) to copy groups of files.
In asynchronous Mode, this function will return immediately and the copy will continue in
the background. Unless you are accessing to the floppy drive, copying files does not inter-
fere with the operation of other CitectSCADA tasks, because this function is time-sliced.
Syntax
FileCopy(Source, Dest, Mode)
Source:
The name of the source file to copy.
Dest:
The name of destination file to copy to. To copy a file to the printer, specify the
name as "LPT1.DOS".
Mode:
The copy mode:
0 - Normal
1 - Copy only if the file time is different.
2 - Copy in asynchronous mode.
Multiple modes can be selected by adding them together (for example, set Mode to 3 to copy
in asynchronous mode if the file time is different).
380
Return Value
0 (zero) if successful, otherwise an error is returned. However, if you copy in asynchronous
mode, the return value does not reflect whether the copy operation was successful or not,
because the function returns before the actual copy is complete.
Related Functions
FileDelete
Example
! Copy Report.Txt to Report.Bak.
FileCopy ("C:\Data\Report.Txt", "C:\Data\Report.Bak",0);
/* Copy AlarmLog.Txt to AlarmLog.Bak only if the file time is
different. Copy in the background. */
FileCopy ("AlarmLog.Txt", "AlarmLog.Bak",1+2);
See Also
File Functions
FileDelete
Deletes a file.
Syntax
FileDelete(Name)
Name:
The name of the file to delete.
Return Value
Related Functions
FileCopy
Example
! Delete old report file.
FileDelete("C:\Data\Report.Txt");
See Also
File Functions
FileEOF
Determines if the end of the file has been reached.
Syntax
FileEOF(File)
381
File:
The file number.
Return Value
1 if the end of file has been reached, otherwise 0 (zero).
Related Functions
FileSeek
Example
WHILE NOT FileEOF(File) DO
Str=FileReadLn(File);
END
See Also
File Functions
FileExist
Checks if a file exists. If the return value is 1, the file exists.
Syntax
FileExist(Name)
Name:
The name of the file to check.
Return Value
TRUE (1) if the file exists, otherwise FALSE (0).
Related Functions
FileOpen
Example
! Check if the file exists
IF FileExist("C:\Data\Report.Txt") THEN
! The file exists
END
See Also
File Functions
FileFind
Finds a file that matches a specified search criteria. To find a list of files, you must first call
this function with the required path and mode (to find the first file), then call the function
382
again with an empty path and a mode of 0 (to find the remaining files). After the last file is
found, an empty string is returned.
If the search is for multiple files, FileFindClose must be called if the search does not run to
completion (for example, you do not run until an empty string is returned).
Syntax
FileFind(sPath, nMode)
sPath:
The name of the file to check. To search for multiple files, the wildcards * and ?
can be used to match multiple entries.
nMode:
The type of file to check:
0 - Normal files (includes files with read-only and archived attributes)
1 - Read-only files only
2 - Hidden files only
4 - System files only
16 - Subdirectories only
32 - Archived files only
128 - Files with no attributes only
These numbers can be added together to search for multiple types of files during
one search.
Return Value
The full path and filename. If no files are found, an empty string is returned.
Related Functions
FileOpen, FileSplitPath, FileMakePath
Example
! Search for all dBase files in the run directory and make a backup
sPath = FileFind("[run]:\*.dbf", 0);
WHILE StrLength(sPath) > 0 DO
FileSplitPath(sPath, sDrive, sDir, sFile, sExt);
sBak = FileMakePath(sDrive, sDir, sFile, "BAK");
FileCopy(sPath, sBak, 0);
! Find the next file
sPath = FileFind("", 0);
END
See Also
File Functions
FileFindClose
Closes a find (started with FileFind) that did not run to completion.
383
Syntax
FileFindClose()
Return Value
0 if no error is detected, or a Cicode error code if an error occurred.
Related Functions
FileFind
Example
//Find the first dbf file starting with fred
sPath = FileFind("[run]:\fred*.dbf", 0);
IF (StrLength(sPath) > 0) THEN
//Do work here
FileFindClose();
END
See Also
File Functions
FileGetTime
Gets the time on a file.
Syntax
FileGetTime(File)
File:
The file number.
Return Value
The file time of the file (in the CitectSCADA time/date variable format).
Related Functions
FileOpen, FileClose, FileSetTime
Example
File = FileOpen("[data]:report.txt", "r");
! Get the time of the file
iTime = FileGetTime(File);
FileClose(File);
See Also
File Functions
FileMakePath
Creates a file path string from individual components.
384
Syntax
FileMakePath(sDrive, sDir, sFile, sExt)
sDrive:
The disk drive.
sDir:
The directory string.
sFile:
The file name (without the extension).
sExt:
The file extension.
Return Value
The full path as a string.
Related Functions
FileSeek, FileFind, FileSplitPath
Example
See FileFind
See Also
File Functions
FileOpen
Opens a file and returns a file number that can be used by other file functions.
You can also use this function to check if a file exists, by opening the file in read-only mode.
A return value of -1 indicates that the file cannot be opened.
ErrSet(1) needs to be in the previous line of your code, else the execution stops and a hard-
ware error is generated. If ErrSet(1) is used then it doesn’t halt, and -1 is returned.
Syntax
FileOpen(Name, Mode)
Name:
The name of the file to open.
Mode:
The mode of the opened file:
"a" - Append mode. Allows you to append to the file without removing the end
of file marker. The file cannot be read. If the file does not exist, it will be
created.
"a+" - Append and read modes. Allows you to append to the file and read from
it. The end of file marker will be removed before writing and restored
when writing is complete. If the file does not exist, it will be created.
"r" - Read-only mode. Allows you to (only) read from the file. If the file does not
exist or cannot be found, the function call will return the value -1.
385
"r+" - Read/write mode. Allows you to read from, and write to, the file. If the file
already exists (before the function is called), its contents will be deleted. If
the file does not exist or cannot be found, the function call will return the
value -1.
"w" - Write mode. Opens an empty file for writing. If the file already exists (before
the function is called), its contents will be deleted. If the file does not exist
or cannot be found, the file will be created.
"w+" - Read/write mode. Opens an empty file for both reading and writing. If the
file already exists (before the function is called), its contents will be deleted.
If the file does not exist or cannot be found, the file will be created.
Return Value
The file number. If the file cannot be opened, -1 is returned and the code is halted.
Related Functions
FileClose, FileRead, FileReadLn, FileWrite, FileWriteLn
Example
! Open a file in read-only mode.
ErrSet(1);
File=FileOpen("C:\Data\Report.Txt","r");
ErrSet(0);
See Also
File Functions
FilePrint
Prints a file on a device.
Syntax
FilePrint(Devicename, Filename)
Devicename:
The name of the target device.
Filename:
The name of the file to print on the device.
Return Value
Related Functions
FileOpen, FileClose, FileWrite, FileWriteLn
Example
! Print a data file on the system printer.
FilePrint("Printer_Device","Data.txt");
386
See Also
File Functions
FileRead
Reads a number of characters from a file. The string can contain less characters than re-
quested if the end of file is reached. A maximum of 255 characters can be read in each call.
Syntax
FileRead(File, Length)
File:
The file number.
Length:
Return Value
The text from the file (as a string).
Related Functions
FileOpen, FileClose, FileReadLn
Example
WHILE NOT FileEOF(File) DO
Str=FileRead(File,20);
END
See Also
File Functions
FileReadBlock
Reads a number of characters from a file. The buffer can contain less characters than re-
quested if the end of file is reached. A maximum of 255 characters can be read in each call.
The data should be treated as a binary data and should not be passed to string functions.
You may use StrGetChar() function to extract each character from the buffer, or pass the
buffer to another function which will accept binary data.
Syntax
FileReadBlock(File, Buffer, Length)
File:
The file number.
Buffer:
387
The buffer to return the binary data. This may be a string or a string packed with
binary data. The string terminator is ignored and the length argument specifies
the number of characters to write.
Length:
Return Value
The number of characters read from the file. When the end of the file is found 0 will be re-
turned. If an error occurs -1 will be returned and IsError() will return the error code.
Related Functions
FileOpen, FileClose, FileRead, FileWriteBlock, StrGetChar
Example
// read binary file and copy to COM port
length = FileReadBlock(File, buf, 128);
WHILE length > 0 DO
ComWrite(hPort, buf, length, 0);
length = FileReadBlock(File, buf, 128);
END
See Also
File Functions
FileReadLn
Reads a line from a file. Up to 255 characters can be returned. The carriage return and new-
line characters are not returned. If the line is longer than 255 characters, the error overflow
(code 275) is returned - you should call this function again to read the rest of the line.
Syntax
FileReadLn(File)
File:
The file number.
Return Value
The text, as a string.
Related Functions
FileOpen, FileClose, FileRead
Example
sLine = FileReadLn(hFile);
! do stuff with the string
WHILE IsError() = 275 DO
! read the rest of the line
sLine = FileReadLn(hFile);
! do stuff with the rest of the line
388
END
See Also
File Functions
FileRename
Renames a file.
Syntax
FileRename(Oldname, Newname)
Oldname:
The original name of the file.
Newname:
The new name of the file.
Return Value
Related Functions
FileCopy, FileDelete
Example
! Rename REPORT.TXT as REPORT.OLD.
FileRename("C:\Data\Report.Txt","C:\Data\Report.Old");
See Also
File Functions
FileRichTextPrint
Prints the rich text file sFilename to the printer given by sPortname.
Syntax
FileRichTextPrint(sFilename, sPortName)
sFilename:
The filename of the rich text format file. The filename must be entered in quota-
tion marks "".
Remember that the filename for a saved report comes from the File Name field in
the Devices form. The location of the saved file must also be included as part of
the filename. For example, if the filename in the Devices form listed [Data];Rep-
Dev.rtf, then you would need to enter "[Data]\repdev.rtf" as your argument. Al-
ternatively, you can manually enter the path, for example,
389
If you are keeping a number of history files for the report, instead of using the ex-
tension rtf, you must change it to reflect the number of the desired history file, for
example, 001.
PortName:
The name of the printer port to which the rich text file will be printed. This name
must be enclosed within quotation marks "". For example "LPT1", to print to the
local printer, or "\\Pserver\canon1" using UNC to print to a network printer.
Return Values
Related Functions
PageRichTextFile, DspRichTextPrint
Example
// This would print the file [Data]\richtext.rtf to LPT1. Remember
that the [Data] path is specified in the Citect.ini file. The file
richtext.rtf is the name of the output file for the report, as
specified in the Devices form. //
iResult = FileRichTextPrint("[Data]\richtext.rtf","LPT1:");
// This would print the file f:\citect\data\richtext.rtf to LPT1.
The file richtext.rtf is the name of the output file for the
report, as specified in the Devices form. //
iResult =
FileRichTextPrint("f:\citect\data\richtext.rtf","LPT1:");
See Also
File Functions
FileSeek
Moves the file pointer to a specified position in a file.
Syntax
FileSeek(File, Offset)
File:
The file number.
Offset:
The offset in bytes, from 0 to the maximum file size -1.
Return Value
The new file position, or -1 if an error is detected.
Related Functions
FileSize
390
Example
! Seek to the start of the file.
FileSeek(File,0);
See Also
File Functions
FileSetTime
Sets the time on a file.
Note: In order for this function to work, the file must first be opened in write or read/write
mode.
Syntax
FileSetTime(File, iTime)
File:
The file number.
iTime:
The new file time, in the CitectSCADA time/date variable format.
Return Value
Related Functions
FileOpen, FileClose, FileGetTime
Example
File = FileOpen("[data]:report.txt", "r+");
! set the file to the current time
FileSetTime(File,TimeCurrent());
FileClose(File);
See Also
File Functions
FileSize
Gets the size of a file.
Syntax
FileSize(File)
File:
The file number.
391
Return Value
The size of the file, in bytes.
Related Functions
FileSeek
Example
! Get the size of the file.
Size=FileSize(File);
See Also
File Functions
FileSplitPath
Splits a file path into individual string components. You enter the full path string as sPath.
The individual components of the path name are returned in the arguments sDrive, sDir,
sFile, and sExt.
Syntax
FileSplitPath(sPath, sDrive, sDir, sFile, sExt)
sPath:
The full path string.
sDrive:
The disk drive.
sDir:
The directory string.
sFile:
The file name (without the extension).
sExt:
The file extension.
Return Value
Related Functions
FileSeek, FileFind, FileMakePath
Example
See FileFind
See Also
File Functions
FileWrite
392
Writes a string to a file. The string is written at the current file position.
Syntax
FileWrite(File, String)
File:
The file number.
String:
The string to write.
Return Value
The number of characters written.
Related Functions
FileOpen, FileClose, FileWriteLn
Example
! Write to the file.
FileWrite(File,"Data");
See Also
File Functions
FileWriteBlock
Writes a string or buffer to a file. The data is written at the current file position. You may
create the binary data by using the StrSetChar function or by reading the data from some
other function. This function is similar to the FileWrite() function however you specify the
length of data to write to the file. The FileWrite() function will send the data to the file until
the sting terminator is found. FileWriteBlock() will ignore any string terminator and copy
the length of bytes to the file. This allows this function to be used for binary data transfer.
Syntax
FileWriteBlock(File, Buffer, Length)
File:
The file number.
Buffer:
The data to write to the file. This may be a string or a string packed with binary
data. The string terminator is ignored and the length argument specifies the num-
ber of characters to write.
Length:
The number of characters to write. The maximum number of characters you may
write in one call is 255. (If you use a string without a terminator in a function that
expects a string, or in a Cicode expression, you could get invalid results.) To use
the string to build up a buffer, you do not need the terminating 0 (zero).
393
Return Value
The number of characters written to the file. If an error is detected -1 will be returned and
IsError() will return the error code.
Related Functions
FileOpen, FileClose, FileWrite, FileReadBlock, StrSetChar
Example
STRING buf;
FOR I = 0 TO 20 DO
StrSetChar(buf, I, I); // put binary data into string
END
! Write binary data to the file.
FileWrite(File, buf, 20);
See Also
File Functions
FileWriteLn
Writes a string to a file, followed by a newline character. The string is written at the current
file position.
Syntax
FileWriteLn(File, String)
File:
The file number.
String:
The string to write.
Return Value
The number of characters written (including the carriage return and newline characters).
Related Functions
FileOpen, FileClose, FileWrite
Example
! Write a line to the file.
FileWriteLn(File,"Line of file data");
See Also
File Functions
394
Chapter: 30 Form Functions
Form functions create and display data entry forms. Use them to display large amounts of
data or request data from the operator; for example, to display, load, and/or edit a database
of recipes.
Form Functions
Following are functions relating to forms:
FormActive Checks if a form is currently active.
FormAddList Adds a text string to a list box or combo box.
FormButton Adds a button to a form.
FormCheckBox Adds a check box to the current form.
FormComboBox Adds a combo box to the current form.
FormCurr Gets the current form and field handles.
FormDestroy Removes a form from the screen.
FormEdit Adds edit fields to a form.
FormField Adds general fields to a form.
FormGetCurrInst Gets data associated with a field.
FormGetData Gets all data associated with a form.
FormGetInst Gets data associated with a field on a form.
FormGetText Gets field text on an active form.
FormGoto Go to a specified form.
FormGroupBox Adds a group box to the current form.
FormInput Adds an input field to a form.
FormListAddText Adds a new text entry to a combo box or a list box.
FormListBox Adds a list box to the current form.
FormListDeleteText Deletes existing text from combo box or list box.
FormListSelectText Selects (highlights) a text entry in a combo box or a list
box.
FormNew Creates a new form.
FormNumPad Provides a keypad form for the operator to add numeric
values.
FormOpenFile Displays a File Open dialog box.
FormPassword Adds a password (no echo) input field.
FormSecurePassword Adds a secure password (no echo) input field.
FormPosition Sets the position of a form on the screen, before it is dis-
played.
FormPrompt Adds a prompt to a form.
FormRadioButton Adds a radio button to the current form.
FormRead Displays a form and reads user input.
FormSaveAsFile Displays a File Save As dialog box.
FormSelectPrinter Displays the Select Printer dialog box.
395
FormSetData Sets data in a form.

FormSetInst Associates data to a field on a form.
FormSetText Sets field text on an active form.
FormWndHnd Gets the window handle for the given form.
See Also
Functions Reference
FormActive
Checks if a form is currently active (displayed on the screen). This function is useful when
forms are being displayed in asynchronous mode and another Cicode task is trying to ac-
cess the form.
Syntax
FormActive(hForm)
hForm:
The form handle, returned from the FormNew() function. The form handle iden-
tifies the table where all data on the associated form is stored.
Return Value
TRUE (1) if the form is active or FALSE (0) if it is not.
Related Functions
FormDestroy, FormNew
Example
See FormDestroy
See Also
Form Functions
FormAddList
Adds a text string to a list box or combo box. You should call this function only after the
FormNew() function, and immediately after either the FormComboBox() or the FormList-
Box(), and before the FormRead() function otherwise an error is returned. The text is added
at the end of the list box or combo box.
To add text to a form that is already displayed, use the FormListAddText() function, and
use the FormListSelectText() function to highlight text on the list.
Syntax
FormAddList(sText)
sText:
The text string to add to the list box or combo box.
Return Value
396
Related Functions
FormNew, FormRead, FormListBox, FormComboBox, FormListAddText, FormListDelete-
Text, FormListSelectText
Example
See FormComboBox and FormListBox
See Also
Form Functions
FormButton
Adds a button to the current form. You can add buttons that run callback functions (spec-
ified in Fn) to perform any actions you need, as well as the standard buttons - an [OK] but-
ton to save the operator’s entries and close the form, and a [Cancel] button to close the form
but discard the changes.
You should call this function only after the FormNew() function and before the FormRead()
function. The button is added to the form at the specified column and row position. The
width of the button is automatically sized to suit the text.
Syntax
FormButton(Col, Row, sText, Fn, Mode)
Col:
The number of the column in which the button will be placed. Enter a number
from 0 (column 1) to the form width - 1. For example, to place the button in col-
umn 8, enter 7.
Row:
The number of the row in which the button will be placed. Enter a number from
0 (row 1) to the form height - 1. For example, to place the button in row 6, enter 5.
sText:
The text to display on the button.
Fn:
The callback function to call when the button is selected. Set to 0 to call no func-
tion. Please be aware that the Fn parameter must be of type INT and the callback
function cannot contain a blocking function.
Mode:
Button mode:
0 - Normal button. When this button is selected the callback function is called.
1 - OK button. When this button is selected, the form is closed, and all operator-
entered data is copied to buffers (specified by the other form functions).
FormRead() returns 0 (zero) to indicate a successful read. The callback
function specified in Fn is called. Note that this mode destroys the form.
2 - Cancel button. When this button is selected, the form is closed and operator-
entered data is discarded. FormRead() returns with an error 299. The call-
back function specified in Fn is called. Note that this mode destroys the
form.
397
Return Value
The field handle if the button is successfully added, otherwise -1 is returned.
Related Functions
FormNew, FormRead
Example
! Create a form, add buttons and then display the form on the
current page
FUNCTION FnMenu()
FormNew("MENU",20,6,1);
FormButton(0 ,4 ," FIND ", FindMenu, 0);
FormButton(10,4 ," TAG ", ShowTag, 0);
FormButton(0 ,5 ," CANCEL ", KillForm, 0);
FormButton(10,5 ," GOTO ", GotoPg, 0);
FormRead(0);
END
See Also
Form Functions
FormCheckBox
Adds a check box to the current form. The check box is a form control that allows the oper-
ator to make individual selections. Each check box can be either checked (true) or cleared
(false).
function. The check box is added to the form at the specified column and row position. The
width of the button is automatically sized to suit the text.
Syntax
FormCheckBox(Col, Row, sText, sBuf)
Col:
The number of the column in which the check box will be placed. Enter a number
from 0 (column 1) to the form width - 1. For example, to place the check box in
column 8, enter 7.
Row:
The number of the row in which the check box will be placed. Enter a number
from 0 (row 1) to the form height - 1. For example, to place the check box in row
6, enter 5.
sText:
The text associated with the check box.
sBuf:
The string buffer in which to put the state of the check box. You should initialize
this buffer to the state of the check box. When the form returns, this buffer will
contain either ’1’ or ’0’ if the box is checked.
398
Return Value
The field handle if the check box is successfully added, otherwise -1 is returned.
Related Functions
FormNew, FormRead
Example
! Create a form, add check boxes, and display the form.
! The operator may select none or all of the check boxes.
FUNCTION FnMenu()
STRING sNuts, sCherrys, sChocolate;
sNuts= "1";
sCherrys= "0";
sChocolate= "1";
FormNew("IceCream",20,6,1);]
FormCheckBox(2 ,2,"Nuts",sNuts);
FormCheckBox(2, 3,"Cherrys",sCherrys);
FormCheckBox(2 ,4,"Chocolate",sChocolate);
FormRead(0);
If sNuts = "1" THEN
! add the nuts
END
IF sCherrys = "1" THEN
! add the cherrys
END
IF sChocolate = "1" THEN
! add the chocolate
END
END
See Also
Form Functions
FormComboBox
Adds a combo box to the current form. A combo box is a form control that allows the oper-
ator to type a selection or make a single selection from a text list.
function. The combo box is added to the form at the specified column and row position
with the specified width and height. If more items are placed in the list than the list can dis-
play, a scroll bar displays (to scroll to the hidden items).
Use the FormAddList() function to add items for display in the list box. If the form is al-
ready displayed, you can use the FormListAddText() and FormListSelectText() functions
to add (and highlight) text in the list box.
Syntax
FormComboBox(Col, Row, Width, Height, sBuf [, Mode] )
Col:
399
The number of the column in which the combo box will be placed. Enter a num-
ber from 0 (column 1) to the form width - 1. For example, to place the combo box
in column 8, enter 7.
Row:
The number of the row in which the combo box will be placed. Enter a number
from 0 (row 1) to the form height - 1. For example, to place the combo box in row
6, enter 5.
Width:
The width of the list box, which should be wide enough to display your widest
item. Items wider than the list box are clipped.
Height:
The height of the list box (the number of items that can be seen in the list box with-
out scrolling).
sBuf:
The string buffer in which to store the selected item. The sBuf parameter can also
hold the starting selection for the Combo box. For example if you set the sBuf
string to "HELLO" before calling FormComboBox, HELLO will be displayed in
the box upon opening the form.
Mode:
The mode in which to create the combo box:
0 - Sort the combo box elements alphabetically.
1 - Place elements in combo box in the order they were added.
Default mode is 0.
Return Value
The field handle if the combo box is successfully added, otherwise -1 is returned.
Related Functions
FormNew, FormRead, FormAddList, FormListAddText, FormListSelectText, FormListBox
Example
! Create a form, add combo box and then display the form
! the operator may type in or select one of the items from the list
FUNCTION FnMenu()
STRING sBuf;
FormNew("Select Item",20,6,1);
FormComboBox(2 ,2, 15, 5, sBuf, 1);
FormAddList("Item One");
FormAddList("Item two");
FormAddList("Item three");
FormRead(0);
! sBuf should contain the selected item or entered text
END
See Also
Form Functions
400
FormCurr
Gets the form and field handles for the current form and field. You should call this function
only from within a callback function. You can then use the same callback function for all
forms and fields, regardless of how the boxes, buttons, etc. on the forms are used. You
should use this function with the FormGetInst() function.
Syntax
FormCurr(hForm, hField)
hForm:
hField:
The field handle of the field currently selected.
Return Value
Related Functions
FormGetInst
Example
See FormGetInst.
See Also
Form Functions
FormDestroy
Destroys a form, that is removes it from the screen. Use this function (from an event) to
close a form.
Syntax
FormDestroy(hForm)
hForm:
Return Value
Related Functions
FormNew
Example
/* Display message to the operator. If after 10 seconds the
operator has not selected OK, then destroy the form. */
hForm=FormNew("Hello",4,20,0);
401
FormPrompt(1,1,"Something bad has happened");

FormButton(5,2,"OK",0,1);
FormRead(1);
! Wait 10 seconds.
Sleep(10);
IF FormActive(hForm) THEN
! Destroy form.
FormDestroy(hForm);
END
See Also
Form Functions
FormEdit
Adds an edit field to the current form. You should call this function only after the Form-
New() function and before the FormRead() function. A user input/edit box is added to the
form at the specified column and row position. The operator can enter or edit the text in the
edit box. This text is then passed to this function as Text.
Syntax
FormEdit(Col, Row, Text, Width [, maxTextLength] )
Col:
The number of the column in which the edit field will be placed. Enter a number
from 0 (column 1) to the form width - 1. For example, to place the edit field in col-
umn 8, enter 7.
Row:
The number of the row in which the edit field will be placed. Enter a number
from 0 (row 1) to the form height - 1. For example, to place the edit field in row 6,
enter 5.
Text:
The text in the edit field. Text initially contains the default text (if any) for the op-
erator to edit. When the function closes, this argument is passed back with the op-
erator’s input.
Width:
The width of the edit field.
maxTextLength:
This optional parameter specifies the maximum length of input text. The default
value is 0 meaning the string can have the maximum length allowed in the system
(Cicode allows strings of 255 characters).
Return Value
The field handle if the string is successfully added, otherwise -1 is returned.
Related Functions
FormNew
402
Example
STRING Recipe;
FormNew("Recipe",5,30,0);
! Add edit field, default Recipe to "Jam".
Recipe="Jam";
FormEdit(1,2,Recipe,20);
! Read the form.
FormRead(0);
! Recipe will now contain the operator-entered data.
See Also
Form Functions
FormField
Adds a field control device (such as a button , check box, or edit field) to the current form.
function. This function allows you to specify a control device with more detail than the oth-
er field functions.
Syntax
FormField(Col, Row, Width, Height, Type, Buffer, Text, Fn [, maxTextLength] )
Col:
The number of the column in which the control will be placed. Enter a number
from 0 (column 1) to the form width - 1. For example, to place the control in col-
umn 8, enter 7.
Row:
The number of the row in which the control will be placed. Enter a number from
0 (row 1) to the form height - 1. For example, to place the control in row 6, enter 5.
Width:
The width of the control device.
Height:
The height of the control device.
Type:
The type of control device:
0 - None
1 - Edit
2 - Edit Password
3 - Text
4 - Button
5 - OK button
6 - Cancel button
7 - Group box
8 - Radio button
9 - Check box
403
Buffer:
The output buffer for the field string. The default value of the control device is
initialized to the value of the buffer. If you specify a Radio button or Check box,
you should initialize the buffer to "0" or "1". The result of the field will also be set
to "0" or "1".
Text:
The display prompt text for a button, or the default text for an edit field (which is
then passed back with the operator’s input).
Fn:
The callback function to call when the button is selected. Set to 0 to call no func-
tion. Please be aware that the Fn parameter must be of type INT, and the callback
function cannot contain a blocking function. For types other than 4,5, and 6, set
this argument to 0.
maxTextLength:
This optional parameter specifies the maximum length of input text for edit fields
(this parameter is ignored for other controls). The default value is 0 meaning the
string can have the maximum length allowed in the system (Cicode allows strings
of 255 characters).
Return Value
The field handle if the field is successfully added, otherwise it will return -1.
Related Functions
FormNew
Example
! Display a form with check boxes to start
!! specific motors.
FUNCTION SelectMotor()
INT hform;
STRING check1 = "0";
hform = FormNew("Selection Menu", 26, 22, 6);
FormField(16, 1, 12, 1, 9, check1, "Primary ", 0);
FormField(16, 2, 12, 1, 9, check2, "Secondary", 0);
FormField(16, 3, 12, 1, 9, check3, "backup ", 0);
FormButton( 9, 20, " &Cancel ", 0, 2);
IF FormRead(0) = 0 THEN
IF check1 = "1" THEN
StartMotor(MOTOR_1);
END
END
END
END
END
404
See Also
Form Functions
FormGetCurrInst
Extracts data associated with a field (set by the FormSetInst() function). You should call this
function only from within a field callback function. This function is the same as calling the
FormCurr() function and then the FormGetInst() function.
Syntax
FormGetCurrInst(iData, sData)
iData:
Integer data.
sData:
String data.
Return Value
Related Functions
FormCurr, FormGetInst, FormSetInst
Example
INT
FUNCTION GetNextRec()
INT hDev;
STRING Str;
FormGetCurrInst(hDev,Str);
DevNext(hDev);
RETURN 0;
END
See Also
Form Functions
FormGetData
Gets all data associated with a form and puts it into the output string buffers. Normally the
field data is copied to the output string buffers only when the user selects the [OK] button.
If you want to use the data while the form is displayed, call this function to get the data.
You should call this function only while the form is displayed otherwise an error is re-
turned, for example, from a field callback function.
Syntax
FormGetData(hForm)
hForm:
405
Return Value
Related Functions
FormCurr
Example
! Field callback to save data.
FUNCTION Save()
INT hForm,hField;
FormCurr(hForm,hField);
FormGetData(hForm);
! Access all data.
..
END
See Also
Form Functions
FormGetInst
Extracts the data associated with a field (set by the FormSetInst() function). You would nor-
mally use this function in a field callback function. It allows single callback functions to
know that the form and field are associated.
Syntax
FormGetInst(hForm, hField, iData, sData)
hForm:
hField:
iData:
Integer data.
sData:
String data.
Return Value
The data (as a string).
Related Functions
FormSetInst, FormCurr, FormGetCurrInst
Example
INT
FUNCTION GetNextRec()
INT hDev,hForm,hField;
406
STRING Str;
! Get field data, for example, the hDev value.
..
FormGetInst(hForm,hField,hDev,Str);
DevNext(hDev);
! Display new record in form.
..
RETURN 0;
END
See Also
Form Functions
FormGetText
Gets the current text from a form field. You should call this function only while the form is
displayed; for example,, from a field callback function.
Syntax
FormGetText(hForm, hField)
hForm:
hField:
Return Value
The field text (as a string).
Related Functions
FormSetText
Example
FUNCTION Search()
INT hForm,hField;
STRING Recipe;
Recipe=FormGetText(hForm,hField);
! Go and find recipe.
..
END
See Also
Form Functions
FormGoto
407
Goes to a specified form. The form is displayed on top of all windows and the keyboard
focus is set to this form.
Syntax
FormGoto(hForm)
hForm:
Return Value
Related Functions
FormNew
Example
FormGoto(hForm);
See Also
Form Functions
FormGroupBox
Adds a group box to the current form. A group box is a form control box drawn to the spec-
ified size. If the box contains radio buttons, they are grouped together. You should call this
function only after the FormNew() function and before the FormRead() function.
The group box is added to the form at the specified column and row position with the spec-
ified width and height. Use the FormRadioButton() function to add the radio buttons to the
box, and call this function between each group of radio buttons.
Syntax
FormGroupBox(Col, Row, Width, Height [, Text] )
Col:
The number of the column in which the group box will be placed. Enter a number
from 0 (column 1) to the form width - 1. For example, to place the group box in
column 8, enter 7.
Row:
The number of the row in which the group box will be placed. Enter a number
from 0 (row 1) to the form height - 1. For example, to place the group box in row
6, enter 5.
Width:
The width of the group box, which should be wide enough to display your wid-
est item.
Height:
The height of the group box.
408
Text:
The text to display as the group box label.
Return Value
The field handle if the group box is successfully added, otherwise -1 is returned.
Related Functions
FormNew, FormRead, FormRadioButton
Example
! Create a form, add to radio buttons groups and then display the
form
! The operator may select one of the radio buttons from each group
FUNCTION FnMenu()
STRING sFast, sSlow, sMedium;
STRING sNorth, sSouth, sEast, sWest;
FormGroupBox(1 ,1, 15, 5, "Speed");
FormRadioButton(2 ,2,"Fast", sFast);
FormRadioButton(2, 3,"Medium", sMedium);
FormRadioButton(2 ,4,"Slow", sSlow);
FormGroupBox(19 ,2, 15, 6, "Direction");
FormRadioButton(20 ,2,"North", sNorth);
FormRadioButton(20, 3,"South", sSouth);
FormRadioButton(20 ,4,"East", sEast);
FormRadioButton(20 ,5,"West", sWest);
FormRead(0);
END
See Also
Form Functions
FormInput
Adds a prompt and edit field to the current form. You should call this function only after
the FormNew() function and before the FormRead() function. When FormRead() is called,
the form will display with the prompt and edit box. The operator’s input is passed back as
a string (Text).
Syntax
FormInput(Col,Row,Prompt,Text,Width [, maxTextLength] )
Col:
The number of the column in which the prompt will be placed. Enter a number
from 0 (column 1) to the form width - 1. For example, to place the prompt in col-
umn 8, enter 7.
Row:
The number of the row in which the prompt will be placed. Enter a number from
0 (row 1) to the form height - 1. For example, to place the prompt in row 6, enter 5.
Prompt:
The prompt string.
409
Text:
The output text string containing the operator’s input.
Width:
maxTextLength:
This optional parameter specifies the maximum length of input text. The default
value is 0 meaning the string can have the maximum length allowed in the system
(Cicode allows strings of 255 characters).
Return Value
The field handle if it is added successfully, otherwise -1 is returned.
Related Functions
FormNew, FormRead
Example
FormInput(1,2,"Recipe",Recipe,20);
See Also
Form Functions
FormListAddText
Adds a new text entry to a combo box or a list box while the form is displayed. It only adds
the text to the list - it does not select it. Use the FormListSelectText() function to select (high-
light) an entry. Call this function only when the form is displayed, for example, from a field
callback function.
Syntax
FormListAddText(hForm, hField, Text)
hForm:
hField:
Text:
The output text string containing the operator’s input.
Return Value
Related Functions
FormListSelectText, FormListDeleteText, FormSetText
410
Example
/* create a form with a list */
hForm = FormNew("Ingredients", 40, 10, 1);
hField = FormListBox(2,2,20,5,sBuf);
FormAddList("Flour");
FormAddList("Water");
FormAddList("Salt");
FormAddList("Sugar");
/* Display the form */
FormRead(1);
..
/*Add Milk to list */
FormListAddText(hForm, hField, "Milk");
..
See Also
Form Functions
FormListBox
Adds a list box to the current form. The list box is a form control that allows the operator
to select from a list of items. You should call this function only after the FormNew() func-
tion and before the FormRead() function.
The list box is added to the form at the specified column and row position with the speci-
fied width and height. If more items are placed in the list than the list can display, a scroll
bar displays for scrolling to the hidden items.
Use the FormAddList() function to add items for display in the list box. If the form is al-
ready displayed, you can use the FormListAddText() and FormListSelectText() functions
to add (and highlight) text in the list box.
Syntax
FormListBox(Col, Row, Width, Height, sBuf [, Mode] )
Col:
The number of the column in which the list box will be placed. Enter a number
from 0 (column 1) to the form width - 1. For example, to place the list box in col-
umn 8, enter 7.
Row:
The number of the row in which the list box will be placed. Enter a number from
0 (row 1) to the form height - 1. For example, to place the list box in row 6, enter 5.
Width:
The width of the list box, in characters. Width should be wide enough to display
your widest item. Items wider than the list box are clipped.
Height:
The height of the list box, as the number of items that can be seen in the list box
without scrolling.
sBuf:
The string buffer in which to store the selected item.
411
Mode:
The mode in which to create the list box:
0 - Sort the list box elements alphabetically.
1 - Place elements in list box in the order they were added.
Mode 0 is the default.
Return Value
The field handle if the list box is successfully added, otherwise -1 is returned.
Related Functions
FormNew, FormRead, FormAddList, FormListAddText, FormListSelectText, FormCom-
boBox
Example
! Create a form, add list box and then display the form.
! The operator may select one of the items from the list.
STRING sBuf;
FUNCTION FnMenu()
FormListBox(2 ,2, 15, 5, sBuf, 1);
FormAddList("Item One");
FormAddList("Item two");
FormAddList("Item three");
FormButton(0,0," OK ",0,1);
FormButton(5,0," CANCEL ",0,2);
FormRead(0);
SELECTION= sBuf;
END
See Also
Form Functions
FormListDeleteText
Deletes an existing text entry from a combo box or a list box while the form is displayed. It
only deletes the text from the list - it does not change the selection. Call this function only
when the form is displayed, for example, from a field callback function.
Syntax
FormListDeleteText(hForm, hField, Text)
hForm:
hField:
Text:
The text to delete.
412
Return Value
Related Functions
FormListSelectText, FormListAddText
Example
/* create a form with a list */
FormRead(1);
..
/*Remove Sugar from the list */
FormListDeleteText(hForm, hField, "Sugar");
..
See Also
Form Functions
FormListSelectText
Selects (highlights) a text entry in a Combo box or a List box while the form is displayed.
The text to be selected must exist in the list. (Use the FormListAddText() function to add a
text entry to a list.) Call this function only when the form is displayed, for example, from a
field callback function.
Syntax
FormListSelectText(hForm, hField, Text)
hForm:
hField:
Text:
The text to be selected. If this text is not present in the list, then no item will be
selected (and this text will not be added).
Return Value
Related Functions
FormListAddText, FormSetText
413
Example
/* Create a form with a list */
FormRead(1);
..
/*Select Flour */
FormListSelectText(hForm, hField, "Flour");
See Also
Form Functions
FormNew
Creates a new data entry form and defines its size and mode. After the form is created, you
can add fields, and then display the form.
Before you can display a form on the screen, you must call this function to set the size and
mode of the form, and then call the various form field functions, FormInput(), FormBut-
ton(), FormEdit() etc to add user input fields to the form. To display the form on the screen
(to allow the user to enter data) call the FormRead() function.
Syntax
FormNew(Title, Width, Height, Mode)
Title:
The title of the form.
Width:
The character width of the form (1 to 131).
Height:
The character height of the form (1 to 131).
Mode:
The mode of the form:
0 - Default font and text spacing
1 - Small font
2 - Fixed pitch font
4 - Static text compression where the vertical spacing is reduced. This can cause
formatting errors if buttons are too close, because the vertical spacing will
be less than the height of a button.
8 - Keep the form on top of the CitectSCADA window.
16 - The current window cannot be changed or closed until the form is finished
or cancelled.
32 - Makes a form with no caption.
414
128 - The form will not close if the ESC or ENTER key is pressed, unless you spe-
cifically define at least one button on the form which acts as an OK or Can-
cel button. For a form with no buttons, the ENTER key normally closes the
form; this mode disables that behavior.
256 – Makes a from with no system-menu (mostly appears as a single close button
X) .
Multiple modes can be selected by adding them (for example, to use Modes 4 and
2, specify Mode 6).
Return Value
The form handle if the form is created successfully, otherwise -1 is returned. The form han-
dle identifies the table where all data on the associated form is stored.
Related Functions
FormDestroy, FormInput, FormButton, FormEdit, FormRead
Example
FormNew("Recipe",30,5,0);
FormInput(1,1,"Recipe No",Recipe,20);
FormInput(1,2,"Amount",Amount,10);
FormRead(0);
See Also
Form Functions
FormNumPad
Provides a keypad form for the operator to add numeric values. You can customize the
standard form as a mathematical keypad, with the +, -, and / operators and the decimal
point. For a time keypad, use the AM, PM, and : (hour/minute divider) buttons. You can
also include a password edit field.
Syntax
FormNumPad(Title, Input, Mode)
Title:
The title to display on the number pad form.
Input:
The existing or default value. This value is returned if the form is cancelled or
accepted without changes.
Mode:
The buttons to include on the keypad form. The Mode can be a combination of
the following:
0 - Standard keypad
1 - Password edit field
2 - not used
4 - With +/- button
415
8 - With / button
16 - With . button
32 - With : button
64 - With AM, PM buttons
Multiple modes can be selected by adding them. For example, to include +/- but-
tons and a . button, specify Mode 20 (16+4).
Return Value
The string value entered by the operator. The IsError() function returns 0 (zero). If the form
was cancelled, the value of Input is returned, and the IsError() function returns error num-
ber 299.
Example
/* Set defaults first, then four keypad forms to adjust recipe. */
Qty_Flour=FormNumPad("Add Flour", Qty_Flour, 17);
Qty_Water=FormNumPad("Add Water", Qty_Water, 17);
Qty_Salt=FormNumPad("Add Salt", Qty_Salt, 17);
Qty_Sugar=FormNumPad("Add Sugar", Qty_Sugar, 17);
See Also
Form Functions
FormOpenFile
Displays a File Open dialog box.
Syntax
FormOpenFile(sTitle, sFileName, sFilter)
sFileName:
The name of the default file to display in the "File Name" field.
sTitle:
A title to display at the top of the form.
sFilter:
A file filter list to display in the "List Files of Type" field. The file filter list has the
following format:
<File Type>|<Filter>|
where:
File Type is the text that displays in the drop-down box, for example All Files
(*.*). Filter is the file type, for example *.CI
Return Value
The name and full path of the selected file (as a string) or an empty string ("") if the Cancel
button is selected.
Related Functions
FormSaveAsFile, FormSelectPrinter
416
Example
// Display the Open File dialog with the following filter list:
// All Files (*.*)
// Exe Files (*.EXE)
// Cicode Files (*.CI)
sFilename = FormOpenFile("Open", "*.CI", "All Files (*.*)|*.*|Exe
Files (*.EXE)|*.EXE|Cicode Files (*.CI)|*.CI|");
See Also
Form Functions
FormPassword
Adds both a password prompt and edit field to the current form. You should call this func-
tion only after the FormNew() function and before the FormRead() function. When Form-
Read() is called, the form will also display the password prompt and edit field.
The operator’s input is not echoed in the field; a single asterisk (*) is displayed for each
character.
Syntax
FormPassword(Col, Row, Prompt, Password, Width)
Col:
umn 8, enter 7.
Row:
Prompt:
The prompt string.
Password:
The password entered by the operator.
Width:
Return Value
Related Functions
FormEdit
Example
! Add Password input.
FormPassword(1,2,"Enter Password",Password,10);
417
See Also
Form Functions
FormPosition
Sets the position of a form on the screen, before it is displayed. You should call this function
only after the FormNew() function and before the FormRead() function.
Syntax
FormPosition(X, Y, Mode)
X, Y:
The x and y pixel coordinates of the form.
Mode:
Not used, set it to 0.
Return Value
Related Functions
FormNew, FormRead
Example
hForm = FormNew("title", 20, 5, 0);
! display form at x=100, y=50
FormPosition(100, 50, 0);
See Also
Form Functions
FormPrompt
Adds a prompt field to the current form. You should call this function only after the Form-
New() function and before the FormRead() function.
Syntax
FormPrompt(Col, Row, Prompt)
Col:
umn 8, enter 7.
Row:
Prompt:
The prompt string.
418
Return Value
Related Functions
FormNew, FormRead
Example
FormPrompt(1,2,"Enter Recipe");
See Also
Form Functions
FormRadioButton
Adds a radio button to the current form, allowing the operator to make a selection from a
multiple choice list. You should call this function only after the FormNew() function and
before the FormRead() function.
The radio button is added to the form at the specified column and row position. The width
of the button will be sized to suit the text.
By default, all radio buttons are placed into the one group. If you require separate groups,
use this function in conjunction with the FormGroupBox() function.
Syntax
FormRadioButton(Col, Row, sText, sBuf)
Col:
The number of the column in which the button will be placed. Enter a number
from 0 (column 1) to the form width - 1. For example, to place the button in col-
umn 8, enter 7.
Row:
The number of the row in which the button will be placed. Enter a number from
0 (row 1) to the form height - 1. For example, to place the button in row 6, enter 5.
sText:
The text associated with the radio button.
sBuf:
The string buffer in which to put the state of the radio button. You should initial-
ize this buffer to the state of the button. When the form returns, this buffer will
contain either ’1’ or ’0’ if the radio button is checked.
Return Value
The field handle if the radio button is successfully added, otherwise -1 is returned.
Related Functions
FormNew, FormRead, FormGroupBox, FormCheckBox
419
Example
! Create a form, add radio buttons and then display the form.
! The operator may only select one radio button , either Fast,
Medium or Slow
FUNCTION FnMenu()
STRINGsFast, sSlow, sMedium;
sFast = "1";
sMedium = "0";
sSlow = "0";
FormNew("Speed",20,6,1);
FormRadioButton(2 ,2,"Fast", sFast);
FormRadioButton(2, 3,"Medium", sMedium);
FormRadioButton(2 ,4,"Slow", sSlow);
FormRead(0);
If sFast = "1" THEN
! do fast stuff
ELSE
IF sMedium = "1" THEN
! do Medium stuff
ELSE
IF sSlow = "1" THEN
! do slow stuff
END
END
See Also
Form Functions
FormRead
Displays the current form (created with the FormNew() function), with all the fields that
were added (with the form field functions).
You can display the form and wait for the user to finish entering data by setting the Mode
to 0. This mode is the most commonly used, with [OK] and [Cancel] buttons to either save
or discard operator entries and to close the form.
To display the form and return before the user has finished, use Mode 1. This mode is used
to animate the data on the form or to perform more complex operations.
is complete.
Syntax
FormRead(Mode)
Mode:
Mode of the form:
0 - Wait for the user.
1 - Do not wait for the user.
Return Value
420
Related Functions
FormNew
Example
! Display the form and wait for the user.
FormRead(0);
! Display the form and do not wait for the user.
FormRead(1);
! While the form is displayed, update the time every second.
WHILE FormActive(hForm) DO
FormSetText(hForm,hField,Time());
Sleep(1);
END
See Also
Form Functions
FormSaveAsFile
Displays a File Save As dialog box.
Syntax
FormSaveAsFile(sTitle, sFileName, sFilter [, sDefExt] )
sTitle:
A title to display at the top of the form.
sFileName:
The name of the default file to display in the "File Name" field.
sFilter:
A file filter list to display in the "List Files of Type" field. The file filter list has the
following format:
<File Type>|<Filter>|
where:
File Type is the text that displays in the drop-down box, for example All Files
(*.*). Filter is the file type, for example *.CI
sDefExt:
The file extension that will be used as a default when you use the FormSaveAs-
File() function. If you do not specify a default extension, files will be saved with-
out an extension.
Return Value
The name and full path of the selected file (as a string) or an empty string ("") if the Cancel
button is selected.
Related Functions
FormOpenFile, FormSelectPrinter
421
Example
// Display the SaveAs dialog with the following filter list:
// All Files (*.*)
// Exe Files (*.EXE)
// Cicode Files (*.CI)
sFilename = FormSaveAsFile("Save As", "Alarms", "All Files
(*.*)|*.*|Exe Files (*.EXE)|*.EXE|Cicode Files (*.CI)|*.CI|",
"ci");
See Also
Form Functions
FormSecurePassword
Adds both a password prompt and edit field to the current form. You should call this func-
tion only after the FormNew() function and before the FormRead() function. When Form-
Read() is called, the form will also display the password prompt and edit field.
The operator’s input is not echoed in the field; a single asterisk (*) is displayed for each
character. The function does not return the password as a plain text, it returns an encrypted
password string. The user can send this string to the UserLogin or UserVerify functions.
Syntax
FormSecurePassword(Col, Row, Prompt, Password, Width)
Col:
umn 8, enter 7.
Row:
Prompt:
The prompt string.
Password:
The encrypted password entered by the operator.
Width:
Return Value
Related Functions
FormEdit, UserLogin, UserVerify
Example
! Add Password input.
FormSecurePassword(1,2,"Enter Password",Password,10);
422
See Also
Form Functions
FormSelectPrinter
Displays the Select Printer dialog box.
Syntax
FormSelectPrinter()
Return Value
The name of the selected printer (as a string) or an empty string ("") if the Cancel button is
selected.
Related Functions
FormOpenFile, FormSaveAsFile
Example
// Display the Select Printer dialog
sPrinter = FormSelectPrinter();
See Also
Form Functions
FormSetData
Sets all the edit data from the string buffers into the form. You should call this function only
while the form is active.
Syntax
FormSetData(hForm)
hForm:
Return Value
Related Functions
FormGetData
Example
INT
FUNCTION MyNextRec()
INT hForm,hField;
423
FormSetData(hForm);
RETURN 0;
END
See Also
Form Functions
FormSetInst
Associates an integer and string value with each field on a form. This data could then be
used by a callback function. You can use a single callback function for all fields, and use the
data to perform different operations for each field.
Syntax
FormSetInst(hForm, hField, iData, sData)
hForm:
hField:
iData:
Integer data.
sData:
String data.
Return Value
Related Functions
FormGetInst
Example
! Open recipe database.
hDev=DevOpen("Recipe", 0);
hForm=FormNew("Recipe",20,5,0);
hField=FormButton(5,2,"Next",GetNextRec,0);
FormSetInst(hForm,hField,hDev,"");
/* The device handle hDev is put into the next button , so when the
button is selected it can get hDev and get the next record. */
See Also
Form Functions
FormSetText
424
Sets new field text on a field. This function allows you to change field text while the form
is displayed. Call this function only when the form is displayed, for example, from a field
callback function.
If you are using this function on a Combo box or a List box, it will select the text from the
Combo box or List box list. If no text exists in the Combo box or List box list, the function
will add it.
Syntax
FormSetText(hForm, hField, Text)
hForm:
hField:
The field handle of the field currently selected. If the hField is a handle to the se-
cure edit field created with FormSecurePassword, the text in the secure edit field
will not be changed. However, when an empty string is passed to FormSetText(),
the contents of the secure edit field will be cleared.
Text:
New field text.
Return Value
Related Functions
FormCurr, FormListSelectText, FormListAddText
Example
/* Create a form with a field */
hField = FormPrompt(2,2,"Motor1:");
/* Display the form*/
FormRead(1);
..
/* Change the text in the field */
FormSetText(hForm, hField, "Pump1:");
..
See Also
Form Functions
FormWndHnd
Gets the window handle for the given form. The window handle may be used by ’C’ pro-
grams and CitectSCADAWnd... functions. You should call this function only after the
FormNew() function and before the FormRead() function.
The window handle is not the same as the CitectSCADA window number and cannot be
used with functions that expect the CitectSCADA window number (the Win... functions).
425
Syntax
FormWndHnd(hForm)
hForm:
Return Value
The window handle if successful, otherwise a 0 is returned.
Related Functions
FormNew, FormRead, WndFind
Example
/* Create a form with a field */
hField = FormPrompt(2,2,"Motor1:");
/* Get the form’s window number for future reference */
hWnd = FormWndHnd(hForm);
/* Display the form*/
FormRead(1);
See Also
Form Functions
426
Chapter: 31 Format Functions
Format functions convert data into formatted strings. You can convert many different items
of data into single, formatted strings that can then be displayed, printed, or written to a file.
The format functions also convert (formatted) data back into individual elements; for ex-
ample,, strings that are read from files or other devices.
Format Functions
Following are functions used for formatting data:
FmtClose Closes a format template.
FmtFieldHnd Gets the handle of a field in a format template.
FmtGetField Gets field data from a format template.
FmtGetFieldHnd Gets field data from a format template using a field handle.
FmtOpen Creates a new format template.
FmtSetField Sets data in a field of a format template.
FmtSetFieldHnd Sets data in a field of a format template using a field handle.
FmtToStr Converts format template data to a string
See Also
Functions Reference
FmtClose
Closes a format template. After it is closed, the template cannot be used. Closing the tem-
plate releases system memory.
Syntax
FmtClose(hFmt)
hFmt:
The format template handle, returned from the FmtOpen() function. The handle
identifies the table where all data on the associated format template is stored.
Return Value
Related Functions
FmtOpen
Example
FmtClose(hFmt);
See Also
Format Functions
427
FmtFieldHnd
Gets the handle of a field in a format template. You can then use the field handle in the Fmt-
GetFieldHnd() and FmtSetFieldHnd() functions. By using a handle, you only need to re-
solve the field name once and then call other functions as required (resulting in improved
performance.)
Syntax
FmtFieldHnd(hFmt, Name)
hFmt:
Name:
The field name.
Return Value
The handle of the format template field, or -1 if the field cannot be found.
Related Functions
FmtGetFieldHnd, FmtSetFieldHnd
Example
!Resolve names at startup.
hName=FmtFieldHnd(hFmt,"Name");
hDesc=FmtFieldHnd(hFmt,"Desc");
!Set field data.
FmtSetFieldHnd(hFmt,hName,"CV101");
See Also
Format Functions
FmtGetField
Gets field data from a format template. Use this function to extract data after a call to
StrToFmt().
Syntax
FmtGetField(hFmt, Name)
hFmt:
Name:
The field name.
Return Value
The data (as a string). If the field does not contain any data, an empty string will be re-
turned.
428
Related Functions
StrToFmt, FmtSetField, FmtToStr
Example
StrToFmt(hFmt,"CV101 Raw Coal Conveyor");
Str=FmtGetField(hFmt,"Name");
! Str will contain "CV101".
See Also
Format Functions
FmtGetFieldHnd
Gets field data from a format template. Use this function to extract data after a call to
StrToFmt(). This function has the same effect as FmtGetField(), except that you use a field
handle instead of the field name.
Syntax
FmtGetFieldHnd(hFmt, hField)
hFmt:
hField:
The field handle.
Return Value
The data (as a string). If the field does not contain any data, an empty string will be re-
turned.
Related Functions
StrToFmt, FmtFieldHnd
Example
hField=FmtFieldHnd(hFmt,"Name");
Str=FmtGetField(hFmt,hField);
! Str will contain "CV101".
See Also
Format Functions
FmtOpen
Creates a format template. After you create a template, you can use it for formatting data
into strings or extracting data from a string. To format a template, use the same syntax as a
device format, that is {<name>[,width[,justification]]}.
429
Syntax
FmtOpen(Name, Format, Mode)
Name:
The name of the format template.
Format:
The format of the template, as {<name>[,width[,justification]]}.
Mode:
0 - Open the existing format.
1 - Open a new format.
Return Value
The format template handle, or -1 if the format cannot be created.
Related Functions
FmtClose
Example
hFmt=FmtOpen("MyFormat","{Name}{Desc,20}",0);
FmtSetField(hFmt,"Name", "CV101");
FmtSetField(hFmt,"Desc","Raw Coal Conveyor");
Str =FmtToStr(hFmt);
! Str will contain "CV101 Raw Coal Conveyor".
See Also
Format Functions
FmtSetField
Sets data in a field of a format template. After you have set all the fields, you can build the
formatted string with the FmtToStr() function.
Syntax
FmtSetField(hFmt, Name, Data)
hFmt:
Name:
The name of the format template.
Data:
Field data.
Return Value
430
Related Functions
FmtGetField, FmtToStr
Example
hFmt=FmtOpen("MyFormat","{Name}{Desc, 20}",0);
FmtSetField(hFmt,"Name", "CV101");
FmtSetField(hFmt,"Desc","Raw Coal Conveyor");
Str =FmtToStr(hFmt);
! Str will contain "CV101 Raw Coal Conveyor".
See Also
Format Functions
FmtSetFieldHnd
The fields, you can build the formatted string with the FmtToStr() function. This function
has the same effect as FmtSetField() except that you use a field handle instead of the field
name.
Syntax
FmtSetFieldHnd(hFmt, hField, Data)
hFmt:
hField:
The field handle.
Data:
Field data.
Return Value
Related Functions
FmtFieldHnd, FmtToStr, FmtSetField
Example
hField=FmtFieldHnd(hFmt,"Name");
FmtSetFieldHnd(hFmt,hField,"CV101");
See Also
Format Functions
FmtToStr
Builds a formatted string from the current field data (in a format template).
431
Syntax
FmtToStr(hFmt)
hFmt:
Return Value
The formatted string as defined in the format description.
Related Functions
StrToFmt
Example
! Get the formatted string.
Str=FmtToStr(hFmt);
See Also
Format Functions
432
Chapter: 32 FTP Functions
FTP functions are used to manage your FTP communications and files (used when running
your project over the Internet). These functions can only be used on the Internet Display
Client.
FTP Functions
Following are functions relating to FTP:
FTPClose Closes an FTP session.
FTPFileCopy Copies a file from the FTP server to the Internet Display Client.
FTPFileFind Finds a file on the FTP server that matches a specified search cri-
teria.
FTPFileFindClose Closes a find (started with FTPFileFind) that did not run to com-
pletion.
FTPOpen Connects to an FTP server
See Also
Functions Reference
FTPClose
Closes an FTP session. This function can only be used on the Internet Display Client.
Syntax
FTPClose(hndFTP)
hndFTP:
The handle of a valid FTP session, as returned by FTPOpen().
Return Value
Related Functions
FTPOpen
Example
INT hFtp;
hFtp = FtpOpen("", "", "");
..
FtpClose(hFtp);
See Also
FTP Functions
FTPFileCopy
433
Copies a file from the FTP server to the Internet Display Client. Before calling this function,
you must call FtpOpen(). This function can only be used on the Internet Display Client.
Syntax
FTPFileCopy(hndFTP, sSrcPath, sDestPath)
hndFTP:
sSrcPath:
The file name and path of the file to be copied from the FTP Server to the Internet
Display Client. This can be any FTP server.
sDestPath:
The destination of the copied file (including the name of the file).
Return Values
Note: The [Internet]ZipFiles parameter does not apply to files copied to the Internet Dis-
play Client using this function.
Related Functions
FTPOpen, FTPFileFind
See Also
FTP Functions
FTPFileFind
Finds a file on the FTP server that matches a specified search criteria. Before you can call
this function, you must call FTPOpen(). This function can only be used on the Internet Dis-
play Client.
To find a list of files, you must first call this function twice: once to find the first file, then
again with an empty path to find the remaining files. After the last file is found, an empty
string is returned.
If the search is for multiple files, FTPFileFindClose must be called if the search does not run
to completion (for example, you do not run until an empty string is returned).
Syntax
FTPFileFind(hndFTP, sPath)
hndFTP:
sPath:
The path you want to search for the desired file. Do not use path substitution
here. To search for multiple files, the wildcards * and ? may be used to match mul-
tiple entries.
nMode:
The type of file to check:
434
0 - Normal files (includes files with read-only and archived attributes)

1 - Read-only files only
2 - Hidden files only
4 - System files only
16 - Subdirectories only
32 - Archived files only
128 - Files with no attributes only
These numbers can be added together to search for multiple types of files during
one search.
Return Value
The full path and filename. If no files are found, an empty string is returned.
Related Functions
FTPFileCopy, FTPOpen
Example
INT hFtp;
STRING sFindPath;
STRING sPath;
sFindPath = "\User\Example\*.RDB";
hFtp = FtpOpen("", "", "");
sPath = FtpFileFind(hFtp, sFindPath);
WHILE StrLength(sPath) > +0 DO
sPath = FtpFileFind(hFtp, "");
END
FtpClose(hFtp);
See Also
FTP Functions
FTPFileFindClose
Closes a find (started with FTPFileFind) that did not run to completion. This function can
only be used on the Internet Display Client.
Syntax
FTPFileFindClose(hndFTP)
hndFTP
Return Value
0 if no error is detected, or a Cicode error code if an error occurred.
Related Functions
FTPFileFind
435
Example
//Find the first DBF file starting with fred
sPath = FileFind("\User\Example\FRED*.DBF", 0);
IF (StrLength(sPath) > 0) THEN
//Do work here
FileFindClose();
END
See Also
FTP Functions
FTPOpen
Connects to an FTP server. This function can only be used on the Internet Display Client.
Syntax
FTPOpen( [sIPAddress] [, sUsername] [, sPassword] )
sIPAddress:
The TCP/IP address of the FTP server you wish to connect to (for example,
10.5.6.7 or plant.yourdoman.com). If you do not specify an IP address, the Cit-
ectSCADA FTP server running on the Internet Server you are connected to will
be used.
sUsername:
The FTP login username. If you omit both the username and IP address, the Cit-
ectSCADA FTP password will be used. If you omit just the username, an anony-
mous logon will occur.
sPassword:
The FTP server password. If you wish to log on anonymously or you wish to log
on to the CitectSCADA FTP server, do not specify a password, here.
Return Value
A handle to the FTP server otherwise -1 if an error occurs (for example, the server cannot
be found).
Related Functions
FTPClose
See Also
FTP Functions
436
Chapter: 33 FuzzyTech Functions
The CitectSCADA FuzzyTech functions support fuzzy logic control and provide an inter-
face to the FuzzyTech functions provided by INFORM Software Corporation. To use these
functions you must purchase the development environment from INFORM - the makers of
FuzzyTech.
FuzzyTech Functions
Following are functions relating to fuzzy logic control:
FuzzyClose Closes specified fuzzy instance.
FuzzyGetCodeValue Gets a specified Code variable from the specified instance.
FuzzyGetShellValue Gets a specified Shell variable from the specified instance.
FuzzyOpen Creates a new fuzzy instance.
FuzzySetCodeValue Sets a specified Code variable in the specified instance.
FuzzySetShellValue Sets a specified Shell variable in the specified instance.
FuzzyTrace Controls the tracing.
See Also
Functions Reference
FuzzyClose
Frees all memory and information for the specified instance. After the fuzzy instance is
closed, the handle given in the hFuzzy parameter is no longer valid.
Syntax
FuzzyClose(hFuzzy)
hFuzzy:
The fuzzy instance handle (and integer greater than 0).
Return Value
Related Functions
FuzzyOpen
Example
See FuzzyOpen.
See Also
FuzzyTech Functions
FuzzyGetCodeValue
Gets a value for the specified input of the specified instance.
437
Syntax
FuzzyGetCodeValue(hFuzzy, iIOIndex, NoHitFlag)
hFuzzy:
iIOIndex:
Specifies the variable to receive the value. The I/O-Indices start with 0 and incre-
ment by 1 for each variable. To find the correct index for a specific variable, the
variables must be sorted in alpha-numerical order, first the inputs and then the
outputs.
NoHitFlag:
Variable to receive the new value of the No-hit-flag. The No- hit-flag is TRUE if
no rule was active for the variable specified by iIOIndex, otherwise it is FALSE.
This must be a Cicode variable of INT type - it cannot be a constant or PLC vari-
able tag.
Return Value
The code value if the function was successful, otherwise -1. Use IsError() to find the error
number if the function does not succeed.
Related Functions
FuzzyOpen, FuzzySetCodeValue
Example
See FuzzyOpen
See Also
FuzzyTech Functions
FuzzyGetShellValue
Gets a value for the specified input of the specified instance. The variables in the instance
must have the data type REAL (floating point values).
Syntax
FuzzyGetShellValue(hFuzzy, iIOIndex, NoHitFlag)
hFuzzy:
iIOIndex:
outputs.
NoHitFlag:
Variable to receive the new value of the No-hit-flag. The No- hit-flag is TRUE if
no rule was active for the variable specified by iIOIndex, otherwise it is FALSE.
This must be a Cicode variable of INT type - it cannot be a constant or PLC vari-
able tag.
438
Return Value
The shell value if the function was successful. Use IsError() to find the error number if the
function does not succeed.
Related Functions
FuzzyOpen, FuzzySetShellValue
Example
See FuzzyOpen
See Also
FuzzyTech Functions
FuzzyOpen
This function loads a *.FTR file, allocates memory and creates a handle for this fuzzy in-
stance. To use the FuzzyTech functions you must be a registered user of one or more of the
following fuzzyTech products: fuzzyTECH Online Edition, fuzzyTECH Precompiler Edi-
tion, or fuzzyTECH for Business PlusC. And you must only use fuzzyTECH to generate the
*.FTR file for FTRUN.
The application must call the FuzzyClose function to delete each fuzzy instance handle re-
turned by the FuzzyOpen function.
Syntax
FuzzyOpen(sFile)
sFile:
Specifies the filename of the .FTR file to load.
Return Value
The handle to the fuzzy instance, or -1 if the function cannot complete the operation. Use
IsError() to find the error number.
Related Functions
FuzzyClose, FuzzyGetShellValue, FuzzySetShellValue, FuzzyGetCodeValue, FuzzySet-
CodeValue, FuzzyTrace.
Example
INT hFuzzy;
INT NoHitFlag;
INT Status;
REAL MemOutput;
// open the Fuzzy Tech runtime instance
hFuzzy = FuzzyOpen("C:\Program Files\Citect\CitectSCADA 7.10\bin\traffic.ftr");
Status = IsError();
IF hFuzzy <> -1 THEN
MemOutput = PLCOutput;
WHILE Status = 0 DO
FuzzySetShellValue(hFuzzy, 0, 42.0);
FuzzySetShellValue(hFuzzy, 1, 3.14150);
MemOutput = FuzzyGetShellValue(hFuzzy, 2, NoHitFlag);
439
Status = IsError();
// Only write to PLC if output changes.
// This reduces load on PLC communication.
IF MemOutput <> PLCOutput THEN
PLCOutput = MemOutput;
END
SleepMS(500);
END
FuzzyClose(hFuzzy);
END
See Also
FuzzyTech Functions
FuzzySetCodeValue
Sets a value for the specified input of the specified instance.
Syntax
FuzzySetCodeValue(hFuzzy, iIOIndex, iCodeValue)
hFuzzy:
iIOIndex:
outputs.
iCodeValue:
The value to be copied to the variable specified by iIOIndex.
Return Value
Related Functions
FuzzyOpen, FuzzyGetCodeValue
Example
See FuzzyOpen.
See Also
FuzzyTech Functions
FuzzySetShellValue
Sets a value for the specified input of the specified instance.
Syntax
FuzzySetShellValue(hFuzzy, iIOIndex, rShellValue)
440
hFuzzy:
iIOIndex:
outputs.
rShellValue:
The value to be copied to the variable specified by iIOIndex.
Return Value
Related Functions
FuzzyOpen, FuzzyGetShellValue
Example
See FuzzyOpen.
See Also
FuzzyTech Functions
FuzzyTrace
Controls the trace process (starting and stopping) of the specified instance.
Syntax
FuzzyTrace(hFuzzy, TraceOn)
hFuzzy:
TraceOn:
Specifies whether to start or to stop a trace process for the Fuzzy instanse speci-
fied by hFuzzy. If this parameter is TRUE (1), the trace process is started. If this
parameter is FALSE (0), the trace process is stopped.
Return Value
Related Functions
FuzzyOpen
Example
See FuzzyOpen.
See Also
FuzzyTech Functions
441
442
Chapter: 34 Group Functions
Group functions manipulate groups of areas, alarm categories, and any other data that can
be accessed as a group. Use these functions to create a group dynamically to use for various
purposes; for example, to allow operators to change their areas, or to view alarms by cate-
gory, and so on.
Group Functions
Following are functions relating to groups of objects:
GrpClose Closes a group.
GrpDelete Deletes items from a group.
GrpFirst Gets the first item in a group.
GrpIn Tests if an item is in a group.
GrpInsert Inserts items into a group.
GrpMath Performs mathematical operations on groups.
GrpName Gets the name of a group from a group handle.
GrpNext Gets the next item in a group.
GrpOpen Opens a group.
GrpToStr Converts a group into a string
See Also
Functions Reference
GrpClose
Closes a group. The group is destroyed and the group handle becomes invalid. You should
close a group when it is not in use, to release the associated memory. CitectSCADA closes
all groups on shutdown.
Syntax
GrpClose(hGrp)
hGrp:
The group handle, returned from the GrpOpen() function. The group handle
identifies the table where all data on the associated group is stored.
Return Value
Related Functions
GrpOpen
Example
hGrp=GrpOpen("MyGrp",1);
..
443
GrpClose(hGrp);
See Also
Group Functions
GrpDelete
Deletes a single element or all elements from a group. You can also delete another group
from within the group.
Syntax
GrpDelete(hGrp, Value)
hGrp:
Value:
The element to delete from the group, from 0 to 16375.
 Set Value to -1 to delete all elements from the group.
 Set Value to a group handle to delete another group from this group.
Return Value
Related Functions
GrpInsert, GrpOpen
Example
! Delete 10 and 14 from a group.
GrpDelete(hGrp,10);
GrpDelete(hGrp,14);
See Also
Group Functions
GrpFirst
Gets the value of the first element in a group. The first element in the group is the element
with the lowest value. You can follow this function with a GrpNext() call, to get the value
of all the elements in a group.
Syntax
GrpFirst(hGrp)
hGrp:
444
Return Value
The value of the first element in a group or -1 if the group is empty.
Related Functions
GrpOpen, GrpNext
Example
Value=GrpFirst(hGrp);
IF Value<>-1 THEN
Prompt("First value is "+Value:###);
END
See Also
Group Functions
GrpIn
Determines if an element is in a group.
Syntax
GrpIn(hGrp, Value)
hGrp:
Value:
The element to locate, from 0 to 16375.
 Set Value to a group handle to check if another group exists in the group.
Return Value
1 if the element is in the group, otherwise 0 is returned.
Related Functions
GrpOpen, GrpInsert, GrpDelete
Example
IF GrpIn(hGrp,10) THEN
Prompt("Area 10 in this group");
END
See Also
Group Functions
GrpInsert
Adds an element (or another group) to a group.
445
Syntax
GrpInsert(hGrp, Value)
hGrp:
Value:
The element to add to the group, from 0 to 16375.
 Set Value to -1 to add all elements (0 to 16375) to the group.
 Set Value to a group handle to insert another group into the group.
Return Value
Related Functions
GrpOpen, GrpDelete, GrpIn
Example
! Add 10 and 14 to a group.
GrpInsert(hGrp,10);
GrpInsert(hGrp,14);
See Also
Group Functions
GrpMath
Performs mathematical operations on two groups, and stores the result in another group.
You can add the two groups, subtract one from the other, or perform Boolean AND, NOT,
and XOR operations on the two groups.
Syntax
GrpMath(hResult, hOne, hTwo, Type)
hResult:
The group number where the result is placed.
hOne:
Number of first group used in the mathematical operation.
hTwo:
Number of the second group used in the mathematical operation.
Type:
Type of mathematical operation:
0 - Add groups one and two.
1 - Subtract group two from group one.
2 - AND groups one and two.
3 - NOT groups one and two.
446
4 - XOR groups one and two.
Return Value
Related Functions
GrpOpen
Example
hOne=GrpOpen("Plantwide",0);
hTwo=GrpOpen("Section1",0);
hResult=GrpOpen("Result",0);
! Subtract Section1 from Plantwide and place in Result.
GrpMath(hResult,hOne,hTwo,1);
See Also
Group Functions
GrpName
Gets the name of a group from a group handle.
Syntax
GrpName(hGrp)
hGrp:
Return Value
The name of the group (as a string).
Related Functions
GrpOpen
Example
! Get the current group name.
sName=GrpName(hGrp);
See Also
Group Functions
GrpNext
Gets the value of the next element in a group. You can get the value of all the elements in a
group. Call the GrpFirst() function to get the value of the first element, and then call this
function in a loop.
447
Syntax
GrpNext(hGrp, Value)
hGrp:
Value:
The value returned from GrpFirst() or the latest GrpNext() call.
Return Value
The value of the next element in a group, or -1 if the end of the group has been found.
Related Functions
GrpFirst
Example
! Count all values in a group.
Count=0;
Value=GrpFirst(hGrp);
WHILE Value<>-1 DO
Count=Count+1;
Value=GrpNext(hGrp,Value);
END
Prompt("Number of values in group is "+Count:###);
See Also
Group Functions
GrpOpen
Creates a group and returns a group handle, or gets the group handle of an existing group.
After you open a group, you can use the group number in functions that use groups, for
example, SetArea() and AlarmSetInfo(). You can open a group that is specified in the
Groups database. You can also create groups at runtime.
When you open a group that is defined in the database, a copy of the group is made - the
original group is not used. You can therefore change the values in the group without affect-
ing other facilities that use this group.
Syntax
GrpOpen(Name, Mode)
Name
The name of the group to open.
Mode
0 - Open an existing group
1 - Create a new group
2 - Attempts to open an existing group. If the group does not exist, it will create it.
448
Return Value
The group handle , or -1 if the group cannot be created or opened. The group handle iden-
tifies the table where all data on the associated group is stored.
Related Functions
GrpClose
Example
! Open Plantwide group defined in the database.
hGrp=GrpOpen("Plantwide",0);
! Set current user area to Plantwide.
SetArea(hGrp);
GrpClose(hGrp);
! Set area to 1...10, 20 and 25 by creating a new group.
StrToGrp(hGrp,"1..10,20,25");
SetArea(hGrp);
GrpClose(hGrp);
See Also
Group Functions
GrpToStr
Converts a group into a string of values separated by " , " and " .. ". You can then display
the group on the screen or in a report.
Syntax
GrpToStr(hGrp)
hGrp:
Return Value
The group (as a string).
Related Functions
GrpOpen, StrToGrp
Example
! Display current areas.
hGrp=GetArea();
Str=GrpToStr(hGrp);
DspStr(21,"WhiteFont",Str);
See Also
Group Functions
449
450
Chapter: 35 I/O Device Functions
The I/O device functions allow you to read the values of variables in I/O devices such as
PLCs, and to write data into these I/O device variables. These functions also allow you to
control I/O devices and to display information about I/O devices.
I/O Device Functions

Following are functions relating to I/O Devices:
DriverInfo Provides information about the driver for a partic-
ular I/O Device.
IODeviceControl Provides control of individual I/O Devices.
IODeviceInfo Gets information on an I/O Device.
IODeviceStats Gets statistical information for all I/O Devices.
SubscriptionAddCallback Adds a callback function to a tag subscription.
SubscriptionGetAttribute Reads an attribute value of a tag subscription.
SubscriptionRemoveCallback Removes a callback function from a tag subscrip-
tion
See Also
Functions Reference
DriverInfo
Provides information about the driver for a specified I/O device. Select the device using the
IODevice argument, and the information to be returned using the Type argument.
This function can only be used if the I/O Server is on the current machine. When the I/O
Server is not in the calling process, this function will become blocking and cannot be called
from a foreground task. In this case, the return value will be undefined and a Cicode hard-
ware alarm will be raised.
Syntax
DriverInfo(IODevice, Type [, ClusterName] )
IODevice:
The name of the I/O device.
Type:
The type of information returned about the driver. Specify one of the following:
0 - Driver Name
1 - Driver Title
2 - Block constant
3 - Max Retrys
4 - Transmit Delay
5 - Receive Timeout
6 - Polltime
451
7 - Watchtime (milliseconds
Note: The DISKDRV driver name is returned as "Disk" instead of "DISKDRV". If the Poll-
time is set as "Interrupt", the function returns "0".
ClusterName:
Specifies the name of the cluster in which the I/O Server resides. This is optional
if you have one cluster or are resolving the I/O server via the current cluster con-
text. The argument is enclosed in quotation marks "".
Return Value
The driver information as a string. It is important to note that in the case of an error the
return value is an empty string.
Example
// Using the IODevice Number
sName = DriverInfo(20, 0); ! Get the name of the driver used with I/O device 20
sName = DriverInfo(2, 1); ! Get the title of the driver used with I/O device 2
// Using the IODevice Name
sName = DriverInfo("IODev",3); ! Get the Max Retrys value of the driver used with
IODev
sName = DriverInfo("IODev1",5); ! Get the Receive Timeout value of the driver used
with IODev1
See Also
IODeviceControl
Provides control of individual I/O devices. You might need to call this function several
times. If you use incompatible values for the various options of this function, you might get
unpredictable results.
This function can only be used if the I/O Server is on the current machine. When the I/O
Server is not in the calling process, this function will become blocking and cannot be called
from a foreground task. In this case, the return value will be undefined and a Cicode hard-
ware alarm will be raised.
Syntax
IODeviceControl(IODevice, Type, Data [, ClusterName] )
IODevice:
The number or name of the I/O device. If you call this function from an I/O server,
you can use the I/O device name. If you call this function from a client, you may
use either the I/O device number or name. To specify all I/O devices, use "*" (as-
terisk) or -1.
Type:
The type of control action:
0 - No longer supported.
1 - Enable/Disable the I/O device on the I/O server. All attempts to read and write
from the I/O device are ignored. (If another I/O device is configured as a
452
standby I/O server, CitectSCADA switches communications to that I/O de-

vice.) The I/O server does not attempt to communicate with the I/O device
until it is re-enabled. When the I/O device is re-enabled, the I/O server at-
tempts to re-establish communication immediately. Mode 1 can only be
called by the I/O Server which is associated with this device.
2 - No longer supported. An invalid argument error is returned if this option is
specified.
3 - No longer supported. An invalid argument error is returned if this option is
specified.
4 - All the data in the associated I/O device cache is flushed. This allows flushing
of all the data from the I/O device without waiting for the aging time. This
is useful when you have long cache time and you want to force a read from
the I/O device.
The Data value is ignored with this mode.
5 - (For scheduled and remote I/O devices). The I/O device is added to the bottom
of the list of I/O devices to be contacted. I/O devices already in the list (al-
ready waiting to be contacted) are given priority over this I/O device.
6 - (For scheduled and remote I/O devices). The I/O device is added to the top of
the list of I/O devices to be contacted; it is given high priority. If there are
already I/O devices at the top of the list with high priority, then this I/O de-
vice will be added to the list after them (that is it will be contacted after
them). For dial-up remote I/O devices, if the modem is already in use - con-
nected to another I/O device - this I/O device will not be dialled until that
connection has been terminated.
7 - (For scheduled and remote I/O devices). The I/O device is added to the top of
the list of I/O devices to be contacted, and it is given top priority. For dial-
up remote I/O devices, if the modem is currently connected to another I/O
device, the connection will be cancelled, and the top priority I/O device
will be dialled. It will also stay connected until manually disconnected
with another call to IODeviceControl().
Note: This mode will not attempt to disconnect any other persistent connections.
Persistent connections can only be disconnected using mode 8.
8 - (For scheduled and remote I/O devices). Disconnect an I/O device. Current re-
quests will be completed before the I/O device is disconnected.
9 - (For scheduled I/O devices). The communication schedule for the I/O device
is disabled. This is to prevent the I/O device from being contacted when its
scheduled dial-time occurs.
10 - (For scheduled I/O devices). Puts the I/O device into Write On Request mode.
That is, as soon as a write request is made, the I/O device will be added to
the list of I/O devices to be contacted. It is given priority over existing read
requests, but not over existing write requests.
In this situation, there will be a delay while the I/O device is contacted. Do not
mistake this pause for inactivity (for example, do not continually execute a
command during this delay).
11 - Change the I/O device cache timeout. If the I/O Server is restarted, the cache
timeout will return to its original value. (For scheduled I/O devices, this
value can be checked using the Kernel Page Unit command. For all other I/
453
O devices, this value is configured in the Cache Time field at the I/O Devic-
es Properties form.)
12 - The time of day at which to add the I/O device to the list of I/O devices to be
contacted. Set the time in Data in seconds from midnight (for example,
specify 6 p.m. as 18 * 60 * 60). Use Type 12 to specify a one-timecommuni-
cation.
13 - The communication period (the time between successive communication at-
tempts). The value you specify represents different periods, depending on
what type of schedule you are using (that is daily, weekly, monthly, or
yearly. This is set using Type 15.). You can choose to specify the communi-
cation period either in seconds from midnight, day of week (0 to 6,
Sunday = 0), month (1 to 12), or year. Enter the value in Data. For example,
if your schedule is weekly, and you set Data = 3, you are specifying each
Wednesday. If your schedule is monthly, Data = 3 indicates March. For dai-
ly communication, set the period in Data in seconds from midnight; for ex-
ample, set Data to 6 * 60 * 60 to contact the I/O device every 6 hours.
14 - The time at which the I/O Server will first attempt to communicate with the
I/O device. Set the time in Data in seconds from midnight, for example, to
synchronize at 10a.m., set Data to 10 * 60 * 60.
15 - Type of schedule. Set Data to one of the following:
 1 - Daily
 2 - Weekly
 3 - Monthly
 4 - Yearly
16 - (For remote I/O devices) Read all tags from the I/O device. Data is unused -
set it to 0 (zero).
Data:
Data for the control operation*:
1 - Disable the I/O device (Disable Write On Request mode for Type 10)
0 - Enable the I/O device (Enable Write On Request mode for Type 10) or the I/O
device name (for Type 2 or 3).
* For Type 5-8, Data is ignored; enter 0 (zero).
ClusterName:
Return Value
Related Functions
IODeviceInfo, IODeviceStats, TagRead, TagWrite
Example
IODeviceControl(4, 1, 1); ! Disable I/O device 4
454
See Also
IODeviceInfo
Gets information about a specified I/O device.
Apart from when Type is set to 3 or 17, this function can only be used if the I/O Server is on
the current machine, otherwise the function will not succeed and will return empty string.
When the I/O Server is not in the calling process, this function will become blocking and
If both the primary and standby I/O devices are on the same server and they have the same
I/O device name, you can get information about them individually by specifying the fol-
lowing:
IODeviceInfo("PLC1,P",1); // for the Primary
IODeviceInfo("PLC1,S",1); // for the Standby
where P represents the primary I/O device and S the standby I/O device.
If you have more than one standby device on the same server, there is currently no way of
using this function for other than the first standby device.
Note: When the I/O server is not in the calling process, this function could become a block-
ing function if the information required by this function is on an I/O server (except types 3
and 17, which are normally non-blocking). If this is the case, this function cannot be called
from a foreground task (such as a graphics page) or an expression. Otherwise the return
value will be undefined and a Cicode hardware alarm raised.
Syntax
IODeviceInfo(IODevice, Type [, ClusterName] )
IODevice:
The I/O device number, or the I/O device name enclosed in double quotes.
Type:
The type of information:
0 - Name of I/O device
1 - Protocol of I/O device
2 - Protocol address
3 - Client I/O device state
 1 = Running - Client is either talking to an online I/O device or talking to a
scheduled device that is not currently connected but has a valid cache
 2 = Standby - Client is talking to an online standby I/O device
 4 = Starting - Client is talking to an I/O device that is attempting to come
online
 8 = Stopping - Client is talking to an I/O device that is in the process of stop-
ping
 16 = Offline - Client is pointing to an I/O device that is currently offline
 32 = Disabled - Client is pointing to a device that is disabled
455
 66 = Standby write - client is talking to an I/O device configured as a stand-

by write device
4 - Current generic error number (decimal)
5 - Current driver error number (decimal)
6 - Disabled flag
7 - Statistics, minimum read time
8 - Statistics, maximum read time
9 - Statistics, average read time
10 - I/O server I/O device state
 1 = Running - I/O device for this I/O server is online or a scheduled device
that is not currently connected but has a valid cache
 2 = Standby - I/O device for this I/O server is online and a standby unit
 4 = Starting - I/O device for this I/O server is attempting to come online.
Starting may be combined with either Offline or Remote such as: 20 = Start-
ing(4) + Offline(16) or 132 = Starting(4) + Remote(128).
 8 = Stopping - I/O device for this I/O server is currently in the process of
stopping
 16 = Offline (only valid on an I/O server) - I/O device for this I/O server is
currently offline
 32 = Disabled - I/O device for this I/O server is disabled
 66 = Standby write - I/O device for this I/O server is configured as a standby
write device
 128 = Remote (never returned by itself - see Starting - I/O device for this I/
O server is a scheduled device but not currently connected
11 - Unit number
12 - Configured I/O server name
13 - Configured Port name
14 - Configured startup mode
15 - Configured comment
16 - The primary I/O server name the client uses to communicate to this device
17 - The I/O Server the client is using to communicate to this device. Will be
Standby if the Primary is down.
18 - State of the remote unit:
 0 = Remote unit is disconnected and OK
 1 = Remote unit is connected and online
 2 = Remote unit is in the dial queue
 16 = Remote unit is disconnected and offline
 32 = Remote unit is disconnected and disabled
This mode causes redirection to the I/O server if running in separate processes.
19 - Number of successful attempts to communicate with the scheduled I/O de-
vice.
20 - Number of unsuccessful attempts to communicate with the scheduled I/O de-
vice.
21 - Write mode: Write On Request, and normal (as per schedule defined in the
Express Communications Wizard).
456
22 - Number of queued read requests for the scheduled I/O device. (This mode
causes redirection to the I/O server if running in separate processes.)
23 - Number of queued write requests for the scheduled I/O device. (This mode
causes redirection to the I/O server if running in separate processes.)
24 - The cache timeout (in milliseconds).
26 - The name of the line device (for example, modem) you are using to connect
to the I/O device. (This mode causes redirection to the I/O server if running
in separate processes.)
27 - The call_status of a currently connected remote I/O device.
DIALCALLSTATE_UNAVAIL 0
DIALCALLSTATE_IDLE 1
DIALCALLSTATE_OFFERING 2
DIALCALLSTATE_ACCEPTED 3
DIALCALLSTATE_DIALTONE 4
DIALCALLSTATE_DIALING 5
DIALCALLSTATE_RINGBACK 6
DIALCALLSTATE_BUSY 7
DIALCALLSTATE_SPECIALINFO 8
DIALCALLSTATE_CONNECTED 9
DIALCALLSTATE_PROCEEDING 10
DIALCALLSTATE_ONHOLD 11
DIALCALLSTATE_CONFERENCED 12
DIALCALLSTATE_ONHOLDPENDCONF 13
DIALCALLSTATE_ONHOLDPENDTRANSFER 14
DIALCALLSTATE_DISCONNECTED_NORMAL 16
DIALCALLSTATE_DISCONNECTED_LINELOST 17
DIALCALLSTATE_DISCONNECTED_UNKNOWN 18
DIALCALLSTATE_DISCONNECTED_REJECT 19
DIALCALLSTATE_DISCONNECTED_PICKUP 20
DIALCALLSTATE_DISCONNECTED_FORWARDED 21
DIALCALLSTATE_DISCONNECTED_BUSY 22
DIALCALLSTATE_DISCONNECTED_NOANSWER 23
DIALCALLSTATE_DISCONNECTED_BADADDRESS 24
DIALCALLSTATE_DISCONNECTED_UNREACHABLE 25
DIALCALLSTATE_DISCONNECTED_CONGESTION 26
DIALCALLSTATE_DISCONNECTED_INCOMPATIBLE 27
DIALCALLSTATE_DISCONNECTED_UNAVAIL 28
DIALCALLSTATE_DISCONNECTED_NODIALTONE 29
DIALCALLSTATE_DISCONNECTED_NUMBERCHANGED 30
DIALCALLSTATE_DISCONNECTED_OUTOFORDER 31
DIALCALLSTATE_DISCONNECTED_TEMPFAILURE 32
DIALCALLSTATE_DISCONNECTED_QOSUNAVAIL 33
DIALCALLSTATE_DISCONNECTED_BLOCKED 34
DIALCALLSTATE_DISCONNECTED_DONOTDISTURB 35
457
DIALCALLSTATE_DISCONNECTED_CANCELLED 36
DIALCALLSTATE_UNKNOWN 48
(This mode causes redirection to the I/O server if running in separate processes.)
28 - The call rate (in bits per second) which may be the DTE or DCE connection
speed depending on the server modem settings. (This mode causes redi-
rection to the I/O server if running in separate processes.)
ClusterName:
Return Value
The type of information (as a string).
Related Functions
IODeviceControl, IODeviceStats, TagRead, TagWrite
Example
//Using the IODevice Number
sName = IODeviceInfo(20, 0); ! Get the name of I/O device 20
sName = IODeviceInfo(2, 1); ! Get the protocol of I/O device 2
//Using the IODevice Name
sName = IODeviceInfo("IODev",10); ! Get the I/O Server State
sName = IODeviceInfo("IODev1",3); ! Get the State of IODev1
See Also
IODeviceStats
Gets statistical information for all I/O devices, and displays the information in a dialog box.
Note: In a multi-process environment this function must be called from the IOServer pro-
cess or redirected there using MsgRPC. If this isn’t done, some of the information on the
IODeviceStats form will not be displayed correctly.
Syntax
IODeviceStats()
Return Value
Related Functions
IODeviceInfo
458
Example
IODeviceStats(); ! display all I/O device information
See Also
SubscriptionAddCallback
Adds a function callback to a tag subscription. When the value change for a subscribed tag
is detected, a callback function can be called. This implements change based Cicode and
avoids continuously polling a tag value to monitor changes.
Multiple callbacks are possible to the same subscription.
To remove a callback from a subscription use the SubscriptionRemoveCallback function.
Syntax
SubscriptionAddCallback(iHandle, sCallback)
iHandle
Integer handle of the subscription to add a callback to.
sCallback
String stating the name of a function to call when the value is updated. The func-
tion should have the structure:
FUNCTION evtHandler(INT subsHandle)
..
End
Where subsHandle is the subscription that raised the event.
Return Value
Related Functions
TagSubscribe, TagUnsubscribe, SubscriptionGetAttribute, SubscriptionRemoveCallback
See Also
SubscriptionGetAttribute
Reads the specified attribute value of a subscribed tag. Similar to TagRead.
Syntax
SubscriptionGetAttribute(iHandle, sAttribute [, iOffset] )
iHandle
Integer handle of the subscription to read from.
sAttribute
459
Attribute of the tag to read. Supported Attributes are:

 ClusterName - Return the cluster context of the subscription. For example, for
the tag subscribed as "cluster1.tagname", return value is "cluster1". If the tag
was subscribed without a cluster the return value will be an empty string.
 FullName - Return the full subscription name. For example, for the tag sub-
scribed as "cluster1.tagname", return value is "cluster1.tagname". If the tag
was subscribed without a cluster the return value will be the tagname.
 TagName - Return the tagname for the subscription. For example, for the tag
subscribed as "cluster1.tagname", return value is "tagname".
 Value - The current value of the tag.
 ValueQuality - The current quality of the tag.
 ValueTimestamp - The timestamp when the tag last changed.
 ValueTimestampMS - The timestamp in milliseconds when the tag last
changed.
iOffset
Optional integer expressing the zero based index of an array attribute. This is
only valid for the Value attribute. Default value is 0.
Return Value
String representation of the cached value for a subscribed tag. On error, an empty string
and an error is set.
Related Functions
TagSubscribe, TagUnsubscribe, SubscriptionAddCallback, SubscriptionRemoveCallback
See Also
SubscriptionRemoveCallback
Removes a function callback from a tag subscription. The subscription handle and callback
function must match those used when adding the callback.
Syntax
SubscriptionRemoveCallback(iHandle, sCallback)
iHandle
Integer handle of the subscription of the callback.
sCallback
String stating the name of the callback function.
Return Value
Related Functions
TagSubscribe, TagUnsubscribe, SubscriptionAddCallback, SubscriptionGetAttribute
See Also
460
Chapter: 36 Keyboard Functions
Keyboard functions control the processing of keyboard entries, including the movement of
the keyboard cursor and manipulation of keyboard commands.
Keyboard Functions
Following are functions relating to the keyboard:
KeyAllowCursor Allows the command cursor to move to any AN or only to ANs that
have commands defined.
KeyBs Deletes the last character from the key command line.
KeyDown Moves the command cursor down.
KeyGet Gets the raw key code from the key command line.
KeyGetCursor Gets the AN where the cursor is positioned.
KeyLeft Moves the command cursor left.
KeyMove Moves the command cursor in the requested direction.
KeyPeek Gets a key from the key command line without removing the key.
KeyPut Puts a raw key code into the key command line.
KeyPutStr Puts a string into the key command line.
KeyReplay Replays the last key sequence.
KeyReplayAll Replays and executes the last key sequence.
KeyRight Moves the command cursor right.
KeySetCursor Moves the command cursor to a specified AN.
KeySetSeq Adds a keyboard sequence at runtime.
KeyUp Moves the command cursor up.
SendKeys Sends a keystroke (or string of keystrokes) to a window.
See Also
Functions Reference
KeyAllowCursor
Allows (or disallows) the command cursor to move to the specified AN or to all ANs. The
command cursor normally moves only to ANs that have commands defined.
Syntax
KeyAllowCursor(AN, State)
AN:
The AN where the command cursor can move. If 0, all ANs are implied.
State:
Allow state:
0 - Do not allow the cursor to move to this AN.
1 - Allow the cursor to move to this AN.
461
Return Value
Related Functions
KeyGetCursor
Example
KeyAllowCursor(20,1);
! Allows the command cursor to move to AN20.
KeyAllowCursor(0,1);
! Allows the command cursor to move to any AN.
See Also
Keyboard Functions
KeyBs
Removes the last key from the key command line. If the key command line is empty, this
function will not perform any action.
You should call this function using a "Hot Key" command (as shown in the example below),
otherwise the backspace character is placed into the key command line and the command
does not execute. A "Hot Key" command is a command that executes as soon as it is placed
into the key command line.
Syntax
KeyBs()
Return Value
Related Functions
KeyGet
Example
System Keyboard
Key Sequence *Bs
Command KeyBs()
Comment Define a backspace Hot Key
(*) represents a HotKey command)

/* If "START A B C" is in the key command line and "START" is
the Key Name for the "F1" key: */
KeyBs();
! Removes ASCII "C".
KeyBs();
! Removes ASCII "B".
KeyBs();
! Removes ASCII "A".
462
KeyBs();
! Removes Key_F1.
KeyBs();
! Performs no action.
See Also
Keyboard Functions
KeyDown
Moves the command cursor down the page to the closest AN. If an AN-Down cursor over-
ride is specified (in the Page Keyboard database) for the graphics page, the command cur-
sor moves to that AN instead.
Syntax
KeyDown()
Return Value
Related Functions
KeyUp, KeyLeft, KeyRight, KeyMove
Example
See KeyDown.
See Also
Keyboard Functions
KeyGet
Gets the last key code from the key command line. The key is removed from the command
line. Use this function to process the operator key commands directly. You should call this
function from the keyboard event function.
Syntax
KeyGet()
Return Value
The last key code from the key command line. If the key command line is empty, 0 (zero)
is returned.
Related Functions
KeyPeek, KeyPut
Example
/* If "START A B C" is in the key command line and "START" is
the Key Name for the "F1" key: */
463
Variable=KeyGet();
! Sets Variable to 67 (ASCII "C").
Variable=KeyGet();
! Sets Variable to 66 (ASCII "B").
Variable=KeyGet();
! Sets Variable to 65 (ASCII "A").
Variable=KeyGet();
! Sets Variable to 170 (the ASCII value of the F1 key (Key_F1)).
Variable=KeyGet();
! Sets Variable to 0.
See Also
Keyboard Functions
KeyGetCursor
Gets the AN at the position of the command cursor. If you are using groups, and there are
currently two command cursors, the AN for the innermost will be returned. For example,
if there is a cursor for a group as well as a cursor for one of its objects, the AN for the object
will be returned.
Syntax
KeyGetCursor()
Return Value
The AN at the position of the command cursor. If no cursor is visible, -1 is returned.
Related Functions
KeySetCursor
Example
! If the command cursor is on AN25:
AN=KeyGetCursor();
! Sets AN to 25.
See Also
Keyboard Functions
KeyLeft
Moves the command cursor left (across the page) to the closest AN. If an AN-Left cursor
override is specified (in the Page Keyboard database) for the graphics page, the command
cursor moves to that AN instead.
Syntax
KeyLeft()
464
Return Value
Related Functions
KeyRight, KeyUp, KeyDown, KeyMove
Example
See KeyRight
See Also
Keyboard Functions
KeyMove
Moves the command cursor in a specified direction to the closest AN. If an AN cursor over-
ride is specified, the command cursor moves to that AN directly. This function is equiva-
lent to the KeyUp(), KeyDown(), KeyLeft(), and KeyRight() functions.
Syntax
KeyMove(Direction)
Direction:
Direction to move the cursor:
0 - Do not move
1 - Left
2 - Right
3 - Up
4 - Down
Return Value
Related Functions
KeyUp, KeyDown, KeyLeft, KeyRight
Example
KeyMove(1);
! Moves the cursor left.
See Also
Keyboard Functions
KeyPeek
Gets the ascii key code from the key command line (at a specified offset), without removing
the key from the key command line. An offset of 0 returns the key code from the last posi-
tion in the key command line.
465
Syntax
KeyPeek(Offset)
Offset:
The offset from the end of the key command line
Return Value
The ASCII key code.
Related Functions
KeyGet
Example
! If "A B C" is in the key command line:
Variable=KeyPeek(0);
! Sets Variable to 67 (ASCII "C")
Variable=KeyPeek(2);
! Sets Variable to 65 (ASCII "A")
See Also
Keyboard Functions
KeyPut
Puts an ASCII key code or Keyboard key code into the last position of the key command
line. If this key completes any command, that command will execute.
Syntax
KeyPut(KeyCode)
KeyCode:
The key code to put into the key command line.
Return Value
Related Functions
KeyGet
Example
KeyPut(Key_F1);
/* Puts "Key_F1" (the Key Code for the "F1" key) into the last
position of the key command line. If "START" is the Key Name for
the "F1" key, this would be equivalent to
KeyPutStr("START"). In either case, "START" will display on the
key command line. */
KeyPut(StrToChar("A"));
/* Puts the Key Code for the "A" key into the last position of the
key command line. */
466
See Also
Keyboard Functions
KeyPutStr
Puts a string at the end of the key command line. The string can contain either key names
or data characters. If this string completes any command, that command will execute.
Syntax
KeyPutStr(String)
String:
The string to put into the key command line.
Return Value
Related Functions
KeyPut
Example
KeyPutStr("START ABC");
! Places "START ABC" at the end of the key command line.
KeyPutStr("TURN PUMP 1 ON");
! Places "TURN PUMP 1 ON" at the end of the key command line.
See Also
Keyboard Functions
KeyReplay
Replays the last key sequence (except for the last key, which would execute the command).
This function is useful when a command is to be repeated. To call this function from the
keyboard, use a Hot Key "*" (asterisk) command, otherwise the KeyReplay() function itself
is replayed.
Syntax
KeyReplay(sub)
sub:
Number of characters to subtract before replay. Default value is 1.
Return Value
467
Related Functions
KeyReplayAll
Example
If the previous contents of the key command line were:
"START ABC ENTER"
KeyReplay();
! Replays "START ABC".
See Also
Keyboard Functions
KeyReplayAll
Replays the last key sequence and executes the command. To call this function from the
keyboard, use a Hot Key " * " (asterisk) command, otherwise the KeyReplayAll() function
itself is replayed.
Syntax
KeyReplayAll()
Return Value
Related Functions
KeyReplay
Example
If the previous contents of the key command line were:
"START ABC ENTER"
KeyReplayAll();
! Replays "START ABC ENTER" and executes the command.
See Also
Keyboard Functions
KeyRight
Moves the command cursor right (across the page) to the closest AN. If an AN-Right cursor
override is specified (in the Page Keyboard database) for the graphics page, the command
cursor moves to that AN instead.
Syntax
KeyRight()
468
Return Value
Related Functions
KeyUp, KeyDown, KeyLeft, KeyMove
Example
See KeyLeft
See Also
Keyboard Functions
KeySetCursor
Displays the command cursor at a specified AN. A keyboard command must exist, or you
must first call the KeyAllowCursor() function (at the AN) to allow the cursor to move to the
AN. If the AN does not exist, or if a command does not exist at that AN, or if KeyAllowCur-
sor() has not been called, the command cursor does not move.
Syntax
KeySetCursor(AN)
AN:
The AN where the command cursor will be displayed.
Return Value
If the AN does not exist, or if a command does not exist at that AN, or if KeyAllowCursor()
has not been called, the return value is 1. Otherwise, the function will return 0.
Related Functions
KeyGetCursor, KeyAllowCursor
Example
! Move the command cursor to AN20.
KeySetCursor(20);
See Also
Keyboard Functions
KeySetSeq
Adds a keyboard sequence to the current page at runtime. The key sequence is only added
to the current window. When the page is closed, the keyboard sequence is deleted.
Syntax
KeySetSeq(sKeySeq, AN, Fn)
sKeySeq:
469
The keyboard sequence.

AN:
The AN where the keyboard sequence will apply. If you set AN to 0 (zero), the
keyboard sequence will apply to all ANs on the page.
Fn:
The function to call when the keyboard sequence matches. This function must be
a callback function.
Return Value
Related Functions
DspButton, DspButtonFn
Example
/* Set the key sequence and call the "Callback" function when the
sequence is found. */
KeySetSeq("F2 ### Enter", 0, Callback);
! This function is called when the key sequence is found.
INT
FUNCTION CallBack()
INT Value;
! Get user data.
Value=Arg1;
..
RETURN 0;
END
See Also
Keyboard Functions
KeyUp
Moves the command cursor up the page to the closest AN. If an AN-Up cursor override is
specified (in the Page Keyboard database) for the graphics page, the command cursor
moves to that AN.
Syntax
KeyUp()
Return Value
KeyDown, KeyLeft, KeyRight, KeyMove
Example
See KeyUp.
470
See Also
Keyboard Functions
SendKeys
Sends a keystroke (or string of keystrokes) to a window as if they were typed on the key-
board. The window receives input focus and is brought to the foreground.
Syntax
SendKeys(sTitle, sKeys)
sTitle:
The title (caption) of the destination window.
sKeys:
The key (or keys) to send to sTitle.
 To send a single keyboard character, use the character itself. For example, to
send the letter a, set sKeys to a. To send more than one character, append each
additional character to the string. For example, to send the letters a, b, and c,
set sKeys to abc.
 The plus (+), caret (^), and percent sign (%) have special meanings. To send
one of these special characters, enclose the character with braces. For example,
to send the plus sign, use {+}. To send a { character or a } character, use {{} and
{}}, respectively.
 To specify characters that are not displayed when you press a key (such as En-
ter or Tab) and other keys that represent actions rather than characters, use
the codes shown below:
Key Code
Backspace {backspace} or {bs} or{bksp}
Break {break}
Caps Lock {capslock}
Clear {clear}
Del {delete} or {del}
End {end}
Enter {enter} or ~
Esc {escape} or {esc}
Help {help}
Home {home}
Insert {insert}
Num Lock {numlock}
Page Down {pgdn}
Page Up {pgup}
Print Screen {prtsc}
Scroll Lock {scrolllock}
Tab {tab}
Up Arrow {up}
Down Arrow {down}
Right Arrow {right}
471
Left Arrow {left}

F1 {f1}
F2 {f2}
F3 {f3}
F4 {f4}
F5 {f5}
F6 {f6}
F7 {f7}
F8 {f8}
F9 {f9}
F10 {f10}
F11 {f11}
F12 {f12}
 To specify keys combined with any combination of Shift, Ctrl, and Alt, pre-
cede the regular key code with one or more of these codes:
Key Code
Shift +
Ctrl ^
Alt %
To specify that Shift, Ctrl, and/or Alt are held down while several keys are
pressed, enclose the keys in parentheses. For example, to hold down the Shift key
while sending E then C, use +(EC). To hold down Shift while sending E, followed
by C without the Shift key, use +EC. To specify repeating keys, use the form {key
number}. For example, {left 42} means send the left arrow key 42 times. Note that
you must leave a space between the key and number.
Return Value
Related Functions
WndFind
Example
SendKeys("Untitled - Notepad", "abc");
// Send the key sequence "abc" to the Notepad application
See Also
Keyboard Functions
472
Chapter: 37 Mail Functions
The mail facility enables you to send data (for example, a report) between CitectSCADA us-
ers (or any other computer). CitectSCADA can send mail automatically, triggered by an
event such as a report or an alarm. It can also read mail, so any user on the system can send
mail to CitectSCADA (for example, a batch recipe).
You can use the mail facility to send information from CitectSCADA to Managers, Super-
visors or anyone on a LAN or WAN whether they are running CitectSCADA or not. You
can use it to send mail directly to these people whenever an event occurs (for example, you
can mail reports directly to the QA department when they are scheduled, or send mail to
the maintenance department when equipment is due for service).
The mail system uses the MAPI standard interface, so you can use any mail system that
supports this standard. The mail system allows data transfer across different computer
platforms and to remote sites (using a data gateway), enabling you to send high-level data
across a wide area network.
Mail Functions
Following are functions relating to sending or receiveing mail:
MailError Gets the last mail error code
MailLogoff Logoff from the mail system
MailLogon Logon to the mail system
MailRead Reads a standard mail message
MailSend Sends a standard mail message
See Also
Functions Reference
MailError
Gets the last mail error code. The error code is extracted from the MAPI mail system, and
explains what caused the MAPI error.
Syntax
MailError()
Return Value
0 (zero) if successful, otherwise an error is returned. Refer also to MAPI errors.
Related Functions
MailLogon, MailLogoff, MailSend, MailRead
Example
! Logon to the mail system
IF MailLogon("RodgerG", "password", 0) THEN
error = MailError();
473
!do what is required

END
See Also
Mail Functions
MailLogoff
Logs off from the mail system. You should log off the mail system when all mail operations
are complete. CitectSCADA automatically logs off the mail system on shutdown.
Syntax
MailLogoff()
Return Value
Related Functions
MailLogon, MailSend, MailRead
Example
! Send the report to Rodger
MailLogon("Andrew", "password", 0);
MailSend("Rodger Gaff", "Report", "This is the weekly report",
"[data]:weekly.txt", 0);
MailLogoff();
See Also
Mail Functions
MailLogon
Logs on to the mail system. You must call this function before any other mail function.
The mail system uses the MAPI standard interface, so you can use any mail system that
supports this standard.
You should log on to the mail system when CitectSCADA starts, and log off only at shut-
down. (The logon procedure can take a few seconds to complete.) You can only log on as
one user at a time for each computer, so you can only read mail for this user name.
Syntax
MailLogon(sName, sPassword, iMode)
sName:
The name of the mail user. This name is the user’s mail box name (the unique
shorthand name, not the full user’s name).
sPassword:
The password of the mail user.
474
iMode:
The mode of the logon:
0 - Normal logon.
2 - Get unique logon, do not share existing mail client logon.
Return Value
Related Functions
MailLogoff, MailSend, MailRead, MailError
Example
! Send the report to James
MailLogon("RodgerG", "password", 0);
MailSend("James Glover", "Report", "This is the weekly report",
"[data]:weekly.txt", 0);
MailLogoff();
See Also
Mail Functions
MailRead
Reads a standard mail message. The mail message can contain text, an attached file, or both.
Before you can use this function, you must use the MailLogon() function to log on to the
mail system. You can only read mail sent to the user name specified in the MailLogon()
function.
Syntax
MailRead(sName, sSubject, sNote, sFileName, iMode)
sName:
The name of the mail user who sent the message.
sSubject:
The subject text of the mail message.
sNote:
The note section of the message. If the message is longer than 255 characters, Ci-
tectSCADA will save the message in a file and return the file name in sNote. Use
the file functions to read the message. The name of the file will be in the form
CTxxxxx where x is a unique number. You must delete the file after you have fin-
ished with the mail message.
sFileName:
The name of any attached file. If there is no attached file in the message, specify
sFileName as an empty string "".
iMode:
The mode of the read:
475
0 - Read a message. If no message is available, wait for a message.

1 - Read a message. If no message is available, return with an error code.
Return Value
Related Functions
MailLogon, MailLogoff, MailSend, MailError
Example
MailLogon("RodgerG", "password", 0);
! Read a message. Don’t wait if no message
IF MailRead(sName, sSubject, sNote, sFileName, 1) = 0 THEN
! got message now do something with it
END
WHILE TRUE DO
! wait for a mail message
MailRead(sName, sSubject, sNote, sFileName, 0);
END;
MailLogoff();
See Also
Mail Functions
MailSend
Sends a standard mail message. The mail message can contain text, an attached file, or both.
Before you can use this function, you must use the MailLogon() function to log on to the
mail system. You can only send mail from the user name specified in the MailLogon() func-
tion. You can send mail to any mail user or to another Citect client.
Syntax
MailSend(sName, sSubject, sNote, sFileName, iMode)
sName:
The name of the mail user who will receive the message. This name is the user’s
full name (not their mailbox name).
sSubject:
The subject text of the mail message (a short description of what the message is
about).
sNote:
The note section of the message (the main section of the message text). You can
enter up to 255 characters, or a file name for longer messages. If you enter a file
name, set iMode to 1.
sFileName:
The name of any attached file. If there is no attached file in the message, set sFile-
Name to an empty string "".
476
iMode:
The mode of the send:
0 - Normal mail message.
1 - The sNote argument is the name of a text file to send as the note.
Return Value
Related Functions
MailLogon, MailLogoff, MailRead, MailError
Example
MailLogon("Wombat", "password", 0);
! send the report to Andrew
MailSend("Andrew Bennet", "Report", "Attached is the weekly report", "[data]:week-
ly.txt", 0);
! send hello message to JR
MailSend("Jack Russell", "Hello", "You’ve only got yourself to blame!", "", 0);
! send a big note to Nigel
MailSend("Nigel Colless", "Big Message", "[data]:message.txt", "", 1);
MailLogoff();
See Also
Mail Functions
477
478
Chapter: 38 Math and Trigonometry Functions
The following functions allow you to perform mathematical calculations in your Cicode
files.
Math/Trigonometry Functions
Following are mathematical or trigonometrical functions:
Abs Gets the absolute value of a number.
ArcCos Gets the arccosine of an angle.
ArcSin Gets the arcsine of an angle.
ArcTan Gets the arctangent of an angle.
Cos Gets the cosine of an angle.
DegToRad Converts an angle from degrees to radians.
Exp Raises e to the power of a number.
Fact Gets the factorial of a number.
HighByte Gets the high-order byte of a two-byte integer.
HighWord Gets the high-order word of a four-byte integer.
Ln Gets the natural logarithm of a number.
Log Gets the base 10 logarithm of a number.
LowByte Gets the low-order byte of a two-byte integer.
LowWord Gets the low-order word of a four-byte integer.
Max Gets the higher of two numbers.
Min Gets the lower of two numbers.
Pi Gets the value of pi.
Pow Raises a number to the power of another number.
RadToDeg Converts an angle from radians to degrees.
Rand Gets a random number.
Round Rounds a number.
Sign Gets the sign of a number.
Sin Gets the sine of an angle.
Sqrt Gets the square root of a number.
Tan Gets the tangent of an angle.
See Also
Functions Reference
Abs
Calculates the absolute (positive) value of a number. The absolute value of a number is the
number without its sign.
Syntax
Abs(Number)
479
Number:
Any number.
Return Value
The absolute (positive) value of Number.
Related Functions
Sign
Example
Variable=Abs(-67);
Variable=Abs(67);
See Also
ArcCos
Calculates the arccosine of an angle.
Syntax
ArcCos(Number)
Number
The cosine of the angle.
Return Value
The arccosine (the angle, in radians) of Number.
Related Functions
Cos
Example
Variable=ArcCos(0.4);
! Sets Variable to 1.1592...
See Also
ArcSin
Calculates the arcsine of an angle.
Syntax
ArcSin(Number)
480
Number:
The sine of the angle.
Return Value
The arcsine (the angle, in radians) of Number.
Related Functions
Sin
Example
Variable=ArcSin(1);
See Also
ArcTan
Calculates the arctangent of an angle.
Syntax
ArcTan(Number)
Number:
The tangent of the angle.
Return Value
The arctangent (the angle, in radians) of Number.
Related Functions
Tan
Example
Variable=ArcTan(0.4);
See Also
Cos
Calculates the trigonometric cosine of an angle.
Syntax
Cos(Angle)
Angle:
481
Any angle (in radians).
Return Value
The cosine of Angle.
Related Functions
ArcCos
Example
Variable=Cos(0.7854);
See Also
DegToRad
Converts an angle from degrees to radians.
Syntax
DegToRad(Angle)
Angle:
Any angle (in degrees).
Return Value
The angle in radians.
Related Functions
RadToDeg
Example
Variable=DegToRad(180);
! Sets Variable to 3.1415... (pi).
See Also
Exp
Calculates the exponential of a number (natural logarithm base e).
Syntax
Exp(Number)
Number:
Any number.
482
Return Value
The exponential of Number (to the base e).
Related Functions
Log
Example
Variable=Exp(1);
See Also
Fact
Calculates the factorial of a number.
Syntax
Fact(Number)
Number:
Any number.
Return Value
The factorial of Number.
Example
Variable=Fact(6);
! Sets Variable to 720 (that is 720=1x2x3x4x5x6).
See Also
HighByte
Gets the high-order byte of a two-byte integer.
Syntax
HighByte(TwoByteInteger)
TwoByteInteger:
A two-byte integer.
Return Value
The high-order byte (that is | X | - |)
483
Related Functions
LowByte, HighWord, LowWord
Example
Variable=HighByte(0x5678);
! Sets Variable to 0x56.
See Also
HighWord
Gets the high-order word of a four-byte integer.
Syntax
HighWord(FourByteInteger)
FourByteInteger:
A four-byte integer.
Return Value
The high-order word (that is | X | X | - | - |)
Related Functions
LowWord, HighByte, LowByte
Example
Variable=HighWord(0x12345678);
See Also
Ln
Calculates the natural (base e) logarithm of a number.
Syntax
Ln(Number)
Number:
Any number.
Return Value
The natural (base e) logarithm of Number.
484
Related Functions
Log
Example
Variable=Ln(2);
See Also
Log
Calculates the base 10 logarithm of a number.
Syntax
Log(Number)
Number:
Any number.
Return Value
The base 10 logarithm of Number.
Related Functions
Ln
Example
Variable=Log(100);
! Sets Variable to 2 (that is 100=10 to the power of 2).
See Also
LowByte
Gets the low-order byte of a two-byte integer.
Syntax
LowByte(TwoByteInteger)
TwoByteInteger:
A two-byte integer.
Return Value
The low-order byte (that is | - | X |)
485
Related Functions
HighByte, LowWord, HighWord
Example
Variable=LowByte(0x5678);
See Also
LowWord
Gets the low-order word of a four-byte integer.
Syntax
LowWord(FourByteInteger)
FourByteInteger:
A four-byte integer.
Return Value
The low-order word (that is | - | - | X | X |)
Related Functions
HighByte, LowByte, HighWord
Example
Variable=LowWord(0x12345678);
! Sets Variable to 0x5678
See Also
Max
Gets the higher of two numbers.
Syntax
Max(Number1, Number2)
Number1:
The first number.
Number2:
The second number.
486
Return Value
The higher of numbers Number1 and Number2.
Related Functions
Min
Example
Variable=Max(24,12);
See Also
Min
Returns the lower of two numbers.
Syntax
Min(Number1, Number2)
Number1:
The first number.
Number2:
The second number.
Return Value
The lower of numbers Number1 and Number2.
Related Functions
Max
Example
Variable=Min(24,12);
See Also
Pi
Gets the value of pi (the ratio of the circumference of a circle to its diameter).
Syntax
Pi()
487
Return Value
The value of pi.
Example
Variable=Pi();
See Also
Pow
Calculates x to the power of y.
Syntax
Pow(X, Y)
X:
The base number.
Y:
The exponent.
Return Value
X to the power of Y.
Related Functions
Exp
Example
Variable=Pow(5,3);
See Also
RadToDeg
Converts an angle from radians to degrees.
Syntax
RadToDeg(Angle)
Angle:
488
Return Value
The angle in degrees.
Related Functions
DegToRad
Example
Variable=RadToDeg(Pi());
See Also
Rand
Generates a random number between 0 and a specified maximum number less one.
The Rand function is zero-based, so the resultant number generated will range from zero
to one less than the number provided in the Maximum argument.
Syntax
Rand(Maximum)
Maximum:
The maximum number. This number must be between 2 and 32767 (inclusive).
Return Value
A random number of integer type.
Example
Variable=Rand(101);
! Sets Variable to a random number from 0 to 100.
// To create a random number between 0 and 1 with 2 decimal places,
divide the above variable by 100, as shown here: //
Variable = Variable/100;
See Also
Round
Rounds a number to a specified number of decimal places.
Syntax
Round(Number, Places)
Number:
The floating-point number to round.
489
Places:
The number of decimal places.
Return Value
The number rounded to Places decimal places.
Example
Variable=Round(0.7843,2);
! Sets Variable to 0.78 (result is rounded to 2 decimal places).
Variable=Round(123.45,-1);
! Sets Variable to 120.0 (rounded to -1 decimal place).
See Also
Sign
Gets the sign of a number.
Syntax
Sign(Number)
Number:
Any number.
Return Value
The sign of Number.
Related Functions
Abs
Example
Variable=Sign(100);
Variable=Sign(-300);
! Sets Variable to -1.
Variable=Sign(0);
See Also
Sin
Calculates the trigonometric sine of an angle.
Syntax
Sin(Angle)
490
Angle:
Any angle (in radians).
Return Value
The sine of Angle.
Related Functions
ArcSin
Example
Variable=Sin(0.7854);
See Also
Sqrt
Gets the square root of a number.
Syntax
Sqrt(Number)
Number:
Any positive number.
Return Value
The square root of Number.
Related Functions
Pow
Example
Variable=Sqrt(4);
See Also
Tan
Calculates the trigonometric tangent of an angle.
Syntax
Tan(Angle)
Angle:
491
Return Value
The tan of Angle.
Related Functions
ArcTan
Example
Variable=Tan(1);
See Also
492
Chapter: 39 Miscellaneous Functions
This section describes general Cicode functions.
Following are miscellaneous functions.
AreaCheck Determines whether the current user has access to a speci-
fied area.
Assert Verifies a particular condition is true, or halts the task.
Beep Beeps the speaker or sound card in the computer.
CitectInfo Gets information about a CitectSCADA variable.
CodeTrace Traces Cicode into the Kernel and the SYSLOG.DAT file.
DebugBreak Causes a breakpoint error to start the Cicode Debugger.
DebugMsg In-line debug messages of user Cicode.
DebugMsgSet Enables/disables the DebugMsg function.
DelayShutdown Causes CitectSCADA to shut down after a specified period
DisplayRuntimeManager Starts and displays CitectSCADA Runtime Manager.
DumpKernel Dumps Kernel data to the Kernel.dat file.
EngToGeneric Converts a variable into generic scale format.
Exec Executes an application or PIF file.
GetArea Gets the current viewable areas.
GetEnv Gets an environment variable.
InfoForm Displays graphics object help information for the AN closest
to the cursor.
InfoFormAn Displays graphics object help information for an AN.
Input Gets text input from the operator.
IntToReal Converts an integer variable into a real (floating point) num-
ber.
KerCmd Executes a command in a kernel window.
KernelQueueLength Obtains the number of rows in a queue.
KernelTableInfo Provides a consistent method of accessing items within a Ker-
nel Table.
KernelTableItemCount Obtains the number of rows in a Kernel Table.
LanguageFileTranslate Translates an ASCII file into the local language.
Message Displays a message box on the screen.
ParameterGet Gets the value of a system parameter.
ParameterPut Updates a system parameter.
ProcessIsClient Determines if the currently executing process contains a Cli-
ent component
ProcessIsServer Determines if the currently executing process contains a par-
ticular server component.
ProcessRestart Restarts the current process in which Cicode is running.
493
ProjectRestartGet Gets the path to the project to be run the next time Cit-
ectSCADA is restarted.
ProjectRestartSet Sets the path to the project to be run the next time Cit-
ectSCADA is restarted.
ProjectSet Sets the name or path of the current project.
Prompt Displays a message in the prompt line.
Pulse Pulses (jogs) a variable tag every two seconds.
ServerInfo Gets client and server information.
ServerInfoEx Gets client and server information from a specified process in
a multiprocessor environment.
ServerRestart Restart any specific alarm, report, trend or I/O server from
any Cicode node in system,
without affecting other server processes running on the same
machine.
ServiceGetList Gets information about services running in the component
calling this function.
SetArea Sets the current viewable areas.
SetLanguage Sets the current language for runtime text, and the character
set.
Shutdown Ends CitectSCADA’s operation.
ShutdownForm Displays a form that allows an operator to shut down the Ci-
tectSCADA system.
ShutdownMode Gets the mode of the shutdown/restart.
SwitchConfig Switches focus to the CitectSCADA configuration application.
TestRandomWave Generates a random wave.
TestSawWave Generates a saw wave.
TestSinWave Generates a sine wave.
TestSquareWave Generates a square wave.
TestTriangWave Generates a triangular wave.
Toggle Toggles a digital tag on or off.
TraceMsg Displays a message in the Kernel and Debugger debug win-
dows.
Version Gets the version number of the CitectSCADA software.
See Also
Functions Reference
AreaCheck
Determines whether the current user has access to a specified area.
Syntax
AreaCheck(Area)
Area:
The area number (0 - 255)
Return Value
TRUE (1) if the user has access to the Area or FALSE (0) if not.
494
Related Functions
GetArea, GetPriv
Example
IsArea = AreaCheck(5);
See Also
Assert
Verifies that the specified expression is TRUE. If then expression is FALSE, the current task
will be halted. This is useful to help prevent the execution of code you do not want to run
in the event an error has been detected.
This function can be used in a debug mode, where the FALSE assertion will be logged to
the Kernel and SysLog.DAT, with the time, date, Cicode file name, and line number. Addi-
tionally the operator will be prompted with a dialog. The debug mode can be set by using
the [Code]DebugMessage parameter or DebugMsgSet() function.
Note: If you have the "Citect will start debugger on hardware errors" option set in the
Cicode Editor, the Debugger will start with the position before the Halt() instruction. You
must ’step over’ this command if you want to continue debugging the function that called
the Assert().
Syntax
Assert(bCondition)
bCondition:
The boolean expression. This expression must evaluate to TRUE (1) or FALSE (0).
Return Value
None. However, if the assertion tests as FALSE, error 347 is generated.
Related Functions
Halt, DebugMsg, DebugMsgSet, CodeTrace, TraceMsg, ErrLog
Example
INT
FUNCTION FileDisplayEx(STRING sFileName);
INT hFile;
Assert(hFile <> -1);
...
FileClose(hFile);
RETURN 0;
END
495
See Also
Beep
Beeps the internal speaker or sound card (installed in the computer). If you use the internal
speaker on your computer, the function does not return until the sound has completed. If
you use a sound card, the function returns immediately and the sound plays in the back-
ground.
Use the Windows Control Panel to set up waveforms.
Syntax
Beep(nSound)
nSound:
The type of sound:
-1 - Standard beep
0 - Default beep waveform
1 - Critical stop waveform
2 - Question waveform
3 - Exclamation waveform
4 - Asterisk waveform
Return Value
Related Functions
DspPlaySound
Example
/* Beeps the speaker with the default waveform. */
Beep(0);
See Also
CitectInfo
Gets information about a CitectSCADA variable. This function returns internal statistics
and other information about the CitectSCADAruntime system.
Note: This function is a non-blocking function and can only access data contained within
the calling process; consequently it cannot return data contained in a different server pro-
cess. This function is not redirected automatically by CitectSCADA runtime. If you want to
make a call from one process to return data in another, use MsgRPC() to make a remote pro-
cedure call on the other process. Alternatively, include the server process that has the in-
formation that CitectInfo requires in the calling process.
496
Syntax
CitectInfo(sGroup, sName, sType)
sGroup:
The name of the group to which the variable belongs. Valid group names are:
"General", "Port", "IODevice", "Network", "Stats", "Memory", or "Disk".
sName:
The name of the variable. This name depends on sGroup:
 "General" - the name is ignored.
 "Port" - the name of the I/O port configured in the database (with the Ports da-
tabase). The port information is only valid for an I/O server. If the port name
is "total", the total statistics for the I/O server are returned.
 "IODevice" - the name of the I/O device configured in the I/O devices database.
 "Network" - the name is ignored.
 "Stats" - The name of the statistics buffer or Statistical Information Record
(SIR):
"Alarm Proc" - Alarm Processing (includes Digital, Analog, Advanced and High
Resolution alarms).
"Citect n" - The CitectSCADA window where n is the window number (returned
from the WinNumber() function)
"Code n" - The user Cicode task (thread) where n is the task handle (returned from
the TaskHnd() function)
"Reset" - Reset the CitectSCADA statistics.
"ElapsedTimeMS" - The elapsed time since statistics have been reset. Returns -1 if
more than 20 days has elapsed.
 "Memory" - the measurement used
0 = bytes
KB = kilobytes
MB = megabytes
GB = gigabytes
 "Disk" - The disk drive to access:
0 = The current drive
1 = A:
2 = B:
3 = C: and so on.
sType:
The type of information to get, depending on sGroup:
"General" - General statistics:
0 - CPU usage
1 - CitectSCADA kernel cycles per second
2 - CitectSCADA kernel tasks per second
3 - Citect Kernel boot time
4 - Citect Kernel running time (in seconds)
5 - CitectSCADA startup time
6 - CitectSCADA running time in seconds
497
7 - Not supported in v7.10

8 - Total read requests
9 - Total Read requests per second
10 - Total write requests
11 - Total write requests per second
12 - Total Physical read requests
13 - Total Physical read requests per second
14 - Total Physical write requests
15 - Total Physical write requests per second
16 - Total Blocked read requests
17 - Total Blocked write requests
18 - Total Digital read requests
19 - Total Register read requests
20 - Total Digital read requests per second
21 - Total Register read requests per second
22 - Total Cache reads count
23 - Total Cache reads %
24 - Overall Average response time (ms)
25 - Overall Minimum response time (ms)
26 - Overall Maximum response time (ms)
27 - Request sample for response times
28 - Static point count is no longer supported. Calling the function with parame-
ter 28 returns a value of 0 and a hardware alarm is raised.
29 - Dynamic point count currently in use
"Port" - Port information for the I/O Server:
0 - Read requests
1 - Write requests
2 - Physical read requests
3 - Physical write requests
4 - Cached read requests
5 - Cached write requests
6 - Blocked read requests
7 - Blocked write requests
8 - Read requests per second
9 - Write requests per second
10 - Error count
11 - Read bytes counter
12 - Channel usage %
13 - Read bytes per second
498

17 - Statistics, time of samples
18 - Statistics, number of sample
"IODevice" - I/O device information for the I/O device:
0 - Client side status:
 1 = Running - Client is either talking to an online IO device or talking to a
scheduled device that is not currently connected but has a valid cache
 2 = Standby - Client is talking to an online standby IO device
 4 = Starting - Client is talking to an IO device that is attempting to come on-
line
 8 = Stopping - Client is talking to an IO device that is in the process of stop-
ping
 16 = Offline - Client is pointing to an IO device that is currently offline
 32 = Disabled - Client is pointing to a device that is disabled
 66 = Standby write - Client is talking to an I/O device configured as a stand-
by write device
1 - I/O Server status:
 1 = Running - I/O Server is either talking to an online IO device or talking
to a scheduled device that is not currently connected but has a valid cache
 2 = Standby - I/O Server is talking to an online standby IO device
 4 = Starting - I/O Server is talking to an IO device that is attempting to come
online
 8 = Stopping - I/O Server is talking to an IO device that is in the process of
stopping
 16 = Offline - I/O Server is pointing to an IO device that is currently offline
 32 = Disabled - I/O Server is pointing to a device that is disabled
 66 = Standby write - I/O Server is talking to an I/O device configured as a
standby write device
2 - If this I/O device is a standby device
3 - Last generic error
4 - Last driver error
5 - Error count
6 - Initialization count
10 - Statistics, number of samples
"Network" - Network statistical information:
0 - Read Network Control Blocks (NCBs)
1 - Maximum pending read NCBs
2 - Minimum pending read NCBs
3 - Current pending read NCBs
4 - Number of short read NCBs
5 - Write NCBs
6 - Maximum pending write NCBs
499
7 - Minimum pending write NCBs

8 - Current pending write NCBs
9 - Number of short write NCBs
10 - Total NCBs
11 - Maximum pending total NCBs
12 - Minimum pending total NCBs
13 - Current pending total NCBs
14 - Number of short total NCBs
15 - Minimum send response time in milliseconds
16 - Maximum send response time in milliseconds
17 - Average send response time in milliseconds
18 - Send packet count
"Stats" - Statistical information:
0 - Minimum time between code executions (cycles)
1 - Maximum time between code executions (cycles)
2 - Average time between code executions (cycles)
3 - Total cycle time in milliseconds
4 - Minimum time to execute the code in milliseconds
5 - Maximum time to execute the code in milliseconds
6 - Average time to execute the code in milliseconds
7 - Total execute time in milliseconds
"Memory" - Memory information:
0 - Free virtual memory
1 - Free windows system resources as %
2 - Free Physical Memory
3 - Memory Paging File Size
4 - Total Physical Memory
5 - Total % of Physical Memory Used (Win 2000 or later) and % of the last 1000
pages in memory that are in use (Win NT or earlier).
"Disk" - Disk information:
0 - Free disk space in bytes
1 - Total disk space in bytes
2 - Free disk space in kilobytes
3 - Total disk space in kilobytes
Return Value
The type of information (as an integer).
Related Functions
IODeviceInfo, WinNumber, TaskHnd
500
Example
! Get free memory
FreeMemory = CitectInfo("Memory", "", 0);
! Get free disk space on C:
FreeDisk = CitectInfo("Disk", 3, 0);
! Get max cycle time for digital alarms
MaxCycleTime = CitectInfo("Stats","Digital Alm","1");
See Also
CodeTrace
Traces Cicode into the Kernel and the SYSLOG.DAT file. Use this function for finding bugs
in your Cicode. It will trace all functions called, the arguments to those functions, and their
return values. It will also trace any errors, writes to the I/O devices, and task state changes.
Note: Use this function only during system development; it can cause excessive loading on
the CPU.
Syntax
CodeTrace(hTask, nMode)
hTask:
The Cicode task handle as returned from TaskHnd() function or any of the fol-
lowing special values:
0 - Foreground Cicode.
-2 - The next created task.
-3 - All new created tasks.
-4 - All tasks.
nMode:
The mode of the trace:
0 - Tracing off
1 - Trace user Cicode functions calls
2 - Trace built-in function calls
4 - Trace errors
8 - Trace writes to the I/O devices
16 - Trace task state changes
-1 - All modes (except 0)
Return Value
Related Functions
Assert, TaskHnd, DebugMsg, DebugMsgSet, TraceMsg, ErrLog
501
Example
// Start tracing errors
CodeTrace(TaskHnd(), 4);
....
// Stop tracing
CodeTrace(TaskHnd(), 0);
// trace all functions in new task
CodeTrace(-2, 1 + 2);
TaskNew("MyFunc", "data", 0);
See Also
DebugBreak
Causes a breakpoint exception error to occur (error number 342). This allows programmers
to trap invalid states in their Cicode. If the Cicode Editor is not running, and the Citect will
start debugger on hardware errors option is set (Debug menu - Options), the Debugger
will be started. When the debugger starts, the correct Cicode file, function, and line will be
displayed.
Syntax
DebugBreak()
Return Value
None.
Related Functions
DspKernel, KerCmd, DumpKernel, TraceMsg
Example
!Check to see that rSpan is greater than zero else cause a break.
If rSpan equals 0 it would cause a Divide by Zero hardware error
anyway.
IF rSpan > 0 THEN
rCalcRate = iAmount/rSpan;
ELSE
DebugBreak();
END
See Also
DebugMsg
Provides in-line debug messages of user Cicode, to the Kernel, Debugger Debug window,
and the SysLog.DAT file. This function can be enabled or disabled with the [Code]Debug-
Message parameter or DebugMsgSet() function at runtime.
502
Syntax
DebugMsg(sMessage)
sMessage:
The debugging message to log. Be sure to enclose this message in double quotes
(" ").
Return Value
None.
Related Functions
Assert, DebugMsgSet, CodeTrace, TraceMsg, ErrLog
Example
INT
FUNCTION
FileDisplayEx(STRING sFileName);
INT hFile;
DebugMsg("When opening file " + sFileName + ", the handle was: " + IntToStr(hFile));
...
FileClose(hFile);
RETURN 0;
END
See Also
DebugMsgSet
Enables/disables the DebugMsg() logging functionality. It also controls whether logging is
enabled for the Assert() function. This function also sets the [Code]DebugMessage param-
eter appropriately.
Syntax
DebugMsgSet(nMode)
nMode:
The logging mode:
0 - Disable logging.
1 - Enable logging.
Return Value
Related Functions
Assert, DebugMsg
503
Example
Buttons
Text Debug Enable
Command DebugMsgSet(1)
Comment Enable debug logging
See Also
DelayShutdown
Terminates CitectSCADA’s operation after the specified delay period (in milliseconds).
This function is suitable to be called by the CTAPI. The delay period enables the user to
close the connection between the CTAPI and third-party applications before CitectSCADA
shuts down.
Syntax
DelayShutdown(Delay)
Delay:
The period (in milliseconds) after whichCitectSCADA will shut down.
Return Value
No return value.
Related Functions
CtOpen, CtClose, CtCicode
Example
DelayShutdown(10 000)
!Terminates CitectSCADA’s operation after 10 seconds
See Also
DisplayRuntimeManager
This function will start the CitectSCADA Runtime Manager if it is not already running ,
otherwise it will just bring the CitectSCADA Runtime Manager to the foreground.
Syntax
DisplayRuntimeManager()
Return Value
DumpKernel
504
Dumps Kernel data to the KERNEL.DAT file.
Syntax
DumpKernel(iMode, sName)
iMode:
The Kernel data to dump:
0x0001 Dump general statistics
0x0002 Dump the task
0x0004 Dump the I/O device
0x0008 Dump the driver
0x0010 Dump netstat
0x0020 Dump the table
0x0040 Dump the queue
0x4000 Dump in verbose mode
0x8000 Dump all the kernel data in non-verbose mode.
To dump all data in verbose mode, set iMode to 0xc0000 (0x8000 + 0x4000).
You can select any one of the above modes or may add them together to get more than one
type of information. For example, to dump netstat and I/O device data in verbose mode, set
iMode to 0x4014 (0x0004 + 0x0010 + 0x4000). Using 0x4000 on its own will dump no data,
it must be combined with another mode.
sName:
The queue or table name(empty for all queues or tables). Only valid if iMode is
0x0001 or 0x0040.
Return Value
Related Functions
DspKernel, KerCmd, TraceMsg
Example
DumpKernel(0x8000, "");
!Dump all the Kernel data
See Also
EngToGeneric
Gets a variable in the CitectSCADA generic scale format. CitectSCADA uses this scale to
display trends. It calls this function automatically for trends defined in the project. If you
want to display a trend using Cicode you must call this function.
Syntax
EngToGeneric(Value, EngLow, EngHigh)
505
Value:
The value to convert to the CitectSCADA generic scale format.
EngLow:
The engineering units zero scale.
EngHigh:
The engineering units full scale.
Return Value
The variable (in the range 0 - 32000).
Related Functions
DspBar, DspTrend
Example
/* Using trend definition 5 at AN20, display the value of Tag1 on
Pen1 of the trend. Tag1 has an engineering scale of 0 to 100. */
DspBar(20,5,EngToGeneric(Tag1,0,100));
See Also
Exec
Executes an application or PIF file. The application or command starts up and continues to
run in parallel with CitectSCADA.
This function can return while the application is still starting up, so you should use the
Sleep() function to allow the application enough time to start.
Syntax
Exec(Command [, Mode] )
Command:
The operating system command to execute.
Mode:
The mode of the window:
1 - Normal
3 - Maximized
6 - Minimized
If you do not enter a mode, the default mode is 1.
Return Value
Related Functions
Sleep
506
Example
Exec("c:\winnt\system32\mspaint.exe");
! Starts up the Paint application with a normal window.
Exec("cmd /c mkdir c:\test");
! Uses the DOS shell to create a new directory
You must quote paths and applications passed to the exec function (using ^" to embed
quotes) so that the function can be executed correctly when long file names are used. For
example:
Exec(PathToStr("^"" + "[BIN]:\Ctcicode")+ "^" ^"" +
PathToStr("[RUN]:\cicode.ci") + "^"")
creates a command line that ends up as:

C:\Program Files\CitectSCADA\CitectSCADA 7.10\Bin\CtCicode C:\Program Files\CitectSCADA\CitectSCADA
7.10\Project\Cicode.ci
See Also
GetArea
Gets the current logged-in areas.
Syntax
GetArea()
Return Value
The login area groups as an integer that represents a group handle. If this group is modi-
fied, the actual login areas do not change.
Related Functions
SetArea
Example
! If the current areas are 1, 5 and 20:
hGrp=GetArea();
Str=GrpToStr(hGrp);
! sets Str to "1,5,20".
See Also
GetEnv
Gets a DOS environment variable.
507
Syntax
GetEnv(sName)
sName:
The name of the environment variable.
Return Value
The DOS environment variable (as a string).
Example
/* Get the current DOS path. */
sPath = GetEnv("Path");
See Also
InfoForm
Displays graphics object information for the object under the mouse pointer. If there is no
object directly under the mouse pointer, it displays information for the nearest object. Each
tag associated with the object is displayed, along with its raw and engineering values and
a button that displays all the details from the Variable Tags form. The function also displays
the Cicode expression, with any result that the expression has generated.
This function only supports the display of simple Cicode expressions.
Syntax
InfoForm(Mode)
Mode:
For security purposes, the Write button on the information form displayed by this
function can be disabled.
0 - The Write button on the displayed information form will be available and will
function normally.
1 - The Write button will not be shown.
Return Value
Related Functions
InfoFormAn
508
Example
System Keyboard
Key Sequence AnHelp
Command InfoForm();
Comment Display graphics object help for the AN closest to the cursor
See Also
InfoFormAn
Displays graphics object information for a specified AN. This function displays each tag as-
sociated with the object, along with its raw and engineering values and a button that dis-
plays all the details from the Variable Tags form. The function also displays the Cicode
expression, with any result that the expression has generated.
Syntax
InfoFormAn(AN [, Mode] )
AN:
The AN of the graphics object for which information is displayed.
Mode:
For security purposes, the Write button on the information form displayed by this
function can be disabled.
0 - The Write button on the displayed information form will be available and will
function normally.
1 - The Write button will not be shown.
Return Value
Related Functions
InfoForm
Example
System Keyboard
Key Sequence ### AnHelp
Command InfoFormAn(Arg1);
Comment Display graphics object help for a specified AN
See Also
Input
Displays a dialog box in which an operator can input a single value. The dialog box has a
title, a prompt, and a single edit field. For multiple inputs, use the Form functions.
509
is complete.
Syntax
Input(Title, Prompt, Default)
Title:
The title of the input box.
Prompt:
The prompt text.
Default:
The default text that the operator can edit or replace.
Return Value
The edit field entry (as a string). If the user presses the Cancel button , an empty string is
returned and the IsError() function returns the error code 299.
Related Functions
Message, FormNew
Example
/* Shut down CitectSCADA if the user inputs "Yes". */
STRING sStr;
sStr=Input("Shutdown","Do you wish to shutdown?","Yes");
IF sStr="Yes" THEN
Shutdown();
END
See Also
IntToReal
Converts an integer into a real (floating point) number.
Syntax
IntToReal(Number)
Number:
The integer to convert.
Return Value
The real number.
Related Functions
RealToStr, StrToInt
510
Example
! Sets Variable to 45.0
Variable=IntToReal(45);
! Sets Variable to -45.0
Variable=IntToReal(-45);
See Also
KerCmd
Executes a command in a Kernel window.
Syntax
KerCmd(Window, sCommand)
Window:
The name of the Kernel window.
sCommand:
The command to execute in the Kernel window.
Return Value
Related Functions
DspKernel, TraceMsg, DumpKernel
See Also
KernelQueueLength
Obtains the number of records in a queue.
Syntax
KernelQueueLength(sName)
sName:
The name of the queue, which can be enumerated by the page queue kernel com-
mand.
Return Value
This function returns the Length value of the page queue command.
Related Functions
None
511
See Also
KernelTableInfo
Provides a consistent method of accessing items within Kernel Table.
Syntax
KernelTableInfo(sTable, sRecord, sField)
sTable:
The name of the table. The following tables are supported:
sTable sRecord sField Notes
Bufferpool The value of the Mode, Size, Total, These names are
‘Name’ field Free, InUse, Max, unique when each
Peak, Short, Gets, Bufferpool is created
TotErr, Grow, Shrink
CiCode The value of the Name, HND, State, The CiCode function
‘Name’ field or CPU_Time, TaskNew exposes the
the ‘HND’ field. If Poll_Time, Slice handle. That is why
the user specifies record access by han-
a number as the dle is acceptable for
sRecord we will this table. The name
assume it is a field may or may not
handle, other- be unique (if you run
wise we will look the same CiCode task
it up as a string twice with different
name parame-ters). Access-
ing by ‘Name’ will fail if
there are duplicates
Task The value of the Mode, Hnd, State, None
‘Name’ field Prty, Cpu, Min, Max,
Avg, Count
Trendqueues The value of the FlushQueueLength, None
‘DriverName’ FlushQueuesMax ,
field TotalFlushes, File-
Writes
sRecord:
The key to a column in the table depending on the sTable parameter.
sField:
The key to a column in the table depending on the sTable parameter.
Return Value
Returns the content of a field of the given table in the format of a Cicode STRING.
Related Functions
KernelTableItemCount, DumpKernel
See Also
512
KernelTableItemCount
Obtains the number of rows in a Kernel Table.
Syntax
KernelTableItemCount(sName)
sName:
The name of the table that can be enumerated by the page table kernel command.
Return Value
Returns the number of active records in the table (not the length value displayed by the
page table kernel command).
The following tables row counts are not returned by this command (it returns 0)
 IODevices.Tags
 IODevices.Subs
 IODevices.Blocks
 CSAToPSI.Subs"
KernelTableInfo, DumpKernel
See Also
LanguageFileTranslate
Translates an ASCII file into a local language. Use this function to translate RTF reports for
viewing on client screens.
The local language used by this function is specified by the [Language]LocalLanguage pa-
rameter. You must set this parameter accordingly.
Syntax
LanguageFileTranslate(sSourceFile, sDestFile)
sSourceFile:
The name of the ASCII file containing multi-language text, which will be copied
and translated. You should specify the full path or use path substitution. The path
and name should be contained within quotation marks.
sDestFile:
The name of the destination file which will be created/ replaced with the local/
translated version of the source file. You should specify the full path or use path
substitution. The path and name should be contained within quotation marks.
Return Value
1 if successful, otherwise 0.
Related Functions
SetLanguage, StrToLocalText
513
Example
/* Translates the text in Shift.RTF and saves it in LShift.RTF. */
LanguageFileTranslate("c:\MyApplication\data\Shift.RTF","c:\MyApplication\data\
LShift.RTF");
/* Translates the text in [Data]:Shift.RTF and saves it in
[LocalData]:LShift.RTF. */
LanguageFileTranslate("[Data]:Shift.RTF","[LocalData]:LShift.RTF"
);
See Also
Message
Displays a message box on the screen and waits for the user to select the OK or Cancel but-
ton.
is complete.
Syntax
Message(Title, Prompt, Mode)
Title:
The title of the message box.
Prompt:
The prompt displayed in the message box.
Mode:
The mode of the message box:
0 - OK button
1 - OK and Cancel button
16 - Stop Icon
32 - Question Icon
48 - Exclamation Icon
64 - Information Icon
Select more than one mode by adding the modes. For example, set Mode to 33 to
display the OK and Cancel buttons and the Question icon. You can only display
one icon for the message box.
Return Value
0 (zero) if successful, otherwise an error is returned. If the user presses the Cancel button
the function returns an error code of 299.
Related Functions
Input
514
Example
/* Display an error message in a message box. */
IF Total<>100 THEN
Message("Error","Total not 100%",48);
END
See Also
ParameterGet
Gets the value of a system parameter. The system parameter can exist in the CITECT.INI
file and/or in the Parameters database.
If the system parameter does not exist in the CITECT.INI file or the database, the default
value is returned. If the system parameter exists in both CITECT.INI and the database, the
value of the system parameter is taken from CITECT.INI.
Syntax
ParameterGet(Section, Name, Default)
Section:
The section name.
Name:
The system parameter name.
Default:
The default value of the parameter.
Return Value
The parameter (as a string).
Related Functions
ParameterPut, WndGetFileProfile, WndPutFileProfile
Example
Variable=ParameterGet("Page","Windows","4");
See Also
ParameterPut
Updates a system parameter in the CITECT.INI file. If the system parameter does not exist,
it is added to the CITECT.INI file.
Syntax
ParameterPut(Section, Name, Value)
515
Section:
The section name.
Name:
The system parameter name.
Value:
The value to put in the system parameter.
Return Value
Related Functions
ParameterGet, WndGetFileProfile, WndPutFileProfile
Example
/* Changes the [Page] Windows system parameter in CITECT.INI to "4". */
ParameterPut("Page","Windows","4");
See Also
ProcessIsClient
Determines if the currently executing process contains a Client component.
Syntax
ProcessIsClient()
Return Value
TRUE (1) if the process contains a Client component, otherwise FALSE (0).
Related Functions
ProcessIsServer, ServerInfo, ServerInfoEx, ServiceGetList
Example
To execute local variable simulation code on the client only:
IF (ProcessIsClient()) THEN
SimulateLocalVariables();
END
See Also
ProcessIsServer
Determines if the currently executing process contains a particular server component.
516
Syntax
ProcessIsServer(sServerType [, sClusterName] [, sServerName])
sServerType:
Case insensitive string specifying the type of server to check for. Supported val-
ues are "IOServer", "Trend", "Alarm" and "Report".
sClusterName:
Optional case insensitive string specifying the cluster name to combine with the
server type specified in the first argument and the server name (if specified).
sServerName:
Optional case insensitive string specifying a server name to combine with the
server type specified in the first argument and the cluster name (if specified).
Return Value
TRUE (1) if the process contains the specified component, otherwise FALSE (0).
Related Functions
ProcessIsClient, ServerInfo, ServerInfoEx, ServiceGetList
Example
To execute disk PLC tag simulation code only on the I/O server in Cluster1 with the name
IOServer3:
IF (ProcessIsServer("IOServer", "Cluster1", "IOServer3")) THEN
SimulateDiskTags();
END
See Also
ProcessRestart
Restarts the current process in which Cicode is running.
Syntax
INT error = ProcessRestart()
Return Value
0 (zero) if successful, otherwise the following error is returned:
256 - General software error
See Also
Cicode and General errors
Related Functions
ServerRestart
517
Example
ProcessRestart()
See Also
ProjectRestartGet
Gets the path to the project to be run the next time CitectSCADA is restarted. (You must
have a project already set using either ProjectSet or ProjectRestartSet. Use this function
with the Shutdown() function to shut down and then restart the project that is currently
running.
Syntax
ProjectRestartGet()
Return Value
The path to the project to be run the next time CitectSCADA is restarted.
Related Functions
Shutdown, ShutdownMode, ProjectSet, ProjectRestartSet
Example
See Shutdown.
See Also
ProjectRestartSet
Sets the path to the project to be run the next time CitectSCADA is restarted.
Syntax
ProjectRestartSet(sPath)
sPath:
The path to the project. You must use the full path, for example to specify the
path to the project "Demo", use: "C:\CITECT\USER\DEMO".
Return Value
Related Functions
Shutdown, ShutdownMode, ProjectSet, ProjectRestartGet
See Also
518
ProjectSet
Sets either the name or the path of the project to be run next time CitectSCADA is restarted.
The project path is written to the [CtEdit]Run parameter.
Syntax
ProjectSet(sProject)
sProject:
The name of the project (for example "DEMO"), or the path to the project. If you
specify the path to the project, you must use the full path. If you do not specify a
project, the current project will be used.
Return Value
Related Functions
Shutdown, ShutdownMode, ProjectRestartGet
Example
/* Set the next project to "Demo". */
ProjectSet("Demo");
/* Set the next project to "MyPath". */
ProjectSet("I:\CITECT\PROJECT1\MYPATH");
See Also
Prompt
Displays a message in the prompt line (AN=2) on the operator’s computer.
Syntax
Prompt(String)
String:
The message to be displayed.
Return Value
Related Functions
Message, DspError
Example
/* Display "This is a prompt!" at the prompt AN. */
Prompt("This is a prompt!");
519
See Also
Pulse
Pulses (jogs) a variable tag on, then off. The variable tag is switched ON (1) and two sec-
onds later it is switched OFF (0). The exact period of the pulse is determined by the com-
munication channel to the I/O device. If the communication channel is busy, the pulse time
may be longer than two seconds. The code in the I/O device should not rely on a pulse time
of exactly 2 seconds. Use the pulse as a trigger only.
Syntax
Pulse(sTag)
sTag:
The digital tag to pulse.
Return Value
Related Functions
Toggle
Example
Buttons
Text Jog 145
Command Pulse(M145)
Comment Pulse the variable tag M145 every two seconds
See Also
ServerInfo
Gets status information on clients and servers.
Note: This function is a non-blocking function and can only access data contained within
the calling process; consequently it cannot return data contained in a different server pro-
cess. This function is not redirected automatically by CitectSCADA runtime. If you want to
make a call from one process to return data in another, use MsgRPC() to make a remote pro-
cedure call on the other process. Alternatively, use the ServerInfoEx function that allows
you to specify the name of the component from which you want to retrieve data.
Syntax
ServerInfo(sName, nType [, ClusterName] )
sName:
The name of the client or server, either "Client", "Server", "Alarm", "Trend", or
"Report".
520
 You can also pass a number instead of the name (but it still must be enclosed
in quotes). The number represents the target client. For example, if there are
12 clients, passing "3" will get information on the 3rd client.
 If this server is an Alarm, Trend, Report, and I/O server then each client will
be attached 4 times. So 12 clients would mean there are 3 CitectSCADA com-
puters using this server - one of which is itself.
nType:
The type of information required (depends on the Name you specify):
"Alarm", "Trend", or "Report" name:
0 - Active flag (returns 1 if this is the active server, 0 if an inactive server).
1 - Number of clients attached to this server.
2 - If this client is attached to the primary or standby server for the specified serv-
er name. If Name is "Alarm" and if this client is attached to the primary
alarm server, the return value is 0. If this client is attached to the standby,
the return value is 1.
3 - The status of the client connection to the specified server name. If Name is "Re-
port" and the client is talking to a report server (either primary or standby),
the return value is 1. If not, the return value is 0.
"Client" name:
0 - The computer name, as specified by [LAN]Node.
1 - Not supported.
2 - Not supported.
3 - Not supported.
For modes 1,2 and 3, use ServerInfoEx instead.
"Server" name:
0 - Not supported.
1 - The number of clients attached to this server. This is the total number of Alarm,
Trend Report, and I/O server clients.
"<number>":
0 - The name of the server this client is talking to. For example, "Alarm", "Trend",
"Report", or "IOServer".
1 - The login name of the client. This may be an empty string if the client has not
logged in.
2 - The CitectSCADA computer name of the client computer.
3 - The time the client logged in.
4 - The number of messages received from this client.
5 - The number of messages sent to this client.
6 - If this client has a licence (1) from this server or not (0).
7 - The type of the licence; full licence (0), View-only Client (1), or Control Client
(2).
8 - If the client is remote (1) or local (0).
ClusterName:
The name of the cluster that the server belongs to. This is only relevant if:
 The Name is "alarm", "report", or "trend"; AND
 The type of information required, nType, is 2 or 3.
521
Return Value
Status information specified by nType.
Related Functions
ServerInfoEx
Example
sSrvInfo=ServerInfo("Report",0);
IF sSrvInfo THEN
! This is a primary report server.
ELSE
! This is a stand-by report server.
END
/* Get and store the names of all clients attached to this server */
iCount = 1;
iClients = ServerInfo("Server", 1);
WHILE iCount <= iClients DO
sName[iCount] = ServerInfo(IntToStr(iCount), 2);
iCount = iCount + 1;
END
See Also
ServerInfoEx
Gets status information on clients and servers from a specified component in a multipro-
cess runtime environment.
When this function is called, the system redirects the call to the process that contains the
specified component. If the specified component is in the calling process, the call is not re-
directed. If the specified component is not one of the servers listed in the sComponent argu-
ment description (see below), of if the system cannot find the component from all the
connected local processes, a hardware alarm is raised.
Syntax
ServerInfoEx(sName, nType, sComponent [, ClusterName] )
sName:
The name of the client or server, either "Client", "Server", "Alarm", "Trend", or
"Report".
 You can also pass a number instead of the name (but it still must be enclosed
in quotes). The number represents the target client. For example, if there are
12 clients, passing "3" will get information on the 3rd client.
 If this server is an Alarm, Trend, Report, and I/O server then each client will
be attached 4 times. So 12 clients would mean there are 3 CitectSCADA com-
puters using this server - one of which is itself.
nType:
The type of information required (depends on the Name you specify): "Alarm",
"Trend", or "Report" name:
522
0 - Active flag (returns 1 if this is the active server, 0 if an inactive server).

1 - Number of clients attached to this server.
2 - If this client is attached to the primary or standby server for the specified serv-
er name. If Name is "Alarm" and if this client is attached to the primary
alarm server, the return value is 0. If this client is attached to the standby,
the return value is 1.
3 - The status of the client connection to the specified server name. If Name is "Re-
port" and the client is talking to a report server (either primary or standby),
the return value is 1. If not, the return value is 0.
"Client" name:
0 - The computer name, as specified by [LAN]Node.
1 - The primary server name, as specified in the server configuration forms in
Project Editor.
2 - The secondary server name, as specified , as specified in the server configura-
tion forms in Project Editor.
3 - The name of the INI file being used, for example, Citect.INI.
"Server" name:
0 - The server name, as specified in the server configuration forms in Project Ed-
itor.
1 - The number of clients attached to this server. This is the total number of Alarm,
Trend Report, and I/O server clients.
"<number>":
0 - The name of the server this client is talking to. For example, "Alarm", "Trend",
"Report", or "IOServer".
1 - The login name of the client. This may be an empty string if the client has not
logged in.
2 - The CitectSCADA computer name of the client computer.
3 - The time the client logged in.
4 - The number of messages received from this client.
5 - The number of messages sent to this client.
6 - If this client has a licence (1) from this server or not (0).
7 - The type of the licence; full licence (0), View-only Client (1), or Control Client
(2).
8 - If the client is remote (1) or local (0).
sComponent:
Specifies the component name from which to retrieve the status information:
" "- An empty string causes the function to run on the calling process.
"Alarm" - Redirects the function to the alarm server process.
"Trend" - Redirects the function to the trend server process.
"Report" - Redirects the function to the report server process.
"IOServer" - Redirects the function to the I/O server process.
523
Note: If sName is "Client", the function will NOT be redirected to the component specified
by sComponent. Instead, the function gets information of type nType from the current client
connection to the component specified by sComponent.
ClusterName:
The name of the cluster that the server belongs to. This is only relevant if:
 The Name is "alarm", "report", or "trend"; AND
 The type of information required, nType, is 2 or 3.
Return Value
Status information specified by nType.
Related Functions
ServerInfo
Example
This example gets the server information from the report process.
sSrvInfo=ServerInfoEx("Report",0, "Report");
IF sSrvInfo THEN
! This is a primary report server.
ELSE
! This is a stand-by report server.
END
/* Get and store the names of all clients attached to the report server */
iCount = 1;
iClients = ServerInfoEx("Server", 1, "Report");
WHILE iCount <= iClients DO
sName[iCount] = ServerInfoEx(IntToStr(iCount), 2, "Report");
iCount = iCount + 1;
END
See Also
ServerRestart
Restart any specific alarm, report, trend or I/O server from any Cicode node in system,
without affecting other server processes running on the same machine.
Syntax
INT error = ServerRestart (STRING sServerName, STRING sCluster = "")
sServerName:
The name of the server to restart
sCluster:
The cluster the server belongs to. This parameter is optional. If sCluster is not specified the
current system cluster is used.
Return Value
0 (zero) if successful, otherwise one of the following error codes is returned:
524
256 - General software error

292 - Invalid function
403 - Cluster not found
418 - No server of type on cluster
512 - Time out error
513 - Access denied error
See Also
Cicode and General errors.
Related Functions
ProcessRestart
Example
ServerRestart("AlarmServer1", "Cluster1");
See Also
ServiceGetList
Determines the service type(s), cluster name(s), and service name(s) of all services current-
ly running in the component that called this function. It also determines if the client com-
ponent is running.
If you call this function from a component that is running purely as a Control Client or
View-only Client, the function will return "Client".
If you call this function from a single-process component that includes:
 I/O server called IOServ1 on ClustA
 Trend server called Trend1 on ClustB
 Alarm server called Alarm1 on ClustA
 Report server called Report1 on ClustB
 Client
The function will return a string similar to:
"IOServer.ClustA.IOServ1,Trend.ClustB.Trend1,Alarm.ClustA.Alarm1,Re-
port.ClustB.Report1,Client"
The order of components in the string is not fixed so the exact string may vary from the
above. You should parse the returned string or alternatively use ProcessIsClient or Proces-
sIsServer to find the information you need.
Syntax
ServiceGetList()
525
Return Value
String in the form:
serviceType1.clusterName1.serviceName1,serviceType2.clusterName2.serviceName2, ... ,Client
Related Functions
ProcessIsClient, ProcessIsServer, ServerInfo, ServerInfoEx
See Also
SetArea
Sets the current viewable areas. You can pass a single area number, or a group of areas to
set multiple areas. You can only set areas that are flagged for the current user.
Syntax
SetArea(Area)
Area:
The area to set (1 to 255).
Return Value
Related Functions
GrpOpen
Example
/* Set current viewable area to Area 1. */
SetArea(1);
See Also
SetLanguage
Sets the language database from which the local translations of all native strings in the
project will be drawn, and specifies the character set to be used. Native strings are those
that are preceded by a @, and enclosed in brackets (for example, @(Motor Overload)).
This function will dynamically change the language of display items such as alarm descrip-
tions, button text, keyboard/alarm logs, graphic text, Cicode strings etc. The language will
only be changed on the client that calls the function. This means that you can display dif-
ferent languages at different clients, even though they are running the same project.
If the local language character set differs from the default character set of the Windows in-
stallation, the runtime text may be garbled. You can set the local language and character set
by using this function, or through the [Language]LocalLanguage and [Language]CharSet
Parameters.
526
Syntax
SetLanguage(sLanguage, nCharSet)
sLanguage:
The name of the language database from which the local translations of all native
strings in the project will be drawn. You do not need the .dbf extension.
nCharSet:
The character set to use when displaying the localized text in runtime:
0 ANSI
1 Default
128 Japanese - Shiftjis
129 Korean - Hangul
130 Korean - Johab
134 Chinese - simplified
136 Chinese - traditional
161 Greek
162 Turkish
163 Vietnamese
177 Hebrew
178 Arabic
186 Baltic
204 Russian
222 Thai
Return Value
0 (zero) if successful, otherwise 262 (the file could not be opened).
Related Functions
LanguageFileTranslate, StrToLocalText
Example
SetLanguage("French",1);
! Changes the current language to French, using the Windows
default character set.
See Also
Shutdown
Terminates CitectSCADA’s operation. Use this function to shut down the CitectSCADA
system, otherwise buffered data could be lost.
Note: With one exception, the Shutdown command will succeed only if there is an Alarm
Server in your system. The exception to this is if you specify an empty string for the sDest
527
parameter (shutdown this computer only). In this case the shutdown will succeed even if
there is no Alarm Server.
The shutdown can affect only the computer that calls it, or all or part of a CitectSCADA net-
work. If you are shutting down a network, specify the computers (Control Clients and serv-
ers) to be shut down in sDest, and the extent of the shutdown in Mode.
Note: If [Shutdown]NetworkIgnore parameter is set to 0 (zero) and a client receives a shut-
down request message from a server. Phase 2 clients only receive a shutdown request when
the first phase 1 client has reconnected to the server.
You can allow selected computers to override the shutdown with the [Shutdown]Net-
workIgnore parameter. (You might set this parameter for critical servers, for example, I/O
servers.)
Use the ShutdownForm() function to prompt the user for verification before shutting Cit-
ectSCADA down.
Note: If the [Shutdown]NetworkStart parameter is set to 0 (zero), the Shutdown() function
will ignore the sDest argument. This will result in the shutting down and restarting of the
machine the function is run on regardless of the machine specified.
Syntax
Shutdown( [sDest] [, sProject] [, Mode] [, ClusterName] )
sDest:
The destination computer(s) to be shut down, as a string:
"" (blank string) - This computer only - Default value
["Computer_Name"] - The specified CitectSCADA client (defined in the comput-
er’s CITECT.INI file)
["Server_Name"] - The specified CitectSCADA server
"All Clients" - All CitectSCADA clients on the network
"All Servers" - All CitectSCADA servers on the network
"Everybody" - All CitectSCADA computers on the network
sProject:
The full path of the project to run on restart as a string. The path is written to the
configuration files and is used when the system restarts. The default value is "",
which means that no changes are made to the configuration and the current
project is restarted.
Mode:
The type of shutdown:
1 - Shutdown CitectSCADA only - Default value
2 - Shutdown and restart CitectSCADA (do not log off Windows)
3 - Shutdown and restart CitectSCADA and log off Windows (must set up an auto
login)
4 - Shutdown CitectSCADA and re-boot the computer
5 - Shutdown CitectSCADA only
6 - Shutdown and restart CitectSCADA clients, but not this computer
ClusterName:
528
The name of the cluster that the machine(s) named in Dest belongs to. This is not
required if:
 the function is called with Dest empty (the default); OR
 the client is connected to only one cluster containing an Alarm Server.
Return Value
Related Functions
ProjectRestartGet, ProjectRestartSet, ProjectSet, ShutdownMode, ShutdownForm, On-
Event
Example
/* Shut down CitectSCADA on this computer. */
Shutdown();
/* Shut down and restart CitectSCADA clients, but not this computer. */
Shutdown("All Clients", ProjectRestartGet(), 6, "ClusterXYZ");
See Also
ShutdownForm
Displays a dialog box to verify that the user really wants to shut down the CitectSCADA
system. If the user selects [Yes], CitectSCADA is shut down.
complete.
Syntax
ShutdownForm()
Return Value
Related Functions
Shutdown
529
Example
System Keyboard
Key Sequence Shutdown
Command ShutdownForm();
Comment Display the shutdown form
Buttons
Text Shutdown
Command ShutdownForm();
Comment Display the shutdown form
See Also
ShutdownMode
Gets the mode of the last Shutdown function call. The mode is useful to identify the type of
Shutdown that was performed.
Syntax
ShutdownMode()
Return Value
The shutdown mode set when shutdown was called.
Related Functions
Shutdown
Example
nMode = ShutdownMode()
If nMode = 4 Then
Prompt ("Citect closed down and computer was rebooted")
END
See Also
SwitchConfig
Switches focus to a specific CitectSCADA configuration application. If the specified appli-
cation is not running, it will be started.
Syntax
SwitchConfig(nApp)
nApp:
The configuration application:
1 - Citect Graphics Builder (CTDRAW32.EXE)
530
2 - Citect Project Editor (CTEDIT32.EXE)

3 - Citect Explorer (CTEXPLOR.EXE)
4 - Citect Cicode Editor (CTCICODE.EXE)
Return Value
Example
! Switch to the Graphics Builder.
SwitchConfig(1);
See Also
TestRandomWave
Generates a random wave. The height of the wave is restricted by minimum and maximum
values. You can offset the starting point of the wave, for example, to display multiple
waves at the same AN. You can use this function to generate test input.
Syntax
TestRandomWave( [Period] [, Low] [, High] [, Offset] )
Period:
The number of seconds required to generate one cycle of the wave. If no period
is entered, the period has a default of 60.
Low:
The lowest value of the wave. If no low value is entered, this value has a default
of 0.
High:
The highest value of the wave. If no high value is entered, this value has a default
of 100.
Offset:
The offset in seconds, to generate the wave. If no offset is entered, the offset has a
default of 0.
Return Value
The value of the random wave.
Related Functions
TestSawWave, TestSinWave, TestSquareWave, TestTriangWave
Example
/* Specify a random wave of 60 seconds duration, with a minimum
value of 0 units and a maximum value of 100 units, with no offset.
*/
TestRandomWave(60,0,100,0);
531
See Also
TestSawWave
Generates a saw wave. The height of the wave is restricted by minimum and maximum val-
ues. You can offset the starting point of the wave, for example, to display multiple waves
at the same AN. You can use this function to generate test input.
Syntax
TestSawWave( [Period] [, Low] [, High] [, Offset] )
Period:
Low:
of 0.
High:
of 100.
Offset:
default of 0.
Return Value
The value of the saw wave.
Related Functions
TestRandomWave, TestSinWave, TestSquareWave, TestTriangWave
Example
/* Specifies a saw wave of 60 seconds duration, with a minimum
*/
TestSawWave();
See Also
TestSinWave
Generates a sine wave. The height of the wave is restricted by minimum and maximum val-
ues. You can offset the starting point of the wave, for example, to display multiple waves
at the same AN. You can use this function to generate test input.
532
Syntax
TestSinWave( [Period] [, Low] [, High] [, Offset] )
Period:
Low:
of 0.
High:
of 100.
Offset:
default of 0.
Return Value
The value of the sine wave.
Related Functions
TestRandomWave, TestSawWave, TestSquareWave, TestTriangWave
Example
/* Specifies a sine wave of 30 seconds duration, with a minimum
*/
TestSinWave(30);
See Also
TestSquareWave
Generates a square wave. The height of the wave is restricted by minimum and maximum
values. You can offset the starting point of the wave, for example, to display multiple
Syntax
TestSquareWave( [Period] [, Low] [, High] [, Offset] )
Period:
Low:
of 0.
High:
533
of 100.
Offset:
default of 0.
Return Value
The value of the square wave.
Related Functions
TestRandomWave, TestSawWave, TestSinWave, TestTriangWave
Example
/* Specifies a square wave of 30 seconds duration, with a minimum
value of -1000 units and a maximum value of 1000 units, with an
offset of 10 seconds. */
TestSquareWave(30,-1000,1000,10);
See Also
TestTriangWave
Generates a triangular wave. The height of the wave is restricted by minimum and maxi-
mum values. You can offset the starting point of the wave, for example, to display multiple
Syntax
TestTriangWave( [Period] [, Low] [, High] [, Offset] )
Period:
Low:
of 0.
High:
of 100.
Offset:
default of 0.
Return Value
The value of the triangular wave.
534
Related Functions
TestRandomWave, TestSawWave, TestSinWave, TestSquareWave
Example
/* Specifies a triangular wave of 60 seconds duration, with a
minimum value of 0 units and a maximum value of 100 units, with no
offset. */
TestTriangWave();
See Also
Toggle
Toggles a digital tag on or off. If the variable tag is ON (1), this function will turn it OFF. If
the variable tag is OFF (0), this function will turn it ON.
Syntax
Toggle(sTag)
sTag:
The digital tag to toggle.
Return Value
Related Functions
Pulse
Example
Buttons
Text Motor 145
Command Toggle(M145)
Comment Toggle the variable tag M145 (Motor 145) on or off
To toggle the Paging Alarm property:

Toggle(MyCluster.Alarm_1.Paging);
See Also
TraceMsg
Displays a message in the Kernel and Debugger debug windows.
Syntax
TraceMsg(String)
535
String:
The message to display.
Return Value
Related Functions
DspKernel, KerCmd, DumpKernel, DebugBreak, Assert, DebugMsg, DebugMsgSet, Code-
Trace, ErrLog
Example
TraceMsg("Error Found");
// Displays "Error Found" in the debug window
See Also
Version
Gets the version number of the CitectSCADA software in use.
Syntax
Version(Type)
Type:
The type of version:
0 - Major version number
1 - Minor version number
2 - Revision number
3 - Version text
Return Value
The version number as a string.
Example
! If the CitectSCADA version number is 1.2:
Version(0);
! Returns 1.
Version(1);
! Returns 2.
Version(3);
! Returns "1.2".
See Also
536
Chapter: 40 Page Functions
Page functions display graphics pages, files, and the standard alarm, trend, and menu pag-
es.
Page Functions
Following are functions relating to graphics pages:
PageAlarm Displays a category of active alarms on the predefined alarms
page.
PageDisabled Displays a category of disabled alarms on the predefined alarms
page.
PageDisplay Displays a graphics page.
PageFile Displays a file on the predefined file to screen page.
PageFileInfo Returns the width or height of an unopened page in pixels.
PageGetInt Gets a local page-based integer.
PageGetStr Gets a local page-based string.
PageGoto Displays a graphics page without pushing the last page onto the
PageLast stack.
PageHardware Displays the active hardware alarms on the predefined alarms
page.
PageInfo Gets page information.
PageLast Displays the last ten graphics pages.
PageMenu Displays a menu page with page selection buttons.
PageNext Displays the next graphics page.
PagePeekLast Gets any page on the PageLast stack.
PagePopLast Gets the last page on the PageLast stack.
PagePopUp Displays the pop up window at the mouse position.
PagePrev Displays the previous graphics page.
PagePushLast Puts a page on the end of the PageLast stack.
PageRichTextFile Used as a page entry function - creates a rich text object, and
loads a rich text file into that object.
PageSelect Displays a dialog box with a list of graphics pages defined in the
project.
PageSetInt Stores a local page-based integer.
PageSetStr Stores a local page-based string.
PageSummary Displays a category of alarm summary entries on the predefined
alarm page.
PageTrend Displays a standard trend page in a single cluster system.
PageTrendEx Displays a standard trend page in a multi-cluster system.
See Also
Functions Reference
PageAlarm
537
Displays a category of active alarms on the alarm page. To use this function, you must use
the Graphics Builder to create a page called "Alarm" (using the alarm template).
Notes
 The operation of this function has changed. In Version 2.xx this function displayed the
built-in alarm page from the Include project.
 This function is not supported in the server process in a multiprocessor environment.
Calling this function from the server process results in a hardware alarm being raised.
Syntax
PageAlarm( [Category] )
Category:
The alarm category to display. Set to 0 (the default) to display all alarm catego-
ries.
Return Value
Related Functions
PageDisabled, PageHardware
Example
System Keyboard
Key Sequence AlarmPage
Command PageAlarm(0)
Comment Display all active alarms on the alarm page
System Keyboard
Key Sequence Alarm ### Enter
Command PageAlarm(Arg1)
Comment Display a specified category of active alarms on the alarm page
See Also
Page Functions
PageDisabled
Displays a category of disabled alarms on the alarm page. To use this function, you must
use the Graphics Builder to create a page called "Disabled" (using the disabled template).
Notes
built-in disabled alarm page from the Include project.
Syntax
PageDisabled( [Category] )
Category:
538
The alarm category to display. Set to 0 (the default) to display all alarm catego-
ries.
Return Value
Related Functions
PageAlarm
Example
System Keyboard
Key Sequence DisabledPage
Command PageDisabled(0)
Comment Display all disabled alarms on the alarm page
System Keyboard
Key Sequence Disabled ### Enter
Command PageDisabled(Arg1)
Comment Display a specified category of disabled alarms on the alarm page
See Also
Page Functions
PageDisplay
Displays a graphics page in the active window. The page must be in one of the operator’s
current areas. The page to be displayed is identified by its Page Name or the Page Number.
When this function is executed, it tests whether or not the identified page is based on a
CSV_Include project template. If it is, the function uses TaskNew to run a CSV version of
the PageDisplay function, "CSV_MM_PageDisplay". This confirms if multi-monitor sup-
port is required. As TaskNew is used to execute this function, no return value becomes
available to PageDisplay. Under these circumstances, PageDisplay will return zero (0).
You can specify if the page operates within the context of a particular cluster in a multiple
cluster project. When the page launches during runtime, the ClusterName argument is
used to resolve any tags that do not have a cluster explicitly defined.
CitectSCADA saves the current page (onto a stack) before it displays the required page.
You can call PageLast() to re-display the pages on the stack.
You cannot call this function from the Exit command field (see Page Properties) or a Cicode
Object.
Note: This function is not supported in the server process in a multiprocessor environment.
Syntax
PageDisplay(Page,ClusterName)
Page:
539
The name or page number of the page to display (in quotation marks ""). Can be
prefixed by the name of a host cluster, that is "ClusterName.Page". This will take
precedence over the use of the ClusterName parameter if the two differ.
ClusterName:
The name of the cluster that will accommodate the page at runtime (in quotation
marks ""). The specified cluster is used to resolve any tags that do not have a clus-
ter explicitly defined. If the Page parameter is prefixed with the name of a cluster,
this parameter will not be used.
Return Value
0 (zero) if the page is successfully displayed, otherwise an error is returned.
If the page is based on a CSV_Include project template, the function will return 0 (zero) as
a CSV version of the function is executed via TaskNew.
Related Functions
PageGoto, PageLast
Example
Buttons
Text Mimic Page
Command PageDisplay("Mimic")
Comment Display the "Mimic" page
System Keyboard
Key Sequence Page ############## Enter
Command PageDisplay(Arg1)
Comment Display a specified page
PageDisplay("MIMIC1");
! Displays page "MIMIC1".
/* Displays page "MIMIC2" and places page "MIMIC1" onto the
PageLast stack. */
PageDisplay("10");
/* Displays page "10" and places page "MIMIC2" onto the PageLast
stack. */
PageLast();
/* Displays the last page on the stack, that is page "MIMIC2" and
removes it from the stack. */
Note: Before CitectSCADA version 5.0, page records could be edited in the Project Editor.
One of the fields available for configuration was "Page Number". The value entered for a
page could then be used in runtime with the Page Cicode functions such as PageDisplay(),
PageGoto(), and PageInfo(1).
For example, PageDisplay("1") can be used to display the page that has "1" (without the
quotes) set in the Page Number field. PageInfo(1) returns the Page Number of the current
page.
From version 5.0 on, this feature is only backwards-supported. The "Alias" field in the
project Pages.DBF file still contains the Page Numbers from upgraded projects; however,
the Pages database records are no longer available for direct editing in CitectSCADA.
540
See Also
Page Functions
PageFile
Displays a file on the page. After the file is displayed, you can scroll up and down through
the file. To use this function, you must use the Graphics Builder to create a page called "File"
(using the file template).
Notes
built-in file page from the Include project.
Syntax
PageFile(sName)
sName:
The name of the file to display.
Return Value
0 (zero) if the file is successfully displayed, otherwise an error is returned.
Related Functions
DspFile
Example
System Keyboard
Key Sequence File ######## Enter
Command PageFile(Arg1)
Comment Display the specified file on the page
See Also
Page Functions
PageFileInfo
Returns the width or height of an unopened page.
Syntax
PageFileInfo(sPageName, nMode)
sPageName:
The name of the page you would like to retrieve size information for.
nMode:
Retrieves either the width or the height of the specified page in pixels.
0 - returns the page width
1 - returns the page height
541
Return Value
The height or width of the specified page in pixels, depending on the value set for nMode.
See Also
Page Functions
PageGetInt
Gets a local page-based integer. Page-based variables are local to each display page. If two
or more windows are displayed, each window has a unique copy of the variable. You can
use these variables in Cicode to keep track of variables unique to each window.
Notes
 You can find out the current setting for [Page]ScanTime parameter, by calling this func-
tion as follows: PageGetInt(-2).
Syntax
PageGetInt(Offset)
Offset:
The offset in the array of integers.
Return Value
The value of the integer.
Related Functions
PageSetInt, PageGetStr, PageSetStr
See Also
Page Functions
PageGetStr
Gets a local page-based string. Page-based variables are local to each display page. If two
or more windows are displayed, each window has a unique copy of the variable. You can
use these variables in Cicode to keep track of variables unique to each window.
Specify the position of the variable in the array in the Offset argument. (The length of the
array is set by the [Page]MaxStr parameter.)
Syntax
PageGetStr(Offset)
Offset:
The offset in the array of strings.
542
Return Value
The string.
Related Functions
PageSetInt, PageGetInt, PageSetStr
See Also
Page Functions
PageGoto
Displays a graphics page in the active window. The page must be in one of the operator’s
current areas. You can specify either the Page Name or the Page Number of the graphics
page.
You can also specify if the page operates within the context of a particular cluster in a mul-
tiple cluster project. When the page launches during runtime, the ClusterName argument
is used to resolve any tags that do not have a cluster explicitly defined.
This function is similar to PageDisplay(), however PageGoto() does not put the current
page onto the PageLast stack.
Object.
Syntax
PageGoto(Page,ClusterName)
Page:
ClusterName:
The name of the cluster that will accommodate the page at runtime (in quotation
marks ""). The specified cluster is used to resolve any tags that do not have a clus-
ter explicitly defined. If the Page parameter is prefixed with the name of a cluster,
this parameter will not be used.
Return Value
Related Functions
PageDisplay
Example
543
PageLast stack. */
PageGoto("10");
/* Displays page "10". Page "MIMIC2" is not placed onto the
PageLast stack. */
page.
See Also
Page Functions
PageHardware
Displays the active hardware alarms on the alarms page. To use this function, you must use
the Graphics Builder to create a page called "Hardware" (using the alarm template).
Notes
built-in hardware alarm page from the Include project.
Syntax
PageHardware()
Return Value
Related Functions
PageAlarm
Example
System Keyboard
Key Sequence Hardware
Command PageHardware()
Comment Display active hardware alarms on the hardware alarms page
See Also
Page Functions
PageInfo
544
Gets information about the current page.

Syntax
PageInfo(Type)
Type:
The type of page information required:
0 - Page Name
1 - Page Number
2 - Page Title
3 - Display filename
4 - Symbol filename
5 - Next Page Name
6 - Previous Page Name
7 - Previous display count, incremented at each page scan. The page scan rate de-
faults to the value of the Citect.ini parameter [Page]ScanTime, and can be
overridden per page by changing the scan time setting in the General tab
of the page properties in Graphics Builder.
8 - Parent window number. Returns -1 if there is no parent
9 - First child window number. Returns -1 if there are no children
10 - Next child in child link. Returns -1 for the end of the list
11 - Window mode (set by the WinNewAt() function)
12 - Width of window
13 - Height of window
14 - X position of window
15 - Y position of window
16 - Dynamic window horizontal scale
17 - Dynamic window vertical scale
Types 16 and 17 return a real number between 0 and 1 (as a STRING) and will be
identical, as the dynamic scaling does not allow a change in the aspect ra-
tio.
18 - Flashing color state. Type 18 returns one of the following:
 "0" - the palette does not flash
 "1" - the palette is primary now
 "2" - the palette is secondary now
19 - In animation cycle. Returns a 1 (true) or 0 (false)
20 - In communications cycle. Returns a 1 (true) or 0 (false)
21 - Width of background page
22 - Height of background page
23 - The number of animation points on a page
24 - The value of the highest animation point on the page
545
25 - Indicates when the page’s "On Page Shown" event has been triggered. Re-
turns 1 if triggered, 0 if it has not.
26 - The cluster that has been specified to host the page. Returns the cluster name,
or an empty string if no cluster has been specified.
Return Value
The information (as a string).
Related Functions
PageDisplay
Example
! If currently on page "MIMIC1";
Variable=PageInfo(0);
! Sets Variable to "MIMIC1".
quotes) set in the PageNumber field. PageInfo(1) returns the Page Number of the current
page.
See Also
Page Functions
PageLast
Displays the graphics page that was last displayed. With this function, you can successively
recall the last ten pages that were displayed.
Graphics pages displayed using this command cannot be subsequently recalled.
Object.
Syntax
PageLast()
Return Value
546
Related Functions
PagePeekLast, PagePopLast, PagePushLast
Example
Buttons
Text Last Page
Command PageLast()
Comment Display the graphics page that was last displayed
PageLast stack. */
PageDisplay("10");
! Displays page "10" and places page "MIMIC2" onto the PageLast
stack.
PageLast();
PageLast();
PageLast();
/* Returns an "Out of range" error code as there are no more pages
on the stack.*/
See Also
Page Functions
PageMenu
Displays a menu page with page selection buttons. A page goto button is displayed for each
of the first 40 pages defined in the project.
Syntax
PageMenu()
Return Value
Related Functions
PageGoto, PageLast, PagePrev, PageSelect
547
Example
Buttons
Text Menu
Command PageMenu()
Comment Display the menu page
System Keyboard
Key Sequence Menu
Command PageMenu()
Comment Display the menu page
See Also
Page Functions
PageNext
Displays the next page as specified in the project.
Object.
Syntax
PageNext()
Return Value
Related Functions
PagePrev
Example
Buttons
Text Page Next
Command PageNext()
Comment Display the next page in the browse sequence
System Keyboard
Key Sequence PageNext
Command PageNext()
Comment Display the next page in the browse sequence
/* If graphics page 1 is currently displayed, and the graphics

page 1 has Next Page Name=10. */
PageNext();
! Displays graphics page 10.
548
See Also
Page Functions
PagePeekLast
Gets the Page Name at an offset in the PageLast stack (without removing the page from the
stack).
Syntax
PagePeekLast(Offset)
Offset:
The offset from the end of the PageLast stack. Offset 0 is the last page on the stack,
Offset 1 is the second last page on the stack, etc.
Return Value
The Page Name or an empty string if there is no last page.
Related Functions
PagePopLast, PagePushLast
Example
PageLast stack. */
PageDisplay("10");
stack.
PageGoto(PagePeekLast(0));
PageGoto(PagePeekLast(1));
See Also
Page Functions
PagePopLast
Gets the Page Name of the last item on the PageLast stack and removes the page from the
stack.
Syntax
PagePopLast()
549
Return Value
The page name or an empty string if there is no last page.
Related Functions
PageLast
Example
PageLast stack. */
PageDisplay("10");
stack.
Variable=PagePopLast();
/* Sets Variable to "MIMIC2" and removes "MIMIC2" from the
PageLast stack. */
PageLast();
See Also
Page Functions
PagePopUp
Display pop up window at the mouse position. If the mouse position is not known then the
pop up will display in the centre of the screen. The window is displayed with no resize and
will be closed if the page is changed.
Syntax
PagePopUp(sPage)
sPage:
The name of the page (drawn with the Graphics Builder).
Return Value
page.
550
Related Functions
PageLast
See Also
Page Functions
PagePrev
Displays the previous page as specified in the project.
Object.
Syntax
PagePrev()
Return Value
Related Functions
PageNext
Example
Buttons
Text Page Previous
Command PagePrev()
Comment Display the previous page in the browse sequence
System Keyboard
Key Sequence PagePrev
Command PagePrev()
Comment Display the previous page in the browse sequence
/* If graphics page 10 is currently displayed, and graphics page

10 has Prev Page Name=1. */
PagePrev();
! Displays graphics page 1.
See Also
Page Functions
PagePushLast
Places a page at the end of the PageLast stack.
551
Syntax
PagePushLast(Page)
Page:
The Page Name or Page Number (of the page) to place at the end of the PageLast
stack.
Return Value
Related Functions
PagePopLast, PagePeekLast
Example
PageLast stack. */
PageDisplay("10");
stack.
PagePushLast("TREND1");
! Places page "TREND1" onto the PageLast stack.
PageLast();
/* Displays the last page on the stack, that is page "TREND1" and
PageLast();
See Also
Page Functions
PageRichTextFile
This function creates a rich edit object, and loads a copy of the rich text file Filename into
that object. The rich text object will be rectangular in shape, with dimensions determined
by nHeight, and nWidth. If you do not specify nHeight and nWidth, AN will define the posi-
tion of one corner, and (AN + 1) the position of the diagonally opposite corner. This function
would often be used as a page entry function.
Syntax
PageRichTextFile(AN, Filename, nMode [, nHeight] [, nWidth] )
AN:
The animation point at which to display the rich text object.
Filename:
The name of the file to be copied and loaded into the rich text object. The filename
must be entered in quotation marks "".
552
If you are loading a copy of an RTF report, the report must have already been run
and saved to a file.
Remember that the filename for the saved report comes from the File Name field
in the Devices form. The location of the saved file must also be included as part
of the filename. For example, if the filename in the Devices form listed [Da-
ta];RepDev.rtf, then you would need to enter "[Data]\repdev.rtf" as your argu-
ment. Alternatively, you can manually enter the path, for example,
If you are keeping a number of history files for the report, instead of using the rtf
extension, you must change it to reflect the number of the desired history file, for
example, 001.
nMode:
The display mode for the rich text object. The mode can be any combination of:
0 - Disabled - should be used if the rich text object is to be used for display pur-
poses only.
1 - Enabled - allows you to select and copy the contents of the RTF object (for in-
stance an RTF report), but you will not be able to make changes.
2 - Read/Write - allows you to edit the contents of the RTF object. Remember,
however, that the object must be enabled before it can be edited. If it has
already been enabled, you can just enter Mode 2 as your argument. If it is
not already enabled, you will need to enable it. By combining Mode 1 and
Mode 2 in your argument (3), you can enable the object, and make it read/
write at the same time.
Because the content of the rich text object is just a copy of the original file, changes
will not affect the actual file, until saved using the DspRichTextSave function.
nHeight:
The height of the rich text object in pixels. The height is established by measuring
down from the animation point.
If you do not enter a height and width, the size of the object will be determined
by the position of AN and AN+1.
nWidth:
The width of the rich text object in pixels. The width is established by measuring
across to the right of the animation point.
If you do not enter a height and width, the size of the object will be determined
by the position of AN and AN+1.
Return Value
None
Related Functions
DspRichText, DspRichTextLoad, DspRichTextEdit, DspRichTextEnable, DspRichTextGet-
Info, DspRichTextPgScroll, DspRichTextPrint, DspRichTextSave, DspRichTextScroll, File-
RichTextPrint
Example
PageRichTextFile(108,"f:\citect\data\richtext.rtf",0);
// This function would produce a rich text object at animation
point 108. Into this object a copy of f:\citect\data\richtext.rtf
553
would then be loaded. Remember, richtext.rtf is the name of the

output file for the report, as specified in the Devices form.
Because 0 was specified as the nMode for this example, the
contents of this object will be display only. //
PageRichTextFile(53,"[Data]\richtext.rtf",1);
//This function would produce a rich text object at animation
point 53. Into this object a copy of [Data]\richtext.rtf would
then be loaded. It will be possible to select and copy the
contents of the object, but not make changes. //
See Also
Page Functions
PageSelect
Displays a dialog box with a list of all graphics pages defined in the project. AN operator
can select a page name for display.
Syntax
PageSelect()
Return Value
Related Functions
PageGoto, PageLast, PagePrev, PageMenu
Example
Buttons
Text Page Select
Command PageSelect()
Comment Display the page selection dialog box
PageSelect();
! Displays the page selection dialog box.
See Also
Page Functions
PageSetInt
Stores a local page-based integer. Page-based variables are stored in an array, local to each
display page. This function allows you to save integer variables in temporary storage.
Notes
 You can dynamically change the setting for [Page]ScanTime parameter, by calling this
function as follows: PageSetInt(-2, <scantime>).
554
Syntax
PageSetInt(Offset, Int)
Offset:
Int:
The integer value to store.
Return Value
Related Functions
PageGetInt, PageGetStr, PageSetStr
See Also
Page Functions
PageSetStr
Stores a local page-based string. Page-based variables are stored in an array, local to each
display page. This function allows you to save string variables in temporary storage.
Specify the position of the variable in the array in the Offset argument. (The length of the
array is set by the [Page]MaxStr parameter.)
Syntax
PageSetStr(Offset, String)
Offset:
String:
The string to store. The string length is 128 characters.
Return Value
Related Functions
PageGetInt, PageGetStr, PageSetInt
See Also
Page Functions
PageSummary
Displays a category of alarm summary entries on the alarm page. To use this function, you
must use the Graphics Builder to create a page called "Summary" (using the alarm tem-
plate).
555
Notes
built-in summary alarm page from the Include project.
Syntax
PageSummary(Category)
Category:
The category number for the alarms you want to summarise.
Return Value
Related Functions
PageAlarm
Example
System Keyboard
Key Sequence SummaryPage
Command PageSummary(0)
Comment Display all alarm summary entries on the alarm page
System Keyboard
Key Sequence Summary ### Enter
Command PageSummary(Arg1)
Comment Display a specified category of alarm summary entries on the alarm
page
See Also
Page Functions
PageTrend
Displays a trend page with the specified trend pens. Use this function to display trends in
a single cluster system with a single trend page. You must create the trend page with the
Graphics Builder and set all the pen names to blank. Then display that page by calling this
function and passing the required trend tags. Call this function from a menu of trend pages.
Note: Because you cannot mix templates in a project, PageTrend will not work if you have
included the CSV_Include project in your project. For example, if your project includes the
CSV_Include project, PageTrend("pagename", "trendtag") only works on trend pages
based on XP-style templates (that is, "Trend"). When using PageTrend to go to a page based
on a standard template (for example, "SingleTrend"), the page displays, but no trend tag is
added. This also applies for the CSV_Trend_Page function.
This function is not supported in the server process in a multiprocessor environment. Call-
ing this function from the server process results in a hardware alarm being raised. For a
multi-cluster system use PageTrendEx.
556
Syntax
PageTrend(sPage, sTag1 [, sTag2..sTag8] )
sPage:
Name of the trend page (drawn with the Graphics Builder).
sTag1:
The first trend tag to display on the page.
sTag2..sTag8:
Optionally trend tags 2 to 8 to display on the page.
Return Value
page.
Related Functions
TrnNew, TrnSelect, TrendWin, TrendPopUp, PageTrendEx
Example
Buttons
Text Process Trend
Command PageTrend("MyTrend", "PV1", "PV2", "PV3")
Comment Display the trend page with three trend pens
PageTrend("MyTrend", "PV1", "PV2", "PV3")

/* Display three trend tags on a single trend page. */
See Also
Page Functions
PageTrendEx
Displays a trend page of a specified cluster in a multi-cluster system with the specified
trend pens. Use this function to display trends in a mult-cluster system with a single trend
page. You must create the trend page with the Graphics Builder and set all the pen names
to blank. Then display that page by calling this function and passing the required trend
tags. Call this function from a menu of trend pages. This function can also be used in a sin-
gle cluster system, the sCluster argument is optional in such a case.
557
Note: Because you cannot mix templates in a project, PageTrendEx will not work if you
have included the CSV_Include project in your project. For example, if your project in-
cludes the CSV_Include project, PageTrend("pagename", "trendtag") only works on trend
pages based on XP-style templates (that is, "Trend"). When using PageTrend to go to a page
based on a standard template (for example, "SingleTrend"), the page displays, but no trend
tag is added. This also applies for the CSV_Trend_Page function.
This function is not supported in the server process in a multiprocessor environment. Call-
ing this function from the server process results in a hardware alarm being raised.
Syntax
PageTrendEx(sPage, sCluster, sTag1 [, sTag2..sTag8] )
sPage:
Name of the trend page (drawn with the Graphics Builder).
sCluster:
Name of the cluster in which the trend page is located.
sTag1:
The first trend tag to display on the page.
sTag2..sTag8:
Optionally trend tags 2 to 8 to display on the page.
Return Value
page.
Related Functions
TrnNew, TrnSelect, TrendWin, TrendPopUp, PageTrend
Example
Buttons
Text Process Trend
Command PageTrendEx("MyTrend", "MyCluster", "PV1", "PV2", "PV3")
Comment Display the trend page on the specified cluster with three trend pens
PageTrendEx("MyTrend", "MyCluster", "PV1", "PV2", "PV3")

/* Display three trend tags on a single trend page on the
specified cluster. */
558
See Also
Page Functions
559
560
Chapter: 41 Plot Functions
With the plot functions, you can plot system data on the screen or on your system print-
er(s).
Plot Functions
Following are functions relating to plotting data:
PlotClose Displays and/or prints the plot, then closes the plot.
PlotDraw Draws a point, line, box, or circle on a plot.
PlotFile This function is now obsolete.
PlotGetMarker Gets the marker number of a symbol that is registered as a mark-
er.
PlotGrid Draws gridlines to be used for plotted lines.
PlotInfo Gets information about a plot.
PlotLine Plots a line through a set of data points.
PlotMarker Draws markers on a plotted line or at a specified point.
PlotOpen Opens a new plot, sets its output device, and returns a plot handle
for use by the other plot functions.
PlotScaleMarker Draws scale lines (with markers) beside the grid on your plot (if
there is one).
PlotSetMarker Sets (registers) a symbol as a marker.
PlotText Draws text on a plot.
PlotXYLine Draws an XY line through a set of data points.
See Also
Functions Reference
PlotClose
Displays the plot on screen or sends it to the printer (depending on the output device you
specified in the PlotOpen() function), then closes the plot. Once the plot is closed, it cannot
be used.
Syntax
PlotClose(hPlot)
hPlot:
The plot handle, returned from the PlotOpen() function. The plot handle identi-
fies the table where all data on the plot is stored.
Return Value
561
Related Functions
PlotDraw, PlotGetMarker, PlotGrid, PlotInfo, PlotLine, PlotMarker, PlotOpen, PlotScale-
Marker, PlotSetMarker, PlotText, PlotXYLine, TrnPlot
Example
See PlotOpen
See Also
Plot Functions
PlotDraw
Constructs drawings on your plot. Use the coordinates (X1,Y1) and (X2,Y2) to define a
point, line, rectangle, square, circle, or ellipse. You can specify the style, color, and width of
the pen, and a fill color for a box or circular shape.
You must call the PlotOpen() function first, to get the handle for the plot (hPlot) and to spec-
ify the output device.
Syntax
PlotDraw(hPlot, Type, PenStyle, PenCol, PenWidth, nFill, X1, Y1, X2, Y2)
hPlot:
Type:
The type of drawing:
1 - Rectangle or square
2 - Circle or ellipse
3 - Line
4 - Point
PenStyle:
The style of the pen used to draw:
0 - Solid
1 - Dash ( - - - - - )
2 - Dot (...............................)
3 - Dash and dot ( - . - . - . - . - )
4 - Dash, dot, dot ( - . . - . . - . . - )
5 - Hollow
PenCol:
The color of the pen (flashing color is not supported). Select a color from the list
of Predefined Color Names and Codes or create an RGB-based color using the
function MakeCitectColour.
PenWidth:
Pen width in pixels. If the width is thicker than one pixel, you must use a solid
pen (PenStyle = 0). Maximum width is 32.
562
nFill:
The fill color of the rectangle, square, circle, or ellipse (flashing color is not sup-
ported). Select a color from the list of predefined color names and codes or create
an RGB-based color using the function MakeCitectColour. For a point or line,
nFill is ignored.
X1, Y1:
X and y coordinates (in pixels) of the upper-left corner of the drawing (the origin).
X2, Y2:
X and y coordinates (in pixels) of the lower-right corner of the drawing.
For a point, (X1,Y1) and (X2,Y2) are assumed to be the same, so (X2,Y2) is ignored.
To draw a circle or ellipse, enter the coordinates for a square or rectangle; the cir-
cle or ellipse is automatically drawn within the box.
If the plot is for display on the screen, all coordinates are relative to the AN spec-
ified in the PlotOpen() function. If the output device is a printer, all coordinates
are relative to the point (0,0).
Return Value
Related Functions
PlotClose, PlotGrid, PlotInfo, PlotLine, PlotMarker, PlotOpen, PlotScaleMarker, PlotText,
PlotXYLine, TrnPlot
Example
See PlotOpen.
See Also
Plot Functions
PlotGetMarker
Gets the marker number of a symbol. The symbol must be a symbol and registered with the
PlotSetMarker() function.
Syntax
PlotGetMarker(sSymbolName)
sSymbolName:
The library name and symbol name ("Library.Symbol") of the symbol that is reg-
istered as a marker.
Return Value
The marker number if successful, otherwise -1 is returned.
Related Functions
PlotMarker, PlotScaleMarker, PlotSetMarker
563
Example
/*Assume that the symbol was registered by PlotSetMarker function */
PlotSetMarker(20,"Global.Hourglass");
/*Later on, this symbol can be used as shown below*/
hPlot = PlotOpen(36,"Display",1);
..
/* Display red hourglass as marker at point (100,200) on AN36. */
MarkerNo = PlotGetMarker("Global.Hourglass");
PlotMarker(hPlot,MarkerNo,red,1,1,100,200);
..
PlotClose(hPlot);
See Also
Plot Functions
PlotGrid
Defines a frame and draws horizontal and vertical grid lines within this frame. These grid
lines can then be used by the PlotLine(), PlotXYLine(), and PlotScaleMarker() functions.
You must define the frame for a plot before you can plot points with the PlotLine() and
PlotXYLine() functions. nSamples specifies the maximum number of samples that can be
plotted for a single line. If you set FrameWidth to 0 (zero), the frame will be defined but not
displayed (however, the plot will still be displayed).
You can specify the number of grid lines and their color, as well as the background color
which will fill the frame. If nHorGrid and nVerGrid are set to 0 (zero), then the grid lines will
not be drawn.
You must call the PlotOpen() function, first, to get the handle for the plot (hPlot), and to
specify the output device. Then call this function to set up the frame and grid. You can then
call the PlotScaleMarker() function to draw scale lines beside the frame, and call the Plot-
Line() or PlotXYLine() to plot a set of data points.
Syntax
PlotGrid(hPlot, nSamples, X1, Y1, X2, Y2, nHorGrid, HorGridCol, nVerGrid, VerGridCol,
FrameWidth, FrameCol, nFill, nMode)
hPlot:
Plot handle, returned from the PlotOpen() function. The plot handle identifies the
table where all data on the plot is stored.
nSamples:
The maximum number of samples that can be plotted for a single line in this
grid (valid values between 2 and 16000 inclusive). For example, if you set nSam-
ples to 10, then plot 2 lines in this grid (using the PlotLine() function), each line
will be plotted with a maximum of 10 samples. For this example, a line can pos-
sess less than 10 samples, but if it has more, it will be shortened to 10 samples.
X1, Y1:
The x and y coordinates of the upper-left corner of the frame containing the grid
lines.
X2, Y2:
564
The x and y coordinates of the lower-right corner of the frame containing the grid
lines.
If the plot is for display on the screen, you should set (X1,Y1) to (0,0). The origin
of the frame is then positioned at the AN specified in the PlotOpen() function.
If the output device is a printer, both (X1,Y1) and (X2,Y2) are relative to the point
(0,0).
nHorGrid:
The number of rows (formed by the horizontal grid lines) to draw within the
frame. If you do not need grid lines, set nHorGrid to 0 (zero) and HorGridCol to
0. nHorGrid cannot exceed the pixel width of the plot.
HorGridCol:
The color of the horizontal grid lines (flashing color is not supported). Select a col-
or from the list of Predefined Color Names and Codes or create an RGB-based
color using the function MakeCitectColour.
nVerGrid:
The number of columns (formed by the vertical grid lines) to draw within the
frame. If you do not need grid lines, set nVerGrid to 0 (zero) and VerGridCol to
0. nVerGrid cannot exceed the pixel height of the plot.
VerGridCol:
The color of the vertical grid lines (flashing color is not supported). Select a color
from the list of Predefined Color Names and Codes or create an RGB-based color
using the function MakeCitectColour.
FrameWidth:
The width (also called pen width) of the frame enclosing the grid, in pixels. To
define the frame without drawing its boundaries, set FrameWidth to 0 (zero) and
FrameCol to 0. The maximum is 32.
FrameCol:
The color of the frame enclosing the grid (flashing color is not supported). Select
a color from the list of Predefined Color Names and Codes or create an RGB-
based color using the function MakeCitectColour.
nFill:
The background color for the frame (flashing color is not supported). Select a col-
or from the list of Predefined Color Names and Codes or create an RGB-based
color using the function MakeCitectColour.
nMode:
The mode of the plot. For future use only - set it to 0 (zero).
Return Value
Related Functions
PlotClose, PlotDraw, PlotInfo, PlotLine, PlotMarker, PlotOpen, PlotScaleMarker, PlotText,
PlotXYLine, TrnPlot
Example
See PlotOpen
565
See Also
Plot Functions
PlotInfo
Gets information about the plot. You can call this function to determine the number of pix-
els per page or inch, the resolution of a plot, and the size and spacing of characters for a
specified text font. You can also check whether a printer can print rotated text. (See Plot-
Text().)
You must first call the PlotOpen() function to get the handle for the plot (hPlot) and specify
the output device.
Syntax
PlotInfo(hPlot, Type [, sInput] )
hPlot:
Type:
The type of plot information to get:
0 - Horizontal pixels on a printout page
1 - Vertical pixels on a printout page
2 - Horizontal pixels per inch
3 - Vertical pixels per inch
4 - Horizontal resolution
5 - Vertical resolution
6 - Height of the font used
7 - External leading of the font used
8 - Character width of the font used
9 - Rotatable text is allowed or not
10 - Indicates whether or not a font is supported
11 - Horizontal size of a page in millimeters
12 - Vertical size of a page in millimeters
sInput:
The font handle (hFont), returned from the DspFont() function. Useful only for
Type 6, 7, 8, or 10.
Return Value
The attributes of the plot as a string.
Related Functions
PlotClose, PlotDraw, PlotGrid, PlotLine, PlotMarker, PlotOpen, PlotScaleMarker, PlotText,
PlotXYLine, TrnPlot
566
Example
hPlot = PlotOpen(36,"Display",1);
:
/* Print text in upward direction but first check if printer
supports text rotation. Set default text orientation to left to
right (just in case). */
Orient = 0;
IF PlotInfo(hPlot,9) THEN
Orient = 1;
END
PlotText(hPlot,hFont,Orient,100,100,"scale");
..
/* Print text "Citect Graph" centred horizontally at top of page.*/
PageWidth = PlotInfo(hPlot,0); ! Get width of page
hFont = DspFont("Courier",14,black,-1);
TextWidth = PlotInfo(hPlot,8,hFont); ! Get width of each character
TextPosn = (PageWidth - TextWidth * 12) / 2 ! Get start of 1st character
PlotText(hPlot,hFont,0,TextPosn,0,"Citect Graph");
..
PlotClose(hPlot);
See Also
Plot Functions
PlotLine
Draws a line (in the CitectSCADA plot system) for a set of data points. You specify the data
points in the table pTable, and plot these points between the LoScale and HiScale values. The
line is drawn inside the frame defined by the PlotGrid() function.
For each line on a plot, you can specify a different pen style, color, and width, and a differ-
ent marker style and color. You can draw lines either from left to right or from right to left.
the output device. You should then use the PlotGrid() function to set up the frame and grid,
before you call this function to plot the line.
Syntax
PlotLine(hPlot, PenStyle, PenCol, PenWidth, MarkerStyle, MarkerCol, nMarker, Length, pTable,
LoScale, HiScale, Mode)
hPlot:
PenStyle:
0 - Solid
1 - Dash ( - - - - - )
2 - Dot (...............................)
3 - Dash and dot ( - . - . - . - . - )
4 - Dash, dot, dot ( - . . - . . - . . - )
567
5 - Hollow
PenCol:
PenWidth:
The width of the pen, in pixels. If the width is thicker than one pixel, you must
use a solid pen (PenStyle = 0). The maximum width is 32.
MarkerStyle:
The style of the markers:
0 - No markers
1 - Triangle
2 - Square
3 - Circle
4 - Diamond
5 - Filled triangle
6 - Filled square
7 - Filled circle
8 - Filled diamond
20 - 32000 - User-defined markers. You can register any symbol as a marker with
the PlotSetMarker() function. Call the PlotGetMarker() function if you do
not know the number of a marker you have previously registered.
MarkerCol:
The color of the markers (flashing color is not supported). Select a color from the
list of predefined color names and codes or create an RGB-based color using the
nMarker:
The number of samples between markers.
Length:
The length of the array, that is, the number of points in the table pTable for Plot-
Line(), or in tables xTable and yTable for PlotXYLine().
 For every line you draw with the PlotLine() and PlotXYLine() functions within
a plot, you must add the Length arguments for each call, and pass the total to
the PlotGrid() function (in the nSamples argument).
pTable:
The points to be plotted (as an array of floating-point values).
LoScale:
The lowest value that will be displayed on the plot (that is the value assigned to
the origin of your grid). The LoScale and HiScale values determine the scale of
your grid. This scale is used to plot values. for example, If LoScale = 0 (zero) and
HiScale = 100, a value of 50 will be plotted half way up the Y-axis of your grid.
LoScale must be in the same units as the values in pTable.
HiScale:
568
The highest value that will be displayed on the plot. The LoScale and HiScale val-
ues determine the scale of your grid. This scale is used to plot values. for example,
If LoScale = 0 (zero) and HiScale = 100, a value of 50 will be plotted half way up
the Y- axis of your grid. HiScale must be in the same units as the values in pTable.
Mode:
The origin of your grid, and the direction of the plotted line:
1 - Origin is bottom-left, x is left to right, y is upwards
2 - Origin is bottom-right, x is right to left, y is upwards
4 - Origin is top-left, x is left to right, y is downwards
8 - Origin is top-right, x is right to left, y is downwards
Return Value
Related Functions
PlotClose, PlotDraw, PlotGetMarker, PlotGrid, PlotInfo, PlotMarker, PlotOpen, PlotScale-
Example
See PlotOpen
See Also
Plot Functions
PlotMarker
Draws markers on a plotted line or at a specified point. You can plot any one of the stan-
dard markers, or use a symbol of your choice. (You must first register your symbol as a
marker, by using the PlotSetMarker() function.)
To draw a single marker at a specified point, set X and Y to the coordinates of the point,
and set Length to 1.
You can draw markers on a plotted line when you draw the line, that is within the Plot-
Line() or PlotXYLine() function. You would use the PlotMarker() function only if you need
to draw a second set of markers on the same line. Call PlotMarker() immediately after the
line is drawn. Set X and Y to -1 and Length to the number of data points (specified in the
Length argument of the PlotLine() or PlotXYLine() function).
the output device.
Syntax
PlotMarker(hPlot, MarkerStyle, MarkerCol, nMarker, Length, X, Y)
hPlot:
MarkerStyle:
569
0 - No markers
1 - Triangle
2 - Square
3 - Circle
4 - Diamond
5 - Filled triangle
6 - Filled square
7 - Filled circle
8 - Filled diamond
20 - 32000: User-defined markers. You can register any symbol as a marker with
MarkerCol:
The color of the marker (flashing color is not supported). Select a color from the
list of Predefined Color Names and Codes or create an RGB-based color using the
nMarker:
Length:
The length of the array (the number of line points in the table pTable) plotted in
the PlotLine() or PlotXYLine() function. To draw only one marker at a specified
point, set Length to 1.
X, Y:
The x and y coordinates, in pixels, of the point where the marker is to be drawn.
If the plot is for display on the screen, the coordinates are relative to the AN spec-
ified in the PlotOpen() function. If the output device is a printer, the coordinates
To draw the markers on a plotted line, set both X and Y to -1, and set Length to
the same value as the Length passed in the PlotLine() or PlotXYLine() function.
Return Value
Related Functions
PlotClose, PlotDraw, PlotGetMarker, PlotGrid, PlotInfo, PlotLine, PlotOpen, PlotScale-
Example
hPlot=PlotOpen(36,"Display",1);
..
/* Draw a filled red square marker at the point (X=100,Y=200). */
PlotMarker(hPlot,6,red,1,1,100,200);
..
/* Draw 10 black triangles and 5 green cylinders along a plot
line. */
PlotLine(hPlot,0,black,3,5,black,10,100,Buf2[0],0,100,2);
PlotSetMarker(20,"Global.Cylinder");
570
PlotMarker(hPlot,20,green,5,100,-1,-1)
..
PlotClose(hPlot);
See Also
Plot Functions
PlotOpen
Opens a new plot, sets its output device, and returns its plot handle. You can send the plot
to any one of your system printers, or display it on screen at the specified AN.
You must call this function before you can call the other plot functions.
Syntax
PlotOpen(AN, sOutput, Mode)
AN:
The animation point (AN) where the plot will display. Set the AN to 0 (zero)
when sOutput is a printer.
Do not use an animation point number at which a graphic object exists as this will
prevent the PlotOpen() function from succeeding.
sOutput:
The output device where the plot is sent, for example:
 "Display" - Display on screen. The plot is recorded in a metafile and displayed
(at the specified AN) when the plot system is closed.
 "LPT1:" - Send to printer LPT1.
 "LPT2:" - Send to printer LPT2.
 "\\ABC\Printers\Color1" - Send to UNC port (and so on for any output de-
vice)
Mode:
When a plot is removed or updated, the portion of the background screen be-
neath it is blanked out. The mode determines how the background screen is re-
stored. The mode of the plot system:
1 - Normal mode
2 - Use for compatibility with the old graph functions
17 - Soft (valid for normal mode). The background screen (a rectangular region
beneath the plot) is restored with the original image. Any objects that are
within the rectangular region are destroyed when the background is re-
stored.
33 - Hard (valid for normal mode). The background screen (a rectangular region
beneath the plot) is painted with the color at the AN.
65 - Persistent (valid for normal mode). The plot is not erased. As the plot is up-
dated, it is re-displayed on top. This mode provides fast updates. Trans-
parent color is supported in this mode.
129 - Opaque animation (valid for normal mode). The plot is not erased. As the
plot is updated, it is re-displayed on top. This mode provides the fastest
updates. Transparent color is not supported in this mode.
571
257 - Overlapped animation (valid for normal mode). The background screen (the
rectangular region beneath the plot) is completely repainted.
Return Value
The plot handle if the plot is opened successfully, otherwise -1 is returned. The plot handle
identifies the table where all data on the associated plot is stored.
Related Functions
PlotClose, PlotDraw, PlotGrid, PlotInfo, PlotLine, PlotMarker, PlotScaleMarker, PlotText,
PlotXYLine, TrnPlot
Example
hPlot=PlotOpen(0,"LPT2:",1);
IF hPlot <> -1 THEN
/* Set up a black frame with red & blue grid lines. */
PlotGrid(hPlot,18,450,800,1850,1600,5,red,10,blue,4,black,white,0);
/* Draw a scale line to the left of the frame. */
PlotScaleMarker(hPlot,400,1600,6,1,black,0);
/* Plot a simple line in green for a table of 10 values. */
PlotLine(hPlot,0,green,3,6,green,2,10,Buf1,0,100,1);
/* Plot a line in yellow (with black markers) for tables of 8 X and Y values. */
PlotXYLine(hPlot,0,yellow,4,3,black,2,8,Buf2,0,150,Buf3,0,100,1);
/* Draw a title box above the plot frame, with the heading "Citect Graph". */
PlotDraw(hPlot,1,0,black,1,grey,900,250,1400,400);
hFont = DspFont("Times",-60,black,grey);
PlotText(hPlot,hFont,0,950,350,"Citect Graph");
PlotClose(hPlot);
END
The above example prints the following (on the printer):
572
PlotOpen(0,"LPT1:",1) // opens a new plot to be sent to printer

PlotOpen(20,"DISPLAY",17) // normal plot with soft animation
PlotOpen(20,"DISPLAY",257) // normal plot with overlap animation
PlotOpen(20,"DISPLAY",1) // normal plot with overlap animation(for default ani-
mation mode is overlap animation)
PlotOpen(20,"DISPLAY",16) // INVALID (does not specify whether it is normal or
Version 2.xx mode).
PlotOpen(20,"DISPLAY",2) // INVALID for Version 2.xx graph system (does not sup-
port display as output).
See Also
Plot Functions
PlotScaleMarker
Draws scale lines beside the grid on your plot (if there is one) and places markers on them.
The height of the scale line is automatically set to the height of the frame set in the Plot-
Grid() function.
the output device. You should then use the PlotGrid() function to set up the frame and grid,
before you call this function to draw the scale lines.
Syntax
PlotScaleMarker(hPlot, X, Y, nMarker, PenWidth, PenCol, Mode)
hPlot:
573
X, Y:
The x and y coordinates of the point where the scale line starts. The end coordi-
nates of the scale line are automatically defined by the size of the frame (set in the
PlotGrid() function).
If the plot is for display on the screen, all coordinates are relative to the AN spec-
ified in the PlotOpen() function. If the output device is a printer, all coordinates
nMarker:
The number of markers on the scale line.
PenWidth:
The width of the scale line, in pixels.
PenCol:
Mode:
The mode of the markers:
0 - Both sides of the scale line
1 - Left of the scale line
2 - Right of the scale line
Return Value
Related Functions
PlotClose, PlotDraw, PlotGrid, PlotInfo, PlotLine, PlotMarker, PlotOpen, PlotText, PlotXY-
Line, TrnPlot
Example
See PlotOpen
See Also
Plot Functions
PlotSetMarker
Registers a symbol as a marker. You can then draw the new marker at points and on plotted
lines, by specifying the MarkerNo of the symbol as the MarkerStyle in the PlotMarker() func-
tion. Call the PlotGetMarker() function if you do not know the number of a marker.
Syntax
PlotSetMarker(MarkerNo, sSymbolName)
MarkerNo:
574
The number of the marker, to be used as the MarkerStyle in the PlotMarker()

function. Your marker numbers must be greater than or equal to 20 (to a maxi-
mum of 32000).
sSymbolName:
The name and path of the symbol to be defined as a marker.
Return Value
Related Functions
PlotMarker, PlotScaleMarker, PlotGetMarker
Example
hPlot=PlotOpen(30,"Display",1);
..
/* Display red hourglass as marker at point (100,200). */
PlotSetMarker(20,"Global.Hourglass");
PlotMarker(hPlot,20,red,1,1,100,200);
..
PlotClose(hPlot);
See Also
Plot Functions
PlotText
Prints text on a plot. You can specify the font, position, and orientation of the text. If you
specify an orientation other than ’left-to-right’, you must check that the font (and the print-
er) supports the orientation.
the output device. You also must call the DspFont() function to get a handle for the font
(hFont).
Syntax
PlotText(hPlot, hFont, Orientation, X, Y, sText)
hPlot:
hFont:
The font handle, returned from the DspFont() function. The font handle identifies
the table where details of that font are stored.
Orientation:
The orientation of the text:
0 - Left-to-right
1 - Upwards
2 - Right-to-left
575
3 - Downwards
You should check that the font supports rotation (where Orientation = 1, 2, or 3).
Most true type and vector fonts support rotation. If the PlotInfo(hPlot, 9) function
returns false, you must specify an Orientation of 0 (zero).
X, Y:
The x and y coordinates (in pixels) of the start of the text. If the plot is for display
on the screen, the coordinates are relative to the AN specified in the PlotOpen()
function. If the output device is a printer, the coordinates are relative to the point
(0,0).
sText:
The text string to be plotted.
Return Value
Related Functions
DspFont, PlotClose, PlotDraw, PlotGrid, PlotInfo, PlotLine, PlotMarker, PlotScaleMarker,
PlotXYLine, TrnPlot
Example
See PlotOpen.
See Also
Plot Functions
PlotXYLine
Plots values from two different tables. Values from one table are considered X coordinates,
and values from the other are considered Y coordinates. Points are plotted between the low
and high scale values specified for x and y. The line is plotted inside the frame defined by
the PlotGrid() function.
For each line, you can specify a different pen style, color, and width, and a different marker
style and color. You can draw lines either from left to right or from right to left. You must
first call the PlotOpen() function to get the handle for the plot (hPlot) and specify the output
device. You should then use the PlotGrid() function to set up the frame and grid, before you
call this function to plot the line.
Syntax
PlotXYLine(hPlot, PenStyle, PenCol, PenWidth, MarkerStyle, MarkerCol, nMarker, Length,
xTable, LoXScale, HiXScale, YTable, LoYScale, HiYScale, Mode)
hPlot:
PenStyle:
0 - Solid
1 - Dash ( - - - - - )
576
2 - Dot (...............................)
3 - Dash and dot ( - . - . - . - . - )
4 - Dash, dot, dot ( - . . - . . - . . - )
5 - Hollow
PenCol:
PenWidth:
The width of the pen, in pixels. If the width is thicker than one pixel, you must
use a solid pen (PenStyle = 0). The maximum width is 32.
MarkerStyle:
0 - No markers
1 - Triangle
2 - Square
3 - Circle
4 - Diamond
5 - Filled triangle
6 - Filled square
7 - Filled circle
8 - Filled diamond
20 - 32000 - User-defined markers. You can register any symbol as a marker with
MarkerCol:
The color of the markers (flashing color is not supported). Select a color from the
list of Predefined Color Names and Codes or create an RGB-based color using the
nMarker:
Length:
The length of the array, that is the number of points in the table pTable for Plot-
Line(), or in tables xTable and yTable for PlotXYLine().
For every line you draw with the PlotLine() and PlotXYLine() functions within a
plot, you must add the Length arguments for each call, and pass the total to the
PlotGrid() function (in the nSamples argument).
xTable:
The x coordinates for the points in the line, as an array of floating point values.
LoXScale:
The lowest X-axis value that will be displayed on the plot (that is the X-coordi-
nate of the origin of your grid). The LoXScale and HiXScale values determine the
scale of your grid. This scale is used to plot values. for example, If LoXScale = 0
577
(zero) and HiXScale = 100, a value of 50 will be plotted half way along the X-axis
of your grid.
LoXScale must be in the same units as the values in xTable.
HiXScale:
The highest X-axis value that will be displayed on the plot. The LoXScale and
HiXScale values determine the scale of your grid. This scale is used to plot values.
for example, If LoXScale = 0 (zero) and HiXScale = 100, a value of 50 will be plot-
ted half way along the X-axis of your grid.
HiXScale must be in the same units as the values in xTable.
yTable:
The y coordinates for the points in the line, as an array of floating point values.
LoYScale:
The lowest Y-axis value that will be displayed on the plot (that is the Y-coordi-
nate of the origin of your grid). The LoYScale and HiYScale values determine the
scale of your grid. This scale is used to plot values. for example, If LoYScale = 0
(zero) and HiYScale = 100, a value of 50 will be plotted half way up the Y-axis of
your grid.
LoYScale must be in the same units as the values in xTable.
HiYScale:
The highest Y-axis value that will be displayed on the plot. The LoYScale and
HiYScale values determine the scale of your grid. This scale is used to plot values.
for example, If LoYScale = 0 (zero) and HiYScale = 100, a value of 50 will be plot-
ted half way up the Y-axis of your grid.
HiYScale must be in the same units as the values in xTable.
Return Value
Related Functions
PlotClose, PlotDraw, PlotGrid, PlotInfo, PlotLine, PlotMarker, PlotScaleMarker, PlotText,
TrnPlot
Example
See PlotOpen
See Also
Plot Functions
578
Chapter: 42 Report Functions
With the report functions, you can run reports on the report server, change their schedul-
ing, or get their status.
Report Functions
Following are functions relating to Reports:
RepGetCluster Retrieves the name of the cluster the report is running on.
RepGetControl Gets report control information.
Report Runs a report.
RepSetControl Sets report control information.
See Also
Functions Reference
RepGetCluster
This function retrieves the name of the cluster a report is running on. This function should
only be called from a report file.
Syntax
RepGetCluster()
Return Value
The name of the cluster the report in running on.
See Also
Report Functions
RepGetControl
Gets report control information on a report. This function is a blocking function. It will
block the calling Cicode task until the operation is complete.
Syntax
RepGetControl(ReportName, Type [, ClusterName])
ReportName:
The name of the report (can be prefixed by the name of the cluster that is Cluster-
Name.ReportName).
Type:
The type of report control information to get (send back in the return value):
0 - State of the report - returns one of:
 0 -Idle
 1 - Waiting for PLC data for trigger
 2 - Waiting for PLC data
579
 3 - Running
1 - Time of day that the report is due to run next.
2 - The report period, in seconds, or week day, month or year, for example, if the
report is weekly, this is the day of the week, 0 (Sunday) to 6 (Saturday).
3 - Synchronisation time of day of the report, for example, 10:00:00 (In seconds
from midnight).
4 - Type of report schedule - returns one of:
 0 - Event triggered
 1 - Daily
 2 - Weekly
 3 - Monthly
 4 - Yearly
5 - Report state - returns one of:
 0 - Enabled
 1 - Disabled
ClusterName:
Name of the cluster in which the report resides. This is optional if you have one
cluster or are resolving the report server via the current cluster context. The argu-
Return Value
The control information, as an integer.
Related Functions
RepSetControl, Report
Example
Next=RepGetControl("SHIFT",1,"ClusterXYZ");
! Sets Next to the time that the report is due to run.
! Display a message at the prompt AN (AN2) if
! the report is running.
IF RepGetControl("SHIFT",0,"ClusterXYZ")=3 THEN
Prompt("Shift report is running");
END
See Also
Report Functions
Report
Runs a report on the Report Server. This function only schedules the report for execution.
The running of the report is controlled entirely by the Report Server.
This function will start the specified report on the Reports Server to which the CitectSCA-
DA computer is communicating. If you are using the Reports Servers in Primary/Standby
mode, the report can run on the Standby Server. If you call this function on the Standby
Server then the report will definitely run on the Standby Server, even if the Primary Server
is active.
580
is complete.
Syntax
Report(ReportName [, ClusterName] )
ReportName:
The name of the report to run (can be prefixed by the name of the cluster that is
ClusterName.ReportName).
ClusterName:
Return Value
Related Functions
RepSetControl, RepGetControl
Example
Buttons
Text Shift Report
Command Report("Shift", "ClusterXYZ")
Comment Runs the Shift Report
System Keyboard
Key Sequence Report ############ Enter
Command Report(Arg1)
Comment Runs a specified Report
Report("SHIFT","ClusterXYZ");
! Runs the report named "SHIFT".
Report("DAY","ClusterXYZ");
! Runs the report named "DAY".
/* The "SHIFT" and "DAY" reports are started. The order in which
the reports are run cannot be determined. If you want the "DAY"
report to run after the "SHIFT" report, call Report("DAY") at the
end of the "SHIFT" report. */
See Also
Report Functions
RepSetControl
Sets report control information to temporarily override the normal settings for a specified
report. You can change the report schedule for a periodic report, and run one-time or event-
triggered reports. These new settings are set on both the primary and standby report serv-
ers, but are not saved to the database. When you restart your system, CitectSCADA uses
the existing settings, defined in the Reports database.
581
You might need to call this function several times. For example, to change an event-trig-
gered report to run at 6 hourly intervals, you need to change the schedule (Type 4), syn-
chronization time (Type 3), and period (Type 2). If you use incompatible values for these
options, you can get unpredictable results. To change more than one option, disable the re-
port, set the options, and then re-enable the report.
is complete.
Syntax
RepSetControl(ReportName, Type, Data [, ClusterName] )
ReportName:
The name of the report (can be prefixed by the name of the cluster that is Clus-
terName.ReportName).
Type:
The type of report control information to set:
1 - The time of day at which to run the next report. Subsequent reports are run at
the times calculated from the period (Type 2) and synchronisation time
(Type 3). Use Type 1 to specify a one-time report. Set the time in Data in
seconds from midnight (for example, specify 6 p.m. as 18 * 60 * 60).
2 - The report period. Set the new period in Data according to the report schedule
(Type 4), in seconds from midnight, day of week (0 to 6, Sunday = 0),
month (1 to 12), or year.
For a daily report schedule, set the report frequency in Data in seconds from mid-
night; for example, set Data to 6 * 60 * 60 for a 6 hourly shift report. If the
report is weekly, set Data to the day of the week, for example, when Data
= 2, the day is Tuesday.
3 - Synchronisation time of day of the report. Set the time in Data in seconds from
midnight, for example, to synchronize at 10a.m., set Data to 10 * 60 * 60.
4 - Type of report schedule. Set Data to one of the following:
 0 - Event triggered
 1 - Daily
 2 - Weekly
 3 - Monthly
 4 - Yearly
5 - Report state. Set Data to either:
 0 - Enabled
 1 - Disabled
Data
The new data value, dependent on the Type.
ClusterName:
Return Value
582
Related Functions
RepGetControl, Report
Example
RepSetControl("Shift",1,TimeCurrent()+60,"ClusterXYZ");
! Runs the "Shift" report in 1 minute.
! change weekly report to 8 hour shift starting at 7 am
RepSetControl("Weekly", 5, 1,"ClusterXYZ"); ! disable report
RepSetControl("Weekly", 4, 1,"ClusterXYZ"); ! change mode to daily
RepSetControl("Weekly", 3, 7 * 60 * 60,"ClusterXYZ"); ! sync at 7:00:00 am
RepSetControl("Weekly", 2, 8 * 60 * 60,"ClusterXYZ"); ! run every 8 hours
RepSetControl("Weekly", 5, 0,"ClusterXYZ"); ! enable report
! change yearly report to run on March 10 at 7 am
RepSetControl("Yearly", 5, 1,"ClusterXYZ"); ! disable report
RepSetControl("Yearly", 4, 4,"ClusterXYZ"); ! change mode to yearly
RepSetControl("Yearly", 3, 7 * 60 * 60,"ClusterXYZ"); ! sync at 7:00:00 am
RepSetControl("Yearly", 2, 31 + 28 + 10,"ClusterXYZ"); ! run on March 10th
RepSetControl("Yearly", 5, 0,"ClusterXYZ"); ! enable report
See Also
Report Functions
583
584
Chapter: 43 Security Functions
The security functions allow you to control logins, logouts, and general security, and to
add, delete, and modify user records during run time. By giving selected users access to
these functions, you can provide them with supervisory control of the system.
Security Functions
Following are functions relating to Security:
FullName Gets the full name of the current operator.
GetPriv Checks the privilege and area of the current operator.
Login Logs an operator into the CitectSCADA system. Not avail-
able when logged in as Windows user.
LoginForm Displays a form that allows an operator to log in to the Cit-
ectSCADA system.
Logout Logs an operator out of the CitectSCADA system.
LogoutIdle Sets an idle time logout for the current operator.
MultiSignatureForm Displays a form that allows up for 4 users to have their cre-
dentials verified in order to approve an operation.
MultiSignatureTagWrite Displays a form that allows up for 4 users to have their cre-
dentials verified in order to approve a write of
a specific value to a specific tag.
Name Gets the user name of the current operator.
UserCreate Creates a new user record during run time. Not available
when logged in as Windows user.
UserCreateForm Displays a form to create a record for a new user. Not avail-
able when logged in as Windows user.
UserDelete Deletes a new user record during run time. Not available
UserEditForm Displays a form for a selected user to create or delete user
records during run time.
Not available when logged in as Windows user.
UserInfo Gets information about the operator who is currently
logged-in to the system.
UserLogin Logs an operator into the CitectSCADA system using a se-
cure password string.
UserPassword Changes a user’s password during run time. Not available
UserPasswordExpiryDays Returns the number of days left before the user’s password
is due to expire.
UserPasswordForm Displays a form for the operator to change their own pass-
word during run time.
UserVerify Uses the authentication functionality in the user login sys-
tem.
VerifyPrivilegeForm Displays a form that allows a single user to enter their cre-
dentials.
585
VerifyPrivilegeTagWrite Displays a form that allows any single user to enter their
credentials in order to approve a write of
a specific value to a specific tag.
WhoAmI Displays the name of the operator who is currently logged-
in to the system.
See Also
Functions Reference
FullName
Gets the full name of the user who is currently logged on to the system. The user can be a
Citect or a Windows user. For a Citect user the full name is the one defined in the users
form. For a Windows user the full name is in the format of <DomainName>\<UserName>.
When there is no one logged in or the logged in user is a "system user" this function returns
an empty string.
Syntax
FullName()
If the user is logged on as a Domain user the name should be the Windows domain name
and user account name in the format of <DomainName\UserName>.
If the user is logged on as a local user the name should be the local machine name and user
account name in the format of <MachineName\UserName>.
Return Value
The user name (as a string).
Related Functions
Name, UserInfo
Example
/* Display the full name of the current user at AN20. */
DspText(20, 0, FullName());
See Also
Security Functions
GetPriv
Checks if the current user has a privilege for a specified area. With this function, you can
write your own Cicode functions to control user access to the system.
Syntax
GetPriv(Priv, Area)
Priv
The privilege level (1..8).
Area
586
The area of privilege (0..255).
Return Value
Returns 1 if the user has the specified privilege in the area, or 0 (zero) if the user does not
have the privilege.
Related Functions
SetArea
Example
/* User must have privilege 2, or cannot do operation. */
IF GetPriv(2, 0) THEN
! Do operation here
ELSE
Prompt("No privilege for command");
END
See Also
Security Functions
Login
Logs a user into the CitectSCADA system, using CitectSCADA security and gives users ac-
cess to the areas and privileges assigned to them in the Users database. Only one user can
be logged into a computer at any one time. If a user is already logged in when a second user
logs in, the first user is automatically logged out.
When using Windows security use UserLogin to limit Windows credentials being exposed
as plain text.
At startup, or when the user logs out, a default user is active, with access to area 0 (zero)
and privilege 0 (zero) only. Use the LoginForm() function to display a form for logging in
to the system.
Syntax
Login(sUserName, sPassword)
sUserName:
The user’s name, as defined in the Users database.
sPassword:
The user’s password, as defined in the Users database.
Return Value
Related Functions
LoginForm, Logout, LogoutIdle, Message, Input, UserLogin
587
Example
/* Log in a user whose user name is "FRED" and whose password is
"ABC". */
Login("FRED","ABC");
See Also
Security Functions
LoginForm
Displays a form in which a user can log in to the CitectSCADA system by entering their
name and password. If the login is correct, the user is logged into the CitectSCADA system
with the area(s) and privilege(s) assigned to them in the Users database.
From version 7.10 this form can be pre-filled by the caller. Both Citect and Windows users
are supported.
is complete.
Syntax
LoginForm(sUserName, sPassword)
sUserName:
The user’s name, as defined in the Users database.
sPassword:
The user’s password, as defined in the Users database.
Return Value
Related Functions
Login, UserLogin
Example
System Keyboard
Key Sequence Login
LoginForm Display the Login form
Comment Allow user login
Buttons
Text Operator Login
LoginForm Display the Login form
Comment Allow user login
See Also
Security Functions
588
Logout
Logs the current user out of the CitectSCADA system. CitectSCADA continues to run, but
with access to area 0 (zero) and privilege 0 (zero) only.
Calling this function to logout the logged on user will cause an automatically logged in user
to be logged back on. If there is no user logged in, calling this function will return an error.
When the logged on user is an automatically logged in user, calling this function will return
an error.
Syntax
Logout()
Return Value
Related Functions
Login, LoginForm, LogoutIdle, UserInfo, Message, Input
Example
/* Log the current user out of the system. */
Logout();
See Also
Security Functions
LogoutIdle
Sets an idle time for logging out the current user. If the current user does not execute a com-
mand within the specified idle time, a prompt is displayed. If the prompt is ignored, then
the user is logged out. For all users to have the same idle time, you would call this function
at startup. Otherwise, you can call the function from the Users database to specify an idle
time for each user. This function will not log out an automatically loged on user.
Syntax
LogoutIdle(Idle)
Idle:
The number of minutes the user must be idle before logout will occur. Set Idle to
-1 to disable the current logout timeout.
Return Value
No return value.
Related Functions
Logout, Login, LoginForm
589
Example
Users
User Name Operator1
LoginForm LogoutIdle(5)
Comment Logs the user out after five minutes
See Also
Security Functions
MultiSignatureForm
Displays a form that allows up for 4 users to have their credentials verified in order to approve an operation. The
usernames can be Citect or Windows users.
Syntax
MultiSignatureForm(sOperationDescription, sLogDevice, sUser1, sUser2, sUser3, sUser4)
sOperationDescription:
A description of the operation that requires approval. This string will be dis-
played on the signature form and logged to the log device if the operation is ap-
proved.
sLogDevice:
The name of a log device if logging is required, otherwise pass an empty string.
sUser1..4:
Each sUser argument must be either a Citect user name, a Windows user name
(including domain\ prefix) or a blank string. Even though the sUser arguments
are numbered 1 through 4, this only controls the order in which users are dis-
played on the multi-signature form. You can pass empty strings for any of these
arguments, but at least one user must be specified.
Return Value
TRUE (1) if the operation approved (that is all users’ credentials were verified and the op-
erator clicked the "Approve" button, otherwise FALSE (0).
Related Functions
FormSecurePassword
MultiSignatureTagWrite
VerifyPrivilegeForm
VerifyPrivilegeTagWrite
Example
// This example sets the page integer to indicate the approval status, but
// it can be used to perform any logic necessary to trigger the operation
// that was approved.
PageSetInt(1, MultiSignatureForm("Shut down plant", "ApprovalLog",

"shiftsupervisor", "DOMAIN\mike.manager", "", ""));
590
See Also
Security Functions
Form Functions
Displays a form that allows up for 4 users to have their credentials verified in order to approve a write of a specific
value to a specific tag. If all users are verified successfully, the write to the tag is performed by this function before
it returns. The usernames can be Citect or Windows users.
Syntax
MultiSignatureTagWrite(sTagName, sValueToWrite, sLogDevice, sUser1, sUser2, sUser3,
sUser4)
sTagName:
The name of the tag to which a write needs to be approved.
sValuetoWrite:
The value to write to the tag if approval succeeds.
sLogDevice:
sUser:
Each sUser argument must be either a Citect user name, a Windows user name
(including domain\ prefix) or an empty string. Even though the sUser arguments
are numbered 1 through 4, this only controls the order in which users are dis-
played on the multi-signature form. You can pass empty strings for any of these
arguments, but at least one user must be specified.
Return Value
TRUE (1) if the operation was approved (that is all users’ credentials were verified and the
operator clicked the "Approve" button, otherwise FALSE (0).
Related Functions
FormSecurePassword
MultiSignatureForm
VerifyPrivilegeForm
Example
// This example generates a form to request two users to approve the tag write op-
eration.
// When approved, the PLC_VAR1 tag is written with the value 123 and a page string
// is set to indicate the approval status.
IF (MultiSignatureTagWrite("PLC_VAR1", "123", "", "John Smith", "Angela Huth", "",
"")) THEN
PageSetStr(1, "TagWrite Successful");
ELSE
591
PageSetStr(1, "TagWrite Not Successful");

END
See Also
Security Functions
Form Functions
Name
Gets the name of the operator who is currently logged on to the display system. The user
can be a Citect or a windows user.If this function is called on a server, it returns the name
of the local operator. If there is no one logged on, or the logged on user is a "system user"
this function returns an empty string.
Syntax
Name()
Return Value
The name of the user as a string. If the user is logged on as a Windows user the name will
be the Windows user account name.
Related Functions
FullName, Login, LoginForm
Example
/* Display the user name of the current user at AN20. */
DspText(20,0,Name());
See Also
Security Functions
UserCreate
Not available for a Windows user.
Creates a record for a new user. A new user of the specified type is created. The name of
the user must be unique.
Syntax
UserCreate(sName, sFullName, sPassword, sType [, sAccess] [, sPrivGlobal] [, sPriv1..sPriv8] )
sName:
The name of the user.
sFullName:
The full name of the user.
sPassword:
The password of the user.
592
The sPassword argument is optional. If not passed, this argument defaults to an

empty string which is subsequently ignored. It is included for the purposes of
handling duplicate user names and separate password identification compatibil-
ity.
sType:
The generic type of user. The type must be defined in the Users database (with
the Users form).
sAccess:
User’s viewable areas.
sPrivGlobal:
User’s global privilege.
sPriv1-8:
User’s privilege for areas 1 - 8.
Return Value
Related Functions
UserDelete, UserEditForm, UserPassword, UserPasswordForm, UserCreateForm
Example
/* Create a new user */
UserCreate("Fred", "Fred Jones", "secret", "Operator");
See Also
Security Functions
UserCreateForm
Displays a form to create a record for a new user. A new user of the specified type is creat-
ed. The name of the user must be unique.
Syntax
UserCreateForm()
Return Value
Related Functions
UserDelete, UserEditForm, UserPassword, UserPasswordForm, UserCreate
593
Example
UserCreateForm()
See Also
Security Functions
UserDelete
Deletes the record for a user. Changes are written to both the Users database and the runt-
ime database in memory.
Syntax
UserDelete(sName)
sName:
Return Value
Related Functions
UserCreate, UserEditForm
Example
/* Delete Fred from the database */
UserDelete("Fred");
See Also
Security Functions
UserEditForm
Displays a form to allow the user to create or delete any user record in the database. This
function should have restricted access. Changes are written to both the Users database and
the runtime database in memory.
Syntax
UserEditForm()
Return Value
594
Related Functions
UserCreate, UserDelete
Example
/* Display a form for the user to create or delete user records. */
UserEditForm();
See Also
Security Functions
UserInfo
Gets information about the operator who is currently logged-in to the system.
Syntax
UserInfo(Type)
Type:
The type of user information:
0 - Flag to indicate if anyone is logged in or not
1 - The login name of the user
2 - The full name of the user
3 - The time the user logged in
4 - The time the user entered the last command
5 - The number of commands entered by the user
6 - The type of login:
 "0" indicates there is no one logged in.
 "1" indicates there is a user explicitly logged in.
 "2" indicates the logged on user is a system default user (server process
auto login Super user).
 "3" indicates the logged on user is a system default user (control client auto
login windows user).
Return Value
The information (as a string). If an error is detected, an empty string is returned.
Related Functions
Login
Example
/* Check if a user has logged on. If so, get the user’s full name
and the number of commands they have performed. */
String sName;
String sCount;
IF UserInfo(0) = "1" THEN
sName = UserInfo(2);
sCount = UserInfo(5);
END
595
See Also
Security Functions
UserLogin
Logs a user into the CitectSCADA system, using either Windows security or CitectSCADA security and gives users
access to the areas and privileges assigned to them in the Users database. Only one user can be logged into a
computer at any one time. If a user is already logged in when a second user logs in, the first user is replaced by
the newly logged on user.
To call this function at user login, the password argument passed must be in secure string
format.
At startup, or when the user logs out, a default user is active, with access to area 0 (zero)
and privilege 0 (zero) only. Use the LoginForm() function to display a form for logging in
to the system.
Syntax
UserLogin(sUserName, sPassword)
sUserName:
The user’s name as defined in the Users database, or the Windows User account
name, in plain text.
sPassword:
The user’s password, as defined in the Users database or Windows account for-
matted as a secure string.
To improve the user credentials protection provides a system built-in user login
function that takes the user name and secure password as the arguments. This re-
duces the chance that the user’s password can be exposed in plaint text from the
runtime system
Return Value
Related Functions
LoginForm, Logout, LogoutIdle, Message, Input
Example
/*
**FUNCTION NAME:LoginForm
**
**This function displays the login form, get the user name and
**password then trys to log the user in. If the login fails it
**will retry until login is ok or user presses the cancel button.
**
596
*/
INT
FUNCTION
LoginForm(STRING sName="", STRING sPassword="")
INTbDone;
INTnStatus;
INThForm;
bDone = FALSE;
WHILE bDone = FALSE DO
FormNew("@(Login Form)", 35, 5, 5);
FormPrompt(1, 0, "@(Name)");
FormInput(16, 0, "", sName, 16);
FormPrompt(1, 2, "@(Password)");
FormSecurePassword(18, 2, "", sPassword, 16);
FormButton( 6, 4, " " + "@(OK)" + " ", 0, 1);
FormButton(20, 4, "@(Cancel)", 0, 2);
hForm = FormNew("@(User Login)", 36, 1, 8 + 16 + 128 + 256);
FormPrompt(1, 0, "@(Authentication in progress ...)");
FormRead(1);
SleepMs(200);
IF UserLogin(sName, sPassword) = 0 THEN
bDone = TRUE
nStatus = 0;
ELSE
sPassword = "";
END
IF FormActive(hForm) THEN
FormDestroy(hForm);
597
END
ELSE
bDone = TRUE;
nStatus = 298;
END
END
RETURN nStatus;
END
See Also
Security Functions
UserPassword
Changes the password for the user. Changes are written to both the Users database and the
runtime database in memory.
Syntax
UserPassword(sName [, sPassword] [, sOldPassword] )
sName:
sPassword:
ity.
sOldPassword:
The password assigned to the user before the UserPassword() function is run.
The sOldPassword argument is optional. If passed, CitectSCADA will only permit
the password change (and consequent re-setting of the expiry period) when the
old password is correctly entered. If the sOldPassword parameter is not passed,
the password change will proceed without restriction.
Return Value
Related Functions
UserPasswordForm, UserCreate, UserEditForm
598
Example
/* Change Fred’s password */
UserPassword("Fred", "secret");
See Also
Security Functions
UserPasswordExpiryDays
Returns the number of days left before the user’s password is due to expire.
To use this function, you can build a form page by using cicode that takes the user name
and password as inputs and output the number of days that return by UserPasswordExpi-
ryDays().
Syntax
UserPasswordExpiryDays(sUserName [, sPassword] )
sUserName:
sPassword:
ity.
Return Value
The return value contains either the number of days before password expiry, or one of two
exception conditions:
 0 to 365 - number of days
 -1 - no expiry
 -2 - user not found or password wrong
Related Functions
UserPassword
See Also
Security Functions
UserPasswordForm
Display a form to allow users to change their own passwords. Changes are written to both
the Users database and the runtime database in memory.
599
Syntax
UserPasswordForm()
Return Value
Related Functions
UserPassword, UserCreate, UserEditForm
Example
/* Allow users to change their own passwords */
UserPasswordForm();
See Also
Security Functions
UserVerify
Verifies a given user by authenticating the user’s credential, verifies the user privileges and
areas against those specified in the functions parameters. Successful verification however
does not log the user into the CitectSCADA runtime system.
Syntax
UserVerify(sName, sPassword, [, sAccess] [, sPrivGlobal] [, sPriv1..sPriv8] )
sName:
sPassword:
The password of the user. The sPassword argument must be passed as a secure
string.
sAccess:
Specifies the required user’s viewable areas.
sPrivGlobal:
Specifies the required user’s global privilege.
sPriv1-8:
Specifies the required areas for privileges 1 - 8. That is, sPriv1 contains the areas
(1,2,3,4,...,255) where the user has Privilege 1.
Return Value
The successful verification has to meet the following conditions:
 The selected user credentials can be authenticated
 The required user privileges are included in the authenticated user’s total privileges.
600
Related Functions
UserDelete, UserEditForm, UserPassword, UserPasswordForm, UserCreateForm
Example
INT FUNCTION UserVerifyTest()
STRING sName;
STRING sPassword;
INT bDone;
INT nStatus;
bDone = FALSE;
WHILE bDone = FALSE DO
FormNew("@(Login Form)", 30, 5, 5);
FormInput(1, 0, "@(Name)" + " ", sName, 16);
FormSecurePassword(1, 2, "@(Password)" + " ", sPassword, 16);
FormButton( 1, 4, " " + "@(OK)" + " ", 0, 1);
FormButton(17, 4, "@(Cancel)", 0, 2);
IF UserVerify(sName, sSecurePassword) = 0 THEN
bDone = TRUE;
nStatus = 0;
Message("Info", "Verification successful", 0)
ELSE
sPassword = "";
Message("Info", "Verification not successful", 0)
END
ELSE
bDone = TRUE;
nStatus = 298;
END
END
RETURN nStatus;
END
See Also
Security Functions
VerifyPrivilegeForm
Displays a form that allows a single user to enter their credentials. These credentials are checked against a spec-
ified set to ensure the user has the required privileges before allowing the operation to proceed.
The user can be a Citect or Windows user.
Syntax
VerifyPrivilegeForm(sOperationDescription,sLogDevice, sAccess, sGlobalPriv, sPriv1, sPriv2,
sPriv3, sPriv4, sPriv5, sPriv6, sPriv7, sPriv8)
sOperationDescription:
A description of the operation that requires approval.
sLogDevice:
sAccess:
The required user viewable areas, or pass an empty string for none.
601
sGlobalPriv:
The required global privilege, otherwise pass an empty string.
sPriv1..8:
(1,2,3,4,...,255) where the user has Privilege 1. Each argument must be either spec-
ified or an empty string for none.
Return Value
The name of the user that met the required privileges, otherwise ""
Related Functions
FormSecurePassword
MultiSignatureForm
Example
// This example generates a form to request a user to approve an operation.
// This user needs the global privilege level of 8.
// When approved, the operation is completed and a page string
IF (VerifyPrivilegeForm("Shut Down Plant", "ApprovalLog", "PlantWide", "8", "", "",
"", "", "", "", "", "")<>"") THEN
// Do operation
PageSetStr(1, "Operation approved");
ELSE
PageSetStr(1, "Operation not approved");
END
See Also
Security Functions
Form Functions
Displays a form that allows any single user to enter their credentials in order to approve a write of a specific value
to a specific tag. These credentials are checked against a specified set to ensure the user has the required privi-
leges before allowing the operation to proceed.
The usernames can be Citect or Windows users.
Syntax
VerifyPrivilegeTagWrite(sTagName, sValueToWrite, sLogDevice, sAccess, sGlobalPriv,
sPriv1, sPriv2, sPriv3, sPriv4, sPriv5, sPriv6, sPriv7, sPriv8)
sTagName:
The name of the tag to which a write needs to be approved.
sValuetoWrite:
The value to write to the tag if approval succeeds.
602
sLogDevice:
sAccess:
The required user viewable areas, or pass an empty string for none.
sGlobalPriv:
The required global privilege, otherwise pass an empty string.
sPriv1..8:
(1,2,3,4,...,255) where the user has Privilege 1. Each argument must be either spec-
ified or an empty string for none.
Return Value
Name of user that met the required privileges (and therefore the value was written to the
specified tag), otherwise ""
Related Functions
FormSecurePassword
MultiSignatureForm
VerifyPrivilegeForm
Example
// This example generates a form to request a user to approve the tag write operation.
// This user needs privilege levels of 6 and 3.
// When approved, the PLC_VAR1 tag is written with the value 123 and a page string
IF (VerifyPrivilegeTagWrite("PLC_VAR1", "123", "ApprovalLog", "PlantWide", "", "6",
"3", "", "", "", "", "", "")<>"") THEN
PageSetStr(1, "TagWrite Successful");
ELSE
PageSetStr(1, "TagWrite Not Successful");
END
See Also
Security Functions
Form Functions
WhoAmI
Displays the user name and full name of the user currently logged-in to the system. When
the current logged on user is Windows user this function returns the user’s full name in the
format of <DomainName>\<UserName>. The names are displayed at the prompt AN.
Syntax
WhoAmI()
603
Return Value
Related Functions
Name, FullName, UserInfo
Example
/* Display the user’s full name and user name at the prompt AN. */
WhoAmI();
See Also
Security Functions
604
Chapter: 44 Statistical Process Control Functions
SPC (Statistical Process Control) functions allow you to alter the properties and parameters
that affect the SPC calculations. By using the SPC functions you can also gain direct access
to the SPC data and alarms.
SPC Functions
Following are functions relating to Statistical Process Control:
SPCAlarms Returns the status of the specified SPC alarm.
SPCClientInfo Returns SPC data for the given SPC tag.
SPCGetHistogramTable Returns an array containing the frequency of particular
ranges for the given SPC tag.
SPCGetSubgroupTable Returns an array containing the specified subgroup’s ele-
ments with the mean, range and standard deviation.
SPCPlot Generates a single page print showing three separate
trends of the SPC Mean, Range, and Standard Deviation.
SPCProcessXRSGet Gets the process mean, range and standard deviation
overrides.
SPCProcessXRSSet Sets the process mean, range and standard deviation
overrides.
SPCSetLimit Sets the upper or lower control limits of X-bar, range, or
standard deviation charts.
SPCSpecLimitGet Gets the upper and lower specification limits for the spec-
ified tag.
SPCSpecLimitSet Sets the upper and lower specification limits for the spec-
ified tag.
SPCSubgroupSizeGet Gets the size of a subgroup for the specified SPC tag.
SPCSubgroupSizeSet Sets the subgroup size for the specified SPC tag.
See Also
Functions Reference
SPCAlarms
Returns the status of the specified SPC alarm. This function is used to configure SPC
alarms, by defining alarms with this trigger in Advanced Alarms.
Syntax
SPCAlarms(sSPCTag, AlarmType)
sSPCTag:
The SPC Tag name as defined in SPC Tags.
605
AlarmType:
The description of the alarm type. The following types are valid:
XFreak XGradualUp XStratification
XOutsideCL XGradualDown XMixture
XAboveUCL XUpTrend ROutsideCL
XBelowLCL XDownTrend RAboveUCL
XOutsideWL XErratic RBelowLCL
Return Value
Alarm status, ON (1) or OFF (0).
Related Functions
AlarmAck
Example
Advanced Alarms
Alarm Tag Feed_SPC_XBLCL
Alarm Desc Process mean below LCL
Expression SPCAlarms("Feed_SPC", XBelowLCL)
Comment Trigger an alarm when XBelowLCL condition becomes true.
Advanced Alarms
Alarm Tag Temp_SPC_GRADUP
Alarm Desc Mean is drifting up
Expression SPCAlarms("Temp_SPC", XGradualUp)
Comment Trigger an alarm if mean drifts up.
See Also
SPC Functions
SPCClientInfo
Returns SPC data for the given SPC tag. The information retrieved through this function is
from the cache maintained by the client. This function will give a faster response than the
related functions which access the SPC (trend) server.
This function can only be called while on an SPC page.
Syntax
SPCClientInfo(sSPCTag, iType)
sSPCTag:
iType:
The information to be returned:
1 - Subgroup Size
2 - No. of Subgroups
3 - Process Mean (x double bar)
4 - Process Range
606
5 - Process Standard Deviation

6 - Lower Specification Limit (LSL)
7 - Upper Specification Limit (USL)
8 - Cp - Process Capability Actual
9 - Cpk - Process Capability Potential
10 - Process Skewness
11 - Process kurtosis
Return Value
The requested data specified by iType. It is of type REAL.
Related Functions
SPCSpecLimitGet, SPCProcessXRSGet, SPCSubgroupSizeGet
Example
/* This function will check the capability of a particular SPC tag.*/
REAL
FUNCTION
CheckCapability(STRING sTAG)
REAL rReturn;
rReturn = SPCClientInfo(sTag, 8);
!rReturn holds the inherent capability value
IF rReturn > 1.0 THEN
Message(sTag + "Assessment","The process is Capable.",64);
ELSE
Message(sTag + "Assessment","The process is not Capable.",64);
END
Return rReturn;
END
See Also
SPC Functions
SPCGetHistogramTable
Returns an array containing the frequencies of particular ranges for the given SPC tag. The
histogram structure is implied in the order of the table as follows - the first array element
is the data less than -3 sigma. The second value is the data between -3 sigma and -3 sigma
plus the bar width etc. The last value is the data greater than +3 sigma.
Syntax
SPCGetHistogramTable(sSPCTag, iNoBars, TableVariable)
sSPCTag:
iNoBars:
607
The number of bars in the table. The valid range is restricted to values from 7 to
100. This also indicates the size of the array to be returned.
TableVariable:
The Cicode array that will store the histogram data. This variable must be defined
as a global array of type INT. The number of elements in the array must be equal
to (or greater than) iNoBars.
Return Value
0 (zero) if successful, otherwise an error number is returned. The histogram table is written
to TableVariable.
Related Functions
TableMath
Example
/* This function will get the maximum frequency present in the
histogram of a particular SPC tag.*/
INT iFrequency[7];
! This variable must be global to the file so is declared outside
of the function
INT
FUNCTION
GetMaxFreq(STRING sTAG)
INT iError;
INT iMax = -1;
iError = SPCGetHistogramTable(sTag, 7, iFrequency);
!The elements of iFrequency now hold the histogram table frequencies.
IF iError = 0 THEN
! Get maximum
iMax = TableMath(iFrequency,7,1,0);
END
Return iMax;
END
See Also
SPC Functions
SPCGetSubgroupTable
Returns an array containing the specified subgroup’s elements with the mean, range and
standard deviation. The data will be in the following order:
Element0, Element1, ... , Element(n-1), Mean, Range, StdDev
where n is the subgroup size.

Syntax
SPCGetSubgroupTable(sSPCTag, iSubgroup, TableVariable)
sSPCTag:
608
iSubgroup:
The number of the subgroup being displayed whose data is to be retrieved. Zero
(’0’) represents the most recent subgroup.
TableVariable:
The first element of the Cicode array that will store the sample data. This variable
must be defined as a global array of type REAL. The number of elements in the
array must be equal to (or greater than) the subgroup size + 3.
Return Value
0 (zero) if successful, otherwise an error number is returned. The subgroup’s data is written
to TableVariable.
Related Functions
TableMath
Example
/* This function will get the minimum value present in the sample
data of a particular SPC tag.*/
REAL rSubgroup[8]; ! 5 samples + mean + range + stddev.
! This variable must be global to the file, so is declared outside
of the function
REAL
FUNCTION
GetMinSample(STRING sTAG)
INT iError;
REAL iMin = 0;
iError = SPCGetSubgroupTable(sTag, 7, rSubgroup);
!The elements of rSubgroup now hold the group samples, mean, range and stddev.
IF iError = 0 THEN
! Get minimum. Note that the range of data is 5
iMin = TableMath(rSubgroup,5,0,0);
END
Return iMin;
END
See Also
SPC Functions
SPCPlot
This function is designed to work only on an SPCXRSChart page. It prints a single page
showing three separate trends of the SPC Mean, Range, and Standard Deviation. The Mean
must be at AN, the Range at AN + 1, and the Standard Deviation at AN + 2. You can specify
a title and a comment for the plot, and whether it is printed in color or in black and white.
Syntax
SPCPlot(sPort, AN [, sTitle] [, sComment] [, iMode] )
sPort:
609
The name of the printer port to which the plot will be printed. This name must
be enclosed within quotation marks. For example LPT1:, to print to the local
printer, or \\Pserver\canon1 using UNC to print to a network printer.
AN:
The animation point at which the Mean chart is currently situated. The Range
and Standard Deviation charts must be on the next two consecutive animation
numbers. For example, if the Mean chart is at animation point 40, the Range chart
must be at animation point 41, and the Standard Deviation chart must be at ani-
mation point 42.
sTitle:
The title of the trend plot.
sComment:
The comment that is to display beneath the title of the trend plot. You do not have
to enter a comment.
iMode:
The color mode of the printer.
0 - Black and White (default)
1 - Color
Return Value
Related Functions
TrnPlot, TrnComparePlot, TrnPrint, PlotOpen
Example
/* This function will print the Mean trend (currently displayed at
animation point 40), the Range trend (currently at animation point
41), and the Standard Deviation trend (currently at animation
point 42). The result is a one page, black and white combination
of all three trends, printed to LPT1. */
SPCPlot("LPT1:",40, "CitectSCADA SPC Chart","Gradually
increasing trend",0);
See Also
SPC Functions
SPCProcessXRSGet
Gets the process mean, range, and standard deviation overrides for the specified SPC tag.
The values that are returned are the values that are currently being used by the SPC (trend)
server, not necessarily the values specified in the SPC Tag definition.
is complete.
610
Syntax
SPCProcessXRSGet(sSPCTag, XVariable, RVariable, SVariable [, ClusterName] )
sSPCTag:
XVariable:
The Cicode variable that stores the process mean (X double bar). This variable
must be defined as a global of type REAL. Do not specify a constant in this field.
RVariable:
The Cicode variable that stores the range (R). This variable must be defined as a
global of type REAL. Do not specify a constant in this field.
SVariable:
The Cicode variable that stores the standard deviation (S). This variable must be
defined as a global of type REAL. Do not specify a constant in this field.
ClusterName:
Specifies the name of the cluster of the SPC tag.
Return Value
0 (zero) if successful, otherwise an error number is returned. The process mean is written
to XVariable, the process range to RVariable, and the standard deviation to SVariable.
Related Functions
SPCClientInfo, SPCProcessXRSSet
Example
/* This function will set a new override value for Mean, without
overwriting the values already in place for Standard Deviation and
Range */
REAL rOldMean;
REAL rRange;
REAL rStdDev;
! These variables must be global to the file, so are declared
outside of the function
INT
FUNCTION
Tank1SPCNewMean(REAL rNewMean)
INT iError;
iError = SPCProcessXRSGet("TANK_1_TEMP", rOldMean, rRange, rStdDev);
! If no error, rOldMean, rRange and rStdDev now hold the current values of XRS.
IF iError = 0 THEN
iError = SPCProcessXRSSet("TANK_1_TEMP", rNewMean, rRange, rStdDev);
END
Return iError;
END
See Also
SPC Functions
SPCProcessXRSSet
611
Sets the process mean, range and standard deviation overrides for the specified SPC tag.
The values entered here will override CitectSCADA’s automatic calculations, and the over-
rides specified in the SPC Tags definition.
is complete.
Syntax
SPCProcessXRSSet(sSPCTag, rMean, rRange, rStdDev [, ClusterName] )
sSPCTag:
rMean:
The new value of process mean (x double bar) to set.
rRange:
The new value of process range to set.
rStdDev:
The new value of process standard deviation to set.
ClusterName:
Return Value
0 (zero) if successful, otherwise an error number is returned.
Related Functions
SPCProcessXRSGet
Example
See SPCProcessXRSGet
See Also
SPC Functions
SPCSetLimit
Sets the upper or lower control limits of X-bar, range, or standard deviation charts. Using
this function will only set the controller limits on the Client display which will not affect
the SPC Alarms. To set the server control limits, use the SPCProcessXRSSet function.
Syntax
SPCSetLimit(AN, Type, Value, Setting)
AN:
The AN where the SPC chart is located.
Type:
The SPC type:
1 - X-bar upper control limit
612
2 - X-bar lower control limit

3 - Range upper control limit
4 - Range lower control limit
5 - Standard deviation upper control limit
6 - Standard deviation lower control limit
7 - X-bar centre line
8 - Range centre line
9 - Standard deviation centre line
Value:
The value for the control limit.
Setting:
Automatic calculation or manual setting of control limits:
0 - Automatic
1 - Manual
Return Value
Example
SPCSetLimit(40,1,250,1);
! Sets X-bar upper control limit to 250 at AN40.
See Also
SPC Functions
SPCSpecLimitGet
Gets the process Upper and Lower Specification Limits (USL and LSL) for the specified SPC
tag. The values that are returned are the values that are currently being used by the SPC
(trend) server, not necessarily the values specified in the SPC Tag definition.
is complete.
Syntax
SPCSpecLimitGet(sSPCTag, LSLVariable, USLVariable [, ClusterName] )
sSPCTag:
LSLVariable:
The Cicode variable that stores the Lower Specification Limit (LSL). This variable
must be defined as a global of type REAL. Do not specify a constant in this field.
USLVariable:
The Cicode variable that stores the Upper Specification Limit (USL). This vari-
able must be defined as a global of type REAL. Do not specify a constant in this
field.
613
ClusterName:
Return Value
0 (zero) if successful, otherwise an error number is returned. The LSL is written to LSLVa-
riable, while the USL is written to USLVariable.
Related Functions
SPCClientInfo, SPCSpecLimitSet
Example
/* This function will increase the current USL and LSL of the
specified Tag by 10 percent.*/
REAL rLSL;
REAL rUSL;
! These variables must be global to the file, so are declared
outside of the function
INT
FUNCTION
ExpSLbyPercent(STRING sTAG)
REAL rIncPercent = 1.1;
REAL rDecPercent = 0.9;
INT iError;
iError = SPCSpecLimitGet(sTag, rLSL, rUSL);
! If no error, rLSL and rUSL now hold the current values of LSL and USL for sTAG
rLSL = rLSL * rDecPercent;
rUSL = rUSL * rIntPercent;
IF iError = 0 THEN
iError = SPCSpecLimitSet(sTAG, rLSL, rUSL);
END
Return iError;
END
! The function would be called as follows;
Page Button
Button Text Expand Temperature Limits
Expression ExpSLby10Percent("TANK_1_TEMP");
See Also
SPC Functions
SPCSpecLimitSet
Sets the process Upper and Lower Specification Limits (USL and LSL) for the specified SPC
tag. The values entered here will override those specified in the SPC Tags definition.
is complete.
Syntax
SPCSpecLimitSet(sSPCTag, rLSL, rUSL [, ClusterName] )
sSPCTag:
614

rLSL:
The new value of Lower Specification Limit (LSL) to set.
rUSL:
The new value of Upper Specification Limit (USL) to set.
ClusterName:
Return Value
Related Functions
SPCSpecLimitGet
Example
See SPCSpecLimitGet
See Also
SPC Functions
SPCSubgroupSizeGet
Gets the subgroup size for the specified SPC tag. The value that is returned is the value that
is currently being used by the SPC (trend) server, not necessarily the value specified in the
SPC Tag definition.
is complete.
Syntax
SPCSubgroupSizeGet(sSPCTag, SizeVariable [, ClusterName] )
sSPCTag:
SizeVariable:
The Cicode variable that stores the subgroup size. This variable must be defined
as a global of type INT. Do not specify a constant in this field.
ClusterName:
Return Value
0 (zero) if successful, otherwise an error number is returned. The subgroup size is written
to SizeVariable.
Related Functions
SPCClientInfo, SPCSubgroupSizeSet
615
Example
See SPCSubgroupSizeSet.
See Also
SPC Functions
SPCSubgroupSizeSet
Sets a new subgroup size for the specified SPC tag. The new subgroup size becomes the
new size as long as the SPC (trend) server is running. The subgroup size is updated first in
the SPC server, which then informs all clients to update. This will force re-calculation of
SPC values (UCL and LCL) across the span of any displayed charts.
is complete.
Syntax
SPCSubgroupSizeSet(sSPCTag, iSize [, ClusterName] )
sSPCTag:
iSize:
The new size of the subgroup to set.
ClusterName:
Return Value
Related Functions
SPCSubgroupSizeGet
Example
/* This function increments the subgroup size for FEED_RATE_1 by
the specified amount. */
INT iSize;
! This variable must be global to the file, so is declared outside
of the function
INT
FUNCTION
IncSubgroupSize(INT iIncrement)
INT iError;
iError = SPCSubgroupSizeGet("FEED_RATE_1", iSize);
! If no error, iSize now contains the current subgroup size of FEED_RATE_1
iSize = iSize + iIncrement;
IF iError = 0 and (isize > 1) THEN
iError = SPCSubgroupSizeSet("FEED_RATE_1", iSize );
END
Return iError;
END
616
See Also
SPC Functions
617
618
Chapter: 45 SQL Functions
SQL functions allow you to define, manipulate, and control data in SQL databases and oth-
er relational databases. By using the SQL functions (or the device functions with an SQL
device), you can directly access data on database servers, mini-computers, and mainframe
computers.
SQL Functions
Following are functions related to SQL operations:
ExecuteDTSPkg Loads and executes a Data Transformation Services package which
initiates data transfer between OLE DB data sources.
SQLAppend Appends a text string to the SQL buffer.
SQLBeginTran Starts a database transaction.
SQLCommit Commits a transaction to the database.
SQLConnect Makes a connection to a database system for execution of SQL
statements.
SQLDisconnect Closes a database connection.
SQLEnd Terminates an SQL query.
SQLErrMsg Returns an error message from the SQL system.
SQLExec Executes an SQL query on a database.
SQLFieldInfo Gets information about the fields or columns selected in an SQL
query.
SQLGetField Gets field or column data from a database record.
SQLInfo Gets information about a database connection.
SQLNext Gets the next database record from a SQL query.
SQLNoFields Gets the number of fields or columns that were returned by the last
SQL statement.
SQLNumChange Gets the number of records that were modified in the last insert,
update, or delete SQL statement.
SQLRollBack Rolls back (or cancels) the last database transaction.
SQLSet Sets a statement string in the SQL buffer.
SQLTraceOff Turns off the debug trace.
SQLTraceOn Turns on the debug trace.
See Also
Functions Reference
ExecuteDTSPkg
Loads and executes a DTS (Data Transformation Services) package which initiates data
transfer and transformations between OLE DB data sources.
A DTS package is created using the DTS utility provided in Microsoft SQL Server 7.0. It can
be saved in a COM structured file, a Microsoft Repository, or in an SQL Server Database.
619
All except the first of this function’s parameters are optional, and their use will depend on
your needs.
Syntax
ExecuteDTSPkg(sFileOrSQLSvrName [, sPkgName] [, sParam1, ... , sParam5] [, sPkgPwd] [, sP-
kgVer] [, sLogFile] [, sSQLSvrUsr] [, sSQLSvrPwd])
sFileOrSQLSvrName:
The path and name of the file containing the package (for file-based packages), or
the SQL Server name (for SQL Server stored packages).
sPkgName:
The package name.
 For file-based packages where only one package is stored in a file, you can ig-
nore this parameter, as the package name defaults to the name of the file.
 If the package has been named differently to the file, or a file contains more
than one package, you must specify the package name. You must also specify
the package name for SQL Server stored packages.
sParam1, ,sParam5:
Five optional variables which may be used as global variables within the DTS
package. The variables must be named Param1, Param2, Param3, Param4, and
Param5.
sPkgPwd:
The package password.
The creator of the DTS package may have implemented a password so that unau-
thorized users cannot access it. In this case, you must specify the package pass-
word. If no password has been implemented, you can omit this parameter.
sPkgVer:
The package version. If you don’t specify a version, the most recent version is
used.
sLogFile:
AN optional path and name for a log file. The log file can track activity such as:
 File DTS package detected
 SQL DTS package detected
 Package initialized successfully
 Package executed sucessfully
 Package execution was not successful
sSQLSvrUsr:
The user name providing access to the SQL Server where the DTS package is
stored. A user’s account on the SQL Server consists of this user name and, in most
cases, a password.
This parameter also determines which method is used to load the package.
If sSQLSvrUsr is specified, the package is assumed to be an SQL Server stored
package. In this case, the package is loaded using the LoadFromSQLServer()
method. Otherwise, the package is file-based and LoadFromStorageFile() is
called.
sSQLSvrPwd:
The password providing access to the SQL Server, if the user’s account on the
server requires a password.
620
Return Value
0 (zero) if the package was executed successfully, otherwise a DTS error number is re-
turned.
Example
/* File-based package with one package per file, where the package
name is the same as the file name.*/
iResult = ExecuteDTSPkg("c:\dtspackages\package.dts");
/*SQL Server stored package with additional parameters */
iResult = ExecuteDTSPkg("Server1", "TestPackage", "Param1", "Param2", "Param3",
"Param4", "Param5", "Fred", "1", "c:\packages\PkgLog.txt", "jsmith", "secret");
See Also
SQL Functions
SQLAppend
Appends a statement string to the SQL buffer. Cicode cannot send an SQL statement that
is longer than 255 characters. If you have an SQL statement that is longer than the 255 char-
acter limit, you can split the statement into smaller strings, and use this function to append
the statements in the SQL buffer.
Syntax
SQLAppend(hSQL, String)
hSQL:
The handle to the SQL connection, returned from the SQLConnect() function.
The SQL connection handle identifies the table where details of the associated
SQL connection are stored.
String:
The statement string to append to the SQL buffer.
Return Value
0 (zero) if successful, otherwise an error number is returned. (For details of the 307 error
code, call the SQLErrMsg function).
Related Functions
SQLSet, SQLBeginTran, SQLCommit, SQLConnect, SQLDisconnect, SQLEnd, SQLErrMsg
Example
See SQLSet
See Also
SQL Functions
SQLBeginTran
621
Starts a database transaction. When you make a transaction, your changes are not written
to the database until you call the SQLCommit() function. Alternatively, you can use the
SQLRollBack function() to discard all changes made during the transaction.
After you begin a transaction, you must call either SQLCommit() to save the changes or
SQLRollBack() to discard the changes. You must use one of these functions to complete the
transaction and release all database locks. Unless you complete the transaction, you cannot
successfully disconnect the SQL connection.
A single database connection can only handle one transaction at a time. After you call SQL-
BeginTran(), you must complete that transaction before you can call SQLBeginTran() again.
If you disconnect from a database while a transaction is active (not completed), CitectSCA-
DA automatically "rolls back" the transaction any changes you made to the database in that
transaction are discarded.
You do not need to begin a transaction to modify a database. Any changes you make to a
database before you call the SQLBeginTran() are automatically committed, and no data-
base locks are held.
The SQLBeginTran() function is not supported by all databases. If the function is not per-
forming as you expect, check that both your database and ODBC driver support transac-
tions. Refer to the documentation for your database for more information on transactions.
Syntax
SQLBeginTran(hSQL)
hSQL:
The handle to the SQL connection, returned from the SQLConnect() function. The
SQL connection handle identifies the table where details of the associated SQL
connection are stored.
Return Value
Related Functions
SQLCommit, SQLConnect, SQLDisconnect, SQLEnd, SQLErrMsg, SQLExec, SQLFieldIn-
fo, SQLGetField, SQLInfo, SQLNext, SQLNoFields, SQLNumChange, SQLRollBack, SQL-
TraceOff, SQLTraceOn
Example
/* Increase each employee’s salary and superannuation by a
specified amount. If any errors occur, the changes are aborted */
INT
FUNCTION
PayIncrease(STRING sIncrease)
INT hSQL;
INT Count1;
INT Count2;
hSQL = SQLConnect("DRV=QEDBF");
SQLBeginTran(hSQL);
SQLExec(hSQL, "UPDATE C:\DATA\EMPLOYEE SET Salary = Salary + " +sIncrease);
Count1 = SQLNumChange(hSQL);
SQLExec(hSQL, "UPDATE C:\DATA\EMPLOYEE SET Super = Super + " +sIncrease);
622
Count2 = SQLNumChange(hSQL);
IF Count1 = Count2 THEN
SQLCommit(hSQL);
ELSE
SQLRollBack(hSQL);
END
SQLEnd(hSQL);
SQLDisconnect(hSQL);
END
See Also
SQL Functions
SQLCommit
Commits (to the database) all changes made within a transaction. If you call the SQLBegin-
Trans() function to begin a transaction, you must call the SQLCommit() function to save the
changes you make to the database during that transaction (with the Insert, Delete, and Up-
date SQL commands).
The SQLCommit() and SQLRollBack() functions both complete a transaction and release all
database locks. But while the SQLCommit() function saves all changes made during the
transaction, the SQLRollBack() function discards these changes. Unless you call the SQL-
Commit() function before you disconnect the database, CitectSCADA automatically rolls
back the transaction any changes you made to the database in that transaction are discard-
ed.
The SQLCommit() function could affect different databases in different ways. If the func-
tion is not performing as you expect, check that your database is ODBC compatible. Refer
to the documentation for your database for information on committing transactions.
Syntax
SQLCommit(hSQL)
hSQL:
Return Value
code, call the SQLErrMsg() function).
Related Functions
SQLBeginTran, SQLConnect, SQLDisconnect, SQLEnd, SQLErrMsg, SQLExec, SQLField-
Info, SQLGetField, SQLInfo, SQLNext, SQLNoFields, SQLNumChange, SQLRollBack,
SQLTraceOff, SQLTraceOn
Example
See SQLBeginTran
See Also
SQL Functions
623
SQLConnect
Makes a connection to a database system, and returns a handle to the connection for use by
the other SQL functions. Through this connection, you can execute SQL statements in the
specified database. You must call this function before any other SQL function.
You only require one connection for each database system to be accessed (for example, Or-
acle, dBASE, Excel, etc.).
Do not use an SQL database for storage of real-time data (such as alarms), because SQL da-
tabases do not provide real-time performance when accessing database data. Only use an
SQL database where data transfer is not critical (for example, recipes or reports). If you try
to use SQL to store real time data, CitectSCADA’s performance could be greatly decreased.
Syntax
SQLConnect(sConnect)
sConnect:
The connection string, in the format:
<attribute>=<value>[;<attribute>=<value>. . .]
The following attributes can be used in a connection string:
DSN Data Source Name. The name of the data source defined with the ODBC util-
ity in the Windows Control Panel. You must use the DSN attribute, unless you
are using CitectSCADA v2.01 or earlier.
DLG Dialog box. Set DLG to 1 to display a dialog box that allows the user to input
their user ID, password, and connection string. DLG is an optional attribute.
UID User name or Authorization/Login ID. Check the documentation for your
ODBC driver and database to see if you need to use the UID attribute.
PWD Password. Check the documentation for your ODBC driver and database to
see if you need to use the PWD attribute.
MODIFY The ability of CitectSCADA to understand and accept native SQL depends on
SQL the database driver being used. Set MODIFYSQL to 1 (the default) for an
ODBC-compliant SQL. Set MODIFYSQL to 0 to use the native SQL syntax of
the database system, as well as for any CitectSCADA databases you created
with versions 2.01 or earlier, that employ database-specific SQL statements.
The Q+E ODBC database drivers are backward compatible with those sup-
plied with earlier versions of CitectSCADA.
REREAD Set to 1 to reread records from the database after updating them. Use this
AFTER UP- attribute to get the correct value of automatically updated columns, such as
DATE time and date stamps.
REREAD Set to 1 to reread records from the database after inserting into it. Use this
AFTER IN- attribute to get the correct value of automatically-updated columns, such as
SERT time and date stamps.
DRV Use the DRV attribute for compatibility with CitectSCADA v2.01 and earlier.
Use the DRV instead of the data source name (DSN) in the connection string.
Do not use DRV in new CitectSCADA applications.
CitectSCADA recognizes the above attributes for all the database systems in the
table below, but not all these attributes are essential for all databases. The aster-
isks (*) beside each database indicate the attributes you must use to connect to
that database. The acceptable values for each attribute also vary according to the
database system, so select from the list to see the attributes and values:
DATABASE SYSTEM DSN UID PWD DRV
624
Btrieve Files * QEBTR

dBASE Files * QEDBF
EXCEL Files * QEXLS
IBM DB2 X X X QEDB2
Informix
INGRES * * QEING
Netware SQL * QEXQL
Oracle * * * QEORA
OS/2 and DB2/2 * * * QEEE
Paradox * * QEPDX
SQLBase/ (Gupta) * * * QEGUP
SQL Server * * * QESS
Text Files * * QETXT
XDB Databases * * * QEXDB
DRV:
DRV names are included only for maintaining CitectSCADA applications built
using CitectSCADA v2.01 or earlier. For these early version, use DRV instead of
the data source name (DSN).
X:
No longer supported directly. See information on the OS/2 and DB2/2 database
drivers and the "Q+E Database Drivers Reference Manual".
Return Value
The SQL connection handle if the connection is successful, otherwise -1 is returned. (For de-
tails of the 307 error code, call the SQLErrMsg() function). The SQL connection handle iden-
tifies the table where details of the associated SQL connection are stored.
Related Functions
SQLBeginTran, SQLCommit, SQLDisconnect, SQLEnd, SQLErrMsg, SQLExec, SQLField-
Example
/* Make a connection to an SQL server and select the name field
from each record in the employee database. */
FUNCTION
ListNames()
INT hSQL;
STRING sName;
INT Status;
hSQL = SQLConnect("DSN=MyDatabase;UID=billw;SRVR=CI1");
IF hSQL <> -1 THEN
Status = SQLExec(hSQL, "SELECT NAME FROM EMPLOYEE");
IF Status = 0 THEN
WHILE SQLNext(hSQL) = 0 DO
sName = SQLGetField(hSQL, "NAME");
..
END
SQLEnd(hSQL);
625
ELSE
Message("Error", SQLErrMsg(), 48);
END
ELSE
Message("Error", SQLErrMsg(), 48);
END
END
See Also
SQL Functions
SQLDisconnect
Closes a database connection. You should close all connections to databases before you
shut down CitectSCADA, to release system resources.
For each active transaction (that is, for each SQLBeginTran() call), you should complete the
transaction before you disconnect from the database call SQLCommit() to save your chang-
es, or SQLRollBack() function to discard changes. If you call SQLDisconnect() while a trans-
action is still active, CitectSCADA automatically "rolls back" the transaction any changes
you made to the database in that transaction are discarded.
CitectSCADAalso automatically ends any queries that are active when the database is dis-
connected. If you have called SQLExec() during a database connection, you must call
SQLEnd() before you disconnect from the database or the disconnection attempt might not
succeed.
Syntax
SQLDisconnect(hSQL)
hSQL:
Return Value
You should not call SQLErrMsg() if SQLDisconnect() returns zero (that is, if the disconnec-
tion is successful). SQLErrMsg() would provide information about a connection that does
not exist; the information could be meaningless.
Related Functions
SQLBeginTran, SQLCommit, SQLConnect, SQLEnd, SQLErrMsg, SQLExec, SQLFieldInfo,
SQLGetField, SQLInfo, SQLNext, SQLNoFields, SQLNumChange, SQLRollBack, SQLTra-
ceOff, SQLTraceOn
Example
See SQLConnect
626
See Also
SQL Functions
SQLEnd
Ends the execution of an SQL query (from the latest SQLExec() call). If you have called the
SQLExec() function from within a database connection, you should call SQLEnd() before
you disconnect from that database. When the SQLEnd() function ends the execution of the
current SQL query, it frees the memory that was allocated for that query.
Only one query can be active at a time, so you do not need to end one query before you
execute another query each time you call SQLExec(), the previous query (through a previ-
ous SQLExec() call) is automatically ended. Similarly, CitectSCADA automatically ends the
latest query when it disconnects the database, even if you have not called SQLEnd(). How-
ever, the SQLEnd() function aids efficiency SQLEnd() releases the memory that was allo-
cated when the latest query was executed.
Syntax
SQLEnd(hSQL)
hSQL:
Return Value
Related Functions
SQLBeginTran, SQLCommit, SQLConnect, SQLErrMsg, SQLExec, SQLFieldInfo, SQLGet-
Field, SQLInfo, SQLNext, SQLNoFields, SQLNumChange, SQLRollBack, SQLTraceOff,
SQLTraceOn
Example
See SQLConnect
See Also
SQL Functions
SQLErrMsg
Returns an error message from the SQL system. If a 307 error code occurs when one of the
SQL functions is called, an SQL error message is generated. Call this function to get that
error message.
Syntax
SQLErrMsg()
627
Return Value
The error message (as a string).
Related Functions
SQLBeginTran, SQLCommit, SQLConnect, SQLDisconnect, SQLEnd, SQLExec, SQLField-
Example
See SQLConnect
See Also
SQL Functions
SQLExec
Executes an SQL query on a database. With this function, you can execute any SQL query
or command supported by the SQL database. Only "CHAR" type fields are supported in
database tables.
Keywords such as "DATE", "TIME", and "DESC" cannot be used as field names by some da-
tabase systems. To use fields with these names, you must append underscores to the names
(for example, "TIME_", "DATE_", "DESC_").
The SQLNext() function must be called after the SQLExec() function before you can access
data in the first record.
Only one query can be active at a time, so you do not need to end one query before you
execute another query;each time you call SQLExec(), the previous query (through a previ-
ous SQLExec() call) is automatically ended. Similarly, CitectSCADA automatically ends the
latest query when it disconnects the database, even if you have not called SQLEnd(). How-
ever, the SQLEnd() function aids efficiency;SQLEnd() releases the memory that was allo-
cated when the latest query was executed.
Syntax
SQLExec(hSQL, sSelect)
hSQL:
sSelect:
The SQL query to be sent to the SQL database.
Return Value
628
Related Functions
SQLBeginTran, SQLCommit, SQLConnect, SQLDisconnect, SQLEnd, SQLErrMsg,
SQLFieldInfo, SQLGetField, SQLInfo, SQLNext, SQLNoFields, SQLNumChange, SQL-
RollBack, SQLTraceOff, SQLTraceOn
Example
These examples assume that the following tables are setup in a SQL server (with the name
configured in Windows Control Panel) and opened with the SQLConnect() function:
PEOPLE
SURNAME FIRSTNAME OCCUPATION DEPARTMENT
MARTIAN MARVIN ENGINEER MANAGEMENT
CASE CARRIE SUPPORT CITECT
LIGHT LARRY PROGRAMMER CITECT
BOLT BETTY ENGINEER SYSTEMS
PHONE
SURNAME NUMBER
MARTIAN 5551000
CASE 5551010
BOLT 5551020
LIGHT 5551030
Each SQL string (sSQL) should be encased within the SQLExec function, for example:
SQLExec(hSQL, sSQL);
To add a record to a table:
sSQL = "INSERT INTO PEOPLE (SURNAME, FIRSTNAME, OCCUPATION,
DEPARTMENT) VALUES(’ALLEN’,’MATTHEW’,’PROGRAMMER’,’CITECT’)";
This SQL command changes the PEOPLE table to:

PEOPLE
ALLEN MATTHEW PROGRAMMER CITECT
To remove records from a table:

sSQL = "DELETE FROM (PEOPLE, PHONE) WHERE SURNAME=’MARTIAN’";
SQLBeginTran(hSQL);
SQLExec(hSQL,sSQL);
IF (Message("Alert", "Do you really want to DELETE MARTIAN", 33) = 0) THEN
SQLCommit(hSQL);
ELSE
SQLRollback(hSQL);
END
Assuming that OK was clicked on the Message Box, the tables change to:
629
PEOPLE
PHONE
SURNAME NUMBER
CASE 5551010
BOLT 5551020
LIGHT 5551030
To change a record:
sSQL = "UPDATE PEOPLE SET OCCUPATION=’SUPPORT’ WHERE
FIRSTNAME=’LARRY’";
This SQL command changes the PEOPLE table to:
PEOPLE
LIGHT LARRY SUPPORT CITECT
To select a group of records from a table:

sSQL = "SELECT SURNAME FROM PEOPLE WHERE OCCUPATION=’ENGINEER’";
This SQL command will return the following table back to CitectSCADA. The table can
then be accessed by the SQLNext() function and the SQLGetField() functions.
CITECT TABLE for hSQL
SURNAME
MARTIAN
BOLT
You can also select data using a much more complete SQL string, for example:
sSQL = "SELECT (SURNAME, OCCUPATION, NUMBER) FROM (PEOPLE, PHONE)
WHERE DEPARTMENT=’CITECT’ AND PEOPLE.SURNAME = PHONE.SURNAME";
This SQL command retrieves the following table:

SURNAME OCCUPATION NUMBER
CASE SUPPORT 5551010
LIGHT PROGRAMMER 5551030
To extract information from a table:
630
STRING sInfo[3][10]
int i = 0;
WHILE ((SQLNext(hSQL) = 0) and (i < 10)) DO
sInfo[0][i] = SQLGetField(hSQL, "SURNAME");
sInfo[1][i] = SQLGetField(hSQL, "OCCUPATION");
sInfo[2][i] = SQLGetField(hSQL, "NUMBER");
END
This code example leaves the information in the sInfo two dimensional array as follows:
sInfo
0 1 2
0 CASE SUPPORT 5551010
1 LIGHT PROGRAMMER 5551030
2
3
4
...
See Also
SQL Functions
SQLFieldInfo
Gets information about the fields or columns selected by a SQL query. The function returns
the name and width of the specified field. If you call the function within a loop, you can
return the names and sizes of all the fields in the database.
Syntax
SQLFieldInfo(hSQL, hField, sName, Width)
hSQL:
The handle to the SQL connection, returned from the SQLConnect() function.
The SQL connection handle identifies the table where details of the associated
SQL connection are stored.
hField:
The field (or column) handle, indicating the position of the field in the database.
sName:
A string variable in which the function stores the field name.
Width:
An integer variable in which the function stores the field width.
Return Value
631
Related Functions
SQLBeginTran, SQLCommit, SQLConnect, SQLDisconnect, SQLEnd, SQLErrMsg, SQLEx-
ec, SQLGetField, SQLInfo, SQLNext, SQLNoFields, SQLNumChange, SQLRollBack, SQL-
Example
! Lists all fields in the Employee database
FUNCTION
ListFields()
INT hSQL;
STRING sField;
INT Count;
INT Width;
INT Index;
SQLTraceOn("C:\DATA\TRACE.LOG");
SQLExec(hSQL, "SELECT * FROM C:\DATA\EMPLOYEE");
Count = SQLNoFields(hSQL);
Index = 0;
WHILE Index < COUNT DO
SQLFieldInfo(hSQL,Index,sField,Width);
..
END
SQLEnd(hSQL);
SQLTraceOff();
END
See Also
SQL Functions
SQLGetField
Gets field or column data from a database record. To get the database record, use the
SQLExec() and SQLNext() functions.
Syntax
SQLGetField(hSQL, sField)
hSQL:
sField:
The name of the field or column.
632
Return Value
The field or column data (as a string). A null string is returned if the field or column does
not contain data.
The maximum length of the return data is 255 characters. If the returned data is longer than
this, the function will return error 306.
Related Functions
ec, SQLFieldInfo, SQLInfo, SQLNext, SQLNoFields, SQLNumChange, SQLRollBack, SQL-
Example
See SQLConnect
See Also
SQL Functions
SQLInfo
Gets information about a database connection.
Syntax
SQLInfo(hSQL, Type)
hSQL:
Type:
The type of information to get:
0 - The connection string
1 - The current SQL statement
2 - The current database filename (only works with SQL device)
3 - The SQL format handle
4 - The current Q+E library SQL handle. This handle can be used with functions
in the Q+E library which can be called in Cicode with the DLL functions.
Return Value
The information (as a string).
Related Functions
ec, SQLFieldInfo, SQLGetField, SQLNext, SQLNoFields, SQLNumChange, SQLRollBack,
633
Example
SQLInfo(1,2);
See Also
SQL Functions
SQLNext
Gets the next database record from an SQL query. Use the SQLExec() function to select a
number of records or rows from the SQL database, and then use the SQLNext() function to
step through each record separately.
Syntax
SQLNext(hSQL)
hSQL:
Return Value
Related Functions
ec, SQLFieldInfo, SQLGetField, SQLInfo, SQLNoFields, SQLNumChange, SQLRollBack,
Example
See SQLConnect
See Also
SQL Functions
SQLNoFields
Gets the number of fields or columns that were returned by the last SQL statement.
Syntax
SQLNoFields(hSQL)
hSQL:
634
Return Value
The number of fields. A value of 0 is returned if no fields were returned or if an error has
been detected. (For details of an error, call the SQLErrMsg function).
Related Functions
ec, SQLFieldInfo, SQLGetField, SQLInfo, SQLNext, SQLNumChange, SQLRollBack, SQL-
Example
See SQLFieldInfo
See Also
SQL Functions
SQLNumChange
Gets the number of records that were modified in the last SQL Insert, Update, or Delete
statement.
Syntax
SQLNumChange(hSQL)
hSQL:
Return Value
The number of records that were modified. A value of 0 is returned if no fields were re-
turned or if an error has occurred. (For details of an error, call the SQLErrMsg function).
Related Functions
ec, SQLFieldInfo, SQLGetField, SQLInfo, SQLNext, SQLNoFields, SQLRollBack, SQLTra-
ceOff, SQLTraceOn
Example
See SQLBeginTran
See Also
SQL Functions
SQLRollBack
Rolls back (discards) all changes made to the database within the current transaction. If you
call the SQLBeginTrans() function to begin a transaction, you are not committed to changes
to the database made by the Insert, Delete, and Update commands until you call the SQL-
Commit() function. You can discard these changes by calling the SQLRollBack() function.
635
You can only call the SQLRollBack() function if you have called SQLBeginTran() to begin a
transaction. You do not need to begin a transaction to modify a database, but any changes
you make to a database outside of a transaction are automatically committed.
The SQLRollBack() function could affect different databases in different ways. If the func-
tion is not performing as you expect, check that your database is ODBC-compatible. Refer
to the documentation for your database for more information on rolling back transactions.
Syntax
SQLRollBack(hSQL)
hSQL:
Return Value
Related Functions
ec, SQLFieldInfo, SQLGetField, SQLInfo, SQLNext, SQLNoFields, SQLNumChange, SQL-
Example
See SQLBeginTran
See Also
SQL Functions
SQLSet
Sets a statement string in the SQL buffer. Cicode cannot send an SQL statement that is long-
er than 255 characters. If you have an SQL statement that is longer than the 255 character
limit, you can split the statement into smaller strings, and use this function and the SQLAp-
pend() function to append the statements in the SQL buffer.
Syntax
SQLSet(hSQL, String)
hSQL:
String:
The statement string to set in the SQL buffer. The string must contain the first part
of an SQL statement.
636
Return Value
Related Functions
SQLAppend, SQLBeginTran, SQLCommit, SQLConnect, SQLDisconnect, SQLEnd
Example
SQLBeginTran(hSQL);
SQLSet(hSQL, "SELECT *")
SQLAppend(hSQL, " FROM EMP");
SQLAppend(hSQL, " ORDER BY last_name");
SQLExec(hSQL, "");
See Also
SQL Functions
SQLTraceOff
Turns off the debug trace. Use this function to stop tracing function calls that are made to
the database.
Syntax
SQLTraceOff()
Return Value
Related Functions
RollBack, SQLTraceOn
Example
See SQLFieldInfo
See Also
SQL Functions
SQLTraceOn
Turns on a debug trace. Use this function to begin tracing function calls that are made to
the database. The information is written to a log file.
Syntax
SQLTraceOn(sFile)
637
sFile:
The output file name for the debug trace.
Return Value
Related Functions
RollBack, SQLTraceOff
Example
See SQLFieldInfo
See Also
SQL Functions
638
Chapter: 46 String Functions
String functions allow you to manipulate strings in various ways. You can extract charac-
ters or substrings from a string, convert strings into other data types, format strings, search
for strings, and perform other operations.
String Functions
Following are functions relating to Strings:
CharToStr Converts an ASCII code into a string.
HexToStr Converts a number into a hexadecimal string.
IntToStr Converts an integer variable into a string.
PathToStr Converts a CitectSCADA path into a string.
RealToStr Converts a floating-point variable into a string.
StrClean Removes control characters from a string.
StrFill Fills a string with characters.
StrFormat Formats a variable into a string.
StrGetChar Gets a single character from a string or buffer.
StrLeft Gets the left-most characters from a string.
StrLength Gets the length of a string.
StrLower Converts a string to lower-case.
StrMid Gets characters from the middle of a string.
StrPad Pads a string to the required length.
StrRight Gets the right-most characters from a string.
StrSearch Searches for a string within a string.
StrSetChar Sets a single character into string or buffer.
StrToChar Converts a string to an ASCII code.
StrToDate Converts a string into a date variable.
StrToFmt Converts a string into format fields.
StrToGrp Converts a string into a group.
StrToHex Converts a hexadecimal string into an integer.
StrToInt Converts a string into an integer variable.
StrToLines Converts a string into lines of limited length.
StrToLocalText Converts a string from Native language to Local language.
StrToPeriod Converts a string into a (time) period.
StrToReal Converts a string into a floating-point variable.
StrToTime Converts a string into a time variable.
StrToValue Converts a string into a floating-point variable.
StrTrim Trims spaces from a string.
StrUpper Converts a string to upper-case.
StrWord Gets a word from a string.
639
See Also
Functions Reference
CharToStr
Converts an ASCII code into a string.
Syntax
CharToStr(ASCIICode)
ASCIICode:
The ASCII code to convert.
Return Value
A string containing the converted ASCII code.
Related Functions
StrSetChar
Example
str = CharToStr(65);
! Sets str to "A".
See Also
String Functions
HexToStr
Converts a number into a hexadecimal string. The string is the width specified (padded
with zeros).
Syntax
HexToStr(Number, Width)
Number:
The number to convert.
Width:
The width of the string.
Return Value
A string containing the converted number.
Related Functions
StrToHex, IntToStr
Example
Variable=HexToStr(123, 4);
! Sets Variable to "007B".
640
Variable = HexToStr(0x12ABFE, 8);

! Sets Variable to "0012ABFE"
See Also
String Functions
IntToStr
Converts a number into a string.
Syntax
IntToStr(Number)
Number:
The number to convert.
Return Value
A string containing the converted number.
Related Functions
StrFormat
Example
Variable=IntToStr(5);
! Sets Variable to "5".
See Also
String Functions
PathToStr
Converts a CitectSCADA path into a string. The path string can contain one of the standard
CitectSCADA path operators, BIN, DATA, RUN, or a user-configured path. If the string
does not contain a CitectSCADA path, it is unchanged.
Syntax
PathToStr(sPath)
sPath:
The CitectSCADA path to convert.
Return Value
A string containing the converted path.
Example
Variable=PathToStr("[data]:test.txt");
! Sets Variable to "c:\MyApplication\data\test.txt".
! assuming that DATA=C:\MyApplication\DATA
641
See Also
String Functions
RealToStr
Converts a floating-point number into a string.
Syntax
RealToStr(Number, Width, Places)
Number:
The floating-point number to convert.
Width:
The width of the string.
Places:
The number of decimal places contained in the string.
Return Value
The floating-point number (as a string).
Related Functions
StrToReal
Example
Variable=RealToStr(12.345,10,1);
! Sets Variable to " 12.3" (10 characters long).
See Also
String Functions
StrClean
Removes control characters from a string. Any character that is not a displayable ASCII
character is removed from the string.
Syntax
StrClean(String)
String:
The source string.
Return Value
The string with all control characters removed.
642
Related Functions
StrTrim
Example
Variable=StrClean("*****Text*****");
/* Sets Variable to "Text" (the "*" character in this example
represents an unprintable character). */
See Also
String Functions
StrFill
Fills a string with a number of occurrences of another string.
Syntax
StrFill(String, Length)
String:
The string to be repeated.
Length:
The length of the string.
Return Value
The filled string.
Related Functions
StrPad
Example
Variable=StrFill("abc",10);
! Sets Variable to "abcabcabca".
Variable=StrFill("x",10);
! Sets Variable to "xxxxxxxxxx".
See Also
String Functions
StrFormat
Converts a variable into a formatted string. This function is the equivalent of the Cicode
" :#### " operator.
Syntax
StrFormat(Variable, Width, DecPlaces, EngUnits)
Variable:
643
The variable to format into a string.

Width:
The width of the variable after it has been converted to string format.
DecPlaces:
The number of decimal places in the converted string.
EngUnits:
The engineering units of the variable.
Return Value
The variable (as a formatted string).
Related Functions
StrToReal, StrToInt, RealToStr, IntToStr
Example
Variable=StrFormat(10.345,5,2,"%");
! Sets Variable to "10.35%".
See Also
String Functions
StrGetChar
Gets a single character from a string or buffer. Use this function to read a string, character
by character.
Syntax
StrGetChar(String, iOffset)
String:
The source string.
iOffset:
The offset in the string, commencing at 0.
Return Value
The character at the offset in the string.
Related Functions
StrSetChar
Example
FOR i = 0 To length DO
char = StrGetChar(str, i);
! Get char from string
END
644
See Also
String Functions
StrLeft
Gets the left-most characters from a string.
Syntax
StrLeft(String, N)
String:
The source string.
N:
The number of characters to get from the source string.
Return Value
A string containing the left-most N characters of String.
Related Functions
StrRight, StrMid, StrLength
Example
Variable=StrLeft("ABCDEF",2);
! Sets Variable to "AB".
See Also
String Functions
StrLength
Gets the length of a string.
Syntax
StrLength(String)
String:
The source string.
Return Value
The length of the string (as an integer).
Related Functions
StrRight, StrMid, StrLeft
Example
Variable=StrLength("ABCDEF");
645
See Also
String Functions
StrLower
Converts a string to lowercase.
Syntax
StrLower(String)
String:
The source string.
Return Value
The string (as lowercase).
Related Functions
StrUpper
Example
Variable=StrLower("ABCDEF");
! Sets Variable to "abcdef".
Variable=StrLower("AbCdEf");
! Sets Variable to "abcdef".
See Also
String Functions
StrMid
Gets characters from the middle of a string.
Syntax
StrMid(String, Offset, Characters)
String:
The source string.
Offset:
Characters:
The number of characters to get, commencing at the offset.
Return Value
A string containing the number of characters from the offset.
646
Related Functions
StrLeft, StrLength, StrRight
Example
Variable=StrMid("ABCDEF",1,3);
! Sets Variable to "BCD".
Variable=StrMid("ABCDEF",4,1);
! Sets Variable to "E".
See Also
String Functions
StrPad
Pads a string with a number of occurrences of another string. Padding can be added to the
left or to the right of a string. If the string is already longer than the required string length,
the string is truncated.
Syntax
StrPad(String, PadString, Length)
String:
The source string.
PadString:
The padding string.
Length:
The length of the string. If a positive length is specified, padding will be added to
the right of the string. If a negative length is specified, padding will be added to
the left of the string.
Return Value
A padded string.
Related Functions
StrFill
Example
Variable=StrPad("Test"," ",10);
! Sets Variable to "Test ".
Variable=StrPad("Test","abc",-14);
! Sets Variable to "abcabcabcaTest".
See Also
String Functions
StrRight
647
Gets the rightmost characters from a string.
Syntax
StrRight(String, N)
String:
The source string.
N:
The number of characters to get from the source string.
Return Value
A string containing the rightmost N characters of String.
Related Functions
StrLeft, StrMid, StrLength
Example
Variable=StrRight("ABCDEF",2);
! Sets Variable to "EF".
See Also
String Functions
StrSearch
Searches for a string within a string, commencing at a specified offset. The result of the
search is the index in the source string, where the first character of the sub-string is found.
Index 0 is the first character in the string, index 1 is the second, and so on.
Syntax
StrSearch(Offset, String, Substring)
Offset:
String:
The source string.
Substring:
The substring to search for.
Return Value
The index in the search string, or -1 if the sub-string does not exist in the string.
Related Functions
StrLength
648
Example
Variable=StrSearch(1,"ABCDEF","CD");
Variable=StrSearch(4,"ABCDEF","CD");
Variable=StrSearch(5,"ABCDEF","F");
See Also
String Functions
StrSetChar
Sets a single character into a string or buffer. Use this function to build up a string, character
by character, and terminate the string with the end-of-string character 0 (zero). (If you use
a string without a terminator in a function that expects a string, or in a Cicode expression,
you could get invalid results.) To use the string to build up a buffer, you do not need the
terminating 0 (zero).
Syntax
StrSetChar(sText, iOffset, Char)
sText:
The destination string.
iOffset:
Char:
The ASCII character to set into the string.
Return Value
Related Functions
StrGetChar
Example
! Set chars in buffer, Buf is NOT a valid string
! and cannot be used where a normal string would be used.
FOR i = 0 To length DO
StrSetChar(Buf, i, 30 + i);
END
StrSetChar(sStr, 0, 13); ! put CR into string
StrSetChar(sStr, 1, 0); ! terminate so may be used as a normal string
See Also
String Functions
649
StrToChar
Gets the ASCII code of the first character in a string.
Syntax
StrToChar(String)
String:
The source string.
Return Value
The ASCII code of the first character in String.
Related Functions
StrGetChar
Example
Variable=StrToChar("ABC");
! Sets Variable to 65 (ASCII "A").
See Also
String Functions
StrToDate
Converts a "date" string into a time/date variable. This variable is the same as returned from
the TimeCurrent() function. To set the order of the day, month, and year, and the delimiter,
use the Windows Control panel.
Time/date functions can only be used with dates from 1980 to 2035. You should check that
the date you are using is valid with the following Cicode:
IF StrToDat(Arg1)>0 THEN
...
ELSE
...
END
Syntax
StrToDate(String)
String:
The source string.
Return Value
A time/date variable, or 274 if the time/date is out of range.
Related Functions
StrToPeriod, StrToTime
650
Example
! Australian format (dd/mm/yy) is set in the Windows Control panel.
DateVariable=DateAdd(StrToDate("3/11/95"),86400);
NewDate= TimeToStr(DateVariable, 2);
! Adds 24 hours to 3/11/95 and sets NewDate to "4/11/95".
See Also
String Functions
StrToFmt
Converts a string into field data for a format template. This function is useful for splitting
a string into separate strings. After the string is converted, you can call the FmtGetField()
function to extract the individual data from the template fields.
Syntax
StrToFmt(hFmt, String)
hFmt:
String:
The source string.
Return Value
The string (formatted as template field data).
Related Functions
FmtOpen, FmtGetField
Example
Name=FmtGetField(hFmt,"Name");
! Sets Name to "CV101".
See Also
String Functions
StrToGrp
Converts a string into a group and places it into a group number. Any existing values in
the group are cleared before the new values are inserted. The group string is a series of
numbers separated by " , " to list individual values or " .. " to specify a range of values.
Syntax
StrToGrp(hGrp, Str)
651
hGrp:
Str:
The string to convert.
Return Value
Related Functions
GrpOpen
Example
! Set group to 1 ... 10 and 20, 30 and 40.
StrToGrp(hGrp,"1..10,20,30,40");
See Also
String Functions
StrToHex
Converts a hexadecimal string into an integer. This function will search the string for the
first non-blank character, and then start converting until it finds the end of the string or a
non-hexadecimal numeric character. If the first non-blank character is not one of the follow-
ing hexadecimal characters, the return value is 0 (zero):
 (0-9, a-f, A-F);
 A space;
 A"+" (plus) or a "-" (minus) sign.
Syntax
StrToHex(String)
String:
Return Value
An integer (converted from String).
Related Functions
StrToReal, StrToValue, HexToStr
Example
Variable=StrToHex("123");
! Sets Variable to hex 123, decimal 291
Variable=StrToHex("F2");
! Sets Variable to hex F2, decimal 242
Variable=StrToHex("G45");
652
Variable=StrToHex("-FG");
! Sets Variable to hex, -F decimal -15.
See Also
String Functions
StrToInt
Converts a string into an integer. This function will search the string for the first non-blank
character, and then start converting until it finds the end of the string or a non-numeric
character. If the first non-blank character is not a numeric character (0-9), a space, a " + " or
a " - " sign, the return value is 0 (zero).
Syntax
StrToInt(String)
String:
Return Value
An integer (converted from String).
Related Functions
StrToReal, StrToValue
Example
Variable=StrToInt("45");
Variable=StrToInt("45.23");
Variable=StrToInt("A45");
See Also
String Functions
StrToLines
Converts a string into separate lines that contain no more than the number of characters
specified in the MaxChars argument.
The function splits the string by inserting newline characters into the text string, thus di-
viding it into separate lines. The string will be split at a whitespace character if possible,
and that whitespace will be replaced by the newline character. If no whitespace characters
are available then the insertion will be made at the maximum number of characters from
the previous line break.
653
Syntax
StrToLines(String,MaxChars, nLines)
String:
MaxChars:
The maximum number of characters permitted in each new line produced by the
StrToLines() function.
nLines:
The number of lines produced by the StrToLines() function from the input string.
Return Value
An integer (nLines) containing the number of lines produced by the StrToLines() function
from the input string.
Example
BrokenString=StrToLines("Was that a real Stegosaur?", 5, nLines);
!The function returns the value 6 in nLines, and Broken String now contains:
Was
that
a
real
Stego
saur?
BrokenString=StrToLines("It breaks the string by inserting newline characters into
the text.", 16, nLines);
!The function returns the value 6 in nLines, and Broken String now contains:
It breaks the
string by
inserting
newline
characters into
the text.
See Also
String Functions
StrToLocalText
Converts a native string into the local version of that string. (The string must be contained
within quotation marks, as shown in the example below.) The local version is taken from
the current language database(as specified using the [Language]LocalLanguage parameter).
StrToLocalText(sText)
sText:
The string for which you would like the local translation returned. This string
must be enclosed in quotation marks. For example:
"@(Motor Overload)"
654
Return Value
The local version of the text if it was found, otherwise the native text or "#MESS" is re-
turned, depending on the setting of the [Language]DisplayError parameter.
Related Functions
LanguageFileTranslate, SetLanguage
Example
StrToLocalText("@(Motor Overload)");
! Returns the Local translation of Motor Overload.
See Also
String Functions
StrToPeriod
Converts a string into a time period. You would normally use this function to convert op-
erator input, for example, to set a trend period.
A valid period string is in the format HH:MM:SS, MM:SS or SS, where HH is the hours, MM
is the minutes and SS is the seconds. The colon character (’:’) represents the time delimiter
for these fields, which will be the current system time delimiter as set in the Windows Con-
trol Panel.
If minutes are specified, seconds must be in the range 0-59. If hours are specified, minutes
must be in the range 0-59.
Syntax
StrToPeriod(String)
String:
Return Value
A period (converted from String), or -1 if no conversion can be performed.
Related Functions
StrToTime, StrToDate
Example
Variable=StrToPeriod("200");
! Sets Variable to 200 (seconds).
Variable=StrToPeriod("200:40");
! Sets Variable to 12040 (12000 + 40 seconds).
Variable=StrToPeriod("48:00:40");
! Sets Variable to 172840 (172800 + 40 seconds).
655
See Also
String Functions
StrToReal
Converts a string into a floating-point number. This function will search the string for the
first non-blank character, and then start converting until it finds the end of the string or a
non-numeric character. If the first non-blank character is not a numeric character (0-9), a
space, a decimal point, a " + " or a " - " sign, the return value is 0 (zero).
Syntax
StrToReal(String)
String:
Return Value
A floating-point number (converted from String).
Related Functions
StrToInt, StrToValue
Example
Variable=StrToReal("45");
Variable=StrToReal("45.23");
! Sets Variable to 45.23
Variable=StrToReal("A45");
See Also
String Functions
StrToTime
Converts a "time" string into a time/date variable. The value returned is the number of sec-
onds from midnight. You can add this value to the date to get the current time value. To set
the time delimiter, use the Windows Control Panel.
A valid time string is in the format HH:MM:SS or HH:MM:SS tt, where HH is the hour in
the range 0-23, MM is the minute in the range 0-59, SS is the second in the range 0-59 and
tt is the time extension; for example,, am or pm. The colon character ’:’ represents the time
delimiter for these fields, which will be the current system time delimiter as set in the Win-
dows control panel.
Times may also be passed in the for HH or HH:MM. In other words, you may omit the
right-hand fields if they are 0.
Syntax
StrToTime(String)
656
String:
Return Value
A time/date variable, or -1 if no conversion can be performed.
Related Functions
Time, Date
Example
Variable=StrToTime("11:43:00");
! Sets Variable to (11*3600+43*60+0) seconds.
Variable=StrToTime("9:02");
! Sets Variable to (9*3600+2*60) seconds.
Variable=StrToTime("2");
! Sets Variable to (2*3600) seconds.
See Also
String Functions
StrToValue
Converts a string into a floating-point number. This function is similar to the StrToReal()
function except that the function halts if it is passed an empty or invalid string. The function
will search the string for the first non-blank character, and then start converting until it
finds the end of the string or a non-numeric character. If the first non-blank character is not
a numeric character (0-9), a space, a decimal point, a " +" or a " - " sign, the function will halt.
Use this function to check keyboard input from the operator by setting control points (for
example,, it prevents a setpoint from being set to 0 if the operator presses ENTER or enters
invalid data by mistake).
Syntax
StrToValue(String)
String:
Return Value
A floating-point number (converted from String).
Related Functions
StrToReal, StrToInt
657
Example
System Keyboard
Key Sequence F3 ######## Enter
Command SP123 = StrToValue(Arg1);
Comment Set setpoint 123 to value unless value is invalid
Note that the Cicode is halted. Any other Cicode after the StrToValue() function will not
execute.
See Also
String Functions
StrTrim
Removes leading and trailing spaces from a string. Internal spaces are not removed from
the string.
Syntax
StrTrim(String)
String:
The source string.
Return Value
String with leading and trailing spaces removed.
Related Functions
StrPad, StrFill
Example
Variable=StrTrim(" Test String ");
! Sets Variable to "Test String".
See Also
String Functions
StrUpper
Converts a string to uppercase.
Syntax
StrUpper(String)
String:
The source string.
Return Value
The string (as uppercase).
658
Related Functions
StrLower
Example
Variable=StrUpper("abcdef");
! Sets Variable to "ABCDEF".
Variable=StrUpper("AbCdEf");
! Sets Variable to "ABCDEF".
See Also
String Functions
StrWord
Gets the first word from a string. The word is removed from the string to allow the function
to be repeated. Word separators can be a space, newline, carriage return, or tab character.
Syntax
StrWord(String)
String:
The source string.
Return Value
The first word from String (as a string).
Related Functions
StrSearch
Example
Str="THIS IS A STRING";
Variable=StrWord(Str);
! Sets Variable to "THIS".
! Sets Variable to "IS".
! Sets Variable to "A".
! Sets Variable to "STRING".
See Also
String Functions
659
660
Chapter: 47 Super Genie Functions
The Super Genie functions allow you to use SuperGenies in your runtime system.
Super Genie Functions

Following are functions relating to Super Genies:
Ass Associates a variable tag with a Super Genie.
AssChain Chains the associations from the current Super Genie to a new Su-
per Genie.
AssChainPage Chains the associations from the current Super Genie to a new Su-
per Genie, and displays the new Super Genie (in the current win-
dow).
AssChainPopUp Chains the associations from the current Super Genie to a new Su-
per Genie, and displays the new Super Genie in a new popup win-
dow.
AssChainWin Chains the associations from the current Super Genie to a new Su-
per Genie, and displays the new Super Genie in a new window. The
new window will be of the same type as the current window.
AssChainWinFree Saves the tag associations on an existing Super Genie, closes it,
then assigns the tags to a new window.
AssGetProperty Gets association information about the current Super Genie from
the datasource
AssGetScale Gets scale information about the associations of the current Super
Genie from the datasource
AssInfo Gets association information about the current Super Genie (that
is information about a variable tag that has been substituted into
the Super Genie).
AssInfoEx Gets association information about the current Super Genie (that
is information about a variable tag that has been substituted into
the Super Genie). Replacement for AssInfo supporting online
changes.
AssPage Associates up to eight variable tags with a Super Genie and dis-
plays the Super Genie in the current window.
AssPopUp Associates up to eight variable tags with a Super Genie and dis-
plays the Super Genie in a popup window.
AssScaleStr Gets scale information about the associations of the current Super
Genie (that is scale information about a variable tag that has been
substituted into the Super Genie).
AssTag Associates a variable tag with the current Super Genie. The asso-
ciation will be created for the current Super Genie only, and will only
come into effect after you re-display the Super Genie.
AssTitle Sets the runtime window title to the tag name of the first variable
substituted into the Super Genie.
AssVarTags Associates up to eight variable tags with a Super Genie. This asso-
ciation is only made for the next Super Genie you display (either in
the current window or in a new window). You can use this function
repeatedly to associate more than 8 variable tags to a Super Genie.
AssWin Associates up to eight variable tags with a Super Genie, and dis-
plays the Super Genie in a new window.
661
See Also
Functions Reference
Ass
Associates a variable tag with a Super Genie. This association is only made for the next Su-
per Genie you display (either in the current window or in a new window). You cannot cre-
ate an association for a Super Genie that is already displayed. You must call this function
once for every Super Genie substitution string in the Super Genie, otherwise the variable
(substitution string) will remain uninitialized and it will be displayed as #ASS.
This function provides the lowest level of support for associating Super Genie variables
with physical tags. The higher level functions (listed below) are simpler to use.
Syntax
Ass(hWin, nArg, sTag, nMode [, ClusterName] )
hWin:
The association will be created for the next Super Genie to display in the window
specified here; enter the window number or:
 -3 - for the current window.
 -2 - for the next new window displayed.
nArg:
The argument number (substitution string number) of the Super Genie string to
be replaced by sTag. For example, to replace ?INT 3? with sTag, set nArg to 3.
sTag:
The variable tag that will replace the Super Genie substitution string. The tag
must be the same data type as that specified by the Super Genie substitution
string. For example, only a digital tag could replace the substitution string ?DIG-
ITAL 4?. Any other type of tag may raise a hardware alarm or display #err. If the
substitution string does not specify a type (for example, ?5?), you can use any
type except STRING.
The name of the tag can be prefixed by the name of the cluster for example, "Clus-
terName.Tag".
ClusterName:
Specifies the name of the cluster in which the Variable Tag resides. This is option-
al if you have one cluster or are resolving the tag via the page’s current cluster
Resolution of the tag’s cluster context occurs when the page is displayed. It is re-
solved to the page’s cluster context, not the context in force when this function is
called.
nMode:
The mode of the association. Set to 0.
Return Value
662
Related Functions
AssTag, AssPage, AssWin, AssPopUp, AssInfo, AssChain, AssChainPage, AssChainWin,
AssChainWinFree, AssChainPopUp
Example
// Associate variable tag PV123 with the next Genie to display in
the current window
Ass(-3, 5, "PV123", 0);
See Also
AssChain
Chains the associations from the current Super Genie to a new Super Genie. Use this func-
tion to display a new Super Genie when you already have one displayed. The new Super
Genie will inherit all the associations of the first Super Genie.
This function provides the lowest level of support for chaining associations from one Super
Genie to another. You should call the higher level functions AssChainPage(), AssChain-
Win(), and AssChainPopUp() - these functions are simpler to use.
Syntax
AssChain(hDest, hSource, nMode)
hDest:
The next Super Genie to display in the window specified here will inherit all the
associations of the current Super Genie - enter the window number, or:
 -3: for the current window
 -2: for the next new window displayed.
hSource:
The number of the window containing the source Super Genie (that is the Super
Genie from which the associations will be inherited).
nMode:
The mode of the association. Set to 0.
Return Value
Related Functions
Ass, AssTag, AssPage, AssWin, AssPopUp, AssInfo, AssChainPage, AssChainWin, Ass-
ChainWinFree, AssChainPopUp
Example
// Copy all associations from the current Super Genie to !NewGenie
AssChain(WinNumber(), WinNumber(), 0);
PageDisplay("!NewGenie");
663
See Also
AssChainPage
Chains the associations from the current Super Genie to a new Super Genie, and displays
the new Super Genie (in the current window). Use this function to display a new Super Ge-
nie when you already have one displayed. The new Super Genie will inherit all the associ-
ations of the first Super Genie.
Syntax
AssChainPage(sPage)
sPage:
The page name of the Super Genie. If you prefixed your Super Genie page name
with an exclamation mark (!), remember to include it here.
Return Value
Related Functions
Ass, AssTag, AssPage, AssWin, AssPopUp, AssInfo, AssChain, AssChainWin, AssChain-
WinFree, AssChainPopUp
Example
// Display new Super Genie in current window, using current associations
AssChainPage("!NewGenie");
See Also
AssChainPopUp
the new Super Genie in a new popup window. Use this function to display a new Super
Genie in a new popup window when a Super Genie is already displayed. The new Super
Genie will inherit all the associations of the first.
Note: This function prevents the Super Genie from being opened more than once (at the
same time). However, the same Super Genie with different associations can be opened.
Syntax
AssChainPopUp(sPage)
sPage
664
Return Value
Related Functions
Ass, AssTag, AssPage, AssWin, AssPopUp, AssInfo, AssChain, AssChainPage, AssChain-
Win, AssChainWinFree
Example
// Display new Super Genie in new popup using current associations
AssChainPopUp("!NewGenie");
See Also
AssChainWin
the new Super Genie in a new window. The new window will be of the same type as the
current window. Use this function to display a new Super Genie in a new window when a
Super Genie is already displayed. The new Super Genie will inherit all the associations of
the first.
Syntax
AssChainWin(sPage, X, Y, Mode)
sPage:
 X - The x pixel coordinate of the top left corner of the window.
 Y - The y pixel coordinate of the top left corner of the window.
Mode:
0 - Normal page.
1 - Page child window. The window is closed when a new page is displayed, for
example, when the PageDisplay() or PageGoto() function is called. The
parent is the current active window.
2 - Window child window. The window is closed automatically when the parent
window is freed with the WinFree() function. The parent is the current ac-
tive window.
4 - No re-size. The window is displayed with thin borders and no maximize/min-
imize icons. The window cannot be re-sized.
8 - No icons. The window is displayed with thin borders and no maximize/mini-
mize or system menu icons. The window cannot be re-sized.
16 - No caption. The window is displayed with thin borders, no caption, and no
maximize/minimize or system menu icons. The window cannot be re-
sized.
665
32 - Echo enabled. When enabled, all keyboard echo, prompts, and error messag-
es are displayed on the parent window. This mode should only be used
with child windows (for example, Mode 1 and 2).
64 - Always on top.
128 - Open a unique window. This mode prevents this window from being
opened more then once.
256 - Display the entire window. This mode ensures that no parts of the window
will appear off the screen
512 - Open a unique Super Genie. This mode prevents a Super Genie from being
opened more than once (at the same time). However, the same Super Genie
with different associations can be opened.
1024 - Disables dynamic resizing of the new window, overriding the setting of the
[Page]DynamicSizing parameter.
You can select multiple modes by adding modes together (for example, set Mode
to 9 to open a page child window without maximize, minimize, or system menu
icons).
Return Value
Related Functions
WinFree, AssChainPopUp
Example
// Displays a new super genie in a new window using the current associations
AssChainWin("!NewGenie", 100, 200, 1 + 8);
See Also
AssChainWinFree
Saves the first 8 tag associations on an existing Super Genie, closes it, then assigns the 8 tags
to a new window. This allows a Super Genie popup window to call another popup win-
dow, and close the parent popup.
This function is effectively the same as the AssChainWin() function, but frees the current
Super Genie.
Syntax
AssChainWinFree(sPage, X, Y, Mode)
sPage:
X - the x pixel coordinate of the top-left corner of the window.
Y - the y pixel coordinate of the top-left corner of the window.
666
Mode:
0 - Normal page.
tive window.
sized.
64 - Always on top.
icons).
Return Value
Related Functions
Win, AssChainPopUp
Example
// Close the current genie window and display a new genie using the current associ-
ations
AssChainWinFree("!GeniePopup", 200, 300, 1 + 8);
667
See Also
AssGetProperty
This function gets association information about the current Super Genie from the data-
source (that is information about a variable tag that has been substituted into the Super Ge-
nie). You can only call this function on a Super Genie after all the associations are
completed.
Use this function to display association information as part of the Super Genie. For exam-
ple, if you have a Super Genie that is a loop controller, you could display the name of the
loop at the top of the loop controller box. Each time the Super Genie is used with different
associations (specifically a different tag name association) the correct loop name will be dis-
played.
If a constant value is associated, then only the constant value can be retrieved through the
TagName property. All other properties are not valid.
This function replaces AssInfo.
Syntax
AssGetProperty(iArg, sProperty [, iCached] )
iArg:
The argument number of the association from which to get information.
sProperty:
The property to read. Property names are case sensitive. Supported properties
are:
Address - The configured address of the associated tag (as specified in the variable
tags form)
ArraySize - Array size of the associated tag. Returns 1 for non-array types
AssFullName - Full name of the association tag in the form cluster.tagname even if
the tag is not resolved
ClusterName - Name of the cluster the associated tag resides on.
DataBitWidth - Number of bits used to store the value
Description - Description of the associated tag
EngUnitsHigh - Maximum scaled value
EngUnitsLow - Minimum scaled value
Format - Format bit string. The format information is stored in the integer as fol-
lows:
 Bits 0-7 - format width
 Bits 8-15 - number of decimal places
 Bits 16 - zero-padded
 Bit 17 - left-justified
 Bit 18 - display engineering units
 Bit 20 - exponential (scientific) notation
FormatDecPlaces - Number of decimal places for default format
FormatWidth - Number of characters used in default format
668
FullName - Full name of the association tag in the form cluster.tagname If the as-
sociation tag is not resolved, returns an empty string.
RangeHigh - Maximum unscaled value
RangeLow - Minimum unscaled value
TagName - Name of the tag for the specified association
Type - Raw type of associated tag
Units - Engineering Units for example, %, mm, Volts
iCached:
Optional flag to attempt to retrieve the cached value for the property rather than
the current value. This makes the function non-blocking. If the property has not
yet been cached, an error is set.
0 - Do not force cached read. Cicode is blocking
1 - Force cached read. Cicode is non-blocking
Default value is 1 (true).
Return Value
String representation of the property of the association. On detection of an error, an empty
string and an error are set.
Related Functions
AssGetProperty, AssGetScale, AssInfo, AssScaleStr, TagGetProperty, TagGetScale, Tag-
ScaleStr, TagInfo
Example
// Get the engineering full scale value for the 2nd
// argument of the association of the current Super Genie
EngFullScale = AssGetProperty(2, "EngUnitsHigh", 0);
// Get the cached engineering units for the 3rd argument
// of the association of the current Super Genie
MeasureUnits = AssGetProperty(3, "Units", 1);
See Also
AssGetScale
Gets scale information about the associations of the current Super Genie from the data-
source (that is scale information about a variable tag that has been substituted into the Su-
per Genie). You can only call this function on a Super Genie after all the associations are
completed.
Use this function to display association scale information as part of the Super Genie. For
example, if you have a bar graph illustrating output, you could indicate zero, 50%, and full
scale output on the vertical axis of the graph. Each time the Super Genie is used with dif-
ferent associations the correct scale values will be displayed.
The value is returned as a formatted string using the association format specification and
(optionally) the engineering units.
669
This function replaces AssScaleStr.
Syntax
AssGetScale(iArg, iPercent, iEngUnits [, iCached] )
iArg:
The argument number of the association from which to get information.
iPercent:
The percentage of full scale of the returned value.
iEngUnits:
Flag to determine if the value is returned with engineering units:
0 - Do not return the value with engineering units
1 - Return the value with engineering units
iCached:
Return Value
The scale of the association (as a string).
Related Functions
AssGetProperty, AssInfo, AssScaleStr, TagGetProperty, TagGetScale, TagScaleStr, TagInfo
Example
// Display the zero, 50% and full scale of the 2nd argument
// of the association of the current Super Genie
DspText(31,0,AssGetScale(2, 0, 1));
See Also
AssInfo
Gets association information about the current Super Genie (that is information about a
variable tag that has been substituted into the Super Genie). You can only call this function
on a Super Genie after all the associations are completed.
670
played.
Note: This function is being deprecated and is replaced by the AssGetProperty function. If
the Tag properties are updated, AssInfo does not get the updated values whereas AssGet-
Property does. In addition, the function AssInfoEx has been introduced to make it easier to
make legacy Cicode compatible with online changes. In most cases AssInfo can be replaced
with AssInfoEx using Find and Replace (see Using Find and Replace in a project). Please be
aware that if you are replacing an instance of AssInfo with AssInfoEx in a loop, you may
want to make AssInfoEx blocking using the iCached argument to verify you are using the
correct value for the Tag in your logic.
Syntax
AssInfo(nArg, nType)
nArg:
When you associate variable tags with super Genies, the Super Genie substitution
strings are replaced by variable tags. The nArg argument allows you to get infor-
mation about one of those variable tags. All you need to know is which substitu-
tion string it replaced when the association was performed.
Enter the argument number (substitution string number) of the relevant substitu-
tion string. For example, if you want information about the variable that replaced
substitution string
?INT 3?
set nArg to 3.
nType:
0 - The Tag name of the association. If the association tag is not resolved, returns
an empty string.
1 - Engineering units
2 - Raw zero scale
3 - Raw full scale
4 - Engineering zero scale
5 - Engineering full scale
6 - Width of the format
7 - Number of decimal places of format
8 - The Tag format as a long integer. The format information is stored in the inte-
ger as follows:
 Bit 17- left-justified
9 - Logical Unit Number - I/O device number (for internal use)
10 - Raw Type - Protocol’s raw data type number for this tag. Type numbers are:
 0 - Digital
 1 - Integer
671
 2 - Real
 3 - BCD
 4 - Long
 5 - Long BCD
 6 - Long Real
 7 - String
 8 - Byte
 9 - Void
 10 - Unsigned integer
11 - Bit Width - Tag’s size in bits. For example, an INT is 16 bits
12 - Unit Type - Protocol’s unit type number for this tag
13 - Unit Address - Tag’s address after the protocol DBF’s template is applied.
14 - Unit Count - Array size. For example, if the tag’s address is I1[50], the unit
count is 50.
15 - Record Number - Tag’s record number in variable.DBF - 1. That is, the first
tag has a record number of 0.
16 - Comment - As defined in the variable tags list.
17 - ClusterName of the tag. If the association tag is not resolved, returns an emp-
ty string.
18 - Full name (cluster.tagname) of the associated tag. If the association tag is not
resolved, returns an empty string.
19 - Full name (cluster.tagname) of the associated tag even if the association tag is
not resolved.
Return Value
The value of the information as a string.
Related Functions
Ass, AssInfoEx, AssTag, AssPage, AssWin, AssPopUp, AssChain, AssChainPage, Ass-
ChainWin, AssChainWinFree, AssChainPopUp, AssGetProperty, AssGetScale, AssScal-
eStr, TagGetProperty, TagGetScale, TagScaleStr, TagInfo, TagInfoEx
Example
sTag = AssInfo(1, 0); // Get the name of association 1
sEngLow = AssInfo(1, 4); // get the low engineering scale of association 1
See Also
AssInfoEx
Gets association information about the current Super Genie (that is information about a
variable tag that has been substituted into the Super Genie). You can only call this function
on a Super Genie after all the associations are completed.
672
played.
Note: When replacing an instance of AssInfo with AssInfoEx in a loop, you may want to
make AssInfoEx blocking using the iCached argument to verify you are using the correct
value for the Tag in your logic.
Syntax
AssInfoEx(nArg, nType [, iCached] )
nArg:
strings are replaced by variable tags. The nArg argument allows you to get infor-
mation about one of those variable tags. All you need to know is which substitu-
tion string it replaced when the association was performed.
tion string. For example, if you want information about the variable that replaced
substitution string
?INT 3?
set nArg to 3.
nType:
0 - The Tag name of the association. If the association tag is not resolved, returns
an empty string.
2 - Raw zero scale
3 - Raw full scale
8-16 - Not supported
17 - ClusterName of the tag. If the association tag is not resolved, returns an emp-
ty string.
18 - Full name (cluster.tagname) of the associated tag. If the association tag is not
resolved, returns an empty string.
19 - Full name (cluster.tagname) of the associated tag even if the association tag is
not resolved.
iCached:
673
Return Value
The value of the information as a string. If an error is detected an empty string is returned.
The error code can be obtained by calling the IsError Cicode function.
Related Functions
Ass, AssInfo, AssTag, AssPage, AssWin, AssPopUp, AssChain, AssChainPage, AssChain-
Win, AssChainWinFree, AssChainPopUp, AssGetProperty, AssGetScale, AssScaleStr, Tag-
GetProperty, TagGetScale, TagScaleStr, TagInfo, TagInfoEx
Example
sTag = AssInfoEx(1, 0); // Get the name of association 1 in non-blocking mode
sEngLow = AssInfoEx(1, 4, 0); // get the low engineering scale of association 1,
block until data is available
See Also
AssPage
Associates up to eight variable tags with a Super Genie and displays the Super Genie in the
current window. The first variable tag (sTag1) replaces Super Genie substitution string 1.
The second variable tag (sTag2) replaces substitution string 2, and so on.
This function has the same effect as calling Ass() or AssTag() eight times, and then calling
the PageDisplay() function. The AssPage() function provides a quick way of associating
eight Super Genie variables and displaying the Super Genie - at the same time.
If you want to associate more than eight tags with the Super Genie, you must call the Ass-
VarTags(), AssTag(), or Ass() function to create the associations before you call this func-
tion.
Syntax
AssPage(sPage, sTag1, [sTag2..8] )
sPage:
sTag1..sTag8:
The first eight physical tags to be associated with the Super Genie. For any given
Super Genie, the variable tags will replace the Super Genie substitution strings as
follows:
Variable tag... replaces substitution string...
sTag1 1
sTag2 2
sTag3 3
sTag4 4
sTag5 5
sTag6 6
674
sTag7 7
sTag8 8
Because there is a strict correlation between the variable tag numbers and the sub-
stitution string numbers, it is important to know how your Super Genie substitu-
tions are numbered. For example, if your Super Genie has three unique
substitution strings, numbered 1, 3, & 4, you must enter a blank ("") for sTag2.
The variable tags that you specify here must be the same data type as that speci-
fied by the relevant Super Genie substitution strings. For example, only a digital
tag could replace the substitution string ?DIGITAL 4?. If the substitution string
does not specify a type (for example, ?5?), you can use any type except STRING.
terName.Tag".
Return Value
Related Functions
Ass, AssTag, AssWin, AssPopUp, AssInfo, AssChain, AssChainPage, AssChainWin, Ass-
Example
// Associate 3 tags with the Super Genie then display the Super Genie
AssPage("!MyGenie", "PV123", "OP123", "SP123");
See Also
AssPopUp
Associates up to eight variable tags with a Super Genie and displays the Super Genie in a
popup window. The first variable tag (sTag1) replaces Super Genie substitution string 1.
The second variable tag (sTag2) replaces substitution string 2, and so on.
This function has the same effect as calling the Ass() function or the AssTag() function eight
times, and then calling the WinNewAt() function to create a window at the position of the
mouse. The AssPopUp() function is a quick way of associating eight Super Genie variables
and displaying the Super Genie in a new window at the same time.
If you want to associate more than eight tags with the Super Genie, you must call the Ass-
tion.
Note: This function prevents the Super Genie from being opened more than once (at the
same time). However, the same Super Genie with different associations can be opened.
Syntax
AssPopUp(sPage, sTag1, [sTag2..8] )
sPage:
675
sTag1..sTag8:
The first 8 physical tags to be associated with the Super Genie. For any given Su-
per Genie, the variable tags will replace the Super Genie substitution strings as
follows:
sTag1 1
sTag2 2
sTag3 3
sTag4 4
sTag5 5
sTag6 6
sTag7 7
sTag8 8
terName.Tag".
Return Value
Related Functions
Ass, AssTag, AssPage, AssWin, AssInfo, AssChain, AssChainPage, AssChainWin, Ass-
Example
// Associate 3 tags with the Super Genie then display it
AssPopUp("!MyGenie", "PV123", "OP123", "SP123");
See Also
AssScaleStr
Gets scale information about the associations of the current Super Genie (that is scale infor-
mation about a variable tag that has been substituted into the Super Genie). You can only
call this function on a Super Genie after all the associations are completed.
676
Use this function to display association scale information as part of the Super Genie. For
example, if you have a bar graph illustrating output, you could indicate zero, 50%, and full
scale output on the vertical axis of the graph. Each time the Super Genie is used with dif-
ferent associations the correct scale values will be displayed.
The value is returned as a formatted string using the association format specification and
(optionally) the engineering units.
Note: This function is being deprecated and is replaced by the AssGetScale function. If the
Tag properties are updated AssScaleStr does not get the updated values whereas Ass-
GetScale does.
Syntax
AssScaleStr(nArg, Percent, EngUnits)
nArg:
strings are replaced by variable tags. The nArg argument allows you to get scale
information about a particular variable tag. All you need to know is which sub-
stitution string the tag replaced when the association was performed.
tion string. For example, if you want scale information about the variable that re-
placed substitution string:
?INT 3?
set nArg to 3.
Percent:
EngUnits:
Determines if the value is returned with engineering units:
Return Value
The scale of the association (as a string).
Related Functions
AssGetProperty, AssGetScale, AssInfo, TagGetProperty, TagGetScale, TagScaleStr, TagIn-
fo
Example
// Display the zero, 50% and full scale of the variable that was substituted for
Super Genie arg no. 3
DspText(31,0,AssScaleStr(3, 0, 1));
See Also
677
AssTag
Associates a variable tag with the a Super Genie. The association will only be created for
the next Super Genie you display in the current window, and will only come into effect af-
ter you re-display the Super Genie. You must call this function once for every substitution
string in the current Super Genie, or the super-genie variable (substitution string) will re-
main uninitialized and it will display as #ASS. You cannot use this function to create asso-
ciations for variables that will display in new windows.
Syntax
AssTag(nArg, sTag [, ClusterName] )
nArg:
The argument number (substitution string number) of the Super Genie string to
be replaced by sTag. For example, to replace ?INT 3? with sTag, set nArg to 3.
sTag:
The variable tag that will replace the Super Genie substitution string. The tag
must be the same data type as that specified by the Super Genie substitution
string. For example, only a digital tag could replace the substitution string ?DIG-
ITAL 4?. If the substitution string does not specify a type (for example, ?5?), you
can use any type except STRING.
terName.Tag".
ClusterName:
Specifies the name of the cluster in which the Variable Tag resides. This is option-
al if you have one cluster or are resolving the tag via the current cluster context.
The argument is enclosed in quotation marks "".
Resolution of the tag’s cluster context occurs when the page is displayed. It is re-
solved to the page’s cluster context, not the context in force when this function is
called.
Return Value
Related Functions
Ass, AssPage, AssWin, AssPopUp, AssInfo, AssChain, AssChainPage, AssChainWin, Ass-
Example
// Associate variable tag PV123 and PV124 with !MyGenie
AssTag(1, "PV123");
AssTag(2, "PV124");
// Re-display the current Super Genie
PageDisplay("!MyGenie");
See Also
678
AssTitle
Sets the runtime window title to the tag name of the first variable substituted into the Super
Genie.
Syntax
AssTitle( [Mask] [, Prefix] [, Suffix])
Mask:
The number of characters to mask (hide) from the right of the title string (option-
al).
Prefix:
A string to add to the beginning of the title string (optional).
Suffix:
A string to add to the end of the title string (optional).
Return Value
Related Functions
Win, AssChainWinFree, AssChainPopUp
See Also
AssVarTags
Associates up to eight variable tags with a Super Genie. This association is only made for
the next Super Genie you display (either in the current window or in a new window). This
function has an offset that allows you to specify which substitution string the first variable
tag will replace. This means that if you have a Super Genie with more than 8 substitution
strings, you can use this function repeatedly (while increasing the offset), until you have
associated all the necessary variable tags.
This function has the same effect as calling the Ass() function or the AssTag() function eight
times. The AssVarTags() function is a quick way of associating up to eight Super Genie
variables at the same time.
Syntax
AssVarTags(hWin, nOffset, sTag1, [sTag2..8] )
hWin:
The association will be created for the next Super Genie to display in the window
specified here - enter the window number or:
-3 - for the current window.
-2 - for the next new window displayed.
nOffset:
By default, the first variable tag (sTag1) will replace substitution string 1, and
sTag2 will replace substitution string 2, and so on. Enter an offset to change this
679
so that sTag1 replaces a substitution string other than the first. For example, an
offset of 8 means that sTag1 replaces string 9 instead of the default string 1
(8+1=9), and sTag2 replaces string 10 instead of string 2 (8+2=10) etc. This means
that you can use this function repeatedly to associate more than eight variables.
sTag1..8:
The physical variable tags (up to eight) to be associated with the Super Genie. For
any given Super Genie, the variable tags will replace the Super Genie substitution
strings as follows:
If nOffset is 0... sTag1 will replace the substitution string 1,
sTag2 will replace the substitution string 2, etc.
If nOffset is 8... sTag1 will replace the substitution string 9,
sTag2 will replace the substitution string 10, etc.
terName.Tag".
Return Value
No value is returned.
Related Functions
AssTag, AssPage, AssWin, AssPopUp, AssInfo, AssChain, AssChainPage, AssChainWin,
AssChainWinFree, AssChainPopUp
Example
// Associate 12 variables to the Super Genie
AssVarTags(WinNumber(), 0, "PV123", "SP123", "OP123", "PV124", "SP124", "OP124",
"PV125", "SP125");
AssVarTags(WinNumber(), 8, "OP125", "PV126", "SP126", "OP126");
PageDisplay("!MyGenie"); // Display the Super Genie
See Also
AssWin
Associates up to eight variable tags with a Super Genie, and displays the Super Genie in a
new window. This function has the same effect as calling the Ass() or AssTag() function
eight times, and then calling the WinNewAt() function. The AssWin() function is a quick
way of associating eight Super Genie variables and creating a new window - at the same
time.
If you want to associate more than eight tags with the Super Genie you must call the Ass-
tion.
680
Syntax
AssWin(sPage, X, Y, Mode, sTag1, [sTag2..8] )
sPage:
X - The x pixel coordinate of the top left corner of the window.
Y - The y pixel coordinate of the top left corner of the window.
Mode:
0 - Normal page.
tive window.
sized.
64 - Always on top.
icons).
sTag1..8:
The first eight physical tags to be associated with the Super Genie. For any given
Super Genie, the variable tags will replace the Super Genie substitution strings as
follows:
sTag1 1
681
sTag2 2
sTag3 3
sTag4 4
sTag5 5
sTag6 6
sTag7 7
sTag8 8
terName.Tag".
Return Value
Related Functions
AssTag, AssPage, , AssPopUp, AssInfo, AssChain, AssChainPage, AssChainWin, Ass-
Example
// Associate 3 tags with the Super Genie
// then display the new window at (100,200) in mode 9
AssWin("!MyGenie", 100, 200, 1 + 8, "PV123", "OP123", "SP123");
See Also
682
Chapter: 48 Table (Array) Functions
Table functions perform mathematical functions on entire tables (or arrays), such as the cal-
culation of minimum, maximum, average, and standard deviation values.

Following are functions relating to Tables:
TableLookup Gets a value from a table.
TableMath Performs mathematical operations on a table, for example, average,
maximum, minimum, etc.
TableShift Shifts a table, left or right.
See Also
Functions Reference
TableLookup
Searches for a value in a table, and returns the position (offset) of the value in the table.
Note that the first item in a table is offset 0 (zero), the next item is offset 1, etc.
Syntax
TableLookup(Table, Size, Value)
Table:
The table to search. The table must be an array of real numbers.
Size:
The maximum number of items in the table.
Value:
The value to locate.
Return Value
The offset to the table value, or -1 if the value does not exist.
Related Functions
TableMath
Example
REAL Levels[5]=10,15,50,100,200;
Variable=TableLookup(Levels,5,50);
Variable=TableLookup(Levels,5,45);
683
See Also
TableMath
Performs mathematical operations on a table of real (floating-point) numbers. This function
supports minimum, maximum, average, standard deviation, and total operations on a ta-
ble of values. Use this function for operating on tables returned from the trend system with
the TrnGetTable() function. You can set the Mode to either accept or ignore invalid or gated
data returned from TrnGetTable().
Note: This function cannot check the length of any arrays passed to it. If the array is shorter
than the size argument, unpredictable results can occur, such as data in memory being
overwritten, or a general protection fault.
Syntax
TableMath(Table, Size, Command [, Mode] )
Table:
Any table of floating-point numbers.
Size:
Command:
The mathematical operation to perform on the table:
0 - Minimum
1 - Maximum
2 - Average
3 - Standard deviation
4 - Total
Mode:
The mode of the operation:
0 - Operate on all data - default
1 - Ignore invalid or gated data returned from the TrnGetTable() function
Return Value
Related Functions
TableLookup TrnGetTable
Example
REAL Array[5]=10,15,50,100,200;
REAL Min,Avg;
! Get the minimum value.
Min=TableMath(Array, 5, 0, 0); ! Sets Min to 10.
! Get the average value.
Avg=TableMath(Array, 5, 2, 0); ! Sets Avg to 75.
684
See Also
TableShift
Shifts table items in a table by a number of positions. You can shift the table left or right.
Items shifted off the end of the table are lost. Items within a table that are not replaced by
other items (that have moved) are set to 0.
Syntax
TableShift(Table, Size, Count)
Table:
The table to shift, an array of real numbers.
Size:
Count:
The number of positions to shift the table items. A negative Count moves items
to the right and a positive Count moves items to the left.
Return Value
Related Functions
TableMath, TableLookup
Example
REAL Levels[5]=10,15,50,100,200;
TableShift(Levels,5,2);
/* Shifts the table items by 2 positions to the left, that is
Levels[0]=50
Levels[1]=100
Levels[2]=200
Levels[3]=0
Levels[4]=0 */
See Also
685
686
Chapter: 49 Tag Functions
The Tag functions allow you to read the values of variables in I/O devices such as PLCs,
and to write data into these I/O device variables. These functions also allow you to control
I/O devices and to display information about I/O devices.
Tag Functions
Following are functions relating to Tags:
TagDebug Displays a dialog which allows you to select any configured tag
to read or change (write) its value.
TagGetProperty Gets a property for a variable tag from the datasource.
TagGetScale Gets the value of a tag at a specified scale from the datasource
TagInfo Gets information about a variable tag.
TagInfoEx Gets information about a variable tag.
TagRamp Increments a tag by a percentage amount.
TagRDBReload Reloads the variable tag database so when TagInfo is called it
picks up all online changes to the tag database.
TagRead Reads a variable from an I/O Device.
TagScaleStr Gets the value of a tag at a specified scale.
TagSubscribe Subscribes a tag for periodic monitoring and event handling.
TagUnsubscribe Unsubscribes a tag for periodic monitoring and event handling.
TagWrite Writes to an I/O Device variable
TagWriteEventQue Opens the tag write event queue.
See Also
Functions Reference
TagDebug
Displays a dialog which allows you to select from a list of all the configured variable tags
in your system. Once you have selected a tag, you can either press the Read button to get
the tag’s current value; or change the value by entering a new one, and pressing the Write
button. This function should only be used for debugging or commissioning.
To read or change (write) the value of an element in an array variable, type it into the dia-
log’s variable tag field as follows:
687
Syntax
TagDebug()
Return Value
The name of the tag entered in the dialog.
Related Functions
TagInfo, TagRead, TagWrite
Example
TagDebug(); /* Display debug form to allow user to debug */
See Also
Tag Functions
TagGetProperty
This function reads a property of a variable tag from the datasource. This function replaces
TagInfo.
Syntax
TagGetProperty(sName, sProperty [, iCached] [, ClusterName] )
sName:
The name of the tag from which to get information. The name of the tag can be
prefixed by the name of the cluster that is "ClusterName.Tag".
sProperty:
The property to read. Property names are case sensitive. Supported properties
are:
Address - Returns the configured address of the tag (as specified in the variable
tags form).
ArraySize - Array size of the associated tag. Returns 1 for non-array types.
DataBitWidth - Number of bits used to store the value
Description - Tag description
EngUnitsHigh - Maximum scaled value
EngUnitsLow - Minimum scaled value
Format - Format bit string. The format information is stored in the integer as fol-
lows:
FormatDecPlaces - Number of decimal places for default format
FormatWidth - Number of characters used in default format
688
RangeHigh - Maximum unscaled value

RangeLow - Minimum unscaled value
Type - Type of tag. Allowed values are:
 0 - Digital
 1 - Byte
 2 - Integer16
 3 - UInteger16
 4 - Long
 5 - Real
 6 - String
 7 - ULong
 8 - Undefined
Units - Engineering Units for example, %, mm, Volts
iCached:
ClusterName:
Specifies the name of the cluster in which the Tag resides. The argument is en-
closed in quotation marks.
Return Value
String representation of the property of the tag. On error, an empty string and an error is
set.
Related Functions
AssGetProperty, AssGetScale, AssInfo, AssScaleStr, TagGetScale, TagScaleStr, TagInfo
Example
// Get the engineering full scale value for the variable "PV131"
EngFullScale = TagGetProperty("PV131", "EngUnitsHigh", 0);
// Get the cached array size for the array variable "PLC_Array"
ArrayLength = TagGetProperty("PLC_Array", "ArraySize", 1);
See Also
Tag Functions
TagGetScale
Gets the value of a tag at a specified scale from the datasource. The value is returned as a
formatted string using the tags format specification and (optionally) the engineering units.
Use this function to write generic Cicode that will work with any type of tag. This function
replaces TagScaleStr.
689
Syntax
TagGetScale(sName, iPercent, iEngUnits [, iCached] [, ClusterName] )
sName:
The name of the tag. The name of the tag can be prefixed by the name of the clus-
ter that is "ClusterName.Tag".
iPercent:
iEngUnits:
Flag to determine if the value is returned with engineering units:
iCached:
ClusterName:
Return Value
The scale of the tag (as a string).
Related Functions
AssGetProperty, AssGetScale, AssInfo, AssScaleStr, TagGetProperty, TagScaleStr, TagInfo
Example
// Display the zero, 50% and full scale of the tag CV_123_PV
DspText(31,0,TagGetScale("CV_123_PV", 0, 1));
See Also
Tag Functions
TagInfo
Gets information about a variable tag. This function allows you to develop generic Cicode
and Super Genies.
Syntax
TagInfo(sName, nType [, ClusterName] )
690
sName:
To get information on a particular element in an array, enter the array name here,
followed by the number of the element as follows:
"PLC_Array[9]"
The above example tells the function to get information on the tenth element in
PLC_Array (remember, the address of the first element in an array is 0 (zero)).
nType:
0 - The Tag name from the variables table. This is the same as sName argument.
(Returned to be compatible with the AssInfo() function).
2 - Raw zero scale
3 - Raw full scale
ger as follows:
 0 - Digital
 1 - Integer
 2 - Real
 3 - BCD
 4 - Long
 5 - Long BCD
 6 - Long Real
 7 - String
 8 - Byte
 9 - Void
12 - Unit Type - Protocol’s unit type number for this tag
13 - Unit Address - Tag’s address after the protocol DBF’s template is applied.
14 - Unit Count - Array size. For example, if the tag’s address is I1[50], the unit
count is 50.
691
15 - Record Number - Tag’s record number in variable.DBF - 1. That is, the first
tag has a record number of 0.
17 - ClusterName of the tag. If the tag is not resolved, returns an empty string.
18 - Full name (cluster.tagname) of the tag. If the tag is not resolved, returns an
empty string.
19 - Reserved for internal operation.
20 - Configured Address of the tag. If the tag is not resolved, returns an empty
string.
If the tag is a local variable, modes 9, 11, 12, 13, 14, 15 and 17 will return an empty
string, while mode 18 will return only the tag name (without the cluster speci-
fied).
ClusterName
Return Value
The value of the information as a string.
Related Functions
AssGetProperty, AssGetScale, AssInfo, AssScaleStr, TagGetProperty, TagGetScale, TagIn-
foEx, TagScaleStr
Example
/* Get the engineering full scale value for the variable "PV131" */
EngFullScale = TagInfo("PV131", 5);
/* Get the engineering zero scale value for the array variable "PLC_Array" */
EngZeroScale = TagInfo("PLC_Array", 4);
See Also
Tag Functions
TagInfoEx
This function replaces TagInfo and supports online changes. It is recommended therefore
that instances of TagInfo in legacy code are migrated to either TagInfoEx or TagGetProper-
ty. New Cicode should use TagGetProperty.
Gets information about a variable tag. This function allows you to develop generic Cicode
and Super Genies. Execution can be blocking or non-blocking depending on the iCached
argument.
Note: When replacing an instance of TagInfo with TagInfoEx in a loop, you may want to
make TagInfoEx blocking using the iCached argument so that you are using the correct val-
ue for the Tag in your logic.
Syntax
TagInfoEx(sName, nType [, ClusterName] [, iCached] )
692
sName:
To get information on a particular element in an array, enter the array name here,
followed by the number of the element as follows:
"PLC_Array[9]"
The above example tells the function to get information on the tenth element in
nType:
0 - The Tag name from the variables table. This is the same as sName argument.
(Returned to be compatible with the AssInfo() function).
2 - Raw zero scale
3 - Raw full scale
ger as follows:
 0 - Digital
 1 - Integer
 2 - Real
 3 - BCD
 4 - Long
 5 - Long BCD
 6 - Long Real
 7 - String
 8 - Byte
 9 - Void
12-15 - Not supported
17 - ClusterName of the tag.
18 - Full name (cluster.tagname) of the tag.
693
If the tag is a local variable, modes 9, 11 and 17 will return an empty string, while
mode 18 will return only the tag name (without the cluster specified).
ClusterName
iCached:
Return Value
The value of the information as a string. In case of error an empty string is returned. The
error code can be obtained by calling the IsError Cicode function.
Related Functions
fo, TagScaleStr
Example
/* Get the engineering full scale value for the variable "PV131".
Obtain the value from Cluster1 in blocking mode */
EngFullScale = TagInfoEx("PV131", 5, "Cluster1", 0);
/* Get the engineering zero scale value for the array variable
"PLC_Array" in non-blocking mode*/
EngZeroScale = TagInfoEx("PLC_Array", 4);
See Also
Tag Functions
TagRamp
This function will increment a Tag by the amount defined by iPercentInc. It is often used
for incrementing a tag while a button is held down.
Syntax
TagRamp(sTag, iPercentInc)
sTag:
The variable tag name (or alarm property name), as a string. The name of the tag
can be prefixed by the name of the cluster that is "ClusterName.Tag".
To read a particular element in an array, you can enter the array name here, fol-
lowed by an index to the element as follows:
"PLC_Array[9] "
The above example tells the function to read the 10th element in the array variable
694
If you enter an array offset using the nOffset argument, it will be added to the in-
dex value specified here. For example, TagRead("PLC_Array[9]", 4) will read the
14th element in PLC_Array (because [9] means the 10th element, and an offset of
4 means 4 elements after the 10th = element 14).
iPercentInc:
The percentage by which you want to increase the value of the variable. A nega-
tive number will decrease the variable. The increment is calculated as a percent-
age of the full range.
Return Value
Related Functions
TagInfo, TagRead, TagWrite
Example
Buttons
Text Ramp Up
Repeat Command TagRamp("PLC_VAR_1",2);
Comment Continual increment by 2%
See Also
Tag Functions
TagRDBReload
Works in conjunction with the TagInfo function. Reloads the variable tag database so when
TagInfo is called it picks up all online changes to the tag database.
Syntax
TagRDBReload()
Return Value
Returns 1 if the tag database was successfully reloaded, and 0 if the tag database fails to
load.
Note: This function will fail and return 0 if the parameter [General]TagDB as been set to 0.
Related Functions
TagInfo
See Also
Tag Functions
TagRead
Reads a variable from the I/O device. The variable tag must be defined in the Variable Tags
database. Because the variable tag is specified as a string (not as a tag), you can ignore the
data type of the variable.
695
complete.
TagRead should only be used when the variable tag name is a calculation such as sAlarm-
Ext+".Paging". For simple assignment of variables use the assignment operator. For exam-
ple, MyString = MyCluster.MyAlarm.MyProperty.
If you try to read many variables at the same time, the TagRead() function may be slow.
The offset index for array variables is checked against the size of the array.
Syntax
TagRead(sTag [, nOffset] [, ClusterName] )
sTag:
"PLC_Array[9] "
nOffset:
The offset for an array variable. This argument is optional - if not specified, it has
a default value of 0.
If you enter an array index as part of the sTag argument, it will be added to this
offset value. For example, TagRead("PLC_Array[9]", 4) will read the 14th element
in PLC_Array (because [9] means the 10th element, and an offset of 4 means 4 el-
ements after the 10th = element 14).
ClusterName:
Return Value
The value of the I/O device variable, as a string. An error is returned if the tag does not exist,
or if the variable cannot be read from the I/O device.
Related Functions
TagWrite, IODeviceControl, IODeviceInfo
Example
sValueVar1 = TagRead("PLC_VAR1");
sValueVarStr = TagRead("PLC_VAR_STR"); ! Read string data
/* Read the 15 element in array variable "PLC_Array" */
PLC_Array_15 = TagRead("PLC_Array[14]");
696
See Also
Tag Functions
TagScaleStr
Gets the value of a tag at a specified scale. The value is returned as a formatted string using
the tags format specification and (optionally) the engineering units. Use this function to
write generic Cicode that will work with any type of tag.
Note: This function is being deprecated and is replaced by the TagGetScale function. If the
Tag properties are updated TagScaleStr does not get the updated values whereas Tag-
GetScale does.
Syntax
TagScaleStr(sTag, Percent [, EngUnits] )
sTag:
The name of the tag.
Percent:
EngUnits:
Optional flag to determine if the value is returned with engineering units:
Return Value
The scale of the tag (as a string).
Related Functions
fo
Example
// Display the zero, 50% and full scale of the tag CV_123_PV
DspText(31,0,TagScaleStr("CV_123_PV", 0, 1));
See Also
Tag Functions
TagSubscribe
Subscribes a tag so that Cicode functions can be called when a tag’s value changes. The sub-
scription checks each poll period whether the tag has changed value and if it has, the spec-
ified callback function is called. This avoids continuously polling a tag value to monitor
changes. To add a function callback to the subscription, use the optional parameter in this
command or the SubscriptionAddCallback function.
697
Multiple subscriptions are possible to the same tag. Each new subscription returns a new
subscription handle. Multiple callbacks are possible to the same subscription.
To unsubscribe a tag use the TagUnsubscribe function.
Syntax
TagSubscribe(sTagName [, iPollTime] [, sScaleMode] [, dDeadband] [, sCallback] )
sTagName
String representing the tag to subscribe to in the form of
"<cluster_name>.<tag_name>".
iPollTime
Optional integer representing the Datasource Poll time in milliseconds (default
250).
sScaleMode
Optional string stating the mode to subscribe. Supported modes are: Raw, Eng,
Percent. Default is "Eng".
dDeadband
Optional real value specifying the percentage of the variable tag’s engineering
range that a tag must change by for an update to be sent through the system. De-
fault value is -1.0, indicating the deadband specified by the tag definition is to be
used.
sCallback
Optional string stating the name of a function to call when the value is updated.
If an empty string is specified, no handler is registered. Default value is "" (empty
string).
The function should have the structure:
FUNCTION evtHandler(INT subsHandle)
...
END
Where subsHandle is the subscription that raised the event.
Return Value
Integer representing the subscription handle that can be used to read values, hook to events
or unsubscribe. If unsuccessful, -1 is returned and an error is set.
Related Functions
TagUnsubscribe, SubscriptionAddCallback, SubscriptionGetAttribute, SubscriptionRe-
moveCallback
Example
The following example subscribes the tag "Conveyor1" in order to manually poll for at-
tributes of the tag:
...
INT subsHandle = TagSubscribe("Conveyor1");
...
// Get the last changed value, quality and timestamp for the tag
convValue = SubscriptionGetAttribute(subsHandle, "Value");
convQual = SubscriptionGetAttribute(subsHandle, "ValueQuality");
698
convTime = SubscriptionGetAttribute(subsHandle, "ValueTimestamp");

...
// Unsubscribe the tag
TagUnsubscribe(subsHandle);
The following example subscribes the "conveyor1" tag as a percentage and polls it every
100ms to check for changes. When the value changes the functions OnValueChanged and
ValChanged2 are called.
...
INT subsHandle = TagSubscribe("Conveyor1", 100, "Percent",
"OnValueChanged");
...
SubscriptionAddCallBack(subsHandle, "ValChanged2");
...
Function OnValueChanged(INT handle)
subsVal = SubscriptionGetAttribute(handle, "Value");
subsQual = SubscriptionGetAttribute(handle, "ValueQuality");
...
END
...
Function ValChanged2(INT handle)
subsVal = SubscriptionGetAttribute(handle, "Value");
subsTime = SubscriptionGetAttribute(handle, "ValueTimestamp");
...
END
...
// Remove all callbacks and unsubscribe
TagUnsubscribe(subsHandle);
See Also
Tag Functions
TagUnsubscribe
Unsubscribes the tag subscription specified by the integer subscription handle that was re-
turned from the TagSubscribe function. This function also removes any callbacks that are
associated with the subscription.
Syntax
TagUnsubscribe(iHandle)
iHandle
Integer handle of the subscription to unsubscribe.
Return Value
Related Functions
TagSubscribe, SubscriptionAddCallback, SubscriptionGetAttribute, SubscriptionRemove-
Callback
699
See Also
Tag Functions
TagWrite
Writes to an I/O device variable by specifying the variable tag. The variable tag must be de-
fined in the Variable Tags database.
This function completes asynchronously to the caller. An error occurs if the tag does not
exist or if a write request could not be sent. This function does not test whether the write
succeeded. In cases where the write does not succeed, TagWrite does not return a driver
error code. For important write operations, perform a TagRead to confirm that the write
took place.
TagWrite should only be used when the variable tag name is a calculation such as sAlarm-
Ext+".Paging". For assignment of variables use the assignment operator. For example, My-
Cluster.MyAlarm.MyProperty = MyString.
Note: When using this function, you cannot use the ClusterGetName function or
[Code]ScaleCheck parameter to write an out-of-range value to a device. This function
checks a value before writing it to a PLC. If the value is out of range, the attempted write
operation will not occur, but no hardware alarm will be generated.
Syntax
TagWrite(sTag, sValue [, nOffset] [, bSynch] [, ClusterName] )
sTag:
"PLC_Array[9] "
sValue:
The value to be written to the I/O device variable. The value is specified as a
string. The function converts the string into the correct format, and then writes it
to the variable.
To write to a particular element in an array, you can enter the array name here,
followed by an index to the element as follows:
"PLC_Array[9] "
The above example tells the function to write to the 10th element in the array vari-
able PLC_Array (remember, the address of the first element in an array is 0 (ze-
ro)).
dex value specified here. For example, TagWrite("PLC_Array[9]", 24, 4) will set
the 14th element in PLC_Array to 24 (because [9] means the 10th element, and an
offset of 4 means 4 elements after the 10th = element 14).
700
nOffset:
Optional offset for an array variable. Default is 0.
Note: If you enter an array index as part of the sValue argument, it will be added
to this offset value. For example, TagWrite("PLC_Array[9]", 24, 4) will set
the 14th element in PLC_Array to 24 (because [9] means the 10th element,
and an offset of 4 means 4 elements after the 10th = element 14).
bSynch:
An optional boolean argument that specifies whether the command is synchro-
nous (blocking) or asynchronous (non- blocking). This parameter is "False", or
asynchronous, by default. To use this parameter and an offset is not relevant, you
must specify 0 for the offset.
ClusterName:
Return Value
0 (zero) if successful.
Related Functions
TagRead, IODeviceControl, IODeviceInfo
Example
TagWrite("PLC_VAR1", 123);
TagWrite("PLC_VAR1", 123, 0, TRUE); ! Write to PLC variable
! and block until write is successful.
TagWrite("PLC_VAR_STR", "string data to write");
TagWrite("PLC_ARRAY", 42, 3); ! Write to element 4 in array
TagWrite("PLC_Array[9]", 2); ! Write to element 12 in array
See Also
Tag Functions
TagWriteEventQue
Opens the tag write event queue. The TagWriteEventQue is a queue of data containing de-
tails of tag value changes initiated by the process. To read events from the queue, use the
QueRead() or QuePeek() functions. The queue contains timestamp, tagname and value
data for each change event.
This queue is enabled by the corresponding INI parameter [General]TagWriteEventQue.
Writes are logged to the queue for all tags whose IODevices have their Log Write parameter
enabled.
Syntax
TagWriteEventQue()
Return Value
The handle of the tag write event queue, or -1 if the queue cannot be opened.
701
Related Functions
AlarmEventQue, QueRead, QuePeek
Example
To enable tag logging:
 On the client, set the INI param [General]TagWriteEventQue = 1.
 Enable the IODevices that you want to be logged by setting their
Log Write parameters to TRUE. See I/O Devices Properties.
To read the queue you need to create a Cicode function. For example:
FUNCTION
checkWrite()
STRING sTagAndValue = "";
INT nDateTime = 0;
INT hQue = TagWriteEventQue();
IF hQue = -1 THEN
RETURN;
END
WHILE 1 DO
QueRead(hQue, nDateTime, sTagAndValue, 1);
Message("Value written", sTagAndValue, 64);
END
END
Where:
 nDateTime is the timestamp of the tag write.
 sTagAndValue is the tagname and value written to the queue.
When the function is run, all successful writes to tags on the IODevice will show as a mes-
sage "Value written <tagname> <value>".
Note: The TagWriteEventQue is enabled on each process and will only log the data changes
initiated by this process. By combining this data with the current user and machine name
CitectSCADA can generate a user activity log with respect to setting data within the control
system. This functionality can also be combined with CitectSCADA Reports to augment the
detail of the historian data.
See Also
Tag Functions
702
Chapter: 50 Task Functions
Task functions support advanced multi-tasking operations in Cicode, handling queues,
semaphores, messages, and other process functions. The task functions control the transfer
of data between different Cicode tasks and across the network to different computers (by
remote procedure calls).
Task Functions
Following are functions relating to Tasks:
ClusterGetName Sets the execution mode of a Cicode task.
EnterCriticalSection Requests permission for the current thread to have access to a
critical shared resource (critical section). If the critical section
is already being accessed, the thread will be granted access
when it is free.
Halt Halts the current Cicode task.
LeaveCriticalSection Relinquishes the current thread’s ownership of a critical shared
resource (critical section).
MsgBrdcst Broadcasts a message.
MsgClose Closes a message.
MsgGetCurr Gets the handle of the message that called the current report
or remote procedure.
MsgOpen Opens a message session with a CitectSCADA server or client.
MsgRead Reads a message from a session.
MsgRPC Calls a remote procedure on another CitectSCADA computer.
MsgState Verifies the status of a message session.
MsgWrite Writes a message to a session.
QueClose Closes a queue.
QueLength Gets the current length of a queue.
QueOpen Creates or opens a queue.
QuePeek Searches a queue for a queue element.
QueRead Reads elements from a queue.
QueWrite Writes elements to a queue.
ReRead ReRead is deprecated in this version.
SemClose Closes a semaphore.
SemOpen Creates or opens a semaphore.
SemSignal Signals a semaphore.
SemWait Waits on a semaphore.
Sleep Suspends the current Cicode task for a specified time.
SleepMS Suspends the current Cicode task for a specified time (in milli-
seconds).
TaskCluster Gets the name of the cluster context in which the current task
is executing.
TaskGetSignal Retrieves a value that indicates the stop signal for a specific
task.
703
TaskHnd Gets the handle of a particular task.

TaskKill Kills a running task.
TaskNew Creates a new task.
TaskNewEx Creates a new task with a subscription rate.
TaskResume Resumes a task.
TaskSetSignal Ends a task by manually triggering its stop signal.
TaskSuspend Suspends a task.
See Also
Functions Reference
CodeSetMode
Sets various execution modes for Cicode tasks in the current thread. Using this function,
you can specify whether to:
 Write to a local image of an I/O device.
 Check if a variable is within range before writing it to the I/O device.
 Echo error messages to the operator.
 Check the case of string data in Cicode.
Syntax
CodeSetMode(Type, Value)
Type:
Type of mode:
0 - Write to a local image of an I/O device. If you set Value to 1, this mode is en-
abled, and Cicode writes its local memory image of the I/O device when-
ever you write to the I/O device. (Cicode assumes that most writes to the I/
O device will be done immediately).
This local image might produce problems, or you might want to verify that the
data was actually written to the I/O device. If you set Value to 0 (zero), this
check is disabled, and Cicode does not write to the local memory image.
1 - Check if a variable is within range before writing it to the I/O device. If you set
Value to 1, this mode is enabled. When a variable tag is modified, Cicode
checks the new value of the variable against the Scales specified in the Vari-
able Tags database. If the value of the variable is out of scale, Cicode gen-
erates a hardware error, and does not write to the I/O device.
If you set Value to 0 (zero), this check is disabled. Cicode writes the variable to
the I/O device without checking if its value is within range.
2 - Echo error messages to the operator. If you set Value to 1, this mode is enabled.
When a simple user error occurs (for example, if the PageDisplay() func-
tion is passed a bad page name), Cicode displays an error message at the
Error AN, and returns an error code from the function.
If you set Value to 0 (zero), the echo is disabled. Cicode does not display the error
message, and the output of the DspError() function is stopped.
3 - Ignore the case of string data in the current thread of Cicode. If you set Value
to 1, this mode is enabled, and CitectSCADA will ignore case in string data.
For example, CitectSCADA will equate "Hello" to "HELLO".
704
If you set Value to 0 (zero), CitectSCADA will be case sensitive to string data.
Case sensitivity is used when a string comparison operation is performed.
For example:
IF sStr1 = sStr2 THEN
(You can also make CitectSCADA case sensitive to strings in all of your Cicode,
using the [Code]IgnoreCase parameter.)
Value:
The value of the mode:
0 - Disable
1 - Enable
Return Value
-1 if there is an error, otherwise the last value of the mode.
Example
! disable local image write
CodeSetMode(0, 0);
See Also
Task Functions
EnterCriticalSection
Requests permission for the current thread to have access to a critical section (shared criti-
cal resource). If the critical section is already being accessed by another thread (using the
EnterCriticalSection() function), the current thread will be granted access when the other
thread relinquishes ownership using the LeaveCriticalSection() function.
Once a thread has ownership of a critical section, it can access the same section repeatedly
(using the EnterCriticalSection() function each time). Remember, however, that LeaveCrit-
icalSection() must be called once for each EnterCriticalSection() used.
Note: This function is process-based, not computer-based, and so is only effective for
threads within the same process. Any threads attempting to gain access to this critical sec-
tion will be blocked until the thread relinquishes ownership. This function will have no ef-
fect on threads running within other processes.
Syntax
EnterCriticalSection(sName)
sName:
The name of the critical section. The name must be entered in quotation marks.
Return Value
This function does not return a value.
Related Functions
LeaveCriticalSection
705
Example
/* Request access to critical section, execute code and relinquish
ownership of critical section. */
FUNCTION
MyCriticalFunction()
EnterCriticalSection("MyCritical");
// critical code is placed here
LeaveCriticalSection("MyCritical");
END
See Also
Task Functions
Halt
Stops the execution of the current Cicode task and returns to CitectSCADA. This function
does not affect any other Cicode tasks that are running.
Use this function to stop execution in nested function calls. When Halt() is called, Cicode
returns to CitectSCADA and does not execute any return function calls.
Syntax
Halt()
Return Value
Related Functions
Assert, TaskKill
Example
INT
FUNCTION
MyFunc(INT Arg)
IF Arg<0 THEN
Prompt("Invalid Arg");
Halt();
END
...
END
See Also
Task Functions
LeaveCriticalSection
Relinquishes the current thread’s ownership of a critical section (shared critical resource).
Once ownership is relinquished, access to the critical section is available to the next thread
706
that requests it (using the EnterCriticalSection() function). If a thread has been waiting for
access, it will be granted at this point.
LeaveCriticalSection() must be called once for each EnterCriticalSection() used.
Note: This function is process-based, not computer-based, and so will only prevent access
to a critical section within a single process. This function only works between Cicode tasks
within the same process.
Syntax
LeaveCriticalSection(sName)
sName:
The name of the critical section. The name must be entered in quotation marks.
Return Value
This function does not return a value.
Related Functions
EnterCriticalSection
Example
/* Request access to critical section, execute code and relinquish
ownership of critical section. */
FUNCTION
MyCriticalFunction()
EnterCriticalSection("MyCritical");
// critical code is placed here
LeaveCriticalSection("MyCritical");
END
See Also
Task Functions
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.
707
Return Value
Related Functions
MsgOpen, MsgClose, MsgRead, MsgWrite, MsgRPC
Example
! Send a message to all alarm clients.
MsgBrdcst("Alarm",0,"Alarm Occurred");
See Also
Task Functions
MsgClose
Closes a message. After the message is closed, the message post function (the callback func-
tion 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 han-
dle identifies the table where all data on the associated message is stored.
Return Value
Related Functions
MsgOpen, MsgRead, MsgWrite, MsgRPC
Example
MsgClose("Alarm",hMsg);
See Also
Task Functions
MsgGetCurr
Gets the handle of the client message that called the report or remote procedure that is cur-
rently running. You can call this function only in a report or a remote procedure call.
708
If the report was called by a client, this function returns that client message handle. The re-
port can then send a message back to the client. If a function was called remotely by MsgR-
PC(), this function returns the message handle for the remote client.
Syntax
MsgGetCurr()
Return Value
The handle for the client message. The message handle identifies the table where all data
on the associated message is stored. The function returns -1 if no client called the report or
function.
Related Functions
MsgOpen, MsgRPC
Example
! Send message back to the client.
hMsg=MsgGetCurr();
IF hMsg<>-1 THEN
MsgRPC(hMsg,"Prompt","^"Hello Client from Report Server^"",1);
END
See Also
Task Functions
MsgOpen
Opens a message session with a CitectSCADA server. You can specify a message post func-
tion - a callback function that is automatically called when a message arrives. In this func-
tion you can call MsgRead() to get the message, and perform other tasks common to your
message sessions. You can then call MsgWrite() to send a message back to the caller, Ms-
gRPC() to call a procedure on the caller, and so on.
Syntax
MsgOpen(Name, Mode, Fn [, ClusterName] )
You should use MsgState() to check the return value of MsgOpen(). The message post func-
tion is set effectively only if MsgState() returns 1, which means the message session is on-
line.
You can open a client-server message session or a session between redundant servers. This
function does not create extra network sessions; it uses CitectSCADA’s existing sessions, so
you create sessions to the Alarm Server, Report Server, Trend Server, or a named I/O Serv-
er.
Name:
The name of the server to open, either:
 For Mode 0, 1, or 3: "Alarm", "Report", "Trend", or the name of an I/O Server.
 For Mode 2: The default computer name, as set in the [Lan]Node parameter.
Mode:
709
The mode of the message session to open:

0 - Open the client side.
1 - Open the server side.
2 - Open a session from a server to the default computer name. Set Name to the
computer name of the computer, as defined by the [LAN]Node parameter.
3 - Open a message session between redundant servers. (Clients cannot tell which
server they are connected to or if something has changed on the server. All
changes should be performed on the redundant server as well.)
4 - Open a message session from the calling process to the client process. The
Name and Fn are ignored in this mode. The message session opened in this
mode does not need to call MsgClose.
Fn:
The message post function, that is a callback function for the message event. Set
Fn to 0 if no event callback function is required.
ClusterName:
The name of the cluster the server being communicated with belongs to, this is
used when mode is 0, 1 or 3. This is not required if the client is connected to only
one cluster containing a server of the type set in the name parameter.
Return Value
The message handle, or -1 if the session cannot be opened. The message handle identifies
the table where all data on the associated message is stored.
Related Functions
MsgClose, MsgRead, MsgWrite, MsgRPC
Example
INT hClient = -1;
// Open message session on the client, connecting using the
//existing message session to the current Alarm server
FUNCTION
MsgClientOpen()
INT nState;
hClient = MsgOpen("Alarm", 0, MsgPostClient);
IF hClient <> -1 THEN
nState = MsgState(hClient);
SELECT CASE nState
CASE 1
Prompt("Message session is online!");
//Send a message to the server
MsgWrite(hClient, 1, "MyMessage");
CASE -1
Prompt("Message session handle is invalid!");
CASE 0
Prompt("Message session is offline!");
CASE 2
Prompt("Message session is connecting!");
CASE 3
Prompt("Message session is disconnecting!");
CASE ELSE
Prompt("Message session has unknown status!");
END SELECT
710
ELSE
Prompt("Message session could not be opened!");
END
END
// This function is called when the client receives a message from
//the server
INT
FUNCTION
MsgPostClient()
INT Type;
STRING Str;
MsgRead(Type,Str);
Prompt("Client recieved message: Type = "+Type:###+" Str = "+Str);
RETURN 0;
END
See Also
Task Functions
MsgRead
Reads a message from a message session. You can call this function only in a message post
function (the callback function specified in the MsgOpen() function), to read the current
message.
The Type and Str variables of this function return the message number and the text of the
message. The return value of this function is the message handle (allowing a response to be
sent back if required).
You must open the message session using the MsgOpen() function, to enable the callback
function.
Syntax
MsgRead(Type, Str)
Type:
The message number.
Str:
The message text.
Return Value
The message handle of the message being read.
Related Functions
MsgOpen, MsgClose, MsgWrite, MsgRPC
Example
/* This function will read a message from the session and if
Type=1, will display the string as a prompt. If Type=2 then the
speaker beeps and an acknowledgment is sent back to the caller. */
INT
FUNCTION
MsgPostClient()
711
INT Type;
STRING Str;
INT hMsg;
hMsg=MsgRead(Type,Str);
IF Type=1 THEN
Prompt("Message"+Str);
ELSE
IF Type=2 THEN
Beep();
MsgWrite(hMsg,2,"DONE");
END
END
END
See Also
Task Functions
MsgRPC
Calls a remote procedure on another CitectSCADA computer. You can call any of the built-
in Cicode functions remotely, or your own functions. You pass the Name of the function as
a string, not as the function tag, and pass all the arguments for that function in Arg.
You can call the function in synchronous or asynchronous Mode. In synchronous mode,
MsgRPC() does not return until the remote function is called and the result is returned. In
asynchronous mode, MsgRPC() returns before the function is called, and the result cannot
be returned.
Syntax
MsgRPC(hMsg, Name, Arg, Mode)
hMsg:
Name:
The name of the function to call remotely, as a string.
If this function returns an error, you should confirm that the name you have used
is not a label instead of the actual function name. Some functions are aliased using
a label, for example, the function _AlarmGetFieldRec is defined in the labels da-
tabase as "AlarmGetFieldRec". In this case, only "_AlarmGetFieldRec" should be
passed to MsgRPC.
Arg:
The arguments to pass to the function, separated by commas (,). Enclose string
arguments in quotes "" and use the string escape character (^) around strings en-
closed within a string. If you do not enclose the string in quotes, then the string is
only the first tag found.
Mode:
The mode of the call:
0 - Blocking mode - synchronous.
1 - Non-blocking mode - asynchronous.
712
Return Value
The result of the remote function call (as a string). If the function is called in asynchronous
mode the result of the remote function cannot be returned, so an empty string is returned.
Related Functions
MsgOpen, MsgClose, MsgRead, MsgWrite
Example
! Call remote procedure, call MyRPC() on server. Wait for result
Str=MsgRPC(hMsg,"MyRPC","Data",0);
! Call remote procedure, pass two strings. Don’t wait for call to complete.
! be careful of your string delimiters as shown.
MsgRPC(hMsg,"MyStrFn","^"First string^",^"Second string^"",1);
! Call remote procedure, pass Cicode string. Don’t wait for call to complete.
STRING sMessage = "this is a message";
MsgRPC(hMsg,"MyStrFn","^"" + sMessage + "^"",1);
! These functions could be used to acknowledge an alarm by record
from any CitectSCADA Client on the network.
! The AlmAck() function is initialized by the Control Client
(Don’t forget that servers are also Control Clients.)
! The Alarm tag is passed into the function as a string and a
message is sent to the Alarms Server to initialize
! the AlmAckMsg() function.
FUNCTION
AlmAck(String AlmTag)
INT hAlarm1;
hAlarm1 = MsgOpen("Alarm", 0, 0);
MsgRPC(hAlarm1,"AlmAckMsg",AlmTag,1);
MsgClose("Alarm", hAlarm1);
END
! The AlmAckMsg() function is executed on the Alarms Server that
the client is connected to. This could be
! either the primary or standby Alarms Server. The function
performs the alarm acknowledge.
FUNCTION
AlmAckMsg(String AlmTag)
AlarmAckRec(AlarmFirstTagRec(AlmTag,"",""));
END
See Also
Task Functions
MsgState
Verifies the status of a message session. Use MsgState() to check the return value of Ms-
gOpen(). A message post function is set effectively only if MsgState() returns 1, which
means the message session is online.
Syntax
MsgState(hMsg)
hMsg:
713
Return Value
This function has the following possible return values:
 -1 if the message session handle is invalid
 0 if the message session is offline
 1 if the message session is online
 2 if the message session is connecting
 3 if the message session is disconnecting.
Related Functions
MsgOpen
Example
INT hClient = -1;
// Open message session on the client, connecting using the

existing
// message session to the current Alarm server
FUNCTION
MsgClientOpen()
INT nState;
hClient = MsgOpen("Alarm", 0, MsgPostClient);
IF hClient <> -1 THEN
nState = MsgState(hClient);
SELECT CASE nState
CASE 1
Prompt("Message session is online!");
//Send a message to the server
MsgWrite(hClient, 1, "MyMessage");
CASE -1
Prompt("Message session handle is invalid!");
CASE 0
Prompt("Message session is offline!");
CASE 2
Prompt("Message session is connecting!");
CASE 3
Prompt("Message session is disconnecting!");
CASE ELSE
Prompt("Message session has unknown status!");
END SELECT
ELSE
Prompt("Message session could not be opened!");
END
END
714
See Also
Task Functions
MsgWrite
Writes a message to a message session. The message is sent to the remote computer’s call-
back function and can be read by calling MsgRead(). If the remote computer has not opened
the session, this message is disregarded.
This function returns immediately after passing the message to CitectSCADA. CitectSCA-
DA sends the message over the LAN in the background.
You must first open the message session using the MsgOpen() function, to obtain the mes-
sage handle.
Syntax
MsgWrite(hMsg, Type, Str)
hMsg:
Type:
The integer message data, that is the message number.
Str:
The message text.
Return Value
Related Functions
MsgRead, MsgOpen
Example
MsgWrite(hMsg,10,"MyMsg");
See Also
Task Functions
QueClose
Closes a queue opened with the QueOpen() function. All data is flushed from the queue.
If a Cicode task is waiting on the QueRead() function, it returns with a "queue empty" sta-
tus. You should close all queues when they are no longer required, because they consume
memory. At shutdown, CitectSCADA closes all open queues.
Syntax
QueClose(hQue)
715
hQue:
The queue handle, returned from the QueOpen() function. The queue handle
identifies the table where all data on the associated queue is stored.
Return Value
Related Functions
QueLength, QueOpen, QueRead, QueWrite, QuePeek
Example
hQue=QueOpen("MyQue",1);
...
QueClose(hQue);
See Also
Task Functions
QueLength
Gets the current length of the queue.
Syntax
QueLength(hQue)
hQue:
Return Value
The current length of the queue. If the queue is closed then 0 is returned.
Related Functions
QueClose, QueOpen, QueRead, QueWrite, QuePeek
Example
Length=QueLength(hQue);
See Also
Task Functions
QueOpen
Open a queue for reading and writing data elements. Use this function to create a new
queue or open an existing queue. Use queues for sending data from one task to another or
for other buffering operations.
716
Syntax
QueOpen(Name, Mode)
Name:
The name of the queue.
Mode:
The mode of the queue open:
0 - Open existing queue.
1 - Create new queue.
2 - Attempts to open an existing queue. If the queue does not exist, it will create it.
Return Value
The queue handle, or -1 if the queue cannot be opened. The queue handle identifies the ta-
ble where all data on the associated queue is stored.
Related Functions
QueClose, QueLength, QueRead, QueWrite, QuePeek
Example
! Create a queue.
hQue=QueOpen("MyQue",1);
! Write data into the queue.
QueWrite(hQue,1,"Quetext");
QueWrite(hQue,1,"Moretext");
! Read back data from the queue.
QueRead(hQue,Type,Str,0);
See Also
Task Functions
QuePeek
Searches a queue for a queue element. You can search for the element by specifying a string,
an integer, or both. You can remove the element from the queue by adding 8 to the Mode.
Note: This function may modify the arguments Type and Str depending on the Mode.
Therefore, these arguments must be variables. You should consider that they may be im-
pacted by the setting for Mode when calling the function.
Syntax
QuePeek(hQue, Type, Str, Mode)
hQue:
Type:
The number to search for (if using the search mode for a matching number). If
you are using a matching string mode, the number found is returned in Type.
717
Str:
The string to search for (if using the search mode for a matching string). If you
are using a matching number mode, the string found is returned in Str.
Mode:
The mode of the search:
1 - Search for a matching string.
2 - Search for a matching number.
4 - Search for a matching string and use a case-sensitive search.
8 - If the element is found, remove it from the queue.
16 Search the queue, in order, for the element at the offset specified by Type.
Use mode 16 when you know the location of the element you want. For example
if you set Type = 0, QuePeek will return the first element in the queue, type = 2,
will return the 3rd element in the queue, etc. If you specify an offset which is
greater than the length of the queue, the "queue empty" error (296) is returned.
You can extend the search by adding modes. For example, set Mode to 3 to search
for a matching string and matching number, or set Mode to 11 to also remove the
string and number from the queue.
Return Value
Related Functions
QueClose, QueLength, QueOpen, QueRead, QueWrite
Example
STRING Str;
INT Type;
! search for ’mystring’ in queue, don’t remove if found
Str = "mystring";
status=QuePeek(hQue,Type,Str,1);
IF Status = 0 THEN
! Now use found Type
...
END
See Also
Task Functions
QueRead
Reads data from a queue, starting from the head of the queue. Data is returned in the same
order as it was written onto the queue and is removed from the queue when read. If the
Mode is 0 (non-blocking) and the queue is empty, the function returns with an error. If the
Mode is 1 (blocking) the function does not return until another Cicode task writes data onto
the queue.
is complete.
718
Syntax
QueRead(hQue, Type, Str, Mode)
hQue:
Type:
The integer variable to read from the queue (written to the queue as Type by the
QueWrite() function).
Str:
The string variable to read from the queue (written to the queue as Str by the
QueWrite() function).
Mode:
0 - Non-blocking.
1 - Wait for element.
Return Value
Related Functions
QueClose, QueLength, QueOpen, QueWrite, QuePeek
Example
Status=QueRead(hQue,Type,Str,0);
IF Status = 0 THEN
! Now use Type and Str.
...
END
See Also
Task Functions
QueWrite
Writes an integer and string onto the end of a queue. The integer and string have no mean-
ing to the queue system, they are just passed from QueWrite() to QueRead(). Queue data is
written to the end of the queue. When the data is later read from the queue, it is returned
on a first-in-first-out basis.
is complete.
Syntax
QueWrite(hQue, Type, Str)
hQue:
719
Type:
The integer to put into the queue.
Str:
The string to put into the queue.
Return Value
Related Functions
QueClose, QueLength, QueOpen, QueRead, QuePeek
Example
QueWrite(hQue,2,"Hello there");
QueWrite(hQue,4,"Help");
See Also
Task Functions
ReRead
ReRead is deprecated in this version of CitectSCADA.
Tags are now subscribed at the start of a function and updated tag values are sent to the
subscribing function. Tag subscriptions are made at the update rate of:
 the graphics page if called from a page
 the default subscription rate as determined by [Code]TimeData if called from Cicode
(default 250ms)
 the update rate requested of a task created using TaskNewEx
 the update rate requested of a subscription created using TagSubscribe
You will want to verify that the subscription update rate matches the requirements of your
system.
After removing ReRead from looping code you may need to extend the period of the Sleep
function. This is to replace the pause ReRead created while it read all the tag values.
Syntax
ReRead(Mode)
Mode:
0 - Read only if data is stale.
1 - Read anyway.
Return Value
No value (void).
720
See Also
Task Functions
SemClose
Closes a semaphore opened with SemOpen(). You should close all semaphores when they
are no longer required, because they consume memory. If any Cicode tasks are waiting on
this semaphore, the tasks are released with an error.
to an importantsection within a single process. This function only works between Cicode
tasks within the same process.
Syntax
SemClose(hSem)
hSem:
The semaphore handle, returned from the SemOpen() function. The semaphore
handle identifies the table where all data on the associated semaphore is stored.
Return Value
Related Functions
SemOpen, SemSignal, SemWait
Example
SemClose(hSem);
See Also
Task Functions
SemOpen
Opens a semaphore for access control. When the semaphore is opened, it is initially sig-
nalled. Use a semaphore for controlling access to a restricted device, for example, to stop
another Cicode task accessing a device while it is in use. You might require semaphores for
some Cicode operations, because they can access a device that is critical. (Cicode is a multi-
tasking system.)
Syntax
SemOpen(Name, Mode)
Name:
The name of the semaphore.
721
Mode:
0 - Open existing semaphore.
1 - Create new semaphore.
2 - Attempts to open an existing semaphore. If the semaphore does not exist, it
will create it.
Return Value
The semaphore handle, or -1 if the semaphore was not opened successfully. The semaphore
Related Functions
SemClose, SemSignal, SemWait
Example
hSem=SemOpen("MySem",1);
See Also
Task Functions
SemSignal
Signals a semaphore. If several Cicode tasks are waiting on this semaphore, the first task is
released. This function is a blocking function. It will block the calling Cicode task until the
operation is complete.
Syntax
SemSignal(hSem)
hSem:
Return Value
Related Functions
SemClose, SemOpen, SemWait
Example
SemSignal(hSem);
722
See Also
Task Functions
SemWait
Waits on a semaphore to be signalled. This function is a blocking function. It will block the
calling Cicode task until the operation is complete.
Syntax
SemWait(hSem, Timeout)
hSem:
Timeout:
Semaphore time-out time:
-1 - Wait until semaphore is clear (regardless of how long).
0 - Do not wait - return immediately. (This timeout can be used to check the state.)
> 0 - The number of seconds to wait if semaphore is not signalling, then return.
Return Value
0 (zero) if the semaphore has been gained, otherwise an error is returned.
Related Functions
SemClose, SemOpen, SemSignal
Example
Status=SemWait(hSem,10);
IF Status=0 THEN
...
ELSE
Prompt("Could not get semaphore");
END
See Also
Task Functions
Sleep
Suspends the current Cicode task for a specified number of seconds. After the time delay,
the Cicode task wakes and continues execution. If the sleep time is 0, the Cicode task is pre-
empted for 1 time slice only.
723
This function does not affect any other Cicode tasks - only the task calling Sleep() is sus-
pended. If you have Cicode that runs continuously in a loop, you should call the Sleep()
function somewhere within the loop, to pause the loop and allow other tasks to run.
is complete.
Syntax
Sleep(Seconds)
Seconds:
The number of seconds. Set to 0 to pre-empt the task for one time-slice.
Return Value
Related Functions
TaskNew, ReRead, SleepMS
Example
Buttons
Text Step
Command PLCBit=1;Sleep(2);PLCBit=0;
Comment Switch Bit ON and then OFF 2 seconds later
! Display "Hello" 10 times at 60 second intervals.

WHILE I < 10 DO
Sleep(60);
Prompt("Hello");
I = I + 1;
END
! Sleep a while in polling loops
WHILE < waiting for event or time> DO
! do what ever here
...
Sleep(10);! sleep a while to give other tasks a go.
! the longer the sleep the better for other tasks.
END
See Also
Task Functions
SleepMS
Suspends the current Cicode task for a specified number of milliseconds. After the time de-
lay, the Cicode task wakes and continues execution. This function is similar to the Sleep
function but with greater resolution.
Although a value of 0 milliseconds is accepted, it is not recommended. Try to use at least a
value of 1.
724
This function does not affect any other Cicode tasks; only the task calling SleepMS() is sus-
pended. If you have Cicode that runs continuously in a loop, you should call the SleepMS()
or Sleep() function somewhere within the loop, to pause the loop and allow other tasks to
run.
is complete.
Syntax
SleepMS(Milliseconds)
Milliseconds:
The number of milliseconds (1000 milliseconds per second). Set to 0 to pre-empt
the task for one time-slice. Be careful not to use a value that is too small. Setting
the value to 0 would generally have no desirable effect.
Return Value
Related Functions
TaskNew, ReRead, Sleep
Example
Buttons
Text Step
Command PLCBit=1;SleepMS(500);PLCBit=0;
Comment Switch Bit ON and then OFF 500 milliseconds later.
! Increment a memory variable by ten, 120 times over one minute

(twice a second).
I = 0;
WHILE I < 180 DO
SleepMS(500);
iRamp = iRamp + 10;
I = I + 1;
END
! sleep a while in polling loops
WHILE < waiting for event or time> DO
! do what ever here
...
SleepMS(200);! sleep a while to give other tasks a go.
! the longer the sleep the better for other tasks.
END
See Also
Task Functions
TaskCluster
Gets the name of the cluster context in which the current task is executing.
725
Syntax
TaskCluster()
Return Value
The cluster name of the current context or an empty string if the task is executing without
a cluster context.
Related Functions
terNext, ClusterServerTypes, ClusterSetName, ClusterStatus, ClusterSwapActive,
TaskNew, TaskNewEx
Example
! Get the cluster context of the current task
sCluster = TaskCluster();
See Also
Task Functions
Cluster Functions
About cluster context
TaskGetSignal
Retrieves a value that indicates the signal that is currently set for a specific task. This func-
tion can be used to check the value of the current signal before using TaskSetSignal to apply
a new signal.
Syntax
TaskGetSignal(Hnd)
Hnd:
The task’s handle. To retreive this use the function TaskHnd().
Return Value
The value of the current signal. (0 (zero) represents normal operation, 1 indicates the task
is stopped).
Related Functions
TaskSetSignal, TaskHnd, TaskKill, TaskNew, TaskResume
See Also
Task Functions
TaskHnd
726
Gets the task handle of a specific task. You can then use the task handle with other task
functions to control the task. If you do not specify a thread name, it will default to that of
the current task.
Syntax
TaskHnd( [sName] )
sName:
The thread name of the task. The thread name is the name of the function that was
passed to the TaskNew() function. For example, if. . .
TaskNew("MyTask","",0);
then:
hTask=TaskHnd("MyTask");
will return the handle of this task.
If you do not specify a thread name, it will default to that of the current task.
Return Value
The task handle, identifying the table where all data on the task is stored.
Related Functions
TaskKill, TaskNew, TaskResume, TaskSuspend
Example
! Get the task handle of the current task and then kill it.
hTask=TaskHnd();
TaskKill(hTask);
! Get the task handle of MyTask and then kill it.
hTask=TaskHnd("MyTask");
TaskKill(hTask);
See Also
Task Functions
TaskKill
Kills a task. The Cicode task will be stopped and will not run again.
Syntax
TaskKill(hTask)
hTask:
The task handle, returned from the TaskNew() or TaskHnd() function. The task
handle identifies the table where all data on the associated task is stored.
Return Value
Note: TaskKill is an abrupt way to stop a Cicode task. It can cause system errors and may
have unintended consequences. Whenever possible, use TaskGetSignal and TaskSetSignal
to stop Cicode tasks. Use TaskKill as a last resort and after observing the following:
727
Related Functions
TaskGetSignal, TaskSetSignal, TaskHnd, TaskNew, TaskResume, TaskSuspend
Example
! Create a task, run it for 10 seconds and then kill it.
hTask=TaskNew("MyFunc","",0);
Sleep(10);
TaskKill(hTask);
FUNCTION
MyFunc()
INT Count;
WHILE 1 DO
Prompt("Hello "+Count:###);
Count=Count+1;
END
END
See Also
Task Functions
TaskNew
Creates a new Cicode task and returns the task handle. You pass the Name of the function
(that creates the task) as a string, not as the function tag, and pass all the arguments for that
function in Arg. After the task is created, it runs in parallel to the calling task. The new task
will run forever unless it returns from the function or is killed by another task.
You can set the Mode to run the task forever or only until the current page is changed or the
current window is freed. If you do not add 4 to the Mode, CitectSCADA starts the task im-
mediately, without reading any data from the I/O devices - any I/O device variable that you
use will either contain 0 (zero) or the last value read. If you add 4 to the Mode, CitectSCA-
DA requests all I/O device data and waits for the data to be returned before starting the task
- the task is provided with the correct data, but there will be a delay in starting the task. Use
Mode 4 when the I/O device data must be read, but do not use Mode 4 when the task has
to start immediately.
You can specify that if the task is already running, the function will exit without launching
a new task and an error will display. This is useful when you want only a single instance
of the function running at any point in time.
It is also possible to run the task within the context of a particular cluster in a multi cluster
system by setting the ClusterName parameter. If a cluster is not specified, the task will use
the cluster context of the caller, be it a page or Cicode task. Please be aware that the cluster
context cannot be changed once the code is running.
Any animation output for the new task is displayed in the window where it was created. If
you want to send output to other windows, use the WinSelect() function.
Syntax
TaskNew(sName, sArg, Mode [, ClusterName] )
sName:
The name of the function to create the task, as a string.
728
sArg:
The set of arguments to be passed to the function. Individual arguments must be
separated by commas (,). Enclose string arguments in quotes "" and use the string
escape character (^) around strings enclosed within a string. If you do not enclose
the string in quotes, then the string is only the first tag found. The entire set of ar-
guments must be enclosed in quotes ("").
Mode:
The mode of the task:
0 - Task runs forever.
1 - Task runs until the current page is changed.
2 - Task runs until the current window is freed.
4 - Request all I/O device data before starting task.
8 - If the task already exists, the function will exit without launching the new task.
You can select any one of modes 0, 1 or 2 and may add mode 4 and/or mode 8.
For example, set Mode to 6 to request all I/O device data before starting the task,
and to run the task until the current window is freed.
ClusterName:
The name of the cluster context to be applied to the new Cicode task. This is op-
tional if you have one cluster or are resolving the task via the current cluster con-
text. The argument is enclosed in quotation marks "". You may pass "-" as the
ClusterName argument to run the requested Cicode task without a cluster con-
text.
Return Value
The task handle, or -1 if the task cannot be successfully created. The task handle identifies
the table where all data on the associated task is stored.
Related Functions
TaskHnd, TaskKill, TaskNewEx, TaskResume, TaskSuspend, ReRead, WinSelect
Example
! Create a task that displays a message for 10 seconds.
hTask=TaskNew("MyFunc","Data",0);
! Continue to run while task runs.
FUNCTION
MyFunc(STRING Msg)
FOR I=0 TO 10 DO
Prompt(Msg);
Sleep(1);
END
END
...
! Call a function which expects more complex argument
hTask=TaskNew("ArgFunc","^"string one^",^"string two^",1,2",0);
hTask=TaskNew("ArgFunc","^""+sOne+"^",^""+sTwo+"^","+iOne:##+","+
iTwo:##,0);
FUNCTION
ArgFunc(STRING sOne, STRING sTwo, INT iOne, INT iTwo)
...
END
729
See Also
Task Functions
TaskNewEx
Creates a new Cicode task with an individual subscription rate and returns the task handle.
You pass the Name of the function (that creates the task) as a string, not as the function tag,
and pass all the arguments for that function in Arg. After the task is created, it runs in par-
allel to the calling task. The new task will run forever with tags updated at the specified
time interval unless it returns from the function or is killed by another task.
You can set the Mode to run the task forever or only until the current page is changed or the
current window is freed. If you do not add 4 to the Mode, CitectSCADA starts the task im-
mediately, without reading any data from the I/O devices - any I/O device variable that you
use will either contain 0 (zero) or the last value read. If you add 4 to the Mode, CitectSCA-
DA requests all I/O device data and waits for the data to be returned before starting the task
- the task is provided with the correct data, but there will be a delay in starting the task. Use
Mode 4 when the I/O device data must be read, but do not use Mode 4 when the task has
to start immediately.
You can specify that if the task is already running, the function will exit without launching
the new task and an error will display. This is useful when you want only a single instance
of the function running at any point in time.
It is also possible to run the task within the context of a particular cluster in a multi cluster
system by setting the ClusterName parameter. If a cluster is not specified, the task will use
the cluster context of the caller, be it a page or Cicode task. Please be aware that the cluster
context cannot be changed once the code is running.
Any animation output for the new task is displayed in the window where it was created. If
you want to send output to other windows, use the WinSelect() function.
Syntax
TaskNewEx(sName, sArg, Mode, SubscriptionRate [, ClusterName] )
sName:
The name of the function to create the task, as a string.
sArg:
The set of arguments to be passed to the function. Individual arguments must be
separated by commas (,). Enclose string arguments in quotes "" and use the string
escape character (^) around strings enclosed within a string. If you do not enclose
the string in quotes, then the string is only the first tag found. The entire set of ar-
guments must be enclosed in quotes ("").
Mode:
The mode of the task:
0 - Task runs forever.
1 - Task runs until the current page is changed.
2 - Task runs until the current window is freed.
4 - Request all I/O device data before starting task.
730
8 - If the task already exists, the function will exit without launching the new task.
You can select any one of modes 0, 1 or 2 and may add mode 4 and/or mode 8.
For example, set Mode to 6 to request all I/O device data before starting the task,
and to run the task until the current window is freed.
SubscriptionRate
The subscription rate for the task, between 0 and 60000 milliseconds, which de-
termines the frequency at which the I/ O Server reads I/O device data in order to
provide tags with up-to-date Cicode variables. A value of -1 may be passed which
will use the current task’s subscription rate or the default value as set by the ex-
isting parameter [CODE]TimeData which defaults to 250.
ClusterName:
The name of the cluster context to be applied to the new Cicode task. This is op-
tional if you have one cluster or are resolving the task via the current cluster con-
text. The argument is enclosed in quotation marks "". You may pass "-" as the
ClusterName argument to run the requested Cicode task without a cluster con-
text.
Return Value
The task handle, or -1 if the task cannot be successfully created. The task handle identifies
the table where all data on the associated task is stored.
Related Functions
TaskHnd, TaskKill, TaskNew, TaskResume, TaskSuspend, ReRead, WinSelect
Example
! Create a task that calls a function every half second.
hTask=TaskNewEx("MyFunc","Data",0,500);
See Also
Task Functions
TaskResume
Resumes a task that was suspended by the TaskSuspend() function. After a task is resumed,
it runs on the next time-slice.
Syntax
TaskResume(hTask)
hTask:
Return Value
731
Related Functions
TaskHnd, TaskKill, TaskSuspend, TaskNew
Example
TaskResume(hTask);
See Also
Task Functions
TaskSetSignal
Manually applies a signal to a specified task.
Syntax
TaskSetSignal(Hnd, nSignal)
Hnd:
The task’s handle. To retrieve this use the function TaskHnd().
nSignal:
Allows you to signal a specified task. Set to 0 (zero) for normal operation, 1 to stop
the task or any other number that represents a defined signal.
Return Value
Related Functions
TaskGetSignal, TaskHnd, TaskKill, TaskSuspend, TaskNew, TaskResume
See Also
Task Functions
TaskSuspend
Suspends a task. The task will stop running and will start again only when TaskResume()
is called.
Syntax
TaskSuspend(hTask)
hTask:
Return Value
Related Functions
TaskHnd, TaskKill, TaskNew, TaskResume
732
Example
TaskSuspend(hTask);
...
TaskResume(hTask);
See Also
Task Functions
733
734
Chapter: 51 Time and Date Functions
Time/date functions manipulate time and date variables. CitectSCADA stores time/date-re-
lated variables as a single integer. This integer represents the number of seconds since 01/
01/1970. It is in GMT, but it has an offset that updates it to local time (determined by the
timezone the application is in). The Time/date functions convert this integer into time and
date variables.
Note: The Time/date functions can only be used with dates between 1980 and 2035.
Time/Date Functions
Following are functions relating to Time and Date:
Date Gets the current system date in string format.
DateAdd Adds time to a date.
DateDay Gets the day from a date.
DateInfo Returns the date format currently in effect on the CitectSCADA Serv-
er.
DateMonth Gets the month from a date.
DateSub Subtracts two dates.
DateWeekDay Gets the day of week from a date.
DateYear Gets the year from a date.
OLEDateToTime Converts an OLE DATE value to a CitectSCADA time/date value.
SysTime Marks the start of an event.
SysTimeDelta Calculates the time-span of an event.
Time Gets the current system time in string format.
TimeCurrent Gets the current time/date value.
TimeHour Gets hours from a time.
TimeInfo Returns the time format currently in effect on the CitectSCADA Serv-
er.
TimeMidNight Converts a time variable into the time at midnight.
TimeMin Gets minutes from a time.
TimeSec Gets seconds from a time.
TimeSet This function is now obsolete.
TimeToStr Converts a time/date variable into a string.
TimeUTCOffset Determines the local time bias from UTC at a specified time.
See Also
Functions Reference
Date
Gets the current date in string format.
Note: Time/Date functions can only be used with dates between 1980 and 2035. You should
check that the date you are using is valid with Cicode similar to the following:
735
IF StrToDate(Arg1)>0 THEN
...
ELSE
...
END
Syntax
Date( [Format] )
Format:
The format required:
2 - Short date format, dd/mm/yy
3 - Long date format, day month year
9 - Extended date format, dd/mm/yyyy
If omitted, the default Format is 2. All of these formats follow the Regional Set-
tings found in the Windows Control Panel.
Return Value
The current date (in string format).
Related Functions
Time, TimeToStr, TimeCurrent
Example
/* If the current system date is 3rd November 1991 and the Windows
date format is dd/mm/yy; */
str = Date();
! Sets str to "3/11/91".
str = Date(2);
! Sets str to "3/11/91".
str = Date(3);
! Sets str to "3rd November 1991".
See Also
Time/Date Functions
DateAdd
Adds time (in seconds) to a time/date value. The return value is in time/date variable for-
mat. Use this function for time and date calculations.
Syntax
DateAdd(Time, AddTime)
Time:
The time/date to which the AddTime will be added.
AddTime:
The time to add, in seconds.
736
Return Value
The date as a time/date variable.
Related Functions
TimeToStr, DateSub
Example
DateVariable=DateAdd(StrToDate("3/11/91"),86400);
! Adds 24 hours to 3/11/91.
NewDate=TimeToStr(DateVariable);
! Sets NewDate to 4/11/91.
See Also
Time/Date Functions
DateDay
Gets the day of the month from a time/date variable.
Time/date functions can only be used with dates between 1980 and 2035. You should check
that the date you are using is valid with Cicode similar to the following:
...
ELSE
...
END
Syntax
DateDay(Time)
Time:
The time/date variable.
Return Value
The day of the month as an integer.
Related Functions
Date
Example
! If the current system date is 3rd November 1991;
Variable=DateDay(TimeCurrent());
See Also
Time/Date Functions
737
DateInfo
Returns the date format currently used on the CitectSCADA Server.
Syntax
DateInfo(nInfo, nExtra)
nInfo:
Determines the contents of the string returned by the DateInfo() function. Valid
values and resulting strings are:
1 - The current date order:
 "0" - MMDDYY
 "1" - DDMMYY
 "2" - YYMMDD.
2 - The current date delimiter.
3 - The current short date format.
4 - The current long date format.
5 - The current extended date format.
6 - The short weekday string. The particular weekday returned is determined by
the nExtra argument.
7 - The long weekday string. The particular weekday returned is determined by
the nExtra argument.
8 - The short month string. The particular month returned is determined by the
nExtra argument.
9 - The long month string. The particular month returned is determined by the
nExtra argument.
nExtra:
When an nInfo argument of 6 or 7 is specified, the nExtra argument determines
which weekday (1-7) is returned by the DateInfo() function.
When an nInfo argument of 8 or 9 is specified, the nExtra argument determines
which month (1-12) is returned by the DateInfo() function.
The nExtra argument is ignored if any other nInfo value is passed to the function.
Return Value
A string containing one of the following:
 Current date order ("0" for MMDDYY, "1" for DDMMYY, "2" for YYMMDD;
 Current date delimiter;
 Current short date format;
 Current long date format;
 Current extended date format;
 Short weekday string;
 Long weekday string;
 Short month string;
 Long month string;
depending on the nInfo and nExtra arguments passed to the function.
Related Functions
TimeInfo
738
Example
! If the current system date is the fourth of December 2002;
TwelfthMonth=DateInfo(9,12);
! Sets TwelfthMonth to "December".
See Also
Time/Date Functions
DateMonth
Gets the month from a time/date variable.
Note: Time/date functions can only be used with dates from 1980 to 2035. You should check
...
ELSE
...
END
Syntax
DateMonth(Time)
Time:
Return Value
The month of the year as an integer.
Related Functions
Date
Example
Variable=DateMonth(TimeCurrent());
See Also
Time/Date Functions
DateSub
Subtracts time (in seconds) from a time/date value. The return value is in time/date variable
format. Use this function for time and date calculations.
Syntax
DateSub(Time, SubTime)
739
Time:
The time/date from which the SubTime will be subtracted.
SubTime:
The time to subtract, in seconds.
Return Value
The time difference (in seconds) as an integer.
Related Functions
Date, DateAdd
Example
Variable=DateSub(StrToDate("05/11/91"),StrToDate("03/11/91"));
! Sets Variable to number of seconds between 2 date/times.
Str=TimeToStr(Variable,5);
! Sets Str to "48:00:00".
See Also
Time/Date Functions
DateWeekDay
Gets the day of the week from a time/date variable.
the date you are using is valid with Cicode similar to the following:
...
ELSE
...
END
Syntax
DateWeekDay(Time)
Time:
Return Value
An integer representing the day of the week as follows:
1 - Sunday
2 - Monday
3 - Tuesday
4 - Wednesday
5 - Thursday
6 - Friday
740
7 - Saturday
Related Functions
Date, TimeCurrent
Example
! If the current system date is Sunday, 3rd November 1991;
Variable=DateWeekDay(TimeCurrent());
See Also
Time/Date Functions
DateYear
Gets the year from a time/date variable.
...
ELSE
...
END
Syntax
DateYear(Time [, Mode] )
Time:
Mode:
The format required:
0 - Short year, yy. If you use this mode during the year 2000, 0 (zero) will be re-
turned.
1 - Long year, yyyy
If omitted, the default Mode is 0.
Return Value
The year as an integer.
Note: In the year 2000, this function will return 0 (zero) if mode 0 (zero) is used.
Related Functions
Date
741
Example
Variable=DateYear(TimeCurrent(),0);
! If the current system date is 18th October 2000;
See Also
Time/Date Functions
OLEDateToTime
Converts an OLE DATE value (stored in a REAL) to a CitectSCADA time/date value.
Note: An OLE DATE representing a local time in the daylight savings(DST) to standard
time(Std) transition period will be converted to the DST value internally. For example, if
the DST transition is 30/3/2003 2:00:00 Std, the local time will behave in the following man-
ner: 2:00:00 DST -> 2:59:59 DST -> 2:00:00 Std. Because of this, a value representing the pe-
riod between 2:00:00 and 2:59:59 on that date will be interpreted as 2:00:00 DST, not Std.
Syntax
OLEDateToTime(OLEDate, Local)
OLEDate:
The OLE DATE value to convert (stored as a REAL).
Local:
0 - OleDate represents a UTC time.
1 - OleDate represents a Local time.
Return Value
Returns a CitectSCADA time/date value.
Related Functions
TimeCurrent, TimeToOLEDate
Example
Real = TimeToOLEDate(TimeCurrent(), 1);
! Sets Real to the local date/time value
TimeVariable = OLEDateToTime(Real, 1);
! Sets TimeVariable to the value of Real when interpreted as Local
time.
See Also
Time/Date Functions
742
SysTime
Gets the CitectSCADA internal system millisecond counter. The counter is not based on
time, but counts from 0 up to the maximum integer value and then back to 0.
You can use this function to time events down to the millisecond level, either by subtracting
the current SysTime from the SysTime at the start of the event, or by using the SysTimeDel-
ta() function (which will give the same result).
The SysTime() function does not return the time of day. Use the Time() or TimeCurrent()
function to obtain the time of day.
...
ELSE
...
END
Syntax
SysTime()
Return Value
The CitectSCADA internal system millisecond counter (as an integer).
Related Functions
SysTimeDelta, Time, TimeCurrent
Example
Start=SysTime();
! Gets the current time.
...
Delay=SysTime()-Start;
! Sets Delay to the time difference, in milliseconds.
See Also
Time/Date Functions
SysTimeDelta
Calculates the time difference between a start time and the current time, and updates the
start time to the current time. You can time continuous events in a single operation. See the
SysTime() function for information on its use.
...
ELSE
743
...
END
Syntax
SysTimeDelta(Start)
Start:
The start time returned from the SysTime() function.
Return Value
The time difference from a start time and the current time.
Related Functions
SysTime
Example
Start=SysTime();
! Gets the current time.
...
Delay1=SysTimeDelta(Start);
! Sets Delay1 to the time difference from Start.
...
Delay2=SysTimeDelta(Start);
! Sets Delay2 to the time difference from the last SysTimeDelta()
call.
See Also
Time/Date Functions
Time
Gets the current time in string format.
...
ELSE
...
END
Syntax
Time( [Format] )
Format:
The format of the time:
0 - Short time format, hh:mm
744
1 - Long time format., hh:mm:ss

If omitted, the default Format is 0.
Return Value
The current time (as a string).
Related Functions
Date, TimeToStr
Example
! If the current time is 10:45:30;
Variable=Time();
! Sets Variable to "10:45".
Variable=Time(0);
! Sets Variable to "10:45".
Variable=Time(1);
! Sets Variable to "10:45:30".
See Also
Time/Date Functions
TimeCurrent
Gets the current system time/date in time/date variable format. Please be aware that Cit-
ectSCADA stores time as the number of seconds since 01/01/1970. You can convert this val-
ue into usable date and time variables by using the various Date and Time functions.
...
ELSE
...
END
Syntax
TimeCurrent()
Return Value
A time/date variable.
Related Functions
StrToDate, StrToTime
Example
! If the current system time is 11:43:10 a.m.;
TimeVariable=TimeToStr(TimeCurrent(),0);
! Sets TimeVariable to "11:43".
745
See Also
Time/Date Functions
TimeHour
Gets the hour value from a time/date variable.
...
ELSE
...
END
Syntax
TimeHour(Time)
Time:
Return Value
The hour (as an integer).
Related Functions
TimeCurrent
Example
HoursVariable=TimeHour(TimeCurrent());
! Sets HoursVariable to 11.
See Also
Time/Date Functions
TimeInfo
Returns the time format currently used on the CitectSCADA Server.
Syntax
TimeInfo(nInfo)
nInfo:
Determines the contents of the string returned by the TimeInfo() function. Valid
values and resulting strings are:
1- The current time hour format:
746
 "0" - 12 hour
 "1" - 24 hour
2- The current time delimiter.
3- The current morning time extension.
4- The current evening time extension.
Return Value
Depending on the nInfo argument passed to the function, a string containing:
 Current time hour format ("0" for 12 hour, "1" for 24 hour)
 Current time delimiter
 Current morning time extension
 Current evening time extension
Related Functions
DateInfo
Example
! If the current system time is 15:43:10.;
ClockType=TimeInfo(1);
! Sets ClockType to "1".
See Also
Time/Date Functions
TimeMidNight
Returns the number of seconds between midnight on January 1, 1970, and the midnight im-
mediately prior to the specified time/date. This function is useful for performing calcula-
tions with the time and date.
...
ELSE
...
END
Syntax
TimeMidNight(Time)
Time:
Return Value
A time/date variable.
747
Related Functions
TimeCurrent
Example
timeNow = TimeCurrent();
! get the time variable at 7am today
time7am = TimeMidNight(timeNow) + 7*60*60;
IF timeNow > time7am AND timeNow < time7am + 10 THEN
Beep();
Prompt("Wake Up!");
END
See Also
Time/Date Functions
TimeMin
Gets the minutes value from a time/date variable.
...
ELSE
...
END
Syntax
TimeMin(Time)
Time:
Return Value
The minute (as an integer).
Related Functions
TimeCurrent
Example
! If the current system time is 11:43:10 a.m.
MinutesVariable=TimeMin(TimeCurrent());
! Sets MinutesVariable to 43.
See Also
Time/Date Functions
748
TimeSec
Gets the seconds value from a time/date variable.
...
ELSE
...
END
Syntax
TimeSec(Time)
Time:
Return Value
The second (as an integer).
Example
SecondsVariable=TimeSec(TimeCurrent());
! Sets SecondsVariable to 10.
See Also
Time/Date Functions
TimeToOLEDate
Converts a CitectSCADA time/date value to an OLE DATE value (this should be stored in
a REAL).
Syntax
TimeToOLEDate(Time, Local)
Time:
Time/date variable.
Local:
0 - The return value is output as UTC time.
1 - The return value is output as Local time.
Return Value
Returns an OLE date value.
749
Related Functions
TimeCurrent, OLEDateToTime
Example
Real = TimeToOLEDate(TimeCurrent(), 1);
! Sets Real to the local date/time value
See Also
Time/Date Functions
TimeToStr
Converts a time/date variable into a string. Use this function for calculating time differenc-
es or run times, and so on. Set Format to 6 to convert time periods that are in milliseconds,
such as the times that are returned from the SysTime() and SysTimeDelta() functions.
Note: Once a date/time is retrieved as UTC, the string cannot be used by the Cicode func-
tions StrToDate and StrToTime to synthesize a date/time value as these functions support
local time only.
...
ELSE
...
END
Syntax
TimeToStr(Time, Format [, UTC] )
Time:
Format:
Format of the string:
0 - Short time format, hh:mm.
1 - Long time format, hh:mm:ss.
2 - Short date format, dd/mm/yy.
3 - Long date format, day month year.
4 - Time and date, weekday month day year hh:mm:ss.
5 - Long time period, hh:mm:ss. Time must be in seconds.
6 - Millisecond time period, hh:mm:ss:xxx ("xxx" represents milliseconds). Time
must be in milliseconds.
7 - Short time period, hh:mm. Time must be in seconds.
8 - Long time period, days:hh:mm:sec. Time must be in seconds.
750
9 - Extended date format, dd/mm/yyyy.

UTC:
Universal Time Co-ordinate (optional)
0 - Display the string as a local date/time (default).
1 - Display the string as a UTC date/time (valid for formats 0-4 and 9).
Return Value
A string containing the converted time/date or period variable, or an empty string if in-
valid.
Related Functions
Time, TimeCurrent, Date
Example
! If the current system time is 11:50:00 a.m.
String=TimeToStr(TimeCurrent(),0);
! Sets String to "11:50".
String=TimeToStr(125 + TimeCurrent(),5);
! Sets String to "11:52:05" (the current time + 2 minutes and 5
seconds).
See Also
Time/Date Functions
TimeUTCOffset
Determines the local time bias from UTC that was in force at a specified time. For example,
US Pacific Standard Time is -8 hrs from UTC, so -28800 would be returned (-8 hours x 60
minutes x 60 seconds). However, if the specified time occurred during daylight saving, the
returned value would be -7 hours (or -25200 seconds).
Syntax
TimeUTCOffset(Time)
Time:
Return Value
The local time bias in seconds.
Related Functions
TimeCurrent
See Also
Time/Date Functions
751
752
Chapter: 52 Trend Functions
You can control a trend’s operation by using the trend functions. CitectSCADA has stan-
dard trend pages, so you would not normally use these low-level functions unless you
want to define your own trend displays. You can control the movement of the trend cursor,
trend scaling, and the definition of trend attributes (such as the trend starting time and
sampling period). You can also create, and subsequently delete trends.
Trend Functions
Following are functions relating to Trends:
TrnAddHistory Restores an old history file to the trend system.
TrnBrowseClose Closes a trend browse session.
TrnBrowseFirst Gets the oldest trend entry.
TrnBrowseGetField Gets the field indicated by the cursor position in the
browse session.
TrnBrowseNext Gets the next trend entry in the browse session.
TrnBrowseNumRecords Returns the number of records in the current browse
session.
TrnBrowseOpen Opens a trend browse session.
TrnBrowsePrev Gets the previous trend entry in the browse session.
TrnClientInfo Gets information about the trend that is being dis-
played at the AN point.
TrnComparePlot Prints two trends (one overlaid on the other), each
with up to four trend tags.
TrnDelete Deletes a trend created by the TrnNew() function.
TrnDelHistory Deletes an old history file from the trend system.
TrnEcho Enables and disables the echo on the trend display.
TrnEventGetTable Stores event trend data and the associated time
stamp in an event table and time table, for a specified
trend tag.
TrnEventGetTableMS Stores event trend data and time data (including mil-
liseconds) for a specified trend tag.
TrnEventSetTable Sets trend data from a table, for a specified trend
tag.
TrnEventSetTableMS Sets event trend data and time data (including milli-
seconds) for a specified trend tag.
TrnExportClip Exports trend data to the clipboard.
TrnExportCSV Exports trend data to a file in CSV (comma separated
values) format.
TrnExportDBF Exports trend data to a file in dBASE III format.
TrnExportDDE Exports trend data to applications via DDE.
TrnFlush Flushes the trend to disk.
TrnGetBufEvent Gets the event number of a trend at an offset for a
pen.
TrnGetBufTime Gets the trend time at an offset for a pen.
753
TrnGetBufValue Gets the trend value at an offset for a pen.

TrnGetCluster Gets the name of the cluster the trend graph is asso-
ciated with.
TrnGetCursorEvent Gets the event number of a trend at the trend cursor.
TrnGetCursorMSTime Gets the time (in milliseconds from the previous mid-
night) at a trend cursor for a specified pen.
TrnGetCursorPos Gets the position of the trend cursor.
TrnGetCursorTime Gets the time/date at the trend cursor.
TrnGetCursorValue Gets the current trend cursor value of a pen.
TrnGetCursorValueStr Gets the current trend cursor value of a pen as a for-
matted string.
TrnGetDefScale Gets the default engineering zero and full scales of a
trend tag.
TrnGetDisplayMode Gets the display mode of a trend.
TrnGetEvent Gets the event number of a trend at a percentage
along the trend.
TrnGetFormat Gets the format of a pen.
TrnGetGatedValue Returns the internally stored value for <GATED>.
TrnGetInvalidValue Returns the internally stored value for
<TRN_NO_VALUES>.
TrnGetMode Gets the display mode of trends (historical or real-
time).
TrnGetMSTime Gets the time (in milliseconds from the previous mid-
night) of the trend (plotted by a specified pen)
at a percentage along the trend,using the time and
date of the right-most sample displayed.
TrnGetPen Gets the trend tag of a pen.
TrnGetPenComment Gets the comment of a trend pen.
TrnGetPenFocus Gets the number of the pen currently in focus.
TrnGetPenNo Gets the pen number of a pen name.
TrnGetPeriod Gets the display period of a trend.
TrnGetScale Gets the scale of a pen.
TrnGetScaleStr Gets the scale of a pen as a formatted string.
TrnGetSpan Gets the span time of a trend.
TrnGetTable Stores trend data in an array.
TrnGetTime Gets the time/date of a pen.
TrnGetUnits Gets the data units of a trend pen.
TrnInfo Gets the configured values of a trend tag.
TrnIsValidValue Determines whether a logged trend value is <VAL-
ID>, <GATED>, or invalid <TRN_NO_VALUES>.
TrnNew Creates a new trend at run time.
TrnPlot Prints a plot of one or more trend tags.
TrnPrint Prints a trend that is displayed on the screen.
TrnSamplesConfigured Gets the number of samples configured for the cur-
rently displayed trend.
TrnScroll Scrolls a trend pen.
TrnSelect Sets up a page for a trend.
754
TrnSetCursor Moves the trend cursor a specified number of sam-

ples.
TrnSetCursorPos Moves the trend cursor to the given x-axis position.
TrnSetDisplayMode Specifies how trend samples will be displayed on the
screen.
TrnSetEvent Sets the start event of a trend pen.
TrnSetPen Sets a trend pen to a new trend tag.
TrnSetPenFocus Sets the pen focus.
TrnSetPeriod Sets the display period (time base) of a trend.
TrnSetScale Re-scales a pen.
TrnSetSpan Sets the span time of a trend.
TrnSetTable Sets trend data from an array.
TrnSetTime Sets the starting time/date of a pen.
The following trend functions are used on all standard trend templates. Use these functions
only if you create your own trend templates
(These functions are written in Cicode and can be found in the include project.)
TrendDspCursorScale Displays a scale value for the current pen.
TrendDspCursorTag Displays the tag name of the current pen.
TrendDspCursorTime Displays the cursor time of the current pen.
TrendDspCursorValue Displays the cursor value of the current pen.
TrendGetAn Gets the AN number of the trend under the mouse po-
sition.
TrendPopUp Displays a pop-up trend with the specified trend pens.
TrendRun Initializes the cursor and rubber-band features on a
trend page.
TrendSetDate Sets the starting date for all the pens on a trend.
TrendSetScale Sets the scale of one or more pens on a trend.
TrendSetSpan Sets the span time of a trend.
TrendSetTime Sets the starting time for all the pens on a trend.
TrendSetTimebase Sets a new sampling period for a trend.
TrendWin Displays a trend page (in a new window) with the
specified trend pens.
TrendZoom Zooms a trend in either one or both axes.
See Also
Functions Reference
TrendDspCursorScale
Displays a scale value for the current pen in the current pen font.
Syntax
TrendDspCursorScale(AN, Percent)
AN:
The AN of the trend.
Percent:
755
The percentage of full scale to display for the current pen, as an integer.
Return Value
Related Functions
TrendDspCursorScale, TrendDspCursorTag, TrendDspCursorTime, TrendDspCursorVal-
ue, TrendGetAn, TrendRun, TrendSetDate, TrendSetScale, TrendSetSpan, TrendSetTime,
TrendSetTimebase, TrendZoom
Example
See built-in trend templates.
See Also
Trend Functions
TrendDspCursorTag
Displays the trend tag name of the current pen in the pen font.
Syntax
TrendDspCursorTag(AN [, Mode] )
AN:
Mode:
An optional argument used to specify whether the trend tag name is displayed
with a cluster prefix. Set:
 0 display tag without cluster prefix (default)
 1 display tag with cluster prefix.
Return Value
Related Functions
TrendSetTimebase, TrendZoom
Example
See Also
Trend Functions
TrendDspCursorTime
Displays the cursor time of the current pen in the current pen font.
756
Syntax
TrendDspCursorTime(AN, Format)
AN:
The AN number of the trend.
Format:
Format of the string:
0 - Short time format, hh:mm.
1 - Long time format, hh:mm:ss.
2 - Short date format, dd/mm/yy.
3 - Long date format, day month year.
4 - Time and date, weekday month day year hh:mm:ss.
5 - Long time period, hh:mm:ss. Time must be in seconds.
6 - Millisecond time period, hh:mm:ss:xxx ("xxx" represents milliseconds). Time
must be in milliseconds.
7 - Short time period, hh:mm. Time must be in seconds.
8 - Long time period, days:hh:mm:sec. Time must be in seconds.
9 - Extended date format, dd/mm/yyyy.
Return Value
Related Functions
TrendDspCursorScale, TrendDspCursorTag, TrendDspCursorValue, TrendGetAn, Tren-
dRun, TrendSetDate, TrendSetScale, TrendSetSpan, TrendSetTime, TrendSetTimebase,
TrendZoom
Example
See the built-in trend templates.
See Also
Trend Functions
TrendDspCursorValue
Display the cursor value of the current pen in the current pen font.
Syntax
TrendDspCursorValue(AN)
AN:
Return Value
757
Related Functions
TrendDspCursorScale, TrendDspCursorTag, TrendDspCursorTime, TrendGetAn, Tren-
dRun, TrendSetDate, TrendSetScale, TrendSetSpan, TrendSetTime, TrendSetTimebase,
TrendZoom
Example
See Also
Trend Functions
TrendGetAn
Gets the AN number of the trend beneath the current mouse position.
Syntax
TrendGetAn()
Return Value
The AN of the trend, or 0 (zero) if the mouse is not positioned over a valid trend.
Related Functions
ue, TrendRun, TrendSetDate, TrendSetScale, TrendSetSpan, TrendSetTime, TrendSetTime-
base, TrendZoom
Example
See Also
Trend Functions
TrendPopUp
Displays a pop-up trend with the specified trend pens. You must create the trend page with
the graphic builder and set all the pen names to blank.
Syntax
TrendPopUp(sPage, sTag1 [, sTag2..sTag8] )
sPage:
The name of the trend page (drawn with the Graphics Builder).
sTag1:
The First trend tag to display on the page.
sTag2..sTag8:
The trend tags to display on the page.
758
Return Value
Related Functions
PageTrend, TrendWin, WinNewAt
Example
Buttons
Text Popup Trend
Command TrendPopUp("MyPop", "PV1", "PV2", "PV3")
Comment Display a popup trend with three trend pens
See Also
Trend Functions
TrendRun
Initializes the cursor and rubber-band features on a trend page. This function is included
as a Cicode Object on all new trend pages. Only use this function when configuring a trend
template that requires this functionality.
Syntax
TrendRun(iPageType)
iPageType:
The type of the page:
0 - Normal trend page template
1 - Compare trend page template
Return Value
Related Functions
ue, TrendGetAn, TrendSetDate, TrendSetScale, TrendSetSpan, TrendSetTime, TrendSet-
Timebase, TrendZoom
Example
See Also
Trend Functions
TrendSetDate
Sets the end date for all pens on a trend. Samples taken after this date will not be displayed.
You can enter the date in the Value argument, or leave the Value blank - a form is then dis-
played in run time for the operator to enter an end date.
759
Syntax
TrendSetDate(AN, Value)
AN:
Value:
The new date, as a string. Samples taken after date will not be displayed. This ar-
gument is optional.
Return Value
Related Functions
ue, TrendGetAn, TrendRun, TrendSetScale, TrendSetSpan, TrendSetTime, TrendSetTime-
base, TrendZoom
Example
See Also
Trend Functions
TrendSetScale
Sets the scale of the current pen or of all pens on a trend. You can enter a scale in the Value
argument, or leave the Value blank. A form is then displayed in run time for the operator to
enter a value for the scale.
Syntax
TrendSetScale(AN, Percent [, Value] )
AN:
Percent:
The scale to be set:
0 - Zero scale
100 - Full scale
Value:
An optional value for the scale, as a string.
Return Value
Related Functions
ue, TrendGetAn, TrendRun, TrendSetDate, TrendSetSpan, TrendSetTime, TrendSetTime-
base, TrendZoom
760
Example
See Also
Trend Functions
TrendSetSpan
Sets the span time of the trend. The span time is the time period covered in the trend win-
dow. You can enter a span time in the Value argument, or leave the Value blank - a form is
then displayed in run time for the operator to enter a value for the span time.
Syntax
TrendSetSpan(AN [, Value] )
AN:
Value:
An optional value for the span time, as a string.
Return Value
Related Functions
ue, TrendGetAn, TrendRun, TrendSetDate, TrendSetScale, TrendSetTime, TrendSetTime-
base, TrendZoom
Example
See Also
Trend Functions
TrendSetTime
Sets the end time for all the pens on a trend. Samples taken after this time will not be dis-
played. You can enter an end time in the Value argument, or leave the Value blank - a form
is then displayed in run time for the operator to enter a value for the end time.
Syntax
TrendSetTime(AN [, Value] )
AN:
Value:
An optional value for the end time, as a string. Samples taken after this time will
not be displayed.
761
Return Value
Related Functions
ue, TrendGetAn, TrendRun, TrendSetDate, TrendSetScale, TrendSetSpan, TrendSetTime-
base, TrendZoom
Example
See Also
Trend Functions
TrendSetTimebase
Sets a new sampling period for a trend. You can enter a sampling period in the Value argu-
ment, or leave the Value blank. A form is then displayed in run time for the operator to enter
a value for the sampling period.
Syntax
TrendSetTimebase(AN [, Value] )
AN:
Value:
An optional value for the sampling period, as a string.
Return Value
Related Functions
TrendZoom
Example
See Also
Trend Functions
TrendWin
Displays a trend page (in a new window) with the specified trend pens. You must create
the trend page with the graphic builder and set all the pen names to blank. You then display
that page by calling this function and pass the required trend tags. The function will create
a new window with the specified window mode.
762
Syntax
TrendWin(sPage, X, Y, Mode, sTag1 [, sTag2..sTag8] )
sPage:
The name of the trend page (drawn with the Graphics Builder).
X:
The x pixel coordinate of the top left corner of the window.
Y:
The y pixel coordinate of the top left corner of the window.
Mode:
0 - Normal page.
tive window.
sized.
64 - Always on top.
1024 - Disables dynamic resizing of new window, overriding the setting of the
icons).
sTag1:
The firs trend tag to display on the page.
sTag2..sTag8:
The trend tags to display on the page.
763
Return Value
Related Functions
PageTrend, TrendPopUp, WinNew
Example
Buttons
Text Trend Window
Command TrendWin("MyTrend", 0, 0, 4, "PV1", "PV2", "PV3")
Comment Display a trend page in a new window with no maximize and minimize
icons
See Also
Trend Functions
TrendZoom
"Zooms" a specified trend in either one or both axes. Set the zoom values (TimeZoom and/
or ScaleZoom) to greater than one to "zoom in" or to less than one to "zoom out".
If you specify a destination AN, you can zoom one trend (at SourceAn) onto another (at
DestAn), in the same way as on the standard zoom trend page.
Syntax
TrendZoom(SourceAn, TimeZoom, ScaleZoom [, DestAn] )
SourceAn:
The AN on which the source trend is located.
TimeZoom:
The scale by which the Time axis will be changed (as a real number).
ScaleZoom:
The scale by which the Scale axis will be changed (as a real number).
DestAn:
The AN on which the destination or target trend is located. If you do not enter a
DestAn, it is set to the same AN as SourceAn.
Return Value
Related Functions
TrendSetTimebase
Example
TrendZoom(30, 2.0, 2.0);
/* Zoom in by a factor of 2 on both the time and scale axes. */
764
TrendZoom(30, 0.5, 0.5);

/* Zoom out by a factor of 2 on both the time and scale axes. */
See Also
Trend Functions
TrnAddHistory
Adds an old (backed up) trend history file to the trend system so that its data can be used.
When you back-up a trend file, change its extension so that it indicates the age of the file’s
trend data (for example, the month and year).
An archived trend file does not need to reside in the same directory as existing active
trends. CitectSCADA retrieves the trend name from the header of the specified file and
adds its data to the trend history. Please be aware that only a reference to the archived file,
and not the file itself, is kept in the trend history. Therefore, care must be taken if using this
function to access archived files residing on removable storage media. When you remove
the media, the archived data is no longer available for display.
This function can only be used if the Trend Server is on the current machine. When the
Trend Server is not in the calling process, this function will become blocking and cannot be
Syntax
TrnAddHistory(FileName [, ClusterName] )
FileName:
The file name and directory path of an old history file. The old file does not need
to reside in the same directory as existing active trends to be restored.
ClusterName:
Specifies the name of the cluster in which the Trend Server resides. This is option-
al if you have one cluster or are resolving the trend server via the current cluster
Return Value
Related Functions
TrnDelHistory, MsgRPC
Example
TrnAddHistory("C:\CITECT\DATA\TR1.MAY91");
! Adds the file TR1.MAY91 to the trend system.
See Also
Trend Functions
765
TrnBrowseClose
The TrnBrowseClose function terminates an active data browse session and cleans up all
resources associated with the session.
TrnBrowseClose(iSession)
iSession
The handle to a browse session previously returned by a TrnBrowseOpen call.
Return Value
0 (zero) if the trend browse session exists, otherwise an error is returned.
Related Functions
TrnBrowseFirst, TrnBrowseGetField, TrnBrowseNext, TrnBrowseNumRecords, Trn-
BrowseOpen, TrnBrowsePrev
See Also
Trend Functions
TrnBrowseFirst
The TrnBrowseFirst function places the data browse cursor at the first record.
complete.
Syntax
TrnBrowseFirst(iSession)
iSession
Return Value
Related Functions
TrnBrowseClose, TrnBrowseGetField, TrnBrowseNext, TrnBrowseNumRecords, Trn-
See Also
Trend Functions
TrnBrowseGetField
The TrnBrowseGetField function retrieves the value of the specified field from the record
the data browse cursor is currently referencing.
766
Syntax
TrnBrowseGetField(iSession, sFieldName)
iSession
sFieldName
are:
AREA, EXPRESSION, FILENAME, FILES, FORMAT, LSL, PERIOD, PRIV,
RANGE, SDEVIATION, SPCFLAG, STORMETHOD, SUBGRPSIZE,
TAGGENLINK, TIME, TRIGGER, USL, XDOUBLEBAR.
Return Value
Related Functions
TrnBrowseClose, TrnBrowseFirst, TrnBrowseNext, TrnBrowseNumRecords, Trn-
Example
INT errorCode = 0;
...
fieldValue = TrnBrowseGetField(iSession, sFieldName);
// Successful case
ELSE
// Function did not succeed
END
...
See Also
Trend Functions
TrnBrowseNext
The TrnBrowseNext function moves the data browse cursor forward one record. If you call
this function after you have reached the end of the records, error 412 is returned
complete.
Syntax
TrnBrowseNext(iSession)
767
iSession
Return Value
Related Functions
TrnBrowseClose, TrnBrowseFirst, TrnBrowseGetField, TrnBrowseNumRecords, Trn-
See Also
Trend Functions
TrnBrowseNumRecords
The TrnBrowseNumRecords function returns the number of records that match the filter
criteria.
Syntax
TrnBrowseNumRecords(iSession)
iSession
Return Value
session.
Related Functions
TrnBrowseClose, TrnBrowseFirst, TrnBrowseGetField, TrnBrowseNext, TrnBrowseOpen,
TrnBrowsePrev
Example
INT numRecords = 0;
...
numRecords = TrnBrowseNumRecords(iSession);
// Have records
ELSE
// No records
END
...
See Also
Trend Functions
768
TrnBrowseOpen
The TrnBrowseOpen function initiates a new browse session and returns a handle to the
new session that can be used in subsequent data browse function calls.
complete.
Syntax
TrnBrowseOpen( [sFilter] [, sFields] [, sClusters] )
sFilter
sFields
AREA, EXPRESSION, FILENAME, FILES, FORMAT, LSL, PERIOD, PRIV,
RANGE, SDEVIATION, SPCFLAG, STORMETHOD, SUBGRPSIZE,
TAGGENLINK, TIME, TRIGGER, USL, XDOUBLEBAR.
sClusters
be browsed.
Return Value
Returns an integer handle to the browse session. Returns -1 on error.
Related Functions
TrnBrowseClose, TrnBrowseFirst, TrnBrowseGetField, TrnBrowseNext, TrnBrowseNum-
Records, TrnBrowsePrev
Example
INT iSession;
...
iSession = TrnBrowseOpen("NAME=ABC*", "NAME,TYPE",
// Successful case
ELSE
// Function did not succeed
END
...
See Also
Trend Functions
769
TrnBrowsePrev
The TrnBrowsePrev function moves the data browse cursor back one record. If you call this
function after you have reached the beginning of the records, error 412 is
Syntax
TrnBrowsePrev(iSession)
iSession
Return Value
Related Functions
TrnBrowseClose, TrnBrowseFirst, TrnBrowseGetField, TrnBrowseNext, TrnBrowseNum-
Records, TrnBrowseOpen
See Also
Trend Functions
TrnClientInfo
Gets information about the trend that is being displayed at the AN point.
Syntax
TrnClientInfo(AN, Pen, Type, Data, Error)
hAN:
The AN point number at which the trend is displayed.
Pen:
The trend pen number:
0 - The pen currently in focus
1...8 - Pen1. . .Pen8
Type:
The type of information you would like returned.
1 - The number of samples configured for the trend. If you select Type 1, the Data
argument is ignored.
Data:
For future enhancements; is currently ignored.
Error:
An output argument. If the function is successful, the error is set to 0 (zero). If un-
successful, an error value is set, and a hardware alarm is triggered.
770
Return Value
The requested information (as a string) if successful, otherwise a hardware alarm is gener-
ated.
Related Functions
TrnInfo
Example
INT nError;
INT nSamples;
INT nTime;
!Gets the number of samples configured for the current pen of the
trend displayed at AN 30.
nSamples = TrnClientInfo(30, 0, 1, "", nError);
IF nError = 0 THEN
nTime = nSamples * 50;
ELSE
nTime = 0;
END
See Also
Trend Functions
TrnComparePlot
Prints two trends, one overlaid on the other. Each trend can have up to four tags configured
on it. The significance of this type of plot is that the two trends show different times and
display periods. It is possible to compare a trend tag or tags over different time slots. Each
trend line is drawn with a different pen style and marker as appropriate. The trend plot in-
cludes a comment and a legend, and you can specify the vertical high and low scales.
For more advanced trend plotting, you can use the low-level plot functions.
Syntax
TrnComparePlot(sPort, sTitle, sComment, AN, iMode, nSamples, iTime1, rPeriod1, iTime2,
rPeriod2, Tag1......Tag8, rLoScale1, rHiScale1,......rLoScale8, rHiScale8)
sPort:
The name of the printer port to which the plot will be printed. This name must be
enclosed within quotation marks. For example LPT1:, to print to the local printer,
or \\Pserver\canon1 using UNC to print to a network printer.
sTitle:
sComment:
The comment that is to display beneath the title of the trend plot. You do not have
to enter a comment.
AN:
Sets the display mode. A value of 0 causes the default display mode to be used.
Otherwise, the display mode of the specified AN is set.
771
iMode:
0 - black and white (default)
1 - Color
nSamples:
The number of data points on the plot.
iTime1:
The end point in time (the most recent point) for the first trend.
rPeriod1:
The period (in seconds) of the first trend. This can differ from the actual trend pe-
riod. If you do not enter a period, it defaults to the sample period of Tag1.
iTime2:
The end point in time (the most recent point) for the second trend.
rPeriod2:
The period (in seconds) of the second trend. This can differ from the actual trend
period. If you do not enter a period, it defaults to the sample period of Tag5.
Tag1. . .Tag8:
The trend tags for the plot. Tags 1 to 4 must be for the first trend, and tags 5 to 8
must be for the second.
rLoScale1, HiScale1,....LoScale8, HiScale8
The minimum and maximum on the vertical scale for the trend line of each of the
tags (Tag1. . . Tag8)
Return Value
Related Functions
TrnPlot, TrnPrint, PlotOpen SPCPlot
Example
/* Prints two black and white trends (one overlaid on the other)
to LPT1, comparing the trend lines of one trend tag (Feed_Flow) at
different times. The first trend line has a starting time of
12 noon, on 11/12/96, and the second has a starting time of 9am, on
11/10/96. Both contain 200 sample points, and have a period of 2
seconds. Both trend lines will be on a vertical scale of 10-100.
*/
INT Time;
INT RefTime;
Time = StrToDate("11/12/96") + StrToTime("12:00:00");
RefTime = StrToDate("11/10/96") + StrToTime("09:00:00");
TrnComparePlot("LPT1:","Citect Flow Comparison Plot","Comparison
with Reference",0,
0,200,Time,2,RefTime,2,"Feed_Flow","","","","Feed_Flow","","","",
10,100,0,0,0,0,0,0,10,100);
772
See Also
Trend Functions
TrnDelete
Deletes a trend that is displayed on a current page. This trend may have been created by
the TrnNew() function or by a trend object.
Syntax
TrnDelete(AN)
AN:
The AN where the trend is located.
Return Value
Related Functions
TrnNew
Example
TrnDelete(20);
! Deletes the trend at AN20.
See Also
Trend Functions
TrnDelHistory
Removes a trend history file that has been added to the trend system by the TrnAddHisto-
ry() function. This function does not delete the file completely, it only disconnects it from
the historical trend system.
This function can only be used if the Trend Server is on the current machine. When the
Trend Server is not in the calling process, this function will become blocking and cannot be
Syntax
TrnDelHistory(FileName [, ClusterName] )
FileName:
The trend history file to disconnect from the historical trend system.
ClusterName:
Specifies the name of the cluster in which the Trend Server resides. This is option-
al if you have one cluster or are resolving the trend server via the current cluster
773
Return Value
Related Functions
TrnAddHistory, MsgRPC
Example
TrnDelHistory("C:\CITECT\DATA\TR1_91.MAY");
! Disconnects the file from the trend system.
See Also
Trend Functions
TrnEcho
Enables and disables the echo of the trend display. Use this function when you need to
make many changes to a trend display, so that the display updates only once. You should
first disable the trend echo, do all the trend changes, and then enable the echo to show the
changes.
Syntax
TrnEcho(AN, nMode)
AN:
The animation number of the trend.
nMode:
The mode of the echo:
0 - Disable echo of the trend display.
1 - Enable echo of the trend display, to show changes.
Return Value
The current echo mode, otherwise 0 (zero) is returned, and an error code is set. You can call
the IsError() function to get the actual error code.
Related Functions
TrnSetScale, TrnSetPeriod
Example
! Disable echo of trend display at AN40
TrnEcho(40,0);
! Change the scales on pens 1 and 2
TrnSetScale(40,1,0,-1000);
TrnSetScale(40,1,100,-1000);
TrnSetScale(40,2,0,-1000);
TrnSetScale(40,2,100,-1000);
! Enable echo to show changes to the display
TrnEcho(40,1);
774
See Also
Trend Functions
TrnEventGetTable
Stores event trend data in an event table and the associated time stamp in a time table, for
a specified trend tag. Data is stored at the specified Period, working backwards from the
starting point specified by EventNo. If Period differs from the trend period configured in the
Trend Tags database, the values to be stored are calculated from the trend data. Values are
either averaged or interpolated.
complete.
Syntax
TrnEventGetTable(Tag, EventNo, Period, Length, Table, TimeTable, Mode [, ClusterName] )
Tag:
The trend tag enclosed in quotation marks "" (can be prefixed by the name of the
cluster that is ClusterName.Tag).
EventNo:
The starting event number for entries in the trend table.
Period:
The time difference between tabulated trend values (in seconds). For example, if
you set this period to 30 seconds, CitectSCADA will get the last trend value (sam-
pled at the end of the trend section), then get the trend value that was sampled 30
seconds before that, and so on until it reaches the start time of the trend section.
If this period is different to the trend’s sampling period, the trend values will be
averaged or interpolated. Set to 0 (zero) to default to the actual trend period.
Length:
The number of trend values to store in the trend table, from 1 to the maximum
number of items in the table.
Table:
The Cicode array in which the trend data is stored. You can enter the name of an
array here (see the example).
TimeTable:
The table of integer values in which the time stamp is stored.
Mode:
The Display Mode parameters allow you to enter a single integer to specify the
display options for a trend (for a maximum of eight trends).
To calculate the integer that you should enter for a particular trend, select the op-
tions you want from the list below, adding their associated numbers together.
The resulting integer is the DisplayMode parameter for that trend.
Invalid/Gated trend options:
0 - Convert invalid/gated trend samples to zero.
1 - Leave invalid/gated trend samples as they are.
775
Ordering trend sample options:

0 - Order returned trend samples from oldest to newest.
2 - Order returned trend samples from newest to oldest.
Condense method options:
0 - Set the condense method to use the mean of the samples.
4 - Set the condense method to use the minimum of the samples.
8 - Set the condense method to use the maximum of the samples.
Stretch method options:
0 - Set the stretch method to step.
128 - Set the stretch method to use a ratio.
256 - Set the stretch method to use raw samples.
Gap Fill Constant option:
n - the number of missed samples that the user wants to gap fill) x 4096.
The options listed in each group are mutually exclusive. The default value for
each Display Mode is 258 (0 + 2 + 256).
ClusterName:
The name of the cluster in which the trend tag resides. This is optional if you have
one cluster or are resolving the trend via the current cluster context. The argu-
Return Value
The actual number of samples read. The return value is 0 if an error is detected. You can
call the IsError() function to get the actual error code. If EventNo is 0 (zero) then the Event-
No will be set to the current event number.
Related Functions
TrnEventSetTable, TrnGetEvent, TrnGetDisplayMode
See Also
Trend Functions
TrnEventGetTableMS
Stores event trend data and time data (including milliseconds) for a specified trend tag. The
event trend data is stored in an event table, and the time stamp in time tables. Data is stored
at the specified Period, working backwards from the starting point specified by EventNo. If
Period differs from the trend period configured in the Trend Tags database, the values to be
stored are calculated from the trend data. Values are either averaged or interpolated.
complete.
Syntax
TrnEventGetTableMS(Tag, EventNo, Period, Length, Table, TimeTable, Mode, MSTimeTable [,
ClusterName] )
Tag:
776
EventNo:
The starting event number for entries in the trend table.
Period:
Length:
number of items in the table.
Table:
TimeTable:
The table of integer values in which the time stamp is stored.
Mode:
tions you wish to use from those listed below, adding their associated numbers
together. The resulting integer is the DisplayMode parameter for that trend.
Note: Options listed in each group are mutually exclusive. The default value for
each Display Mode is 258 (0 + 2 + 256).
MSTimeTable:
The table of integer values in which the millisecond component of the time stamp
is stored.
ClusterName:
777
Return Value
call the IsError() function to get the actual error code.
Related Functions
TrnEventSetTableMS TrnGetEvent, TrnEventGetTable
See Also
Trend Functions
TrnEventSetTable
Adds new event to a trend, or overwrites existing points with new values.
To add new events, set ’EventNo’ to zero. The events are inserted at a point determined by
the time stamp associated with each event. If the timestamp of a new event is identical to
that of an existing event, the new event will overwrite the old one.
To overwrite specific existing events, set ’EventNum’ to the last event number of the block
of events to be overwritten, and set the times of the new events to zero.
complete.
Syntax
TrnEventSetTable(Tag, EventNo, 0, Length, Table, TimeTable [, ClusterName] )
Tag:
EventNo:
Event Number:
 When adding new events to a trend, set EventNo to 0.
 When overwriting existing values, set EventNo to the last event number to be
overwritten. For example, if overwriting events 100 to 110, set EventNo to 110.
Length:
The number of trend values in the trend table.
Table:
The table of floating-point values in which the trend data is stored. You can enter
the name of an array here (see the example).
TimeTable:
The table of integer values in which the time stamp is stored. If you would like
events to stay in correct time-stamp order, sort the values in this table in ascend-
ing order. When EventNo is non-zero the values in this table may be zero. This
will result in the values of the requested events being overwritten but the time-
stamps staying the same.
778
ClusterName:
Return Value
Related Functions
TrnEventGetTable
Example
REAL TrendTable1[100];
INT TimeTable[100];
/* Defines an array of a maximum of 100 entries. Assume that
TrendTable1 has been storing data from a source. */
TrnEventSetTable("OP1",nEventNo, 1,10,TrendTable1[0],
TimeTable[0], "ClusterXYZ");
/* A set of 10 trend data values are set for the OP1 trend tag. */
See Also
Trend Functions
TrnEventSetTableMS
Sets event trend data and time data (including milliseconds) for a specified trend tag. The
event trend data is set in an event table, and the time stamp in time tables. Data is set at the
period specified, working backwards from the starting point specified by EventNo.
If the period of setting data differs from the trend period (defined in the Trend Tags data-
base), the values to be set are calculated from the trend data, either averaged or interpolat-
ed. The user must have the correct privilege (as specified in the Trend Tags form),
otherwise the data is not written.
complete.
Syntax
TrnEventSetTableMS(Tag, EventNo, Period, Length, Table, TimeTable, MSTimeTable [, Clus-
terName] )
Tag:
EventNo:
Event Number:
 When adding new events to a trend, set EventNo to 0.
 When overwriting existing values, set EventNo to the last event number to be
overwritten. For example, if overwriting events 100 to 110, set EventNo to 110.
779
Period:
This will be the interval (in seconds) between trend values when they are set (that
is it will be the perceived sampling period for the trend). This period can differ
from the actual trend period. Set to 0 (zero) to default to the actual trend period.
Length:
Number of trend values in the trend table.
Table:
Table of floating-point values in which the trend data is stored. You can enter the
name of an array here (see example).
TimeTable:
Table of integer values in which the time stamp is stored. If you would like events
to stay in correct time-stamp order, sort the values in this table in ascending or-
der. When EventNo is non-zero the values in this table may be zero. This will re-
sult in the values of the requested events being overwritten but the timestamps
staying the same.
MSTimeTable:
The table of integer values in which the millisecond component of the time stamp
is stored.
ClusterName:
Return Value
Related Functions
TrnEventGetTable
Example
// Arrays for trend data
REAL garSingleValue[1];
INT ganSingleTime[1];
INT ganSingleMS[1];
// Push the data in the trend system
INT
FUNCTION LogTrend(STRING sTagName, REAL rValue, INT nDateTime, INT
nMS)
INT nSamplesWritten;
garSingleValue[0] = rValue;
ganSingleTime[0] = nDateTime;
ganSingleMS[0] = nMS;
nSamplesWritten = TrnEventSetTableMS(sTagname, 0, 0, 1, garSingleValue[0],
ganSingleTime[0], ganSingleMS[0], "ClusterXYZ");
RETURN nSamplesWritten;
END
780
See Also
Trend Functions
TrnExportClip
Exports trend data to the Windows Clipboard. The data is set at the specified Time and Pe-
riod, and listed from earliest to latest. Any gated or invalid data is written as 0.0.
Data is stored as a grid, with each row time-stamped. The first column/field is the date, fol-
lowed by the time, followed by the tags 1 to 8.
You can use the ClipMode argument to make the output more useful. For example, to paste
the data into Excel, use ClipMode 2 for CSV format. If you use ClipMode 1 or 3, the default
paste menu option causes data to be pasted into the user’s spreadsheet as text. If you use
ClipMode 3, use the Paste Special option to paste the required format. Please be aware that
not all packages support multiple clipboard formats in this way.
Syntax
TrnExportClip(Time, Period, Length, Mode, ClipMode, sTag1 ... sTag8, iDisplayMode1 ... iDis-
playMode 8)
Time:
The starting time for the data being exported.
Period:
The period (in seconds) of the entries being exported. (This period can differ from
the actual trend period.)
Length:
The length of the data table, that is The number of rows of samples to be exported.
for example if you put the length as 12, and you declare two tags to be exported,
you get a grid with 12 rows of samples. Each row has values for each of the two
tags making a total of 24 samples in all.
Mode:
The format mode to be used:
Periodic trends
1 - Export the Date and Time, followed by the tags.
2 - Export the Time only, followed by the tags.
4 - Ignore any invalid or gated values. (Only supported for periodic trends.)
8 - The time returned will have millisecond accuracy.
Event trends
1 - Export the Time, Date and Event Number, followed by the tags.
2 - Export the Time and Event Number, followed by the tags.
ClipMode:
The format for the data being exported.
1 - Text
2 - CSV
You can add these modes for a combination of formats.
781
sTag1 ... sTag8:

The trend tag names for the data being exported.
iDisplayMode1 ... iDisplayMode8:
By default, this argument is set to 3 (see the details for options 1 and 2 below).
Invalid and gated samples that are not converted to zero will appear in the desti-
nation file as the string "na" (for invalid) or "gated".
12 - Set the condense method to use the newest of the samples.
Display as Periodic options:
0 - Display according to trend type.
1048576 - Display as periodic regardless of trend type.
Return Value
Note: If using this function to export trends by using event numbers, you must specify a
valid event number in the Time argument, rather than a time.
Related Functions
ClipSetMode, TrnExportCSV
Example
TrnExportClip(TimeCurrent(), 2, 60 * 60/2, 2, 3, "Feed",
"Weight");
/* Export the last hour of data from the trend tags Feed and Weight
to the clipboard in both Text and CSV formats. Note that the 60 *
60/2 is a decomposed way or writing 1800, which is the number of 2
782
second samples in 1 hour. */
See Also
Trend Functions
TrnExportCSV
Exports trend data to a file in CSV (Comma Separated Variable) format. The data is set at
the specified Time and Period, and listed from earliest to latest. Any gated or invalid data is
written as 0.0.
You can view the CSV file with a text editor, and import the file directly into other packages
such as Excel for data analysis and presentation.
If you’re using this function to export trends by using event numbers, you must specify a
valid event number in the Time argument, rather than a time.
Syntax
TrnExportCSV(Filename, Time, Period, Length, Mode, sTag1 ... sTag8, iDisplayMode1 ... iDis-
playMode 8)
Filename:
The name of the destination path and file.
Time:
Period:
Length:
The length of the data table, that is, The number of rows of samples to be export-
ed. for example if you put the length as 12, and you declare two tags to be export-
ed, you get a grid with 12 rows of samples. Each row has values for each of the
two tags making a total of 24 samples in all.
Mode:
Periodic trends
4 - Ignore any invalid or gated values. (This mode is only supported for periodic
trends.)
Event trends
783
sTag1 ... sTag8:

The trend tag names for the data being exported.
together. The resulting integer is the DisplayMode parameter for that trend. By
default, this argument is set to 3 (see the details for options 1 and 2 below).
Options listed in each group are mutually exclusive. The default value for each
Display Mode is 258 (0 + 2 + 256).
Return Value
Related Functions
TrnExportDBF, TrnPrint
Example
TrnExportCSV("c:\TrnData.CSV", TimeCurrent(), 2, 60 * 60/2, 2,
"Feed", "Weight");
/* Export the last hour of data from the trend tags Feed and
Weight.
The 60 * 60/2 is a decomposed way or writing 1800, which is the
number of 2 second samples in 1 hour. */
784
See Also
Trend Functions
TrnExportDBF
Exports trend data to a file in dBASE III format. The data is set at the specified Time and
Period, and listed from earliest to latest. Any gated or invalid data is written as 0.0.
You can import the DBF file directly into other packages such as Excel, for data analysis and
presentation.
Syntax
TrnExportDBF(Filename, Time, Period, Length, Mode, sTag1 ... sTag8, iDisplayMode1 ... iDis-
playMode 8)
Filename:
Time:
Period:
Length:
Mode:
Periodic trends
trends.)
Event trends
sTag1 ... sTag8:
The trend tag names for the data being exported. Tag names longer than 10 char-
acters will be truncated, as the standard DBF field format is 10 characters.
785
together. The resulting integer is the DisplayMode parameter for that trend. By
default, this argument is set to 3 (see the details for options 1 and 2 below).
Display Mode is 258 (0 + 2 + 256).
Return Value
Related Functions
TrnExportCSV, TrnPrint
Example
TrnExportDBF("c:\TrnData.DBF", TimeCurrent(), 2, 60 * 60/2, 2,
"Feed", "Weight");
/* Export the last hour of data from the trend tags Feed and
Weight. Note that the 60 * 60/2 is a decomposed way or writing
1800, which is the number of 2 second samples in 1 hour. */
See Also
Trend Functions
TrnExportDDE
786
Exports trend data via DDE. The data is set at the specified Time and Period, and listed
from earliest to latest. Any gated or invalid data is written as 0.0. Data is stored as a grid,
with each row time-stamped. The first column/field is the date, followed by the time, fol-
lowed by the tags 1 to 8.
You can use the DDEMode argument to make the output more useful. For example; to
paste the data into Excel, use DDEMode 2 for CSV format. If you use DDEMode 1, data will
be put into the user’s spreadsheet as text.
Note: If you’re using this function to export trends by using event numbers, you must spec-
ify a valid event number in the Time argument, rather than a time.
Syntax
TrnExportDDE(sApplication, sDocument, sTopic, Time, Period, Length, Mode, DDEMode,
sTag1 ... sTag8, iDisplayMode1 ... iDisplayMode 8)
sApplication:
The application name to export the data.
sDocument:
The document in the application to export the data.
sTopic:
The topic in the application to export the data. Note you may have to use a special
topic format to make the data export correctly. See your application documenta-
tion for details; For example with Excel you must specify the matrix of rows and
columns as "R1C1:R8C50" depending on the size of the data.
Filename:
Time:
Period:
Length:
Mode:
Periodic trends
trends.)
Event trends
787

DDEMode:
The format for the data being exported. CSV format allows the application to sep-
arate the data into each individual element, however not all applications will sup-
port this mode. See you applications documentation for details.
1 - Text (default)
2 - CSV
sTag1 ... sTag8:
The trend tag names for the data being exported. Tag names longer than 10 char-
acters will be truncated, as the standard DBF field format is 10 characters.
By default, this argument is set to 3 (see the details for options 1 and 2 below).
Display Mode is 258 (0 + 2 + 256).
Return Value
Related Functions
TrnExportCSV, TrnExportClip, TrnExportDBF
788
Example
TrnExportDDE("Excel", "data.xls", "R1C1:R61C4", TimeCurrent(), 1,
60, 2, 2, "Feed", "Weight");
/* Export the last 60 seconds of data from the trend tags Feed and
Weight into Excel at R1C1:R61C4 in CSV formats */
See Also
Trend Functions
TrnFlush
Writes acquired trend data to disk without waiting for the trend buffer to be filled. Cit-
ectSCADA normally buffers the trend data in memory and only writes to disk when re-
quired, to give optimum performance. Because this function reduces the performance of
the Trends Server, use it only when necessary.
Syntax
TrnFlush(Name [, ClusterName] )
Name:
The name of the logging tag (can be prefixed by the name of the cluster that is
ClusterName.Tag). Set to " * " to flush all trend data.
ClusterName:
Return Value
Related Functions
TrnSetTable
Example
TrnFlush("Trend1", "ClusterXYZ");
! Forces the Trend1 data to be written to disk.
See Also
Trend Functions
TrnGetBufEvent
Gets the event number of a trend at an offset for a specified pen. This function only operates
on an event-based trend.
Syntax
TrnGetBufEvent(AN, Pen, Offset)
789
AN:
Pen:
1...8 - Pen1. . .Pen8
Offset:
The trend buffer offset, in samples. The number of samples can range from 0 to
the maximum number of samples that can display on the trend - 1.
Return Value
The event number. If Offset is not within boundaries, 0 (zero) is returned. If AN or Pen is
invalid, 0 (zero) is returned and an error code is set.
Related Functions
TrnGetEvent, TrnSetEvent, TrnGetCursorEvent
Example
! For the trend at AN20
DspText(31,0,TrnGetBufEvent(20,0,10));
/* Displays the trend event at offset 10 for the pen currently in
focus. The event will display at AN31. */
See Also
Trend Functions
TrnGetBufTime
Gets the time and date of a trend at an offset for a specified pen. The Offset should be a value
between 0 (zero) and the number of samples displayed on the trend.
Syntax
TrnGetBufTime(AN, Pen, Offset)
AN:
Pen:
1...8 - Pen1. . .Pen8
Offset:
The trend buffer offset, in samples. The number of samples can range from 0 to
the maximum number of samples that can display on the trend - 1.
790
Return Value
A time/date variable. If Offset is not within boundaries, 0 (zero) is returned. If AN or Pen is
invalid, 0(zero) is returned and an error code is set.
Related Functions
TrnGetCursorTime
Example
INT time;
time = TrnGetBufTime(20,0,10);
IF time <> 0 THEN
DspText(31,0,TimeToStr(time,2));
END
/* Displays the trend date at offset 10 for the pen currently in
focus. The time will display at AN31. */
See Also
Trend Functions
TrnGetBufValue
Gets the value of a trend at an offset for a specified pen. The offset should be a value be-
tween -1 and the number of samples displayed on the trend.
Syntax
TrnGetBufValue(AN, Pen, Offset)
AN:
Pen:
1...8 - Pen1. . .Pen8
Offset:
The trend buffer offset, in samples. The number of samples can range from -1 to
the maximum number of samples that can display on the trend minus 1.
-1 means get the last valid value in the display (provided it is less than 1.5 sample
periods old).
If there is no invalid or gated sample within the last 1.5 sample periods, it is as-
sumed that a sample has been missed and an invalid trend value is returned. See
the TrnIsValidValue function.
Return Value
The trend value. If the actual value is gated or invalid, the standard invalid or gated values
are returned (no error is set). You can check this return value using TrnIsValidValue().
791
Related Functions
TrnGetCursorValue, TrnIsValidValue
Example
DspText(31,0,TrnGetBufValue(20,0,10):###.#);
/* Displays the trend value at offset 10 for the pen currently in
focus. */
See Also
Trend Functions
TrnGetCluster
Gets the cluster name of a trend graph on a page.
Syntax
TrnGetCluster(AN)
AN:
The AN of the chosen trend graph.
Return Value
The name of the cluster the trend graph is associated with.
See Also
Trend Functions
TrnGetCursorEvent
Gets the event number of a trend, at the trend cursor position for a specified pen. This func-
tion only operates on an event-based trend.
Syntax
TrnGetCursorEvent(AN, Pen)
AN:
Pen:
1...8 - Pen1. . .Pen8
Return Value
The event number, or 0 (zero) if the trend cursor is disabled.
Related Functions
TrnSetEvent, TrnGetCluster, TrnGetEvent
792
Example
DspText(31,0,TrnGetCursorEvent(20,0));
/* Displays the trend event at the cursor for the pen currently in
focus. The event will display at AN31. */
See Also
Trend Functions
TrnGetCursorMSTime
Gets the time (in milliseconds from the previous midnight) at a trend cursor for a specified
pen.
Syntax
TrnGetCursorMSTime(AN, Pen)
AN:
Pen:
1...8 - Pen1. . .Pen8
Return Value
The number of milliseconds since the previous midnight. If the trend cursor is disabled, 0
(zero) is returned. If AN or Pen is invalid, 0 (zero) is returned and an error code is set.
Related Functions
TrnGetCursorTime
Example
STRING timeStr;
STRING msecStr;
timeStr = TimeToString(TrnGetCursorTime(20,1),2) + " ";
msecStr = TimeToString(TrnGetCursorMSTime(20,1),6);
DspText(31,0,timeStr + msecStr);
! Returns "23/02/01 10:53:22.717"
See Also
Trend Functions
TrnGetCursorPos
Gets the offset of a trend cursor from its origin, in samples.
793
Syntax
TrnGetCursorPos(AN)
AN:
Return Value
The offset of a trend cursor from its origin, in samples, or -1 if the trend cursor is disabled.
Related Functions
TrnSetCursorPos
Example
! If the trend cursor is disabled
Offset=TrnGetCursorPos(20);
! Sets Offset to -1.
! If the trend cursor is 50 samples from the origin
Offset=TrnGetCursorPos(20);
! Sets Offset to 50.
See Also
Trend Functions
TrnGetCursorTime
Gets the time and date at a trend cursor for a specified pen.
Syntax
TrnGetCursorTime(AN, Pen)
AN:
Pen:
1...8 - Pen1. . .Pen8
Return Value
A time/date variable. If the trend cursor is disabled, 0 (zero) is returned. If AN or Pen is in-
valid, 0 (zero) is returned and an error code is set.
Related Functions
TrnGetBufTime
Example
INT time;
794
time = TrnGetCursorTime(20,1);
! Displays the trend cursor date for Pen1.
! Displays the trend cursor time for Pen1.
See Also
Trend Functions
TrnGetCursorValue
Gets the value at a trend cursor for a specified pen.
Syntax
TrnGetCursorValue(AN, Pen)
AN:
Pen:
1...8 - Pen1. . .Pen8
Return Value
The trend value. If the actual value is gated or invalid, the standard invalid or gated values
are returned (no error is set). You can check this return value using TrnIsValidValue().
Related Functions
TrnGetBufValue
Example
DspText(31,0,TrnGetCursorValue(20,0));
! Displays the value at the trend cursor for the focus pen.
See Also
Trend Functions
TrnGetCursorValueStr
Gets the value at a trend cursor for a specified pen. The value is returned as a formatted
string using the pen’s format specification and (optionally) the engineering units.
Syntax
TrnGetCursorValueStr(AN, Pen, EngUnits)
AN:
795
Pen:
1...8 - Pen1. . .Pen8
EngUnits:
Engineering units mode:
0 - Do not include the engineering units at the end of the formatted string.
1 - Include the engineering units at the end of the formatted string.
Return Value
The trend value (as a string). If trend data is invalid, or an argument passed to the function
is invalid "<na>" is returned. If the actual value is gated (not triggered) "<gated>" is re-
turned. If the trend cursor is disabled, an empty string is returned.
Related Functions
TrnGetCursorValue
Example
DspText(31,0,TrnGetCursorValueStr(20,0,1));
/* Displays the value at the trend cursor for the focus pen. The
value will display as a formatted string (including the
engineering units).*/
See Also
Trend Functions
TrnGetDefScale
Gets the default engineering zero and full scales of a trend tag.
is complete.
Syntax
TrnGetDefScale(Tag, LoScale, HiScale [, ClusterName] )
Tag:
cluster that is "ClusterName.Tag").
LoScale:
The engineering zero scale.
HiScale:
The engineering full scale.
ClusterName:
796
Return Value
Related Functions
TrnGetScale, TrnInfo
Example
REAL LoScale;
REAL HiScale;
TrnGetDefScale("PV1",LoScale,HiScale,"ClusterXYZ");
/* Returns engineering zero and full scales of the trend tag
"PV1". */
See Also
Trend Functions
TrnGetDisplayMode
Returns the display mode of the selected trend pen. The display mode is set using TrnSet-
DisplayMode.
Syntax
TrnGetDisplayMode(AN, PenNumber)
AN:
The AN of the chosen trend.
PenNumber:
0 - The pen currently in focus.
1...8 - Pen1. . .Pen8.
Return Value
An integer representing the trend’s display mode:
797

1048576 - display as periodic regardless of trend type.
Related Functions
TrnSetDisplayMode
Example
int DisplayMode = TrnGetDisplayMode (10, 7)
/* Returns The Display Mode of pen 7 for the trend at AN 10.*/
See Also
Trend Functions
TrnGetEvent
Gets the event number of the trend at a percentage along the trend, using the current event
as the base point. This function only operates on an event-based trend. The first recorded
event (the start event) would be event number 1 and the highest number would be the latest
event. The event number is stored in a LONG and would eventually wrap around if you
have enough events.
Syntax
TrnGetEvent(AN, Pen, Percent)
AN:
Pen:
1...8 - Pen1. . .Pen8
Percent:
798
The percentage of the trend from the starting event, from 0 (the start event) to 100
(the end event).
Return Value
The event number.
Related Functions
TrnSetEvent, TrnGetCluster, TrnGetCursorEvent
Example
/* Display the start event for the current pen of the trend at
AN20. */
DspText(31,0,TrnGetEvent(20,0,0));
See Also
Trend Functions
TrnGetFormat
Gets the format of a trend tag being plotted by a specified pen.
Syntax
TrnGetFormat(AN, Pen, Width, DecPlaces)
AN:
Pen:
1...8 - Pen1. . .Pen8
Width:
The width of the format.
DecPlaces:
The number of decimal places in the format.
Return Value
Related Functions
TrnGetScale, TrnGetUnits
Example
/* If the trend tag being plotted by Pen1 of the trend at AN20 has
a format of "###.#" */
TrnGetFormat(20,1,Width,DecPlaces);
! Sets Width to 5 and DecPlaces to 1.
799
See Also
Trend Functions
TrnGetGatedValue
Returns the internally stored value for <GATED>. If the internally stored value changes in
the future, you will not need to modify your Cicode, as this function will return the correct
value.
Syntax
TrnGetGatedValue()
Return Value
The internally stored value for <GATED>.
Related Functions
TrnGetInvalidValue, TrnIsValidValue
Example
REAL MyTrendValue;
IF MyTrendValue = TrnGetGatedValue() THEN
Prompt ("This value is <GATED>")
ELSE
IF MyTrendValue = TrnGetInvalidValue() THEN
Prompt("This value is <TRN_NO_VALUES>")
ELSE
Prompt("Trend value is = " + RealToStr(MyTrendValue, 10, 1));
END
END
See Also
Trend Functions
TrnGetInvalidValue
Returns the internally stored value for <INVALID>. If the internally stored value changes
in the future, you will not need to modify your Cicode, as this function will return the cor-
rect value.
Syntax
TrnGetInvalidValue()
Return Value
The internally stored value for <INVALID>.
Related Functions
TrnGetGatedValue, TrnIsValidValue
800
Example
REAL newArray[100];
REAL oldArray[90];
INT trigger;
INT
FUNCTION
DoubleArray()
INT i;
FOR i = 0 TO 99 DO
IF TrnIsValidValue(oldArray[i]) = 1 OR trigger = 0 THEN
newArray[i] = TrnGetGatedValue();
ELSE
IF i >= 90 OR TrnIsValidValue(oldArray[i]) = 2 THEN
newArray[i] = TrnGetInvalidValue();
ELSE
newArray[i] = oldArray[i] * 2;
END
END
END
RETURN i;
END
See Also
Trend Functions
TrnGetMode
Gets the mode (real-time or historical trending) of the trend pen.
Syntax
TrnGetMode(AN, Pen)
AN:
Pen:
1...8 - Pen1. . .Pen8
Return Value
The current mode, 0 for real-time or 1 for historical.
Related Functions
TrnScroll
Example
INT Mode;
Mode=TrnGetMode(20,0);
! Gets the current mode of the pen in focus.
IF Mode=0 THEN
DspText(31,0,"Real Time Trending");
801
ELSE
DspText(31,0,"Historical Trending");
END
See Also
Trend Functions
TrnGetMSTime
Gets the time (in milliseconds from the previous midnight) of the trend (plotted by a spec-
ified pen) at a percentage along the trend, using the time and date of the right-most sample
displayed. The time associated with the right-most sample displayed is known as the end
time. The start time is the time of the left-most sample displayed. Percent 0 (zero) will cor-
respond to the end time, and Percent 100 will correspond to the start time
Syntax
TrnGetMSTime(AN, Pen, Percent)
AN:
Pen:
1...8 - Pen1. . .Pen8
Percent:
The percentage of the trend from the time and date of the right-most sample dis-
played (end time), from 0 to 100.
Return Value
The number of milliseconds since the previous midnight. Zero (0) is returned if an error is
detected.
802
Related Functions
TrnGetTime
Example
! For Pen 1 at AN20
STRING timeStr;
STRING msecStr;
timeStr = TimeToString(TrnGetTime(20,1,100),2) + " ";
msecStr = TimeToString(TrnGetMSTime(20,1,100),6);
DspText(31,0,timeStr + msecStr);
returns
"23/02/01 10:53:22.717"
See Also
Trend Functions
TrnGetPen
Gets the trend tag being plotted by a specified pen.
Syntax
TrnGetPen(AN, Pen [, Mode] )
AN:
Pen:
1...8 - Pen1. . .Pen8
Mode:
An optional argument used to specify whether the trend tag name is returned
with a cluster prefix. Set:
 0 return tag without cluster prefix (default)
 1 return tag with cluster prefix.
Return Value
The trend tag (as a string) being plotted by Pen. If AN or Pen is invalid, an empty string is
returned, and an error code is set. You can call the IsError() function to get the actual error
code.
Related Functions
TrnSetPen
803
Example
DspText(31,0,TrnGetPen(20,0,1));
! Displays the trend tag with cluster prefix of the focus pen.
See Also
Trend Functions
TrnGetPenComment
Retrieves the comment of a pen.
Syntax
TrnGetPenComment(AN, Pen)
AN
Pen:
1...8 - Pen1. . .Pen8
Return Value
The comment of the pen as a string.
Related Functions
TrnGetPen
Example
DspText(31,0,TrnGetPen(18,0));
! Displays the trend comment of the focus pen.
See Also
Trend Functions
TrnGetPenFocus
Gets the number of the pen currently in focus.
Syntax
TrnGetPenFocus(AN)
AN:
804
Return Value
The pen currently in focus (between 1 and 8). If AN is invalid, -1 is returned and an error
code is set.
Related Functions
TrnSetPenFocus
Example
DspText(31,0,TrnGetPenFocus(20));
! Displays the pen currently in focus.
See Also
Trend Functions
TrnGetPenNo
Gets the pen number of a pen name. The pens on a trend are either defined in the Page
Trends database or set by the TrnSetPen() function.
Syntax
TrnGetPenNo(AN, Tag)
AN:
Tag:
The trend tag.
Return Value
The pen number, or 0 (zero) if an error is detected.
Related Functions
TrnSetPen
Example
/* Assume that 8 trend fonts, Pen1TrendFont ... Pen8TrendFont are
defined in the Fonts database. The following code will display the
trend tag using the matching font for that pen. */
STRING sFont;
INT iPen;
iPen = TrnGetPenNo(20,"PV1");
IF 0 < iPen AND iPen < 9 THEN
sFont = "Pen" + IntToStr(iPen) + "TrendFont";
DspStr(31,sFont,"PV1");
END
805
See Also
Trend Functions
TrnGetPeriod
Gets the current display period of a trend. (To obtain the sampling period, use the TrnInfo
function.)
Syntax
TrnGetPeriod(AN)
AN:
Return Value
The current display period of a trend (in seconds), or 0 (zero) if an error is detected.
Related Functions
TrnSetPeriod, TrnInfo
Example
/* For the trend at AN20, get and display the current display
period. */
! If the period is 10 seconds
INT Period;
STRING Str;
Period=TrnGetPeriod(20);
Str=TimeToStr(Period,5);
DspStr(31,"",Str);
See Also
Trend Functions
TrnGetScale
Gets the display scale of the trend tag being plotted by a specified pen.
Syntax
TrnGetScale(AN, Pen, Percent)
AN:
Pen:
1...8 - Pen1. . .Pen8
Percent:
The percentage of the full scale, from 0 to 100.
806
Return Value
The scale of the trend tag being plotted by Pen. If AN or Pen is invalid, 0 (zero) is returned
and an error code is set.
Related Functions
TrnSetScale, TrnGetDefScale
Example
DspText(31,0,TrnGetScale(20,0,0));
! Displays the zero scale of the focus pen.
! Displays the 50% scale of the focus pen.
! Displays the full scale of the focus pen.
See Also
Trend Functions
TrnGetScaleStr
Gets the scale of the trend tag being plotted by a specified pen. The value is returned as a
formatted string using the pen’s format specification and (optionally) the engineering
units.
Syntax
TrnGetScaleStr(AN, Pen, Percent, EngUnits)
AN:
Pen:
1...8 - Pen1. . .Pen8
Percent:
The percentage of the full scale, from 0 to 100.
EngUnits:
Engineering units mode:
0 - Do not include the engineering units at the end of the formatted string.
1 - Include the engineering units at the end of the formatted string.
Return Value
The scale of the trend tag being plotted by Pen (as a string). If AN or Pen is invalid, <na> is
returned and an error code is set.
807
Related Functions
TrnGetScale
Example
DspText(31,0,TrnGetScaleStr(20,0,0,1));
/* Displays the zero scale of the focus pen. The scale displays as
a formatted string (including the engineering units). */
/* Displays the 50% scale of Pen2. The scale displays as a
formatted string (including the engineering units). */
/* Displays the full scale of the trend tag being plotted by the
focus pen. The scale displays as a formatted string (excluding the
engineering units). */
See Also
Trend Functions
TrnGetSpan
Gets the span time of a trend (if the span was set by the TrnSetSpan() function). The span
time is the total time displayed in the trend window.
Note: If you call the TrnSetPeriod() function after the TrnSetSpan() function, the span is au-
tomatically set to 0 (zero).
Syntax
TrnGetSpan(AN)
AN:
Return Value
The span time, in seconds. 0(zero) is returned if the AN is invalid or if the span was not set
by the TrnSetSpan() function.
Related Functions
TrnSetSpan, TrnGetPeriod, TrnSetPeriod
Example
// Use a keyboard command or button to set a span of 2 hours.
TrnSetSpan(40,StrToTime("2:00:00");
// Then use TrnGetSpan function to display the span
Time = TrnGetSpan(40)
DspText(31,0,TimeToStr(Time,5));
See Also
Trend Functions
808
TrnGetTable
This function allows you to tabulate values from a specific section of trend. The values in
the table (possibly an array variable) are arranged by time.
If the period (Period) is different to the trend’s sampling period (configured in the Trend
Tags database), the returned values are determined by DisplayMode.
is complete.
Syntax
TrnGetTable(Tag, Time, Period, Length, Table, DisplayMode, Milliseconds [, ClusterName] )
Tag:
Time:
The end time and date (long integer) of the desired trend section. Once you have
entered the end time and date (Time), period (Period), and number of trend tag
values collected (Length), the start time and date will be calculated automatically.
For example, if Time = StrToDate("18/12/96") + StrToTime("09:00"), Period = 30,
and Length = 60, the start time would be 08:30. In other words, the trend values
for the period between 8.30am and 9am (on December 18, 1996) would be tabu-
lated.
If this argument is set to 0 (zero), the time used will be the current time.
Period:
Length:
number of items in the table. This argument has a max of 4000 (in v6). Specifying
a length of greater than 4000 results in a return value of 0 and IsError()=274
(INVALID_ARGUMENT). This limitation can be configured using the citect.ini
parameter [Trend]MaxRequestLength.
Table:
DisplayMode:
tions you want to use from those listed below, adding their associated numbers
809

Display Mode is 258 (0 + 2 + 256).
Milliseconds:
This argument allows you to set your sample request time with millisecond pre-
cision. After defining the time and date in seconds with the Time argument, you
can then use this argument to define the milliseconds component of the time.
For example, if you wanted to request data from the 18/12/96, at 9am, 13 seconds,
and 250 milliseconds you could set the Time and Milliseconds arguments as fol-
lows:
Time = StrToDate("18/12/96") + StrToTime("09:00:13")
Milliseconds = 250
If you don’t enter a Milliseconds value, it defaults to 0 (zero). There is no range
constraint, but as there are only 1000 milliseconds in a second, you should keep
your entry between 0 (zero) and 999.
ClusterName:
Name of the cluster in which the trend tag resides. This is optional if you have
Return Value
The actual number of samples read. 0(zero) is returned if an error occurs. You can call the
IsError() function to get the actual error code.
Related Functions
TrnSetTable, TrnGetDisplayMode
Example
/* Defines an array of a maximum of 100 entries in which the trend
data is stored. */
TrnGetTable("OP1",StrToDate("18/12/91")
+StrToTime("09:00"),2,10,TrendTable1[0],0, "ClusterXYZ");
/* Stores the values of trend tag "OP1" in Table TrendTable1. Data
810
is stored at the following times:

18/12/91 09:00:00 TrendTable1[0]
08:59:58 TrendTable1[1]
08:59:56 TrendTable1[2]
...
18/12/91 08:59:42 TrendTable1[9] */
Average=TableMath(TrendTable1[0],100,2);
/* Gets the average of the trend data. */
See Also
Trend Functions
TrnGetTime
Gets the time and date of the trend (plotted by a specified pen) at a percentage along the
trend, using the time and date of the right-most sample displayed. The time associated with
the rightmost sample displayed is known as the end time. The start time is the time of the
left-most sample displayed. Percent 0 (zero) will correspond to the end time, and Percent
100 will correspond to the start time.
Syntax
TrnGetTime(AN, Pen, Percent)
AN:
Pen:
1...8 - Pen1. . .Pen8
Percent:
The percentage of the trend from the time and date of the right-most sample dis-
played (end time), from 0 to 100.
Return Value
A time/date variable. 0 (zero) is returned if an error is detected.
811
Related Functions
TrnSetTime
Example
DspText(31,0,TimeToStr(TrnGetTime(20,0,0),2));
! Displays the trend current date for the focus pen.
! Displays the trend current time for the focus pen.
! Displays the time 50% along the trend for the focus pen.
See Also
Trend Functions
TrnGetUnits
Gets the data units for the trend tag plotted by a specified Pen.
Syntax
TrnGetUnits(AN, Pen)
AN:
Pen:
1...8 - Pen1. . .Pen8
Return Value
The data units for the trend tag plotted by Pen, otherwise an empty string is returned, and
an error code is set. You can call the IsError() function to get the actual error code.
Related Functions
TrnGetFormat, TrnGetScale
Example
DspText(31,0,TrnGetUnits(20,0));
! Displays the data units for the focus pen.
See Also
Trend Functions
TrnInfo
Gets the configured values of a trend tag.
812
Syntax
TrnInfo(Tag, Type [, ClusterName] )
Tag:
The name of the trend tag enclosed in quotation marks "" (can be prefixed by the
name of the cluster that is ClusterName.Tag).
Type:
The type of information required:
1 - Trend Type
2 - Sample Period (to obtain the Display Period, use the TrnGetPeriod function)
3 - Trend File Name (without file extension)
4 - Area
5 - Privilege
6 - Current Event Number. Valid only for event type trends
7 - Engineering Units
8 - The storage method used for the tag. A returned value of 2 represents two byte
storage (scaled), 8 represents eight byte storage (floating point).
9 - The file period of the tag in seconds. If the file period is set to monthly or year-
ly, a file period cannot be calculated as months and years vary in length.
Therefore, a file period of 0 will be returned for trends with such file peri-
ods.
ClusterName:
Return Value
The value (as a string), otherwise an empty string is returned, and an error code is set. You
can call the IsError() function to get the actual error code.
Example
! Get the file name of trend tag LT131
sFileName = TrnInfo("LT131", 3, "ClusterXYZ");
See Also
Trend Functions
TrnIsValidValue
Determines whether a logged trend value is:
 <VALID> - an actual trend value;
 <GATED> - if a periodic trend has a trigger condition, and that condition is FALSE, a
standard substitute (or GATED) value is logged instead of the actual value; or
 <INVALID> - for some reason, no value was logged.
813
Syntax
TrnIsValidValue(TrendValue)
TrendValue:
A trend value (of type REAL).
Return Value
0 for <VALID>
1 for <GATED>
2 for <INVALID>
Related Functions
TrnGetGatedValue, TrnGetInvalidValue
Example
INT
FUNCTION
DoubleArray()
INT i;
FOR i = 0 TO 99 DO
IF TrnIsValidValue(oldArray[i]) = 1 OR trigger = 0 THEN
newArray[i] = TrnGetGatedValue();
Prompt ("This value is <GATED>");
ELSE
IF i >= 90 OR TrnIsValidValue(oldArray[i]) = 2 THEN
newArray[i] = TrnGetInvalidValue();
ELSE
newArray[i] = oldArray[i] * 2;
Prompt ("This value is <TRN_NO_VALUES>");
END
END
END
RETURN i;
END
See Also
Trend Functions
TrnNew
Creates a new trend at run time. This function performs the same operation as an entry in
the Page Trends database. After the trend is created by the TrnNew() function, all the other
trend functions can access and control the trend.
Syntax
TrnNew(AN, Trend [, Tag1 ... Tag8] [, ClusterName] )
AN:
The AN where the bottom right-hand corner of the trend is located.
Trend:
814
The trend definition number (as a STRING).

Tag1 . . .Tag8:
The trend tags. (These tags cannot be prefixed with cluster name, cluster should
be specified with the ClusterName argument).
ClusterName:
The name of the cluster in which all the trend tags reside. This is optional if you
have one cluster or are resolving the trends via the current cluster context. The
argument is enclosed in quotation marks "".
Return Value
Related Functions
TrnDelete
Example
TrnNew(20,"trn002","PV1","OP1", "ClusterXYZ");
/* Creates a new trend at AN20 using trend definition 2, plotting
"PV1" on Pen1 and "OP1" on Pen2. */
See Also
Trend Functions
TrnPlot
Prints the trend line of one or more trend tags. Each trend line is drawn with a different pen
style and marker as appropriate. The trend plot includes a comment and a legend, and you
can specify the vertical high and low scales. The Mode defines the color mode of the printer.
The default mode is black and white.
For more advanced trend plotting, you can use the low-level plot functions.
Syntax
TrnPlot(sPort, nSamples, iTime, rPeriod, sTitle, AN, Tag1......Tag8, iMode, sComment,
rLoScale1, rHiScale1, ......rLoScale8, rHiScale8)
sPort:
enclosed within quotation marks. For example LPT1:, to print to the local printer,
or \\Pserver\canon1 using UNC to print to a network printer.
nSamples:
The number of data points on the plot.
iTime:
The end point in time (the most recent point) for the trend plot.
rPeriod:
The period (in seconds) of the trend plot. This can differ from the actual trend pe-
riod.
815
If you do not enter a period, it defaults to the sample period of Tag1.

sTitle:
Tag1. . .Tag8:
The trend tags.
AN:
The AN of the chosen trend. If you enter 0 (zero), the display mode will default
to 258. (This is the display mode that is passed into TrnGetTable() when it is
called internally by TrnPlot().) If you call TrnPlot() from a report, you must enter
0 (zero) here.
iMode:
0 - Black and White
1 - Color
sComment:
The comment that is to display beneath the title of the trend plot. You may pass
an empty string if no comment is required.
rLoScale1, HiScale1,......LoScale8, HiScale8:
The minimum and maximum on the vertical scale for the trend line of each of the
tags (Tag1. . . Tag8).
Return Value
Related Functions
TrnComparePlot, TrnPrint, PlotOpen, SPCPlot
Example
/* Prints a black and white plot to LPT1, containing the trend
lines of two variable tags (PV1 & PV2). The trend lines have a
starting time of 9am, on 11/10/96, 200 sample points, and a period
of 2 seconds. The trend line of PV1 will be on a vertical scale of
0-200, and PV2 will be on a vertical scale of 0-400. */
INT time;
Time = StrToDate("11/10/96") + StrToTime("09:00:00");
TrnPlot("LPT1:",200,Time,2,"Citect Trend
Plot","PV1","PV2","","","","","","",0,"Process variable operation
at shutdown",0,200,0,400);
See Also
Trend Functions
TrnPrint
Prints the trend that is displayed on the screen (at AN) using the current display mode for
each trend. You can specify the trend title, the target printer, whether to print in color or
black and white, and whether to display the Plot Setup form when the function is called.
816
Syntax
TrnPrint(sPort, sTitle, AN, iModeColour, iDisplayForm)
sPort:
enclosed within quotation marks "". For example "LPT1:", to print to the local
printer, or "\\Pserver\canon1" using UNC to print to a network printer.
It is not necessary to enter a printer port. The first time the printer port is omitted,
you will be prompted to select one at the Printer Setup form. The selection you
make will then be used as the default.
sTitle:
The title to print at the top of the trend plot. If you do not specify a title in sTitle,
the page title will be used.
AN:
The AN where the trend plot is located.
iModeColour:
-1 - Color to be decided (Default). CitectSCADA refers to the [GENERAL]Print-
erColourMode parameter to determine print color. If there is no setting for
this parameter, it will default to black and white.
0 - Black and White
1 - Color
DisplayForm:
Defines whether or not the Plot Setup form will display when the function is
called. This form allows you to enter the color mode of the printer, and define the
printer setup etc. (See Printing Trend Data for more information on this form.)
-1 - CitectSCADA refers to the [GENERAL]DisablePlotSetupForm parameter to de-
termine if the form will display.
0 - Do not display form
1 - Display form
Return Value
Related Functions
TrnPlot, TrnComparePlot, WinPrint, SPCPlot
Example
TrnPrint("LPT1:","Test Print",40,0,0);
/* Prints the trend plot displayed at AN40, without prompting for
setup details.*/
See Also
Trend Functions
817
TrnSamplesConfigured
Gets the number of samples configured for the currently displayed trend.
Syntax
TrnSamplesConfigured(AN)
AN:
Return Value
The number of samples configured for the trend, or 0 (zero) if an error is detected. You can
Example
/* For the trend at AN20, get and display the number of samples */
INT nSamples;
nSamples=TrnSamplesConfigured(20);
DspStr(31,"",IntToStr(nSamples));
See Also
Trend Functions
TrnScroll
Scrolls the trend pen by a specified percentage (of span), or number of samples.
Syntax
TrnScroll(AN, Pen, nScroll [, nMode] )
AN:
The AN where the trend is located. Set to -1 for all trends on the current page.
Pen:
The trend pen number. Set to -1 for all pens.
nScroll:
The amount by which the trend will be scrolled. Use nMode to specify whether
the trend will be scrolled by percentage or by number of samples.
Because the resolution of Client requests is 1 second, requests of millisecond ac-
curacy are rounded to 1 second. For example, if requested to scroll 2 samples of
400 milliseconds (a total of 0.8 seconds), the trend will actually scroll 1 second.
nMode
The type of scrolling to be performed.
1 - The trend will be scrolled by a percentage of span. Default.
2 - The trend will be scrolled by a number of samples. This mode is not available
if the user puts the trend into the ’trend span’ mode by setting the span. In
this case no scrolling would take place; the user must use nMode 1.
818
Return Value
Related Functions
TrnSetTime
Example
! Scroll all pens (of the trend at an20) 100% forwards.
TrnScroll(20,-1,100); or TrnScroll(20,-1,100,1);
! Scrolls all pens (of all trends on the current trend page) 300% backwards.
TrnScroll(-1, -1, -300); or TrnScroll(20,-1.-300,1);
!Scrolls all pens (of all trends on the current trend page) 3 samples forwards.
TrnScroll(20,-1,3,2);
!Scrolls all pens (of all trends on the current trend page) 1 sample backwards.
TrnScroll(20,-1,-1,2);
See Also
Trend Functions
TrnSelect
Sets up a page for a trend. This function allows you to set up a trend before the trend page
is displayed. You can therefore use a single trend page to display any trend in the project
by selecting the trend first, and then displaying the trend page. The PageTrend() function
uses this function to display the standard trend pages.
Call this function and a set of TrnSetPen() functions before you display a trend page. When
the trend page is displayed, all pens set by the TrnSetPen() functions are displayed. You can
use the TrnSelect() function to configure different set of pens to be displayed on one generic
trend page. The pen settings in the Page Trend database are overridden.
Note: Trend functions used after the TrnSelect() function must use the special value -2 as
their AN. (See the example below).
Syntax
TrnSelect(Window, Page, AN [, ClusterName] )
Window:
The window number (returned from the WinNumber function).
-3 - for the current window.
-2 - for the next window displayed.
Page:
The name of the page that displays the trend.
AN:
The AN where the trend displays, or -3 for the first trend on the page.
ClusterName:
The name of the cluster that is associated with any trend tag for this trend graph.
This is optional if you have one cluster or are resolving the trend via the current
cluster context. The argument is enclosed in quotation marks "".
819
Return Value
Related Functions
TrnSetPen, PageTrend, WinNumber
Example
TrnSelect(WinNumber(), "TrendPage", 40, "ClusterXYZ");
TrnSetPen(-2,1,"PV1");
PageDisplay("TrendPage");
See Also
Trend Functions
TrnSetCursor
Moves the trend cursor by a specified number of samples. If the trend cursor is disabled,
this function enables it. If the cursor is enabled and the number of samples is 0 (zero), the
cursor is disabled. If the cursor is moved off the current trend frame, the trend scrolls.
Syntax
TrnSetCursor(AN, Samples)
AN:
Samples:
The number of samples to move the cursor.
Return Value
Related Functions
TrnGetCursorTime, TrnGetCursorValue, TrnGetCursorValueStr, TrnSetCursorPos
Example
TrnSetCursor(20,1);
! Moves the trend cursor forwards 1 sample.
TrnSetCursor(-1,-40);
! Moves the trend cursor (of all trends on the current trend page)
backwards 40 samples.
See Also
Trend Functions
820
TrnSetCursorPos
Moves the trend cursor to a specified x-axis point, offset from the trend cursor origin. If the
trend cursor is disabled, this function enables it. If the position is outside of the trend frame,
it sets the trend cursor to half of the frame.
Syntax
TrnSetCursorPos(AN, Position)
AN:
Position:
The x-axis point at which to position the trend cursor, offset from the trend cursor
origin.
Return Value
Related Functions
TrnGetCursorPos, TrnSetCursor
Example
! For the trend at AN20, if the trend frame is 400 points
TrnSetCursorPos(20,0);
! Moves the trend cursor to its origin.
TrnSetCursorPos(20,200);
! Moves the trend cursor to half of its frame size (200 points).
See Also
Trend Functions
TrnSetDisplayMode
Specifies how raw trend samples are displayed on the screen.
Syntax
TrnSetDisplayMode(AN, PenNumber, DisplayMode)
AN:
The animation number of the chosen trend.
PenNumber:
The pen number of the chosen trend. Specify:
0 - The current pen
1-8 - Pens 1 through 8
-1 - All pens
DisplayMode:
821
To calculate the integer you should enter, select the options you want to use from
the list below, adding their associated numbers together. The resulting integer is
the DisplayMode parameter for that trend.
Note: Options listed in each group are mutually exclusive. The default value for each Dis-
play Mode is 258 (0 + 2 + 256).
1048576 - display as periodic regardless of trend type.
Since the Display as Periodic options are read-only, they cannot be set using
TrnSetDisplayMode. They can be retrieved using TrnGetDisplayMode() and also
used with the TrnExport group of functions.
Return Value
Related Functions
TrnGetDisplayMode, TrnGetTable
See Also
Trend Functions
TrnSetEvent
Sets the start event of a trend pen. This function only operates on an event-based trend.
Syntax
TrnSetEvent(AN, Pen, Event)
AN:
822

Pen:
1...8 - Pen1. . .Pen8
Event:
The number of the start event.
Return Value
Related Functions
TrnGetEvent, TrnGetCluster, TrnGetCursorEvent
Example
! Sets pen1 to event number 123456
TrnSetEvent(20,1,123456);
! Scrolls pen1 back by 100 events
TrnSetEvent(20,1,TrnGetBufEvent(20,1,0)-100);
See Also
Trend Functions
TrnSetPen
Sets the trend tag of a trend pen. The trend pen changes to the specified tag and the trend
is refreshed. The trend pen must be in the operator’s area to be displayed. If outside of the
operator’s area, data is not displayed. You cannot mix periodic trends and event trends in
the same trend window.
Syntax
TrnSetPen(AN, Pen, Tag)
AN:
-1 - All trends on the current trend page.
-2 - The function being called is using the special AN setup by the TrnSelect()
function.
Pen:
The pen for which the trend tag will be changed.
-2 - The first available pen (This value is automatically changed to 0 for SPC
trends because they have only one pen per trend.)
-1 - All pens on the trend. (DO NOT USE for SPC trends.)
0 - The pen currently in focus.
1...8 - Pen1....Pen8
823
Tag:
The trend tag. If Tag = ! the pen is deleted.
Return Value
0 (zero) if successful, otherwise an error is returned. Note that if a mixture of periodic and
event trends is detected, the return value is 0 (zero), but the hardware alarm #329 is set.
Related Functions
TrnGetPen, TrnSelect
Example
TrnSetPen(20,1,"PV1");
! Sets the trend tag of Pen1 to "PV1".
See Also
Trend Functions
TrnSetPenFocus
Sets the focus to a specified pen. After the focus is set, the focus pen is used with other trend
functions.
Syntax
TrnSetPenFocus(AN, Pen)
AN:
Pen:
The trend pen:
-4 - Make the next pen the focus pen; do not skip blank pens.
-3 - Make the previous pen the focus pen; do not skip blank pens.
-2 - Make the next pen the focus pen; skip blank pens.
-1 - Make the previous pen the focus pen; skip blank pens.
0 - Do not change the focus pen.
1...8 - Change Pen1. . .8 to be the focus pen.
Return Value
The old pen focus number, or -1 if an error is detected. You can call the IsError() function
to get the actual error code.
Related Functions
TrnGetPenFocus
824
Example
System Keyboard
Key Sequence NextPen
Command TrnSetPenFocus(20, -2)
Comment For the trend at AN20, make the next pen the focus pen
See Also
Trend Functions
TrnSetPeriod
Sets the display period (time base) of a trend. When the period is changed, CitectSCADA
reads the historical data to reconstruct the trend data, and refreshes the trend. All pens
have the same display period.
This function clears the span set by the TrnSetSpan() function.
Syntax
TrnSetPeriod(AN, Period)
AN:
Period:
The new sampling period (in seconds) of the trend. To set the display period to
the sampling period, set this argument to 0 (zero),
Return Value
Related Functions
TrnGetPeriod, TrnEcho, TrendSetTimebase, TrendSetSpan
Example
System Keyboard
Key Sequence ## Enter
Command TrnSetPeriod(20, Arg1)
Comment Set a new sampling period for the trend at AN20
See Also
Trend Functions
TrnSetScale
Sets a new scale for a trend pen. In the automatic scaling mode, the zero and full scales are
automatically generated.
Syntax
TrnSetScale(AN, Pen, Percent, Scale)
825
AN:
Pen:
-1 - All pens
1...8 - Pen1...Pen8
Percent:
The scale mode:
-2 - Set both zero and full scales to the default scales.
-1 - Place the trend into automatic scale mode.
0 - Set the zero scale.
100 - Set the full scale.
Scale:
The new value of the scale. Scale is ignored if Percent is -2.
Return Value
Related Functions
TrnGetScale, TrnEcho, TrnSetScale
Example
TrnSetScale(20,-1,100,5000.0);
! Sets the full scale of all pens to 5000.0
See Also
Trend Functions
TrnSetSpan
Sets the span time of a trend. The span time is the total time displayed in the trend window.
You can set the period to contain fractions of a second. For example, if you set a trend with
240 samples to a span of 10 minutes, then each sample would be 2.5 seconds. Choose a span
long enough to provide a sufficient sample rate to capture accurate real time data.
Syntax
TrnSetSpan(AN, Span)
AN:
Span:
The span time (in seconds).
826
Return Value
Related Functions
TrnSetPeriod, TrnGetSpan, TrnSetSpan
Example
// Set a span of 2 hours.
TrnSetSpan(40,StrToTime("2:00:00"));
// Then use TrnGetSpan function to display the span
Time = TrnGetSpan(40);
DspText(31,0,TimeToStr(Time,5));
See Also
Trend Functions
TrnSetTable
Writes trend tag data from a table to the trend logging system (starting at the top of the ta-
ble, and continuing to the bottom). Each value is written with a time and date, as specified
by Period. If Period differs from the trend sampling period (defined in the Trend Tags data-
base), the trend’s sample values will be calculated (averaged or interpolated) from the tab-
ulated trend data.
The user must have the correct privilege (as specified in the database), otherwise the data
is not written.
is complete.
Syntax
TrnSetTable(Tag, Time, Period, Length, Table, Milliseconds [, ClusterName] )
Tag:
Time:
The time and date (long integer) to be associated with the first value in the table
when it is set. Once you have entered the end time and date (Time), set period
(Period), and number of trend tag values to be set (Length), the start time and
date will be calculated automatically. For example, if Time = StrToDate("18/12/
96") + StrToTime("09:00"), Period = 30, and Length = 60, the start time would be
08:30. In other words, the first value from the table would be set with time 9am,
and the last would be set with time 8.30am (on December 18, 1996).
If this argument is set to 0 (zero), the time used will be the current time.
Period:
This will be the interval (in seconds) between trend values when they are set (that
is it will be the perceived sampling period for the trend). This period can differ
from the actual trend period. Set to 0 (zero) to default to the actual trend period.
827
Length:
The number of trend values in the trend table.
Table:
The table of floating-point values in which the trend data is stored. You can enter
the name of an array here (see the example).
Milliseconds:
This argument allows you to set the time of the first sample in the table with mil-
lisecond precision. After defining the time and date in seconds with the Time ar-
gument, you can then use this argument to define the milliseconds component of
the time.
For example, if you wanted to set data from the 18/12/96, at 9am, 13 seconds, and
250 milliseconds you could set the Time and Milliseconds arguments as follows:
Time = StrToDate("18/12/96") + StrToTime("09:00:13")
Milliseconds = 250
If you don’t enter a milliseconds value, it defaults to 0 (zero). There is no range
constraint, but as there are only 1000 milliseconds in a second, you should keep
your entry between 0 (zero) and 999.
ClusterName:
Return Value
Related Functions
TrnGetTable
Example
/* Defines an array of a maximum of 100 entries. Assume that
TrendTable1 has been storing data from a source. */
TrnSetTable("OP1",StrToDate("18/12/91")
+StrToTime("09:00"),2,10,TrendTable1[0], "ClusterXYZ");
/* A set of 10 trend data values are set for the OP1 trend tag. */
See Also
Trend Functions
TrnSetTime
Sets the end time and date of a trend pen. If you set a time less than the current time, the
trend display is set to historical mode and samples taken after this time and date will not
be displayed. If you set the time to the current time, for example by using the TimeCurrent
or TrendZoom cicode functions, the trend is displayed in real-time mode and samples after
this date and time will display.
828
Syntax
TrnSetTime(AN, Pen, Time)
AN:
The AN where the trend is located, or:
-1 - All trends on the current page
0 - The trend where the cursor is positioned
Pen:
-1 - All pens
1...8 - Pen1. . .Pen8
Time:
The end time and date of the trend. Samples taken after this time and date will
not be displayed. Set to 0 (zero) to set the trend to the current time (real-time
mode).
Return Value
Related Functions
TrnGetTime, TrnSetTime
Example
TrnSetTime(20,1,TimeCurrent()-60*30);
/* Sets Pen1 to 30 minutes before the current time (30 minutes ago). */
TrnSetTime(20,1,0);
/* Sets the trend to real-time mode. */
See Also
Trend Functions
829
830
Chapter: 53 Window Functions
Window functions control the display of windows. You can open, move, size, activate, and
de-activate windows. You can also specify titles for your windows.
Window Functions
Following are functions relating to Windows:
GetWinTitle Returns the name of the active window as a string.
HtmlHelp Invokes the Microsoft HTML Help application
WinCopy Copies the active window to the Windows clipboard.
WinFile Writes the active window to a file.
WinFree Removes a display window.
WinGetFocus Gets the number of the CitectSCADA window that has the keyboard
focus.
WinGetWndHnd Gets the window handle for the current window.
WinGoto Changes the active window.
WinMode Sets the display mode of the active window.
WinMove Moves the active window.
WinNew Opens a display window.
WinNewAt Opens a display window at specified coordinates.
WinNext Makes the next window active.
WinNumber Gets the window number of the active CitectSCADA window.
WinPos Positions a window on the screen.
WinPrev Makes the previous window active.
WinPrint Prints the active window.
WinPrintFile Prints a file to the printer.
WinSelect Selects a window for Cicode output.
WinSize Sizes a window.
WinStyle Switches on and off scrolling and scroll bar features for existing win-
dows.
WinTitle Sets the title of the active window.
WndFind Gets the Windows number of any window in any application.
WndGetFileProfile Gets a profile string from any .INI file.
WndGetProfile This function is obsolete from this version of the product.
WndHelp Invokes the Windows Help application.
WndInfo Gets the Windows system metrics information.
WndPutFileProfile Puts a profile string into any .INI file.
WndPutProfile This function is obsolete from this version of the product.
WndShow Sets the display mode of any window of any application.
WndViewer Invokes the Windows Multimedia application.
831
See Also
Functions Reference
GetWinTitle
Returns the name of the active window as a string.
Note: This function is unavailable in the Web Client.
Syntax
GetWinTitle()
Return Value
The title of the active window as a string if successful; otherwise, an error is returned.
Related Functions
WinTitle
See Also
Window Functions
HtmlHelp
Invokes the Microsoft HTML Help application (hh.exe) to display a specific topic from a
specific HTML help file (.chm).
Syntax
HtmlHelp(sHelpFile, nCommand, sData)
sHelpFile:
The help file to display. For example: "C:\Program Files\Citect\CitectSCADA
7.10\bin\CitectSCADA.chm"
nCommand:
The type of help:
0 - Display a topic identified by an internal file name in the sData field. This is the
name of the file within the .chm file. For example:
"CitectSCADA_Help_Overview.html"
1 - Display a topic identified by the Mapped Topic ID in the sData field. For ex-
ample: "1000"
2 - Terminate the help application
3 - Display the index
sData:
Optional data, depending on the value of nCommand. See above.
Return Value
832
Related Functions
WndHelp
Example
The following example displays the overview page of the CitectSCADA help:
HtmlHelp("C:\Program
Files\Citect\CitectSCADA 7.10\bin\CitectSCADA.chm", 0,
"CitectSCADA_Help_Overview.html");
See Also
Window Functions
WinCopy
Copies the graphics image of the active window to the Windows Clipboard. You can paste
this Clipboard image into other applications.
Notes:
 This function might not work as expected if called directly from the Kernel; instead, this
function should be called from a graphics page.
Syntax
WinCopy( [xScale] [, yScale] [, bSwapBlackWhite] [, fromColor] [, toColor] [, sMap] )
xScale:
The x scaling factor for the item being copied. This argument is optional, as a de-
fault setting of 1 is used to maintain the current horizontal scaling of the image.
The outcome is proportional to 1; for example, 0.5 halves the width of the image.
yScale:
The y scaling factor for the item being copied. This argument is optional, as a de-
fault setting of 1 is used to maintain the current vertical scaling of the image. The
outcome is proportional to 1; for example, 0.5 halves the height of the image.
bSwapBlackWhite:
Swaps the colors black and white for the purpose of printing pages with a lot of
black content. Use the value of 1 to swap black and white. default is 0 (optional).
fromColor
The hex RGB color value (0xRRGGBB) to change into toColor. The default value
of -1 results in no color change (optional).
toColor
The hex RGB color value (0xRRGGBB) into which fromColor is changed. The de-
fault value of -1 results in no color change (optional).
Note: To change a color, a value must be specified for both fromColor and toColor.
sMap:
833
The file name or path of a text based map file used to specify colours to swap
when printing. By default Citect will look in the bin directory for the map file. The
format for the map file is:
RRR1 GGG1 BBB1 RRR2 GGG2 BBB2 [HHH] [SSS] [LLL]
Where:
RRR1, GGG1 and BBB1 are decimal values for red, green and blue in the range 000
to 255. They specify the color to change FROM.
to 255. They specify the color to change TO.
HHH, SSS and LLL are optional tolerance values to enable swapping a range of
colors. The tolerance values are applied to the FROM color when replacing indi-
vidual pixels in the image. Default values are shown below.
HHH is a decimal value representing the Hue tolerance. Valid range is 0 to 360.
Default = 0.
SSS is a decimal value representing the Saturation tolerance. Valid range is 0 to
255. Default = 2 * Hue tolerance.
LLL is a decimal value representing the Luminance tolerance. Valid range is 0 to
Leading zeros are not required, however they aid readability.
Comments may be placed at the end of each line, or on individual lines, and must
be proceeded with // or !.
Example map file:
043 043 255 155 205 255 025 000 025 //Change dark blue to light blue using Hue and
Luminance tolerance of 25
000 000 000 255 255 255 //Swap black to white with no tolerance
Note: A Hue tolerance range cannot overlap with another specified Hue, or Hue tolerance
range. If this occurs, there is a possibility that the color will not be swapped.
Return Value
Related Functions
WinPrint
Example
WinCopy();
! Copies the active window to the Windows Clipboard.
WinCopy(0.5,0.5);
! Copies the active window to the Windows Clipboard at half the
current size.
See Also
Window Functions
WinFile
834
Writes the graphics image of the active window to a file. The file is saved in the CitectSCA-
DA compressed .bmp format.
Notes:
Syntax
WinFile(sFile [, xScale] [, yScale] [, bSwapBlackWhite] [, fromColor] [, toColor] [, sMap] )
sFile:
The name of the file to be created.
xScale:
The x scaling factor for the item being printed. This argument is optional, as a de-
fault setting of 1 is used to maintain the horizontal scaling of the image. The out-
come is proportional to 1; for example, 0.5 halves the width of the image .
yScale:
The y scaling factor for the item being printed. This argument is optional, as a de-
fault setting of 1 is used to maintain the current vertical scaling of the image. The
outcome is proportional to 1; for example, 0.5 halves the height of the image.
bSwapBlackWhite:
black content. The value of 1 swaps black and white. Default is 0 (optional).
fromColor:
toColor:
sMap:
when printing. By default Citect will look in the bin directory for the map file. The
format for the map file is:
Where:
835
Default = 0.
Example map file:
Return Value
Related Functions
WinPrint
Example
WinFile("DUMP");
/* Writes the active window to a file named DUMP in the current
directory. */
See Also
Window Functions
WinFree
Removes the active display window. Be aware that the last window (and any child win-
dows owned by the last window) cannot be removed. You cannot call this function as an
exit command (see Page Properties) or from a Cicode Object.
Notes
 This function cannot be used in the CitectSCADA Web Client.
Syntax
WinFree()
Return Value
836
Related Functions
WinNew, WinNewAt
Example
WinFree();
! Removes the active display window.
See Also
Window Functions
WinGetFocus
Gets the number of the CitectSCADA window that has the keyboard focus.
Syntax
WinGetFocus()
Return Value
The window number of the CitectSCADA window that has the keyboard focus. Note that
this is not the same as the window handle, returned from the WndFind() function.
Related Functions
WndFind
Example
nCitectWin=WinGetFocus();
! Gets the number of the CitectSCADA window that has
the keyboard focus
See Also
Window Functions
WinGetWndHnd
Gets the window handle for the current window. The window handle may be used by ’C’
programs and CitectSCADA Wnd... functions. You may pass the windows handle to a ’C’
program by using the DLL functions.
Syntax
WinGetWndHnd()
Return Value
The window handle if successful, otherwise 0 (zero) is returned. Note that this is not the
same as a CitectSCADA window number returned from the WinNumber() function.
837
Related Functions
DLLCall, WinNew, WndFind, WndShow
Example
INT hWnd;
hWnd = WinGetWndHnd();
WinShow(hWnd,6); //iconize the window
See Also
Window Functions
WinGoto
Changes the active window. The specified window is placed in front of all other windows
and all keyboard commands will apply to this window. You cannot call this function as an
exit command (see Page Properties) or from a Cicode Object.
Syntax
WinGoto(Window)
Window:
The window number (returned from the WinNumber() function). Note that this
is not the same as the window handle, returned from the WndFind() function.
Return Value
Related Functions
WinNew
Example
! If two windows are displayed;
WinGoto(1);
! Changes the active window to Window 1.
WinGoto(0);
! Changes the active window to Window 0.
See Also
Window Functions
WinMode
Sets the display mode of the active CitectSCADA window.
838
Syntax
WinMode(Mode)
Mode:
The mode:
0 - Hide the window.
2 - Activate the window in an iconized state.
3 - Activate the window in a maximized state.
4 - Display the window in its previous state without activating it.
5 - Activate the window in its current state.
6 - Iconize the window.
7 - Display the window in an iconized state without activating it.
8 - Display the window in its current state without activating it.
9 - Activate the window in its previous state.
Return Value
Related Functions
WinNew
Example
! Iconize the active CitectSCADA window.
WinMode(7);
See Also
Window Functions
WinMove
Moves the active window to a new location and sizes the window in a single operation.
This is the same as calling the WinPos() and the WinSize() functions. You use PageInfo to
get the current window position.
Notes
 This function cannot be used in the CitectSCADA Web Client.
Syntax
WinMove(X, Y, Width, Height)
X, Y:
The new x and y pixel coordinates of the top-left corner of the active window.
839
Width:
The width of the window, in pixels.
Height:
The height of the window, in pixels.
Return Value
Related Functions
WinSize, WinPos, PageInfo
Example
WinMove(100,50,500,300);
/* Moves the top-left corner of the active window to the pixel
coordinate 100,50 and size the window to 500 x 300 pixels. */
See Also
Window Functions
WinNew
Opens a new display window, with a specified page displayed. The window can later be
destroyed with the WinFree() function.
You can also specify if the displayed page operates within the context of a particular cluster
in a multiple cluster project. When the page is displayed during runtime, the ClusterName
argument is used to resolve any tags that do not have a cluster explicitly defined.
Syntax
WinNew(Page,ClusterName)
Page:
ClusterName:
The name of the cluster that will accommodate the page at runtime. This is op-
tional if you have one cluster or are resolving the page via the current cluster con-
text. The argument is enclosed in quotation marks "". If the Page parameter is
prefixed with the name of a cluster, this parameter will not be used.
Return Value
The window number of the window, or -1 if the window cannot be opened. Note that this
is not the same as the window handle returned from the WndFind() function.
840
Related Functions
WinFree, WinNewAt
Example
! If the display window being opened is window number 2:
Window=WinNew("Alarm");
! Displays the Alarm page and sets Window to 2.
See Also
Window Functions
WinNewAt
Opens a new display window at a specified location, with a selected page displayed. The
window can later be destroyed with the WinFree() function.
You can also specify if the displayed page operates within the context of a particular cluster
in a multiple cluster project. When the page is displayed during runtime, the ClusterName
argument is used to resolve any tags that do not have a cluster explicitly defined.
Syntax
WinNewAt(Page, X, Y, Mode, ClusterName)
Page:
X:
The x pixel coordinate of the top left corner of the window.
Y:
The y pixel coordinate of the top left corner of the window.
Mode:
0 - Normal page.
tive window.
841

sized.
64 - Always on top.
4096 - Allows the window to be resized without maintaining the current aspect
ratio. The aspect ratio defines the relationship between the width and the
height of the window, which means this setting allows you to stretch or
compress the window to any proportions. This option overrides the setting
of the [Page]MaintainAspectRatio parameter.
8192 - Text on a page will be resized in proportion with the maximum scale
change for a resized window. For example, consider a page that is resized
to three times the original width, and half the original height. If this mode
is set, the font size of the text on the page will be tripled (in proportion with
the maximum scale). This option overrides the setting of the [Page] Scale-
TextToMax parameter.
16384 - Hide the horizontal scroll bar.
32768 - Hide the vertical scroll bar.
65536 - Disable horizontal scrolling.
131072 - Disable vertical scrolling.
icons).
ClusterName:
The name of the cluster that will accommodate the page at runtime. This is op-
tional if you have one cluster or are resolving the page via the current cluster con-
text. The argument is enclosed in quotation marks "". If the Page parameter is
prefixed with the name of a cluster, this parameter will not be used.
Return Value
The window number of the window, or -1 if the window cannot be opened. Note that this
is not the same as the window handle returned from the WndFind() function.
Related Functions
WinFree, WinNew
842
Example
Buttons
Text Mimic Page
Command WinNewAt("Mimic", 100, 20, 0)
Comment Display the mimic page in a new window at coordinate 100, 20.
Buttons
Text Pop Page
Command WinNewAt("Popup", 100, 200, 2)
Comment Display the popup page in a child window at coordinate 100, 200
Buttons
Text Pop Page
Command WinNewAt("Popup", 100, 200, 4)
Comment Display the popup page in a new window with no maximize and minimize
icons
System Keyboard
Key Sequence Pop ######## Enter
Command WinNewAt(Arg1, 100, 200, 2)
Comment Display a specified popup page in a child window at coordinate 100, 200
System Keyboard
Key Sequence Pop ######## Enter
Command WinNewAt(Arg1, 100, 200, 4)
Comment Display a specified popup page in a new window with no maximize and
minimize icons
See Also
Window Functions
WinNext
Makes the next window (in order of creation) active.
Syntax
WinNext()
Return Value
The window number of the window, or -1 if there is no next window. Note that this is not
the same as the window handle returned from the WndFind() function.
Related Functions
WinNew, WinPrev
Example
! If the display window being made active is window number 2:
Window=WinNext();
! Makes the next window active and sets Window to 2.
843
See Also
Window Functions
WinNumber
Gets the window number of the active CitectSCADA window. This number can be used
with other functions to control the window.
Syntax
WinNumber()
Return Value
The window number of the window. Note that this is not the same as the window handle
returned from the WndFind() function.
Related Functions
WinNew, WinGoto
Example
! Create a new window, but keep the active window the same:
Window=WinNumber();
WinNew("Alarm");
WinGoto(Window);
See Also
Window Functions
WinPos
Moves the active window to a new location. You use PageInfo() to get the current window
position.
Syntax
WinPos(X, Y)
X, Y:
The new x and y pixel coordinates of the top-left corner of the active window.
Return Value
Related Functions
WinSize, WinMove, PageInfo
844
Example
WinPos(100,50);
/* Moves the top-left corner of the active window to the pixel
coordinate 100,50. */
See Also
Window Functions
WinPrev
Makes the previous window (in order of creation) active.
Syntax
WinPrev()
Return Value
The window number of the window, or -1 if there is no next window. Note that this is not
the same as the window handle returned from the WndFind() function.
Related Functions
WinNext
Example
! If the display window being made active is window number 2:
Window=WinPrev();
! Makes the previous window active and sets Window to 2.
See Also
Window Functions
WinPrint
Sends the graphics image of the active window to a printer.
Notes:
Syntax
WinPrint(sPort [, xScale] [, yScale] [, bSwapBlackWhite] [, fromColor] [, toColor] [, sMap] )
sPort:
The name of the printer port to which the window will be printed. This name
must be enclosed within quotation marks "". For example "LPT1:", to print to the
sPort may not contain spaces.
845
xScale:
The x scaling factor for the print. The default value of 0 (zero) automatically scales
the print to fit the page. A value of 1 is used to maintain the current horizontal
scaling of the image. The outcome is proportional to 1; for example, 0.5 halves the
width of the image (optional).
yScale:
The y scaling factor for the print. The default value of 0 (zero) automatically scales
bSwapBlackWhite:
black content. Use the default value of 1 to swap black and white (optional).
fromColor
toColour
sMap:
when printing. By default CitectSCADAwill look in the bin directory for the map
file. The format for the map file is:
Where:
Default = 0.
Example map file:
846
Return Value
Related Functions
WinPrintFile
Example
WinPrint("LPT3:",0,0,0);
! Prints the active window on printer "LPT3". The print will be
scaled to fit the largest possible page area and will retain the
orientation of the printer, aspect ratio and colors that are
displayed on screen.
WinPrint("LPT3:");
!Prints the page as in the first example, but swaps black and
white on the printout.
WinPrint("LPT3:",0,0,0,0x00FF00,0xFF0000);
!Changes green to red.
WinPrint("LPT3:",0,0,1,0x00FF00,0xFF0000);
!Changes green to red and black to white.
See Also
Window Functions
WinPrintFile
Prints a file to the system printer. The file must be saved with the WinFile() function.
Note: This function might not work as expected if called directly from the Kernel; if the
WinFile function fails, WinPrintFile either doesn’t print anything or prints a previously
saved page. This function should be called from a graphics page.
Syntax
WinPrintFile(sFile, sPort [, xScale] [, yScale] [, bSwapBlackWhite] [, fromColor] [, toColor] )
sFile:
The file name.
sPort:
The name of the printer port to which the window will be printed. This name
must be enclosed within quotation marks "". For example "LPT1:", to print to the
sPort may not contain spaces
847
xScale:
The x scaling factor for the print. The default value of 0 (zero) automatically scales
yScale:
The y scaling factor for the print. The default value 0 (zero) automatically scales
bSwapBlackWhite:
black content. Use the default value of 1 to swap black and white (optional).
fromColor
toColor
Return Value
Related Functions
WinPrint
Example
! Save image to disk then print.
WinFile("temp");
WinPrintFile("temp", "LPT3:",0,0,0);
! Prints the file "temp" on printer "LPT3". The print will be
scaled to fit the largest possible page area and will retain the
orientation of the printer, aspect ratio and colors that are
displayed on screen.
WinPrintFile("temp","LPT3:");
! Prints the page as in the first example, but swaps black and
white on the printout.
WinPrintFile("temp","LPT3:",0,0,0,0x00FF00,0xFF0000);
! Changes green to red.
WinPrintFile("temp","LPT3:",0,0,1,0x00FF00,0xFF0000);
! Changes green to red and black to white.
Window Functions
WinSelect
Selects a window to make active. This function only affects the output of Cicode functions.
It does not change the screen focus of the windows, or move a background window to the
foreground.
848
Always re-select the original window if it is called from a Page database (Page Numbers,
Page Symbols, and so on), because other Cicode tasks will assume it is the correct window.
This function only changes the active window for the Cicode task that called it.
Syntax
WinSelect(Window)
Window:
The window number to select. Note that this is not the same as the window han-
dle returned from the WndFind() function.
Return Value
The old window number.
Related Functions
WinGoto, WinNumber
Example
OldWindow=WinSelect(1);
! Selects window number 1.
Prompt("Message to Window 1");
! Sends message to window number 1.
WinSelect(2);
! Selects window number 2.
Prompt("Message to Window 2");
! Sends message to window number 2.
WinSelect(OldWindow);
! Selects original window.
See Also
Window Functions
WinSize
Sizes the active window. The origin of the window does not move.
Syntax
WinSize(Width, Height)
Width, Height:
The new width and height of the window, in pixels.
Return Value
849
Related Functions
WinMove, WinPos
Example
WinSize(200,100);
! Sizes the active window to 200 pixels wide x 100 pixels high.
See Also
Window Functions
WinStyle
Switches on and off scrolling and scrollbar features for existing windows.
Syntax
WinStyle(Style, Mode)
Style:
One of the following:
1 - Hide horizontal scroll bars.
2 - Hide vertical scroll bars.
3 - Disable horizontal scrolling.
4 - Disable vertical scrolling.
Mode:
The mode of the option:
0 - Turn option off.
1 - Turn option on.
Return Value
Related Functions
WinNewAt
Example
To turn horizontal and vertical scroll bars off for the current window:
WinStyle(1, 1);
WinStyle(2, 1);
See Also
Window Functions
WinTitle
Sets the title of the active window.
850
If a window title has been set with the [Page]WinTitle parameter, CitectSCADA uses this
title when it refreshes the page (overriding the window title set with the WinTitle() func-
tion). To prevent CitectSCADA from overriding the title, set the parameter [Page]WinTitle
to *.
Syntax
WinTitle(sTitle)
sTitle:
The new title for the window.
Return Value
Related Functions
WinNew, GetWinTitle
Example
WinTitle(Time()+" "+Date());
! Places the current time and date into the window title.
See Also
Window Functions
WndFind
Gets the Windows handle of any window of any application, so that the window can be
manipulated. The window handle is not the same as the CitectSCADA window number
and cannot be used with functions that expect the CitectSCADA window number (the
Win... functions).
The window title (caption) must be an exact match of the window name (including any
blank spaces) for this function to find the window. You should therefore check that the oth-
er application does not change the title of the window during execution.
Note that if the title banner of a CitectSCADA window is set with the CitectSCADA param-
eter [Page] WinTitle, you should not specify justification (for example, use {TITLE,32,N}).
If justification is not disabled (that is the N is omitted), you must pass the full title of the
window (including leading and trailing blanks) to this function.
Syntax
WndFind(sTitle)
sTitle
The title (caption) of the window.
Return Value
The window handle. Note that this is not the same as a CitectSCADA window number re-
turned from the WinNumber() function.
851
Related Functions
WinNew
Example
hWndExcel=WndFind("Microsoft Excel - Book1");
! Gets the Windows number of the window titled "Microsoft Excel -
Book1"
See Also
Window Functions
WndGetFileProfile
Gets a profile string from any .ini file.
Syntax
WndGetFileProfile(sGroup, sName, sDefault, sFile)
sGroup:
The name of the [group].
sName:
The name of the variable.
sDefault:
The default value.
sFile:
The .ini file name.
Return Value
The profile string from sFile.
Related Functions
WndPutFileProfile
Example
! get this user startup page from USER.INI File
sStartup =
WndGetFileProfile(Name(),"Startup","menu","[Run]:\USER.INI");
PageDisplay(sStartup);
See Also
Window Functions
WndHelp
Invokes the Windows Help application (WinHlp32.EXE) to display a specific topic from a
specific help file.
852
Syntax
WndHelp(sHelpFile, Command, Data)
sHelpFile:
The help file to display.
Command:
The type of help:
1 - Displays the help topic identified by the context string/number in the Data
field. The context string/number must be defined in the [MAP] section of
the help’s .HPJ file.
2 - Closes the Help application. Enter an empty string for the Data argument.
3 - Displays the help contents topic defined by the CONTENTS option in the [OP-
TIONS] section of the .HPJ file.
4 - Displays the contents topic of the designated How to Use Help file. The context
string/number (specified in the Data field) must be defined in the [MAP]
section of the .HPJ file.
5 - Changes the current help contents topic to match the context string/number
specified in the Data field. This topic is used instead of the one defined by
the CONTENTS option in the [OPTIONS] section of the .HPJ file. NOTE:
This will affect Command 3 (see above). The context string/number must
be defined in the [MAP] section of the help’s .HPJ file, and the help file
must already be open. The change will last only until the help file is closed.
8 - Displays, in a pop-up window, the help topic identified by the context string/
number in the Data field. The context string/number must be defined in the
[MAP] section of the .HPJ file.
9 - Tests that the correct help file is displayed. If the correct help file is currently
displayed, this command merely makes the help the active window. If the
incorrect help file is displayed, WinHelp opens the correct file, and dis-
plays the help contents topic defined by the CONTENTS option in the [OP-
TIONS] section of the .HPJ file.
Note: This command will not distinguish between two files of the same name, regardless
of their paths.
11 - Displays the CitectSCADA Help Topics with either the Contents, the Index,
or the Find tab selected, depending on which one was last used. Enter an
empty string for the Data argument.
257 - Searches the help index for your keyword (as specified in the Data field) and
displays the first topic in the index with an identical match. If there is no
match, displays the index with your keyword already entered. To display
the index without passing a keyword, enter an empty string for the Data
argument.
258 - Executes the Help macro string specified in the Data field. Help must be run-
ning and the help file must be open, or the message is ignored.
260 - Displays, in a pop-up window, the help topic identified by the context
string/number in the Data field.
261 - Searches the help index for your keyword (as specified in the Data field) and
displays the first topic in the index with an identical match. If there is no
853
match, displays the index with your keyword already entered. To display
the index without passing a keyword, enter an empty string for the Data
argument.
Data:
The context string/number or keyword of the help topic that is requested.
Return Value
Related Functions
WndViewer
Example
WndHelp("MyHelp.HLP", 3, 1);
! Displays the "MyHelp" Contents page.
WndHelp("C:\Help\Process.HLP", 8, 239);
! Displays topic labelled "239" in the "Process" help file.
See Also
Window Functions
WndInfo
Gets information on the window system (such as the widths and heights of the various el-
ements displayed by Windows). WndInfo() can also return flags that indicate whether the
current version of the Windows operating system is a debugging version, whether a mouse
is present, or whether the functions of the left and right mouse buttons have been ex-
changed.
Syntax
WndInfo(Type)
Type:
The system measurement to be retrieved. All measurements are in pixels. The
system measurement must be one of the following values:
0 - Width of the screen.
1 - Height of the screen.
2 - Width of the arrow bitmap on a vertical scroll bar.
3 - Height of the arrow bitmap on a horizontal scroll bar.
4 - Height of the window title. This is the title height plus the height of the win-
dow frame that cannot be sized (SM_CYBORDER).
5 - Width of the window frame that cannot be sized.
6 - Height of the window frame that cannot be sized.
7 - Width of the frame when the window has the WS_DLGFRAME style.
8 - Height of the frame when the window has the WS_DLGFRAME style.
9 - Height of the scroll box on vertical scroll bar.
854
10 - Width of the scroll box (thumb) on horizontal scroll bar.

12 - Height of the icon.
13 - Width of the cursor.
14 - Height of the cursor.
15 - Height of a single-line menu bar. This is the menu height minus the height of
the window frame that cannot be sized (SM_CYBORDER).
16 - Width of the window client area for a full-screen window.
17 - Height of the window client area for a full-screen window (equivalent to the
height of the screen minus the height of the window title).
18 - Height of a Kanji window.
19 - Non-zero if the mouse hardware is installed.
20 - Height of arrow bitmap on a vertical scroll bar.
21 - Width of arrow bitmap on a horizontal scroll bar.
22 - Non-zero if the Windows version is a debugging version.
23 - Non-zero if the left and right mouse buttons are swapped.
24-27 - Not Used
28 - Minimum width of the window.
29 - Minimum height of the window.
30 - Width of bitmaps contained in the title bar.
31 - Height of bitmaps contained in the title bar.
32 - Width of the window frame that can be sized.
33 - Height of the window frame that can be sized.
34 - Minimum tracking width of the window.
35 - Minimum tracking height of the window.
Return Value
The system metric information.
Example
width = WndInfo(0); ! get width of screen
height = WndInfo(1); ! get height of screen
WinPos(width/2, height/2); ! move window to centre of screen
See Also
Window Functions
WndPutFileProfile
Puts a profile string into any .INI file.
Syntax
WndPutFileProfile(sGroup, sName, sData, sFile)
sGroup:
855
The name of the [group].

sName:
The name of the variable.
sData:
The variable data.
sFile:
The .INI file name.
Return Value
Related Functions
WndGetFileProfile
Example
WndPutFileProfile(Name(), "What", "100", "USER.INI");
See Also
Window Functions
WndShow
Sets the display mode of any window of any application.
Syntax
WndShow(hWnd, nMode)
hWnd:
The Windows handle of the window (returned from the WndFind() function).
Note that this is not the same as a CitectSCADA window number returned from
the WinNumber() function.
nMode:
The window mode:
0 - Hide the window.
1 - Activate the window in normal mode.
2 - Activate the window in an iconized state.
3 - Activate the window in a maximized state.
4 - Display the window in its previous state without activating it.
5 - Activate the window in its current state.
6 - Iconize the window.
7 - Display the window in an iconized state without activating it.
8 - Display the window in its current state without activating it.
9 - Activate the window in its previous state.
856
Return Value
Related Functions
WndFind
Example
WndShow(WndFind("Microsoft Excel"), 0);
! Hides the "Microsoft Excel" window.
See Also
Window Functions
WndViewer
Invokes the Microsoft Multimedia application.
Syntax
WndViewer(sViewerFile, Command, Data)
sViewerFile:
The Multimedia Viewer file to display.
Command:
The type of help:
1 - Displays a Viewer topic (specified in the Data field) in the main Viewer win-
dow.
2 - Displays a Viewer topic (specified in the Data field) in a pop-up window.
Data:
The context string of the Multimedia Viewer topic.
Return Value
Note:CitectSCADA cannot test if the topic has been found or displayed correctly. For ex-
ample, if you pass an invalid topic, the viewer will open with "Viewer topic does not exist"
- but this function will return 0.
Related Functions
WndHelp
Example
WndViewer("MyFile.MVB",1, "Contents");
! Displays the contents topic in the Multimedia file "MyFile.MVB".
WndViewer("HelpFile.MVB",2, "HelpTip");
! Displays the HelpTip topic in the Multimedia file "HelpFile.MVB"
in a popup.
857
See Also
Window Functions
858
Part: 4
Technical Reference
This section contains information for Users and describes the following:
Browse Function Field Reference
860
Chapter: 54 Cicode Errors
This section describes the error codes used by CitectSCADA in the following situations:
 Hardware related errors
 Cicode and general errors
 Mail API errors
Hardware/Cicode Errors
CitectSCADA ’traps’ system errors automatically. When CitectSCADA detects a system er-
ror, it generates a hardware alarm, and the corresponding error message is placed in the
alarm description. Each error has an associated (unique) error number.
You can use the IsError() function to get the number of the last error. Alternatively, you can
trap and process errors within your user functions. Use the ErrSet() function to enable or
disable error trapping.CitectSCADA ’traps’ system errors automatically. When a system
error occurs, CitectSCADA generates a hardware alarm, and the corresponding error mes-
sage is placed in the alarm description. Each error has an associated (unique) error number.
Range Source Cause
0 - 31 PLC or I/O The I/O Device is reporting an error, or CitectSCADA is experienc-
Device ing the reported error trying communicate with an I/O Device. Of-
Generic er- ten caused by incorrect configuration or improper cabling.
rors
256 -511 General General errors are wide ranging, from animation to server prob-
lems. However, there are two main causes of general errors:
1. Device
External devices such as printers, databases, and files can cause
many different hardware errors since they are beyond the control
of CitectSCADA. Often the device itself is improperly configured or
non-existent.
2. Cicode
Cicode errors are generated when your project configuration calls
a Cicode function in an invalid way, or when a Cicode function re-
turns an error or does illegal operations.
For a detailed list of these errors see Cicode and General Errors.
382 - Invalid tag This will indicate that the tag data validation process has identified
383 data a discrepancy with the tag index values. See Validating distributed
project data for tag-based drivers for more information.
You can use the IsError() function to get the number of the last error. Alternatively, you
can trap and process errors within your user functions. Use the ErrSet() function to enable
or disable error trapping.
861
Cicode and General Errors

The table below describes the general errors in Cicode.
Error No. Error title Description
256 General software error An internal CitectSCADA soft-

ware error is detected. Contact
Citect Support and provide de-
tails on what causes the error.
257 Value is out of range A numeric value is out of

range. An out-of-range value
has been passed to a function,
or an array index is off the end
of an array, or a value that is
outside of the specified engi-
neering scale has been as-
signed to a I/O Device variable.
You can disable range checking
on PLC variables with the
CodeSetMode() function.
258 Buffer has been overrun A buffer has been overrun.

More data has been passed to a
function than it can write to its
temporary buffers. Try again by
calling the function twice, with
half the data in each call.
259 Array has been overrun An array passed to a function is

too small for the data request-
ed. Define a larger array or re-
duce the maximum data size
requested.
260 Path does not exist The specified path to a device

or file does not exist. During a
function call (that tried to open
a file), a non-existent path was
specified. Call the function
again with the correct path.
261 File does not exist The specified file or device

does not exist. During a func-
tion call (that tried to open a
file), the file could not be found.
Call the function again with the
correct file name. This error will
also be detected if you try to
call TrnDelHistory() on a file
that has not been added using
TrnAddHistory().
862
262 Cannot open file The specified file cannot be

opened. During a function call
(that tried to open a file), the
file could not be opened. There
may be a mode error (for ex-
ample, from trying to open a
read-only file in write mode), or
the file may be open by others,
or the operating system re-
sources may be too low to open
the file.
Check that the file does exist

(use File Manager), and that
you have the correct rights to
open it. (Check with your net-
work supervisor that you have
correct rights to open the file).
263 Cannot read file The specified file cannot be

read. Either an error has been
detected during a read opera-
tion, or the end of file was un-
expectedly found, or a loss of
the file server occurred, or the
operating system is out of re-
sources.
264 Cannot write to file The specified file cannot be

written to. During a function
call (that tried to write to a file),
a write error has been detected.
There could be a disk full error,
or a loss of the file server may
have occurred, or the operating
system is out of resources.
265 Invalid file type An attempt was made to open

a file of the wrong type, for ex-
ample, you tried to open an
ASCII file as a dBASE file.
266 Field not found in file The specified field does not ex-
ist in the device or database. A
function that is trying to access
an individual field in a database
cannot find that field. Check
that you have specified the cor-
rect field name and database
name.
863
267 File mode is invalid An operation has been at-

tempted on a file or device that
is of the wrong mode, for exam-
ple, you tried to perform a seek
on a printer device. Do not use
this operation on this type of
device.
268 Key not found in file The requested key was not
found when a key search was
performed on a database de-
vice, that is the record specified
on an indexed search cannot be
found. Either the record does
not exist or you have specified
the wrong key.
269 Bad handle specified A bad handle has been passed

to a function. You have called a
function that requires a device
handle, font handle, window
handle, etc., but you passed a
number that does not associate
with a read device, font, or win-
dow (for example, you called
WinGoto(100) when no window
with the handle "100" exists).
Check where the handle or
number was retrieved from,
and verify that it is the same
handle. This error may also be
detected if you have closed or
destroyed the resource and you
then try to access it.
271 No more free handles left All the available file handles
have been used, that is too
many files or databases are
open at the same time. Open
fewer files at one time or in-
crease the number of file han-
dles in the [CtEdit]DBFiles
parameter.
272 Out of memory CitectSCADA is out of memory.

Increase the amount of memo-
ry in the computer or use small-
er databases.
273 Divide by zero An attempt has been made to

divide a number by zero.
864
274 Invalid argument passed An invalid argument has been

passed to a Cicode function.
This is a general error message
and is generated when argu-
ments passed to a function are
out of range or are invalid.
Check the value of arguments
being passed to the function. If
arguments are input directly
from the operator, you should
check that the correct argu-
ments are being passed to the
function.
275 Overflow A calculation has resulted in a

numeric value overflow. Check
for operations that will gener-
ate large numbers.
276 No privilege for operation A user has requested an oper-

ation for which he or she has no
privilege.
277 Not in correct area A user has requested data that

does not belong to the current
user area.
278 Report already busy A request has been made to

run a report that is already run-
ning. You can get the current
state of a report with the
RepGetControl() function. You
can ignore this error message
(because the report is already
running).
279 Report is late for execu- The report cannot run at the
tion rate requested in the configura-
tion. An attempt could have
been made to run a report too
frequently, and the required
data cannot be read from the I/
O Device(s) in time for the next
report.
280 Invalid report ID specified The specified report name does

not exist, or the user has no
privilege to run the report, or
the report is not in the current
user area. Check the name of
the report and the current us-
er’s privilege and areas.
865
281 No server could be found The specified CitectSCADA

server cannot be found. Either
the server is not running or
there is some communication
problem with the network.
Check that the network is set
up correctly, and you are using
the same Server Name on both
the client and server.
282 Foreground Cicode can- You cannot block the fore-

not block ground CitectSCADA task. You
may have called a blocking
function from one of the Page
animation databases.
283 Trend has missed sam- The trend cannot run at the
ples rate requested in the configura-
tion. An attempt could have
been made to trend the data
too frequently, and the required
data cannot be read from the I/
O Device(s) in time for the next
trend. Either increase the per-
formance of the communication
link to the PLCs or slow the rate
of trend data acquisition.
284 Device is disabled An attempt was made to ac-

cess a device that is disabled.
You can disable any devices
(printers and other logging de-
vices) with the DevDisable()
function. When CitectSCADA
(or your Cicode function) tries
to access a disabled device, this
error message returns and all
output is lost.
285 Foreground Cicode run is The foreground Cicode task is

too long taking too long to animate the
display page. The Cicode is too
complex and is taking too long
to execute. Simplify the Cicode
that is animating the page, or
increase the [Code] TimeSlice
parameter. If you cannot sim-
plify the Cicode, you can create
a separate task using
TaskNew() to calculate your
complex operation, and then
use the Display functions to dis-
play the results. Cicode running
from a TaskNew() call is in
background mode and can run
as long as required.
866
286 Out of Cicode threads CitectSCADA has run out of

Cicode tasks. Run fewer tasks
(for example, reports, key com-
mands, and Cicode tasks) in
parallel, or increase the number
of tasks with the [Code]Threads
parameter. This error can be
caused by a configuration error
if you keep creating tasks but
do not "kill" them when they
are no longer required.
287 Floating point exception An invalid floating-point num-

trap ber has been found. Check the
floating-point data from the I/O
Device.
867
288 Out of buffers CitectSCADA is out of dynamic

buffers. You have called a func-
tion that requests buffer space
but no buffers are available.
Check which function is causing
the error and increase the asso-
ciated buffers, or slow the rate
of transfer to that function. If
the error occurs on a server or
LAN device, increase the num-
ber of buffers with the
[Lan]ReadPool parameter.
This error can also be detected

if something is stopping the re-
lease of the buffers, for exam-
ple, if network communication
has stopped or a PLC has just
come off-line. The error ’Out of
buffers’ can also be generated
in the following ways:
Calling QueWrite() when the

queue functions have run out of
buffers. You can increase the
number of queue buffers with
the [Code] Queue parameter.
Calling WinFree() to free the

last Cicode window. If Win-
Free() did free the last window,
CitectSCADA would have no
windows left.
To verify which function is

causing the hardware error,
display the {ERRPAGE} and
{ERRDESC} fields on the hard-
ware alarm.
289 Name does not exist The specified name does not
exist in this context. You are
probably using the wrong
name.
290 Not finished A request has been made for

trend data that has not yet fin-
ished trending.
868
291 File not CitectSCADA for- The specified file is not in Cit-
mat ectSCADA format. The file
(trend, graphic, or any other
file) is in an invalid format.
Check that the name of the file
is valid or that the file has not
become corrupted.
292 Invalid function The specified function name

does not exist. You have tried
to create a task, or called a re-
mote procedure, or set an
event function that does not ex-
ist.
293 File error A general file error has been

detected. Either a general hard-
ware error has occurred, or the
operating system is out of re-
sources, or the file server is
down.
294 File EOF The end of the file was found.

An attempt was made to read
data off the end of a file or da-
tabase.
869
295 Cicode stack overflow A Cicode evaluation stack over-

flow has occurred. There are
too many local function vari-
ables or nested function calls.
Reduce the number of local
variables or increase the [Code]
Stack parameter.
The Cicode stack is used to

store local function variables
and function calls. If you have
many nested functions and a
large number of local function
variables, the Cicode stack may
overflow. When the Cicode
stack overflows, the Cicode that
caused the overflow is halted.
You can estimate the size of

the stack by counting the max-
imum number of local function
variables in the deepest func-
tion calls. For example, if func-
tion A has 10 variables and calls
function B with 30 variables,
which calls function C with 40
variables, the stack needs to be
10 + 30 + 40 = 80 deep.
296 Queue empty An attempt has been made to

read an element from an empty
queue.
297 Semaphore owner died The owner of a Cicode sema-

phore was halted, killed, or re-
turned without releasing the
semaphore. Reset the shared
resource back to a known state
(because the task that died
may have left it in a mess), and
then continue. For example, if
you are sharing a printer, do a
form feed.
298 Semaphore timeout The requested semaphore was

still in use after the specified
timeout. Either try to get the
semaphore again or abort the
operation and tell the operator
of the detected error.
870
299 Cancelled The specified form or com-

mand was cancelled. This error
is returned when a user presses
the Cancel button on a form.
The normal procedure is to
abort the operation.
300 Trend not found The trend does not exist at the
specified AN and page. A trend
function may have been called
when the trend is not defined
for that AN.
301 Trend pen not found The required trend pen name
does not exist in the Trends da-
tabase or is not in the current
user area. Check that the pen
name exists and check the cur-
rent user’s privilege and area.
302 Trend data not valid The requested trend data is not
valid. Either the I/O Device
data was bad, or the CitectSCA-
DA trend server was shut down,
or the trend data was disabled.
303 Invalid animation number The AN specified in the function

is not defined. You called one of
the DspXXX animation func-
tions, but you specified an ani-
mation number that was out of
range or that had been deleted.
304 File server failed, stand- CitectSCADA has detected that

by active a file server has become inop-
erative, and will switch to the
standby file server. The file
server’s inoperative condition is
due to errors of the network or
of the file server computer. This
error is displayed only if you
have enabled redundant file
servers. If a redundant file
server is not enabled, Cit-
ectSCADA and Windows crash-
es when the file server becomes
inoperative. You should report
this error to the operators to fix
the file server.
871
305 Conflicting types of ani- The same AN is being used for

mation two different types of anima-
tion. This error is detected if
you try to display two (or more)
incompatible types of anima-
tion on the same AN (for exam-
ple, you try to display a symbol
at a AN where a bar graph is al-
ready displayed). Check the
configuration. If you need to
display a new animation, you
must first delete the old anima-
tion with the DspDel() function.
306 SQL field value truncated A maximum of 1000bytes

(1Kb) can be returned from a
single field call. If the field data
is larger than this limit, it is
truncated. You have tried to ac-
cess a database where one of
the fields is greater than 1000
bytes in size. Change the data-
base field size to less than 1000
bytes so it can be accessed. In
fact, you should change the
field size to less than 256 bytes,
the maximum allowable length
of a Cicode string.
307 SQL database error A general SQL error. Call the

SQLErrMsg() function for de-
tails of the detected error.
308 SQL null field data re- Data has been requested from
turned a field that contained no data,
or the SQL server does not sup-
port this type of field data. Cit-
ectSCADA will return an empty
string. Call the SQLFieldInfo()
function to list the fields in the
database.
309 Trend data is gated You have requested trend data

that was gated (set to logging
disabled) by the trigger expres-
sion (that is when it was ac-
quired). The data is returned
with the gated values set to 0.
310 Incompatible server ver- Two servers are running in-

sion compatible versions of the Cit-
ectSCADA software. Install the
latest version on each server.
Contact Citect Support to ar-
range for an upgrade.
872
311 Alarm tag synchronize er- When the Alarm server shuts
ror down it writes an alarm save
file. If the alarm server is in tag
mode (rather than record
mode) this message will dis-
play. You can set the mode with
the [Alarm]SaveStyle parame-
ter. You can ignore this mes-
sage as it is an alert only.
312 MAPI generic error A generic MAPI error has been

detected. Call the MailError()
function to retrieve the MAPI
error.
313 No MAPI The MAPI mail system is not in-

stalled, or incorrectly installed
on the computer.
314 MAPI offline The computer is not logged on

to the MAPI mail system. Call
the MailLogon() function to log
on to the MAPI mail system.
315 MAPI no mail No mail was available. This

message is returned from the
MailRead() function if no mail is
available.
316 dBASE record locked by The dBASE file is being access-

another ed by another user. Check if the
dBASE file has been opened in
exclusive mode by the other us-
er. This error can also be de-
tected if another user is
updating the dBASE file, and
will most likely occur if it is an
indexed database, and the file
is on a slow file server. You can
adjust dBASE access with the
[General]LockRetry and [Gen-
eral]LockDelay parameters.
317 Not in this version The operation is not supported

in this version of CitectSCADA.
You must upgrade to a higher
version.
318 Invalid page function You have called the PageGo-

to(), PageNext(), PagePrev(),
PageDisplay(), or PageLast() as
an exit command in the Pages
database.
873
319 Low physical memory CitectSCADA is low on physical

memory. Increase available
physical memory (not virtual
memory). Reduce the size of
SMARTDRV cache, close any
other windows programs that
are running, or add more RAM
to your computer. You can set
the minimum size of memory
required by CitectSCADA with
the [Memory]MinPhyK parame-
ter. This parameter sets a value
for the minimum physical mem-
ory before CitectSCADA will
generate this error message.
This error may also be detected

if your swap file is large (that is
greater than 20 Mb). Reduce
the size of your swap file. The
swap file is configured with the
Windows Control Panel (386
Enhanced icon).
320 Cannot free window The WinFree() function has

been called but CitectSCADA
has no windows left. (Note that
the last window and any child
windows owned by the last win-
dow cannot be removed.)
321 Font cannot be found The specified font cannot be

found. Check the font name.
322 LAN Failure CitectSCADA has detected an

error on the network.
323 Super Genie not Associat- A Super Genie variable has not
ed been associated correctly. This
error can be detected if a vari-
able passed to the Super Genie
is the wrong data type or the
variable does not exist. The er-
ror will also be detected if the
Ass() function has not been
called for the variable.
325 Project is not compiled Changes have been made to

the project while the system
was running. Either restart the
system or shutdown and re-
compile.
874
326 Could not run the Cit- The CitectSCADA compiler

ectSCADA compiler could not be found. Either the
computer has run out of mem-
ory, or the compiler has been
removed from its directory.
327 User type not found An attempt was made to create

a user of a type that has not
been defined in the users data-
base.
328 User already exists An attempt was made to create

a new user with the same name
as an existing user.
329 Cannot have mixed An attempt was made to dis-

trends play both a periodic trend and
an event trend in the same
trend window. Check the
project configuration (Trend
Tags and Page Trends databas-
es) for mixed trends displayed
in a trend window.
336 Event type trend is ex- One of the arguments passed

pected to this trend function is only
valid for event type trends.
337 Trend in file does not ex- The trend name inside the
ist trend file does not exist in the
trend database. It is likely that
the trend file belongs to a trend
which is deleted from the sys-
tem configuration.
338 Plot Functions Sequence Plot functions are to be written

Mismatch in sequence since they depend
on the data set up by other plot
functions. Please refer to the
description section for each Plot
Function for the order of plot
functions.
339 Plot Marker is not Defined An undefined plot marker sym-

bol has been used. Use the Plot-
SetMarker function before the
PlotLine, PlotXYLine or Plot-
Marker functions.
875
342 Debug break The DebugBreak() Cicode

function has been called. This
indicates an invalid condition
detected in user written Cicode.
Enable the Cicode debugger to
find the cause of the problem.
343 Foreground Cicode can- A breakpoint has been hit in

not break foreground Cicode. Foreground
Cicode cannot be blocked. You
can disable this error message
in Debug Options, accessed
through the Debug menu in the
Cicode Editor.
This error occurs when the
344 Format overflow string being used to return an
error message is not long
enough for the information to
go into it.
This warning is returned when
345 Trend data not ready the trend data is not ready to be
returned. Try again later.
346 Dynamic Out of licence The dynamic point count has

points exceeded the point limit. See
CitectSCADA Licence Point
Count.
347 Assertion failed in user An assertion in your Cicode has

Cicode been proven FALSE, and the
task terminated. Assertions are
made using the Assert() func-
tion. If you set the [Code]De-
bugMessage parameter to 1,
the assertion is logged and the
operator prompted.
Problems connecting to the FTP
353 FTP Failure server for file copy. Check that
the service is running correctly
by using a 3rd party tool out-
side CitectSCADA.
The automation object to be
354 Unrecognized object class used is not known or regis-
tered.
The automation objects inter-
355 Object has no interface face no longer exists. This is ei-
ther a logic or code error.
Generic automation exception
356 Object automation excep- code for logging issues.
tion
Formatting issues likely due to
357 Too many arguments too many arguments (automa-
tion)
876

Less arguments available than
358 Too few arguments expected (automation)
An object tried to be created
359 Named object already ex- when it was already existed and
ists it was not expected to exist.
Check your cicode (automa-
tion)
The name of an object did not
360 Unrecognized named ob- match the internal records.
ject Check your cicode (automa-
tion).
An animation object id was not
361 Page CTG/RDB record found in the records. Try a full
mismatch compile and re-start.
362 Object event queue flood- CitectSCADA has run out of

ed Cicode tasks while processing
ActiveX events. Create fewer
concurrent ActiveX events, or
increase the number of tasks
with the [Code]Threads param-
eter.
Internal error in cicode han-
363 Incorrect number of argu- dling of objects. Try a full re-
ments compile and restart.
Internal error in cicode han-

364 No ’this’ argument dling of objects. Try a full re-
compile and restart.
374 Date Time Conflict A Date and/or time conflict has

been detected. If you are at-
tempting a TrnAddHistory(),
verify that the file you are add-
ing does not have a conflicting
time or date with existing trend
files.
375 Password Expired The password has expired.
Change password or adjust the
[General]PasswordExpiry set-
tings.
379 Cannot modify field The Users.DBF file is protected
from direct user manipulation,
so cannot be modified.
380 Name Exists The user name specified al-
ready exists in the Users.DBF.
381 File Format Error The file is not in the desired for-
mat. It may be corrupted.
382 Page data / variable tag Page data / variable tag data
data mismatch mismatch with tag-based driv-
er.
877

Cicode task has been flagged as
384 The code this queue/ dead. This will not be an issue if
semaphore was waiting a cicode task was killed deliber-
for exited due to an error ately by the cicode logic.
A number of Cicode functions

391 Unsupported Cicode func- can only be run in a non Web
tion in Citect Web Client context. This error is flagging
that such a function was tried
from a Web client.
402 Cluster not specified Cicode call is ambiguous be-

cause no cluster was specified.
403 Cluster not found The provided cluster name was

not seen as a valid cluster
name.
404 Cluster name and tag A cluster name and a tag with
mismatch a cluster name prefix were both
passed, but they do not match
each other.
405 Cluster not connected The operation cannot continue

as the cluster is not connected.
406 Cluster already connected The operation cannot continue

as the cluster is already con-
nected.
407 Databrowse pending Databrowse session currently

being connected and is not yet
available for further com-
mands.
This normally means that data
408 Databrowse not support- has been requested from the
ed wrong client / server type, that
is a client request on a server or
vice versa.
Browse type unknown. Check
409 Databrowse type not all versions of citect32 are the
found same.
410 Databrowse session not iSession handle is invalid.

found
411 Databrowse session ex- Cannot open a session as it al-

ists ready exists.
412 Databrowse session EOF Cannot browse beyond end of

file. No more records left in the
browse.
878
413 Databrowse field not The specified field is not

found present in the file.
414 Databrowse invalid field The specified field is not valid

for this browse function.
Browse command unknown.
415 Databrowse no command Check all versions of citect32
are the same.
Internal flag that all clusters
416 Databrowse no next clus- have been processed. Users
ter use this in cicode to determine
that there are no more clusters.
417 Cluster required for oper- The operation cannot continue

ation as the cluster is required for op-
eration of a server.
418 No server of type on clus- There is no server of the re-

ter quired type configured on the
server.
419 Client / Server ID mis- An ID given to a Cicode func-

match tion is not of the correct type.
420 Not available outside pro- This functionality is not avail-

cess able outside a process bound-
ary for example,
AlarmFirstCatRec is only able to
be called from inside the Alarm
Server process.
421 Invalid tran handle de- Citect’s internal communica-

tected tions subsystem detected an
error while trying to send a
message.
422 Dial call failed An attempt to make a call to a
remote I/O device failed. You
can find more information on
the cause of this problem (if it is
reproducible) by setting [Di-
al]Debug=1 and [Dial]Debu-
gLevel=3 and looking in the
syslog.dat.
423 Subscription value is Occurs when a tag has been
pending subscribed to, and attempted to
read the value before the initial
value has been retrieved from
the server.
424 Tag not found Occurs when attempt to read or
subscribe to a tag that does not
exist.
425 No connector Not used.
879

426 Write to named pipe failed An attempt to send a message
via a name pipe has failed.
427 Redirect from non-Cicode A function cannot be redirected
task to another component as a
proxy RPC unless it is in the
context of a Cicode call.
428 Data browse record is in- The specified record is not valid
valid for this browse function.
429 Can’t plot symbol to print- The Cicode PlotMarker() func-
er tion can only plot a symbol to
the display. This error occurs
when the PlotMarker() Cicode
function is used with a user-de-
fined marker and a printer was
specified as the output when
PlotOpen() was called.
430 Alarm sort parameters The [Alarm]SortMode parame-
mismatch ter value on client is different as
compared to the value on the
alarm server. This value should
be same in order to display
alarms in correct order on the
client.
431 Summary sort parameters Values for [Alarm]Summa-
mismatch rySort and [Alarm]Summa-
rySortMode parameters on
client are different as compared
to the values on the alarm serv-
er. These values should be
same in order to display alarm
summary in correct order on
the client.
432 Property not ready A specific tag property has been
read in synchronous mode, be-
fore the value has been re-
trieved from the server.
(similar to subscription value is
pending)
433 Cicode type mismatch Some server side changes are
now allowed for cicode, without
restarting the client. This
means that now it is possible to
change a tag type to one that
now cannot be converted as it
was before. Eg val = TagA -
TagB, If TagA has been con-
verted from Integer to String,
then the cicode will raise a
cicode type mismatch as the ’-’
operation is not supported for
strings
434 Invalid data conversion Attempt to convert a value to a
type that cannot store the value
for example, ULong to Long,
and the value is greater than
the Long type can handle.
880

437 Failed to load security pro- Cannot load or initialize the
vider Windows security provider. This
indicates that the installation of
operating system may be cor-
rupted or the Windows security
provider was not included.
439 Authentication failed Cannot authenticate the given
Windows user name and pass-
word. Make sure the user name
and password are typed in cor-
rectly
440 Authentication session Cannot find the authentication
does not exist session during the authentica-
tion process for the Windows
user. This indicates that there
was miscommunications in be-
tween client and server.
441 Role checking failed Cannot perform the role-check
process for the Windows user.
Make sure the roles database in
the project is not corrupted.
442 No linked role The given Windows user is not
linked to any role defined in the
project.
443 Acquire user credentials Cannot obtain the user creden-
failed tial handle from Windows.
444 Acquire user access token Cannot obtain the user access
failed token. This indicates that the
security context of the Windows
user was invalid.
445 Encrypt data failed Cannot encrypt the user infor-
mation during the Windows
user authentication process.
This indicates that the security
context of the Windows user
was invalid.
446 Decrypt data failed Cannot decrypt the user infor-
mation during the Windows
user authentication process.
This indicates that the security
context of the Windows user
was invalid.
447 The name of the table can Cicode UsrKernelTableInfo()
not be found in the kernel. has asked for a table that does
not exist.
449 Invalid logout The logout was called when
there is no one logged in or the
logged on user is system de-
fault user.
512 Time out error Failed to execute requested ac-
tion on time.
513 Access denied error Access denied to perform re-
quested action.
881

514 Write failed Write fails as client is in view-
only mode.User needs to login
with valid user credentials to
get write access.
Windows Socket Error Codes

The following CitectSCADA error codes are mapped to standard Windows socket errors.
Generally these errors are beyond CitectSCADA’s control, that is, there is a external reason
why CitectSCADA cannot use the TCP/IP connection (assuming there are no Citect config-
uration issues).

(10050) Network is down.
1330 WSAENETDOWN
(10051) Network is unreach-
1331 Socket unreachable able.
(10052) Network dropped
1332 Network reset connection on reset.
(10053) Software caused con-

1333 Connection aborted nection abort.
(10054) Connection reset by
1334 Connection reset peer.
(10055) No buffer space

1335 No buffers available available.
(10060) Connection timed
1340 Socket timeout out.
(10061) Connection refused.

1341 Connection refused
(10063) Item Name too long.
1343 Name too long
(10064) Host is down.
1344 Host down
(10065) No route to host.
1345 Host unreachable
MAPI Errors
The table below describes the MAPI errors in Cicode.
Error Error title Description
number
0 SUCCESS_SUCCESS The command completed successfully.
1 MAPI_USER_ABORT The command was aborted by the user.
2 MAPI_E_FAILURE General MAPI error.
3 The login failed, either the login user is unknown,
MAPI_E_LOGIN_FAIL misspelt, or the password is incorrect.
URE
882
4 MAPI_E_DISK_FULL The disk is full. The mail system will copy files into
the temporary directory when mail is read. This can
fill up the local hard disk.
5 Insufficient memory to complete the command.
MAPI_E_INSUFFICIE
NT_MEMORY
6 You do not have enough privilege to complete the re-
MAPI_E_ACCESS_DE quested command.
NIED
8 You have tried to open too many sessions to the mail
MAPI_E_TOO_MANY system.
_SESSIONS
9 Too many attached files in a message.
MAPI_E_TOO_MANY
_FILES
10 Too many recipients for a mail message.
MAPI_E_TOO_MANY
_RECIPIENTS
11 Cannot find the attached file.
MAPI_E_ATTACHME
NT_NOT_FOUND
12 Cannot open the specified attached file. Most likely
MAPI_E_ATTACHME the file does not exist.
NT_OPEN_FAILURE
13 Cannot write the attached file.
MAPI_E_ATTACHME
NT_WRITE_FAILURE
14 Recipient of the mail message is unknown. Check if
MAPI_E_UNKNOWN_ the user is configured in the mail system or check the
RECIPIENT spelling of the user’s name.
15 Unknown recipient type.
MAPI_E_BAD_RECIP
TYPE
16 No new messages to read.
MAPI_E_NO_MESSA
GES
17 The mail message is invalid.
MAPI_E_INVALID_M
ESSAGE
18 Text message is too large to be sent. If you want to
MAPI_E_TEXT_TOO_ send large text messages, write the text to a file and
LARGE attach the file to the mail message.
19 Mail session is invalid. You should not get this error
MAPI_E_INVALID_SE message; contact Citect Pty Ltd Technical Support.
SSION
20 You should not get this error message; contact Citect
MAPI_E_TYPE_NOT_ Pty Ltd Technical Support.
SUPPORTED
21 The recipient of the mail message is ambiguous.
MAPI_E_AMBIGUOU Specify the exact user name to which the mail is to
S_RECIPIENT be sent.
22 Mail message is in use. You should not get this error
MAPI_E_MESSAGE_I message: contact Citect Pty Ltd Technical Support.
N_USE
883
23 Mail cannot be sent or received as the network has

MAPI_E_NETWORK_ experienced an error.
FAILURE
MAPI_E_INVALID_E Pty Ltd Technical Support.
DITFIELDS
MAPI_E_INVALID_R Pty Ltd Technical Support.
ECIPS
26 Command is not supported by this implementation of
MAPI_E_NOT_SUPPO MAPI.
RTED
884
Chapter: 55 Browse Function Field Reference
Field Name Description Length Values
ACKDATE Event acknowl- 12 short: dd-mm-yy

edge date
[default] extended: dd-

mm-yyyy
Note: works between: UTC

time 1/1/1980 - UTC time
31/12/2037, otherwise "".
Note:The format can be

chaged by setting Extended-
Date to FALSE under the
section [Alarm] in the cit-
ect.ini file.
ACKDATEEXT Extended Event 12 For non-Hardware alarms:

Acknowledge date dd-mm-yyyy
ACKTIME Event acknowl- 12 hh:mm:ss [am|pm].

edge time

31/12/2037, otherwise ""
ALARMTYPE Alarm type (text) 16 "Digital", "Analog", "Ad-

vanced", "Multi-Digital",
"Argyle Analog", "Time
Stamped", "Time Stamped
Digital", "Time Stamped An-
alog"
ALMCOMMENT Alarm comment 254
AREA Alarm area 16 Numeric value (integer)
CATEGORY Alarm category 16 Numeric value (integer)
CLUSTER The cluster the tag 32

exists on
885
COMMENT Comment 64 If hardware alarm = "".
Or configured event de-

scription or trend comment
CUSTOM1 Alarm custom field 64

#1

#2

#3

#4

#5

#6

#7

#8
DATE Alarm Date in de- 12 short: dd-mm-yy

fault format

mm-yyyy

31/12/2037, otherwise "".
Note: The format can be

changed by setting Extend-
edDate to FALSE under the
ect.ini file.
DATEEXT Extended Alarm 12 dd-mm-yyyy

date
DEADBAND Alarm deadband 12 For Analog, Argyle Analog

and Timestamped Analog
alarms: Numeric value (re-
al)
886
DELTATIME Event on duration 12 hh:mm:ss
DESC Alarm description 254 For Analog Alarms
"OFF", "ON", "ON State 2",

"ON State 3", "ON State 4",
"ON State 7", "DEVIATION",
"RATE OF CHANGE", "LOW",
"HIGH", "LOW LOW", "HIGH
HIGH", "Invalid".
For others - configured de-

scriptions.
DEVIATION Alarm deviation 12 For Analog, Argyle Analog

al)
ENG_FULL The engineering 11 Numeric value (real)

full scale for this
value
ENG_UNITS Engineering units 8 The predefined values (see

below) are in the Help.dbf of
the bin directory but the
user may specify it as a free
text:
%, Amps, deg, ft, ft/min, ft/

s, ft/sec, gal, gal/h, gal/min,
gal/s, gal/sec, Hz, kg, kg/h,
kg/min, kg/s, kg/sec, km/h,
kPa, kW, litres, lt, lt/h, lt/
min, lt/s, lt/sec, m/min, m/
s, m/sec, metres, Rev, Rev/
h, RPM, t, t/h, Tonnes, Volts,
Watts.
ENG_ZERO The engineering 11 Numeric value (real)

zero scale for this
value
ERRDESC Extra Citect info 80 For Hardware alarms: error

on alarms description according to the
configuration.
ERRPAGE Alarm from this 80 For Hardware alarms: the

Citect page Citect page the alarm is as-
signed to.
887
EXPRESSION Logged variable 65 The logged variable name

name (clustername.tagname).
If the expression contains

simple Cicode containing a
single tag name, such as
"LT131" or "LT131<1000",
the tag name is returned (in
both these cases LT131). If
the expression contains a
function call or more than
one tag name, an empty
string is returned.
FILENAME File where the 231

trend data is to be
stored
FILES The number of 4

history files stored
on the hard disk
(for this tag)
FORMAT Alarm format 12 For Analog, Argyle Analog

al)
FULLNAME Event user full 20 For non-Hardware alarms

name the configured full name of
the event user if exists.
Otherwise "System".
GROUP Alarm group 16 For Argyle Digital alarms:

Numeric value
HELP Alarm help 254 The name of the help page.
HIGH Alarm high 12 For Analog, Argyle Analog

al)
HIGHHIGH Alarm highhigh 12 For Analog, Argyle Analog

al)
888
LOCALTIMEDATE Alarm Date and 24 yyyy-mm-dd

Time hh:mm:ss[.ttt].

31/12/2037, otherwise ""
LOGSTATE Log state text 13 "ACTIVE", "INACTIVE",

"DISABLED", "ENABLED",
"ACKNOWLEDGED", "LOW",
HIGH", "RATE", "DEVIA-
TION", "CLEARED", "UNAC-
KNOWLEDGED"
LOW Alarm low 12 For Analog, Argyle Analog

al)
LOWLOW Alarm lowlow 12 For Analog, Argyle Analog

al)
LSL Lower specifica- 16

tion limit
MILLISEC Alarm millisec- 6 Numeric value (integer)

onds
NAME Alarm name 80
NATIVE_COMMENT Event Comment 64 For non-Hardware alarms:

the event description.
NATIVE_DESC Alarm description 80 Analog alarm - Alarm state

text.
Otherwise - Configured
alarm description.
NATIVE_NAME Alarm name 80 Configured alarm name.
NATIVE_SUMDESC Event description 80 For non-Hardware Analog

text alarms: the event state
string.
For non-Hardware other

alarms: the event [or if not
exists the alarm] description
889
NODE Local node name 32
OFFDATE Event on date 12 short: dd-mm-yy

mm-yyyy

31/12/2037, otherwise "".

ect.ini file.
OFFDATEEXT Extended Event 12 For non-Hardware alarms:

off date dd-mm-yyyy
OFFMILLI Alarm summary 6 For High Resolution, Times-

milliseconds tamped Digital and Times-
tamped Analog alarms it is
the milliseconds part of the
off time
OFFTIME Event off time 12 hh:mm:ss [am|pm].
NOTE: works between: UTC

31/12/2037, otherwise ""
OFFTIMEDATE Special SQL for- 12 For non-Hardware alarms:

matted date and HH:MM:SS.
time
configured in the citect.ini
file by specifying TimeDate
under the section [Alarm].
OLD_DESC Argyle old state 8 "Invalid", "OFF", "ON", "ON

desc. State 2", "ON State 3", "ON
State 4", "ON State 5", "ON
State 6", "ON State 7"
890
ONDATE Event on date 12 short: dd-mm-yy

mm-yyyy

31/12/2037, otherwise "".

ect.ini file.
ONDATEEXT Extended Event 12 For non-Hardware alarms:

on date dd-mm-yyyy
ONMILLI Alarm summary 6 For High Resolution, Times-

milliseconds tamped Digital and Times-
tamped Analog alarms it is
the milliseconds part of the
on time
ONTIME Event on time 12 hh:mm:ss [am|pm].

31/12/2037, otherwise ""
ONTIMEDATE Special SQL for- 12 For non-Hardware alarms:

matted date and HH:MM:SS.
time

ORATODATE Special SQL for- 12 The first 12 characters of

matted time the string:
"TO_DATE(’<sql_time_date
>’, ’<sql_time_format>’)".
891
ORATOOFFDATE Special SQL for- 12 For non-Hardware alarms:

matted time The first 12 characters of the
string:
"TO_DATE(’<sql_off_time_d
ate>’,
’<sql_time_format>’)".
ORATOONDATE Special SQL for- 12 For non-Hardware alarms:

matted time The first 12 characters of the
string:
"TO_DATE(’<sql_on_time_d
ate>’,
’<sql_time_format>’)".
PAGING Alarm paged flag 8 A flag to indicate that the
alarm is going to be paged.
Values are 1 (TRUE) or 0
(FALSE).
PAGINGGROUP Paging group for 80 A freeform text field indicat-
alarm ing the sequence of people
to notify in the event the
alarm occurred.
PERIOD The period of the 32 In hh:mm:ss (hours:min-

history file utes:seconds).
PRIORITY Alarm category 4 Numeric value (integer)

priority
PRIV Alarm privilege 16 Numeric value (integer)
RANGE Process range 16
RATE Alarm rate 12 For Analog, Argyle Analog

al)
RAW_FULL The raw full scale 11 Numeric value (real)

for this value
RAW_ZERO The raw zero scale 11 Numeric value (real)

for this value
RUNNING Running time in 16 Numeric value (real)

seconds
892
SAMPLEPER Sample period of 16 Numeric value (real)

the trend in sec-
onds
SDEVIATION Standard devia- 16

tion
SPCFLAG Indicates tag is a

Statistical Process
Control (SPC) tag
STARTS Number of starts 16 Numeric value (real)
STATE Alarm state string 16 "OFF", "ON", "ON State 2",

HIGH", "Invalid"
STATE_DESC Argyle state de- 8 "Invalid", "OFF", "ON", "ON

scription State 2", "ON State 3", "ON
State 4", "ON State 5", "ON
State 6", "ON State 7"
STATE_DESC0 Argyle state 0 64 For Argyle Digital alarms:

"OFF".
For others: "INVALID"

"ON".

"ON state 2".

"ON state 3".

"ON state 4".
893

"ON state 5".

"ON state 6".

"ON state 7".
STORMETHOD Storage method 16 "Scaled" or "Floating Point"

for the SPC data
SUBGRPSIZE The size of each 8

subgroup
SUMDESC Event description 80 Analog alarm - Event state

text text.
Otherwise - Configured
event [or alarm in case
event not defined] descrip-
tion
SUMSTATE Event state text 16 "OFF", "ON", "ON State 2",

HIGH", "Invalid"
SUMTYPE Event state 16 For non-Hardware alarms:

"DISABLED", "UNAC-
KNOWLEDGED", "AC-
KNOWLEDGED",
"CLEARED".
TAG Tag name 80
TAGEX Extended Alarm 32 <cluster>.<tag> when

tag cluster defined
Otherwise <tag>.
894
TAGGENLINK Indicates Tag was Name of the IO Device from

imported from an which this tag was generat-
IO Device ed
TIME Alarm Time 12 hh:mm:ss [am|pm].

31/12/2037, otherwise ""
TIMEDATE Special SQL for- 24 HH:MM:SS.

matted time

TOTALISER Running total of 16 Numeric value (real)

value
TRIGGER Last trigger value, 5 0 OR 1

used to check for
rising edge of the
(accumulator trigger code
fields)
TRIGGER The variable tag 65 The variable tag (cluster-

that triggers data name.tagname) that trig-
logging gers data logging.
(trend fields)
If the trigger contains sim-

ple Cicode containing a sin-
gle tag name, such as
"LT131<50", the tag name
is returned (in this case
LT131). If the expression
contains a function call or
more than one tag name, an
empty string is returned.
TYPE Alarm or Trend 16 For Alarms:

type string
"DISABLED", "UNAC-
KNOWLEDGED", "AC-
KNOWLEDGED", "CLEARED"
For Trends:
"1" - Periodic, "2" - Event,

"3" - Periodic Event
TYPENUM Alarm type 4 Numeric value (integer)
895
USERDESC Event user de- 64 For non-Hardware alarms

scription the configured user descrip-
tion if exists. Otherwise "".
USERNAME Event user name 16 For non-Hardware alarms

the configured name of the
event user if exists.
Otherwise "System".
USL Upper specifica- 16

tion limit
VALUE Formatted alarm 16 Analog Alarms - numeric

value value formatted according
to configuration.
(alarm fields)
Others - "ON", "OFF"
VALUE The value to be 16 Numeric value (real)

added to the total-
iser while trigger is
(accumulator
true
fields)
XDOUBLEBAR Process mean 16
896
Index
Symbols AlarmNextCatRec Cicode function 171
: operator 67 AlarmNextPriRec Cicode function 172
_ObjectCallMethod Cicode function 125 AlarmNextTagRec Cicode function 173
_ObjectGetProperty Cicode function 126 AlarmNotifyVarChange Cicode function 175
_ObjectSetProperty Cicode function 127 AlarmQueryFirstRec Cicode function 176
AlarmQueryNextRec Cicode function 176
alarms, hardware 861
A AlarmSetDelay Cicode function 177
Abs Cicode function 479 AlarmSetDelayRec Cicode function 178
AccControl Cicode function 119 AlarmSetInfo Cicode function 179
AccumBrowseClose Cicode function 120 AlarmSetQuery Cicode function 182
AccumBrowseFirst Cicode function 120 AlarmSetThreshold Cicode function 184
AccumBrowseGetField Cicode function 121 AlarmSetThresholdRec Cicode function 185
AccumBrowseNext Cicode function 122 AlarmSplit Cicode function 186
AccumBrowseNumRecords Cicode function 122 AlarmSumAppend Cicode function 187
AccumBrowseOpen Cicode function 123 AlarmSumCommit Cicode function 188
AccumBrowsePrev Cicode function 124 AlarmSumDelete Cicode function 189
Accumulator Cicode functions 119 AlarmSumFind Cicode function 190
ActiveX Cicode functions 125 AlarmSumFirst Cicode function 192
Alarm Cicode functions 137 AlarmSumGet Cicode function 193
AlarmAck Cicode function 139 AlarmSumLast Cicode function 194
AlarmAckRec Cicode function 141 AlarmSumNext Cicode function 195
AlarmActive Cicode function 142 AlarmSumPrev Cicode function 196
AlarmClear Cicode function 143 AlarmSumSet Cicode function 197
AlarmClearRec Cicode function 145 AlarmSumSplit Cicode function 198
AlarmComment Cicode function 145 AlarmSumType Cicode function 199
AlarmDelete Cicode function 146 AlmSummaryAck Cicode function 200
AlarmDisable Cicode function 147 AlmSummaryClear Cicode function 200
AlarmDisableRec Cicode function 149 AlmSummaryClose Cicode function 201
AlarmDsp Cicode function 150 AlmSummaryCommit Cicode function 201
AlarmDspLast Cicode function 151 AlmSummaryDelete Cicode function 202
AlarmDspNext Cicode function 153 AlmSummaryDeleteAll Cicode function 203
AlarmDspPrev Cicode function 153 AlmSummaryDisable Cicode function 204
AlarmEnable Cicode function 154 AlmSummaryEnable Cicode function 204
AlarmEnableRec Cicode function 156 AlmSummaryFirst Cicode function 205
AlarmEventQue Cicode function 156 AlmSummaryGetField Cicode function 205
AlarmFirstCatRec Cicode function 157 AlmSummaryLast Cicode function 206
AlarmFirstPriRec Cicode function 158 AlmSummaryNext Cicode function 207
AlarmFirstTagRec Cicode function 160 AlmSummaryOpen Cicode function 207
AlarmGetDelay Cicode function 161 AlmSummaryPrev Cicode function 208
AlarmGetDelayRec Cicode function 161 AlmSummarySetFieldValue Cicode function 209
AlarmGetDsp Cicode function 162 AlmTagsAck Cicode function 210
AlarmGetFieldRec Cicode function 164 AlmTagsClear Cicode function 210
AlarmGetInfo Cicode function 167 AlmTagsClose Cicode function 211
AlarmGetOrderbyKey Cicode function 168 AlmTagsDisable Cicode function 211
AlarmGetThreshold Cicode function 169 AlmTagsEnable Cicode function 212
AlarmGetThresholdRec Cicode function 169 AlmTagsFirst Cicode function 212
AlarmHelp Cicode function 170 AlmTagsGetField Cicode function 213
897
Index
AlmTagsNext Cicode function 214 Cicode Editor

AlmTagsNumRecords Cicode function 214 toolbar options 91
AlmTagsOpen Cicode function 215 Cicode errors 862
AlmTagsPrev Cicode function 216 CitectColourToPackedRGB Cicode function 231
AnByName Cicode function 127 CitectInfo Cicode function 496
ArcCos Cicode function 480 CitectVBA Watch window 95
ArcSin Cicode function 480 Clipboard Cicode functions 219
ArcTan Cicode function 481 ClipCopy Cicode function 219
AreaCheck Cicode function 494 ClipPaste Cicode function 219
argument structure 44 ClipReadLn Cicode function 220
arguments ClipSetMode Cicode function 221
default values 48 ClipWriteLn Cicode function 221
key sequences as 20 cluster Cicode functions 223
passing data to 26 ClusterActivate Cicode function 223
arguments, string 26 ClusterDeactivate Cicode function 224
Ass Cicode function 662 ClusterFirst Cicode function 224
AssChain Cicode function 663 ClusterGetName Cicode function 224
AssChainPage Cicode function 664 ClusterIsActive Cicode function 225
AssChainPopUp Cicode function 664 ClusterNext Cicode function 226
AssChainWin Cicode function 665 ClusterServerTypes Cicode function 226
AssChainWinFree Cicode function 666 ClusterSetName Cicode function 227
Assert Cicode function 495 ClusterStatus Cicode function 228
Assert function 115 ClusterSwapActive Cicode function 228
AssGetProperty Cicode function 668 code debugging 98
AssGetScale Cicode function 669 CodeSetMode Cicode function 704
AssInfo Cicode function 670 CodeTrace Cicode function 501
AssInfoEx Cicode function 672 cohesion 110
AssPage Cicode function 674 color Cicode functions 231
AssPopUp Cicode function 675 ComClose Cicode function 235
AssScaleStr Cicode function 676 comments 38
AssTag Cicode function 678 formatting 106
AssTitle Cicode function 679 communication Cicode functions 235
AssVarTags Cicode function 679 ComOpen Cicode function 236
AssWin Cicode function 680 Compile Errors window 94
ComRead Cicode function 238
B ComReset Cicode function 239
ComWrite Cicode function 239
background tasks 83
constants, standards for 103
Beep Cicode function 496
controlling tasks 83
bit operators 74
converting integers to strings 67
Breakpoint window 92
copying
breakpoints 99
variables 17
browse function field reference 885
Cos Cicode function 481
coupling 111
C CreateControlObject Cicode function 128
calculations CreateObject Cicode function 130
variables in 18
CallEvent Cicode function 369 D
caret (^) character 27
data
ChainEvent Cicode function 371
displaying, using expressions 23
CharToStr Cicode function 640
898
Index
logging expression 24 DevFind Cicode function 260

returning 28 DevFirst Cicode function 261
data operators 73 DevFlush Cicode function 262
Date Cicode function 735 DevGetField Cicode function 262
date functions 32 DevHistory Cicode function 263
DateAdd Cicode function 736 device Cicode functions 255
DateDay Cicode function 737 DevInfo Cicode function 264
DateInfo Cicode function 738 DevModify Cicode function 265
DateMonth Cicode function 739 DevNext Cicode function 266
DateSub Cicode function 739 DevOpen Cicode function 267
DateWeekDay Cicode function 740 DevOpenGrp Cicode function 268
DateYear Cicode function 741 DevPrev Cicode function 269
DDE Cicode functions 243 DevPrint Cicode function 270
DDEExec Cicode function 244 DevRead Cicode function 271
DDEhExecute Cicode function 244 DevReadLn Cicode function 271
DDEhGetLastError Cicode function 245 DevRecNo Cicode function 272
DDEhInitiate Cicode function 246 DevSeek Cicode function 272
DDEhPoke Cicode function 247 DevSetField Cicode function 273
DDEhReadLn Cicode function 248 DevSize Cicode function 274
DDEhRequest Cicode function 248 DevWrite Cicode function 274
DDEhSetMode Cicode function 249 DevWriteLn Cicode function 275
DDEhTerminate Cicode function 250 DevZap Cicode function 276
DDEhWriteLn Cicode function 250 display Cicode functions 279
DDEPost Cicode function 251 displaying data 23
DDERead Cicode function 252 DisplayRuntimeManager 504
DDEWrite Cicode function 253 DLL Cicode functions 351
DebugBreak Cicode function 502 DLLCall Cicode function 351
debugging 100 DLLCallEx Cicode Function 352
error trapping 114 DLLOpen Cicode function 353
debugging breakpoints 99 DriverInfo Cicode function 451
debugging code 98 DspAnCreateControlObject Cicode function 281
debugging functions 39 DspAnFree Cicode function 282
DebugMsg Cicode function 502 DspAnGetArea Cicode function 283
DebugMsg function 115 DspAnGetPos Cicode function 283
DebugMsgSet Cicode function 503 DspAnGetPrivilege Cicode function 284
decision-making 23 DspAnInfo Cicode function 285
declaration standards, variable 101 DspAnInRgn Cicode function 286
declaration, function 43 DspAnMove Cicode function 286
declarations, formatting 104 DspAnMoveRel Cicode function 287
default values for arguments 48 DspAnNew Cicode function 288
default variable values 52 DspAnNewRel Cicode function 288
defensive programming 112 DspBar Cicode function 289
DegToRad Cicode function 482 DspBmp Cicode function 290
DelayShutdown Cicode function 504 DspButton Cicode function 291
DevAppend Cicode function 256 DspButtonFn Cicode function 292
DevClose Cicode function 256 DspChart Cicode function 293
DevControl Cicode function 257 DspCol Cicode function 294
DevCurr Cicode function 258 DspDel Cicode function 295
DevDelete Cicode function 258 DspDelayRenderBegin Cicode function 295
DevDisable Cicode function 259 DspDelayRenderEnd Cicode function 296
DevEOF Cicode function 260 DspDirty Cicode function 297
899
Index
DspError Cicode function 298 DspRubSetClip Cicode function 336

DspFile Cicode function 298 DspRubStart Cicode function 337
DspFileGetInfo Cicode function 299 DspSetSlider Cicode function 338
DspFileGetName Cicode function 300 DspSetTip Cicode function 339
DspFileScroll Cicode function 300 DspSetTooltipFont Cicode function 339
DspFileSetName Cicode function 301 DspStatus Cicode function 340
DspFont Cicode function 302 DspStr Cicode function 341
DspFontHnd Cicode function 303 DspSym Cicode function 341
DspFullScreen Cicode function 304 DspSymAnm Cicode function 342
DspGetAnBottom Cicode function 305 DspSymAnmEx Cicode function 343
DspGetAnCur Cicode function 306 DspSymAtSize Cicode function 344
DspGetAnExtent Cicode function 306 DspText Cicode function 345
DspGetAnFirst Cicode function 307 DspTipMode Cicode function 346
DspGetAnFromPoint Cicode function 307 DspTrend Cicode function 347
DspGetAnHeight Cicode function 309 DspTrendInfo Cicode function 348
DspGetAnLeft Cicode function 309 DumpKernel Cicode function 505
DspGetAnNext Cicode function 310
DspGetAnRight Cicode function 310 E
DspGetAnTop Cicode function 310
EngToGeneric Cicode function 505
DspGetAnWidth Cicode function 311
EnterCriticalSection Cicode function 705
DspGetEnv Cicode function 311
ErrCom Cicode function 357
DspGetMouse Cicode function 312
ErrDrv Cicode function 358
DspGetMouseOver Cicode function 313
ErrGetHw Cicode function 359
DspGetNearestAn Cicode function 313
ErrHelp Cicode function 360
DspGetParentAn Cicode function 314
ErrInfo Cicode function 361
DspGetSlider Cicode function 314
ErrLog Cicode function 361
DspGetTip Cicode function 315
ErrMsg Cicode function 362
DspGrayButton Cicode function 315
error Cicode functions 357
DspInfo Cicode function 316
error handling 113
DspInfoDestroy Cicode function 318
error messages 861
DspInfoField Cicode function 319
error trapping 114
DspInfoNew Cicode function 320
errors
DspInfoValid Cicode function 321
Cicode 862
DspIsButtonGray Cicode function 321
general 862
DspKernel Cicode function 322
Hardware Cicode errors 861
DspMarkerMove Cicode function 323
MAPI 882
DspMarkerNew Cicode function 323
ErrSet Cicode function 362
DspMCI Cicode function 324
ErrSetHw Cicode function 363
DspPlaySound Cicode function 325
ErrSetLevel Cicode function 365
DspPopupMenu Cicode function 326
ErrTrap Cicode function 366
DspRichText Cicode function 328
escape sequence character 27
DspRichTextEdit Cicode function 329
escape sequences 70
DspRichTextEnable Cicode function 330
evaluating functions 25
DspRichTextGetInfo Cicode function 330
event Cicode functions 369
DspRichTextLoad Cicode function 331
events
DspRichTextPgScroll Cicode function 332
handling 81
DspRichTextPrint Cicode function 333
triggering 24
DspRichTextSave Cicode function 334
Exec Cicode function 506
DspRichTextScroll Cicode function 334
ExecuteDTSPkg Cicode function 619
DspRubEnd Cicode function 335
Exp Cicode function 482
DspRubMove Cicode function 336
900
Index
expression data, logging 24 format Cicode functions 427

expressions 23 format operator (:) 67
decision-making with 23 formatting
triggering events using 24 comments 106
expressions, formatting 105 expressions 105
function headers 109
F functions 106
simple declarations 104
Fact Cicode function 483
text strings 69
fields for browse functions 885
formatting statements 104
file Cicode functions 379
FormButton Cicode function 397
file headers 37
FormCheckBox Cicode function 398
FileClose Cicode function 379
FormComboBox Cicode function 399
FileCopy Cicode function 380
FormCurr Cicode function 401
FileDelete Cicode function 381
FormDestroy Cicode function 401
FileEOF Cicode function 381
FormEdit Cicode function 402
FileExist Cicode function 382
FormField Cicode function 403
FileFind Cicode function 382
FormGetCurrInst Cicode function 405
FileFindClose Cicode function 383
FormGetData Cicode function 405
FileGetTime Cicode function 384
FormGetInst Cicode function 406
FileMakePath Cicode function 384
FormGetText Cicode function 407
FileOpen Cicode function 385
FormGoto Cicode function 408
FilePrint Cicode function 386
FormGroupBox Cicode function 408
FileRead Cicode function 387
FormInput Cicode function 409
FileReadBlock Cicode function 387
FormListAddText Cicode function 410
FileReadLn Cicode function 388
FormListBox Cicode function 411
FileRename Cicode function 389
FormListDeleteText Cicode function 412
FileRichTextPrint Cicode function 389
FormListSelectText Cicode function 413
files
FormNew Cicode function 414
include 19
FormNumPad Cicode function 415
using 13
FormOpenFile Cicode function 416
Files window 95
FormPassword Cicode function 417
FileSeek Cicode function 390
FormPosition Cicode function 418
FileSetTime Cicode function 391
FormPrompt Cicode function 418
FileSize Cicode function 391
FormRadioButton Cicode function 419
FileSplitPath Cicode function 392
FormRead Cicode function 420
FileWrite Cicode function 393
FormSaveAsFile Cicode function 421
FileWriteBlock Cicode function 393
FormSecurePassword 422
FileWriteLn Cicode function 394
FormSecurePassword Cicode function 422
FmtClose Cicode function 427
FormSelectPrinter Cicode function 423
FmtFieldHnd Cicode function 428
FormSetData Cicode function 423
FmtGetField Cicode function 428
FormSetInst Cicode function 424
FmtGetFieldHnd Cicode function 429
FormSetText Cicode function 425
FmtOpen Cicode function 429
FormWndHnd Cicode function 425
FmtSetField Cicode function 430
FTP Cicode functions 433
FmtSetFieldHnd Cicode function 431
FTPClose Cicode function 433
FmtToStr Cicode function 431
FTPFileCopy Cicode function 434
foreground tasks 83
FTPFileFind Cicode function 434
form Cicode functions 395
FTPFileFindClose Cicode function 435
FormActive Cicode function 396
FTPOpen Cicode function 436
FormAddList Cicode function 396
FullName Cicode function 586
901
Index
function headers 109 GrpMath Cicode function 446

function libraries 37 GrpName Cicode function 447
functions GrpNext Cicode function 447
arguments and 26 GrpOpen Cicode function 448
Assert 115 GrpToStr Cicode function 449
debugging 39
DebugMsg 115 H
declaration 43
Halt Cicode function 706
evaluating 25
handling events 81
event handling 81
handling, error 113
formatting 106
hardware alarms 861
groups 36
Hardware Cicode errors 861
keyboard 32
headers, file 37, 108
libraries 37
headers, function 109
miscellaneous 32
HexToStr Cicode function 640
page 31
HighByte Cicode function 483
report 32
HighWord Cicode function 484
returning values 49
HtmlHelp Cicode function 832
scope of 41
structure of 35
syntax 40 I
table 59 I/O device Cicode functions 451
time and date 32 IFDEF macro 61
FuzzyClose Cicode function 437 IFDEFAdvAlm macro 62
FuzzyGetCodeValue Cicode function 437 IFDEFAnaAlm macro 63
FuzzyGetShellValue Cicode function 438 IFDEFDigAlm 63
FuzzyOpen Cicode function 439 include files 19
FuzzySetCodeValue Cicode function 440 InfoForm Cicode function 508
FuzzySetShellValue Cicode function 440 InfoFormAn Cicode function 509
FuzzyTech Cicode functions 437 Input Cicode function 509
FuzzyTrace Cicode function 441 input, runtime operator 20
integers 67
G IntToReal Cicode function 510
IntToStr Cicode function 641
general errors 862
IODeviceControl Cicode function 452
GetArea Cicode function 507
IODeviceInfo Cicode function 455
GetBlueValue Cicode function 231
IODeviceStats Cicode function 458
GetEnv Cicode function 507
IsError Cicode function 366
GetEvent Cicode function 372
GetGreenValue Cicode function 232
GetPriv Cicode function 586 K
GetRedValue Cicode function 232 KerCmd Cicode function 511
GetWinTitle Cicode function 832 KernelQueueLength Cicode function 511
Global variable window 92 KernelTableInfo Cicode function 512
group Cicode functions 443 KernelTableItemCount Cicode function 513
groups of functions 36 KeyAllowCursor Cicode function 461
GrpClose Cicode function 443 keyboard Cicode functions 461
GrpDelete Cicode function 444 keyboard functions 32
GrpFirst Cicode function 444 KeyBs Cicode function 462
GrpIn Cicode function 445 KeyDown Cicode function 463
GrpInsert Cicode function 445 KeyGet Cicode function 463
902
Index
KeyGetCursor Cicode function 464 module variables 53

KeyLeft Cicode function 464 MsgBrdcst Cicode function 707
KeyMove Cicode function 465 MsgClose Cicode function 708
KeyPeek Cicode function 465 MsgGetCurr Cicode function 708
KeyPut Cicode function 466 MsgOpen Cicode function 709
KeyPutStr Cicode function 467 MsgRead Cicode function 711
KeyReplay Cicode function 467 MsgRPC Cicode function 712
KeyReplayAll Cicode function 468 MsgState Cicode function 713
KeyRight Cicode function 468 MsgWrite Cicode function 715
KeySetCursor Cicode function 469 multiple arguments'arguments
KeySetSeq Cicode function 469 multiple 27
KeyUp Cicode function 470 multiple statements 18
MultiSignatureForm 590
L MultiSignatureTagWrite 591
multitasking 82–83
labels, standards for 103
LanguageFileTranslate Cicode function 513
LeaveCriticalSection Cicode function 706 N
libraries of functions 37 Name Cicode function 592
LLClose Cicode function 353 naming standards, variables 102
Ln Cicode function 484
Log Cicode function 485 O
logging expression data 24
ObjectAssociateEvents Cicode function 131
logic 23
ObjectAssociatePropertyWithTag Cicode
logical operators 75
function 132
Login Cicode function 588
ObjectByName Cicode function 133
LoginForm Cicode function 588
ObjectHasInterface Cicode function 133
Logout Cicode function 589
ObjectIsValid Cicode function 134
LogoutIdle Cicode function 589
ObjectToStr Cicode function 135
LowByte Cicode function 485
OLEDateToTime Cicode function 742
LowWord Cicode function 486
one-dimensional variable arrays 57
OnEvent Cicode function 374
M operator precedence 76
macro arguments 64 operator, format 67
mail Cicode functions 473 operators
MailError Cicode function 473 bit 74
MailLogoff Cicode function 474 logical 75
MailLogon Cicode function 474 relational 74
MailRead Cicode function 475 operators, data 73
MailSend Cicode function 476 Output window 92
MakeCitectColour Cicode function 233
MAPI errors 882 P
math/trigonometry Cicode functions 479
PackedRGB Cicode function 233
mathematical operators 73
PackedRGBToCitectColour Cicode function 234
Max Cicode function 486
page Cicode functions 537
Message Cicode function 514
page functions 31
messages, error 861
PageAlarm Cicode function 538
Min Cicode function 487
PageDisabled Cicode function 538
miscellaneous Cicode functions 493
PageDisplay Cicode function 539
miscellaneous functions 32
PageFile Cicode function 541
modular programming 109–111
903
Index
PageFileInfo Cicode function 541 ProjectRestartSet Cicode function 518

PageGetInt Cicode function 542 ProjectSet Cicode function 519
PageGetStr Cicode function 542 Prompt Cicode function 519
PageGoto Cicode function 543 pseudocode 37
PageHardware Cicode function 544 public scope 41
PageInfo Cicode function 545 Pulse Cicode function 520
PageLast Cicode function 546
PageMenu Cicode function 547 Q
PageNext Cicode function 548
QueClose Cicode function 715
PagePeekLast Cicode function 549
QueLength Cicode function 716
PagePopLast Cicode function 549
QueOpen Cicode function 716
PagePopUp Cicode function 550
QuePeek Cicode function 717
PagePrev Cicode function 551
QueRead Cicode function 718
PagePushLast Cicode function 551
QueryFunction Cicode function 217
PageRichTextFile Cicode function 552
QueWrite Cicode function 719
PageSelect Cicode function 554
PageSetInt Cicode function 554
PageSetStr Cicode function 555 R
PageSummary Cicode function 555 RadToDeg Cicode function 488
PageTrend Cicode function 556 Rand Cicode function 489
ParameterGet Cicode function 515 RealToStr Cicode function 642
ParameterPut Cicode function 515 relational operators 74
passing data to arguments 26 RepGetControl Cicode function 580
PathToStr Cicode function 641 Report Cicode function 580
Pi Cicode function 487 report Cicode functions 579
plot Cicode functions 561 report functions 32
PlotClose Cicode function 561 ReportGetCluster Cicode function 579
PlotDraw Cicode function 562 RepSetControl Cicode function 581
PlotGetMarker Cicode function 563 ReRead Cicode function 720
PlotGrid Cicode function 564 returning data from functions 28
PlotInfo Cicode function 566 returning values from functions 49
PlotLine Cicode function 567 Round Cicode function 489
PlotMarker Cicode function 569 runtime operator input 20
PlotOpen Cicode function 571 runtime operator input triggering 25
PlotScaleMarker Cicode function 573
PlotSetMarker Cicode function 574 S
PlotText Cicode function 575
scope 52, 102
PlotXYLine Cicode function 576
scope, function 41
Pow Cicode function 488
security Cicode functions 585
precedence, operator 76
SemClose Cicode function 721
pre-emptive multitasking 83
SemOpen Cicode function 721
Print Cicode function 276
SemSignal Cicode function 722
PrintFont Cicode function 277
SemWait Cicode function 723
PrintLn Cicode function 278
SendKeys Cicode function 471
private scope 41
sequences, escape 70
ProcessIsClient Cicode function 516
SerialKey Cicode function 240
ProcessIsServer Cicode function 516
ServerInfo Cicode function 520
ProcessRestart Cicode function 517
ServerInfoEx Cicode function 522
programming standards 101
ServerRestart Cicode function 524
programming, modular 109
ServiceGetList Cicode function 525
ProjectRestartGet Cicode function 518
904
Index
SetArea Cicode function 526 using multiple 18

SetEvent Cicode function 377 statements, executable 104
SetLanguage Cicode function 526 stepping through code 100
setting StrClean Cicode function 642
variables 17 StrFill Cicode function 643
Shutdown Cicode function 527 StrFormat Cicode function 643
ShutdownForm Cicode function 529 StrGetChar Cicode function 644
ShutdownMode Cicode function 530 string arguments 26
Sign Cicode function 490 string Cicode functions 639
Sin Cicode function 490 strings 67
Sleep Cicode function 723 strings, formatting 69
SleepMS Cicode function 724 StrLeft Cicode function 645
source file headers 108 StrLength Cicode function 645
SPC Cicode functions 605 StrLower Cicode function 646
SPCAlarms Cicode function 605 StrMid Cicode function 646
SPCClientInfo Cicode function 606 StrPad Cicode function 647
SPCGetHistogramTable Cicode function 607 StrRight Cicode function 648
SPCGetSubgroupTable Cicode function 608 StrSearch Cicode function 648
SPCPlot Cicode function 609 StrSetChar Cicode function 649
SPCProcessXRSGet Cicode function 610 StrToChar Cicode function 650
SPCProcessXRSSet Cicode function 612 StrToDate Cicode function 650
SPCSetLimit Cicode function 612 StrToFmt Cicode function 651
SPCSpecLimitGet Cicode function 613 StrToGrp Cicode function 651
SPCSpecLimitSet Cicode function 614 StrToHex Cicode function 652
SPCSubgroupSizeGet Cicode function 615 StrToInt Cicode function 653
SPCSubgroupSizeSet Cicode function 616 StrToLines Cicode function 653
SQL Cicode functions 619 StrToLocalText Cicode function 654
SQLAppend Cicode function 621 StrToPeriod Cicode function 655
SQLBeginTran Cicode function 622 StrToReal Cicode function 656
SQLCommit Cicode function 623 StrToTime Cicode function 656
SQLConnect Cicode function 624 StrToValue Cicode function 657
SQLDisconnect Cicode function 626 StrTrim Cicode function 658
SQLEnd Cicode function 627 structure of functions 35
SQLErrMsg Cicode function 627 structure, argument 44
SQLExec Cicode function 628 StrUpper Cicode function 658
SQLFieldInfo Cicode function 631 StrWord Cicode function 659
SQLGetField Cicode function 632 SubscriptionAddCallback Cicode function 459
SQLInfo Cicode function 633 SubscriptionGetAttribute Cicode function 459
SQLNext Cicode function 634 SubscriptionRemoveCallback Cicode function 460
SQLNoFields Cicode function 634 SuperGenie Cicode functions 661
SQLNumChange Cicode function 635 SwitchConfig Cicode function 530
SQLRollBack Cicode function 635 syntax 39
SQLSet Cicode function 636 SysTime Cicode function 743
SQLTraceOff Cicode function 637 SysTimeDelta Cicode function 743
SQLTraceOn Cicode function 637
Sqrt Cicode function 491 T
Stack window 93
table (array) Cicode functions 683
standards, for constants, variables and labels 103
TableLookup Cicode function 683
standards, naming, for variables 102
TableMath Cicode function 684
standards, programming 101
TableShift Cicode function 685
statements
905
Index
Tag Cicode functions 687 trapping, error 114

TagDebug Cicode function 687 trend Cicode functions 753
TagGetProperty Cicode function 688 TrendDspCursorScale Cicode function 755
TagGetScale Cicode function 689 TrendDspCursorTag Cicode function 756
TagInfo Cicode function 690 TrendDspCursorTime Cicode function 756
TagInfoEx Cicode function 692 TrendDspCursorValue Cicode function 757
TagRamp Cicode function 694 TrendGetAn Cicode function 758
TagRDBReload Cicode function 695 TrendPopUp Cicode function 758
TagRead Cicode function 695 TrendRun Cicode function 759
TagScaleStr Cicode function 697 TrendSetDate Cicode function 759
TagSubscribe Cicode function 697 TrendSetScale Cicode function 760
TagUnsubscribe Cicode function 699 TrendSetSpan Cicode function 761
TagWrite Cicode function 700 TrendSetTime Cicode function 761
TagWriteEventQue Cicode function 701 TrendSetTimebase Cicode function 762
Tan Cicode function 491 TrendWin Cicode function 762
task Cicode functions 703 TrendZoom Cicode function 764
TaskCluster Cicode function 725 triggering
TaskGetSignal Cicode function 726 runtime operator input 25
TaskHnd Cicode function 727 triggering events 24
TaskKill Cicode function 727 TrnAddHistory Cicode function 765
TaskNew Cicode function 728 TrnBrowseClose Cicode function 766
TaskNewEx Cicode function 730 TrnBrowseFirst Cicode function 766
TaskResume Cicode function 731 TrnBrowseGetField Cicode function 766
tasks TrnBrowseNext Cicode function 767
controlling 83 TrnBrowseNumRecords Cicode function 768
tasks, foreground and background 83 TrnBrowseOpen Cicode function 769
TaskSetSignal Cicode function 732 TrnBrowsePrev Cicode function 770
TaskSuspend Cicode function 732 TrnClientInfo Cicode function 770
TestRandomWave Cicode function 531 TrnComparePlot Cicode function 771
TestSawWave Cicode function 532 TrnDelete Cicode function 773
TestSinWave Cicode function 532 TrnDelHistory Cicode function 773
TestSquareWave Cicode function 533 TrnEcho Cicode function 774
TestTriangWave Cicode function 534 TrnEventGetTable Cicode function 775
text files 19 TrnEventGetTableMS Cicode function 776
text strings, formatting 69 TrnEventSetTable Cicode function 778
Thread window 93 TrnEventSetTableMS Cicode function 779
threads 83 TrnExportClip Cicode function 781
time and date Cicode functions 735 TrnExportCSV Cicode function 783
Time Cicode function 744 TrnExportDBF Cicode function 785
time functions 32 TrnExportDDE Cicode function 787
TimeCurrent Cicode function 745 TrnFlush Cicode function 789
TimeHour Cicode function 746 TrnGetBufEvent Cicode function 789
TimeInfo Cicode function 746 TrnGetBufTime Cicode function 790
TimeMidNight Cicode function 747 TrnGetBufValue Cicode function 791
TimeMin Cicode function 748 TrnGetCluster Cicode function 792
TimeSec Cicode function 749 TrnGetCursorEvent Cicode function 792
TimeToOLEDate Cicode function 749 TrnGetCursorMSTime Cicode function 793
TimeToStr Cicode function 750 TrnGetCursorPos Cicode function 793
TimeUTCOffset Cicode function 751 TrnGetCursorTime Cicode function 794
Toggle Cicode function 535 TrnGetCursorValue Cicode function 795
TraceMsg Cicode function 535 TrnGetCursorValueStr Cicode function 795
906
Index
TrnGetDefScale Cicode function 796 using

TrnGetDisplayMode Cicode function 797 files 13
TrnGetEvent Cicode function 798 multiple statements 18
TrnGetFormat Cicode function 799
TrnGetGatedValue Cicode function 800 V
TrnGetInvalidValue Cicode function 800
variable arrays
TrnGetMode Cicode function 801
functions 59
TrnGetMSTime Cicode function 802
one-dimensional 57
TrnGetPen Cicode function 803
variable scope 52
TrnGetPenComment Cicode function 804
variable tags, standards for 103
TrnGetPenFocus Cicode function 804
variables 51, 70
TrnGetPenNo Cicode function 805
copying 17
TrnGetPeriod Cicode function 806
declaration standards 101
TrnGetScale Cicode function 806
default values for 52
TrnGetScaleStr Cicode function 807
in calculations 18
TrnGetSpan Cicode function 808
module 53
TrnGetTable Cicode function 809
naming standards 102
TrnGetTime Cicode function 811
scope standards 102
TrnGetUnits Cicode function 812
setting 17
TrnInfo Cicode function 812
VerifyPrivilegeForm 601
TrnIsValidValue Cicode function 813
VerifyPrivilegeTagWrite 602
TrnNew Cicode function 814
Version Cicode function 536
TrnPlot Cicode function 815
TrnPrint Cicode function 816
TrnSamplesConfigured Cicode function 818 W
TrnScroll Cicode function 818 WhoAmI Cicode function 603
TrnSelect Cicode function 819 WinCopy Cicode function 833
TrnSetCursor Cicode function 820 WinFile Cicode function 835
TrnSetCursorPos Cicode function 821 WinFree Cicode function 836
TrnSetDisplayMode Cicode function 821 WinGetFocus Cicode function 837
TrnSetEvent Cicode function 822 WinGetWndHnd Cicode function 837
TrnSetPen Cicode function 823 WinGoto Cicode function 838
TrnSetPenFocus Cicode function 824 WinMode Cicode function 838
TrnSetPeriod Cicode function 825 WinMove Cicode function 839
TrnSetScale Cicode function 825 WinNew Cicode function 840
TrnSetSpan Cicode function 826 WinNewAt Cicode function 841
TrnSetTable Cicode function 827 WinNext Cicode function 843
TrnSetTime Cicode function 828 WinNumber Cicode function 844
WinPos Cicode function 844
U WinPrev Cicode function 845
WinPrint Cicode function 845
UserCreate Cicode function 592
WinPrintFile Cicode function 847
UserCreateForm Cicode function 593
WinSelect Cicode function 848
UserDelete Cicode function 594
WinSize Cicode function 849
UserEditForm Cicode function 594
WinStyle Cicode function 850
UserInfo Cicode function 595
WinTitle Cicode function 850
UserLogin Cicode function 596
WndFind Cicode function 851
UserPassword Cicode function 598
WndGetFileProfile Cicode function 852
UserPasswordExpiryDays Cicode function 599
WndHelp Cicode function 852
UserPasswordForm Cicode function 599
WndInfo Cicode function 854
UserVerify Cicode function 600
WndPutFileProfile Cicode function 855
907
Index
WndShow Cicode function 856

WndViewer Cicode function 857
writing functions 36
908

CitectSCADA Cicode Reference

Uploaded by

Copyright:

Available Formats

CitectSCADA Cicode Reference

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

CitectSCADA Cicode Reference

Uploaded by

Copyright:

Available Formats

v7.

Cicode Reference Guide

November 2008 edition for CitectSCADA Version v7.10

Contact Citect today at www.Citect.com

Chapter: 1 Introducing Cicode....................................................13

Using Cicode ...............................................................................15

Chapter: 2 Using Cicode Commands.........................................17

Chapter: 3 Using Cicode Expressions.......................................23

Chapter: 4 Using Cicode Functions ...........................................25

Chapter: 5 Working with Commonly Used Functions ..............31

Keyboard Functions ..............................................................................32

Chapter: 6 Writing Functions......................................................35

Chapter: 7 Using Variables .........................................................51

Chapter: 8 Using Arrays..............................................................55

Chapter: 9 Using Cicode Macros................................................61

Chapter: 10 Converting and Formatting Cicode Variables ......67

Chapter: 11 Working with Operators..........................................73

Chapter: 12 Working with Conditional Executors.....................77

Chapter: 13 Performing Advanced Tasks..................................81

Chapter: 14 Editing and Debugging Code.................................85

Compiling Cicode files ..............................................................89

Chapter: 15 Using Cicode Programming Standards ..............101

Chapter: 16 Accumulator Functions ........................................119

Chapter: 17 ActiveX Functions.................................................125

Chapter: 18 Alarm Functions....................................................137

Chapter: 19 Clipboard Functions .............................................219

Chapter: 20 Cluster Functions..................................................223

Chapter: 21 Color Functions.....................................................231

Chapter: 22 Communication Functions...................................235

Chapter: 23 Dynamic Data Exchange Functions ....................243

Chapter: 24 Device Functions...................................................255

Chapter: 25 Display Functions .................................................279

Chapter: 26 DLL Functions .......................................................351

Chapter: 27 Error Functions .....................................................357

Chapter: 28 Event Functions ....................................................369

Chapter: 29 File Functions........................................................379

Chapter: 30 Form Functions .....................................................395

Chapter: 31 Format Functions..................................................427

Chapter: 32 FTP Functions .......................................................433

Chapter: 33 FuzzyTech Functions............................................437

Chapter: 34 Group Functions ...................................................443

Chapter: 35 I/O Device Functions.............................................451

Chapter: 36 Keyboard Functions..............................................461

Chapter: 37 Mail Functions .......................................................473

Chapter: 38 Math and Trigonometry Functions ......................479

Chapter: 39 Miscellaneous Functions......................................493

Chapter: 40 Page Functions......................................................537

Chapter: 41 Plot Functions .......................................................561

Chapter: 42 Report Functions...................................................579

Chapter: 43 Security Functions................................................585

Chapter: 44 Statistical Process Control Functions ................605

Chapter: 45 SQL Functions.......................................................619

Chapter: 46 String Functions....................................................639

Chapter: 47 Super Genie Functions.........................................661

Chapter: 48 Table (Array) Functions........................................683

Chapter: 49 Tag Functions........................................................687

Chapter: 50 Task Functions......................................................703

Chapter: 51 Time and Date Functions......................................735

Chapter: 52 Trend Functions ....................................................753