These are defined in labels.dbf in
the Include project. They can also be found in the Citect help page
'Predefined Labels'. Following is taken from labels.dbf, grouped by
topic, and with some additional notes.
| Animation
Constants
|
|
|
| ANIMATE
|
2
|
Display mode 2
|
| ANM_ARRAY
|
16
|
Animated symbols in array
mode
|
| BORDER
|
2
|
Border Only
|
| BORDER_3D
|
1
|
3D Transparent Button
|
| DELETE_ANM
|
0
|
Delete animation
|
| GRAY_ALL
|
3
|
Gray the entire button
|
| GRAY_HIDE
|
4
|
Hide object when
greyed
|
| GRAY_PART
|
2
|
Sink and gray the text /
symbol
|
| GRAY_SUNK
|
1
|
Sink the text / symbol
|
| NO_CHANGE
|
-1
|
No change in animation
|
| NORMAL
|
0
|
Normal Button
|
| OVERLAP
|
1
|
Display mode 1
|
| SOFT
|
0
|
Display mode 0
|
| TARGET
|
3
|
Screen Target
|
| WRITE_ON_DRAG
|
1
|
Write mode for slider
|
| WRITE_ON_DROP
|
0
|
Write mode for slider
|
| XP_STYLE
|
4
|
XP Style Button
|
|
|
|
|
| Color Constants
|
|
|
| BLACK
|
0x00000000
|
|
| BLUE
|
0x00000080
|
|
| BROWN
|
0x00808000
|
|
| CYAN
|
0x00008080
|
|
| DARK_GREY
|
0x007F7F7F
|
|
| GREEN
|
0x00008000
|
|
| GREY
|
0x00BFBFBF
|
|
| LIGHT_BLUE
|
0x000000FF
|
|
| LIGHT_CYAN
|
0x0000FFFF
|
|
| LIGHT_GREEN
|
0x0000FF00
|
|
| LIGHT_MAGENTA
|
0x00FF00FF
|
|
| LIGHT_RED
|
0x00FF0000
|
|
| MAGENTA
|
0x00800080
|
|
| RED
|
0x00800000
|
|
| TRANSPARENT
|
0xFF000000
|
|
| WHITE
|
0x00FFFFFF
|
|
| YELLOW
|
0x00FFFF00
|
|
|
|
|
|
| Compile
Information
|
|
|
| __DATE__
|
$1
|
Date of compilation
|
| __DB__
|
$4
|
Compiler database name
|
| __FIELD__
|
$6
|
Compiler field name
|
| __FILE__
|
$2
|
Compiler file name
|
| __LINE__
|
$3
|
Compiler line number
|
| __RECORD__
|
$5
|
Compiler record number
|
| __TIME__
|
$0
|
Time of compilation
|
|
|
|
|
| Device Constants
|
|
|
| ASCII_DEV
|
0
|
Ascii Device number
|
| dBASE_DEV
|
2
|
dBASE device number
|
| PRINTER_DEV
|
1
|
Printer Device number
|
| SQL_DEV
|
4
|
SQL device number
|
|
|
|
|
| Keyboard Constants
|
|
|
| KEY_A_ALT
|
0x4041
|
|
| KEY_A_CTRL
|
0x2041
|
|
| KEY_A_SHIFT
|
0x1041
|
|
| KEY_B_ALT
|
0x4042
|
|
| KEY_B_CTRL
|
0x2042
|
|
| KEY_B_SHIFT
|
0x1042
|
|
| KEY_B_ALT
|
0x4042
|
|
| KEY_B_CTRL
|
0x2042
|
|
| KEY_B_SHIFT
|
0x1042
|
|
| KEY_C_ALT
|
0x4043
|
|
| KEY_C_CTRL
|
0x2043
|
|
| KEY_C_SHIFT
|
0x1043
|
|
| KEY_D_ALT
|
0x4044
|
|
| KEY_D_CTRL
|
0x2044
|
|
| KEY_D_SHIFT
|
0x1044
|
|
| KEY_E_ALT
|
0x4045
|
|
| KEY_E_CTRL
|
0x2045
|
|
| KEY_E_SHIFT
|
0x1045
|
|
| KEY_F_ALT
|
0x4046
|
|
| KEY_F_CTRL
|
0x2046
|
|
| KEY_F_SHIFT
|
0x1046
|
|
| KEY_G_ALT
|
0x4047
|
|
| KEY_G_CTRL
|
0x2047
|
|
| KEY_G_SHIFT
|
0x1047
|
|
| KEY_H_ALT
|
0x4048
|
|
| KEY_H_CTRL
|
0x2048
|
|
| KEY_H_SHIFT
|
0x1048
|
|
| KEY_I_ALT
|
0x4049
|
|
| KEY_I_CTRL
|
0x2049
|
|
| KEY_I_SHIFT
|
0x1049
|
|
| KEY_J_ALT
|
0x404A
|
|
| KEY_J_CTRL
|
0x204A
|
|
| KEY_J_SHIFT
|
0x104A
|
|
| KEY_K_ALT
|
0x404B
|
|
| KEY_K_CTRL
|
0x204B
|
|
| KEY_K_SHIFT
|
0x104B
|
|
| KEY_L_ALT
|
0x404C
|
|
| KEY_L_CTRL
|
0x204C
|
|
| KEY_L_SHIFT
|
0x104C
|
|
| KEY_M_ALT
|
0x404D
|
|
| KEY_M_CTRL
|
0x204D
|
|
| KEY_M_SHIFT
|
0x104D
|
|
| KEY_N_ALT
|
0x404E
|
|
| KEY_N_CTRL
|
0x204E
|
|
| KEY_N_SHIFT
|
0x104E
|
|
| KEY_O_ALT
|
0x404F
|
|
| KEY_O_CTRL
|
0x204F
|
|
| KEY_O_SHIFT
|
0x104F
|
|
| KEY_P_ALT
|
0x4050
|
|
| KEY_P_CTRL
|
0x2050
|
|
| KEY_P_SHIFT
|
0x1050
|
|
| KEY_Q_ALT
|
0x4051
|
|
| KEY_Q_CTRL
|
0x2051
|
|
| KEY_Q_SHIFT
|
0x1051
|
|
| KEY_R_ALT
|
0x4052
|
|
| KEY_R_CTRL
|
0x2052
|
|
| KEY_R_SHIFT
|
0x1052
|
|
| KEY_S_ALT
|
0x4053
|
|
| KEY_S_CTRL
|
0x2053
|
|
| KEY_S_SHIFT
|
0x1053
|
|
| KEY_T_ALT
|
0x4054
|
|
| KEY_T_CTRL
|
0x2054
|
|
| KEY_T_SHIFT
|
0x1054
|
|
| KEY_U_ALT
|
0x4055
|
|
| KEY_U_CTRL
|
0x2055
|
|
| KEY_U_SHIFT
|
0x1055
|
|
| KEY_V_ALT
|
0x4056
|
|
| KEY_V_CTRL
|
0x2056
|
|
| KEY_V_SHIFT
|
0x1056
|
|
| KEY_W_ALT
|
0x4057
|
|
| KEY_W_CTRL
|
0x2057
|
|
| KEY_W_SHIFT
|
0x1057
|
|
| KEY_X_ALT
|
0x4058
|
|
| KEY_X_CTRL
|
0x2058
|
|
| KEY_X_SHIFT
|
0x1058
|
|
| KEY_Y_ALT
|
0x4059
|
|
| KEY_Y_CTRL
|
0x2059
|
|
| KEY_Y_SHIFT
|
0x1059
|
|
| KEY_Z_ALT
|
0x405A
|
|
| KEY_Z_CTRL
|
0x205A
|
|
| KEY_Z_SHIFT
|
0x105A
|
|
| KEY_F1
|
0x0170
|
|
| KEY_F1_CTRL
|
0x2170
|
|
| KEY_F1_SHIFT
|
0x1170
|
|
| KEY_F2
|
0x0171
|
|
| KEY_F2_CTRL
|
0x2171
|
|
| KEY_F2_SHIFT
|
0x1171
|
|
| KEY_F3
|
0x0172
|
|
| KEY_F3_CTRL
|
0x2172
|
|
| KEY_F3_SHIFT
|
0x1172
|
|
| KEY_F4
|
0x0173
|
|
| KEY_F4_CTRL
|
0x2173
|
|
| KEY_F4_SHIFT
|
0x1173
|
|
| KEY_F5
|
0x0174
|
|
| KEY_F5_CTRL
|
0x2174
|
|
| KEY_F5_SHIFT
|
0x1174
|
|
| KEY_F6
|
0x0175
|
|
| KEY_F6_CTRL
|
0x2175
|
|
| KEY_F6_SHIFT
|
0x1175
|
|
| KEY_F7
|
0x0176
|
|
| KEY_F7_CTRL
|
0x2176
|
|
| KEY_F7_SHIFT
|
0x1176
|
|
| KEY_F8
|
0x0177
|
|
| KEY_F8_CTRL
|
0x2177
|
|
| KEY_F8_SHIFT
|
0x1177
|
|
| KEY_F9
|
0x0178
|
|
| KEY_F9_CTRL
|
0x2178
|
|
| KEY_F9_SHIFT
|
0x1178
|
|
| KEY_F10
|
0x0179
|
|
| KEY_F10_CTRL
|
0x2179
|
|
| KEY_F10_SHIFT
|
0x1179
|
|
| KEY_F11
|
0x017A
|
|
| KEY_F11_CTRL
|
0x217A
|
|
| KEY_F11_SHIFT
|
0x117A
|
|
| KEY_F12
|
0x017B
|
|
| KEY_F12_CTRL
|
0x217B
|
|
| KEY_F12_SHIFT
|
0x117B
|
|
| KEY_F13
|
0x017C
|
|
| KEY_F13_CTRL
|
0x217C
|
|
| KEY_F13_SHIFT
|
0x117C
|
|
| KEY_F14
|
0x017D
|
|
| KEY_F14_CTRL
|
0x217D
|
|
| KEY_F14_SHIFT
|
0x117D
|
|
| KEY_F15
|
0x017E
|
|
| KEY_F15_CTRL
|
0x217E
|
|
| KEY_F15_SHIFT
|
0x117E
|
|
| KEY_F16
|
0x017F
|
|
| KEY_F16_CTRL
|
0x217F
|
|
| KEY_F16_SHIFT
|
0x117F
|
|
| KEY_DOWN
|
0x0128
|
|
| KEY_LEFT
|
0x0125
|
|
| KEY_RIGHT
|
0x0127
|
|
| KEY_UP
|
0x0126
|
|
| KEY_AND_ALT
|
0x4000
|
Add to code to get Alt
|
| KEY_AND_CTRL
|
0x2000
|
Add to code to get
Control
|
| KEY_AND_SHIFT
|
0x1000
|
Add to code to get
Shifted
|
| KEY_BACKSPACE
|
0x0008
|
|
| KEY_DELETE
|
0x012E
|
|
| KEY_END
|
0x0123
|
|
| KEY_ENTER
|
0x000D
|
|
| KEY_ESC
|
0x001B
|
|
| KEY_ESCAPE
|
0x001B
|
|
| KEY_FF
|
0x000C
|
|
| KEY_HELP
|
0x012F
|
|
| KEY_HOME
|
0x0124
|
|
| KEY_INSERT
|
0x012D
|
|
| KEY_LF
|
0x000A
|
|
| KEY_PGDN
|
0x0122
|
|
| KEY_PGUP
|
0x0121
|
|
| KEY_RETURN
|
0x000D
|
|
| KEY_SNAPSHOT
|
0x012C
|
|
| KEY_SNAPSHOT_CTRL
|
0x212C
|
|
| KEY_TAB
|
0x0009
|
|
| KEY_VT
|
0x000B
|
|
|
|
|
|
| Keyboard Input
Arguments
|
|
|
| Arg1
|
GetGlbStr(0)
|
keyboard argument 1
|
| Arg2
|
GetGlbStr(1)
|
keyboard argument 2
|
| Arg3
|
GetGlbStr(2)
|
keyboard argument 3
|
| Arg4
|
GetGlbStr(3)
|
keyboard argument 4
|
| Arg5
|
GetGlbStr(4)
|
keyboard argument 5
|
| Arg6
|
GetGlbStr(5)
|
keyboard argument 6
|
| Arg7
|
GetGlbStr(6)
|
keyboard argument 7
|
| Arg8
|
GetGlbStr(7)
|
keyboard argument 8
|
| ArgValue1
|
StrToValue(Arg1)
|
Get the value of argument
1
|
|
|
|
|
| Language Constants
|
|
|
| ANSI_CHARSET
|
0
|
ANSI character set
|
| ARABIC_CHARSET
|
178
|
|
| BALTIC_CHARSET
|
186
|
|
| CHINESEBIG5_CHARSET
|
136
|
Chinese character set
|
| DEFAULT_CHARSET
|
1
|
Use the default Windows
character set
|
| EASTEUROPE_CHARSET
|
238
|
|
| GB2312_CHARSET
|
134
|
Chinese character set
|
| GREEK_CHARSET
|
161
|
|
| HANGEUL_CHARSET
|
129
|
Korean character set
|
| HEBREW_CHARSET
|
177
|
|
| JOHAB_CHARSET
|
130
|
|
| RUSSIAN_CHARSET
|
204
|
|
| SHIFTJIS_CHARSET
|
128
|
Japanese character set
|
| THAI_CHARSET
|
222
|
|
| TURKISH_CHARSET
|
162
|
|
| VIETNAMESE_CHARSET
|
163
|
|
|
|
|
|
| Macro Functions
(Documented)
|
|
|
| AlarmFirstCatRec(hCat,nType,hArea=-1,ClusterName="")
|
_AlarmQueryFirstRec(hCat,nType,hArea,0,ClusterName)
|
Get Alarm Cat Rec with
Area
|
| AlarmFirstPriRec(hPri,nType,hArea=-1,ClusterName="")
|
_AlarmQueryFirstRec(hPri,nType,hArea,1,ClusterName)
|
Get Alarm Pri Rec with
Area
|
| AlarmNextCatRec(hRec,hCat,nType,hArea=-1,ClusterName="")
|
_AlarmQueryNextRec(hRec,hCat,nType,hArea,0,ClusterName)
|
Get Alarm Cat Rec with
Area
|
| AlarmNextPriRec(hRec,hPri,nType,hArea=-1,ClusterName="")
|
_AlarmQueryNextRec(hRec,hPri,nType,hArea,1,ClusterName)
|
Get Alarm Pri Rec with
Area
|
| Assert(arg)
|
IF NOT (arg) THEN
_Assert(#arg, __FILE__, __LINE__); END
|
Process an assertion
|
| DateDay(time)
|
_TimeSub(time,3)
|
Get days from time
|
| DateMonth(time)
|
_TimeSub(time,5)
|
Get month from time
|
| DateWeekDay(time)
|
_TimeSub(time,4)
|
Get weekday from time
|
| DevFirst(hDev)
|
DevSeek(hDev,0)
|
DevSeek with Offset=0
|
| DspButton(hAn,UK=0,sText,hFont=0,nW=0,nH=0,DK=0,RK=0,nM=0)
|
_DspButton(hAn,UK,sText,hFont,nW,nH,DK,RK,nM)
|
Display button
|
| DspButtonFn(hAn,UF=0,sText,hFont=0,nW=0,nH=0,DF=0,RF=0,nM=0)
|
_DspButtonFn(hAn,UF,sText,hFont,nW,nH,DF,RF,nM)
|
Display a button
|
| DspSymAnmEx(hAn,mode,s1,s2=0,s3=0,s4=0,s5=0,s6=0,s7=0,s8=0,s9=0)
|
DspSymAnm(hAn,s1,s2,s3,s4,s5,s6,s7,s8,mode,s9)
|
DspSymAnm with mode
|
| GetBlueValue(PackedRGB)
|
((PackedRGB / 65536) BITAND
255)
|
Get the blue component of a
packed RGB colour
|
| GetGreenValue(PackedRGB)
|
((PackedRGB / 256) BITAND
255)
|
Get the green component of a
packed RGB colour
|
| GetRedValue(PackedRGB)
|
(PackedRGB BITAND 255)
|
Get the red component of a
packed RGB colour
|
| IFDEF(sTag,sTrue,sFalse)
|
$9
|
Inline IF defined
macro
|
| IFDEFADVALM(sTag,sTrue,sFalse)
|
$13
|
Inline IF defined
macro
|
| IFDEFANAALM(sTag,sTrue,sFalse)
|
$14
|
Inline IF defined
macro
|
| IFDEFDIGALM(sTag,sTrue,sFalse)
|
$12
|
Inline IF defined
macro
|
| KeyDown()
|
KeyMove(4)
|
Move Cursor down
|
| KeyLeft()
|
KeyMove(1)
|
Move Cursor left
|
| KeyReplayAll()
|
KeyReplay(0)
|
Key Replay All
|
| KeyRight()
|
KeyMove(2)
|
Move Cursor right
|
| KeyUp()
|
KeyMove(3)
|
Move Cursor up
|
| MakeCitectColour(Red,Green,Blue)
|
(Blue + (Green * 256) + (Red
* 65536))
|
Make a Citect Colour from R,
G, B components
|
| ObjectByName(sName)
|
ObjectByNameEx(WinNumber(),sName)
|
Get ActiveX object on current
page by name
|
| PackedRGB(Red,Green,Blue)
|
(Red + Green * 256 + Blue *
65536)
|
Make a packed RGB colour from
its components
|
| Print(sText,nMode=0)
|
DevPrint(DevCurr(),sText,nMode)
|
Print output to device
|
| PrintLn(sText)
|
DevPrint(DevCurr(),sText,1)
|
Print output to device,
newline
|
| Pulse(arg)
|
Pulser(VarToStr(arg))
|
Pulse a tag
|
| TestRandomWave(p=60,lo=0,hi=100,off=0)
|
_Wave(4,p,lo,hi,off)
|
Test random wave
|
| TestSawWave(p=60,lo=0,hi=100,off=0)
|
_Wave(3,p,lo,hi,off)
|
Test Saw wave
|
| TestSinWave(p=60,lo=0,hi=100,off=0)
|
_Wave(0,p,lo,hi,off)
|
Test sin wave
|
| TestSquareWave(p=60,lo=0,hi=100,off=0)
|
_Wave(1,p,lo,hi,off)
|
Test square wave
|
| TestTriangWave(p=60,lo=0,hi=100,off=0)
|
_Wave(2,p,lo,hi,off)
|
Test Triag wave
|
| TimeHour(time)
|
_TimeSub(time,0)
|
Get hours from time
|
| TimeMidNight(time)
|
_TimeSub(time, 7)
|
Extract time at midnight (See
Q5139)
|
| TimeMin(time)
|
_TimeSub(time,1)
|
Get minutes from time
|
| TimeSec(time)
|
_TimeSub(time,2)
|
Get seconds from time
|
| TimeSecond(time)
|
_TimeSub(time, 2)
|
Get seconds from time
|
| Toggle(arg)
|
arg = NOT arg;
|
Toggle the variable
|
|
|
|
|
| Macro Functions
(Undocumented)
|
|
|
| _CreateControlObject(sCls,sName,x1,y1,x2,y2,sEventCls)
|
CreateControlObject(sCls,sName,x1,y1,x2,y2,sEventCls)
|
CreateControlObject default
event class
|
| DateDayMonth(time)
|
_TimeSub(time,10)
|
Get the number of days in the
specified month
|
| FlashColourState()
|
StrToInt(PageInfo(18))
|
Flashing Colour State as a
boolean
|
| GetVar(sTag,sField)
|
$7
|
Get variable field data. Do
not put quotes around arguments. Use field names from
variable.dbf
|
| GetVarDef(sTag,sField,sDefault)
|
$10
|
Get variable field data if
defined
|
| GetVarStr(sTag,sField)
|
$8
|
Get variable field data as
str
|
| GetVarStrDef(sTag,sField,sDefault)
|
$11
|
Get variable field data as a
str if defined
|
| InAnimationCycle()
|
StrToInt(PageInfo(19))
|
In Animation Cycle as a
boolean
|
| InCommunicationsCycle()
|
StrToInt(PageInfo(20))
|
In Communications Cycle as a
boolean
|
| TimeYearDay(time)
|
_TimeSub(time, 8)
|
Day number (0-365)
|
| UnitControl(IODev,Type,Data)
|
IODeviceControl(IODev,Type,Data)
|
|
| UnitInfo(IODev,Type)
|
IODeviceInfo(IODev,Type)
|
|
| UnitStats()
|
IODeviceStats()
|
|
| VarToStr(sTag)
|
$15
|
Convert a tag reference to a
string
|
|
|
|
|
| Misc Constants
|
|
|
| BAD_HANDLE
|
-1
|
Bad Handle
|
| _BLANK_
|
|
NULL Definition
|
| FALSE
|
0
|
Boolean False
|
| TRUE
|
1
|
Boolean True
|
|
|
|
|
| Mouse Button
Constants
|
|
|
| KEY_LBTN_CMD_DN
|
0x0605
|
Left button pressed over
object
|
| KEY_LBTN_CMD_UP
|
0x0601
|
Left button released over
object
|
| KEY_LBUTTON
|
0x0001
|
Left button
|
| KEY_LBUTTON_DBL
|
0x0401
|
Left button
double-clicked
|
| KEY_LBUTTON_DN
|
0x0801
|
Left button pressed
|
| KEY_LBUTTON_UP
|
0x0201
|
Left button released
|
| KEY_MBUTTON
|
0x0004
|
Middle button
|
| KEY_MBUTTON_DBL
|
0x0404
|
Middle button
double-clicked
|
| KEY_MBUTTON_DN
|
0x0804
|
Middle button pressed
|
| KEY_MBUTTON_UP
|
0x0204
|
Middle button released
|
| KEY_RBTN_CMD_DN
|
0x0606
|
Right button pressed over
object
|
| KEY_RBTN_CMD_UP
|
0x0602
|
Right button released over
object
|
| KEY_RBUTTON
|
0x0002
|
Right button
|
| KEY_RBUTTON_DBL
|
0x0402
|
Right button
double-clicked
|
| KEY_RBUTTON_DN
|
0x0802
|
Right button pressed
|
| KEY_RBUTTON_UP
|
0x0202
|
Right button released
|
|
|
|
|
| Port Constants
|
|
|
| EVEN_P
|
2
|
Even Parity
|
| NONE
|
0
|
No Parity
|
| ODD_P
|
1
|
Odd Parity
|
|
|
|
|
| SPC Constants
|
|
|
| RAboveUCL
|
8192
|
|
| RBelowLCL
|
16384
|
|
| ROutsideCL
|
4096
|
|
| XAboveUCL
|
4
|
|
| XBelowLCL
|
8
|
|
| XDownTrend
|
64
|
|
| XErratic
|
512
|
|
| XFreak
|
1
|
|
| XGradualDown
|
256
|
|
| XGradualUp
|
128
|
|
| XMixture
|
2048
|
|
| XOutsideCL
|
2
|
|
| XOutsideWL
|
16
|
|
| XStratification
|
1024
|
|
| XUpTrend
|
32
|
|
|
|
|
|
| Task Constants
|
|
|
| Alarm_Server
|
2
|
Alarm Process Number
|
| Client
|
-1
|
Client Process Number
|
| IO_Server
|
4
|
IO Process Number
|
| Report_Server
|
1
|
Report Process Number
|
| Trend_Server
|
3
|
Trend Process Number
|
|
|
|
|
| Trend Type
Constants
|
|
|
| TRN_EVENT
|
2
|
Event trend
|
| TRN_PERIODIC
|
1
|
Periodic trend
|
| TRN_PERIODIC_EVENT
|
3
|
Event trend
|
|
