WCC PReference en-US PDF

VB scripting 1
C scripting (RT Professional) 2

Runtime API (RT
Professional) 3
SIMATIC
WinCC
WinCC Engineering V15.1 -
Programming reference
System Manual
Online help printout
10/2018
Online help printout
Legal information
Warning notice system
This manual contains notices you have to observe in order to ensure your personal safety, as well as to prevent
damage to property. The notices referring to your personal safety are highlighted in the manual by a safety alert
symbol, notices referring only to property damage have no safety alert symbol. These notices shown below are
graded according to the degree of danger.
DANGER
indicates that death or severe personal injury will result if proper precautions are not taken.
WARNING
indicates that death or severe personal injury may result if proper precautions are not taken.
CAUTION
indicates that minor personal injury can result if proper precautions are not taken.
NOTICE
indicates that property damage can result if proper precautions are not taken.
If more than one degree of danger is present, the warning notice representing the highest degree of danger will be
used. A notice warning of injury to persons with a safety alert symbol may also include a warning relating to property
damage.
Qualified Personnel
The product/system described in this documentation may be operated only by personnel qualified for the specific
task in accordance with the relevant documentation, in particular its warning notices and safety instructions. Qualified
personnel are those who, based on their training and experience, are capable of identifying risks and avoiding
potential hazards when working with these products/systems.
Proper use of Siemens products
Note the following:
WARNING
Siemens products may only be used for the applications described in the catalog and in the relevant technical
documentation. If products and components from other manufacturers are used, these must be recommended or
approved by Siemens. Proper transport, storage, installation, assembly, commissioning, operation and
maintenance are required to ensure that the products operate safely and without any problems. The permissible
ambient conditions must be complied with. The information in the relevant documentation must be observed.
Trademarks
All names identified by ® are registered trademarks of Siemens AG. The remaining trademarks in this publication
may be trademarks whose use by third parties for their own purposes could violate the rights of the owner.
Disclaimer of Liability
We have reviewed the contents of this publication to ensure consistency with the hardware and software described.
Since variance cannot be precluded entirely, we cannot guarantee full consistency. However, the information in
this publication is reviewed regularly and any necessary corrections are included in subsequent editions.
Siemens AG Document order number: Online help printout Copyright © Siemens AG 2018.
Division Digital Factory Ⓟ 10/2018 Subject to change All rights reserved
Postfach 48 48
90026 NÜRNBERG
GERMANY
Table of contents
1 VB scripting................................................................................................................................................25
1.1 System functions (Panels, Comfort Panels, RT Advanced)...................................................25
1.1.1 AcknowledgeAlarm (Panels, Comfort Panels, RT Advanced)...............................................25
1.1.2 ActivatePLCCodeViewer (Panels, Comfort Panels, RT Advanced).......................................25
1.1.3 ActivatePreviousScreen (Panels, Comfort Panels, RT Advanced)........................................27
1.1.4 ActivateScreen (Panels, Comfort Panels, RT Advanced)......................................................28
1.1.5 ActivateScreenByNumber (Panels, Comfort Panels, RT Advanced).....................................29
1.1.6 ActivateSystemDiagnosticsView (Panels, Comfort Panels, RT Advanced)...........................30
1.1.7 ArchiveLogFile (Panels, Comfort Panels, RT Advanced)......................................................31
1.1.8 Back up RAM file system (Panels, Comfort Panels, RT Advanced)......................................32
1.1.9 CalibrateTouchScreen (Panels, Comfort Panels, RT Advanced)..........................................33
1.1.10 ChangeConnection (Panels, Comfort Panels, RT Advanced)...............................................34
1.1.11 ChangeConnectionEIP (Panels, Comfort Panels, RT Advanced)..........................................35
1.1.12 ClearAlarmBuffer (Panels, Comfort Panels, RT Advanced)...................................................37
1.1.13 ClearAlarmBufferProtool (Panels, Comfort Panels, RT Advanced).......................................38
1.1.14 ClearDataRecord (Panels, Comfort Panels, RT Advanced)..................................................39
1.1.15 ClearDataRecordMemory (Panels, Comfort Panels, RT Advanced).....................................40
1.1.16 ClearLog (Panels, Comfort Panels, RT Advanced)................................................................41
1.1.17 CloseAllLogs (Panels, Comfort Panels, RT Advanced).........................................................42
1.1.18 ControlSmartServer (Panels, Comfort Panels, RT Advanced)..............................................42
1.1.19 ControlWebServer (Panels, Comfort Panels, RT Advanced).................................................43
1.1.20 CopyLog (Panels, Comfort Panels, RT Advanced)................................................................44
1.1.21 DecreaseTag (Panels, Comfort Panels, RT Advanced).........................................................45
1.1.22 EditAlarm (Panels, Comfort Panels, RT Advanced)...............................................................46
1.1.23 Encode (Panels, Comfort Panels, RT Advanced)..................................................................46
1.1.24 EncodeEx (Panels, Comfort Panels, RT Advanced)..............................................................47
1.1.25 ExportDataRecords (Panels, Comfort Panels, RT Advanced)...............................................48
1.1.26 ExportDataRecordsWithChecksum (Panels, Comfort Panels, RT Advanced).......................51
1.1.27 ExportImportUserAdministration (Panels, Comfort Panels, RT Advanced)...........................53
1.1.28 GetBrightness (Panels, Comfort Panels, RT Advanced).......................................................54
1.1.29 GetDataRecordFromPLC (Panels, Comfort Panels, RT Advanced)......................................54
1.1.30 GetDataRecordName (Panels, Comfort Panels, RT Advanced)............................................56
1.1.31 GetDataRecordTagsFromPLC (Panels, Comfort Panels, RT Advanced)..............................58
1.1.32 GetGroupNumber (Panels, Comfort Panels, RT Advanced)..................................................58
1.1.33 GetPassword (Panels, Comfort Panels, RT Advanced).........................................................59
1.1.34 GetUserName (Panels, Comfort Panels, RT Advanced).......................................................60
1.1.35 GoToEnd (Panels, Comfort Panels, RT Advanced)...............................................................60
1.1.36 GoToHome (Panels, Comfort Panels, RT Advanced)............................................................61
1.1.37 ImportDataRecords (Panels, Comfort Panels, RT Advanced)...............................................61
1.1.38 ImportDataRecordsWithChecksum (Panels, Comfort Panels, RT Advanced)......................63
1.1.39 IncreaseTag (Panels, Comfort Panels, RT Advanced)..........................................................65
1.1.40 InverseLinearScaling (Panels, Comfort Panels, RT Advanced).............................................65
1.1.41 InvertBit (Panels, Comfort Panels, RT Advanced).................................................................67
1.1.42 InvertBitInTag (Panels, Comfort Panels, RT Advanced)........................................................68
1.1.43 LinearScaling (Panels, Comfort Panels, RT Advanced)........................................................70
1.1.44 LoadDataRecord (Panels, Comfort Panels, RT Advanced)...................................................72
WinCC Engineering V15.1 - Programming reference

System Manual, 10/2018, Online help printout 3
Table of contents
1.1.45 LogOff (Panels, Comfort Panels, RT Advanced)...................................................................73

1.1.46 Logon (Panels, Comfort Panels, RT Advanced)....................................................................73
1.1.47 LookupText (Panels, Comfort Panels, RT Advanced)...........................................................74
1.1.48 NotifyUserAction (Panels, Comfort Panels, RT Advanced)...................................................75
1.1.49 OpenAllLogs (Panels, Comfort Panels, RT Advanced)..........................................................76
1.1.50 OpenCommandPrompt (Panels, Comfort Panels, RT Advanced).........................................77
1.1.51 OpenControlPanel (Panels, Comfort Panels, RT Advanced).................................................78
1.1.52 OpenInternetExplorer (Panels, Comfort Panels, RT Advanced)............................................79
1.1.53 OpenScreenKeyboard (Panels, Comfort Panels, RT Advanced)...........................................79
1.1.54 OpenTaskManager (Panels, Comfort Panels, RT Advanced)...............................................80
1.1.55 PageDown (Panels, Comfort Panels, RT Advanced).............................................................81
1.1.56 PageUp (Panels, Comfort Panels, RT Advanced).................................................................81
1.1.57 PrintReport (Panels, Comfort Panels, RT Advanced)............................................................82
1.1.58 PrintScreen (Panels, Comfort Panels, RT Advanced)...........................................................82
1.1.59 ResetBit (Panels, Comfort Panels, RT Advanced).................................................................83
1.1.60 ResetBitInTag (Panels, Comfort Panels, RT Advanced).......................................................84
1.1.61 SafelyRemoveHardware (Panels, Comfort Panels)...............................................................86
1.1.62 SaveDataRecord (Panels, Comfort Panels, RT Advanced)...................................................87
1.1.63 SendEMail (Panels, Comfort Panels, RT Advanced).............................................................88
1.1.64 SetAcousticSignal (Panels, Comfort Panels, RT Advanced).................................................89
1.1.65 SetAlarmReportMode (Panels, Comfort Panels, RT Advanced)............................................90
1.1.66 SetBit (Panels, Comfort Panels, RT Advanced).....................................................................90
1.1.67 SetBitInTag (Panels, Comfort Panels, RT Advanced)...........................................................92
1.1.68 SetBrightness (Panels, Comfort Panels, RT Advanced)........................................................94
1.1.69 SetConnectionMode (Panels, Comfort Panels, RT Advanced)..............................................95
1.1.70 SetDataRecordTagsToPLC (Panels, Comfort Panels, RT Advanced)..................................96
1.1.71 SetDataRecordToPLC (Panels, Comfort Panels, RT Advanced)..........................................97
1.1.72 SetDaylightSavingTime (Panels, Comfort Panels, RT Advanced).........................................98
1.1.73 SetDeviceMode (Panels, Comfort Panels, RT Advanced).....................................................99
1.1.74 SetDisplayMode (Panels, Comfort Panels, RT Advanced)..................................................100
1.1.75 SetLanguage (Panels, Comfort Panels, RT Advanced).......................................................100
1.1.76 SetPLCDateTime (Panels, Comfort Panels, RT Advanced)................................................101
1.1.77 SetRecipeTags (Panels, Comfort Panels, RT Advanced)....................................................102
1.1.78 SetScreenKeyboardMode (Panels, Comfort Panels, RT Advanced)...................................103
1.1.79 SetTag (Panels, Comfort Panels, RT Advanced).................................................................104
1.1.80 ShiftAndMask (Panels, Comfort Panels, RT Advanced)......................................................105
1.1.81 ShowAlarmWindow (Panels, Comfort Panels, RT Advanced).............................................107
1.1.82 ShowOperatorNotes (Panels, Comfort Panels, RT Advanced)............................................108
1.1.83 ShowPopUpScreen (Panels, Comfort Panels, RT Advanced).............................................109
1.1.84 ShowPopupScreenSizable (Panels, Comfort Panels, RT Advanced)..................................110
1.1.85 ShowSlideInScreen (Panels, Comfort Panels, RT Advanced).............................................112
1.1.86 ShowSoftwareVersion (Panels, Comfort Panels, RT Advanced).........................................113
1.1.87 ShowSystemAlarm (Panels, Comfort Panels, RT Advanced)..............................................114
1.1.88 ShowSystemDiagnosticsWindow (Panels, Comfort Panels)................................................114
1.1.89 StartLogging (Panels, Comfort Panels, RT Advanced)........................................................115
1.1.90 StartNextLog (Panels, Comfort Panels, RT Advanced).......................................................115
1.1.91 StartProgram (Panels, Comfort Panels, RT Advanced).......................................................116
1.1.92 StopLogging (Panels, Comfort Panels, RT Advanced)........................................................118
1.1.93 StopRuntime (Panels, Comfort Panels, RT Advanced).......................................................119
1.1.94 TerminatePROFIsafe (Panels, Comfort Panels, RT Advanced)..........................................120
1.2 System functions (RT Professional).....................................................................................121
1.2.1 ActivateScreen (RT Professional)........................................................................................121

4 System Manual, 10/2018, Online help printout
Table of contents
1.2.2 ActivateScreenInScreenWindow (RT Professional).............................................................122

1.2.3 DecreaseTag (RT Professional)...........................................................................................123
1.2.4 ExportImportUserAdministration (RT Professional).............................................................124
1.2.5 GetParentScreen (RT Professional)....................................................................................125
1.2.6 GetParentScreenWindow (RT Professional)........................................................................126
1.2.7 IncreaseTag (RT Professional)............................................................................................127
1.2.8 InverseLinearScaling (RT Professional)...............................................................................129
1.2.9 InvertBit (RT Professional)...................................................................................................130
1.2.10 InvertBitInTag (RT Professional)..........................................................................................132
1.2.11 LinearScaling (RT Professional)..........................................................................................133
1.2.12 LookupText (RT Professional).............................................................................................135
1.2.13 ResetBit (RT Professional)...................................................................................................136
1.2.14 ResetBitInTag (RT Professional).........................................................................................137
1.2.15 SetBit (RT Professional)......................................................................................................139
1.2.16 SetBitInTag (RT Professional).............................................................................................141
1.2.17 SetLanguage........................................................................................................................143
1.2.18 SetPropertyByConstant (RT Professional)...........................................................................143
1.2.19 SetPropertyByProperty (RT Professional)...........................................................................145
1.2.20 SetPropertyByTag (RT Professional)...................................................................................147
1.2.21 SetPropertyByTagIndirect (RT Professional).......................................................................149
1.2.22 SetTag (RT Professional).....................................................................................................151
1.2.23 SetTagByProperty (RT Professional)...................................................................................152
1.2.24 SetTagByTagIndirect (RT Professional)..............................................................................153
1.2.25 SetTagIndirect (RT Professional).........................................................................................154
1.2.26 SetTagIndirectByProperty (RT Professional).......................................................................155
1.2.27 SetTagIndirectByTagIndirect (RT Professional)...................................................................156
1.2.28 SetTagWithOperatorEvent (RT Professional)......................................................................157
1.2.29 ShowBlockInTIAPortalFromAlarm (RT Professional)...........................................................158
1.2.30 ShowLogonDialog (RT Professional)...................................................................................160
1.2.31 ShowPLCCodeViewFromAlarm (RT Professional)..............................................................160
1.2.32 StopRuntime (RT Professional)...........................................................................................161
1.3 VBScript for Windows (Panels, Comfort Panels, RT Advanced, RT Professional)..............162
1.3.1 VBScript for Windows (Panels, Comfort Panels, RT Advanced, RT Professional)..............162
1.4 VBScript for Windows CE (Panels, Comfort Panels)...........................................................163
1.4.1 VBScript for Windows CE (Panels, Comfort Panels)...........................................................163
1.4.2 CreateObject (Panels, Comfort Panels)...............................................................................163
1.4.3 Control element (Panels, Comfort Panels)...........................................................................164
1.4.4 Properties (Panels, Comfort Panels)....................................................................................166
1.4.4.1 Attr (Panels, Comfort Panels)..............................................................................................166
1.4.4.2 EOF (Panels, Comfort Panels).............................................................................................166
1.4.4.3 Loc (Panels, Comfort Panels)..............................................................................................167
1.4.4.4 LOF (Panels, Comfort Panels).............................................................................................168
1.4.4.5 Seek (Panels, Comfort Panels)............................................................................................168
1.4.5 Methods (Panels, Comfort Panels)......................................................................................169
1.4.5.1 Close (Panels, Comfort Panels)...........................................................................................169
1.4.5.2 Dir (Panels, Comfort Panels)...............................................................................................169
1.4.5.3 FileCopy (Panels, Comfort Panels)......................................................................................170
1.4.5.4 FileDateTime (Panels, Comfort Panels)...............................................................................171
1.4.5.5 FileLen (Panels, Comfort Panels)........................................................................................172
1.4.5.6 Get (Panels, Comfort Panels)..............................................................................................172
1.4.5.7 GetAttr (Panels, Comfort Panels).........................................................................................174

Table of contents
1.4.5.8 Input (Panels, Comfort Panels)............................................................................................174

1.4.5.9 InputB (Panels, Comfort Panels)..........................................................................................175
1.4.5.10 InputFields (Panels, Comfort Panels)..................................................................................176
1.4.5.11 Kill (Panels, Comfort Panels)...............................................................................................177
1.4.5.12 LineInputString (Panels, Comfort Panels)............................................................................177
1.4.5.13 LinePrint (Panels, Comfort Panels)......................................................................................178
1.4.5.14 MkDir (Panels, Comfort Panels)...........................................................................................179
1.4.5.15 MoveFile (Panels, Comfort Panels).....................................................................................179
1.4.5.16 Open (Panels, Comfort Panels)...........................................................................................180
1.4.5.17 Put (Panels, Comfort Panels)...............................................................................................181
1.4.5.18 RmDir (Panels, Comfort Panels)..........................................................................................182
1.4.5.19 SetAttr (Panels, Comfort Panels).........................................................................................183
1.4.5.20 WriteFields (Panels, Comfort Panels)..................................................................................184
1.5 VBS object model (Panels, Comfort Panels, RT Advanced, RT Professional)....................185
1.5.1 VBS object model (RT Professional)....................................................................................185
1.5.2 Objects (Panels, Comfort Panels, RT Advanced)................................................................187
1.5.2.1 HMIRuntime (Panels, Comfort Panels, RT Advanced)........................................................187
1.5.2.2 Screen object (list) (Panels, Comfort Panels, RT Advanced)..............................................188
1.5.2.3 Screen (Panels, Comfort Panels, RT Advanced).................................................................190
1.5.2.4 ScreenItem (Panels, Comfort Panels, RT Advanced)..........................................................191
1.5.2.5 ScreenItems (Panels, Comfort Panels, RT Advanced)........................................................193
1.5.2.6 SmartTags (Panels, Comfort Panels, RT Advanced)...........................................................194
1.5.2.7 SmartTag (Panels, Comfort Panels, RT Advanced)............................................................196
1.5.3 Objects (RT Professional)....................................................................................................198
1.5.3.1 Alarm (RT Professional).......................................................................................................198
1.5.3.2 Alarms (list) (RT Professional).............................................................................................199
1.5.3.3 AlarmLogs (list) (RT Professional).......................................................................................200
1.5.3.4 DataItem (RT Professional)..................................................................................................202
1.5.3.5 DataLogs (list) (RT Professional).........................................................................................203
1.5.3.6 DataSet (list) (RT Professional)...........................................................................................205
1.5.3.7 HMIRuntime (RT Professional)...........................................................................................207
1.5.3.8 Item (RT Professional).........................................................................................................209
1.5.3.9 Layer (RT Professional).......................................................................................................209
1.5.3.10 Layers (list) (RT Professional).............................................................................................211
1.5.3.11 Logging (RT Professional)...................................................................................................212
1.5.3.12 Project (RT Professional).....................................................................................................213
1.5.3.13 Screen (RT Professional).....................................................................................................214
1.5.3.14 ScreenItem (RT Professional)..............................................................................................217
1.5.3.15 ScreenItems (list) (RT Professional)....................................................................................219
1.5.3.16 Screen object (list) (RT Professional)..................................................................................221
1.5.3.17 SmartTag (RT Professional)................................................................................................223
1.5.3.18 SmartTags (RT Professional)...............................................................................................224
1.5.3.19 Tag (RT Professional)..........................................................................................................227
1.5.3.20 Tags (list) (RT Professional)................................................................................................230
1.5.3.21 TagSet (list) (RT Professional)............................................................................................231
1.5.4 Object types (Panels, Comfort Panels, RT Advanced, RT Professional).............................232
1.5.4.1 Object types available in VBS (Panels, Comfort Panels, RT Advanced, RT Professional)....232
1.5.4.2 Objects A-I (Panels, Comfort Panels, RT Advanced, RT Professional)...............................235
1.5.4.3 Objects K-Z (Panels, Comfort Panels, RT Advanced, RT Professional)..............................337
1.5.5 Properties (Panels, Comfort Panels, RT Advanced, RT Professional)................................493
1.5.5.1 Properties A (Panels, Comfort Panels, RT Advanced, RT Professional).............................493
1.5.5.2 Properties B (Panels, Comfort Panels, RT Advanced, RT Professional).............................529

Table of contents
1.5.5.3 Properties C (Panels, Comfort Panels, RT Advanced, RT Professional).............................590

1.5.5.4 Properties D (Panels, Comfort Panels, RT Advanced, RT Professional).............................643
1.5.5.5 Properties E-F (Panels, Comfort Panels, RT Advanced, RT Professional).........................660
1.5.5.6 Properties G-H (Panels, Comfort Panels, RT Advanced, RT Professional).........................719
1.5.5.7 Properties I-J (Panels, Comfort Panels, RT Advanced, RT Professional)...........................743
1.5.5.8 Properties K-L (Panels, Comfort Panels, RT Advanced, RT Professional)..........................761
1.5.5.9 Properties M-N (Panels, Comfort Panels, RT Advanced, RT Professional)........................800
1.5.5.10 Properties O-P (Panels, Comfort Panels, RT Advanced, RT Professional).........................840
1.5.5.11 Properties Q-R (Panels, Comfort Panels, RT Advanced, RT Professional).........................878
1.5.5.12 Properties S (Panels, Comfort Panels, RT Advanced, RT Professional).............................895
1.5.5.13 Properties T (Panels, Comfort Panels, RT Advanced, RT Professional).............................987
1.5.5.14 Properties U-W (Panels, Comfort Panels, RT Advanced, RT Professional)......................1145
1.5.5.15 Properties X-Z (Panels, Comfort Panels, RT Advanced, RT Professional).......................1228
1.5.6 Methods (Panels, Comfort Panels, RT Advanced, RT Professional).................................1253
1.5.6.1 Methods A-G (Panels, Comfort Panels, RT Advanced, RT Professional).........................1253
1.5.6.2 Methods H-R (Panels, Comfort Panels, RT Advanced, RT Professional).........................1317
1.5.6.3 Methods S-Z (Panels, Comfort Panels, RT Advanced, RT Professional)..........................1345
2 C scripting (RT Professional)..................................................................................................................1373
2.1 System functions (RT Professional)...................................................................................1373
2.1.1 ActivateNextScreen (RT Professional)...............................................................................1373
2.1.2 ActivatePreviousScreen (RT Professional)........................................................................1374
2.1.3 ActivateScreen (RT Professional)......................................................................................1375
2.1.4 ActivateScreenInScreenWindow (RT Professional)...........................................................1376
2.1.5 ActivateStartScreen (RT Professional)..............................................................................1377
2.1.6 ActivateStoredScreen (RT Professional)...........................................................................1378
2.1.7 DateToSystemTime (RT Professional)..............................................................................1379
2.1.8 DecreaseTag (RT Professional).........................................................................................1381
2.1.9 GetLocalScreen (RT Professional)....................................................................................1382
2.1.10 GetLinkedTag (RT Professional)........................................................................................1384
2.1.11 GetLanguageByLocaleID (RT Professional)......................................................................1385
2.1.12 GetParentScreen (RT Professional)..................................................................................1387
2.1.13 GetParentScreenWindow (RT Professional)......................................................................1389
2.1.14 GetProp (RT Professional).................................................................................................1391
2.1.14.1 GetPropBOOL (RT Professional)......................................................................................1391
2.1.14.2 GetPropChar (RT Professional).........................................................................................1392
2.1.14.3 GetPropDouble (RT Professional).....................................................................................1394
2.1.14.4 GetPropLong (RT Professional).........................................................................................1395
2.1.15 GetServerTagPrefix (RT Professional)..............................................................................1396
2.1.16 GetTag (RT Professional)..................................................................................................1399
2.1.16.1 GetTag functions (RT Professional)...................................................................................1399
2.1.16.2 GetTagDateTime function (RT Professional).....................................................................1400
2.1.16.3 GetTagMultiStateQCWait functions (RT Professional)......................................................1401
2.1.16.4 GetTagMultiStateWait functions (RT Professional)............................................................1403
2.1.16.5 GetTagMultiWait functions (RT Professional)....................................................................1404
2.1.16.6 GetTagState functions (RT Professional)..........................................................................1405
2.1.16.7 GetTagStateQC functions (RT Professional).....................................................................1408
2.1.16.8 GetTagStateQCWait functions (RT Professional)..............................................................1410
2.1.16.9 GetTagStateWait functions (RT Professional)...................................................................1413
2.1.16.10 GetTagValue functions (RT Professional)..........................................................................1415
2.1.16.11 GetTagValueStateQC functions (RT Professional)............................................................1417
2.1.16.12 GetTagValueStateQCWait functions (RT Professional).....................................................1418

Table of contents
2.1.16.13 GetTagValueWait functions (RT Professional)..................................................................1420

2.1.16.14 GetTagWait functions (RT Professional)............................................................................1421
2.1.17 IncreaseTag (RT Professional)..........................................................................................1423
2.1.18 InquireLanguage (RT Professional)...................................................................................1424
2.1.19 InverseLinearScaling (RT Professional).............................................................................1426
2.1.20 InvertBit (RT Professional).................................................................................................1428
2.1.21 InvertBitInTag (RT Professional)........................................................................................1429
2.1.22 IsUserAuthorized (RT Professional)...................................................................................1431
2.1.23 LinearScaling (RT Professional)........................................................................................1433
2.1.24 ReportJob (RT Professional)..............................................................................................1434
2.1.25 ResetBit (RT Professional).................................................................................................1435
2.1.26 ResetBitInTag (RT Professional).......................................................................................1437
2.1.27 Set_Focus (RT Professional).............................................................................................1438
2.1.28 SetBit (RT Professional).....................................................................................................1439
2.1.29 SetBitInTag (RT Professional)...........................................................................................1440
2.1.30 SetLanguageByLocaleID (RT Professional)......................................................................1442
2.1.31 SetLanguageByName (RT Professional)...........................................................................1444
2.1.32 SetProp (RT Professional).................................................................................................1445
2.1.32.1 SetPropBOOL (RT Professional).......................................................................................1445
2.1.32.2 SetPropChar (RT Professional).........................................................................................1446
2.1.32.3 SetPropDouble (RT Professional)......................................................................................1448
2.1.32.4 SetPropLong (RT Professional).........................................................................................1449
2.1.33 SetPropertyByConstant (RT Professional).........................................................................1451
2.1.34 SetPropertyByProperty (RT Professional).........................................................................1453
2.1.35 SetPropertyByTag (RT Professional).................................................................................1455
2.1.36 SetPropertyByTagIndirect (RT Professional).....................................................................1457
2.1.37 SetTag (RT Professional)...................................................................................................1458
2.1.37.1 SetTag functions (RT Professional)...................................................................................1458
2.1.37.2 SetTagDateTime (RT Professional)...................................................................................1461
2.1.37.3 SetTagMultiStateWait functions (RT Professional)............................................................1461
2.1.37.4 SetTagMultiWait functions (RT Professional)....................................................................1463
2.1.37.5 SetTagState functions (RT Professional)...........................................................................1465
2.1.37.6 SetTagStateWait functions (RT Professional)....................................................................1468
2.1.37.7 SetTagValue functions (RT Professional)..........................................................................1470
2.1.37.8 SetTagValueWait functions (RT Professional)...................................................................1472
2.1.37.9 SetTagWait functions (RT Professional)............................................................................1473
2.1.37.10 SetTag (RT Professional)...................................................................................................1475
2.1.37.11 SetTagByProperty (RT Professional).................................................................................1476
2.1.37.12 SetTagByTagIndirect (RT Professional)............................................................................1478
2.1.37.13 SetTagIndirect (RT Professional)......................................................................................1479
2.1.37.14 SetTagIndirectByProperty (RT Professional).....................................................................1480
2.1.37.15 SetTagIndirectByTagIndirect (RT Professional).................................................................1481
2.1.37.16 SetTagIndirectWithOperatorEvent (RT Professional)........................................................1482
2.1.37.17 SetTagWithOperatorEvent (RT Professional)....................................................................1482
2.1.38 StartProgram (RT Professional).........................................................................................1483
2.1.39 StopRuntime (RT Professional).........................................................................................1484
2.1.40 StoreScreen (RT Professional).........................................................................................1485
2.1.41 SystemTimeToDate (RT Professional)..............................................................................1486
2.1.42 TriggerOperatorEvent (RT Professional)...........................................................................1488
2.1.43 UA (Recipe) (RT Professional)...........................................................................................1489
2.1.43.1 uaArchiveClose (RT Professional).....................................................................................1489
2.1.43.2 uaArchiveDelete (RT Professional)....................................................................................1489

Table of contents
2.1.43.3 uaArchiveExport (RT Professional)....................................................................................1490

2.1.43.4 uaArchiveGetCount (RT Professional)...............................................................................1491
2.1.43.5 uaArchiveGetFieldLength (RT Professional)......................................................................1492
2.1.43.6 uaArchiveGetFieldName (RT Professional).......................................................................1492
2.1.43.7 uaArchiveGetFields (RT Professional)...............................................................................1493
2.1.43.8 uaArchiveGetFieldType (RT Professional)........................................................................1494
2.1.43.9 uaArchiveGetFieldValueDate (RT Professional)................................................................1494
2.1.43.10 uaArchiveGetFieldValueDouble (RT Professional)............................................................1495
2.1.43.11 uaArchiveGetFieldValueFloat (RT Professional)...............................................................1496
2.1.43.12 uaArchiveGetFieldValueLong (RT Professional)...............................................................1497
2.1.43.13 uaArchiveGetFieldValueString (RT Professional)..............................................................1498
2.1.43.14 uaArchiveGetFilter (RT Professional)................................................................................1498
2.1.43.15 uaArchiveGetID (RT Professional).....................................................................................1499
2.1.43.16 uaArchiveGetName (RT Professional)...............................................................................1500
2.1.43.17 uaArchiveGetSor (RT Professional)...................................................................................1500
2.1.43.18 uaArchiveImport (RT Professional)....................................................................................1501
2.1.43.19 uaArchiveInsert (RT Professional).....................................................................................1502
2.1.43.20 uaArchiveMoveFirst (RT Professional)..............................................................................1503
2.1.43.21 uaArchiveMoveLast (RT Professional)..............................................................................1503
2.1.43.22 uaArchiveMoveNext (RT Professional)..............................................................................1504
2.1.43.23 uaArchiveMovePrevious (RT Professional).......................................................................1504
2.1.43.24 uaArchiveOpen (RT Professional).....................................................................................1505
2.1.43.25 uaArchiveReadTagValues (RT Professional)....................................................................1506
2.1.43.26 uaArchiveReadTagValuesByName (RT Professional).......................................................1507
2.1.43.27 uaArchiveRequery (RT Professional).................................................................................1508
2.1.43.28 uaArchiveSetFieldValueDate (RT Professional)................................................................1509
2.1.43.29 uaArchiveSetFieldValueDouble (RT Professional)............................................................1509
2.1.43.30 uaArchiveSetFieldValueFloat (RT Professional)................................................................1510
2.1.43.31 uaArchiveSetFieldValueLong (RT Professional)................................................................1511
2.1.43.32 uaArchiveSetFieldValueString (RT Professional).............................................................1512
2.1.43.33 uaArchiveSetFilter (RT Professional).................................................................................1513
2.1.43.34 uaArchiveSetSort (RT Professional)..................................................................................1513
2.1.43.35 uaArchiveUpdate (RT Professional)...................................................................................1514
2.1.43.36 uaArchiveWriteTagValues (RT Professional).....................................................................1515
2.1.43.37 uaArchiveWriteTagValuesByName (RT Professional).......................................................1516
2.1.43.38 uaConnect (RT Professional).............................................................................................1516
2.1.43.39 uaDisconnect (RT Professional)........................................................................................1517
2.1.43.40 uaGetArchive (RT Professional)........................................................................................1518
2.1.43.41 uaGetField (RT Professional).............................................................................................1518
2.1.43.42 uaGetLastError (RT Professional).....................................................................................1519
2.1.43.43 uaGetLastHResult (RT Professional)................................................................................1521
2.1.43.44 uaGetNumArchives (RT Professional)...............................................................................1522
2.1.43.45 uaGetNumFields (RT Professional)...................................................................................1522
2.1.43.46 uaQueryArchive (RT Professional)...................................................................................1523
2.1.43.47 uaQueryArchiveByName (RT Professional)......................................................................1524
2.1.43.48 UaQueryConfiguration (RT Professional)..........................................................................1525
2.1.43.49 uaReleaseArchive (RT Professional).................................................................................1525
2.1.43.50 uaReleaseConfiguration (RT Professional).......................................................................1526
2.2 C-bib (RT Professional)......................................................................................................1527
2.2.1 ctype functions (RT Professional)......................................................................................1527
2.2.2 Function group c_bib (RT Professional).............................................................................1527
2.2.3 math functions (RT Professional)......................................................................................1528

Table of contents
2.2.4 memory functions (RT Professional)..................................................................................1529

2.2.5 multibyte functions (RT Professional)................................................................................1530
2.2.6 stdio functions (RT Professional).......................................................................................1531
2.2.7 stdlib functions (RT Professional)......................................................................................1532
2.2.8 string functions (RT Professional)......................................................................................1533
2.2.9 time functions (RT Professional).......................................................................................1533
2.3 Structure definition (RT Professional)................................................................................1534
2.3.1 Structure definition CCAPErrorExecute (RT Professional)................................................1534
2.3.2 Structure definition CCAPTime (RT Professional).............................................................1535
2.3.3 Structure definition CMN_ERROR (RT Professional)........................................................1536
2.3.4 Structure definition DM_TYPEREF (RT Professional).......................................................1537
2.3.5 Structure definition DM_VAR_UPDATE_STRUCT (RT Professional)................................1538
2.3.6 Structure definition DM_VAR_UPDATE_STRUCTEX (RT Professional)...........................1539
2.3.7 Structure definition DM_VARKEY (RT Professional)........................................................1540
2.3.8 Structure definition LINKINFO (RT Professional)...............................................................1540
2.3.9 Structure definition MSG_FILTER_STRUCT (RT Professional)........................................1542
2.3.10 Structure definition MSG_RTDATA_STRUCT (RT Professional)......................................1545
3 Runtime API (RT Professional)..............................................................................................................1547
3.1 Runtime API (RT Professional)..........................................................................................1547
3.2 Data management functions (RT Professional).................................................................1548
3.2.1 Basics (RT Professional)....................................................................................................1548
3.2.1.1 Overview of structures (RT Professional)..........................................................................1548
3.2.1.2 Overview of the functions (RT Professional)......................................................................1549
3.2.1.3 Quality codes of HMI tags (RT Professional).....................................................................1550
3.2.1.4 VariableStateType property (RT Professional)..................................................................1554
3.2.1.5 Constants (RT Professional)..............................................................................................1555
3.2.1.6 Error messages (RT Professional).....................................................................................1559
3.2.1.7 Conversion routines (Control Center) (RT Professional)...................................................1561
3.2.2 Structures (RT Professional)..............................................................................................1567
3.2.2.1 DM_CONNECTION_DATA (RT Professional)...................................................................1567
3.2.2.2 DM_CONNKEY (RT Professional).....................................................................................1568
3.2.2.3 DM_CYCLE_INFO (RT Professional)................................................................................1569
3.2.2.4 DM_DATA_SERVICE (RT Professional)............................................................................1570
3.2.2.5 DM_DIRECTORY_INFO (RT Professional).......................................................................1571
3.2.2.6 DM_DLGOPTIONS (RT Professional)...............................................................................1572
3.2.2.7 DM_FORMAT_INFO (RT Professional).............................................................................1573
3.2.2.8 DM_MACHINE_TABLE (RT Professional).........................................................................1574
3.2.2.9 DM_PROJECT_INFO (RT Professional)............................................................................1575
3.2.2.10 DM_SEND_DATA_STRUCT (RT Professional).................................................................1576
3.2.2.11 DM_SD_TARGET_MACHINE (RT Professional)...............................................................1578
3.2.2.12 DM_SD_TARGET_APP (RT Professional)........................................................................1579
3.2.2.13 DM_TYPEREF (RT Professional)......................................................................................1579
3.2.2.14 DM_VAR_UPDATE_STRUCT (RT Professional)...............................................................1581
3.2.2.15 DM_VAR_UPDATE_STRUCTEX (RT Professional)..........................................................1583
3.2.2.16 DM_VARFILTER (RT Professional)...................................................................................1586
3.2.2.17 DM_VARGRP_DATA (RT Professional)............................................................................1588
3.2.2.18 DM_VARGRPKEY (RT Professional)................................................................................1589
3.2.2.19 DM_VARIABLE_DATA (RT Professional)..........................................................................1590
3.2.2.20 DM_VARIABLE_DATA4 (RT Professional)........................................................................1592
3.2.2.21 DM_VARKEY (RT Professional)........................................................................................1594

Table of contents
3.2.2.22 DM_VARLIMIT (RT Professional)......................................................................................1597

3.2.2.23 MCP_NEWVARIABLE_DATA (RT Professional)...............................................................1598
3.2.2.24 MCP_NEWVARIABLE_DATA_4 (RT Professional)...........................................................1600
3.2.2.25 MCP_NEWVARIABLE_DATA_5 (RT Professional)...........................................................1602
3.2.2.26 MCP_NEWVARIABLE_DATA_EX (RT Professional)........................................................1604
3.2.2.27 MCP_NEWVARIABLE_DATA_EX4 (RT Professional)......................................................1606
3.2.2.28 MCP_VARIABLE_COMMON (RT Professional)................................................................1608
3.2.2.29 MCP_VARIABLE_COMMON_EX (RT Professional)..........................................................1610
3.2.2.30 MCP_VARIABLE_LIMITS (RT Professional).....................................................................1612
3.2.2.31 MCP_VARIABLE_LIMITS5 (RT Professional)...................................................................1614
3.2.2.32 MCP_VARIABLE_LIMITS_EX (RT Professional)...............................................................1616
3.2.2.33 MCP_VARIABLE_PROTOCOL (RT Professional).............................................................1617
3.2.2.34 MCP_VARIABLE_PROTOCOL_EX (RT Professional)......................................................1619
3.2.2.35 MCP_VARIABLE_SCALES (RT Professional)...................................................................1620
3.2.3 General functions (RT Professional)..................................................................................1621
3.2.3.1 DMActivateRTProject (RT Professional)............................................................................1621
3.2.3.2 DMAddNotify (RT Professional).........................................................................................1622
3.2.3.3 DMChangeDataLocale (RT Professional)..........................................................................1629
3.2.3.4 DMConnect (RT Professional)...........................................................................................1630
3.2.3.5 DM_NOTIFY_PROC (RT Professional).............................................................................1633
3.2.3.6 DMDeactivateRTProject (RT Professional)........................................................................1635
3.2.3.7 DMDisconnect (RT Professional).......................................................................................1636
3.2.3.8 DMEnumNumberFormats (RT Professional).....................................................................1638
3.2.3.9 DM_ENUM_FORMATS_PROC (RT Professional).............................................................1639
3.2.3.10 DMEnumUpdateCycles (RT Professional).........................................................................1641
3.2.3.11 DM_ENUM_CYCLES_PROC (RT Professional)................................................................1642
3.2.3.12 DMExitWinCC (RT Professional).......................................................................................1644
3.2.3.13 DMExitWinCCEx (RT Professional)...................................................................................1645
3.2.3.14 DMFireNotifyData (RT Professional)..................................................................................1646
3.2.3.15 DMGetConnectionState (RT Professional)........................................................................1648
3.2.3.16 DMGetDataLocale (RT Professional).................................................................................1649
3.2.3.17 DMGetHotkey (RT Professional)........................................................................................1650
3.2.3.18 DMGetMachineInfo (RT Professional)...............................................................................1651
3.2.3.19 DMGetMachineTable (RT Professional)............................................................................1652
3.2.3.20 DMRemoveNotify (RT Professional)..................................................................................1653
3.2.4 Functions for project management (RT Professional)........................................................1656
3.2.4.1 DMEnumOpenedProjects (RT Professional).....................................................................1656
3.2.4.2 DM_ENUM_OPENED_PROJECTS_PROC (RT Professional)..........................................1657
3.2.4.3 DMGetProjectDirectory (RT Professional).........................................................................1659
3.2.4.4 DMGetProjectInformation (RT Professional)......................................................................1660
3.2.4.5 DMGetRuntimeProject (RT Professional)..........................................................................1662
3.2.4.6 DMOpenProjectDocPlus (RT Professional).......................................................................1663
3.2.4.7 DMOpenProjectPlus (RT Professional)..............................................................................1664
3.2.5 Data transport channels (RT Professional)........................................................................1666
3.2.5.1 DMClearBlockQueue (RT Professional)............................................................................1666
3.2.5.2 DMEnumDataServices (RT Professional)..........................................................................1667
3.2.5.3 DM_ENUM_DATA_SERVICE_PROC (RT Professional)...................................................1668
3.2.5.4 DM_DATA_SERVICE_PROC (RT Professional)...............................................................1670
3.2.5.5 DMGetNumPendingBlocks (RT Professional)...................................................................1671
3.2.5.6 DMInstallDataService (RT Professional)............................................................................1672
3.2.5.7 DMSendApplicationData (RT Professional).......................................................................1674
3.2.5.8 DMSetBlockQueueSize (RT Professional).........................................................................1675

Table of contents
3.2.6 Functions for processing tags (RT Professional)...............................................................1676

3.2.6.1 DMEnumVarData (RT Professional)..................................................................................1676
3.2.6.2 DM_ENUM_VARIABLE_PROC (RT Professional).............................................................1678
3.2.6.3 DMEnumVarData4 (RT Professional)................................................................................1679
3.2.6.4 DM_ENUM_VARIABLE_PROC4 (RT Professional)...........................................................1682
3.2.6.5 DMEnumVarGrpData (RT Professional)............................................................................1683
3.2.6.6 DMEnumVarGrpDataExStr (RT Professional)...................................................................1685
3.2.6.7 DM_ENUM_VARGRP_PROC (RT Professional)...............................................................1687
3.2.6.8 DMEnumVariables (RT Professional)................................................................................1688
3.2.6.9 DM_ENUM_VAR_PROC (RT Professional).......................................................................1690
3.2.6.10 DMGetValue (RT Professional)..........................................................................................1691
3.2.6.11 DMGetValueEx (RT Professional).....................................................................................1693
3.2.6.12 DMGetValueExStr (RT Professional).................................................................................1695
3.2.6.13 DMGetValueWait (RT Professional)..................................................................................1704
3.2.6.14 DMGetValueWaitEx (RT Professional)..............................................................................1706
3.2.6.15 DMGetValueWaitExStr (RT Professional)..........................................................................1708
3.2.6.16 DMGetVarInfo (RT Professional).......................................................................................1710
3.2.6.17 DMGetVarInfoExStr (RT Professional)..............................................................................1712
3.2.6.18 DMGetVarLimits (RT Professional)....................................................................................1721
3.2.6.19 DMGetVarLimitsExStr (RT Professional)...........................................................................1723
3.2.6.20 DMGetVarType (RT Professional).....................................................................................1728
3.2.6.21 DMGetVarTypeExStr (RT Professional)............................................................................1730
3.2.6.22 DMSetValue (RT Professional)..........................................................................................1734
3.2.6.23 DMSetValueExStr (RT Professional).................................................................................1737
3.2.6.24 DMSetValueMessage (RT Professional)...........................................................................1740
3.2.6.25 DMSetValueMessageExStr (RT Professional)...................................................................1742
3.2.6.26 DMSetValueWait (RT Professional)...................................................................................1744
3.2.6.27 DMSetValueWaitExStr (RT Professional)..........................................................................1746
3.2.6.28 DMSetValueWaitMessage (RT Professional)....................................................................1749
3.2.6.29 DMSetValueWaitMessageExStr (RT Professional)...........................................................1751
3.2.6.30 DM_COMPLETITION_PROC (RT Professional)................................................................1754
3.2.6.31 DMShowVarPropertiesExStr (RT Professional).................................................................1756
3.2.6.32 DMShowVarDatabase (RT Professional)...........................................................................1758
3.2.6.33 DMShowVarDatabaseExStr (RT Professional)..................................................................1760
3.2.6.34 DMShowVarDatabaseMulti (RT Professional)...................................................................1763
3.2.6.35 DMShowVarDatabaseMultiExStr (RT Professional)..........................................................1766
3.2.6.36 DM_NOTIFY_SELECT_VAR_PROC (RT Professional)....................................................1769
3.2.6.37 GAPICreateNewVariable (RT Professional)......................................................................1771
3.2.6.38 GAPICreateNewVariable4 (RT Professional)....................................................................1772
3.2.6.39 GAPICreateNewVariable5 (RT Professional)....................................................................1774
3.2.6.40 GAPICreateNewVariableEx4 (RT Professional)................................................................1775
3.2.7 Functions for processing structured tags (RT Professional)..............................................1777
3.2.7.1 GAPIEnumTypeMembers (RT Professional).....................................................................1777
3.2.7.2 DM_ENUM_TYPEMEMBERS_PROC (RT Professional)...................................................1779
3.2.7.3 GAPIEnumTypeMembersEx (RT Professional).................................................................1780
3.2.7.4 GAPIEnumTypeMembersExStr (RT Professional)............................................................1782
3.2.7.5 DM_ENUM_TYPEMEMBERS_PROC_EX (RT Professional)............................................1783
3.2.7.6 GAPIEnumTypeMembersEx4 (RT Professional)...............................................................1785
3.2.7.7 DM_ENUM_TYPEMEMBERS_PROC_EX4 (RT Professional)..........................................1786
3.2.7.8 GAPIEnumTypes (RT Professional)..................................................................................1788
3.2.7.9 DM_ENUM_TYPES_PROC (RT Professional)..................................................................1789
3.2.8 Functions for processing connections (RT Professional)...................................................1791

Table of contents
3.2.8.1 DMEnumConnectionData (RT Professional).....................................................................1791

3.2.8.2 DMEnumConnectionDataExStr (RT Professional).............................................................1793
3.2.8.3 DM_ENUM_CONNECTION_PROC (RT Professional)......................................................1794
3.2.9 Functions for the work platform (RT Professional).............................................................1795
3.2.9.1 DMGetOSVersion (RT Professional).................................................................................1795
3.2.9.2 DMGetSystemLocale (RT Professional)............................................................................1797
3.2.9.3 DMSetLanguage (RT Professional)...................................................................................1799
3.2.9.4 DMShowLanguageDialog (RT Professional).....................................................................1800
3.2.10 Functions for updating tags (RT Professional)...................................................................1801
3.2.10.1 DMBeginStartVarUpdate (RT Professional).......................................................................1801
3.2.10.2 DMEndStartVarUpdate (RT Professional).........................................................................1803
3.2.10.3 DMResumeVarUpdate (RT Professional)..........................................................................1804
3.2.10.4 DMStartVarUpdate (RT Professional)................................................................................1806
3.2.10.5 DM_NOTIFY_VARIABLE_PROC (RT Professional)..........................................................1808
3.2.10.6 DMStartVarUpdateEx (RT Professional)............................................................................1809
3.2.10.7 DMStartVarUpdateExStr (RT Professional).......................................................................1812
3.2.10.8 DM_NOTIFY_VARIABLEEX_PROC (RT Professional).....................................................1819
3.2.10.9 DMStopAllUpdates (RT Professional)................................................................................1820
3.2.10.10 DMStopVarUpdate (RT Professional)................................................................................1821
3.2.10.11 DMSuspendVarUpdate (RT Professional).........................................................................1823
3.2.11 Examples (RT Professional)..............................................................................................1825
3.2.11.1 Connection to DM (RT Professional).................................................................................1825
3.2.11.2 Enum Data of Tags (RT Professional)...............................................................................1828
3.2.11.3 Enum open projects (RT Professional)..............................................................................1830
3.2.11.4 Enumerate all structured types (RT Professional).............................................................1832
3.2.11.5 Enumerate all connections (RT Professional)....................................................................1834
3.2.11.6 Inquire project informations (RT Professional)...................................................................1836
3.2.11.7 OnTestDeactivateRuntimeProject (RT Professional).........................................................1837
3.2.11.8 OnTestEnumGroupsAll (RT Professional).........................................................................1837
3.2.11.9 OnTestEnumVariables (RT Professional)..........................................................................1838
3.2.11.10 OnTestEnumConnectionDataAll (RT Professional)...........................................................1839
3.2.11.11 OnTestMachines (RT Professional)...................................................................................1840
3.2.11.12 OnTestProjectInfo (RT Professional).................................................................................1841
3.2.11.13 OnTestProjectPaths (RT Professional)..............................................................................1842
3.2.11.14 OnTestOpenProject (RT Professional)..............................................................................1843
3.2.11.15 OnTestOpenProjects (RT Professional).............................................................................1844
3.2.11.16 OnTestRuntimeProject (RT Professional)..........................................................................1844
3.2.11.17 OnTestSystemLocale (RT Professional)............................................................................1845
3.2.11.18 OnTestUpdateCycles (RT Professional)............................................................................1845
3.2.11.19 OnTestVariablenBeginstartvarupdate (RT Professional)...................................................1846
3.2.11.20 OnTestVariablenEndstartvarupdate (RT Professional)......................................................1847
3.2.11.21 OnTestVariablenGetvalue (RT Professional).....................................................................1848
3.2.11.22 OnTestVariablenGetvaluewait (RT Professional)..............................................................1851
3.2.11.23 OnTestVariablenGetVarInfo (RT Professional)..................................................................1855
3.2.11.24 OnTestVariablenGetvarlimits (RT Professional)................................................................1856
3.2.11.25 OnTestVariablenGetvartype (RT Professional)..................................................................1857
3.2.11.26 OnTestVariablenResumevarupdate (RT Professional)......................................................1858
3.2.11.27 OnTestVariablenSetvalue (RT Professional).....................................................................1859
3.2.11.28 OnTestVariablenSetvaluewait (RT Professional)...............................................................1860
3.2.11.29 OnTestVariablenStopallupdates (RT Professional)...........................................................1861
3.2.11.30 OnTestVariablenStopvarupdate (RT Professional)............................................................1861
3.2.11.31 OnTestVariablenSuspendvarupdate (RT Professional).....................................................1862

Table of contents
3.2.11.32 OnTestWinCCShutdown (RT Professional).......................................................................1862

3.2.11.33 Open project by means of dialog (RT Professional)..........................................................1863
3.2.11.34 Read tag (RT Professional)................................................................................................1864
3.2.11.35 Write tag (RT Professional)................................................................................................1869
3.3 Functions of the graphic system (RT Professional)...........................................................1871
3.3.1.5 List of object properties (A-K) (Graphics Designer) (RT Professional)..............................1875
3.3.1.6 List of object properties (L-Z) (Graphics Designer) (RT Professional)...............................1886
3.3.1.7 API calls to OCXs (RT Professional)..................................................................................1898
3.3.2.1 LINKINFO (RT Professional)..............................................................................................1898
3.3.2.2 MULTILINK (RT Professional)...........................................................................................1900
3.3.2.3 MULTILINKINFO (RT Professional)...................................................................................1901
3.3.2.4 FOCUSINFO (RT Professional).........................................................................................1902
3.3.3.1 PDLRTClosePicture (RT Professional)..............................................................................1902
3.3.3.2 PDLRTDisableClosePicture (RT Professional)..................................................................1904
3.3.3.3 PDLRTEnableClosePicture (RT Professional)...................................................................1906
3.3.3.4 PDLRTGotoPicture (RT Professional)...............................................................................1907
3.3.3.5 PDLRTInquireFreeArea (RT Professional)........................................................................1909
3.3.3.6 PDLRTOpenPicture (RT Professional)..............................................................................1910
3.3.3.7 PDLRTPictureNavigation (RT Professional)......................................................................1913
3.3.3.8 PDLRTShowApp (RT Professional)...................................................................................1914
3.3.3.9 PDLRT_CALLBACK (RT Professional)..............................................................................1915
3.3.4 Functions for affecting the runtime cursor (RT Professional).............................................1917
3.3.4.1 PDLRTGetCursorKeys (RT Professional)..........................................................................1917
3.3.4.2 PDLRTGetFocus (RT Professional)...................................................................................1919
3.3.4.3 PDLRTSetCursorKeys (RT Professional)..........................................................................1921
3.3.4.4 PDLRTSetFocus (RT Professional)...................................................................................1923
3.3.5 Functions for processing object properties (RT Professional)...........................................1925
3.3.5.1 PDLRTGetDefPropEx (RT Professional)...........................................................................1925
3.3.5.2 PDLRTGetPropEx (RT Professional).................................................................................1927
3.3.5.3 PDLRTSetPropEx (RT Professional).................................................................................1930
3.3.6 Functions for processing dynamics (RT Professional).......................................................1935
3.3.6.1 PDLRTGetLink (RT Professional)......................................................................................1935
3.3.6.2 PDLRTSetLink (RT Professional)......................................................................................1937
3.3.6.3 PDLRTSetMultiLink (RT Professional)...............................................................................1939
3.4 Scripting functions (RT Professional).................................................................................1941
3.4.2.1 AP_ACT_KEY (RT Professional).......................................................................................1946
3.4.2.2 AP_ACT_RESULT_STRUCT (RT Professional)................................................................1948
3.4.2.3 CREATE_USER_HEADER_FILE (RT Professional)..........................................................1949

Table of contents
3.4.2.4 GENERATE_COMPILE (RT Professional)........................................................................1950

3.4.2.5 GET_ACTION_STREAM (RT Professional).......................................................................1950
3.4.3.1 APConnect (RT Professional)............................................................................................1951
3.4.3.2 APDisconnect (RT Professional)........................................................................................1953
3.4.3.3 APSetLanguage (RT Professional)....................................................................................1955
3.4.3.4 AP_RT_PROC (RT Professional).......................................................................................1956
3.4.4 Functions for processing Source Code (RT Professional).................................................1959
3.4.4.1 APCompile (RT Professional)............................................................................................1959
3.4.4.2 APCompileEx (RT Professional)........................................................................................1961
3.4.4.3 GSCGenCompile (RT Professional)..................................................................................1964
3.4.4.4 GSCGenCompileUserFunctions (RT Professional)...........................................................1965
3.4.5 Functions for processing actions (RT Professional)...........................................................1967
3.4.5.1 GSCGenGetActionStream (RT Professional)....................................................................1967
3.4.6 Functions of the action programming (RT Professional)....................................................1968
3.4.6.1 APActive (RT Professional)................................................................................................1968
3.4.6.2 APEndAct (RT Professional)..............................................................................................1970
3.4.6.3 APFreeResultStruct (RT Professional)..............................................................................1971
3.4.6.4 APInactive (RT Professional).............................................................................................1972
3.4.6.5 APStart (RT Professional)..................................................................................................1974
3.4.6.6 APTransact (RT Professional)...........................................................................................1977
3.4.7.1 Establish connection to script programming (RT Professional).........................................1979
3.5 Functions of the user administration (RT Professional).....................................................1981
3.5.2.1 PWGEN_GROUPINFO (RT Professional).........................................................................1984
3.5.2.2 PWGEN_LEVELINFO (RT Professional)...........................................................................1985
3.5.2.3 PWGEN_USERINFO (RT Professional)............................................................................1986
3.5.3.1 PWGENConnect (RT Professional)...................................................................................1987
3.5.3.2 PWGENDisconnect (RT Professional)...............................................................................1988
3.5.4 Functions for processing users (RT Professional).............................................................1990
3.5.4.1 PWGENAddUser (RT Professional)...................................................................................1990
3.5.4.2 PWGENAddUserEx (RT Professional)..............................................................................1991
3.5.4.3 PWGENChangePassword (RT Professional)....................................................................1993
3.5.4.4 PWGENCheckUser (RT Professional)...............................................................................1995
3.5.4.5 PWGENDeleteUser (RT Professional)...............................................................................1996
3.5.4.6 PWGENEnumUsers (RT Professional)..............................................................................1997
3.5.4.7 PWGEN_ENUM_USERS_CALLBACK (RT Professional).................................................1999
3.5.5 Functions for processing user groups (RT Professional)...................................................2000
3.5.5.1 PWGENAddGroup (RT Professional)................................................................................2000
3.5.5.2 PWGENEnumGroups (RT Professional)...........................................................................2002
3.5.5.3 PWGEN_ENUM_GROUPS_CALLBACK (RT Professional)..............................................2003
3.5.6 Functions for processing authorizations (RT Professional)................................................2005
3.5.6.1 PWGENAddPermLevel (RT Professional).........................................................................2005
3.5.6.2 PWGENCheckPermission (RT Professional).....................................................................2006
3.5.6.3 PWGENDeletePermLevel (RT Professional).....................................................................2007

Table of contents
3.5.6.4 PWGENEnumPermLevels (RT Professional)....................................................................2009

3.5.6.5 PWGEN_ENUM_LEVELS_CALLBACK (RT Professional)................................................2010
3.5.6.6 PWGENReadUserPerm (RT Professional)........................................................................2011
3.5.6.7 PWRTCheckPermission (RT Professional)........................................................................2013
3.5.6.8 PWRTCheckPermissionOnPicture (RT Professional)........................................................2014
3.5.6.9 PWRTPermissionLevelDialog (RT Professional)...............................................................2015
3.5.6.10 PWRTPermissionLevelDialogEx (RT Professional)...........................................................2016
3.5.6.11 PWRTPermissionToString (RT Professional)....................................................................2017
3.5.7 Functions for logon, logoff (RT Professional).....................................................................2018
3.5.7.1 PWRTGetCurrentUser (RT Professional)..........................................................................2018
3.5.7.2 PWRTGetLoginPriority (RT Professional)..........................................................................2019
3.5.7.3 PWRTIsLoggedInByCard (RT Professional)......................................................................2020
3.5.7.4 PWRTLogin (RT Professional)...........................................................................................2021
3.5.7.5 PWRTLogout (RT Professional).........................................................................................2023
3.5.7.6 PWRTLogoutEx (RT Professional)....................................................................................2024
3.5.7.7 PWRTSilentLogin (RT Professional)..................................................................................2025
3.5.7.8 PWRTSilentLoginEx (RT Professional)..............................................................................2026
3.5.8.1 PWRT check permission (RT Professional).......................................................................2028
3.5.8.2 Checks admission of a certain level for a screen (RT Professional)..................................2029
3.5.8.3 Gets a string associated with the permission number (RT Professional)...........................2030
3.5.8.4 Authorization level query through a dialog with specifying a possible error (RT
Professional)......................................................................................................................2031
3.5.8.5 Return the name of the current user (RT Professional).....................................................2032
3.5.8.6 Queries the current logon priority (RT Professional)..........................................................2033
3.5.8.7 Checks if the user has been logged on by card (RT Professional)....................................2033
3.5.8.8 PWRT login - dialog provided by WinCC itself (RT Professional)......................................2035
3.5.8.9 PWRT logoff (RT Professional)..........................................................................................2036
3.5.8.10 Silent logoff with priority level (RT Professional)................................................................2037
3.5.8.11 Logon without using a dialog (RT Professional).................................................................2038
3.5.8.12 Silent logon with priority level (RT Professional)................................................................2039
3.6 Functions of the text system (RT Professional).................................................................2040
3.6.1.3 Language codes (RT Professional)....................................................................................2042
3.6.2.1 TXTCloseProject (RT Professional)...................................................................................2043
3.6.2.2 TXTGetMaxTextID (RT Professional)................................................................................2045
3.6.2.3 TXTOpenProject (RT Professional)...................................................................................2046
3.6.2.4 TXTRTConnect (RT Professional)....................................................................................2047
3.6.2.5 TXTRTDisconnect (RT Professional).................................................................................2048
3.6.3 Functions for processing infotext (RT Professional)..........................................................2050
3.6.3.1 TXTEnumInfoText (RT Professional).................................................................................2050
3.6.3.2 TXT_ENUM_INFOTEXTS_PROC (RT Professional).........................................................2052
3.6.3.3 TXTUpdateRuntime (RT Professional)..............................................................................2053
3.6.3.4 TXTRTGetInfoText (RT Professional)................................................................................2054
3.6.3.5 TXTRTGetInfoTextMC (RT Professional)..........................................................................2056
3.6.4 Functions for processing languages (RT Professional).....................................................2058
3.6.4.1 TXTEnumLanguages (RT Professional)............................................................................2058
3.6.4.2 TXT_ENUM_LANGUAGES_PROC (RT Professional).......................................................2059
3.6.4.3 TXTGetFont (RT Professional)..........................................................................................2061

Table of contents
3.6.4.4 TXTShowLanguagesDialog (RT Professional)..................................................................2062

3.6.4.5 TXTRTGetLanguageID (RT Professional).........................................................................2064
3.6.4.6 TXTRTSetLanguage (RT Professional).............................................................................2065
3.6.5.1 Get infotext (RT Professional)............................................................................................2067
3.6.5.2 Enumerate infotexts (RT Professional)..............................................................................2069
3.7 Report system functions (RT Professional)........................................................................2071
3.7.1.4 List of object properties (RT Professional).........................................................................2075
3.7.1.5 General procedure for processing print job properties (Report Designer) (RT
Professional)......................................................................................................................2080
3.7.2 Functions for establishing connections (RT Professional).................................................2083
3.7.2.1 RPJAttach (RT Professional).............................................................................................2083
3.7.2.2 RPJDetach (RT Professional)............................................................................................2084
3.7.2.3 RPJMemFree (RT Professional)........................................................................................2085
3.7.3 Functions for processing project properties (RT Professional)..........................................2086
3.7.3.1 RPJGetNumProjectProperties (RT Professional)..............................................................2086
3.7.3.2 RPJGetProjectPropertyAt (RT Professional).....................................................................2087
3.7.3.3 RPJGetProjectProperty (RT Professional).........................................................................2088
3.7.3.4 RPJProjectLock (RT Professional).....................................................................................2089
3.7.3.5 RPJProjectUnlock (RT Professional).................................................................................2091
3.7.3.6 RPJProjectUnlockAll (RT Professional).............................................................................2092
3.7.4 Functions for processing print jobs (RT Professional).......................................................2093
3.7.4.1 RPJCreateJob (RT Professional).......................................................................................2093
3.7.4.2 RPJDeleteJob (RT Professional).......................................................................................2094
3.7.4.3 RPJCreatePropertyHandle (RT Professional)....................................................................2096
3.7.4.4 RPJDeletePropertyHandle (RT Professional)....................................................................2097
3.7.4.5 RPJGetJobNameAt (RT Professional)...............................................................................2099
3.7.4.6 RPJGetNumJobs (RT Professional)..................................................................................2100
3.7.4.7 RPJJobLock (RT Professional)..........................................................................................2101
3.7.4.8 RPJJobUnlock (RT Professional).......................................................................................2103
3.7.4.9 RPJJobUnlockAll (RT Professional)...................................................................................2104
3.7.5 Functions for processing print job methods (RT Professional)..........................................2106
3.7.5.1 RPJCallJobMethod (RT Professional)...............................................................................2106
3.7.5.2 RPJGetJobMethodAt (RT Professional)............................................................................2107
3.7.5.3 RPJGetNumJobMethods (RT Professional)......................................................................2108
3.7.6 Functions for processing print job methods (RT Professional)..........................................2109
3.7.6.1 RPJGetJobPropertyAt (RT Professional)...........................................................................2109
3.7.6.2 RPJGetJobProps (RT Professional)..................................................................................2111
3.7.6.3 RPJGetNumJobProperties (RT Professional)....................................................................2112
3.7.6.4 RPJGetProperty (RT Professional)....................................................................................2113
3.7.6.5 RPJPropertyClear (RT Professional).................................................................................2116
3.7.6.6 RPJSetProperty (RT Professional)....................................................................................2117
3.7.7.1 Get print job method name (RT Professional)....................................................................2121
3.7.7.2 Get print job names (RT Professional)...............................................................................2124
3.7.7.3 Get print job properties (RT Professional)..........................................................................2127
3.7.7.4 Modify print job properties (RT Professional).....................................................................2130
3.7.7.5 Show print job preview (RT Professional)..........................................................................2135

Table of contents
3.8 Tag and log functions (RT Professional)............................................................................2138

3.8.2.1 TLG_ARCHIV_STR (RT Professional)...............................................................................2151
3.8.2.2 TLG_ARCHIVDATARAW (RT Professional)......................................................................2154
3.8.2.3 TLG_BACKUP_TABLE_INFO (RT Professional)...............................................................2157
3.8.2.4 TLG_CURVESCALEX (RT Professional)...........................................................................2159
3.8.2.5 TLG_CURVESCALEY (RT Professional)...........................................................................2164
3.8.2.6 TLG_GETARCHIVDATA (RT Professional).......................................................................2168
3.8.2.7 TLG_IO_BACKUP_SELECT (RT Professional).................................................................2169
3.8.2.8 TLG_PROT_CURVE_INFOS (RT Professional)................................................................2170
3.8.2.9 TLG_SCAL_STR (RT Professional)...................................................................................2172
3.8.2.10 TLG_TABLE_INFO (RT Professional)................................................................................2173
3.8.2.11 TLG_TABLESCALE (RT Professional)..............................................................................2174
3.8.2.12 TLG_TEMPLATEITEM_INFO (RT Professional)...............................................................2177
3.8.2.13 TLG_TIME_STR (RT Professional)....................................................................................2179
3.8.2.14 TLG_TIMEDATA (RT Professional)...................................................................................2180
3.8.2.15 TLG_TPLITEM_CURVE (RT Professional)........................................................................2181
3.8.2.16 TLG_TPLITEM_INFO (RT Professional)............................................................................2182
3.8.2.17 TLG_TPLITEM_TABLE (RT Professional).........................................................................2183
3.8.2.18 TLG_VAR_STR (RT Professional).....................................................................................2184
3.8.2.19 TLG_VARIABLE_INFO (RT Professional).........................................................................2189
3.8.3.1 TLGCSConnect (RT Professional).....................................................................................2190
3.8.3.2 TLGCSConnectEx (RT Professional).................................................................................2192
3.8.3.3 TLGCSDisConnect (RT Professional)................................................................................2193
3.8.3.4 TLGChangeLanguage (RT Professional)...........................................................................2194
3.8.3.5 TLGConnect (RT Professional)..........................................................................................2195
3.8.3.6 TLGDisconnect (RT Professional).....................................................................................2197
3.8.4 Project management functions (RT Professional)..............................................................2198
3.8.4.1 TLGCloseProject (RT Professional)...................................................................................2198
3.8.4.2 TLGOpenProject (RT Professional)...................................................................................2200
3.8.4.3 TLGEnumProject (RT Professional)...................................................................................2202
3.8.4.4 TLG_ENUM_PROJECT_NAME_CALLBACK (RT Professional).......................................2203
3.8.5 Functions for processing tags (RT Professional)...............................................................2204
3.8.5.1 TLGEnumVariables (RT Professional)...............................................................................2204
3.8.5.2 TLG_ENUM_VARIABLE_NAME_CALLBACK (RT Professional).......................................2205
3.8.5.3 TLGEnumVariablesEx (RT Professional)...........................................................................2206
3.8.5.4 TLG_ENUMVARIABLES (RT Professional).......................................................................2208
3.8.5.5 TLGReadVariable (RT Professional).................................................................................2209
3.8.6 Functions for processing logs (RT Professional)...............................................................2211
3.8.6.1 TLGEnumArchives (RT Professional)................................................................................2211
3.8.6.2 TLG_ENUM_ARCHIV_CALLBACK (RT Professional).......................................................2212
3.8.6.3 TLGEnumArchivs (RT Professional)..................................................................................2214
3.8.6.4 TLGEnumArchivsEx (RT Professional)..............................................................................2216
3.8.6.5 TLGEnumArchivsSel (RT Professional).............................................................................2217
3.8.6.6 TLG_ENUMTABLES (RT Professional).............................................................................2219
3.8.6.7 TLGFreeMemory (RT Professional)...................................................................................2221

Table of contents
3.8.6.8 TLGGetArchivData (RT Professional)................................................................................2222

3.8.6.9 TLG_GETARCHIVDATA_CALLBACK (RT Professional)..................................................2224
3.8.6.10 TLGGetArchivDataEx (RT Professional)............................................................................2226
3.8.6.11 TLGGetClosestTime (RT Professional).............................................................................2228
3.8.6.12 TLGGetClosestTimeEx (RT Professional).........................................................................2230
3.8.6.13 TLGInsertArchivData (RT Professional).............................................................................2232
3.8.6.14 TLGLockArchiv (RT Professional)......................................................................................2235
3.8.6.15 TLGLockVariable (RT Professional)..................................................................................2236
3.8.6.16 TLGReadArchiv (RT Professional).....................................................................................2238
3.8.7 Functions for trend and table views (RT Professional)......................................................2239
3.8.7.1 TLGCloseWindow (RT Professional).................................................................................2239
3.8.7.2 TLGDrawCurvesInDC (RT Professional)...........................................................................2240
3.8.7.3 TLGInsertTemplateItem (RT Professional)........................................................................2242
3.8.7.4 TLGPressToolbarButton (RT Professional).......................................................................2243
3.8.7.5 TLGSetRulerWindowVisible (RT Professional)..................................................................2245
3.8.7.6 TLGShowWindow (RT Professional).................................................................................2246
3.8.8 Functions for processing time systems (RT Professional).................................................2247
3.8.8.1 TLGEnumTime (RT Professional)......................................................................................2247
3.8.8.2 TLG_ENUM_TIME_NAME_CALLBACK (RT Professional)................................................2249
3.8.8.3 TLGEnumTimes (RT Professional)....................................................................................2250
3.8.8.4 TLG_ENUMTIMES_CALLBACK (RT Professional)...........................................................2252
3.8.8.5 TLGReadTime (RT Professional).......................................................................................2253
3.8.9 Functions for saving and restoring (RT Professional)........................................................2254
3.8.9.1 TLGEnumBackupEntries (RT Professional).......................................................................2254
3.8.9.2 TLG_ENUMBACKUP_ENTRIES (RT Professional)...........................................................2256
3.8.9.3 TLGExport (RT Professional).............................................................................................2257
3.8.9.4 TLGGetBackupSize (RT Professional)..............................................................................2259
3.8.10.1 Edit curve template - Example 1 (RT Professional)...........................................................2261
3.8.10.2 Enum all acquisition and logging times (RT Professional).................................................2264
3.8.10.3 Enum logs (RT Professional).............................................................................................2267
3.8.10.4 Enum tags of a log (RT Professional)................................................................................2270
3.8.10.5 Enumerate logs (RT Professional).....................................................................................2272
3.8.10.6 Read log (RT Professional)................................................................................................2274
3.8.10.7 Read parameters of time object (RT Professional)............................................................2278
3.9 Recipe functions (RT Professional)....................................................................................2280
3.9.1.2 Structure of recipes (RT Professional)...............................................................................2282
3.9.1.3 Dependencies in call sequence of API functions (RT Professional)..................................2284
3.9.2.1 uaCONFIGARCHIVE (RT Professional)............................................................................2288
3.9.2.2 uaCONFIGFIELD (RT Professional)..................................................................................2290
3.9.3.1 uaGetLastError (RT Professional)......................................................................................2291
3.9.3.2 uaIsActive (RT Professional)..............................................................................................2293
3.9.3.3 uaUsers (RT Professional).................................................................................................2294
3.9.3.4 uaSetLocalEvents (RT Professional).................................................................................2295
3.9.4 Functions for generating connections (RT Professional)...................................................2296
3.9.4.1 uaConnect (RT Professional).............................................................................................2296

Table of contents
3.9.4.2 uaDisconnect (RT Professional)........................................................................................2297

3.9.4.3 uaQueryArchive (RT Professional)....................................................................................2298
3.9.4.4 uaQueryArchiveByName (RT Professional).......................................................................2300
3.9.4.5 UaQueryConfiguration (RT Professional)..........................................................................2302
3.9.4.6 uaReleaseArchive (RT Professional).................................................................................2303
3.9.4.7 uaReleaseConfiguration (RT Professional)........................................................................2305
3.9.5 Functions for recipe processing (RT Professional)............................................................2306
3.9.5.1 uaArchiveClose (RT Professional).....................................................................................2306
3.9.5.2 uaArchiveDelete (RT Professional)....................................................................................2307
3.9.5.3 uaArchiveExport (RT Professional)....................................................................................2308
3.9.5.4 uaArchiveGetID (RT Professional).....................................................................................2310
3.9.5.5 uaArchiveGetName (RT Professional)...............................................................................2311
3.9.5.6 uaArchiveGetSort (RT Professional)..................................................................................2312
3.9.5.7 uaArchiveImport (RT Professional)....................................................................................2313
3.9.5.8 uaArchiveOpen (RT Professional).....................................................................................2314
3.9.5.9 uaArchiveUpdate (RT Professional)...................................................................................2315
3.9.5.10 uaGetArchive (RT Professional)........................................................................................2316
3.9.5.11 uaGetNumArchives (RT Professional)...............................................................................2318
3.9.5.12 uaOpenArchives (RT Professional)....................................................................................2318
3.9.6 Functions for recipe element processing (RT Professional)..............................................2319
3.9.6.1 uaArchiveGetCount (RT Professional)...............................................................................2319
3.9.6.2 uaArchiveGetFilter (RT Professional)................................................................................2321
3.9.6.3 uaArchiveInsert (RT Professional).....................................................................................2322
3.9.6.4 uaArchiveMoveFirst (RT Professional)..............................................................................2323
3.9.6.5 uaArchiveMoveLast (RT Professional)...............................................................................2324
3.9.6.6 uaArchiveMoveNext (RT Professional)..............................................................................2325
3.9.6.7 uaArchiveMovePrevious (RT Professional).......................................................................2326
3.9.6.8 uaGetNumFields (RT Professional)...................................................................................2327
3.9.7 Functions for field processing (RT Professional)...............................................................2328
3.9.7.1 uaArchiveGetFieldLength (RT Professional)......................................................................2328
3.9.7.2 uaArchiveGetFieldName (RT Professional).......................................................................2329
3.9.7.3 uaArchiveGetFields (RT Professional)...............................................................................2330
3.9.7.4 uaArchiveGetFieldType (RT Professional).........................................................................2331
3.9.7.5 uaArchiveGetFieldValueDate (RT Professional)................................................................2332
3.9.7.6 uaArchiveGetFieldValueDouble (RT Professional)............................................................2333
3.9.7.7 uaArchiveGetFieldValueLong (RT Professional)...............................................................2335
3.9.7.8 uaArchiveGetFieldValueString (RT Professional)..............................................................2336
3.9.7.9 uaArchiveSetFieldValueDate (RT Professional)................................................................2337
3.9.7.10 uaArchiveSetFieldValueDouble (RT Professional)............................................................2338
3.9.7.11 uaArchiveSetFieldValueLong (RT Professional)................................................................2339
3.9.7.12 uaArchiveSetFieldValueString (RT Professional)..............................................................2341
3.9.7.13 uaGetField (RT Professional).............................................................................................2342
3.9.8 Filter and sort functions. (RT Professional)........................................................................2343
3.9.8.1 uaArchiveRequery (RT Professional).................................................................................2343
3.9.8.2 uaArchiveSetFilter (RT Professional).................................................................................2344
3.9.8.3 uaArchiveSetSort (RT Professional)..................................................................................2346
3.9.9 Functions for recipe view processing (RT Professional)....................................................2347
3.9.9.1 uaOpenViews (RT Professional)........................................................................................2347
3.9.10 Functions for variables processing (RT Professional)........................................................2348
3.9.10.1 uaArchiveReadTagValues (RT Professional)....................................................................2348
3.9.10.2 uaArchiveReadTagValuesByName (RT Professional).......................................................2349
3.9.10.3 uaArchiveWriteTagValues (RT Professional).....................................................................2350

Table of contents
3.9.10.4 uaArchiveWriteTagValuesByName (RT Professional).......................................................2352

3.10 Alarm functions (RT Professional).....................................................................................2353
3.10.2.1 MSG_RTCREATE_STRUCT_PLUS (RT Professional).....................................................2368
3.10.2.2 MSG_RTDATA_INSTANCECOMMENT_STRUCT_PLUS (RT Professional)....................2370
3.10.2.3 MSG_FILTER_STRUCT_PLUS (RT Professional)............................................................2374
3.10.2.4 MSG_RTDATA_INSTANCE_STRUCT_PLUS (RT Professional)......................................2378
3.10.2.5 MSG_CLASS_STRUCT_PLUS (RT Professional).............................................................2381
3.10.2.6 MSG_CSDATA_STRUCT_PLUS (RT Professional)..........................................................2383
3.10.2.7 MSG_RTGROUPENUM_STRUCT_PLUS (RT Professional)............................................2386
3.10.2.8 MSG_RTGROUPSET_STRUCT_PLUS (RT Professional)................................................2387
3.10.2.9 MSG_COMMENT_INSTANCE_STRUCT_PLUS (RT Professional)..................................2388
3.10.2.10 MSG_INFOTEXT_STRUCT_PLUS (RT Professional).......................................................2389
3.10.2.11 MSG_BACKUP_STRUCT_PLUS (RT Professional)..........................................................2390
3.10.2.12 MSG_RTLOCK_STRUCT_PLUS (RT Professional)..........................................................2392
3.10.2.13 MSG_TEXTVAL256_STRUCT_PLUS (RT Professional)...................................................2393
3.10.2.14 MSGULONGLONG (RT Professional)...............................................................................2394
3.10.3.1 MSRTEnumArchivDataPlus (RT Professional)..................................................................2395
3.10.3.2 MSRTStartMsgServicePlus (RT Professional)...................................................................2397
3.10.3.3 MSRTStopMsgServicePlus (RT Professional)...................................................................2400
3.10.3.4 MSRTQuitHornPlus (RT Professional)...............................................................................2402
3.10.3.5 MSG_SERVICE_NOTIFY_PROC_PLUS (RT Professional)..............................................2403
3.10.3.6 MSRTWebClientPlus (RT Professional)............................................................................2406
3.10.4 Functions for protocol processing (RT Professional)........................................................2407
3.10.4.1 MSRTActivateMProtPlus (RT Professional).......................................................................2407
3.10.4.2 MSRTPrintMProtPlus (RT Professional)............................................................................2408
3.10.5 Functions for alarm processing (RT Professional).............................................................2409
3.10.5.1 MSRTEnumArchivInstancePlus (RT Professional)............................................................2409
3.10.5.2 MSRTCreateMsgInstanceWithCommentPlus (RT Professional).......................................2410
3.10.5.3 MSRTCreateMsgInstancePlus (RT Professional)..............................................................2412
3.10.5.4 MSRTDialogMsgLockPlus (RT Professional)....................................................................2414
3.10.5.5 MSRTCreateMsgPlus (RT Professional)...........................................................................2415
3.10.5.6 MSRTEnumLockedMsgPlus (RT Professional).................................................................2417
3.10.5.7 MSRTEnumMsgRTDataPlus (RT Professional)................................................................2418
3.10.5.8 MSRTGetClassInfoPlus (RT Professional)........................................................................2419
3.10.5.9 MSRTGetMsgAttributesPlus (RT Professional).................................................................2421
3.10.5.10 MSRTGetLastMsgWithCommentPlus (RT Professional)...................................................2423
3.10.5.11 MSRTGetMsgActualPlus (RT Professional)......................................................................2425
3.10.5.12 MSRTGetMsgCSDataPlus (RT Professional)....................................................................2426
3.10.5.13 MSRTGetMsgPriorityPlus (RT Professional).....................................................................2429
3.10.5.14 MSRTGetMsgQuitPlus (RT Professional)..........................................................................2430
3.10.5.15 MSRTGetMsgTextPlus (RT Professional).........................................................................2432
3.10.5.16 MSRTGetSelectedMsgPlus (RT Professional)..................................................................2433
3.10.5.17 MSRTResetMsgPlus (RT Professional).............................................................................2435
3.10.5.18 MSRTLoopInAlarmPlus (RT Professional).........................................................................2437
3.10.6 Functions for alarm group processing (RT Professional)...................................................2438

Table of contents
3.10.6.1 MSRTEnumGroupMsgPlus (RT Professional)...................................................................2438

3.10.6.2 MSRTLockGroupPlus (RT Professional)...........................................................................2440
3.10.6.3 MSRTQuitGroupPlus (RT Professional)............................................................................2441
3.10.7 Functions for alarm filter processing (RT Professional).....................................................2443
3.10.7.1 MSRTGetFilterDataPlus (RT Professional)........................................................................2443
3.10.7.2 MSRTCheckWinFilterPlus (RT Professional).....................................................................2444
3.10.7.3 MSRTSetMsgFilterPlus (RT Professional).........................................................................2446
3.10.7.4 MSRTSetMsgWinFilterPlus (RT Professional)...................................................................2447
3.10.8 Functions for processing alarm view (RT Professional).....................................................2449
3.10.8.1 MSRTMsgWinCommandPlus (RT Professional)...............................................................2449
3.10.9 Functions for processing comments (RT Professional).....................................................2450
3.10.9.1 MSRTGetCommentInstancePlus (RT Professional)..........................................................2450
3.10.9.2 MSRTSetCommentInstancePlus (RT Professional)..........................................................2452
3.10.10 Functions for info text processing (RT Professional).........................................................2454
3.10.10.1 MSRTGetInfotextPlus (RT Professional)...........................................................................2454
3.10.10.2 MSRTSetInfotextPlus (RT Professional)............................................................................2455
3.10.11 Archiving functions (RT Professional)................................................................................2457
3.10.11.1 MSRTEnumBackupListPlus (RT Professional)..................................................................2457
3.10.11.2 MSRTExportPlus (RT Professional)...................................................................................2458
3.11 Functions for displaying the PLC code (RT Professional)..................................................2460
3.11.1 Display in STEP 7 (RT Professional).................................................................................2460
3.11.1.1 Basics (RT Professional)....................................................................................................2460
3.11.1.2 OpenTIAPortalProject (RT Professional)...........................................................................2461
3.11.1.3 OpenTIAPortalIECPLByCall (RT Professional)..................................................................2462
3.11.1.4 OpenTIAPortalIECPLByAssignment (RT Professional).....................................................2465
3.11.1.5 OpenTIAPortalS7GraphByBlock (RT Professional)...........................................................2467
3.11.1.6 Example: Integration in a WinCC function (RT Professional)............................................2469
3.11.2 Display in the PLC code display (RT Professional)............................................................2470
3.11.2.1 Basics (RT Professional)....................................................................................................2470
3.11.2.2 OpenViewerS7GraphByBlock (RT Professional)...............................................................2470
3.11.2.3 OpenViewerIECPLByCall (RT Professional)......................................................................2473
3.11.2.4 OpenViewerIECPLByFCCall (RT Professional).................................................................2476
3.11.2.5 OpenViewerIECPLByAssignment (RT Professional).........................................................2479
3.11.2.6 IsJumpableProDiagAlarm (RT Professional).....................................................................2481
3.11.3 Error-handling (RT Professional).......................................................................................2483
3.12 Functions for displaying the PLC code in an external application (RT Professional).........2485
3.12.2 Querying static information of networks (RT Professional)................................................2486
3.12.2.1 Initialize (RT Professional).................................................................................................2486
3.12.2.2 SetLanguage (RT Professional).........................................................................................2487
3.12.2.3 RequestByAssignment (RT Professional)..........................................................................2488
3.12.2.4 RequestByCall (RT Professional)......................................................................................2489
3.12.2.5 CancelRequest (RT Professional)......................................................................................2491
3.12.2.6 Terminate (RT Professional)..............................................................................................2491
3.12.2.7 Structure of the XML data (RT Professional).....................................................................2492
3.12.3 Querying dynamic statistical information of networks (RT Professional)...........................2495
3.12.3.1 StartDynamicDataSubscription (RT Professional).............................................................2495
3.12.3.2 StopDynamicSubscription (RT Professional).....................................................................2496
3.13 Troubleshooting (RT Professional)....................................................................................2497
3.13.1 CMN_ERROR (RT Professional).......................................................................................2497
3.13.2 CCStorageError.h (RT Professional).................................................................................2498

Table of contents
Index.......................................................................................................................................................2509

Table of contents

VB scripting 1
1.1 System functions (Panels, Comfort Panels, RT Advanced)
1.1.1 AcknowledgeAlarm (Panels, Comfort Panels, RT Advanced)
Description
Acknowledges all selected alarms.
This system function is used when the HMI device does not have an ACK key or when the
integrated key of the alarm view should not be used.
This system function can only be used for function keys.
Use in the function list

AcknowledgeAlarm
Use in user-defined functions

AcknowledgeAlarm
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".
Parameter
--
1.1.2 ActivatePLCCodeViewer (Panels, Comfort Panels, RT Advanced)
Description
Performs a screen change to the given screen with the PLC code view. The PLC code view
shows the program code of the relevant network.
You configure the ActivatePLCCodeView system function at the "Click PLC code view button"
event of a GRAPH overview or at an event of a button.
Screen change from the GRAPH overview

VB scripting
You configure the system function at the "Click PLC code view button" event in a GRAPH
overview to display the GRAPH step sequencer in the PLC code view. If no error is pending,
the sequence of the GRAPH step sequencer is displayed.
If an error occurs, the faulty step is displayed in the PLC code view after jump of the faulty
step. If multiple errors have occurred, the first faulty step of the sequencer is displayed after
the jump. If you have corrected the error, the next faulty step is automatically displayed in the
view. In the detail view, the transition or the interlock is displayed depending on the type of
error.
Screen change from an alarm
You configure the system function at an event of a button. When the button is pressed in
Runtime, the system function checks whether the alarm selected last in the configured alarm
view is a supervision alarm or a GRAPH alarm. If a jump is possible for this alarm, the
configured PLC code view is opened with the corresponding program code.
The jump from an alarm in the alarm view to the PLC code view is made possible for the
following supervision alarms:
● With global supervisions, only for interlock supervisions (Interlock)
● With local supervisions, for all basic supervisions at input parameters
You can find more information on supervisions in the section "Programming PLC > Supervising
machinery and plants with ProDiag".
The jump to the PLC code view is possible for all GRAPH alarms. After the jump, the GRAPH
sequencer and the faulty step are displayed in the PLC code view.
If a supervision alarm and an interlock alarm are pending simultaneously for the same step,
the interlock network is always displayed first after triggering the system function in the PLC
code view regardless of whether the supervision alarm or the interlock alarm was selected.
For the jump from a supervision alarm to the PLC code view, the instance name must conform
to the following naming convention when using supported local operands in a function block:
<FB-Name>_DB.
The jump to a function or an organization block is only possible if only global operands are
used.
Note
The jump in connection with the alarm buffer or the alarm log is not supported.

ActivatePLCCodeView(Screen name, Screen object)

ActivatePLCCodeView Screen_name, Object_name

VB scripting
Note
The version of the GRAPH block must be at least V3.0 for the jump into the GRAPH sequencer
via the "ActivatePLCCodeView" system function.
Note
Use of the system function "ActivatePLCCodeView" in a VB script has no effect at a GRAPH
overview.
Parameters
Screen name
Name of the screen that contains the PLC code view.
Note
Screen change to a pop-up screen or a slide-in screen is not supported.
Screen object
Object name of the PLC code view.
1.1.3 ActivatePreviousScreen (Panels, Comfort Panels, RT Advanced)
Description
Performs a screen change to the screen which was activated before the current screen. The
screen change is not performed if no screen was activated beforehand.
The last 10 screens that were called up are saved. A system alarm is output when you change
to a screen which is no longer saved.
Note
If you want to use the system function, the screen to which you change has to be used in the
navigation structure.

VB scripting

ActivatePreviousScreen

ActivatePreviousScreen
Parameter
--
1.1.4 ActivateScreen (Panels, Comfort Panels, RT Advanced)
Description
Performs a screen change to the given screen.
Use the "ActivateScreenByNumber" system function to change from the root screen to the
permanent area or vice versa.

ActivateScreen (Screen name, Object number)

ActivateScreen Screen_name, Object_number
Parameters
Screen name
Name of the screen to which you change.
Object number
The operator control element which receives the focus in the given screen after the screen
change. The number of the operator control element is to be determined using the tabulator
sequence during configuration.

VB scripting
When "0" is specified:

● If the focus is in the permanent area when the system function is called up, the permanent
area maintains the focus.
● If the focus is in the root screen when the system function is called up, the first operator
control element in the given screen receives the focus.
Note
If the "Reach margin" event is assigned to the "ActivateScreen" system function, only the
value "0" is valid for the "Object number" parameter. The active object is not defined by the
object number, but rather by the X position it had prior to the screen change.
Example
The following program code activates "Screen_2" with the ActivateScreen function, for
example, when you click a button.
Sub ActivateScreen_2()
'User-defined code
'' i. e. when pressing a button
ActivateScreen "Screen_2",0
1.1.5 ActivateScreenByNumber (Panels, Comfort Panels, RT Advanced)
Description
Performs a screen change to a screen depending on a tag value.
The screen is identified by its screen number.

ActivateScreenByNumber (Screen number, Object number)

ActivateScreenByNumber Screen_number, Object_number

VB scripting
Parameter
Screen number
Tag which contains the screen number of the destination screen.
When a change from the root screen to the permanent area is desired, specify "0" or "-1":
0 = Change from root screen to permanent area.
-1 = Change from permanent area to root screen
Object number
The number of the screen object which receives the focus in the given screen after the screen
1.1.6 ActivateSystemDiagnosticsView (Panels, Comfort Panels, RT Advanced)
Description
Activates the system diagnostics view. The system diagnostics view shows the detail view of
the device concerned.

ActivateSystemDiagnosticsView (Screen name, Screen object)

ActivateSystemDiagnosticsView Screen_name, Object_name
Parameters
Screen name
Name of the screen contained in the system diagnostics view.
Screen object
Object name of the system diagnostics view.

VB scripting
1.1.7 ArchiveLogFile (Panels, Comfort Panels, RT Advanced)
Description
This system function moves or copies a log to another storage location for long-term logging.
Prior to "ArchiveLogFile", always run the "CloseAllLogs" system function.
After this system function has been completed, run the "OpenAllLogs" system function.
In "Copy log" mode, the logs are not reopened until the log has been successfully copied or if
a timeout occurs during the copy.
In "Move log" mode, the logs to be moved are renamed and the new logs are opened
immediately. To move the renamed logs, a job is submitted which attempts to move them every
300 seconds if the target directory cannot be accessed. The job is also retained after Runtime
is restarted until it is executed. Therefore, before you move a log, you should check whether
the target directory is accessible.
With Audit Trails, always use the "Move" (hmiMove) mode, otherwise you will be violating the
FDA guideline by duplicating the data stored.

ArchiveLogFile (Log type, Log, Directory name, Mode)

ArchiveLogFile Log_type, Log, Directory_name, Mode
Parameters
Log type
Determines the type of log:
0 (hmiTagArchive) = Tag log
1 (hmiAlarmArchive) = Alarm log
2 (hmiAudittrailArchive)= Audit trail log available for GMP compliant projects. Additional
information is available under "Activating GMP-compliant configuration".
Log
Name of the log being archived.
Directory name
Path for saving the log.
Mode
0 (hmiCopy) = Copy log

VB scripting
1 (hmiMove) = Move log
Application example
You want to move a log file from a local storage medium to the server in order to generate a
backup copy of this file at cyclic intervals.
Notes on configuring
Set up a task in the scheduler which is executed at a specific time on a daily basis. Configure
the following function list for the task:
Procedure on HMI device

● All log files will be closed.
● The log file you specified is moved to the server.
● All closed log files will be opened again.
1.1.8 Back up RAM file system (Panels, Comfort Panels, RT Advanced)
Description
Backs up the RAM file system in the memory medium of the HMI device.
After restarting the HMI device, the data is automatically reloaded in the RAM file system.
Applications such as the Internet Explorer save data (e.g. the last web sites called up)
temporarily to the DRAM file system of the HMI device.

VB scripting

BackupRAMFileSystem

BackupRAMFileSystem
Parameter
--
1.1.9 CalibrateTouchScreen (Panels, Comfort Panels, RT Advanced)
Description
Calls a program for calibrating the touch screen.
During the calibration process, there is a prompt to touch five positions on the screen display.
Touch the screen display within 30 seconds, to confirm the calibration process. If the calibration
is not completed within this time span, the calibration settings are discarded. The user prompt
is in English.
Use this system function the first time you start the HMI device.
Note
The direct keys are reset by the system function.

CalibrateTouchScreen

CalibrateTouchScreen

VB scripting
Parameter
--
Note
The CalibrateTouchScreen system function cannot be simulated.
1.1.10 ChangeConnection (Panels, Comfort Panels, RT Advanced)
Description
Disconnects the connection to the PLC currently in use and establishes a connection to a PLC
with another address. The newly connected PLC must belong to the same device class
(S7-300, S7-400, etc).
Note
When changing to another address, ensure that the address is not already being used by
another HMI device.
The follows address types are supported:

● IP address
● MPI address
The follows PLC types are supported:
● SIMATIC S7 300/400
● SIMATIC S7 200
● SIMATIC S7 1200 (device version up to V11)
● SIMATIC S7 LOGO!
● SIMATIC S7-NC
● SIMOTION

ChangeConnection (Connection, Address, Slot, Rack)

ChangeConnection Connection, Address, Slot, Rack

VB scripting
Parameters
Connection
Name of the connection that is disconnected. The name is set during configuration, for
example, in the "Connections" editor.
Address
MPI/PROFIBUS or IP address of the PLC to which the connection will be established.
Note
Set the address by means of a tag. The objects list displays the tags of all data types. Select
only tags of the following data types:
● Ethernet connection: "String" data type
● MPI connection: "Int" data type
Slot
Slot of the PLC to which the connection will be established.
Rack
Rack of the PLC to which the connection will be established.
Application example
You want to operate one HMI device on several machines. Configure a controller in the project.
When changing the PLC, the connection to the PLC in use is disconnected. Then the
connection to the new PLC with other address parameters is reestablished. All tags in this
connection are now updated from the new controller.
The PLC which you have indicated when creating the project will be used as default.
1. Enter the name and address of the PLC in the "Connections" editor.
2. Configure a button in the process screen.
3. Configure the "ChangeConnection" system function on the "Press" event.
4. Enter the name of the connection and address of the PLC as parameters.
1.1.11 ChangeConnectionEIP (Panels, Comfort Panels, RT Advanced)
Description
Terminates the connection to the Allan Bradley controller currently in use and establishes a
connection to another Allan Bradley controller in Runtime. "EIP" stands for "Ethernet/IP".
The newly connected controller must belong to the same device class (Allen Bradley).

VB scripting
For the connection to be established, the CPU type of the controller to be connected must
match the CPU type of the controller already connected, for example, both controllers have
the CPU type "SLC/Micrologix PLC".
Note
When changing to another address, ensure that the address is not already being used by
another HMI device.
The follows address types are supported:

● IP address

ChangeConnectionEIP (Connection, Address, Communication path)

ChangeConnectionEIP Connection, Address, Communication_path
Parameters
Connection
Name of the connection that is disconnected. The name is set during configuration, for
example, in the "Connections" editor.
Address
IP address of the controller to which the connection is being established.
Note
Set the address by means of a tag. The objects list displays the tags of all data types. Select
only tags of the following data type "String".
Note
The stored IP address must consist of 4 decimal numbers with the value range 0 to 255.
Communication path
CIP path from the Ethernet module to the controller to which the connection is being
established.
You specify the communication path either with a String tag or an HMI tag of the "String" data
type.

VB scripting
Application example
You want to operate one HMI device on several machines. To do so, you configure a PLC in
the project. When changing the PLC, the connection to the PLC in use is disconnected. Then
the connection to the new PLC with other address parameters is reestablished. All tags of this
connection are now updated from the new PLC.
1. Enter the name and address of the PLC in the "Connections" editor.
2. Configure a button in the process screen.
3. Configure the "ChangeConnectionEIP" system function on the "Press" event.
4. Enter the name of the connection and address of the PLC as parameters.
1.1.12 ClearAlarmBuffer (Panels, Comfort Panels, RT Advanced)
Description
Deletes alarms from the alarm buffer on the HMI device.
Note
Alarms which have not yet been acknowledged are also deleted.

ClearAlarmBuffer (Alarm class number)

ClearAlarmBuffer Alarm_class_number
Parameter
Alarm class number

Determines which alarms are to be deleted from the alarm buffer:
0 (hmiAll) = All alarms
1 (hmiAlarms) = Alarms of alarm class "Error"
2 (hmiEvents) = Alarms of alarm class "Warning"
3 (hmiSystem) = Alarms of alarm class "System event"

VB scripting
4 (hmiS7Diagnosis) = Alarms of alarm class "S7 diagnostic alarm"
Note
Device dependency
Alarms of alarm class "Diagnosis Events" are not available on Basic Panels.
1.1.13 ClearAlarmBufferProtool (Panels, Comfort Panels, RT Advanced)
Description
The system function exists to ensure compatibility.
It has the same functionality as the "ClearAlarmBuffer" system function, but uses the old
ProTool numbering.

ClearAlarmBufferProTool (Alarm class number)

ClearAlarmBufferProtoolLegacy Alarm_class_number
Parameter
Alarm class number

Alarm class number whose messages are to be deleted:
-1 (hmiAllProtoolLegacy) = All alarms
0 (hmiAlarmsProtoolLegacy) = Alarms of alarm class "Errors"
1 (hmiEventsProtoolLegacy) = Alarms of alarm class "Warnings"
2 (hmiSystemProtoolLegacy) = Alarms of alarm class "System"
3 (hmiS7DiagnosisProtoolLegacy) = Alarms of alarm class "Diagnosis Events"
Note
Device dependency
Alarms of alarm class "Diagnosis Events" are not available on Basic Panels.

VB scripting
1.1.14 ClearDataRecord (Panels, Comfort Panels, RT Advanced)
Description
Deletes a recipe data record.
Several data records can be deleted from one or more recipes.

ClearDataRecord (Recipe number/name, Data record number/name, Confirmation, Output
status message, Processing status)

ClearDataRecord
Parameters
Recipe number/name
Number or name of the recipe from which recipe data records are deleted. "0" is specified if
you want to delete recipe data records from all available recipes.
Data record number/name

Number or name of the recipe data record to be deleted. "0" is specified if you want to delete
all recipe data records.
Confirmation
Determines whether the operator should confirm the deletion:
0 (hmiOff) = Off: Deletion is begun without confirmation.
1 (hmiOn) = On: The starting of the deletion process must be confirmed.
Output status message

Determines whether a status message is output after the deletion:
0 (hmiOff) = Off: Status message is not output.
1 (hmiOn) = On: Status message is output.
Processing status
Returns the processing status of the system function. You can use the return value, for
example, to delay execution of other system functions until this system function has been
successfully completed:
2 = System function is being performed.
4 = System function was successfully completed.

VB scripting
12 = System function was not performed because an error has occurred.
1.1.15 ClearDataRecordMemory (Panels, Comfort Panels, RT Advanced)
Description
Deletes all recipes data records from the specified storage medium.

ClearDataRecordMemory (Storage location, After confirmation, Output status message,
Processing status)

ClearDataRecordMemory Storage_location, Confirmation, Output_status_message,
Processing_status
Parameters
Storage location
Determines the storage location:
0 (hmiFlashMemory) = Flash memory: Internal flash memory of the HMI device
1 (hmiStorageCard) = Storage card
2 (hmiStorageCard2) = Storage card
3 (hmiStorageCard3) = Storage card MultiMediaCard
4 (hmiStorageCard4) = Storage card
With confirmation
Determines whether the operator should confirm the deletion:
0 (hmiOff) = Off: Deletion is begun without confirmation.
1 (hmiOn) = On: The starting of the deletion process must be confirmed.

Determines whether a status message is output after the deletion:

VB scripting
Processing status
1.1.16 ClearLog (Panels, Comfort Panels, RT Advanced)
Description
Deletes all data records in the given log.

ClearLog (Log type, Log)

ClearLog Log_type, Log
Parameter
Log type
2 (hmiAudittrailArchive) = Audit trail log. Available for GMP-compliant projects Additional
information is available under "Activating GMP-compliant configuration".
Log
Name of the log from which all entries are deleted.

VB scripting
1.1.17 CloseAllLogs (Panels, Comfort Panels, RT Advanced)
Description
Disconnects the connection between WinCC and all logs.

CloseAllLogs

CloseAllLogs
Parameter
--
Application example
You are in runtime and want to change the data medium on which the process values are
logged.
Configure the "CloseAllLogs" system function on the "Close Archive" button.
Configure the "OpenAllLogs" and "StartLogging" system functions on the "Open Archive"
button.
As parameter transfer the respective name of the log that is to be stopped and started.
When you press the "Close Archive" button, the opened logs are closed. The data medium
can be changed. The logging continues during the change of the data medium. The process
values to be logged are cached. You open all logs with the "Open Archive" button. The logging
process will continue in the specified log. The buffered process values are later added to the
log.
1.1.18 ControlSmartServer (Panels, Comfort Panels, RT Advanced)
Description
Starts or stops the Sm@rtServer.

VB scripting

ControlSmartServer (Mode)

ControlSmartServer Mode
Parameter
Mode
Specifies whether the Sm@rtServer is started or stopped.
-1 (hmiToggle) = Toggle: Toggles between the two modes
0 (hmiStop) = Stop: Sm@rtServer is stopped
1 (hmiStart) = Start: Sm@rtServer is started
1.1.19 ControlWebServer (Panels, Comfort Panels, RT Advanced)
Description
Starts or stops the Web server.

ControlWebServer (Mode)

ControlWebServer Mode
Parameter
Mode
Specifies whether the Web server is started or stopped.
0 (hmiStop) = Stop: The Web server is stopped.
1 (hmiStart) = Start: The Web server is started.

VB scripting
1.1.20 CopyLog (Panels, Comfort Panels, RT Advanced)
Description
Copies the contents of a log to another log. Tag values can only be copied to other data logs
and alarms only to other alarm logs, however.
Note
If you copy a log using the "CopyLog" system function, it is possible that external applications
will be unable to read certain country-specific special characters in the logged message text
of the log copy. This does not apply to WinCC Runtime. WinCC Runtime can read the copied
log files without errors.
Note
80% of the log entries are copied when copying the circular logs. 20% of entries are not copied
because the space is reserved for buffer overflow by default.

CopyLog (Log type, Destination log, Source log, Mode, Delete source log)

CopyLog Log_type, Destination log, Source_log, Mode, Delete_source_log
Parameter
Log type
Destination log
Name of the log into which the entries are copied (Destination log).
Source log
Name of the log from which the entries are copied (Source log).
Mode
Determines what is done with copied entries in the destination log:
0 (hmiOverwrite) = Overwrite: Existing entries are overwritten.

VB scripting
2 (hmiAppend) = Append: The entries are inserted at the end of the destination log. When the
configured size of the log has been reached, the destination log is treated like a circular log.
Delete source log

Determines whether the source log is deleted after copying.
0 (hmiNo) = No: Is not deleted.
1 (hmiYes) = Yes: Is deleted.
1.1.21 DecreaseTag (Panels, Comfort Panels, RT Advanced)
Description
Subtracts the given value from the tag value.
X=X-a
Note
The system function uses the same tag as input and output values. When this system function
is used to convert a value, auxiliary tags must be used. The auxiliary tags are assigned to the
tag value with the "SetTag" system function.
If you configure the system function on the events of an alarm and the tag is not being used
in the current screen, it is not ensured that the actual value of the tags is being used in the
PLC. You can improve the situation by setting the "Cyclic continuous" acquisition mode.

DecreaseTag (Tag, Value)

DecreaseTag Tag, Value
Parameter
Tag
The tag from which the given value is subtracted.
Value
The value which is subtracted.

VB scripting
1.1.22 EditAlarm (Panels, Comfort Panels, RT Advanced)
Description
Triggers the "Edit" event for the selected alarm or for the last selected alarm in case of multiple
selection. If the alarms to be edited have not yet been acknowledged, they are acknowledged
automatically when this system function is called.

EditAlarm

EditAlarm
Parameters
--
1.1.23 Encode (Panels, Comfort Panels, RT Advanced)
Description
Adapts the "String" data type of a tag for transfer to the automation system (AS). The tag of
WinCC data type "String" is converted into the AS data type "Array of byte". The result is written
to a tag.

Encode (Byte array, String, Coding)

Encode Byte_array, String, Encoding

VB scripting
Parameter
Byte array
The tag that contains the converted value.
Note
The Byte array must be twice the size of the string length + 2. The Byte array must contain
242 array elements if the string has a length of 120 characters.
Characters are either truncated or not converted if the size is insufficient.
String
The tag of data type "String" that is converted.
Encode
0 (hmiEncodeUTF16LE) - String is encoded in UTF16LE (Unicode 16 Little Endian).
1.1.24 EncodeEx (Panels, Comfort Panels, RT Advanced)
Description
Adapts the "String" data type of a tag for transfer to the automation system (AS). The tag of
WinCC data type "String" is converted into the AS data type "Array of byte". The result is written
to a tag.
By contrast to the Encode system function, you can define the Line break parameter. Using
the Line break parameter you can delete line breaks or replace these with predefined
characters.

EncodeEx (Byte-Array, String, Encoding, Line break)

EncodeEx Byte_array, String, Encoding, Line_break

VB scripting
Parameter
Byte array
The tag that contains the converted value.
Note
The byte array must be twice the size of the string length +2. If the string has a length of 120
characters, the byte array must contain 242 array elements.
Characters are either truncated or not converted if the size is insufficient.
String
The tag of data type "String" that is converted.
Encoding
0 (hmiEncodeUTF16LE) - String is encoded in UTF16LE (Unicode 16 Little Endian).
Line break
All line breaks are either deleted or replaced with predefined characters. Do not replace line
breaks if set as the default value.
0 (replace with "\r\n' (0x000D, 0x000A)) - the line break is replaced with "\r\n".
1 (replace with "\n' (0x000A)) - the line break is replaced with "\n".
2 (do not replace) - the line break is not replaced.
3 (remove line breaks) - the line breaks are removed.
1.1.25 ExportDataRecords (Panels, Comfort Panels, RT Advanced)
Description
Exports one or all data records of a recipe to a CSV file or a TXT file.
One file is created per recipe.

ExportDataRecords (Recipe number/name, Data record number/name, File name, Overwrite,
Output status message, Processing status)

ExportDataRecords Recipe_number/name, Data_record number/name, File_name,
Overwrite, Output_status_message, Processing_status

VB scripting
Parameters
Recipe number/name
Number or name of the recipe from which the data records are exported. Specify "0" if recipe
data records are to be exported from all available recipes.

Number or name of the recipe data record to be exported. Specify "0" if all recipe data records
are to be exported.
File name
Name of the file to which the recipe data records are exported. Enter the name, including the
storage location and the file extension (*.csv or *.txt), for example "C:\TEMP\Orange.csv". If a
folder does not exist, it is created during the export.
If you do not enter the file name fully, the response depends on the number of configured
recipes:
● If multiple recipes are configured and
you only specify one file name and no path, the file is saved in a system directory, for
example, "C:\Documents and Settings\[User]".
When only a path and no file name is specified, the file name is automatically created from
the recipe name. It is a requirement that the folder "D:\Data\", for example, has been created
in the specified folder. If the "D:\Data" folder has not been created, the folder name will be
used as the prefix for the file name, for example, "Data_Recipe name.csv".
● If only one recipe is configured and only one path and no file name is specified,
a file with the folder name is created if the folder does not exist. However, this has no file
extension.
the export is aborted with an error message if the folder exists.
If a memory card is used as storage location, specify the storage location as follows:
"\StorageCard\<Name>".
For Basic Panel, enter the file name as follows: "\USB_X60.1\<Name>".
Overwrite
Determines whether an existing export file with the same name is overwritten:
0 (hmiOverwriteForbidden) = No: Export file will not be overwritten. The export process will not
be carried out.
1 (hmiOverwriteAlways) = Yes: Export is overwritten without a prompt for confirmation.
2 (hmiOverwriteWithPrompting) = With confirmation: Export file is not overwritten until
confirmed.

Determines whether a status message is output after the export:

VB scripting
Processing status
Export format of the recipe data records

If ".csv" is chosen as a file extension for the export file, then only valid characters from the
ANSI character set will be supported. This also applies to separators in decimal numbers and
list elements. The separators used are defined in the country/regional settings of the operating
system of the exporting computer.
You may also set "Unicode text" (".txt") format for the export file. This file format supports the
WinCC and WinCC Runtime character set. Again, the separators used are specified in the
country/regional settings of the operating system of the exporting computer. This file format
always uses tab separators in list elements.
The corresponding file import function also supports the ".csv" and ".txt" (Unicode) file
formats.
Application example
You want to export all data records using a key.
Configure the "ExportDataRecords" system function on the "Press" event for the desired key.
Transfer the following parameters:
● Recipe number/name = 1
● Data record number/name = 0
● File name = c:\temp\orange.csv (for Basic Panels "\USB_X60.1\orange.csv")
● Overwrite = 1
● Output status message = 1
Tags can also be specified in place of the constants. Depending on the configuration, the
operator can enter the desired values in the I/O field or read from the PLC. In this way, the
operator can determine which recipe data records are exported.
As soon as the key is activated, the system function is triggered. The constants or tags are
evaluated. All data records of Recipe 1 are exported to the orange.csv file. If the file already
exists, it will be overwritten.
After exporting the data records, a system alarm is output.

VB scripting
1.1.26 ExportDataRecordsWithChecksum (Panels, Comfort Panels, RT Advanced)
Description
Exports one or all data records of a recipe to a CSV file and generates a checksum for each
line in the file.
One file is created per recipe.

ExportDataRecordsWithChecksum (Recipe number/name, Data record number/name, File
name, Overwrite, Output status message, Processing status)

ExportDataRecordsWithChecksum Recipe_number_or_name, Data_record
number_or_name, File_name, Overwrite, Output_status_message, Processing_status
Parameter
Recipe number/name
Number or name of the recipe from which the data records are exported. Specify "0" if recipe
data records are to be exported from all available recipes.

Number or name of the recipe data record to be exported. Specify "0" if all recipe data records
are to be exported.
File name
Name of the CSV file to which the recipe data records are exported. Enter the path and the
file extension e.g. "C:\TEMP\Orange.CSV".
If a storage card is used as storage location, specify the storage location as follows:
"\StorageCard\<FileName>".
If you define only a file name without specifying a path, the file is saved to the directory from
which Runtime was started. If write access to this directory is not enabled in the Windows 7
operating system, the file is saved to the "VirtualStore" folder of the user directory.
When only one path for the export is specified, the file name is automatically created from the
respective recipe name. This requires, for example, that the directory "D:\Temp\" has been
created. If the directory "D:\Temp" does not exist, the directory name is used as the prefix for
the file name, Temp_Recipe names.csv.
Overwrite
Determines whether an existing CSV file with the same name is overwritten:

VB scripting
0 (hmiOverwriteForbidden) = No: CSV file will not be overwritten. The export process will not
be carried out.
1 (hmiOverwriteAlways) = Yes: CSV file is overwritten without a prompt for confirmation.
2 (hmiOverwriteWithConfirmation) = With confirmation: CSV file is not overwritten until
confirmed.

Determines whether a status message is output after the export:
Processing status
Export format of the recipe data records

If ".csv" is chosen as a file extension for the export file, then only valid characters from the
ANSI character set will be supported. This also applies to separators in decimal numbers and
list elements. The separators used are defined in the country/regional settings of the operating
system of the exporting computer.
You may also set "Unicode text" (".txt") format for the export file. This file format supports the
WinCC and WinCC Runtime character set. Again, the separators used are specified in the
country/regional settings of the operating system of the exporting computer. This file format
always uses tab separators in list elements.
The corresponding file import function also supports the ".csv" and ".txt" (Unicode) file formats.
Application example
Using a key, you want to export all data records and assign a checksum.
Configure the "ExportDataRecordsWithChecksum" system function on the "Press" event for
the desired key. Transfer the following parameters:
● Recipe number/name = 1
● Data record number/name = 0
● File name = c:\temp\orange.csv
● Overwrite = 1
● Output status message = 1

VB scripting
operator can determine which recipe data records are exported.
evaluated. All data records of Recipe 1 are exported to the orange.csv file and assigned
checksums. If the file already exists, it will be overwritten.
After exporting the data records, a system message is output.
1.1.27 ExportImportUserAdministration (Panels, Comfort Panels, RT Advanced)
Description
Exports all users of the user administration of the currently active project to the given file or
imports the users from the given file into the currently active project.
Users, their passwords and rights are saved in the user administration.
All users are overwritten when importing. The imported users are valid immediately.
Note
Exporting and importing of the user administration from V14 is not supported on HMI devices
with a Runtime version older than V14.

ExportImportUserAdministration (File name, Direction)

ExportImportUserAdministration File_name, Direction
Parameter
File name
Name of the file which contains the passwords or to which the passwords are written. Enter
the file location and the file extension (*.txt), for example, "C:\TEMP\Passwords.txt".
Note
If a storage card is used as file location, specify the file location as follows: "\StorageCard
\<FileName".

VB scripting
Direction
Specifies whether passwords are exported or imported:
0 (hmiExport) = Export: Passwords are exported.
1 (hmiImport) = Import: Passwords are imported.
1.1.28 GetBrightness (Panels, Comfort Panels, RT Advanced)
Description
Reads the value of the brightness.

GetBrightness (Brightness)

GetBrightness Brightness
Parameter
Brightness
The tag to which the value is written.
1.1.29 GetDataRecordFromPLC (Panels, Comfort Panels, RT Advanced)
Description
Transfers the selected recipe data record from the PLC to the storage medium of the HMI
device.

GetDataRecordFromPLC (Recipe number/name, Data record number/name, Overwrite,
Output status message, Processing status)

VB scripting

GetDataRecordFromPLC Recipe_number_or_name, Data_record_number_or_name,
Overwrite, Output_status_message, Processing_status
Parameter
Recipe number/name
Number or name of the recipe from which recipe data records are transferred.

Number or name of the recipe data record which is transferred from the PLC to the data medium
of the HMI device.
Overwrite
Determines whether an existing recipe data record with the same name is overwritten:
0 (hmiOverwriteForbidden) = No: Recipe data record is not overwritten. The transfer process
will not be carried out.
1 (hmiOverwriteAlways) = Yes: Recipe data record is overwritten without prompting.
2 (hmiOverwriteWithPrompting) = With confirmation: Recipe data record is not overwritten until
confirmed.

Determines whether a status message is output after the transfer:
Processing status
Application example
You want to transfer a data record from the PLC to the data medium of the HMI device using
a key.
Configure the "GetDataRecordFromPLC" system function on the "Press" event for the desired
key. Transfer the following parameters:

VB scripting
Recipe number/name = 1
Data record number/name = 1
Overwrite = 1
Output status message = 1
operator can determine which recipe data record is transferred from the PLC.
evaluated and the first data record of Recipe 1 is transferred from the PLC to the data medium
of the HMI device. If the recipe data record already exists, it will be overwritten.
A system message is output after the transfer.
1.1.30 GetDataRecordName (Panels, Comfort Panels, RT Advanced)
Description
Writes the name of the given recipe and recipe data record to the given tags.
Note
If the recipe or the recipe data record do not exist, wildcards ("###") are written to the tags.
Note
Only internal tags or external tags are supported as tags.

GetDataRecordName (Recipe number, Data record number, Recipe name, Data record name,
Processing status)

GetDataRecordName Recipe_number, Data_record_number, Recipe_name,
Data_record_name, Processing_status
Parameter
Recipe number
Number of the recipe whose name is written to the given tag.

VB scripting
Data record number

Number of the recipe data record whose name is written to the given tag.
Recipe name
The tag to which the recipe name is written. The tag must be of the STRING type.
Data record name

The tag to which the name of the recipe data record is written. The tag must be of the STRING
type.
Processing status
Application example
You want to output the names of the displayed recipes and the name of the displayed recipe
data record on the HMI device.
Configure the following tags:
● RecNumber" of type INTEGER
● RecDataNumber" of type INTEGER
● RecName" of type STRING
● RecDataName" of type STRING
Configure a recipe view with the tags "RecNumber" for the recipe number and
"RecDataNumber" for the data record number.
Configure the "GetDataRecordName" system function on the "Press" event for a button and
pass the following parameters:
● Recipe number: RecNumber
● Data record number: RecDataNumber
● Recipe name: RecName
● Data record name: RecDataName
Configure two output fields and connect these to the "RecName" and "RecDataName" tags.
Select a recipe and a data record number from the recipe view. As soon as the button is
activated, the system function is triggered and the name of the recipe and the recipe data
record are displayed in both output fields.

VB scripting
1.1.31 GetDataRecordTagsFromPLC (Panels, Comfort Panels, RT Advanced)
Description
Transfers the values of the recipe data record loaded in the PLC to the corresponding recipe
tags.
This system function is used, for example, during teach-in mode on a machine.

GetDataRecordTagsFromPLC (Recipe number/name, Processing status)

GetDataRecordTagsFromPLC Recipe_number_or_name, Processing_status
Parameter
Recipe number/name
Number or name of the recipe data record whose values are written from the PLC to the tags.
Processing status
1.1.32 GetGroupNumber (Panels, Comfort Panels, RT Advanced)
Description
Reads the number of the group to which the user logged on to the HMI device belongs, and
writes it to the given tag.

GetGroupNumber (Tag)

VB scripting

GetGroupNumber Tag
Parameter
Tag
The tag to which the number of the group is written.
1.1.33 GetPassword (Panels, Comfort Panels, RT Advanced)
Description
Writes the password of the user currently logged on to the HMI device in the given tag.
Note
Make sure that the value of the given tag is not displayed in another place in the project.
Note
The passwords of SIMATIC Logon users cannot be read.
Note
The "GetPassword" system function is not available for devices as of device version 14.0.0.0.
If this system feature is used in a project older than version V14, it is removed after migration
to V14. The event linked to the system function is thereby invalidated. The "GetPassword"
system function appears to be faulty in the configuration. A warning is generated during
compiling. The "GetPassword" system function is no longer included in the compiled Runtime
project.

GetPassword (Tag)

GetPassword Tag

VB scripting
Parameter
Tag
The tag to which the password is written.
1.1.34 GetUserName (Panels, Comfort Panels, RT Advanced)
Description
Writes the user name of the user currently logged on to the HMI device in the given tag.
If the given tag has a control connection, the user name is also available in the PLC connection.
This system function makes it possible, for example, to implement a user-dependent release
of certain functionalities.

GetUserName (Tag)

GetUserName Tag
Parameter
Tag
The tag to which the user name is written.
1.1.35 GoToEnd (Panels, Comfort Panels, RT Advanced)
Description
Executes the key function <End> on the HMI device.
This system function is used when the HMI device does not have this functionality by default.
The system function can only be used for the following function keys.

GoToEnd

VB scripting

GoToEnd
Parameter
--
1.1.36 GoToHome (Panels, Comfort Panels, RT Advanced)
Description
Executes the key function <Home> on the HMI device.
This system function is used when the HMI device does not have this functionality by default.
The system function can only be used for the following function keys.

GoToHome

GoToHome
Parameter
--
1.1.37 ImportDataRecords (Panels, Comfort Panels, RT Advanced)
Description
Imports one or all data records of a recipe from a CSV file or a TXT file.
When a path is specified, all records of the given directory are imported.

VB scripting

ImportDataRecords (File name, Data record number/name, Overwrite, Output status
message, Processing status)

ImportDataRecords File_name, Data_record_number_or_name, Overwrite,
Output_status_message, Processing_status
Parameters
File name
Name of the file from which the recipe data records are imported. Enter the storage location
and the file extension (*.CSV or *.TXT), for example "C:\TEMP\Orange.csv".
For Basic Panel, enter the file name as follows: "\USB_X60.1\<Name>"
For additional devices: If a memory card is used as storage location, specify the storage
location as follows: "\StorageCard\<Name>"

Number or name of the recipe data record to be imported. Specify "0" if all recipe data records
are to be imported.
Overwrite
Determines whether existing recipe data records are to be overwritten:
0 (hmiOverwriteForbidden) = No: Recipe data records are not overwritten. The import process
1 (hmiOverwriteAlways) = Yes: Recipe data records are overwritten without prompting.
2 (hmiOverwriteWithPrompting) = With confirmation: Recipe data records are not overwritten
until confirmed.

Determines whether a status message is output after the import:
Processing status

VB scripting
Configurable objects
Object Event
Tag Value change
Upper limit exceeded
Lower limit violated
Function key (global) Release
Press
Function key (local) Release
Press
Screen Loaded
Cleared
Screen object Press
Release
Click
Change (or toggle for switch)
Switch on
Switch off
Enable
Disable
Scheduler Time expired
1.1.38 ImportDataRecordsWithChecksum (Panels, Comfort Panels, RT Advanced)
Description
Imports one or all data records of a recipe from a CSV file with a checksum and verifies the
checksum.

ImportDataRecordsWithChecksum (File name, Data record number/name, Overwrite, Output
status message, Processing status, verify checksum)

ImportDataRecordsWithChecksum File_name, Data_record_number_or_name, Overwrite,
Output_status_message, Processing_status, Verify_checksum

VB scripting
Parameter
File name
Name of the CSV file from which the recipe data records are imported. Enter the path and the
file extension, for example, "C:\TEMP\Orange.CSV".
If a storage card is used as storage medium, specify the storage location as follows:
"\StorageCard\<FileName>".
If you specify a directory instead of an individual CSV file, all files in the specified directory will
be imported.

Number or name of the recipe data record to be imported. Specify "0" if all recipe data records
are to be imported.
Overwrite
Determines whether existing recipe data records are to be overwritten:
0 (hmiOverwriteForbidden) = No: Recipe data records are not overwritten. The import process
1 (hmiOverwriteAlways) = Yes: Recipe data records are overwritten without prompting.
2 (hmiOverwriteWithConfirmation) = With confirmation: Recipe data records are not
overwritten until confirmed.

Determines whether a status message is output after the import:
Processing status
Returns the processing status of the system function. You can use the return value, for example
to delay execution of other system functions, until this system function has been successfully
completed.
Verify checksum
Determines if the checksum should be verified during import:
0 (hmiFalse) = No: Checksum is not verified.
1 (hmiTrue) = Yes: Checksum is verified.

VB scripting
1.1.39 IncreaseTag (Panels, Comfort Panels, RT Advanced)
Description
Adds the given value to the value of the tags.
X=X+a
Note
is used to convert a value, help tags must be used. You can use the "SetTag" system function
to assign the tag value to the auxiliary tags.
If you configure the system function on the events of an alarm and the tag is not being used
in the current screen, it is not ensured that the actual value of the tags is being used in the
PLC. You can improve the situation by setting the "Cyclic continuous" acquisition mode.

IncreaseTag (Tag, Value)

IncreaseTag Tag, Value
Parameter
Tag
The tag to which the given value is added.
Value
The value that is added.
1.1.40 InverseLinearScaling (Panels, Comfort Panels, RT Advanced)
Description
Assigns a value to the tag X, which is calculated from the value of the given tag Y using the
linear function X = (Y - b) / a.

VB scripting
The tags X and Y must not be identical. This system function is the inverse of the
"LinearScaling" system function.
Note
The tags X and Y must not be identical. If a tag is to be converted into itself, a auxiliary tag
must be used.
The "SetTag" system function can be used to assign the value of the tags to be converted to
the auxiliary tags.

InvertLinearScaling (X, Y, b, a)

InverseLinearScaling X, Y, b, a
Parameters
X
The tag which is assigned the value calculated from the linear equation.
Y
The tag that contains the value used for calculation.
b
a
The value through which is divided.

VB scripting
Example
The following program code assigns a value to the varX tag by means of the
InverseLinearScaling function.
{
BYTE varX;
BYTE Yvalue = 10;
BYTE bvalue = 3;
BYTE avalue = 4;
//Inverse linear scaling

InverseLinearScaling (varX, Yvalue, bvalue, avalue);
printf ("varX = %d\r\n, varX);

...
}
The saved return value can be processed in the following code.
1.1.41 InvertBit (Panels, Comfort Panels, RT Advanced)
Description
Inverts the value of the given tag of the "Bool" type:
● If the tag has the value of 1 (TRUE), it will be set to 0 (FALSE).
● If the tag has the value of 0 (FALSE), it will be set to 1 (TRUE).

InvertBit (Tag)

InvertBit Tag
Parameters
Tag
The tag whose bit is set.

VB scripting
Example
The following program code inverts the value of the Boolean tag bStatus and outputs the result
along with the original bSaved value.
'Programming language: VB
Dim myTag
Dim myOutputField
Dim bValue, bSaved, strResult
Set myTag = SmartTags("bStatus")

Set myOutputField=HMIRuntime.Screens("MyScreen").ScreenItems("objTextField")
'Get current value

bValue=myTag.Value
'Save current value

bSaved=bValue
'Invert Bit
InvertBit myTag
bValue=myTag.Value
'Output result old and new value:

strResult="Old Value: "&bSaved &Chr(13)&"New Value: "&bValue
myOutputField.Text=strResult
//Programming language: C
{
BOOL bStatus = 0;
BOOL bSaved = bStatus;
//Invert variable
invertBit(bStatus);
//print current and saved value

printf ("Current value: %d\r\n, Saved value: %d\r\n",bStatus, bSaved);
...
}
1.1.42 InvertBitInTag (Panels, Comfort Panels, RT Advanced)
Description
Inverts a bit in the given tag:
● If the bit in the tag has the value of 1 (TRUE), it will be set to 0 (FALSE).
● If the bit in the tag has the value of 0 (FALSE), it will be set to 1 (TRUE).

VB scripting
After changing the given bit, the system function transfers the entire tag back to the PLC. It is
not checked whether other bits in the tags have changed in the meantime. Operator and PLC
have read-only access to the indicated tag until it is transferred back to the PLC.
Note
If the PLC supports BOOL tags, do not use this system function. Use the "InvertBit" system
function instead.

InvertBitInTag (Tag, Bit)

InvertBitInTag Tag, Bit
Parameters
Tag
The tag in which the given bit is set.
Bit
The number of the bit that is set.
When this system function is used in a user-defined function, the bits in a tag are counted from
right to left. The counting begins with 0.

VB scripting
Example
The following program code inverts a bit at the specified bitposition in the bStatusWord tag
and outputs the result along with the original bSaved value.
Dim myTag
Dim myOutputField
Dim bValue, bSaved, bitposition, strResult
Set myTag = SmartTags("bStatusWord")

'Get current value

bValue=myTag.Value
'Save current value

bSaved=bValue
'Invert Bit in position

bitposition=2
InvertBit myTag, bitposition
bValue=myTag.Value

{
BYTE bStatusWord;
BYTE bsaved = bStatusWord;
BYTE bitposition = 2;
//Invert bit in bitposition

InvertBitInTag (bStatusWord, bitposition);
printf ("Current value: %d\r\n, Saved value: %d\r\n",bStatusWord, bsaved);
...
}
1.1.43 LinearScaling (Panels, Comfort Panels, RT Advanced)
Description
Assigns a value to the tag Y, which is calculated from the value of the given tag X using the
linear function Y= (a *X) + b.

VB scripting
The inverse of this function is the "InvertLinearScaling" system function.
Note
must be used.
the auxiliary tags.

LinearScaling (Y, a, X, b)

LinearScaling Y, a, X, b
Parameters
Y
a
The value with which is multiplied.
X
b

VB scripting
Example
The following program code uses the LinearScaling function to assign a value to the Yvar tag.
{
BYTE Yvar;
BYTE Xvalue = 10;
BYTE bvalue = 3;
BYTE avalue = 4;
// linear scaling
LinearScaling ( Yvar, avalue, Xvalue, bvalue);
printf ("Yvar = %d\r\n, Yvar);

...
}
1.1.44 LoadDataRecord (Panels, Comfort Panels, RT Advanced)
Description
Loads the given recipe data record from the memory medium of the HMI device in the recipe
tags. This system function is used, for example, to display a recipe data record in the recipe
screen.
Activate the "Synchronize recipe view and recipe tags" option in the synchronization settings
of the recipe. If this option is deactivated, the system function has no effect.

LoadDataRecord (Recipe number/name, Data record number/name, Processing status)

LoadDataRecord Recipe_number_or_name, Data_record_number_or_name, Confirmation,
Parameter
Recipe number/name
Number or name of the recipe from which a recipe data record is loaded.

Number or name of the recipe data record to be loaded.

VB scripting
Processing status
1.1.45 LogOff (Panels, Comfort Panels, RT Advanced)
Description
Logs off the current user on the HMI device.

Logoff

Logoff
Parameter
--
1.1.46 Logon (Panels, Comfort Panels, RT Advanced)
Description
Logs on the current user on the HMI device.

Logon (Password, User name)

Logon Password, User_name

VB scripting
Parameter
Password
The tag from which the password for the user logging on is read. If the user is logged on, the
password in the tag is deleted.
User name
The tag from which the user name for the user logging on is read.
1.1.47 LookupText (Panels, Comfort Panels, RT Advanced)
Description
Identifies an entry from a text list. The result depends on the value and on the selected runtime
language. The result is saved to a tag of data type "String".

LookupText (Output text, Index, Language, Text list)

LookupText Output_text, Index, Language, Text_list
Parameters
Output text
The tag to which the result is written.
Index
The tag that defines the value of the list entry.

VB scripting
Language
Defines the runtime language in which the list entry is identified.
● Runtime language
Language code as per VBScript reference, for example, "de-DE" for German (Germany)
or "en-US" for English (United States of America). The selection depends on the activated
runtime languages.
● Tag
The tag that contains the language. Enter the runtime language as decimal value of the
country ID, for example, 1031 for German - Standard, 1033 for English - USA. Details are
available in the VBScript basics, "Locale identifier (LCID) diagram".
● Integer
The number that corresponds to the order of runtime languages for language switching.
The selection depends on the activated runtime languages, for example, "0" for the
language that appears when you first start runtime. You can find more information under
the topic of "Languages in Runtime".
Text list
Defines the text list. The list entry is read from the text list.
1.1.48 NotifyUserAction (Panels, Comfort Panels, RT Advanced)
Description
This system function is used to log user actions that are not automatically logged in the Audit
Trail. You can also use this system function to require the user to enter an acknowledgment
or an electronic signature and a comment for the operator action. A requirement for the use
of the system function is that the GMP-compliant configuration is activated under "Runtime
settings > GMP".
If you use the "NotifyUserAction" system function in a function, the debugger may open if you
cancel your input by clicking "Cancel". To compensate for this reaction, you can use the "On
Error Resume Next" statement in a function. With this instruction, the next instruction is
executed after a runtime error. If you use the "On Error Resume Next" statement, output of
system events is also suppressed.

NotifyUserAction (Confirmation type, Mandatory commenting, Category, Object name,
Description)

NotifyUserAction Confirmation_type, Mandatory_commenting, Category, Object_name,
Description

VB scripting
Parameter
Confirmation type
Establishes how the action must be confirmed
0 = (None): No confirmation required, an entry is created in the Audit Trail
1 = (Acknowledgement): Acknowledgment, the user must acknowledge the action; an entry is
created in the Audit Trail
2 = (Digital Signature): Electronic signature; a dialog window opens in which the user must
enter the electronic signature - an entry is created in the Audit Trail
Mandatory commenting
Establishes if the user has to enter a comment. The comment is logged in the Audit Trail.
0 = (True): True; a dialog window opens in which the user must enter a comment
1 = (False): False; no comment required
Category
Category or class name of the modified object
Object name
Name of the modified object
Description
Text which describes the archiving user action.
1.1.49 OpenAllLogs (Panels, Comfort Panels, RT Advanced)
Description
Reestablishes the connection between WinCC and the logs. Logging can be continued.
Note
Run the "StartLogging" system function in order to restart logging.

OpenAllLogs

VB scripting

OpenAllLogs
Parameter
--
Application example
logged.
Configure the "StopLogging" and "CloseAllLogs" system functions on the "Close Archive"
button.
button.
When the button "Close Archive" is pressed, the specified log is stopped and all open logs are
closed. The data medium can be changed. You open all logs with the "Open Archive" button.
Logging will be continued in the specified log.
1.1.50 OpenCommandPrompt (Panels, Comfort Panels, RT Advanced)
Description
Opens a Windows system prompt.
This function is used, e.g., to copy files or to call up another application.

OpenCommandPrompt

OpenCommandPrompt

VB scripting
Parameter
--
1.1.51 OpenControlPanel (Panels, Comfort Panels, RT Advanced)
Description
Opens a dialog that you can use to edit selected Control Panel settings.
This system function lets you set the following on the HMI device:
● Properties and value of the IP address
● User identification on the network
● WinCC Internet settings
Note
Project security
The "OpenControlPanelDialog" system function is used to bypass the SecureMode on the HMI
device. Take the corresponding precautions to ensure the security of your project.

OpenControlPanelDialog (Dialog)

-
Parameters
Dialog
Sets the Control Panel dialog to be opened.
● PROFINET_X1: Setting of the IP address and Ethernet parameters
● PROFINET_X3: Setting of the IP address and Ethernet parameters; only for Comfort Panel
KP 1500, TP 1500; TP1900, TP2200
● WinCC Internet settings: Setting for Web Server, e-mail notification, provided the HMI
device supports these functions
● Network ID: Setting for identification on the network, provided the HMI device supports
these functions

VB scripting
1.1.52 OpenInternetExplorer (Panels, Comfort Panels, RT Advanced)
Description
Opens the Internet Explorer on the HMI device.
If the Internet Explorer is already open, it will be closed and reopened when you call the system
function.
Note
The Internet Explorer saves data temporarily in the DRAM file system of the HMI device, e.g.
the last web sites that were be called up.
This data can be saved using the "BackupRAMFileSystem" system function so that it is still
available when the HMI device is restarted.

OpenInternetExplorer (Start page)

OpenInternetExplorer Start_page
Parameter
Start page
The page which is loaded when Internet Explorer is started, e.g. "www.siemens.com".
1.1.53 OpenScreenKeyboard (Panels, Comfort Panels, RT Advanced)
Description
Hides or shows the screen keyboard.
The screen keyboard remains open until the screen keyboard is explicitly closed. In this way,
the screen keyboard can also be used in other applications.

OpenScreenKeyboard (Display mode)

VB scripting

OpenScreenKeyboard Display_mode
Parameter
Display mode
Specifies whether the window is opened minimized or maximized with the screen keyboard:
0 (hmiScreenKeyboardMinimized) = Minimized
1 (hmiScreenKeyboardMaximized) = Maximized
1.1.54 OpenTaskManager (Panels, Comfort Panels, RT Advanced)
Description
Shows the task manager.
The task manager allows changing to other open applications on the HMI device.
Note
The appearance of the task manager depends on the operating system installed.

OpenTaskManager

OpenTaskManager
Can be used if the configured device supports user-defined scripts. For additional information,
refer to "Device dependency".
Parameter
--

VB scripting
1.1.55 PageDown (Panels, Comfort Panels, RT Advanced)
Description
Executes the key function <Pagedown> on the HMI device.

PageDown

PageDown
Parameter
-
1.1.56 PageUp (Panels, Comfort Panels, RT Advanced)
Description
Executes the key function <PageUp> on the HMI device.
This system function can only be used for function keys and tasks with a time trigger.

PageUp

PageUp
Parameter
-

VB scripting
1.1.57 PrintReport (Panels, Comfort Panels, RT Advanced)
Description
Prints the given report from the printer which is connected to the HMI device. The report is
printed in the language which is set on the HMI device.
Note
If runtime is closed whilst log data are being printed using the system function, the report will
cease to be supplied with data as soon as runtime stops.

PrintReport (Report)

PrintReport Report
Parameter
Report
Name of the report to be printed.
Note
If you have set up via the "Function list" dialog box a new report for the "PrintReport" function,
when compiling, the following warning appears: "The report "Report_1" has no printed pages."
In order to remedy the warning, open the "Report_1" via the project view and recompile the
project.
1.1.58 PrintScreen (Panels, Comfort Panels, RT Advanced)
Description
Prints the screen currently being displayed on the HMI device from the printer which is
connected to the HMI device.

VB scripting
Opened windows are also printed.
Note
The printer settings are taken over from the current settings in the Windows operation system.

PrintScreen

PrintScreen
Parameter
--
1.1.59 ResetBit (Panels, Comfort Panels, RT Advanced)
Description
Sets the value of a "Bool" type tag to 0 (FALSE).

ResetBit (Tag)

ResetBit Tag
Parameters
Tag
The BOOL type tag which is set to 0 (FALSE).

VB scripting
Example
The following program code sets the value of the Boolean tag bStatus to 0 by means of the
ResetBit function and outputs the result along with the original bSaved value.
Dim myTag
Dim myOutputField

'Set value
bValue=1
myTag.Value=bValue
'Save current value

bSaved=bValue
'Reset Bit
ResetBit myTag
bValue=myTag.Value

{
BOOL bStatus = 1;
//Reset bit
ResetBit (bStatus);

...
}
1.1.60 ResetBitInTag (Panels, Comfort Panels, RT Advanced)
Description
Sets a bit in the specified tag to 0 (FALSE).

VB scripting
Note
If the PLC supports BOOL tags, do not use this system function. Use the "ResetBit" system
function instead.

ResetBitInTag (Tag, Bit)

ResetBitInTag Tag, Bit
Parameters
Tag
The tag in which a bit is set to 0 (FALSE).
Bit
The number of the bit that is set to 0 (FALSE).
When this system function is used in a user-defined function, the bits in the specified tag will
be counted from right to left independent of the PLC used. The counting begins with 0.

VB scripting
Example
The following program code sets a bit to 0 at the specified bitposition in the bStatusWord tag
Dim myTag
Dim myOutputField

'Save current value

bValue=myTag.Value
bSaved=bValue
'Reset Bit
bitposition=2
ResetBitInTag myTag, bitposition
bValue=myTag.Value

{
BYTE bSaved;
bSaved = GetTagByte("bStatusWord");
//Reset bit in bitposition

ResetBitInTag ("bStatusWord", bitposition);

printf ("Current value: %d\r\n, Saved value: %d\r\n",GetTagByte("bStatusWord"), bSaved);
...
}
1.1.61 SafelyRemoveHardware (Panels, Comfort Panels)
Description
Checks whether there is read or write access to the external storage medium. If there is no
access, the external storage medium can be removed without data loss.

VB scripting

SafelyRemoveHardware(Path, Result)

SafelyRemoveHardware Path, Result
Parameters
Result
The tag in which the result is entered.
TRUE: The storage medium can be removed safely. A corresponding system alarm will be
output.
FALSE: The storage medium cannot be removed safely. A corresponding system alarm will
be output.
Path
Path of storage medium, e.g. \Storage Card USB\
1.1.62 SaveDataRecord (Panels, Comfort Panels, RT Advanced)
Description
Saves the current values of the recipe tags as data record to the memory medium of the HMI
device.
This system function is used, for example, to save a recipe data record in the recipe screen.

SaveDataRecord (Recipe number/name, Data record number/name, Overwrite, Output status

SaveDataRecord Recipe_number_or_name, Data_record_number_or_name, Overwrite,

VB scripting
Parameters
Recipe number/name
Number or name of the recipe to which a recipe data record is saved.

Number or name of the recipe data record to be saved. A new data record will be created if
no record of this name or number was found in the recipe, independent of the value at the
"Overwrite" parameter.
Overwrite
Specifies whether an existing data record is overwritten:
0 (hmiOverwriteForbidden) = No: The recipe data record is not overwritten, the data record is
not saved.
1 (hmiOverwriteAlways) = Yes: The recipe data record is overwritten without a prompt for
confirmation.
2 (hmiOverwriteWithConfirmation) = With confirmation: The recipe data record is overwritten
only with confirmation by the user.

Determines whether a status message is output after saving:
Processing status
1.1.63 SendEMail (Panels, Comfort Panels, RT Advanced)
Description
Sends an e-mail from the HMI device to the given addressee.
This system function is used, for example, when, in the case of service, the alarm is to be
passed on directly to the service technician.
Note
To send alarms as e-mails, the HMI system must have an e-mail client at its disposal.

VB scripting

SendEMail (Address, Subject, Text, Return address)

SendEMail Address, Subject, Text, Return_address
Parameter
Address
The e-mail address of the addressee.
Subject
The subject line of the e-mail.
Text
The text sent in the e-mail.
Return address
The e-mail address to which the addressee of this e-mail should send the reply.
1.1.64 SetAcousticSignal (Panels, Comfort Panels, RT Advanced)
Description
Configures the acoustic feedback of touch screen operation on the HMI device.
Note
The configuration that was set at Switch off is reestablished when restarting the HMI device.

SetAcousticSignal (Volume)

SetAcousticSignal Volume

VB scripting
Parameter
Volume
Determines whether and how loud an acoustic signal is emitted:
-1 (hmiToggle) = Toggle: Toggles the emission of the acoustic signal as follows: Muted > Quiet
> Loud.
0 (hmiMuted) = Mute: no acoustic signal
1 (hmiQuiet) = Quiet: quiet acoustic signal
2 (hmiLoud) = Loud: loud acoustic signal
1.1.65 SetAlarmReportMode (Panels, Comfort Panels, RT Advanced)
Description
Switches the automatic reporting of alarms on the printer on or off.

SetAlarmReportMode (Mode)

SetAlarmReportMode Mode
Parameter
Mode
Determines whether alarms are reported automatically on the printer:
0 (hmiDisablePrinting) = Reporting off: Alarms are not printed automatically.
1 (hmiEnablePrinting) = Reporting on: Alarms are printed automatically.
-1 (hmiToggle) = Toggle: Toggles between the two modes.
1.1.66 SetBit (Panels, Comfort Panels, RT Advanced)
Description
Sets the value of a "Bool" type tag to 1 (TRUE).

VB scripting

SetBit (Tag)

SetBit Tag
Parameters
Tag
The BOOL type tag which is set to 1 (TRUE).
Example
SetBit function and outputs the result along with the original bSaved value.
Dim myTag
Dim myOutputField

'Set value
bValue=0
myTag.Value=bValue
'Save current value

bSaved=bValue
'Set Bit
SetBit myTag
bValue=myTag.Value


VB scripting
{
BOOL bStatus = 0;
//Set bit
SetBit (bStatus);

...
}
1.1.67 SetBitInTag (Panels, Comfort Panels, RT Advanced)
Description
Sets a bit in the given tag to 1 (TRUE).
Note
If the PLC supports BOOL tags, do not use this system function. Use the "SetBit" system
function instead.

SetBitInTag (Tag, Bit)

SetBitInTag Tag, Bit
Parameters
Tag
The tag in which a bit is set to 1 (TRUE).
Bit
The number of the bit that is set to 1 (TRUE).

VB scripting
Note
The guaranteed update of the tags used with actual process values is absolutely conditional
in terms of reliable functionality. You should therefore configure the tag in an I/O field or assign
the system function to a screen object, such as a button.
If you have configured a short event such as the activation of an alarm for the system function
you can only access the actual process values by setting the tag for continuous reading.
Example
Dim myTag
Dim myOutputField

'Save current value

bValue=myTag.Value
bSaved=bValue
'Set Bit in tag

bitposition=1
SetBitInTag "bStatusWord", bitposition
bValue=myTag.Value

strResult="Old Value: "& bSaved & "New Value: " & bValue

VB scripting
{
BYTE bSaved;

SetBitInTag ("bStatusWord", bitposition);

1.1.68 SetBrightness (Panels, Comfort Panels, RT Advanced)
Description
Determines the brightness of the display.
Note
The configuration that is set in the Control Panel / Start Center will be reestablished when you
restart the HMI device.
For Basic Panels 2nd Generation, Mobile Panels and Comfort Panels:
The value for the system function "SetBrightness" can be set between 0% and 100%. The set
value is transferred to the HMI device. The brightness settings on the HMI device can be viewed
and edited in "Start Center > Settings > Display". The HMI devices support a brightness setting
between 10% and 100%.
If the system function "SetBrightness" is assigned a value of 0%, the display of the HMI device
is switched off by default in Runtime. If the operator touches the display, the display switches
to the previous brightness setting.
If the system function "SetBrightness" is assigned a value between 1% and 10% and the
operator opens the display settings in the Start Center, brightness is reset to 10%.

SetBrightness (value)

SetBrightness Value

VB scripting
Parameter
Value
New value for the brightness.
1.1.69 SetConnectionMode (Panels, Comfort Panels, RT Advanced)
Description
Connects or disconnects the given connection.
Note
A connection to the PLC cannot be established until the "Online" operating mode has been
set on the HMI device. Use the "SetDeviceMode" system function for this purpose.
If the connection is loaded in "Offline" mode, the connection is closed again each time the
mode switches to "Offline". To re-establish the connection after switching to "Online" mode,
set the connection again to "Online" mode.

SetConnectionMode (Mode, Connection)

SetConnectionMode Mode, Connection
Parameter
Mode
Specifies whether a connection to the PLC is established or disconnected. For devices with
Windows CE and for Runtime Advanced, this parameter cannot be supplied via a tag of the
data type BOOL.
0 (hmiOnline) = online: Connection is established.
1 (hmiOffline) = offline: Connection is disconnected.

VB scripting
Connection
The PLC to which the HMI device is connected. You specify the name of the PLC in the
connection editor.
Multiple use of the system function in a user-defined function

If you use the "SetConnectionMode" system function for different connections, it may be
possible that not all system functions are executed correctly. Proceed as follows to prevent
this situation:
1. Create a tag with the start value "0".
2. Configure the "SetConnectionMode" system function on the "Value change" event of the
HMI tags. If you want to disconnect three connections, for example, you must configure the
system function three times.
3. In the user-defined function, apply the "InvertBit" system function to the HMI tag.
Application example
Two typical application examples for this system function are as follows:
● Test
As long as no PLC is connected to the HMI device, no error messages will be output during
the test on the HMI device. If the HMI device is connected to a PLC, the connection to the
PLC can be established by pressing a key.
● Commissioning
Several PLCs are to be configured for a system. At first, all PLCs except one are configured
"Offline". After commissioning of the first PLC, the connection to each of the other PLCs is
established by pressing a key. In this way, the other PLCs are started up one after another.
1.1.70 SetDataRecordTagsToPLC (Panels, Comfort Panels, RT Advanced)
Description
Transfers the values of the recipe tags to the PLC. The recipe tags contain the values of the
data record which is displayed on the HMI device.

SetDataRecordTagsToPLC (Recipe number/name, Processing status)

SetDataRecordTagsToPLC Recipe_ number_or_name, Processing_status

VB scripting
Parameter
Recipe number/name
Number or name of the recipe from which recipe data record is transferred to the PLC.
Processing status
1.1.71 SetDataRecordToPLC (Panels, Comfort Panels, RT Advanced)
Description
Transfers the given recipe data record directly from the data medium of the HMI device to the
PLC with which the HMI device is connected.
Note
The values of the recipe data record don't need to be displayed on the HMI device.

SetDataRecordToPLC (Recipe number/name, Data record number/name, Output status

SetDataRecordToPLC Recipe_number_or_name, Data_record_number_or_name,
Parameter
Recipe number/name
Number or name of the recipe from which recipe data record is transferred to the PLC.

Number or name of the recipe data record to be transferred to the PLC.

VB scripting

Determines whether a status message is output after the transfer:
Processing status
1.1.72 SetDaylightSavingTime (Panels, Comfort Panels, RT Advanced)
Description
The system function "SetDaylightSavingTime" changes the setting of the HMI device from
daylight saving to standard time and vice versa.
Time settings will take place immediately following system function.
Note
The "SetDaylightSavingTime" system function does not support time zones without daylight
saving time.
Note
Windows 7
The system function "SetDaylightSavingTime" is not supported for PC-based HMI devices
under Windows 7.

SetDaylightSavingTime(DaylightSavingTime)

SetDaylightSavingTime Daylight_saving_time

VB scripting
Parameters
Daylight Saving Time

Determines whether Daylight Saving Time is set on the HMI device:
0 = Daylight Saving Time is not activated
1 = Daylight Saving Time is activated
1.1.73 SetDeviceMode (Panels, Comfort Panels, RT Advanced)
Description
Toggles the operating mode on the HMI device. The following types of operation are possible:
"Online", "Offline" and "Loading".

SetDeviceMode (Operating mode)

SetDeviceMode Operating_mode
Parameter
Operating mode
Specifies the operating mode of the HMI device. For devices with Windows CE, this parameter
cannot be supplied via tag of data type BOOL.
0 (hmiOnline) = online: The connection to the PLC is established. The configured connection
status is always set in this process. The states that were last used in Runtime are not
considered.
1 (hmiOffline) = offline: The connection to the PLC is disconnected.
2 (hmiTransfer) = Load: A project can be transferred from the configuration computer to the
HMI device.
Note
If you use a PC as an HMI device, the runtime software will be exited when you switch operating
mode after "Load".

VB scripting
1.1.74 SetDisplayMode (Panels, Comfort Panels, RT Advanced)
Description
Changes the settings of the screen in which the runtime software runs.
The runtime software runs in full-screen mode as default. The Windows task switch is disabled.

SetDisplayMode (Layout)

SetDisplayMode Display_mode
Parameter
Display mode
Determines the settings for the screen in which the runtime software runs.
1 (hmiScreenFull): Full screen: Title bar of the screen is not visible
2 (hmiScreenMaximized): Maximized
3 (hmiScreenRestore): Restore: The last used screen setting is used. This layout can only be
used when the window is displayed minimized or maximized.
4 (hmiScreenMinimized): Minimized
5 (hmiScreenAutoAdjust): Automatic: The size of the window is set so that all screen objects
in it will be visible.
6 (hmiScreenOnTop): Foreground; either the window appears in the foreground or the program
icon associated with the window flashes on the taskbar depending on the Windows setting.
The setting can be changed in the Windows configuration and applies to all Windows
applications.
1.1.75 SetLanguage (Panels, Comfort Panels, RT Advanced)
Description
Toggles the language on the HMI device. All configured text and system events are displayed
on the HMI device in the newly set language.

VB scripting

SetLanguage (Language)

SetLanguage Language
Parameter
Language
Determines which language is set on the HMI device. The following specifications are possible:
● -1 (hmiToggle) = Toggle: Changes to the next language. The sequence is determined
during configuration in the "Project languages" editor.
● Number you have defined under "Languages and fonts" in the "Runtime Settings" editor.
Changes to the language with the given number.
● Language you have defined under "Languages and fonts" in the "Runtime Settings" editor.
● Language abbreviation in accordance with the VBScript5 reference: This changes to the
language corresponding to the specified language code, e.g. "de-DE" for German
(Germany) or "en-US" for English (United States).
An overview of the language abbreviations is available in the basic information of VBScript
under the topic "Area diagram-ID (LCID) Diagram".
1.1.76 SetPLCDateTime (Panels, Comfort Panels, RT Advanced)
Description
Changes the data and the time of the linked PLC
The system function "SetPLCDateTime" can only be configured for the following PLCs:
● SIMATIC S7-1200
● SIMATIC S7-1500

SetPLCDateTime (connection, time)

-

VB scripting
Parameters
Connection
Connection of PLC and HMI device.
Time
Transfers the date and the time of the HMI device to the PLC. The PLC applies the date and
the time of the HMI device.
1.1.77 SetRecipeTags (Panels, Comfort Panels, RT Advanced)
Description
Changes the status of the recipe tags from "Online" to "Offline" and vice versa.
This system function is used, for example, when recipe data record values are fine tuned when
starting up a machine.

SetRecipeTags (Recipe number/name, Status, Output status message, Processing status)

SetRecipeTags Recipe_number_or_name, Status, Output_status_message,
Processing_status
Parameter
Recipe number/name
Number or name of the recipe in which the recipe data record is saved.
Status
Determines the status of the recipe tags:
0 (hmiOnline) = online: Value changes of the recipe tags are transferred immediately to the
PLC connected to the HMI device.
1 (hmiOffline) = offline: Value changes to the recipe tags are only transferred to the PLC
connected to the HMI device when, for example, the "SetDataRecordTagsToPLC" system
function is executed.

Determines whether a status message is output after saving:

VB scripting

Processing status
1.1.78 SetScreenKeyboardMode (Panels, Comfort Panels, RT Advanced)
Description
Enables or disables the automatic display of the screen keyboard on the HMI device.
This system function is also used to prevent the display of the screen keyboard, e.g. because
an external keyboard is connected to the HMI device.
Note
To enable the "SetScreenKeyboardMode" ("SetScreenKeyboardMode") system function on
an HMI other than a Touch Panel device, set the "Use on-screen keyboard" check box in the
"Runtime settings" dialog of the device settings.

SetScreenKeyboardMode (Mode)

SetScreenKeyboardMode Mode
Parameter
Mode
Determines whether the screen keyboard is hidden or shown:
0 (hmiOff) = Off: Screen keyboard is hidden
1 (hmiOn) = On: Screen keyboard is shown
-1 (hmiToggle) = Toggle: Toggles between the two modes.

VB scripting
1.1.79 SetTag (Panels, Comfort Panels, RT Advanced)
Description
Assigns a new value to the given tag.
Note
This system function can be used to assign strings and numbers, depending on the type of
tag.

SetTag (Tag, Value)

SetTag Tag, Value
Parameters
Tag
The tag to which the given value is assigned.
Value
The value which the given tag is assigned.
Note
The "SetTag" system function is only executed after a connection has been established.

VB scripting
Example
The following program code uses the SetTag function to set the value of the gs_tag_bit tag to
TRUE and saves the return value to the ok tag.
{
BOOL ok;
BOOL bvalue;
//Set the tag to true

ok = SetTag("gs_tag_bit", TRUE);
//error handling
if(ok)
{
// succeeded
printf ( "Function has run through.\r\n" );
bvalue = GetTagBit("gs_tag_bit");
printf ("Value of gs_tag_bit: %d\r\n", bvalue);
}
else
{
// failed
printf ( "Error - function failed." );
}
...
}
1.1.80 ShiftAndMask (Panels, Comfort Panels, RT Advanced)
Description
This system function converts the input bit pattern of the source tags into an output bit pattern
of the target tags. This involves bit shifting and masking.
Note
If the source and target tag have a different number of bits, using the system function in the
target tag can result in a violation of the value range.

ShiftAndMask (Source tag, Target tag, Bits to shift, Bits to mask)

ShiftAndMask Source_tag, Target_tag, Bits_to_shift, Bits_to_mask

VB scripting
Parameter
Source tag
The tag includes the input bit pattern. Integer-type tags, e.g. "Byte", "Char", "Int", "UInt", "Long"
and "ULong" are permitted.
Example: The actual value 72 is set at the 16-bit integer source tag: 0000000001001000.
Target tag
The output bit pattern is saved in the tag. Integer type tags, e.g. "Byte", "Char", "Int", "UInt",
"Long" and "ULong" are permitted.
Example: The shifted input bit pattern is multiplied by the bit mask, with bit-by-bit logical AND
operation: 0000000000001001. The resultant decimal value "8" is saved to the target tag.
Please note the following:
● The source and target tags have the same number of bits.
● The number of bits to shift is less than the number of bits in the source tag and target tag.
● Bits to mask does not have more bits than the source tag and the target tag.
Bits to shift
Number of bits by which the input bit pattern is shifted right. A negative value shifts the input
bit pattern to the left.
Example: "Bits to shift" has the value "+3". The input bit pattern is shifted right by three bits
when the system function is called: 0000000000001001.
Bits to the left are padded with "0". Three bits are truncated on the right. The new decimal
value is "9".
Note
The left bit is "1" in a source tag of the data type with negative signed integer. This sign bit is
padded with "0" when the bits are shifted right. The sign changes to "+".
Bits to mask
An integer serves as bit mask. The bit pattern is used to multiply the shifted input bit pattern.
Example: Integer "2478" with the bit pattern "0000100110101110".

VB scripting
You can enter the bit mask in three different ways:

● Hexadecimal: First enter the prefix "0h" or "0H", followed by an optional space for better
readability. Then group the bit pattern in blocks of four (0000)(1001)(1010)(1110) and set
each block in hexadecimal code: (0)(9)(A)(E). Only the characters 0-9, A-F, a-f are allowed:
"0h 09AE".
● Binary: First enter the prefix "0b" or "0B", followed by an optional space for better readability.
Then group the binary bit pattern into blocks of four 0000 1001 1010 1110 with spaces in
between as a check. Only the characters "0" or "1" are allowed: "0b 0000 1001 1010 1110".
● Decimal: Enter the value "2478" directly, without a prefix.
Note
If you change the device version of the target HMI device after configuration (e.g."13.1.0" to
"13.0.0" or vice versa), you must check and test the parameters of this system function.
You can use the "Char" and "Word" data types for the "Source tag" and "Target tag" parameters
as of device version 13.1.0. In the device versions before 13.1.0, these parameters must be
assigned other data types:
● Use "SInt" instead of "Char"
● Use "Int" instead of "Word"
Otherwise, there may be unwanted effects, for example incorrect or unexpected behavior of
the configured system functions.
1.1.81 ShowAlarmWindow (Panels, Comfort Panels, RT Advanced)
Description
Hides or shows the alarm window on the HMI device.

ShowAlarmWindow (Object name, Display mode)

ShowAlarmWindow Object_name, Display_mode
Parameter
Object name
Name of the alarm view which is hidden or shown.

VB scripting
Display mode
Determines whether the alarm window is hidden or shown:
0 (hmiOff) = Off: Alarm view is hidden
1 (hmiOn) = On: Alarm view is shown
1.1.82 ShowOperatorNotes (Panels, Comfort Panels, RT Advanced)
Application
Displays the tooltip configured for the selected object.
If the system function is configured on a function key, the tooltip for the screen object that
currently has the focus is displayed. If a tooltip is configured for the screen itself, you can switch
to this text by pressing <Enter> or by double-clicking on the help window.
If the system function is configured on a button, only the tooltip for the current screen is
displayed. If a tooltip is configured on the button itself, initially only the tooltip for the button is
displayed. You can press <Enter> or double-click on the help window to switch to the tooltip
for the current screen.
Note
No other screen object can be used while the help window is open. To use the screen object,
close the help window.
Closing the help window

You can close the help window in the following ways:
Using the keys:
● By pressing the <HELP> key again
● By pressing the <ESC> key
Using the touch screen:
● By pressing the button

ShowOperatorNotes (Layout)

ShowOperatorNotes Display_mode

VB scripting
Parameter
Display mode
Determines whether the configured tooltip is hidden or shown:
0 (hmiOff) = Off: Configured tooltip is hidden
1 (hmiOn) = On: Configured tooltip is shown
1.1.83 ShowPopUpScreen (Panels, Comfort Panels, RT Advanced)
Description
Opens the pop-up-screen, for example, when a button is pressed.
You can enter a constant value or assign a tag as coordinates.
If the configured pop-up screen is not visible or only partially visible, the coordinates are set
to 0.0.
Regardless of the size of the permanent area, the start position of the coordinates is always
0.0.

ShowPopupScreen (Name of the screen, X coordinate, Y coordinate, Display mode,
Animation, Animation speed)

ShowPopupScreen Screen_name, X_coordinate, Y_coordinate, Display_mode, Animation,
Animation_speed
Parameters
Name of the screen

Specifies the name of the pop-up screen that appears in Runtime when a button is pressed.
X coordinate
Position of the pop-up screen in the current screen on the X axis
Y coordinate

VB scripting
Display mode
Specifies the mode for the pop-up screen:
Switching
Off
On
Animation
Specifies the direction from which the pop-up screen is shown:
Off
Left
Top
Right
Bottom
Animation speed
Specifies the speed at which the pop-up screen is shown:
Slow
Medium
Fast
1.1.84 ShowPopupScreenSizable (Panels, Comfort Panels, RT Advanced)
Description
Opens the pop-up screen with a defined size. You can open a pop-up screen in a different
size with this system function; the scroll bars are displayed for navigating in the content of the
pop-up screen.
You can enter a constant value or assign a tag as coordinates. If the configured pop-up screen
is not visible or only partially visible, the coordinates are set to 0.0. Regardless of the size of
the permanent area, the start position of the coordinates is always 0.0.
You also define the displayed width and height of the pop-up screen, which can deviate from
the sizes of the configured pop-up screen. The scroll bars are displayed in the pop-up screen
in this case.
Note
Operation on HMI devices with keys
You scroll in pop-up screens using the keyboard shortcut <ALT>+<arrow key>.

VB scripting
Display only one scroll bar

If you specify only one of the sizes smaller than the size of the configured pop-up screen in
the parameters of the system function, the two scroll bars are displayed in the pop-up screen.
You have two options to configure only one scroll bar in the pop-up screen:
● Reduce the width/height of the configured pop-up screen by the size of the device-specific
scroll bar.
● Specify a value that corresponds to the actual size of the pop-up screen for one of the size
parameters and add the device-specific size of the scroll bar. You specify the value for the
other size as needed.
Example:
You want to open a pop-up screen with the configured size of 500 x 420 in the size 500 x
300 with a vertical scroll bar. Specify the value 534 for the width parameter which
corresponds to the actual width of the configured pop-up screen plus the size of the scroll
bar of 34. Enter the value 300 for the height. The pop-up screen is opened in the size 500
x 300 in Runtime and only the vertical scroll bar is displayed.
Device type (version V14) Width Height

HMI devices with 4" display 25 25
Comfort Panels with 19" display
Runtime Advanced
HMI devices with 12" display

ShowPopupScreenSizable (Name of the screen, X coordinate, Y coordinate, Width, Height,
Display mode, Animation, Animation speed)

ShowPopupScreenSizable Screen_name, X_coordinate, Y_coordinate, Width, Height,
Display_mode, Animation, Animation_speed
Parameters
Name of the screen

Specifies the name of the pop-up screen that appears in Runtime when a button is pressed.
X coordinate
Y coordinate

VB scripting
Width
Specifies the width of the pop-up screen. The maximum width must not exceed the screen
width of the configured HMI device.
Height
Specifies the height of the pop-up screen. The maximum height must not exceed the screen
height of the configured HMI device.
Display mode
Specifies the mode for the pop-up screen:
Switching
Off
On
Animation
Specifies the direction from which the pop-up screen is shown:
Off
Left
Top
Right
Bottom
Animation speed
Specifies the speed at which the pop-up screen is shown:
Slow
Medium
Fast
1.1.85 ShowSlideInScreen (Panels, Comfort Panels, RT Advanced)
Description
Calls the slide-in screen, for example, when operating a button.

ShowSlideinScreen (screen name, mode)

ShowSlideInScreen SlideInScreen_name, Mode

VB scripting
Parameters
Screen name
Specifies the slide-in screen that appears in Runtime when a button is pressed:
Top Slide-in screen
Bottom Slide-in screen
Left Slide-in screen
Right Slide-in screen
Mode
Specifies the mode for the slide-in screen:
Switching
Off
On
1.1.86 ShowSoftwareVersion (Panels, Comfort Panels, RT Advanced)
Description
Hides or shows the version number of the runtime software.
Use this system function if during servicing, for example, you required the version of the runtime
software used.

ShowSoftwareVersion (Display mode)

ShowSoftwareVersion Display_mode
Parameter
Display mode
Determines whether the version number is shown:

VB scripting
0 (hmiOff) = Off: Version number is not shown

1 (hmiOn) = On: Version number is shown
1.1.87 ShowSystemAlarm (Panels, Comfort Panels, RT Advanced)
Description
Displays the value of the parameter passed as a system event to the HMI device.

ShowSystemAlarm (Text/value)

ShowSystemAlarm Text_or_value
Parameter
Text/Value
The text or the value, which was output as a system alarm.
1.1.88 ShowSystemDiagnosticsWindow (Panels, Comfort Panels)
Description
Hides or shows the system diagnostic window on the HMI device. The system diagnostic view
is only available in the global screen for Comfort Panels and for WinCC Runtime Advanced.

ShowSystemDiagnosticsWindow (Screen object)

ShowSystemDiagnosticsWindow Object_name

VB scripting
Parameters
Screen object
Name of the system diagnostic window which is hidden or shown.
1.1.89 StartLogging (Panels, Comfort Panels, RT Advanced)
Description
Starts the logging of data or alarms in the specified log. The function can also be applied to
audit trails.
You can interrupt logging at runtime using the "StopLogging" system function.

StartLogging (Log type, Log)

StartLogging Log_type, Log
Parameter
Log type
2 (hmiAudittrailArchive) = Audit trail
Log
Name of the log which is started.
1.1.90 StartNextLog (Panels, Comfort Panels, RT Advanced)
Description
Stops the logging of data or alarms for the given log.
Logging is continued in the next log of the segmented circular log you configured for the
specified log.

VB scripting
If you did not configure a segmented circular log for the specified log, the system function has
no effect.

StartNextLog (Log type, Log)

StartNextLog Log_type, Log
Parameter
Log type
Log
Name of the log for which the logging is stopped and continued in the next log.
1.1.91 StartProgram (Panels, Comfort Panels, RT Advanced)
Description
Starts the specified program on the HMI device.
The runtime software continues running in the background. Alarms continue to be output and
data continues to be updated.
When the given application is exited, the screen which was active during the performance of
the system function is displayed on the HMI device.
This system function is used, for example, to edit recipe data records in MS Excel on the HMI
device.
Note
If Windows CE is installed on the HMI device, during the configuration it must be checked
whether the desired application can be started with this system function.
This system function allows all applications to be started which can be started in the "Execute"
dialog of Windows CE.
The application to be started must be installed on the HMI device.

VB scripting
Note
If an application is not executed via the "StartProgram" function on a Mobile Panel or Comfort
Panel, check the path specification of the system function. On Mobile Panels and Comfort
Panels, some applications are located in the folder "\flash\addons".

StartProgram (Program name, Program parameters, Display mode, Wait for program to end)

StartProgram Program_name, Program_parameters, Display_mode,
Wait_for_program_to_end
Parameter
Program name
Name and path of the program which is started. Upper and lower case are taken into account
in this parameter.
Note
If the path contains spaces, the program can only be started correctly if the path is specified
in inverted commas, e.g. "C:\Program Files\START\start.exe".
Program parameters
The parameters you transfer at the start of the program, for example a file that is opened after
the start of the program.
The description of the necessary parameters is found in the documentation of the program to
be started.
Display mode
Determines how the program window is displayed on the HMI device:
0 (hmiShowNormal) = Normal
1 (hmiShowMinimized) = Minimized
2 (hmiShowMaximized) = Maximized
3 (hmiShowMinimizedAndInactive) = Minimized and inactive
Wait for program to end

Determines whether there is a change back to the project after the called up program has
ended:

VB scripting
0 (hmiNo) = No: No change to project

1 (hmiYes) = Yes: Change to project
Note
The "Wait for program to end" parameter is only available for Runtime Advanced and Panels.
1.1.92 StopLogging (Panels, Comfort Panels, RT Advanced)
Description
Stops the logging of process values or alarms in the specified log. The function can also be
applied to audit trails.
The "StartLogging" system function is used to resume logging at runtime.
Note
When logging is stopped, a connection between WinCC and the log files or log database still
exists. Use the "CloseAllLogs" system function to disconnect this connection.

StopLogging (Log type, Log)

StopLogging Log_type, Log
Parameter
Log type
2 (hmiAudittrailArchive) = Audit trail
Log
Name of the log that is stopped.

VB scripting
Application example
logged.
Configure the "StopLogging" and "CloseAllLogs" system functions on the "Close Archive"
button.
button.
When the button "Close Archive" is pressed, the specified log is stopped and all open logs are
closed. The data medium can be changed. The "Open Archive" button opens all logs and
continues logging in the specified log.
1.1.93 StopRuntime (Panels, Comfort Panels, RT Advanced)
Description
Exits the runtime software and thereby the project running on the HMI device.

StopRuntime (Mode)

StopRuntime Mode
Parameters
Mode
Determines whether the operating system is shut down after exiting runtime.
0 (hmiStopRuntime) = Runtime: Operating system is not shut down
1 (hmiStopRuntimeAndOperatingSystem) = Runtime and operating system: The operating
system is shut down (not possible with WinCE)

VB scripting
Example
The following program code shuts down Runtime and the operating system.
//Stop runtime and shutdown

StopRuntime (hmiStopRuntimeAndOperationSystem);
1.1.94 TerminatePROFIsafe (Panels, Comfort Panels, RT Advanced)
Description
Disconnects the PROFIsafe connection for fail-safe operation between a KTP Mobile Panel
and the PLC.
After execution of the system function "TerminatePROFIsafe", the connector of the KTP Mobile
Panel can be removed from the PLC without the system signaling an error.

TerminatePROFIsafe

TerminatePROFIsafe
Parameters
--

VB scripting
1.2 System functions (RT Professional)
1.2.1 ActivateScreen (RT Professional)
Description


Parameters
Screen name
Object number
Note

VB scripting
Example
'User-defined code
1.2.2 ActivateScreenInScreenWindow (RT Professional)
Description
Performs a screen change to the specified screen in a specified screen window.

ActivateScreenInScreenWindow (Screen name, Screen window, New screen name)

ActivateScreenInScreenWindow Screen_name, Screen_window, New_screen_name
Can be used if the configured device supports user-defined functions. For more information,
refer to "AUTOHOTSPOT".
Parameters
Screen name
Name of the screen to be displayed in the screen window.
Screen window
Name of the screen window in which the new screen is to be displayed.
New screen name

Name of the new screen to be displayed in the screen window.

VB scripting
Example
The ActivateScreenInScreenWindow function is used in the following program code to activate
the "Screen_2" screen when you click a button.
{
// User defined code
// i.e. when pressing a button
ActivateScreenInScreenWindow (GetParentScreen(screenName),
GetParentScreenWindow(screenName), "Screen_2");
...
}
1.2.3 DecreaseTag (RT Professional)
Description
X=X-a
Note
is used to convert a value, auxiliary tags must be used. You can use the "SetTag" system
function to assign the tag value to the auxiliary tags.
If you configure the system function for events of an alarm and the tag is not being used in the
current screen, it is not ensured that the actual tag value is being used in the PLC. You can
improve the situation by setting the "Cyclic continuous" acquisition mode.


Parameters
Tag

VB scripting
Value
Example
The following program code decrements the value at the varX tag by the value at the value
tag. The value entered is saved to the old_value tag and output along with the new varX value.
{
BYTE varX;
BYTE value;
//user input
...
BYTE old_value = varX;
//Decrease tag
DecreaseTag(varX, value);
//print original value and function result

printf ("User input: %i\r\n, Result of function DecreaseTag: %i\r\n", old_value, varX);
...
}
1.2.4 ExportImportUserAdministration (RT Professional)
Description
Exports all users of the user administration of the currently active project to the given file or
imports the users from the given file into the currently active project.
Users, their passwords and rights are saved in the user administration.
All users are overwritten when importing. The imported users are valid immediately.
Note
Exporting and importing of the user administration from V14 is not supported on HMI devices
with a Runtime version older than V14.

ExportImportUserAdministration (File name, Direction)

ExportImportUserAdministration File_name, Direction

VB scripting
Parameter
File name
Name of the file which contains the passwords or to which the passwords are written. Enter
the file location and the file extension (*.txt), for example, "C:\TEMP\Passwords.txt".
Note
If a storage card is used as file location, specify the file location as follows: "\StorageCard
\<FileName".
Direction
Specifies whether passwords are exported or imported:
0 (hmiExport) = Export: Passwords are exported.
1 (hmiImport) = Import: Passwords are imported.
1.2.5 GetParentScreen (RT Professional)
Description
The function determines the name of the parent screen from a specified screen path.

GetParentScreen (screen)

GetParentScreen Screen
Parameters
Screen
The structure of the transferred "Screen" parameter must correspond to that formed by the
graphics system for screen paths:
<Screen_name>.<Screen_window_name>:<Screen_name>.<Screen_window_name>:<Scre
en_name>...

VB scripting
If you use the object list in the function list to specify the parameter, the screen name is entered
instead of the screen path.
Note
The "." character is used to distinguish between screen and screen object names. The ":"
character is used for the hierarchy structuring. Therefore, use only the "-" or "_" as a delimiter
in the name designations.
Return value
Name of the parent screen.
Principle
A "Screenwindow_1" screen window is in a "Screen_1" screen. In the screen window, the
screen becomes "Screen_2" with the "Screenwindow_2" screen window, etc.
Screen path: Screen_1.Screenwindow_1:Screen_2.Screenwindow_2:Screen_3
GetParentScreen returns:
● "Screen_2", if the system function is called in the "Screen_3" screen.
GetParentScreenwindow returns:
● "Screenwindow_2", if the system function is called in the "Screen_3" screen.
1.2.6 GetParentScreenWindow (RT Professional)
Description
The function determines the name of the parent screen window from a transferred screen path.

GetParentScreenWindow (Screen)

GetParentScreenWindow Screen

VB scripting
Parameters
Screen
The structure of the transferred "Screen" parameter must correspond to that formed by the
graphics system for screen paths:
en_name>...
If you use the object list in the function list to specify the parameter, the screen name is entered
instead of the screen path.
Note
Return value
Name of the parent screen window.
Principle
1.2.7 IncreaseTag (RT Professional)
Description

VB scripting
X=X+a
Note


Parameters
Tag
Value

VB scripting
Example
The following program code increments the value of the varX tag by the value in the value tag.
The value entered is saved to the old_value tag and output along with the new varX value.
{
BYTE varX;
BYTE value;
//user input
...
//Increase tag
IncreaseTag(varX, value);

printf ("User input: %i\r\n, Result of function IncreaseTag: %i\r\n", old_value, varX);
...
}
1.2.8 InverseLinearScaling (RT Professional)
Description
Note
must be used.
the auxiliary tags.



VB scripting
Parameters
X
Y
b
a
Example
{
BYTE varX;
BYTE Yvalue = 10;
BYTE bvalue = 3;
BYTE avalue = 4;


...
}
1.2.9 InvertBit (RT Professional)
Description

InvertBit (Tag)

VB scripting

InvertBit Tag
Parameters
Tag
Example
Dim myTag
Dim myOutputField

'Get current value

bValue=myTag.Value
'Save current value

bSaved=bValue
'Invert Bit
InvertBit(myTag)
bValue=myTag.Value

{
BOOL bStatus = 0;
//Invert variable
invertBit(bStatus);

...
}

VB scripting
1.2.10 InvertBitInTag (RT Professional)
Description
Note
function instead.


Parameters
Tag
Bit

VB scripting
Example
Dim myTag
Dim myOutputField

'Get current value

bValue=myTag.Value
'Save current value

bSaved=bValue

bitposition=2
InvertBit(myTag, bitposition)
bValue=myTag.Value

{
BYTE bStatusWord;

...
}
1.2.11 LinearScaling (RT Professional)
Description

VB scripting
Note
must be used.
the auxiliary tags.


Parameters
Y
a
X
b

VB scripting
Example
{
BYTE Yvar;
BYTE Xvalue = 10;
BYTE bvalue = 3;
BYTE avalue = 4;
// linear scaling

...
}
1.2.12 LookupText (RT Professional)
Description
Identifies an entry from a text list. The result depends on the value and on the selected runtime
language. The result is saved to a tag of data type "String".

LookupText (Output text, Index, Language, Text list)

LookupText Output_text, Index, Language, Text_list
Parameters
Output text
The tag to which the result is written.
Index
The tag that defines the value of the list entry.

VB scripting
Language
Defines the runtime language in which the list entry is identified.
● Runtime language
Language code as per VBScript reference, for example, "de-DE" for German (Germany)
or "en-US" for English (United States of America). The selection depends on the activated
runtime languages.
● Tag
The tag that contains the language. Enter the runtime language as decimal value of the
country ID, for example, 1031 for German - Standard, 1033 for English - USA. Details are
available in the VBScript basics, "Locale identifier (LCID) diagram".
● Integer
The number that corresponds to the order of runtime languages for language switching.
The selection depends on the activated runtime languages, for example, "0" for the
language that appears when you first start runtime. You can find more information under
the topic of "Languages in Runtime".
Text list
Defines the text list. The list entry is read from the text list.
1.2.13 ResetBit (RT Professional)
Description

ResetBit (Tag)

ResetBit Tag
Parameters
Tag

VB scripting
Example
Dim myTag
Dim myOutputField

'Set value
bValue=1
myTag.Value=bValue
'Save current value

bSaved=bValue
'Reset Bit
ResetBit(myTag)
bValue=myTag.Value

{
BOOL bStatus = 1;
//Reset bit
ResetBit (bStatus);

...
}
1.2.14 ResetBitInTag (RT Professional)
Description

VB scripting
Note
function instead.


Parameters
Tag
Bit

VB scripting
Example
Dim myTag
Dim myOutputField

'Save current value

bValue=myTag.Value
bSaved=bValue
'Reset Bit
bitposition=2
ResetBit(myTag, bitposition)
bValue=myTag.Value

{
BYTE bStatusWord;
BYTE bSaved = bStatusWord;

ResetBitInTag (bStatusWord, bitposition);

printf ("Current value: %d\r\n, Saved value: %d\r\n",bStatusWord, bSaved);
...
}
1.2.15 SetBit (RT Professional)
Description

SetBit (Tag)

VB scripting

SetBit Tag
Parameters
Tag
Example
Dim myTag
Dim myOutputField

'Set value
bValue=0
myTag.Value=bValue
'Save current value

bSaved=bValue
'Set Bit
SetBit(myTag)
bValue=myTag.Value


VB scripting
{
BOOL bStatus = 0;
//Set bit
SetBit (bStatus);

...
}
1.2.16 SetBitInTag (RT Professional)
Description
Note
function instead.


Parameters
Tag
Bit

VB scripting
Note
Example
Dim myTag
Dim myOutputField

'Save current value

bValue=myTag.Value
bSaved=bValue
'Set Bit in tag

bitposition=2
SetBitInTag(myTag, bitposition)
bValue=myTag.Value

{
BYTE bStatusWord;
BYTE bSaved = bStatusWord;

SetBitInTag (bStatusWord, bitposition);

printf ("Current value: %d\r\n, Saved value: %d\r\n",bStatusWord, bSaved);
...
}

VB scripting
1.2.17 SetLanguage
Description
Toggles the language on the HMI device. All configured text and system events are displayed
on the HMI device in the newly set language.

SetLanguage (Language)

SetLanguage Language
Parameter
Language
Determines which language is set on the HMI device. The following specifications are possible:
● -1 (hmiToggle) = Toggle: Changes to the next language. The sequence is determined
during configuration in the "Project languages" editor.
● Number you have defined under "Languages and fonts" in the "Runtime Settings" editor.
Changes to the language with the given number.
● Language you have defined under "Languages and fonts" in the "Runtime Settings" editor.
● Language abbreviation in accordance with the VBScript5 reference: This changes to the
language corresponding to the specified language code, e.g. "de-DE" for German
(Germany) or "en-US" for English (United States).
An overview of the language abbreviations is available in the basic information of VBScript
under the topic "Area diagram-ID (LCID) Diagram".
1.2.18 SetPropertyByConstant (RT Professional)
Description
Specifies the value of an object property as a string.

SetPropertyByConstant (Screen name, screen object, name of the property, value)

VB scripting

SetPropertyByConstant Screen_name, Screen_object, Property_name, Value
If you want to change the property of a screen, the parameter "Object" must be empty. For this
purpose, use the following syntax, for example:
SetPropertyByConstant ("<Screen name>","","<Property name>","<Value>")
Parameters
Screen name
Name of the screen that contains the object.
Screen object
Name of the object whose property is changed.
Name of the property

Name of the property that will be changed.
Value
The value assigned to the property.
Example
The SetPropertyByConstant function is used in the following program code to change an object
property: In the "Trends" screen, the "ToolbarButtonClick" property of the "Control_1" object
is set to the value 26.
'Programming language: VBS

'Name of the picture: Trends
'Name of the f(t) trend view control: Control_1
SetPropertyByConstant "Trends", "Control_1", "ToolbarButtonClick", "26"
'User defined code

...

VB scripting
{
//Name of the picture: Trends
//Name of the f(t) trend view control: Control_1
SetPropertyByConstant ("Trends", "Control_1", "ToolbarButtonClick", "26");

...
}
Example: Changing a screen property

The SetPropertyByConstant function is used in the following program code to change a screen
property: In the "Trends" screen, the "Backcolor" property is set to the value 255.

SetPropertyByConstant "Trends", "Trends", "Backcolor", "255"
'User defined code

...
{
SetPropertyByConstant ("Trends", "Trends", "Backcolor", "255");

...
}
Alternatively, use the password ZERO or a space-string instead of the second parameter
(object).
1.2.19 SetPropertyByProperty (RT Professional)
Description
Specifies the value of an object property with another object property.

VB scripting

SetPropertyByProperty (screen name, object, property name, target screen name, target
screen object, target property name)

SetPropertyByProperty Screen_name, Screen_object, Property_name,
Source_screen_name, Source_screen_object, Source_property_name
If you want to specify the property of a screen with another screen property, the parameters
"Object" and "Destination object" must be empty. For this purpose, use the following syntax,
for example:
SetPropertyByProperty ("<Screen name>","","<Property name>","<Destination_Screen
name>","","<Destination_Property name>")
Parameters
Screen name
Object
Name of the object whose property value is transferred to the target object.
Property name
Name of the property whose value is transferred to the target object.
Target screen name

Name of the screen that contains the target object.
Target screen object

Name of the target object for which a property is changed.
Target property name


VB scripting
Example
The following program code uses the SetPropertyByProperty function to set the property
"ToolbarButtonClick" of the object "Control_1" in the original screen Trend_1": on the
corresponding property in the destination screen "Trend_2".

'Name of source picture: Trend_1
'Name of target picture: Trend_2
SetPropertyByProperty "Trend_1", "Control_1", "ToolbarButtonClick", "Trend_2",

"Control_2", "ToolbarButtonClick"
'User defined code

...
{
//Name of source picture: Trend_1
//Name of target picture: Trend_2
SetPropertyByProperty ("Trend_1", "Control_1", "ToolbarButtonClick", "Trend_2",

"Control_2", "ToolbarButtonClick");

...
}
1.2.20 SetPropertyByTag (RT Professional)
Description
Specifies the value of an object property with a tag value.

SetPropertyByTag (Screen name, screen object, name of the property, tag name)

SetPropertyByTag Screen_name, Screen_object, Property_name, Tag_name

VB scripting
If you want to specify the property of a screen by means of a tag value, the "Object" parameter
must be empty. For this purpose, use the following syntax, for example:
SetPropertyByTag ("<Screen name>","","<Property name>","<Tag name>")
Parameters
Screen name
Screen object
Name of the object containing the property to be set with the tag value.

Name of the property that is set with the tag value.
Tag name
Name of the tag that contains the value of the property.
Example
The SetPropertyByTag function is used in the following program code to change an object
property: When you click on the object, the object name and the screen in which the object is
located are transferred. The CaptionText in the screen window contains the value of the
HMI_value_1 tag.

SetPropertyByTag screenName, objectName, "CaptionText", "HMI_value_1"
'User defined code

...
{
SetPropertyByTag (screenName, objectName, "CaptionText", "HMI_value_1");

...
}

VB scripting
Example

'User defined code

...
{

...
}
1.2.21 SetPropertyByTagIndirect (RT Professional)
Description
Writes the value of an indirect addressed tag to an object property. The tag transferred as
parameter contains the name of a second tag the value of which is read.

SetPropertyByTagIndirect (Screen name, screen object, name of the property, , tag name)

SetPropertyByTagIndirect Screen_name, Screen_object, Property_name, Tag_name
If you want to specify the property of a screen by means of a tag, the "Object" parameter must
be empty. For this purpose, use the following syntax, for example:
SetPropertyByTagIndirect ("<Screen name>","","<Property name>","<Tag name>")

VB scripting
Parameters
Screen name
Screen object
Name of the object whose property you want to change.

Name of the property to be changed.
Tag name
Name of the tag which, in turn, contains the name of the tag whose value is read.
Example
The SetPropertyByTagIndirect function is used in the following program code to change an
object property: .

SetPropertyByTagIndirect GetParentScreen(screenName), GetParentScreenWindow(screenName),
"ScreenName", "HMI_value_1"
'User defined code

...
{
SetPropertyByTagIndirect (GetParentScreen(screenName), GetParentScreenWindow(screenName),
"ScreenName", "HMI_value_1");

...
}

VB scripting
1.2.22 SetTag (RT Professional)
Description
Note
tag.

SetTag (Tag, Value)

SetTag Tag, Value
Parameters
Tag
Value
Note

VB scripting
Example
{
BOOL ok;
BOOL bvalue;

//error handling
if(ok)
{
// succeeded
}
else
{
// failed
}
...
}
1.2.23 SetTagByProperty (RT Professional)
Description
Specifies a tag value with the value of an object property. The change is also logged in the
alarm system.

SetTagIndirectByProperty (tag name, screen name, screen object, name of the property, with
or without operator event)

SetTagByProperty Tag_name, Screen_name, Screen_object, Property_name,
With_or_without_operator_event

VB scripting
Parameters
Tag name
Name of the tag whose value is specified by the object property.
Screen name
Screen object
Name of the object whose property supplies the tag value.

Name of the property that supplies the tag value.
With or without operator event

0 (hmiWithoutOperatorEvent) = Without operator event
1 (hmiWithOperatorEvent) = With operator event
Example
The following program code returns the value of the selected text when you click in a combo
box.
{
char* rt_value;
SetTagByProperty (rt_value, screenName, objectName, "SelectedText",

hmiWithoutOperatorEvent);
...
}
1.2.24 SetTagByTagIndirect (RT Professional)
Description
Writes the value of an indirect addressed tag to a tag. The tag transferred as parameter
contains the name of a second tag the value of which is read. The change in the alarm system
is logged via an operator input alarm.

SetTagIndirectByTagIndirect (name of the tag, tag name, with or without operator input alarm)

VB scripting

SetTagByTagIndirect Tag_name, Source_tag_name, With_or_without_operator_event
Parameters
Name of the tag

Name of the tag whose value is to be set.
Tag name
Name of a string tag which contains the name of a tag which supplies the tag value.

0 (hmiWithoutOperatorEvent) = Without operator input alarm
1 (hmiWithOperatorEvent) = With operator input alarm
Example
The following program code writes the value of the tag Tag4 to the tag Tag1.
{
SetTag ("IndirectRead", "Tag4");
SetTagByTagIndirect ("Tag1", "IndirectRead", hmiWithoutOperatorEvent);
...
}
1.2.25 SetTagIndirect (RT Professional)
Description
Writes a value to an indirect addressed tag. The tag transferred as output parameter contains
the name of a second tag the value of which is changed by the function. The change in the
alarm system is logged via an operator input alarm.

SetTagIndirect (tag name, , value, with or without operator event)

SetTagIndirect Tag_name, Value, With_or_without_operator_event

VB scripting
Parameters
Tag name
Name of a string tag which contains the name of a tag whose value is to be changed.
Value
Value which is to be written.

Example
The following program code writes the value "value" to the tag Tag3.
{
int value;
SetTag ("IndirectWrite", "Tag3");

SetTagIndirect ("IndirectWrite", "value", hmiWithoutOperatorEvent);
...
}
1.2.26 SetTagIndirectByProperty (RT Professional)
Description
Writes the value of an object property to an indirectly addressed tag. The tag transferred as
output parameter contains the name of a second tag the value of which is changed by the
function. The change in the alarm system is logged via an operator input alarm.

SetTagIndirectByProperty (Tag name, Screen name, Screen object, Name of the property,
With or without operator event)

SetTagIndirectByProperty Tag_name, Screen_name, Screen_object, Property_name,

VB scripting
Parameters
Tag name
Screen name
Screen object
Name of the object whose property supplies the value.

Name of the property which supplies the value.

0 (hmiWithoutOperatorEvent) = Without input alarm
Example
The following program code writes the value of the object property "Background color" to the
tag Tag2.
{
SetTagIndirectByProperty ("IndirectWrite", screenName, objectName, "BackColor",
...
}
1.2.27 SetTagIndirectByTagIndirect (RT Professional)
Description
Writes the value of an indirectly addressed tag to an indirectly addressed tag. The tag
transferred as output parameter contains the name of a second tag the value of which is
changed by the function. The tag transferred as parameter contains the name of a second tag
the value of which is read. The change in the alarm system is logged via an operator input
alarm.

VB scripting

SetTagIndirectByTagIndirect (Tag name, Tag name, With or without operator input alarm)

SetTagIndirectByTagIndirect Tag_name, Source_tag_name, With_or_without_operator_event
Parameters
Tag name
Tag name
Name of the indirect tag that returns the tag value.

Example
The following program code writes the value of the tag "Tag4" to the tag "Tag2".
{
SetTagIndirectByTagIndirect ("IndirectWrite", "IndirectRead");
...
}
1.2.28 SetTagWithOperatorEvent (RT Professional)
Description
Specifies the value for a tag. The change is also logged in the alarm system.

SetTagWithOperatorEvent (name of the tag, value)

VB scripting

SetTagWithOperatorEvent Tag_name, Value
Parameters
Name of the tag

Value
Value written to the tag.
Example
The following program code transfers the value from the "value" tag to the "result" tag when
you click the corresponding button.

SetTagWithOperatorEvent result, value
...
{
SetTagWithOperatorEvent ("result", "value");
...
}
1.2.29 ShowBlockInTIAPortalFromAlarm (RT Professional)
Description
Switches from the alarm view to the affected program code of the selected project in the
engineering system. Changing from the alarm view to the project in the TIA Portal enables
further analysis of the program code, for example, search for a missing contact in the interlock.
You configure this system function at a screen object, for example, a button or a button of the
toolbar in an alarm view. When you click the button, the necessary context is stored by the
system and the corresponding location is automatically displayed in the program code after
switching to the engineering system. You use the Write protection parameter to specify which
authorization is required to enable the switch to the engineering system.

VB scripting
If you have configured the system function to a button, the TIA Portal is started in the mode
that was specified with the write protection parameter. To enable different levels of security
when accessing the system function, configure the buttons with two different authorizations:
● For the first button, configure the authorization for unlimited access by setting the write
protection parameter to FALSE.
● For the second button, configure the authorization so that data cannot be changed by
setting the write protection parameter to TRUE.

ShowBlockInTiaPortalFromAlarm (write protection, offline mode, TIA Portal project path,
screen name of alarm view, name of alarm view, error tag)

ShowBlockInTIAPortalFromAlarm ReadOnly, Offline_mode, TiaPortalProject_path,
AlarmScreen_name, AlarmView_name, Error_tag
refer to "System functions for Runtime Professional".
Parameters
Write protection
Specifies whether the project is opened in read-only mode.
TRUE (default): TIA Portal is opened in read mode, the user cannot make any changes.
FALSE: TIA Portal is opened with read and right authorization.
Offline mode
Specifies whether the project is opened in offline mode.
TRUE: The TIA Portal does not go to online mode after the block is opened.
FALSE (default): Online mode is started after the block is opened.
TIA Portal project path

Path and file name of the project in the TIA Portal to which you change from the alarm view.
Screen name of the alarm view

Name of the screen that contains the alarm view.
Alarm view name

Object name of the alarm view to which you change from the TIA Portal.
Error tag
If an error occurs, information about the error is provided by the error tag.

VB scripting
1.2.30 ShowLogonDialog (RT Professional)
Description
Opens a dialog on the HMI device with which the user can log on to the HMI device.

ShowLogonDialog

ShowLogonDialog
Can be used if the configured device supports user-defined functions. Additional information
is available under "AUTOHOTSPOT".
Parameters
--
1.2.31 ShowPLCCodeViewFromAlarm (RT Professional)
Description
Switches from the alarm view with the selected ProDiag alarm or selected GRAPH alarm to
the PLC code view with the respective network. The screen that contains the PLC code view
is either opened in a root screen or in a screen window.

ShowPLCCodeViewFromAlarm (alarm screen name, alarm view name, basic screen name,
screen window name, screen name of the PLC code view, name of the PLC code view, error
tag)

ShowPLCCodeViewFromAlarm Screen_name, Alarmview_name, Screen_name,
Screen_window_name, Screen_name, PLCCodeView_name, Error_tag
refer to "System functions for Runtime Professional".

VB scripting
Parameters
Alarm screen name

Name of the screen that contains the alarm view.
Alarm view name

Object name of the alarm view from which the selected alarm is transferred.
Basic screen name

Name of the screen which includes a screen window in which the screen can be displayed.
Screen window name

Name of the screen window in which the screen with the PLC code view can be displayed.
Screen name of the PLC code view

Name of the screen that contains the PLC code view.
Name of the PLC code view

Object name of the PLC code view.
Error tag
If an error occurs, information about the error is provided by the error tag.
Error messages
The following errors can be reported back using the error tag:
KOPAPI_E_TPSF_ALGCTRL_NOTSELECTED Exactly one alarm must be selected

KOPAPI_E_TPSF_ONLYONLINELISTALLOWED Only select alarms from the alarm list of the
alarm view
KOPAPI_E_TPSF_ONALARMWRONGPRODUCERID No GRAPH/ProDiag alarm selected
KOPAPI_E_TPSF_ONALARMNOSD0JUMPFLAG It is not possible to jump over this GRAPH/
ProDiag alarm.
The jump from an alarm in the alarm view
to the PLC code view is made possible for
the following supervision alarms:
● With global supervisions, only for
interlock supervisions (Interlock)
● With local supervisions, for all basic
supervisions at input parameters
1.2.32 StopRuntime (RT Professional)
Description

VB scripting
1.3 VBScript for Windows (Panels, Comfort Panels, RT Advanced, RT Professional)

StopRuntime (Mode)

StopRuntime Mode
Parameters
Mode
Example

1.3 VBScript for Windows (Panels, Comfort Panels, RT Advanced, RT

Professional)
1.3.1 VBScript for Windows (Panels, Comfort Panels, RT Advanced, RT Professional)
VBScript
If you have worked with Visual Basic or Visual Basic for applications, then VBScript will seem
familiar to you. If you do not know Visual Basic and are getting familiar with it, then you will
learn all Visual Basic programming languages at once. The step-by-step guides from Microsoft
Press are a good introduction to programming.

VB scripting
1.4 VBScript for Windows CE (Panels, Comfort Panels)
You will find fundamental information on VBScript language elements on the Microsoft
homepage:
http://msdn.microsoft.com/en-us/library/t0aew7h6.aspx
Local ID (LCID)
An overview of all language codes can be found on the Microsoft homepage:
http://msdn.microsoft.com/en-us/goglobal/bb964664
1.4.1 VBScript for Windows CE (Panels, Comfort Panels)
VBScript for Windows CE

You can also use the full range of functions of VBScript, except the control elements for access
to files, on devices with Windows CE.
On a device with Windows CE the "File" and "FileSystem" control elements and the
CreateObject function enable access to files and to the file system.
You will find fundamental information on VBScript language elements on the Microsoft
homepage:
http://msdn.microsoft.com/en-us/library/t0aew7h6.aspx
Local ID (LCID)
An overview of all language codes can be found on the Microsoft homepage:
http://msdn.microsoft.com/en-us/goglobal/bb964664
1.4.2 CreateObject (Panels, Comfort Panels)
Function
This function generates a reference to an automation object.
Syntax
CreateObject (object)

VB scripting
Parameters
Object
A string that contains the ProgID of the object to be generated.
Return value
Outputs a reference to an automation object.
Notes
Use the CreateObject function to generate invisible ActiveX controls in Runtime. CreateObject
cannot be used to generate graphic objects such as TreeView Control or ListView Control.
The objects generated with CreateObjekt do not respond to events. To generate objects that
respond to events, use the CreateObjectWithEvents function. The following table shows the
ProgIDs for ActiveX Controls without events:
Control ProgID
Microsoft CE File control 6.0 .file
Microsoft CE FileSystem control 6.0 .filesystem
Microsoft CE ImageList control 6.0 CEimageList.imagelistctrl
Example
Dim f, fwModeAppend
Set f = CreateObject("FileCtl.File")
fwModeAppend=8
f.Open "\Storage Card\testfile.txt", fwModeAppend
f.Close
1.4.3 Control element (Panels, Comfort Panels)
Control elements for file access

The "File" and "FileSystem" control elements enable access to files and the file system on a
device with Windows CE. The control elements can only be used with the Windows CE Toolkit
for Visual Basic 6.0.
Library
FILECTLdtl

VB scripting
DLL
Mscefile.dll
File control element

The file control element supports the following properties:
● Attr
● EOF
● Loc
● LOF
● Seek
The File control element supports the following properties:
● Close (File)
● Get
● Input
● Input
● InputFields
● LineInputString
● LinePrint
● Open
● Put
● WriteFields
FileSystem control element

The FileSystem control element supports the following methods:
● Dir
● FileCopy
● FileDateTime
● FileLen
● GetAttr
● Kill
● MkDir
● MoveFile
● RmDir
● SetAttr

VB scripting
1.4.4 Properties (Panels, Comfort Panels)
1.4.4.1 Attr (Panels, Comfort Panels)
Function
This property outputs a number that identifies the file mode that was used to open the file.
Syntax
File.Attr
Parameters
File
Reference to a "File" control.
Return values
The values shown in the following table indicate the access mode. If the return value is 0, the
file is closed.
Constant Value
None 0
fsModeInput 1
fsModeOutput 2
fsModeRandom 4
fsModeAppend 8
fsModeBinary 32
Notes
"Attr" is a read-only property. Use the Open method of the "File" control to specify the file
mode.
1.4.4.2 EOF (Panels, Comfort Panels)
Function
This property outputs True when the end of a file is reached which was opened for random or
sequential input.

VB scripting
Syntax
File.EOF
Parameters
File
Notes
Use the EOF property to avoid errors that occur due to reading after the end of a file.
The EOF property outputs False until the end of the file is reached. For files which were opened
with fsModeRandom or fsModeBinary, False is output until the last executed Get statement
returns no complete data record.
For files that were opened in the fsModeBinary mode, an attempt is made to read the file with
the input function until EOF outputs True and an error is generated. If you want to read binary
data with input, use the properties LOF and LOC instead of EOF or use Get in conjunction
with EOF. For files that were opened with fsModeOutput, EOF always outputs True.
1.4.4.3 Loc (Panels, Comfort Panels)
Function
This property outputs a number that names the current read/write position.
Syntax
File.Loc
Parameters
File
Notes
For files which were opened with fsModeRandom, Loc outputs the last entry that was read or
written as number. For files which were opened in all other modes, Loc outputs the position of
the last read or written byte.

VB scripting
1.4.4.4 LOF (Panels, Comfort Panels)
Function
This property outputs the size of a file, in bytes as number.
Syntax
File.LOF
Parameters
File
Notes
The LOF property can be used in combination with the Loc property to to ensure that a read
operation does not extend beyond the end of a file.
1.4.4.5 Seek (Panels, Comfort Panels)
Function
This property sets the next position that is to be read or written in a file and outputs this.
Syntax
File.Seek [= Position]
Parameters
File
Position
Numerical address that describes the position in a file.
Notes
The Seek property writes the next file position, by contrast the Loc property describes the
current file position. The number output for Seek is always one higher than that for Loc. The
only exception to this is when a file was opened new; in this case, both Seek and Loc output
one.

VB scripting
An error is output if Seek produces a negative value or zero.
1.4.5 Methods (Panels, Comfort Panels)
1.4.5.1 Close (Panels, Comfort Panels)
Function
This method closes an open "File" control.
Syntax
File.Close
Parameters
File
Output values
None.
Notes
Use the Open method to open a file.
1.4.5.2 Dir (Panels, Comfort Panels)
Function
This method outputs the name of a file or a directory that fits in a specific pattern or contains
a specific attribute.
Syntax
FileSystem.Dir (Pathname,[Attributs])
Parameters
File
Reference to a "FileSystem" control.

VB scripting
Pathname
Optional: A character string expression that describes the file name or path.
Attributs
Optional: A numerical expression whose sum describes the file attribute. If this was omitted,
all files that are in the corresponding path are output.
The following table shows the parameter settings of the attribute.
Constant Value Description

fsAttrNormal 0 Normal
fsAttrReadOnly 1 Read-only
fsAttrHidden 2 Hidden
fsAttrSystem 4 System file
fsAttrVolume 8 Volume Label. If this was defined, all other attributes are ignor‐
ed.
fsAttrDirectory 16 Directory
fsAttrArchive 32 Log
Output values
String. A file name made up of the path name and the attributes. Dir outputs a zero length
string ("") if the path name is not found.
Notes
Dir supports the use of multi-character wildcards (*) and single-character wildcards (?) for the
description of files that exist multiple times. When used for the first time, you must specify the
path name of the Dir method. If you specify attributes, the path name must also be included.
The Dir method outputs the first file name that matches the path name. If you want to output
additional file names that match the path name, execute Dir again without parameters. If no
further matching file names can be found, Dir returns a zero-length string (""). If a zero-length
string was output, specify the path name by subsequent calling.
1.4.5.3 FileCopy (Panels, Comfort Panels)
Function
This method copies the content of a file to another file.
Syntax
FileSystem.FileCopy PathName, NewPathName

VB scripting
Parameters
FileSystem
PathName
Character string that contains the path and the file name.
NewPathName
Character string that contains the file name and the path of the new file.
Output values
None.
Notes
FileCopy outputs an error if the new file does not exist.
1.4.5.4 FileDateTime (Panels, Comfort Panels)
Function
This method outputs a Variant (date) that contains the date and the time at which the file was
created or last edited.
Syntax
FileSystem.FileDateTime(Pathname)
Parameters
Filesystem
Pathname
Character string expression that names the file name. The path name may contain a directory.
Output value
Indicates the date on which the file was last edited.
Notes
If a new file does not exist, FileDateTime outputs an error.

VB scripting
1.4.5.5 FileLen (Panels, Comfort Panels)
Function
This method outputs the value that describes the length of file in bytes.
Syntax
FileSystem.FileLen(Pathname)
Parameters
Filesystem
Pathname
Character string that describes the file name. The path name may contain a directory.
Output values
Indicates how many bytes a file consists of.
Notes
If the specified file is already open when FileLen is called, the value indicates the size of the
file before this is opened.
1.4.5.6 Get (Panels, Comfort Panels)
Function
This method reads data from an open file into a tag.
Syntax
File.Get Data, [Recnumber]
Parameters
File

VB scripting
Data
Variant tag into which the data is read.
Recnumber
Optional: Number at which reading begins. For files that were opened in binary mode,
Recnumber defines the byte position.
Output values
None.
Notes
Data that is read with the Get method is usually written to the file with the Put method. The
first data record or the first byte in a file is in position 1, the second in position 2 and so on. If
you skip Recnumber, the next data record or the next byte that follows the last Get or Put
method (or which was referred to by the Seek method) is read.
The following rules apply to files which were opened in random mode:
● If the length of the read data is shorter than the length defined in length clause of the Open
method, Get reads the following data records in the length of the data record limit. The
space between the end of a data record and the start of the next data record is filled the
content of the file buffer. Because it is not possible to precisely determine the scope of the
filled data, it is advisable that the length of the data records matches the length of the data
to be read.
● If the data is a numeric type variant, Get reads 2 bytes to determine the VarType of the
variant and then reads the data that is written to the tag. If, for example, a variant of type
VarType3 reads 6 bytes with Get, 2 bytes identify the variant as VarType 3 (long) and 4
bytes contain long data. The data record length is defined in the length clause. When the
open method is used, the data record length must be at least 2 bytes larger than the number
of bytes required to save the tag.
● The Get method can be used to read a variant array from the memory. However, it cannot
be used to read a scalar variant that contains an array. No objects can be read from the
memory with Get.
● If the variant that is to be read is type VarType 8 (string), Get reads 2 bytes and identifies
the variant as VarType 8, 2 additional bytes define the length of the string and the data of
the string is then read. The data record length of the open method defined by the length
clause must be at least 4 bytes greater than the length of the string.
● If the tag to be written is a dynamic array, Get reads the descriptor whose length is 2 plus
8 times the number of dimensions (2 + 8 * NumberOfDimensions). The data record length
of the open method defined by the length clause must be greater than or equal to the sum
of bytes required to read the array data and the array descriptor.
For files which are opened in binary mode, the length clause of the open method has no effect.
Get reads all tags jointly from the memory without filling between the files.

VB scripting
1.4.5.7 GetAttr (Panels, Comfort Panels)
Function
This method outputs a value that describes the attributes of a file or folder.
Syntax
FileSystem.GetAttr(Pfadname)
Parameters
FileSystem
Pathname
Character string that describes the file name or folder name. The path name may contain a
directory.
Output values
A numerical expression whose sum describes the attributes of a file or folder. The following
table shows the possible values.

vbNormal 0 Normal
vbReadOnly 1 Read-only
vbHidden 2 Hidden
VbSystem 4 System
VbDirectory 16 Directory
VbArchive 32 The file has changed since the last backup.
Notes
To specify the set attributes, use the And operator to execute a bitwise comparison of the
values returned by GetAttr and the values of the attribute selected by you.
1.4.5.8 Input (Panels, Comfort Panels)
Function
This method outputs a string that contains the characters from a file opened in input or binary
mode.

VB scripting
Syntax
File.Input(Number)
Parameters
File
Number
Numerical expression that defines the number of output characters.
Output values
A character string that consists of characters read from a file.
Notes
Data that is read with the Input method is generally written to the file with LinePrint or Put
methods. Use this method only for files which were opened in input or binary mode.
In contrast to the LineInputString method, the Input method outputs all read characters, for
example commas, carriage returns, line feeds, quotation marks and leading spaces.
Any attempt to read the file with the Input method before the EOF function returns "True" will
cause an error in files that were opened for binary access. To avoid this error, use the LOF
and Loc functions instead of the EOF function to read binary files with the Input method or use
Get in combination with the EOF function.
1.4.5.9 InputB (Panels, Comfort Panels)
Function
This method returns bytes from a file opened in input or binary mode.
Syntax
File.InputB(Number)
Parameters
File
Number
Each valid numerical expression that describes the number of output bytes.

VB scripting
Output values
An array that contains the bytes read out from the file.
Notes
Files that are read with the InputIB method are usually written with the LinePrint or Put methods.
Use this method only for files which were opened in Input or Binary mode.
1.4.5.10 InputFields (Panels, Comfort Panels)
Function
The method reads data from an open sequential file and outputs a one-dimensional variant
data field.
Syntax
File.InputFields(Number)
Parameters
File
Number
Number of fields which are delimited by commas and are to be read from a file.
Output values
An array that contains fields read from the file.
Notes
Data that is read with the InputFields method is usually written with WriteFields. Use this
method only in files opened in Binary or Input mode. InputFields reads standard string or
numeric data without modifications. The following table shows how InputFields reads other
input data:
Data Content of the assigned tags

Comma delimitation or empty line Empty
#NULL# Null
#TRUE# or #FALSE# True or False
#yyyy-mm-dd hh:mm:ss# The date and/or the time shown as expression
Double quotation marks ("") with input data are discarded.

VB scripting
If you reach the end of the file while you are adding a data object, the added data is deleted
and an error is displayed.
To correctly read data from a file as tags that use InputFields, use the WriteFields method
instead of the LinePrint method to write the data to the files. The use of WriteFields ensures
that each data field is exactly separated.
1.4.5.11 Kill (Panels, Comfort Panels)
Function
This method deletes files and folders from the hard disk.
Syntax
FileSystem.Kill Pathname
Parameters
FileSystem
Pathname
A character string that names one or more files that are to be deleted. The path name may
contain a folder.
Output values
None.
Notes
The Kill method supports the use of multi-character wildcards (*) and single-character
wildcards (?) to identify multiple files.
An error is output if you try to delete an open file using the Kill method.
1.4.5.12 LineInputString (Panels, Comfort Panels)
Function
This method reads a single line from an open sequential file and links it with a string tag.
Syntax
File.LineInputString

VB scripting
Parameters
File
Output values
None.
Notes
Data that is read with LineInput string is usually written to a file with Line Print.
The LineInputString method reads a file character by character until a carriage return sequence
(Chr(13)) or carriage-return/line-feed (Chr(13) + Chr(10)) is reached. Carriage return and line
feed sequences are more often skipped than appended to the character string.
1.4.5.13 LinePrint (Panels, Comfort Panels)
Function
This method writes a single line to an open sequential file.
Syntax
File.LinePrint Output
Parameters
File
Output
A character string that is written to the file.
Output values
None
Notes
Data that is written to a file with LinePrint is usually read out with LineInput string.
A carriage return sequence (Chr(13) + Chr(10)) is appended at the end of the string.

VB scripting
1.4.5.14 MkDir (Panels, Comfort Panels)
Function
This method creates a new folder.
Syntax
FileSystem.MkDir Pathname
Parameters
FileSystem
Pathname
A character string that contains the folder name.
Output values
None.
Notes
MkDir returns an error if the directory already exists.
1.4.5.15 MoveFile (Panels, Comfort Panels)
Function
The method renames an already existing file or a directory and all subdirectories.
Syntax
FileSystem.MoveFile PathName, NewPathName
Parameters
FileSystem
PathName
A character string that contains the file name.

VB scripting
NewPathName
A character string that contains the file name to be copied.
Output values
None.
1.4.5.16 Open (Panels, Comfort Panels)
Function
The method opens a file. The following file modes are available: Input (1), Output (2), Random
(4), Append (8), or Binary (32).
Syntax
File.Open Pathname, Mode, [Access], [Lock], [Reclength]
Parameters
File
Pathname
Mode
Specifies the file mode: Input (1), Output (2), Random (4), Append (8), or Binary (32).
Access
Optional: Not permitted with open file: Read, Write, or ReadWrite [default]. (1, 2, 3)
Lock
Optional: Actions on the open file that are blocked by other processes: Shared, LockRead,
LockWrite [default] and LockReadWrite. (1, 2, 3, 0).
Reclength
Optional: A number in bytes that is lower than 32,767. For files that were opened with random
access, this value corresponds to the sentence length. For sequential files, this value is the
number of buffered characters.
Output values
None.

VB scripting
Note
The reclength parameter is ignored in Binary mode. If a file was opened in Random mode, you
must define a file size that is greater than zero; otherwise, an error is output.
1.4.5.17 Put (Panels, Comfort Panels)
Function
This method writes data from a tag to a file.
Syntax
File.Put Data, [Recnumber]
Parameters
Data
A variant tag that contains data that is to be written to the file.
Recnumber
Optional. Variant (long). Data record number (random mode files) or byte number (binary mode
files) with which the write process starts.
Output values
None.
Notes
Data that is written with Put is usually read out from a file with Get.
The first data record or the first byte in a file is in position 1, the second in position 2 and so
on. If you skip Recnumber, the next data record or the next byte that follows the last Get or
Put method, or which was referred to by the Seek method, is read.

VB scripting
The following rules apply to files that were opened in random mode:
● If the length of the data to be written is shorter than the length defined in the length clause
of the Mopen method, Put writes the following data records in the length of the data record
limit. The space between the end of a data record and the start of the next data record is
filled with the content of the file buffer. Because it is not possible to precisely determine the
length of the filled data, it is advisable that the length of the data records matches the length
of the data to be written. If the length of the data to be written is longer than the length of
the Open method defined in the length clause, an error is output.
● If the tag to be written is a numerical type variant, Put first writes 2 bytes to declare the
variant as VarType and the tag is then written. If, for example, a VarType 3 variant is written,
Put writes 6 bytes, 2 bytes identify the variant as VarType 3 (long) and 4 bytes contain the
long data. The data record length of the open method defined in the length clause must be
at least 2 bytes greater than the number of bytes required to save the tag.
● The Pet method may be used to write a variant array to the memory. However, it cannot
be used to write a scalar variant that contains an array. Objects cannot be written with Put
to the hard disk.
● If the version that is to be written is type VarType 8 (string), Put writes 2 Bytes and identifies
the variant as VarType 8, 2 additional bytes define the length of the string and the data of
the string is then written. The data record length of the open method defined by the length
clause must be at least 4 bytes greater than the length of the string.
● If the tag to be written is a dynamic array, Put writes the descriptor whose length is 2 plus
8 times the number of dimensions (2 + 8 * NumberOfDimensions). The data record length
of the open method defined by the length clause must be greater than or equal to the sum
of bytes required to write the array data and the array descriptor.
For files which are opened in binary mode, the length clause of the open method has no effect.
Put writes all tags jointly from the memory with filling between the files.
1.4.5.18 RmDir (Panels, Comfort Panels)
Function
This method deletes an empty directory.
Syntax
FileSystem.RmDir Pathname
Parameters
FileSystem
PathName

VB scripting
Output values
None.
Notes
The directory must be empty in order to be deleted. A complete path must be specified.
1.4.5.19 SetAttr (Panels, Comfort Panels)
Function
This method set the attribute data of a file.
Syntax
FileSystem.SetAttr Pathname, Attributes
Parameters
FileSystem
Reference to a FileSystem Control
Pathname
Attributes
A numerical expression that contains the sum of the file attributes. The following table shows
the possible values.

vbNormal 0 Standard (default)
vbReadOnly 1 Read-only
vbHidden 2 Hidden
VbSystem 4 System file
VbArchive 32 The file has been modified since the last backup
Output values
None.
Notes
A runtime error occurs if you try to set the attributes of an open file.

VB scripting
1.4.5.20 WriteFields (Panels, Comfort Panels)
Function
This method writes data to a sequential file.
Syntax
File.WriteFields [Data]
Parameters
File
Data
Optional: Variant to be written to a file or variant array of a numerical string or a string
expression.
Output values
None.
Notes
Data that is written with WriteFields is usually read from the file with InputFiles.
If you omit data, a blank line is written to the file.
● The full stop is written as decimal delimiter for numerical data.
● Either #TRUE# or #FALSE# are output for Boolean data. The True and False keywords
are not compiled, regardless of location.
● The time data is written to the file in the universal date format. If either the date or the time
is missing or null, only the existing information is written to the file.
● If the data is empty, nothing is written to the file.
● If the data is null, #NULL# is written to the file.
The WriteFields method adds commas and quotation marks around the strings that are written
to the file. Delimiters do not have to be added to the list. WriteFields inserts a line break in the
form of a carriage-return/line-feed (Chr(13) + Chr(10))- after it has written the last character of
the data to the file.

VB scripting
1.5 VBS object model (Panels, Comfort Panels, RT Advanced, RT Professional)
1.5 VBS object model (Panels, Comfort Panels, RT Advanced, RT

Professional)
1.5.1 VBS object model (RT Professional)
VBS object model in WinCC

The following screen shows the VBS object model in WinCC:

VB scripting
$FWLYH3URMHFW
$FWLYH6FUHHQ
'DWD6HW
'DWD,WHP
+0,5XQWLPH
/RJJLQJ $ODUPORJV
'DWDORJV
$ODUPV 3URFHVVYDOXHV
$ODUP 3URFHVVYDOXH
6FUHHQV
6FUHHQ $FWLYH6FUHHQ,WHP
'DWD6HW
'DWD,WHP
/D\HUV
/D\HU
6FUHHQ,WHPV
6FUHHQ,WHP
7DJV 7DJ6HW
7DJ 7DJ
Use the WinCC object model of the graphic Runtime system to access objects and tags in
Runtime.

VB scripting
Objects
Objects and lists are provided for access to all the objects in the graphic Runtime systems:
● Display and operating objects
● Screens
● Layers
● Tags
Properties
You can specifically change the display and operating elements and tags in Runtime via the
properties of the individual objects. For example, you can enable a button with a click or trigger
a color change by changing a tag value.
Methods
Methods which are applied to individual objects can be used to read out tag values for further
processing or displaying alarms in Runtime.
1.5.2 Objects (Panels, Comfort Panels, RT Advanced)
1.5.2.1 HMIRuntime (Panels, Comfort Panels, RT Advanced)
Description
+0,5XQWLPH
6FUHHQV 6PDUW7DJV
6FUHHQ 6PDUW7DJ
Portrays the graphic runtime system.

VB scripting
The HMIRuntime object contains properties and methods which return the objects to the main
layer, e.g. returns the ActiveScreen property of a screen object.
Application
You use the "HMIRuntime" object, e.g. as follows:
● Read or set the current Runtime language ("Language" property).
● Read name of current base screen or trigger a base screen change by setting a new screen
name (property "BaseScreenName")
● Access tags (List "SmartTags")
● End runtime (Method "Stop")
● Output information on sequence tracing output (Method "Trace")
● Access the screens displayed during runtime (List "Screens")
See also
ActiveScreen (Page 496)
1.5.2.2 Screen object (list) (Panels, Comfort Panels, RT Advanced)
Description
+0,5XQWLPH
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
A list of screen objects.

VB scripting
The list contains the following two elements:

● The first. Element with the index 0 represents the permanent area.
● The second. Element with the index 1 represents the root screen.
Alternatively, the two elements can be addressed with their their names as follows:
● Permanent area: "Permanent area"
● Root screen: Name of the screen displayed in the root screen
If the named screen is not displayed, an error occurs during access.
Permanent area "Permanent area" is displayed in the Object list and in Auto complete.
Note
The alarm window and the alarm indicator are not contained in the screens list, even if they
have the focus in Runtime.
Application
Use the screen property to return the screen list. In the following example, the background
color is changed from black to green:
Use the object name as an index.
'VBS_Example_BackColor
HMIRuntime.Screens("Rootscreen").BackColor = vbGreen
Note
If you perform a screen change, the open references to the screen that is no longer available
will become invalid. As a result, it is no longer possible to work with these references.

VB scripting
1.5.2.3 Screen (Panels, Comfort Panels, RT Advanced)
Description
+0,5XQWLPH
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
Represents the process screen which is being displayed on the HMI device at the moment or
the permanent area in runtime. The screen object is returned to you as a result of accessing
the screen list.
The screen object also contains a list of all graphic objects in the screen that can be addressed
through the list "ScreenItems".
Application
You can also use the screen object to do the following:
● Read the height and width of a screen (properties "Height" and "Width").
● Change the background color (property "BackColor").
In the following example, the background color is changed from black to green:
See also
ScreenItem (Page 191)

VB scripting
1.5.2.4 ScreenItem (Panels, Comfort Panels, RT Advanced)
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Represents an object in the specified screen. The ScreenItem object is an element of the
ScreenItems list.
Application
You can use the ScreenItem object to access the properties of graphic objects within a screen,
depending on certain events.
You use the "ScreenItem" object as follows, for example:
● "Visible" property
Switch the visibility of an object on or off.
● "Height" and "Width" properties
Query the width and height of an object.
● "Top" and "Left" properties
Change the position of an object.
● "ObjectName" property
Read the name of a graphic object
● "Parent" property
Set a reference to the parent screen
Use the ScreenItems property to return an object to the screen. Use the object name as an
index.

VB scripting
Example
In the following example, the background color of the "RootScreen" circle in the "myCircle"
screen is set to green.
'VBS_Example_ScreenItems
Dim objCircle
Set objCircle = HMIRuntime.Screens("RootScreen").ScreenItems("myCircle")
objCircle.BackColor = vbGreen
Note
To save memory space in the HMI device, no object names are loaded during transfer of the
project. If you still want to transfer object names, call up the Runtime settings for the respective
HMI device in WinCC. You can change the setting under "General". The object name is
required when the object should be accessed via the object name or for debugging a project.
The "ScreenItem" object has different properties depending on its features. The following
properties are provided for every "ScreenItem" object:
● Enabled
● Height
● Left
● ObjectName
● Parent
● Top
● Type
● Visible
● Width
If a specific object type is addressed, further properties are added to the standard properties.
The additional properties are provided in the descriptions of the individual object types.

VB scripting
1.5.2.5 ScreenItems (Panels, Comfort Panels, RT Advanced)
Description
+0,5XQWLPH
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
A list of screen item objects with all screen objects of the given process screen. The list has a
parent property. This property provides a reference to the process screen in which the screen
object is located.
Application
By means of the "ScreenItems" list you are able
● To edit or output all objects within the list (that is, all objects within a screen)
● To count the objects of a screen (property "Count").
● To work on a particular object in the list (method "Item").
Use the screen items property to return an object from the process screen. Use the object
name as an index.
Dim objCircle

VB scripting
1.5.2.6 SmartTags (Panels, Comfort Panels, RT Advanced)
Description
+0,5XQWLPH
6PDUW7DJV
6PDUW7DJ
A list of SmartTag objects which represent all of the tags in WinCC Runtime.
Note
The SmartTags list has a limited range of functions. You can only use the tag names to access
a SmartTag object. Access via the index or by using "For each" instruction is not supported.
Note
In order to access a tag, which has still not been created in the project, using the SmartTags
list, no value is returned. Assignment to a non-existing tag is not executed:
Dim intVar
intVar = SmartTags("FillLevel")
"intVar" remains empty when the "FillLevel" tag has not been created.

VB scripting
Note
Current system behavior for dynamic access to elements of a user data type
When you compose the tag name of a user data type element dynamically in Runtime, the
composed tag name is not recognized under the following condition:
● Tag of the data type of the user data type is created.
● Tag is not used, e.g. at an I/O field
Example:
You have configured a user data type "Motor" with the elements "RPM" (Int), "On" (Bool) and
"Off" (Bool). In the project, you have configured the tag "Motor1" as instance of the user data
type. You want to output the values of the elements in only one I/O field in runtime. You have
configured an additional I/O field for input of the element name. The value you enter is saved
to the internal tag strElementName. With the following script you output the value of an element
in the I/O field "IOFieldOutputValue":
Dim strDynElementName, objIOFieldOutputValue
Set objIOFieldOutputValue = objscreen.ScreenItems("IOFieldOutput")
'Get element name from tag value
strDynElementName = SmartTags("strElementName").Value
'Create tag name
objIOFieldOutputValue.ProcessValue =
SmartTags("Motor1."+strDynElementName).Value
Help:
Configure a separate I/O field for each user data type element, for example, in an additional
screen. Interconnect the "process value" with the respective user data type element.
Note
Dynamizing faceplates
Use the following syntax to access a tag that is connected at a faceplate interface
("Properties"):
Smarttags("Properties\int_input1_tag")
Application
Use the SmartTags list to return a SmartTag object. Use the tag name to reference the
SmartTag object.
'VBS_Example_SmartTags
'Writes tag value to local tag and returns a user-defined text through the
operating system channel for debug alarms.
Dim strAirPressure
strAirPressure = "Current air pressure: " + CStr(SmartTags("AirPressure"))
HMIRuntime.Trace strAirPressure

VB scripting
In Runtime Advanced and Panels you address the tag directly using its name. If the tag name
corresponds to the VBS name conventions, you do not need to use the SmartTags list. Follow
the example below:
Dim strAirPressure
strAirPressure = "Current air pressure: " + CStr(AirPressure)
1.5.2.7 SmartTag (Panels, Comfort Panels, RT Advanced)
Description
+0,5XQWLPH
6PDUW7DJV
6PDUW7DJ
Represents the value of the specified process tag. The SmartTag object is an element of the
SmartTag list.
Application
The SmartTag object provides read and write access to the value of the specified process tag.
The SmartTag object does not return an object reference. Use the SmartTags list to return the
value of a process tag. Use the tag name as an index.
Note
With the "SmartTags reads values from the cache" setting, values are read from the process
image (cache) instead of directly from the controller.
The SmartTag object can also read values directly from the controller. However, you can then
expect a substantially higher communication load between the HMI device and the controller.

VB scripting
Example
Dim strAirPressure
Note
Dim intVar
Note
If you want to return the "TypeName" of a SmartTag object data type with the VBS function
"TypeName", use the following syntax:
TypeName(SmartTags("FillLevel").value)
To access the value of an array element, use "SmartTags("<Tag>[Index]")". Set the number
of the desired array element for "index", for example, "SmartTags("AirPressure[2]")".

VB scripting
1.5.3 Objects (RT Professional)
1.5.3.1 Alarm (RT Professional)
Description
+0,5XQWLPH
Alarms 3URFHVVYDOXHV
$ODUP 3URFHVVYDOXH
The alarm object is used to access the Alarms object list.
Note
The properties of the alarm object are not automatically updated when the values of the
properties change.

VB scripting
1.5.3.2 Alarms (list) (RT Professional)
Description
+0,5XQWLPH
Alarms 3URFHVVYDOXHV
$ODUP 3URFHVVYDOXH
Use the alarm object to trigger existing messages.
Usage
Using the "Alarms" list you can:
● Access a message in the list (Item method)
● Create a new alarm object (Create method)
● Read the alarm ID of the message (AlarmID attribute)
● Read the status of a message (State property)
● Read the time stamp of the message (Timestamp property)
● Generate an instance of the alarm object (Instance property)
● Read the name of the computer on which the message came (ComputerName property)
● Read or set the name of the user who triggered the message (UserName property)
● Read or set the name of the process value blocks (ProcessValues property)
● Read or set the message commentary (Comment property)
● Read or set the message server prefix (Context property)

VB scripting
Example
In the following example the alarm with the alarm number "1" configured in the "HMI alarms"
editor is activated.
'VBS360
Dim MyAlarm
Set MyAlarm = HMIRuntime.Alarms(1)
MyAlarm.State = 5 'hmiAlarmStateCome + hmiAlarmStateComment
MyAlarm.Comment = "MyComment"
MyAlarm.UserName = "Hans-Peter"
MyAlarm.ProcessValues(1) = "Process Value 1"
MyAlarm.ProcessValues(4) = "Process Value 4"
MyAlarm.Create "MyApplication"
See also
AlarmID (Page 505)
1.5.3.3 AlarmLogs (list) (RT Professional)
Description
/RJJLQJ $ODUPORJV
'DWDORJV
You can use the object to reconnect swapped-out log segments of the alarm log to Runtime
or to remove previously swapped-in log segments of the alarm log. The log segments to be
swapped in are copied to the "Common logging" folder of the WinCC project. The previously
swapped-in log segments are removed from the "Common logging" folder.
You use parameters to control the location from which log segments are to be swapped in.
You specify the time period over which the log segments are to be swapped in or removed.

VB scripting
If an error occurs during the operation with log segments, the applied method returns an error
alarm.
Usage
● "Restore" method
Previously swapped-out log segments of the alarm log are connected to Runtime.
● "Remove" method
Previously swapped-in log segments of the alarm log are removed from the Runtime project.
Example
In the following example, log segments from the alarm log are swapped in and the return value
is output as a trace.
'VBS187
HMIRuntime.Trace "Ret: " & HMIRuntime.Logging.AlarmLogs.Restore("D:
\Folder","2004-09-14","2004-09-20",-1) & vbNewLine
See also
Restore (Page 1342)
Remove (Page 1337)

VB scripting
1.5.3.4 DataItem (RT Professional)
Description
+0,5XQWLPH
'DWD6HW
'DWD,WHP
6FUHHQV 'DWD6HW
6FUHHQ 'DWD,WHP
You can use the DataItem object to access the contents of the DataSet list. Values or object
references are stored in the list as DataItem.
Access uses the name under which the value was added to the list. Single access using an
index is not recommended since the index changes during adding or deleting of values. You
can use the index to output the complete contents of the list. The output is in alphabetical order.
Note
For object references, ensure that the objects are capable of multi-threading.
Example
The example shows how the value of 'Motor1' is output as a trace.
'VBS163
HMIRuntime.Trace "motor1: " & HMIRuntime.DataSet("motor1").Value & vbNewLine

VB scripting
The following example enumerates all DataItem objects of the DataSet list. Name and value
are output as a trace.
'VBS164
Dim data
For Each data In HMIRuntime.DataSet
HMIRuntime.Trace data.Name & ": " & data.Value & vbNewLine
Next
Note
The value may not be output directly for objects.
See also
Value (Page 1171)
Name (Page 830)
1.5.3.5 DataLogs (list) (RT Professional)
Description
/RJJLQJ $ODUPORJV
'DWDORJV
You can use the object to reconnect swapped-out log segments of the data log to Runtime or
to delete previously swapped-in log segments of the data log. The log segments to be swapped
in are copied to the "Common logging" folder of the WinCC project. The previously swapped-
in log segments are removed from the "Common logging" folder.

VB scripting
You also set the type of log ("Fast data log", "Slow data log", "Fast data log and Slow data
log").
alarm.
Usage
Previously swapped out log segments of the data log are connected to Runtime.
● "Remove" method
Previously swapped-in log segments of the data log are removed from the Runtime project.
Example
In the following example, log segments from the Fast data log are swapped in and the return
value is output as a trace.
'VBS188
HMIRuntime.Trace "Ret: " & HMIRuntime.Logging.DataLogs.Restore("D:
\Folder","2004-09-14","2004-09-20",-1,1) & vbNewLine
See also
Restore (Page 1342)
Remove (Page 1337)

VB scripting
1.5.3.6 DataSet (list) (RT Professional)
Description
+0,5XQWLPH
'DWD6HW
'DWD,WHP
6FUHHQV 'DWD6HW
6FUHHQ 'DWD,WHP
Using the DataSet object, you can exchange data throughout several actions.
A DataSet object is global and defined by the screen object. You can access the data from
any VBS action.
You address the screen object according to the screen hierarchy . The DataSet object persists
as long as the screen is displayed. The global object persists over the entire runtime time
period.
Access uses the DataItem object.
Note
You cannot include objects with the types Screen, Screens, ScreenItem, ScreenItems, Tag
and TagSet in the DataSet list.
The DataSet object does not support any classes.
Application
Use the "DataSet" list as follows:
● Enumerating
Output or process all objects in the list
● "Count" property
Output the number of elements contained

VB scripting
● "Item" method
Work on a particular object in the list
● "Add" method
Add an object to the list
● "Remove" method
Remove a particular object from the list
● "RemoveAll" method
Remove all objects from the list
Access to list elements is made as follows:
HMIRuntime.DataSet("Itemname")
For a picture-specific list, access is performed as follows:
HMIRuntime.Screens("Screenname").DataSet("Itemname")
You access the DataSet object of the screen as follows:
DataSet("Itemname")
If upon access the stated name does not exist in the list, VT_Empty is returned and an
Exception is triggered.
Example
The example shows how you check with "Is Nothing" whether the "DataSet" object exists:
If HMIRuntime.DataSet("MyDataset") Is Nothing Then

HMIRuntime.Trace "Requested DataSet-object does not exist"
Else
HMIRuntime.Trace "Requested DataSet-object exsists"
End If
The example shows how a value can be entered in the list, read and removed from the list
throughout various actions.
'VBS162
HMIRuntime.DataSet.Add "motor1", 23
HMIRuntime.DataSet.Remove("motor1")
See also
RemoveAll (Page 1340)
Remove (Page 1337)

VB scripting
Item (Page 1318)

Add (Page 1257)
1.5.3.7 HMIRuntime (RT Professional)
Description
+0,5XQWLPH
$ODUPV
$ODUP
7DJV
7DJ
6FUHHQV
6FUHHQ
'DWD6HW
'DWD,WHP
/RJJLQJ
$FWLYH3URMHFW
$FWLYH6FUHHQ
The HMIRuntime object represents the graphic Runtime environment.

VB scripting
Usage
You can use the "HMIRuntime" object as follows:
● "Language" property
Read or set the current Runtime language
● "BaseScreenName" property
Read or set the name of the current root screen
● "ActiveProject" property
Read the path of the active Runtime project
● "Tags" property
Accessing tags
● "DataSet" property
Accessing tags in a list
● "Stop" method
Stop Runtime
● "Trace" method
Display messages in a diagnostics window
Example
The following command closes WinCC Runtime:
'VBS3
HMIRuntime.Stop
See also
Trace (Page 1362)
Stop (Page 1362)
Language (Page 762)
Tags (Page 1001)
Logging (Page 797)
DataSet (Page 647)
CurrentContext (Page 642)
MenuToolBarConfig (Page 803)
ActiveScreen (Page 496)
BaseScreenName (Page 547)
SmartTags (Page 956)

VB scripting
1.5.3.8 Item (RT Professional)
Description
The Item object provides a reference to the current object.
Usage
Use the Item object, for example, to address the properties of the object currently selected in
the screen.
Example
In the following example, you set the background color of the object selected in the screen to
red:
'VBS195
Item.BackColor = RGB(255,0,0)
1.5.3.9 Layer (RT Professional)
Description
6FUHHQV
6FUHHQ
/D\HUV
/D\HU
The Layer object returns the result of access to the layers list.

VB scripting
Parent object
Screen in which the screen layer is located
Usage
Depending on certain events, you can use the Layer object to obtain access to the properties
of a complete layer to hide or display a layer with operating elements according to the operator
authorization.
You can use the "Layer" object as follows:
Activate or deactivate visibility of a layer
● "Name" property
Read the name of a layer
Note
The layer property specifies the layer in which the object is located. The layer "0" is output
as layer "0".
When accessed, the layers are counted up from 1 in VBS. Therefore, address level "1" with
"Layers(2)".
Example
In the following example, Layer 1 is set to "invisible":
'VBS4
Layers(2).Visible = vbFalse
See also
Name (Page 830)

VB scripting
1.5.3.10 Layers (list) (RT Professional)
Description
6FUHHQV
6FUHHQ
/D\HUV
/D\HU
Use the layers list to access all 32 layers of the graphical Runtime system.
Parent object
Screen in which the screen layer is located
Usage
You use the "Layers" list as follows:
● "_NewEnum" property
Process all layers in the list
Count all layers contained in the list
● "Item" method
Process a layer from the list
The properties represent default properties and methods of a list and are not described in detail
in the WinCC documentation.
See also
Item (Page 1318)

VB scripting
1.5.3.11 Logging (RT Professional)
Description
+0,5XQWLPH
/RJJLQJ $ODUPORJV
'DWDORJV
You can use the object to reconnect swapped-out log segments to Runtime or to remove
previously swapped-in log segments. The log segments to be swapped in are copied to the
"Common logging" folder of the WinCC project. The previously swapped-in log segments are
removed from the "Common logging" folder.
alarm.
Usage
Previously swapped out log segments of the alarm log and the data log are connected to
Runtime.
● "Remove" method
Previously swapped-in log segments of the alarm log and data log are removed from the
Runtime project.

VB scripting
Example
In the following example, log segments from the alarm log and data log are swapped in and
the return value is output as a trace.
'VBS189
HMIRuntime.Trace "Ret: " & HMIRuntime.Logging.Restore("D:
\Folder","2004-09-14","2004-09-20",-1) & vbNewLine
See also
Restore (Page 1342)
Remove (Page 1337)
DataLogs (list) (Page 203)
AlarmLogs (list) (Page 200)
1.5.3.12 Project (RT Professional)
Description
+0,5XQWLPH
$FWLYH3URMHFW
Using the object, you can query information from the current Runtime project.
The project object is returned as the result of ActiveProject.

VB scripting
Usage
You can read the following using the "Project" object:
● The path of the current Runtime project ("Path" property)
● The name of the current Runtime project, without path or file extension ("Name" property)
Example
The following example returns name and path of the current Runtime project as a trace:
'VBS159
HMIRuntime.Trace "Name: " & HMIRuntime.ActiveProject.Name & vbNewLine
HMIRuntime.Trace "Path: " & HMIRuntime.ActiveProject.Path & vbNewLine
See also
Name (Page 830)
Path (Page 863)
1.5.3.13 Screen (RT Professional)
Description
+0,5XQWLPH
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
Represents the screen which is being displayed on the HMI device at the moment or the
permanent area in runtime. The screen object is returned as a result of accessing the screen
list.

VB scripting
The screen object also contains the following lists:

● You can address all the graphic objects in the addressed screen using the "ScreenItems"
list.
● You can address all the layers in the addressed screen using the "Layers" object.
Application
You can use the screen object for the following actions, for example:
● "Width" and "Height" properties
Reading the width and height of a screen
● "BackColor" property
Changing the background color
Example
In the following example, the background color is changed from black to green:
Parent object
Screen window in which the screen object is embedded.
If the screen object is the root screen, the parent object is not defined and set to zero.
Note
If you perform a screen change, the open references to screens that are no longer available
will become invalid. As a result, it is no longer possible to work with these references.
Example
In the following example, the width of the first screen is increased by 20 pixels in Runtime:
'VBS7
Dim objScreen
Set objScreen = HMIRuntime.Screens(1)
MsgBox "Screen width before changing: " & objScreen.Width
objScreen.Width = objScreen.Width + 20
MsgBox "Screen width after changing: " & objScreen.Width

VB scripting
Notes on Cross References

All the screens you address with the standard formulation are automatically compiled by the
CrossReference of WinCC and then listed in the screen properties.
HMIRuntime.BaseScreenName = "Screenname"
If you call screens with different formulations in the code, you make them known by the
following section of the CrossReference:
' WINCC:SCREENNAME_SECTION_START
Const ScreenNameInAction = "ScreenName"
' WINCC:SCREENNAME_SECTION_END
The section can be inserted in VBS actions as often as required.
See also
Refresh (Page 1336)
Activate (Page 1253)
ObjectSizeDeclutteringEnable (Page 840)
ObjectSizeDeclutteringMax (Page 841)
ObjectSizeDeclutteringMin (Page 841)
LayerDeclutteringEnable (Page 772)
Layers (Page 773)
DataSet (Page 647)
ExtendedZoomingEnable (Page 685)
AccessPath (Page 495)

VB scripting
1.5.3.14 ScreenItem (RT Professional)
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Represents an object in the specified screen. The ScreenItem object is an element of the
ScreenItems list.
Application
You can use the ScreenItem object to access the properties of graphic objects within a screen,
depending on certain events.
You use the "ScreenItem" object as follows, for example:
Switch the visibility of an object on or off.
● "Height" and "Width" properties
Query the width and height of an object.
● "Top" and "Left" properties
Change the position of an object.
● "ObjectName" property
Read the name of a graphic object
● "Parent" property
Set a reference to the parent screen
Use the ScreenItems property to return an object to the screen. Use the object name as an
index.

VB scripting
Example
'VBS_Example_ScreenItems
Dim objCircle
Note
To save memory space in the HMI device, no object names are loaded during transfer of the
project. If you still want to transfer object names, call up the Runtime settings for the respective
HMI device in WinCC. You can change the setting under "General". The object name is
required when the object should be accessed via the object name or for debugging a project.
The "ScreenItem" object has different properties depending on its features. The following
properties are provided for every "ScreenItem" object:
● Enabled
● Height
● Left
● ObjectName
● Parent
● Top
● Type
● Visible
● Width
If a specific object type is addressed, further properties are added to the standard properties.
The additional properties are provided in the descriptions of the individual object types.
See also
Layer (Page 767)
ScreenItems (Page 903)
Top (Page 1085)

VB scripting
1.5.3.15 ScreenItems (list) (RT Professional)
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
A list of ScreenItem objects with all screen objects of the specified screen. The list has a
"Parent" property. This "Parent" property provides a reference to the screen in which the screen
object is located.
Usage
You use the "ScreenItems" list as follows:
● To edit or output all objects within the list (that is, all objects within a screen)
Count the objects of a screen
● "Item" method
Work on a particular object in the list
Use the screen items property to return an object from the screen. Use the object name as an
index.
Example
Dim objCircle

VB scripting
Peculiarities of the ScreenItem object

If you embed an external control (ActiveX control or OLE object) in WinCC, the properties of
the embedded control may have the same names as the general properties of the ScreenItem
object. In this case, the ScreenItem properties take priority.
You can address the properties of the embedded controls, however, via the "object" property.
The "object" property is only available in ActiveX controls and OLE objects.
Example:
'Control1 is an embedded ActiveX-Control with property "type"

'VBS196
Dim Control
Set Control=ScreenItems("Control1")
Control.object.type
'Control1 is a WinCC-Control
'VBS197
Dim Control
Set Control=ScreenItems("Control1")
Control.type
Example
In the following example, you output the name of the objects in the current screen in a message
box:
Sub OnClick(ByVal Item)

'VBS6
Dim lngAnswer
Dim lngIndex
lngIndex = 1
For lngIndex = 1 To ScreenItems.Count
lngAnswer = MsgBox(ScreenItems(lngIndex).Objectname, vbOKCancel)
If vbCancel = lngAnswer Then Exit For
Next
End Sub
See also
Item (Page 1318)
ScreenItems (Page 903)
Top (Page 1085)

VB scripting
1.5.3.16 Screen object (list) (RT Professional)
Description
+0,5XQWLPH
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
Several screens can be opened simultaeously in WinCC Runtime by means of the screen
window technique, whereby there is only one main screen. The "Screens" list allows access
to all open screens in Runtime using the screen name. The screen list contains all hidden
screens.
The access key required in the VBS environment in the HMIRuntime.Screens(<access key>)
instruction must conform to the following syntax description:
[<Root screen name>.]<Screen window name>[:<Screen name>] ...

.<Screen window name>[:<Screen name>]
● The access key represents the screen hierarchy.

● You can omit the screen name at all locations in the key.
● The "AccessPath" property of the "Screen" object corresponds to the full access key.
● The root screen can be addressed via the "" access key.
Examples
The screens are addressed by specifying the hierarchy in the list. You can address the screens
with or without using the screen names. In the following example, a "BaseScreenName" root
screen is configured with a "ScreenWindow". The screen window contains a "ScreenName"
screen.

VB scripting
Addressing using the screen name
'VBS8
Set objScreen = HMIRuntime.Screens("BaseScreenName.ScreenWindow:ScreenName")
Addressing without using the screen name
'VBS9
Set objScreen = HMIRuntime.Screens("ScreenWindow")
Referencing the root screen in various ways
'VBS10
Set objScreen = HMIRuntime.Screens(1)
'VBS11
Set objScreen = HMIRuntime.Screens("")
'VBS12
Set objScreen = HMIRuntime.Screens("BaseScreenName")
See also
Screens (Page 904)

VB scripting
1.5.3.17 SmartTag (RT Professional)
Description
+0,5XQWLPH
6PDUW7DJV
6PDUW7DJ
Represents the value of the specified process tag. The SmartTag object is an element of the
SmartTag list.
Application
The SmartTag object provides read and write access to the value of the specified process tag.
The SmartTag object does not return an object reference. Use the SmartTags list to return the
value of a process tag. Use the tag name as an index.
Note
With the "SmartTags reads values from the cache" setting, values are read from the process
image (cache) instead of directly from the controller.
The SmartTag object can also read values directly from the controller. However, you can then
expect a substantially higher communication load between the HMI device and the controller.
Example
Dim strAirPressure

VB scripting
Note
Dim intVar
Note
If you want to return the "TypeName" of a SmartTag object data type with the VBS function
"TypeName", use the following syntax:
TypeName(SmartTags("FillLevel").value)
To access the value of an array element, use "SmartTags("<Tag>[Index]")". Set the number
of the desired array element for "index", for example, "SmartTags("AirPressure[2]")".
1.5.3.18 SmartTags (RT Professional)
Description
+0,5XQWLPH
6PDUW7DJV
6PDUW7DJ

VB scripting
A list of SmartTag objects which represent all of the tags in WinCC Runtime.
Note
The SmartTags list has a limited range of functions. You can only use the tag names to access
a SmartTag object. Access via the index or by using "For each" instruction is not supported.
Note
Dim intVar
Note
Current system behavior for dynamic access to elements of a user data type
When you compose the tag name of a user data type element dynamically in Runtime, the
composed tag name is not recognized under the following condition:
● Tag of the data type of the user data type is created.
● Tag is not used, e.g. at an I/O field
Example:
You have configured a user data type "Motor" with the elements "RPM" (Int), "On" (Bool) and
"Off" (Bool). In the project, you have configured the tag "Motor1" as instance of the user data
type. You want to output the values of the elements in only one I/O field in runtime. You have
configured an additional I/O field for input of the element name. The value you enter is saved
to the internal tag strElementName. With the following script you output the value of an element
in the I/O field "IOFieldOutputValue":
Dim strDynElementName, objIOFieldOutputValue
Set objIOFieldOutputValue = objscreen.ScreenItems("IOFieldOutput")
'Get element name from tag value
strDynElementName = SmartTags("strElementName").Value
'Create tag name
objIOFieldOutputValue.ProcessValue =
SmartTags("Motor1."+strDynElementName).Value
Help:
Configure a separate I/O field for each user data type element, for example, in an additional
screen. Interconnect the "process value" with the respective user data type element.

VB scripting
Note
Dynamizing faceplates
Use the following syntax to access a tag that is connected at a faceplate interface
("Properties"):
Smarttags("Properties\int_input1_tag")
Application
Use the SmartTags list to return a SmartTag object. Use the tag name to reference the
SmartTag object.
Dim strAirPressure
In Runtime Advanced and Panels you address the tag directly using its name. If the tag name
corresponds to the VBS name conventions, you do not need to use the SmartTags list. Follow
the example below:
Dim strAirPressure
strAirPressure = "Current air pressure: " + CStr(AirPressure)
See also
SmartTag (Page 223)

VB scripting
1.5.3.19 Tag (RT Professional)
Description
+0,5XQWLPH
7DJV 7DJ6HW
7DJ 7DJ
A tag object is returned via the "Tags" list. A tag object can be used to address all the properties
and methods of a tag.
When creating a tag object, all the properties are initialized with the following values:
● Value = VT_EMPTY
● Name = Tag name
● QualityCode = BAD NON-SPECIFIC
● TimeStamp = 0
● LastError = 0
● ErrorDescription = " "
Note
A summary of possible Quality Codes can be found in WinCC Information System under
key word "Communication" > "Diagnostics" or "Communication" > "Quality Codes".

VB scripting
Usage
Use the "Tag" object as follows:
● "Name", "QualityCode", "TimeStamp", "LastError" and "ErrorDescription" properties
Read information on the tag
● "Write" method, "Value" property
Set a value for a tag
● "Read" method, "Value" property
Read a value for a tag
Example
The following example reads the value in the "Tag1" tag:
'VBS13
Dim objTag
Set objTag = HMIRuntime.Tags("Tag1")
objTag.Read()
MsgBox objTag.Value
Declaration of tags in WinCC

Always define internal tags in VB script using the "Dim" instruction in order to prevent writing
tags wrongly.
When creating a new action, the "Option explicit" instruction is automatically entered in the
declaration area and cannot be deleted.
Do not use the "Option explicit" statement in your code as it can lead to Runtime errors.
Example
The following example reads the declaration value in the "lngVar" VB Script tag:
'VBS14
Dim lngVar
lngVar = 5
MsgBox lngVar
Note
Tag names must not contain any special characters.
When creating a tag, ensure it does not contain a value (Value = VT_EMPTY). Initialize the
tags after declaration with the corresponding value.

VB scripting
Notes on Cross References

All the pictures which are addressed with the standard formulation
HMIRuntime.Tags("Tagname")
are automatically compiled by the CrossReference of WinCC and then listed in the picture
properties.
If you address tags with different formulations in the code, you can make them known by the
following section of the CrossReference:
' ' WINCC:TAGNAME_SECTION_START

Const TagNameInAction = "TagName"
' WINCC:TAGNAME_SECTION_END
The section can be inserted in VBS actions as often as required.
Note
Composed tag names may not be recognized by the CrossReference.
See also
Name (Page 830)
Value (Page 1171)
ErrorDescription (Page 673)
LastError (Page 766)
QualityCode (Page 878)
TimeStamp (Page 1045)

VB scripting
1.5.3.20 Tags (list) (RT Professional)
Description
+0,5XQWLPH
7DJV 7DJ6HW
7DJ 7DJ
The "Tags" list enables access to tags in WinCC Runtime. The result of access to the "Tags"
list is returned by an object of the type "Tag". The Tag object can be used to access all the tag
properties and methods.
Note
"Tags" is a list with a restricted functional scope. The tags in the list cannot be accessed via
the index but only by using the tag names. The standard methods get_Count and
get_NewEnum cannot be used in the Tags list.
Application
Tags in the list are accessed via:
HMIRuntime.Tags("Tagname")
The Tags list is used to declare tags (tag objects) for read and write access. The appropriate
HMI tags must exist in order for the write and read acccess to be executed without error.
You can address HMI tags directly in VBScript and set and read values. If you wish to inquire
about additional tag properties, such as quality code or time stamp, or wish to execute error
processing, you must address the tag through tags list. The tag object returned enables access
to all tag properties and methods.

VB scripting
Using the "CreateTagSet" method, you may generate a TagSet object which allows
simultaneous access to several tags.
Example
You use tag names when you set tags.
'VBS16
Dim objTag
Set objTag = HMIRuntime.Tags("Tagname")
If you only use the tag name, the "TagPrefix" property is assigned the values from the
current context (the current screen window).
1.5.3.21 TagSet (list) (RT Professional)
Description
The "TagSet" object enables simultaneous access to several tags in one call. Simultaneous
access demonstrates better performance and lower communication load than single access
to multiple tags.
Usage
You can use the TagSet object as follows:
● "Add" method
Add tags to the list
● "Item" method
Access tag objects contained in the list and their properties
● "Write" method
Write all tags of the list
● "Read" method
Read all tags of the list
● "Remove" method
Remove single tags from the list
● "RemoveAll" method
Remove all tags from the list
Tags in the list are accessed via:
'VBS169
Dim myTags
myTags = HMIRuntime.Tags.CreateTagSet
myTags("Tagname")

VB scripting
In order to have error-free read/write access to tags (tag objects) of the list, the respective tags
must exist in WinCC.
If a read/write access error has occurred, the method used will return an error message using
the "LastError" and "ErrorDescription" properties.
Example
The following example shows how to generate a TagSet object, how to add tags, and how to
write values.
'VBS168
'Build a Reference to the TagSet Object
Dim group
Set group = HMIRuntime.Tags.CreateTagSet
'Add Tags to the Collection
group.Add "Motor1"
group.Add "Motor2"
'Set the Values of the Tags
group("Motor1").Value = 3
group("Motor2").Value = 9
'Write the Values to the DataManager
group.Write
See also
ErrorDescription (Page 673)
LastError (Page 766)
1.5.4 Object types (Panels, Comfort Panels, RT Advanced, RT Professional)
1.5.4.1 Object types available in VBS (Panels, Comfort Panels, RT Advanced, RT Professional)
Purpose of the tables below

The following tables show the VBS names of the object types and their display name in the
"Screens" editor and their availability in the respective runtimes.
Basic objects
VBS name Display name Script support Available in

WinCC RT CE WinCC RT Ad‐ WinCC RT Pro‐
(Panels) vanced fessional
Circle Circle Yes Yes Yes Yes
CircleSegment Circle segment Yes - - Yes

VB scripting

CircularArc Circular arc Yes - - Yes
Connector Connector Yes - - Yes
Ellipse Ellipse Yes Yes Yes Yes
EllipseSegment Ellipse segment Yes - - Yes
EllipticalArc Ellipse arc Yes - - Yes
GraphicView Graphic view Yes Yes Yes Yes
Line Line Yes Yes Yes Yes
Polygon Polygon Yes Yes Yes Yes
Polyline Polyline Yes Yes Yes Yes
Rectangle Rectangle Yes Yes Yes Yes
TextField Text field Yes Yes Yes Yes
TubeArcObject Pipe bends Yes - - Yes
TubeDoubleTeeObject Double T-piece Yes - - Yes
TubePolyline Pipe Yes - - Yes
TubeTeeObject T piece Yes - - Yes
Elements

Bar Bar Yes Yes Yes Yes
BatteryView Charge condition Yes Yes - -
Button Button Yes Yes Yes Yes
CheckBox Check box Yes - - Yes
Clock Clock Yes Yes Yes Yes
ComboBox Combo box Yes - - Yes
DateTimeField Date/time field Yes Yes Yes -
DiskSpaceView Disk space view Yes - - Yes
Gauge Gauge Yes Yes Yes Yes
GraphicIOField Graphic I/O field Yes Yes Yes Yes
HelpIndicator Help indicator No1 Yes - -
IOField I/O field Yes Yes Yes Yes
MultilineEdit Editable text field Yes - - Yes
ListBox List box Yes - - Yes
OptionGroup Option buttons Yes - - Yes
ProtectedAreaName‐ Effective range name Yes Yes2 - -
View (RFID)
RangeLabelView Effective range name Yes Yes2 - -
RangeQualityView Effective range signal Yes Yes2 - -
RoundButton Round button Yes - - Yes

VB scripting

Slider Slider Yes Yes Yes Yes
Switch Switch Yes Yes Yes -
SymbolicIOField Symbolic I/O field Yes Yes Yes Yes
SymbolLibrary Symbol library Yes Yes Yes Yes
WindowSlider Scroll bar Yes - - Yes
WLanQualityView WLAN reception Yes Yes 2
- -
ZoneLabelView Zone name Yes Yes2 - -
ZoneQualityView Zone signal Yes Yes 2
- -
1
Only configurable in the global screen
2
Mobile Panels
Controls

AlarmControl Alarm view Yes - - Yes
AlarmIndicator Alarm indicator No 1
Yes Yes -
AlarmView Alarm view Yes Yes Yes -
AlarmWindow Alarm window No 1
Yes Yes -
ApplicationWindow Print job/Script diagnos‐ Yes - - Yes
tics
CameraControl Camera view Yes Yes - -
ChannelDiagnose Channel diagnostics Yes - - Yes
FunctionTrendControl f(x) trend view Yes Yes Yes Yes
HTMLBrowser HTML browser Yes Yes Yes Yes
MediaPlayer Media Player Yes Yes - Yes
OnlineTableControl Table view Yes - - Yes
OnlineTrendControl f(t) trend view Yes - - Yes
PDFview PDF view Yes Yes Yes -
PLCCodeViewer PLC code viewer Yes - - Yes
RecipeView Recipe view Yes Yes Yes -
S7GraphOverview S7-GRAPH Overview Yes - - Yes
ScreenWindow Screen window Yes - - Yes
SmartClientView Sm@rtClient view Yes Yes Yes -
StatusForce Watch table Yes Yes Yes -
SysDiagControl System diagnostics Yes Yes Yes Yes
view
SysDiagWindow System diagnostics No1 Yes Yes -
view
TrendRulerControl Value table Yes - - Yes

VB scripting

TrendView Trend view Yes Yes Yes -
UserArchiveControl Recipe view Yes - - Yes
UserView User view Yes Yes Yes Yes
1
Only configurable in the global screen
1.5.4.2 Objects A-I (Panels, Comfort Panels, RT Advanced, RT Professional)
AlarmControl (RT Professional)
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Represents the "Alarm view" object. The AlarmControl object is an element of the ScreenItems
list.
Type identifier in VBS

HMIAlarmControl

VB scripting
Example
In the following example, the object with the name "Control1" is moved 10 pixels to the right:
'VBS54
Dim objControl
Set objControl = ScreenItems("Control1")
objControl.Left = objControl.Left + 10
Abbreviation Access in Runtime

R Read
RW Read and write
- No access
Table 1-1 Properties
Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
AllFilters - - - -
AllFiltersForHitlist - - - -
AllServer (Page 512) RW - - Specifies whether the alarms of all available servers
are displayed.
AllTagTypesAllowed - - - -
ApplyProjectSettings RW - - Specifies whether the project settings are applied
(Page 515) from the "HMI alarms" editor.
ApplyProjectSettings‐ - - - -
ForDesignMode
AssignedFilters - - - -
AssignedHitlistFilters - - - -
AutoCompleteColumns RW - - Specifies whether empty columns are shown if the
(Page 522) control is wider than the configured columns.
AutoCompleteRows RW - - Specifies whether empty rows are shown if the con‐
(Page 522) trol is longer than the number of configured rows.
AutoScroll (Page 524) RW - - Specifies how the alarm window reacts when new
alarms appear.
AutoSelectionColors RW - - Specifies whether the colors defined by the system
(Page 524) are used as the selection colors for cells and rows.
AutoSelectionRectCol‐ RW - - Specifies whether the selection frame is shown with
or (Page 525) the color defined by the system.
BackColor (Page 529) RW - - Specifies the background color of the selected ob‐
ject.
Blocks - - - -
BorderColor - - - -

VB scripting

sional vanced
BorderWidth RW - - Specifies the line thickness of the selected object.
(Page 580)
Bounds - - - -
CanBeGrouped - - - -
Caption (Page 590) RW - - Specifies the text that is displayed in the header of
the selected object.
CellCut (Page 594) RW - - Specifies whether the contents of the cells are ab‐
breviated if the cells are too narrow.
CellSpaceBottom RW - - Specifies the bottom margin of the table cells.
(Page 595)
CellSpaceLeft RW - - Specifies the left indent used in the table cells.
(Page 596)
CellSpaceRight RW - - Specifies the right indent used in the table cells.
(Page 596)
CellSpaceTop RW - - Specifies the top margin of the table cells.
(Page 597)
Closeable (Page 602) RW - - Specifies whether the object can be closed in run‐
time.
ColumnResize RW - - Specifies whether you can change the width of the
(Page 619) columns.
Columns - - - -
ColumnScrollbar RW - - Enables the display of column scroll bars.
(Page 620)
ColumnTitleAlignment RW - - Specifies the type of column title alignment.
(Page 630)
ColumnTitles RW - - Specifies whether the column header is displayed.
(Page 631)
ControlDesignMode RW - - Specifies the style of the control.
(Page 637)
DefaultFilterEom - - - -
DefaultHitListFilterEom - - - -
DefaultMsgFilterSQL RW - - Specifies an SQL statement as default for alarm fil‐
(Page 648) ters.
DefaultSort (Page 649) RW - - Specifies the type of sorting.
DefaultSort2 RW - - Specifies the type of sorting.
(Page 649)
DefaultSort2Column RW - - Specifies a column by which the alarm view is sorted
(Page 650) initially by default.
DiagnosticsContext RW - - Specifies the diagnostics context.
(Page 651)
DisplayOptions RW - - Specifies whether alarms whose view was sup‐
(Page 656) pressed are displayed.
DoubleClickAction RW - - Specifies the action to be executed in runtime by
(Page 658) double-clicking on a message line.
Enabled (Page 663) RW - - Specifies whether the selected object can be oper‐
ated in runtime.

VB scripting

sional vanced
ExportDelimiter - - - -
ExportDirectoryChange‐ RW - - Specifies whether the data export directory can be
able (Page 677) changed in runtime.
ExportDirectoryname RW - - Specifies the target directory for the exported run‐
(Page 678) time data.
ExportFileExtension RW - - Specifies the file extension of the export file. Only
(Page 678) the "csv" file extension is currently supported.
ExportFilename RW - - Specifies the name of the target file for the exported
(Page 679) runtime data.
ExportFilename‐ RW - - Specifies whether the export file name can be
Changeable (Page 680) changed in runtime.
ExportFormat - - - -
ExportFormatGuid RW - - Specifies the assignment of ID number and export
(Page 681) provider.
ExportFormatName RW - - Specifies the export file format. Only the "csv" file
(Page 682) format is currently available for the export.
ExportParameters RW - - Specifies the parameters of the selected format by
(Page 683) means of the properties dialog.
ExportSelection RW - - Specifies which runtime data of the control is expor‐
(Page 683) ted.
ExportShowDialog RW - - Specifies whether the data export dialog is shown in
(Page 684) runtime.
FillPattern - - - -
FillPatternColor - - - -
Filter - - - -
Font (Page 708) RW - - Specifies the font.
GridLineColor RW - - Specifies the color for the grid lines.
(Page 720)
GridLineWidth RW - - Specifies the width of the separation lines in pixels.
(Page 722)
Height (Page 723) RW - - Specifies the height of the selected object.
Hitlist - - - -
HitlistColumnAdd RW - - Transfers the selected alarm text block from the list
(Page 730) of available alarm blocks to the list of selected alarm
blocks.
HitlistColumnCount RW - - Specifies the number of alarm text blocks displayed
(Page 730) in the hit list in Runtime.
HitlistColumnIndex RW - - References an alarm text block that is selected for
(Page 731) the hit list.
HitlistColumnName RW - - Shows the name of the alarm text block from the hit
(Page 732) list, which is referenced by means of the "HitlistCo‐
lumnIndex" property.
HitlistColumnRemove RW - - Cuts the marked alarm text block from the list of se‐
(Page 732) lected alarm blocks and pastes it into the list of ex‐
isting alarm blocks.
HitlistColumnRepos RW - - Changes the sorting order of the alarm blocks.
(Page 733)

VB scripting

sional vanced
HitlistColumnSort RW - - Specifies the sorting order in the hit list for the alarm
(Page 733) text block that is referenced in "HitlistColumnIndex".
HitlistColumnSortIndex RW - - Defines the sorting order of the alarm text block ref‐
(Page 734) erenced in "HitlistColumnIndex" in the hit list.
HitlistColumnVisible RW - - Specifies a list with the selected alarm text blocks of
(Page 735) the hit list which are used in the control in Runtime.
HitlistDefaultSort RW - - Sets the default sorting order in the table columns of
(Page 735) the hit list.
HitlistFilter - - - -
HitlistMaxSourceItems RW - - Sets the maximum number of data records from the
(Page 736) alarm log that are to be used to create the hit list.
HitlistMaxSourceItems‐ RW - - Specifies whether a warning should be given if the
Warn (Page 737) maximum number of data records that is defined in
"HitlistMaxSourceItems" is reached.
HitListRelTime RW - - Sets a time range for the statistics.
(Page 737)
HitListRelTimeFactor RW - - Specifies the time factor that together with time type
(Page 738) "HitlistRelTimeFactorType" determines the time pe‐
riod for which the statistics of the hit list is created.
HitlistRelTimeFactor‐ RW - - Specifies the time type which, alongside the time
Type (Page 738) factor "HitlistRelativeTimeFactor", determines the
time period in which the statistics of the hit list will be
created.
HorizontalGridLines RW - - Specifies whether horizontal separating lines are
(Page 740) displayed.
IconSpace (Page 743) RW - - Specifies the spacing between icons and text in the
table cells.
IsActive - - - -
Layer (Page 767) RW - - Specifies the layer in the screen that contains an ob‐
ject.
Left (Page 773) RW - - Specifies the value of the X coordinate of the object.
LineBackgroundColor - - - -
LineColor (Page 789) RW - - Specifies the color of the window separation lines.
LineStyle - - - -
LineWidth (Page 793) RW - - Specifies the line thickness of the selected object.
Location - - - -
LongTermArchiveCon‐ RW - - Specifies how alarms are displayed in the alarm view
sistency (Page 798) when the "Historical alarm list (long-term)" is config‐
ured.
MessageBlockAlign‐ RW - - Sets the mode of alignment for the table contents of
ment (Page 804) the selected alarm block.
MessageBlockAutoPre‐ RW - - Enables automatic setting of the number of decimal
cisions (Page 805) places.
MessageBlockCaption RW - - Specifies the caption of the column header in the
(Page 806) alarm view for the selected alarm text block.
MessageBlockCount RW - - Specifies the number of existing alarm text blocks
(Page 806) that are available for the alarm list and hit list.

VB scripting

sional vanced
MessageBlockDateFor‐ RW - - Specifies the date format for displaying the alarms.
mat (Page 807)
MessageBlockExpo‐ RW - - Specifies the exponential notation for visualization
nentialFormat of the values of a selected alarm block.
(Page 807)
MessageBlockFlashOn RW - - Enables flashing of the selected alarm block in Run‐
(Page 808) time when an alarm appears.
MessageBlockHideText RW - - Enables the textual display of the content of the se‐
(Page 809) lected alarm block.
MessageBlockHideTi‐ RW - - Specifies textual display of the caption of the selec‐
tleText (Page 809) ted alarm block.
MessageBlockId RW - - Specifies the assignment of ID number and alarm
(Page 810) text block in the alarm view.
MessageBlockIndex RW - - References an existing alarm text block.
(Page 811)
MessageBlockLeading‐ RW - - Enables the display of the selected alarm block with
Zeros (Page 811) leading zeroes.
MessageBlockLength RW - - Specifies the length of the selected alarm block
(Page 812) based on the number of characters.
MessageBlockName RW - - Specifies the name for the selected alarm text block.
(Page 812)
MessageBlockPreci‐ RW - - Specifies the number of decimal places for the val‐
sions (Page 813) ues of the selected alarm block.
MessageBlockSelected RW - - Existing alarm blocks are blocks that are available
(Page 813) for use in the control in Runtime for the alarm list or
hit list.
MessageBlockShow‐ RW - - Specifies whether to display both the date and time
Date (Page 814) in the "Time" alarm text block.
MessageBlockShowI‐ RW - - Enables the display of the content of the selected
con (Page 815) alarm block as icon.
MessageBlockShowTi‐ RW - - Specifies textual display of the caption of the selec‐
tleIcon (Page 815) ted alarm block.
MessageBlockTextId RW - - Specifies naming of the selected alarm text block by
(Page 816) means of a text ID that was taken from the text li‐
brary.
MessageBlockTimeFor‐ RW - - Specifies the format for the time or period used to
mat (Page 816) display the alarms.
MessageBlockType RW - - Specifies the number of existing alarm text blocks
(Page 817) that are available for the alarm list and hit list.
MessageColumnAdd RW - - Adds the selected alarm text block from the list of
(Page 818) available alarm blocks to the list of selected alarm
blocks.
MessageColumnCount RW - - Specifies the number of selected alarm text blocks
(Page 818) displayed in the alarm list in Runtime.
MessageColumnIndex RW - - References an alarm text block selected for the
(Page 819) alarm list.

VB scripting

sional vanced
MessageColumnName RW - - Specifies the name of the alarm text block in the
(Page 820) alarm list which is referenced with the "MessageCo‐
lumnIndex" property.
MessageColumnRe‐ RW - - Cuts the marked alarm text block from the list of se‐
move (Page 820) lected alarm blocks and pastes it into the list of ex‐
isting alarm blocks.
MessageColumnRepos RW - - Specifies the order of the alarm text blocks.
(Page 821)
MessageColumnSort RW - - Specifies the sorting order for the alarm text block
(Page 821) that is referenced in "MessageColumnIndex".
MessageColumnSortIn‐ RW - - Defines the sorting order of the alarm text block ref‐
dex (Page 822) erenced in "MessageColumnIndex".
MessageColumnVisible RW - - Specifies whether alarm text blocks are displayed in
(Page 823) the alarm view.
MessageListType RW - - This setting defines which alarm list contents are
(Page 823) displayed when screen opens.
Moveable (Page 828) RW - - Specifies whether the window can be moved in Run‐
time.
MsgFilterSQL RW - - Specifies one or several SQL statements for user-
(Page 829) defined selection of the alarms.
Name - - - -
Object - - - -
OcxGuid - - - -
OcxState - - - -
OcxStateForEs2Rt - - - -
OperatorAlarms - - - -
OperatorMessageId RW - - Specifies the assignment of ID number and trigger
(Page 844) event in the alarm view.
OperatorMessageIndex RW - - References an operator message event.
(Page 845)
OperatorMessage‐ RW - - Specifies the name which is referenced with the "Op‐
Name (Page 845) eratorMessageIndex" event in message events for
operator messages.
OperatorMessageNum‐ RW - - Specifies a message number for the operator mes‐
ber (Page 846) sage of the selected message event if you do not
use the operator message of WinCC.
OperatorMessageSe‐ RW - - Activates the message events in the list that trigger
lected (Page 846) operator messages.
OperatorMessage‐ RW - - Specifies a alarm text block of the operated message
Source1 (Page 847) to be added to "Process value block 1" of the opera‐
tor message configured here.
Source10 (Page 853) to be added to "Process value block 10" of the oper‐
ator message configured here.

VB scripting

sional vanced
OperatorMessageSour‐ RW - - Specifies the format of the source content to be
ceType1 (Page 854) transferred.
PageMode (Page 861) RW - - Enables paging in the historical alarm list (long-term).
PageModeMessage‐ RW - - Defines the number of alarm shown per page when
Number (Page 862) paging the historical alarm list (long-term).
PrintJob (Page 875) RW - - Specifies a print job that is created in the "Reports"
editor.
RowScrollbar RW - - Specifies whether row scroll bars are displayed.
(Page 888)

VB scripting

sional vanced
RowTitleAlignment RW - - Specifies the type of row header alignment.
(Page 889)
RowTitles (Page 890) RW - - Specifies that row headers will be displayed.
RTPersistence RW - - Specifies how online configurations of WinCC are
(Page 890) retained.
RTPersistenceAuthori‐ RW - - Specifies the authorization required for online con‐
zation (Page 891) figuration in runtime.
RTPersistenceType RW - - Specifies how online configurations of WinCC are
SelectedCellColor RW - - Specifies the background color of the selected cell.
(Page 908)
SelectedCellForeColor RW - - Specifies the font color of the selected cell.
(Page 909)
SelectedRowColor RW - - Specifies the background color of the selected row.
(Page 911)
SelectedRowForeColor RW - - Specifies the font color of the selected row.
(Page 912)
SelectedTitleColor RW - - Specifies the background color of the selected table
(Page 914) header.
SelectedTitleForeColor RW - - Specifies the font color of the selected table header.
(Page 915)
SelectionColoring RW - - Specifies whether selection colors are used for cells
(Page 917) or rows.
SelectionRect RW - - Specifies whether a selection frame is used for the
(Page 919) selected cells or rows.
SelectionRectColor RW - - Specifies the color of the selection rectangle in the
(Page 919) alarm window if SelectionType equals "1".
SelectionRectWidth RW - - Specifies the line width of the selection rectangle in
(Page 920) the alarm window if SelectionType equals "1".
SelectionType RW - - Specifies the number of lines you can mark.
(Page 921)
ServerNames RW - - Specifies the servers of a distributed system that
(Page 926) form the data source for the alarm view.
ShowSortButton RW - - Specifies whether the sorting button is shown above
(Page 944) the vertical scroll bar.
ShowSortIcon RW - - Specifies whether the sorting icon is displayed.
(Page 945)
ShowSortIndex RW - - Specifies whether a sort index is displayed.
(Page 945)
ShowTitle (Page 950) RW - - Specifies the representation of the control's window
title.
Size - - - -
Sizeable (Page 955) RW - - Specifies that the size of an object can be changed
in runtime.
SortSequence RW - - Specifies how the sorting order can be changed by
(Page 957) mouse click.

VB scripting

sional vanced
StatusbarBackColor RW - - Specifies the background color for status bars.
(Page 962)
StatusbarElementAdd RW - - Creates a new, user-defined status bar element.
(Page 963)
StatusbarElementAuto‐ RW - - Specifies whether the width of the selected status
Size (Page 964) bar element is set automatically.
StatusbarElement‐ RW - - Specifies the number of configurable status bar ele‐
Count (Page 965) ments.
StatusbarElementIco‐ RW - - Specifies the ID number and symbol assignment of
nId (Page 966) a status bar element.
StatusbarElementID RW - - Specifies the ID number of the selected status bar
(Page 966) element.
StatusbarElementIndex RW - - Specifies the reference for a status bar element.
(Page 967)
StatusbarElement‐ RW - - Specifies the object name of the selected status bar
Name (Page 968) element.
StatusbarElementRe‐ RW - - Removes the selected user-defined status bar ele‐
move (Page 969) ment.
StatusbarElementRe‐ RW - - Changes the name of the user-defined status bar
name (Page 970) element that is referenced by the "StatusbarElemen‐
tIndex" property.
StatusbarElementRe‐ RW - - Specifies the index of an element in the status bar
pos (Page 971) of the display and operating object.
StatusbarElements - - - -
StatusbarElementText RW - - Specifies the text of the selected status bar element.
(Page 972)
StatusbarElementTool‐ RW - - Specifies the tooltip text for the selected user-de‐
tipText (Page 973) fined status bar element.
StatusbarElementUser‐ RW - - Specifies whether the configuration engineer has
Defined (Page 973) added the status bar element as a new user-defined
element.
StatusbarElementVisi‐ RW - - Specifies whether the referenced element of the sta‐
ble (Page 974) tus bar element is displayed in Runtime.
StatusbarElementWidth RW - - Specifies the width of the referenced status bar ele‐
(Page 975) ment in pixels.
StatusbarFont RW - - Specifies the font of the texts in the status bar.
(Page 976)
StatusbarFontColor RW - - Specifies the color of the texts in the status bar.
(Page 977)
StatusbarShowTooltips RW - - Specifies whether tooltips are displayed for the ele‐
(Page 978) ments of the status bar in runtime.
StatusbarText RW - - Specifies the default text in the status bar.
(Page 979)
StatusbarUseBackCol‐ RW - - Specifies whether the background color of the status
or (Page 979) bar is shown.
StatusbarVisible RW - - Specifies whether the status bar of the control is dis‐
(Page 980) played.

VB scripting

sional vanced
TabIndex - - - -
TabIndexAlpha - - - -
TableColor (Page 991) RW - - Specifies the background color of the table rows in
the object.
TableColor2 (Page 991) RW - - Specifies the second background color of the rows.
TableForeColor RW - - Specifies the text color used in the table cells of the
(Page 993) object.
TableForeColor2 RW - - Specifies the second text color used in the table cells
(Page 994) of the object.
TimeBase (Page 1026) RW - - Specifies the time zone in which the time values are
displayed.
TitleColor (Page 1048) RW - - Specifies the background color of the table header.
TitleCut (Page 1049) RW - - Specifies whether the content of the fields in a title
bar is to be shortened if the column is too narrow.
TitleDarkShadowColor RW - - Specifies the color for the dark side of the 3D shading
(Page 1049) for column and row headers in the object table.
TitleForeColor RW - - Specifies the text color for the table column and row
(Page 1050) headers of the object.
TitleGridLineColor RW - - Specifies the color of the separation lines in the title
(Page 1051) bar of the table.
TitleLightShadowColor RW - - Specifies the color for the light side of the 3D shading
(Page 1052) for table column and row headers of the object.
TitleSort (Page 1053) RW - - Specifies how sorting by column header is triggered.
TitleStyle (Page 1054) RW - - Specifies whether a shading color is used for the ta‐
ble header.
ToolbarAlignment RW - - Specifies the position of the toolbar.
(Page 1062)
ToolbarBackColor RW - - Specifies the background color of the toolbar.
(Page 1063)
ToolbarButtonActive RW - - Specifies whether the function linked to the button is
(Page 1064) activated in runtime.
ToolbarButtonAdd RW - - Creates a new user-defined button in the object's
(Page 1065) toolbar.
ToolbarButtonAuthori‐ RW - - Shows the authorization for the selected button func‐
zation (Page 1065) tion.
ToolbarButtonBe‐ RW - - Inserts a leading separator (vertical line) for the se‐
ginGroup (Page 1066) lected key function on the toolbar.
ToolbarButtonClick RW - - Clicks a toolbar button.
(Page 1067)
ToolbarButtonCount RW - - Specifies the number of buttons in the toolbar.
(Page 1068)
ToolbarButtonEnabled RW - - Specifies whether a user-defined toolbar button can
(Page 1069) be operated.
ToolbarButtonHotKey RW - - Specifies the shortcut for the selected button of the
(Page 1070) object.
ToolbarButtonID RW - - Specifies the key function via your unique ID num‐
(Page 1070) ber.

VB scripting

sional vanced
ToolbarButtonIndex RW - - References a button function.
(Page 1071)
ToolbarButtonLocked RW - - Enables/disables display of the locked, pressed
(Page 1072) state for a user-defined toolbar button.
ToolbarButtonName RW - - Specifies the name of the selected user-defined but‐
(Page 1073) ton.
ToolbarButtonRemove RW - - Removes the selected user-defined button.
(Page 1074)
ToolbarButtonRename RW - - Specifies the name of the user-defined toolbar but‐
(Page 1075) ton that is being referenced via the "ToolbarButto‐
nIndex" property.
ToolbarButtonRepos RW - - Specifies the position of a referenced button in the
(Page 1076) object's toolbar.
ToolbarButtons - - - -
ToolbarButtonTooltip‐ RW - - Specifies the tooltip text for the user-defined button
Text (Page 1077) in the toolbar.
ToolbarButtonUserDe‐ RW - - Specifies whether the project engineer has added
fined (Page 1078) the toolbar button as new user-defined button.
ToolbarButtonVisible RW - - Specifies whether the button is displayed in the tool‐
(Page 1079) bar.
ToolbarShowTooltips RW - - Specifies whether the tooltips for the key functions
(Page 1080) are displayed in runtime.
ToolbarUseBackColor RW - - Specifies whether the background color for the tool‐
(Page 1081) bar is shown.
ToolbarUseHotKeys RW - - Specifies whether the hotkeys for the button func‐
(Page 1082) tions are activated in Runtime.
ToolbarVisible RW - - Specifies whether the toolbar of the control is dis‐
(Page 1083) played.
Top (Page 1085) RW - - Specifies the value of the Y coordinate of the selec‐
ted object.
UseMessageColor RW - - Specifies whether the agreed colors of the message
(Page 1156) classes are displayed.
UseSelectedTitleColor RW - - Specifies whether a selection color is used for the
(Page 1158) headers of selected table cells.
UseTableColor2 RW - - Specifies whether a second row color is used for the
(Page 1160) representation of the table.
VerticalGridLines RW - - Specifies whether vertical separation lines are dis‐
(Page 1204) played.
Visible (Page 1207) RW - - Specifies whether the selected object is visible.
Width (Page 1220) RW - - Specifies the width of the object in pixels.

VB scripting
Table 1-2 Methods
Methods RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Activate (Page 1253) Yes - - Enables the permanent area or the root screen.
ActivateDynamic Yes - - Dynamically activates a trigger and the specified cy‐
(Page 1255) cle for a property at runtime.
AttachDB (Page 1259) Yes - - Executes the "Connect backup" key function of the
control.
CopyRows (Page 1260) Yes - - Executes the "Copy lines" key function of the control.
DeactivateDynamic Yes - - Deactivates the trigger of the "ActivateDynamic"
(Page 1262) method used for the specified property in/during run‐
time.
DetachDB (Page 1265) Yes - - Executes the "Disconnect backup" key function of
the control.
Export (Page 1266) Yes - - Executes the "Export log" or "Export data" key func‐
tion of the control.
GetHitlistColumn Yes - - Returns the column object of the alarm view hit list
(Page 1270) designated by name or index as "ICCAxMessage‐
Column" type.
GetHistlistColumnCol‐ Yes - - Returns the list of all column objects of the alarm
lection (Page 1268) view hit list as "ICCAxCollection" type.
GetMessageBlock Yes - - Returns the alarm text block object of the alarm view
(Page 1271) designated by name or index as "ICCAxMessage‐
Block" type.
GetMessageBlockCol‐ Yes - - Returns the list of all alarm text block objects of the
lection (Page 1272) alarm view as "ICCAxCollection" type.
GetMessageColumn Yes - - Returns the column object of the alarm view desig‐
(Page 1273) nated by name or index as "ICCAxMessageColumn"
type.
GetMessageColumn‐ Yes - - Returns the list of all column objects of the alarm
Collection (Page 1274) view as "ICCAxCollection" type.
GetOperatorMessage Yes - - Returns the operator message object of the alarm
(Page 1275) view designated by name or index as "ICCAxOper‐
atorMessage" type.
GetOperatorMessage‐ Yes - - Returns the list of all operator message objects of
Collection (Page 1276) the alarm view as "ICCAxCollection" type.
GetRow (Page 1277) Yes - - Returns the row object defined by its row number in
the table-based controls as "ICCAxDataRow" type.
GetRowCollection Yes - - Returns the list of all row objects of the table-based
(Page 1279) controls as "ICCAxDataRowCollection" type.
GetSelectedRow Yes - - Returns the selected row object of a table-based
(Page 1285) control as "ICCAxDataRow" type.
GetSelectedRows Yes - - Returns the selected row objects of a table-based
(Page 1286) control as type "ICCAxDataRow" for multiple selec‐
tion.
GetStatusbarElement Yes - - Returns the element of the control's status bar des‐
(Page 1292) ignated by name or index as "ICCAxStatusbarEle‐
ment" type.
GetStatusbarElement‐ Yes - - Returns the list of all status bar elements of the con‐
Collection (Page 1293) trol as "ICCAxCollection" type.

VB scripting

sional vanced
GetToolbarButton Yes - - Returns the button function designated by name or
(Page 1300) index on the control toolbar as "ICCAxToolbarBut‐
ton" type.
GetToolbarButtonCol‐ Yes - - Returns the list of all button functions of the control
lection (Page 1301) toolbar as "ICCAxCollection" type.
HideAlarm (Page 1317) Yes - - Executes the "Hide alarm" button function of the
alarm view.
LockAlarm (Page 1320) Yes - - Executes the "Disable alarm" button function of the
alarm view.
LoopInAlarm Yes - - Executes the "Loop in alarm" button function of the
(Page 1320) alarm view.
MoveToFirstLine Yes - - Executes the "First alarm" button function of the
MoveToFirstPage Yes - - Executes the "First page" button function of the
MoveToLastLine Yes - - Executes the "Last alarm" button function of the
MoveToLastPage Yes - - Executes the "Last page" button function of the
MoveToNextLine Yes - - Executes the "Next alarm" button function of the
MoveToNextPage Yes - - Executes the "Next page" button function of the
MoveToPreviousLine Yes - - Executes the "Previous alarm" button function of the
MoveToPreviousPage Yes - - Executes the "Previous page" button function of the
Print (Page 1330) Yes - - Executes the "Print" button function of the control.
QuitHorn (Page 1331) Yes - - Executes the "Alarm annunciator acknowledgment"
button function of the alarm view.
QuitSelected Yes - - Executes the "Single acknowledgment" button func‐
(Page 1331) tion of the alarm view.
QuitVisible (Page 1332) Yes - - Executes the "Group acknowledgment" button func‐
tion of the alarm view.
SelectAll (Page 1345) Yes - - Selects all rows in a table-based control.
SelectRow (Page 1346) Yes - - Selects a specific row in a table-based control.
ShowComment Yes - - Executes the "Comment dialog" button function of
ShowDisplayOptions‐ Yes - - Executes the "Display options dialog" button func‐
Dialog (Page 1350) tion of the alarm view.
ShowEmergencyQuit‐ Yes - - Executes the "Emergency acknowledgment" button
Dialog (Page 1350) function of the alarm view.
ShowHelp (Page 1351) Yes - - Executes the "Help" button function of the control.
ShowHideList Yes - - Executes the "List of alarm to hide" button function
(Page 1351) of the alarm view.
ShowHitList Yes - - Executes the "Hit list" button function of the alarm
(Page 1352) view.

VB scripting

sional vanced
ShowInfoText Yes - - Executes the "About dialog" button function of the
ShowLockDialog Yes - - Executes the "Lock dialog" button function of the
ShowLockList Yes - - Executes the "Lock list" button function of the alarm
(Page 1353) view.
ShowLongTermArch‐ Yes - - Executes the "Historical alarm list (long-term)" but‐
iveList (Page 1354) ton function of the alarm view.
ShowMessageList Yes - - Executes the "Alarm list" button function of the alarm
(Page 1354) view.
ShowPropertyDialog Yes - - Executes the "Configuration dialog" button function
(Page 1355) of the control.
ShowSelectionDialog Yes - - Executes the "Selection dialog" button function of
ShowShortTermArch‐ Yes - - Executes the "Historical alarm list (short-term)" but‐
iveList (Page 1358) ton function of the alarm view.
ShowSortDialog Yes - - Executes the "Sorting dialog" button function of the
ShowTimebaseDialog Yes - - Executes the "Timebase dialog" button function of
UnhideAlarm Yes - - Executes the "Unhide alarm" button function of the
UnlockAlarm Yes - - Executes the "Unlock alarm" button function of the
UnselectAll Yes - - Removes all selections from the cells of a table-
(Page 1364) based control.
UnselectRow Yes - - Removes the selections from a specific cell of a ta‐
(Page 1364) ble-based control.

VB scripting
AlarmView (Panels, Comfort Panels, RT Advanced)
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Represents the "Alarm view" object. The AlarmView object is an element of the ScreenItems
list.
If you change the settings for this object with a user-defined function, the changed settings are
retained even after the screen is called again.
Note
The object "Simple AlarmView" cannot be dynamized with a user-defined function.

R Read
RW Read and write
- No access

sional vanced
AlarmAreaHeight - - - -
AlarmAreaWidth - - - -
AlarmClasses - - - -
AlarmLog - - - -

VB scripting

sional vanced
AlarmSource - - - -
AlarmTextTag - - - -
Authorization - - - -
BackColor (Page 529) - RW RW Specifies the background color of the selected ob‐
ject.
BorderBackColor - - - -
BorderColor - - - -
BorderWidth - - - -
Bounds - - - -
ButtonBackColor - - - -
ButtonBackFillStyle - - - -
ButtonBarElements - - - -
ButtonBarStyle - - - -
ButtonBorderBackColor - - - -
ButtonBorderColor - - - -
ButtonBorderWidth - - - -
ButtonCornerRadius - - - -
ButtonEdgeStyle - - - -
ButtonFirstGradientCol‐ - - - -
or
ButtonFirstGradientOff‐ - - - -
set
ButtonMiddleGradient‐ - - - -
Color
ButtonPositions - - - -
ButtonSecondGradient‐ - - - -
Color
ButtonSecondGradien‐ - - - -
tOffset
ColumnOrder - - - -
Columns - - - -
ColumnsMoveable - - - -
ColumnTextAckGroup - - - -
ColumnTextAlarmState - - - -
ColumnTextAlarmText - - - -
ColumnTextClassName - - - -
ColumnTextDate - - - -
ColumnTextDevice - - - -
ColumnTextDiagnosa‐ - - - -
ble
ColumnTextNumber - - - -

VB scripting

sional vanced
ColumnTextTime - - - -
ColumnWidth - - - -
ConfiguredAlarmClass‐ - - - -
es
CornerRadius - - - -
CountOfLinesPerA‐ - - - -
larms
CountOfVisibleAlarms - - - -
DeviceStyle - - - -
EdgeStyle - - - -
Enabled (Page 663) - RW RW Specifies whether the selected object can be oper‐
ated in runtime.
ES2RT_ButtonPositions - - - -
ES2RT_ColumnOrder - - - -
ES2RT_ColumnWidth - - - -
ES2RT_MessageArea‐ - - - -
Height
ES2RT_MessageArea‐ - - - -
Width
FilterTag - - - -
FilterText - - - -
FitToSize - - - -
Flashing - - - -
FocusColor (Page 706) - RW RW Specifies the color of the focus border when the ob‐
ject has the focus.
FocusWidth (Page 707) - RW RW Specifies the border width when the object has the
focus.
ForeColor - - - -
GridLineColor - RW RW Specifies the color for the grid lines.
(Page 720)
Height - - - -
HorizontalScrollingEna‐ - - - -
bled
IsRunningUnderCE - - - -
Layer (Page 767) - RW RW Specifies the layer in the screen that contains an
object.
Left (Page 773) - RW RW Specifies the value of the X coordinate.
LineAlarmView - - - -
Location - - - -
MessageAreaHeight - - - -
MessageAreaLeft - - - -
MessageAreaTop - - - -
MessageAreaWidth - - - -
Name - - - -

VB scripting

sional vanced
PaddingBottom - - - -
PaddingLeft - - - -
PaddingRight - - - -
PaddingTop - - - -
PreferredUseOnAck - - - -
S7Device - - - -
SecurityForSimpleVie‐ - - - -
wEnabled
SelectionBackColor - RW RW Specifies the background color of the selected cells.
(Page 916)
SelectionForeColor - RW RW Specifies the foreground color of the selected cells.
(Page 918)
SeparateLineForAlarm‐ - - - -
Text
ShowAcknowledgeBut‐ - - - -
ton
ShowAlarmsFromDate - RW RW Specifies that only those message events are dis‐
(Page 928) played that are saved in this tag.
ShowAlarmsToAck‐ - - - -
nowledge
ShowColumnHeaders - - - -
ShowHelpButton - - - -
ShowHorizontalGrid‐ - - - -
lines
ShowLoopInAlarmBut‐ - - - -
ton
ShowMilliseconds - - - -
ShowPendingAlarms - - - -
Size - - - -
SortByTimeDirection - RW RW Specifies whether the last alarm received is shown
(Page 956) at the top (ascending sorting order).
SortByTimeEnabled - RW RW Specifies whether alarm sorting can be altered ac‐
(Page 957) cording to the time.
StyleItem - - - -
SupportsS7Diagnostic‐ - - - -
sInSimpleView
TabIndex - - - -
TableBackColor - RW RW Specifies the background color of the table cells.
(Page 990)
TableEvenRowBack‐ - - - -
Color
TableFont - - - -
TableForeColor - RW RW Specifies the text color used in the table cells of the
(Page 993) object.

VB scripting

sional vanced
TableHeaderBackColor - RW RW Specifies the background color in the header of the
(Page 995) table.
TableHeaderBackFill‐ - - - -
Style
TableHeaderBorder‐ - - - -
BackColor
TableHeaderBorderCol‐ - - - -
or
Width
TableHeaderCornerRa‐ - - - -
dius
TableHeaderEdgeStyle - - - -
TableHeaderFirstGra‐ - - - -
dientColor
dientOffset
TableHeaderFont - - - -
TableHeaderForeColor - RW RW Specifies the text color in the header of the table.
(Page 997)
TableHeaderMiddleGra‐ - - - -
dientColor
TableHeaderPadding‐ - - - -
Bottom
TableHeaderPaddin‐ - - - -
gLeft
Right
Top
TableHeaderSecond‐ - - - -
GradientColor
GradientOffset
ToolbarHeight - - - -
ToolbarLeft - - - -
ToolbarTop - - - -
ToolbarWidth - - - -
Top (Page 1085) - RW RW Specifies the value of the Y coordinate.
UseButtonFirstGradient - - - -
UseButtonSecondGra‐ - - - -
dient
UseDesignColorSche‐ - - - -
ma
UseTableHeaderFirst‐ - - - -
Gradient

VB scripting

sional vanced
UseTableHeaderSe‐ - - - -
condGradient
VerticalScrollBarEna‐ - - - -
bled
VerticalScrollingEna‐ - - - -
bled
ViewType - - - -
ViewTypeForSave‐ - - - -
Stream
Visible (Page 1207) - RW RW Specifies whether the selected object is visible.
Width - - - -
Table 1-4 Methods

sional vanced
Activate (Page 1253) - Yes Yes Enables the permanent area or the root screen.
ApplicationWindow (RT Professional)
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Represents the "ApplicationWindow" object. The ApplicationWindow object is an element of

the ScreenItems list.

VB scripting

HMIApplicationWindow

R Read
RW Read and write
- No access

sional vanced
BorderEnabled RW - - Specifies whether the window is displayed with a
(Page 568) border in runtime.
Bounds - - - -
GSCRuntimeAllowed - - - -
Height (Page 723) RW - - Specifies the height.
ject.
Left (Page 773) RW - - Specifies the value of the X coordinate.
Location - - - -
Name - - - -
ShowCaption RW - - Specifies whether the title bar is shown.
(Page 930)
Size - - - -
TabIndex - - - -
Template (Page 1002) RW - - Specifies the template for displaying window content
in the "Print job/Script diagnostics" object.
Top (Page 1085) - - - -
WindowCloseEnabled RW - - Specifies whether a window can be closed in Run‐
(Page 1223) time.
WindowMaximizeEna‐ RW - - Specifies whether the object can be maximized in
bled (Page 1223) Runtime.
WindowMovingEnabled RW - - Specifies whether the object can be moved in Run‐
(Page 1224) time.
WindowOnTop RW - - Specifies whether the object always remains in the
(Page 1225) foreground in Runtime.
WindowsContents RW - - Specifies the content of the print job or script diag‐
(Page 1225) nostics.
WindowSizingEnabled RW - - Specifies whether the size can be changed.
(Page 1226)

VB scripting
Table 1-6 Methods

sional vanced
time.
Bar (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Represents the "Bar" object. The Bar object is an element of the ScreenItems list.

HMIBar

R Read
RW Read and write
- No access

VB scripting

sional vanced
AlarmLowerLimit RW - - Specifies the low limit at which the alarm is triggered
(Page 506)
AlarmLowerLimitColor RW - - Specifies the bar color for the "AlarmLowerLimit"
(Page 507) limit.
AlarmLowerLimitEna‐ RW - - Specifies whether the "AlarmLowerLimit" limit is
bled (Page 508) monitored.
AlarmLowerLimitRela‐ RW - - Specifies whether the low limit at which the interrupt
tive (Page 508) is triggered is evaluated as a percentage or an ab‐
solute value.
AlarmUpperLimit RW - - Specifies the high limit that triggers the interrupt.
(Page 509)
AlarmUpperLimitColor RW - - Specifies the bar color for the "AlarmUpperLimit"
(Page 510) limit.
AlarmUpperLimitEna‐ RW - - Specifies whether the "AlarmUpperLimit" limit is
AlarmUpperLimitRela‐ RW - - Specifies whether the high limit at which the interrupt
tive (Page 511) is triggered is evaluated as a percentage or an ab‐
solute value.
Authorization RW - - Specifies operating rights.
(Page 520)
AverageLast15Values RW - - Specifies whether the average of the last 15 values
(Page 527) is to be shown.
BackColor (Page 529) RW RW RW Specifies the background color.
BackFillStyle RW - - Specifies the fill pattern.
(Page 534)
BackFlashingColorOff RW - - Specifies the background color for flash state "Off".
(Page 536)
BackFlashingColorOn RW - - Specifies the background color for flash state "On".
(Page 537)
BackFlashingEnabled RW - - Specifies whether the background flashes in run‐
(Page 538) time.
BackFlashingRate RW - - Specifies the flash rate of the background.
(Page 539)
BarBackColor RW RW RW Specifies the color of the bar background for the se‐
(Page 542) lected object.
BarBackFillStyle RW - - Specifies the fill style for the bar.
(Page 543)
BarBackFlashingColor‐ - - - -
Off
BarBackFlashingColor‐ - - - -
On
BarBackFlashingEna‐ - - - -
bled

VB scripting

sional vanced
BarBackFlashingRate - - - -
BarEdgeStyle - - - -
BarOrientation RW - - Specifies the bar alignment.
(Page 547)
BorderBackColor RW - - Specifies the background color of the broken border
(Page 561) line.
BorderColor (Page 565) RW - - Specifies the line color.
BorderFlashingColorOff RW - - Specifies the color of the border line for the flashing
(Page 569) status "Off".
BorderFlashingColorOn RW - - Specifies the color of the border line for the flashing
(Page 570) status "On".
BorderFlashingEnabled RW - - Specifies whether the limit of the object can flash in
(Page 572) runtime.
BorderFlashingRate RW - - Specifies the flash rate of the border line.
(Page 573)
BorderStyle (Page 579) RW - - Specifies the type of border lines.
BorderWidth (Page 580) RW - - Specifies the line thickness of the selected object.
BorderWidth3D - - - -
Bounds - - - -
ColorChangeHysteresis RW - - Specifies the hysteresis as a percentage of the dis‐
(Page 604) play value.
ColorChangeHysteresi‐ RW - - Specifies whether the object is displayed with hys‐
sEnabled (Page 604) teresis.
CompatibilityMode - - - -
CornerStyle (Page 638) RW - - Specifies the shape of the corners of the specified
object.
CountDivisions RW - - Specifies the number of segments into which the bar
(Page 640) will be split by means of the large scale tick marks.
CountSubDivisions - RW RW Specifies the number of scale marks between two
(Page 640) main marks.
DeviceStyle - - - -
DrawInsideFrame RW - - Specifies whether the border line of the selected ob‐
(Page 658) ject with a line thickness greater than 1 should be
drawn within the border or symmetrically to the bor‐
der.
EdgeStyle (Page 660) RW - - Specifies the line style of the selected object.
Enabled (Page 663) RW RW RW Specifies whether the selected object can be oper‐
ated in runtime.
FillPatternColor RW - - Specifies the color of the fill pattern for the selected
(Page 688) object.
Flashing - - - -
FlashingColorOff - - - -
FlashingColorOn - - - -
FlashingEnabled - - - -

VB scripting

sional vanced
FlashingOnLimitViola‐ - - - -
tion
FlashingRate - - - -
Font - - - -
FontBold (Page 711) RW - - Specifies whether the text of the selected object is
shown in bold.
FontName (Page 712) RW - - Specifies the font of the selected object.
FontSize (Page 714) RW - - Specifies the font size of the text for the selected
object.
ForeColor (Page 715) RW RW RW Specifies the font color of the text for the selected
object.
ForeColorTransparency - - - -
InnerHeight - - - -
InnerWidth - - - -
IntegerDigits RW - - Specifies the number of digits to the left of the deci‐
(Page 751) mal point (0 to 20).
LargeTickLabelingStep R - - Returns which scale sections are labeled.
(Page 763)
LargeTicksBold RW - - Specifies whether the long tick marks of a scale are
(Page 763) shown in bold.
LargeTicksSize RW - - Specifies the length of the long tick marks of a scale.
(Page 764)
Layer (Page 767) RW RW RW Specifies the layer in the screen that contains an
object.
Left (Page 773) RW RW RW Specifies the value of the X coordinate of the selec‐
ted object.
Limit4LowerLimit RW - - Specifies the low limit for "Reserve4".
(Page 778)
Limit4LowerLimitColor RW - - Specifies the color for the "Reserve4" low limit.
(Page 779)
Limit4LowerLimitEna‐ RW - - Specifies whether the "Reserve4" low limit is moni‐
bled (Page 780) tored.
Limit4LowerLimitRela‐ RW - - Specifies whether the "Reserve4" low limit is evalu‐
tive (Page 780) ated as a percentage or an absolute value.
Limit4UpperLimit RW - - Specifies the high limit for "Reserve4".
(Page 781)
Limit4UpperLimitColor RW - - Specifies the color for the "Reserve4" high limit.
(Page 782)
Limit4UpperLimitEna‐ RW - - Specifies whether the "Reserve4" high limit is moni‐
Limit4UpperLimitRela‐ RW - - Specifies whether the "Reserve4" high limit is eval‐
tive (Page 783) uated as a percentage or an absolute value.
Limit5LowerLimit RW - - Specifies the low limit for "Reserve5".
(Page 784)

VB scripting

sional vanced
Limit5LowerLimitColor RW - - Sets the color for the "Reserve5" low limit.
(Page 784)
Limit5LowerLimitEna‐ RW - - Specifies whether the "Reserve5" low limit is moni‐
Limit5LowerLimitRela‐ RW - - Specifies whether the "Reserve5" low limit is evalu‐
tive (Page 786) ated as a percentage or an absolute value.
Limit5UpperLimit RW - - Specifies the high limit for "Reserve5".
(Page 786)
Limit5UpperLimitColor RW - - Specifies the color for the "Reserve5" high limit.
(Page 787)
Limit5UpperLimitEna‐ RW - - Specifies whether the "Reserve5" high limit is moni‐
Limit5UpperLimitRela‐ RW - - Specifies whether the "Reserve5" high limit is eval‐
tive (Page 788) uated as a percentage or an absolute value.
LimitRangeCollection - - - -
LineEndShapeStyle RW - - Specifies the shape of the line ends.
(Page 790)
Location - - - -
MaximumValue RW RW RW Specifies the maximum value of the scale in the se‐
MinimumValue RW RW RW Specifies the minimum value of the scale in the se‐
Name - - - -
Precision (Page 874) RW - - Specifies the number of decimal places (0 to 20).
ProcessValue RW RW RW Specifies the default for the value to be displayed.
(Page 876)
ScaleColor (Page 895) RW RW RW Specifies the color of the scale of the selected ob‐
ject.
ScaleGradation RW RW RW Specifies the distance between two large tick marks
(Page 896) of the scale.
ScaleLabelFieldLength - - - -
ScaleLabelingDouble‐ - - - -
Lined
ScalePosition RW - - Specifies the position of the scale of the selected
(Page 898) object.
ScaleStart - - - -
ScalingType (Page 902) RW - - Specifies the type of bar scaling.
SegmentColoring RW RW RW Specifies the type of color change to be displayed if
(Page 906) the limits are exceeded.
ShowBadTagState RW - - Defines whether the object is grayed out when a bad
(Page 929) quality code or tag status is detected.
ShowLargeTicksOnly RW - - Specifies whether only large scale marks are
(Page 938) shown.
ShowLimitLines - - - -
ShowLimitMarkers RW - - Specifies whether the limit values are shown as a
(Page 939) scale value.

VB scripting

sional vanced
ShowLimitRanges - - - -
ShowProcessValue - - - -
ShowScale (Page 943) RW - - Specifies whether the values are also shown in a
scale.
ShowSignForPositive‐ - - - -
Label
ShowTickLabels - - - -
ShowTrendIndicator RW - - Specifies whether the trend (rising or falling) of the
(Page 953) measured value to be monitored is indicated by
means of a small arrow.
Size - - - -
StartValue (Page 961) RW - - Defines the absolute value of the zero point of the
scale indicator.
StyleItem - - - -
TabIndex - - - -
ToleranceLowerLimit RW - - Sets the low limit for tolerance 1.
(Page 1056)
ToleranceLowerLimit‐ RW - - Specifies the color for the low limit "ToleranceLo‐
Color (Page 1057) werLimit".
ToleranceLowerLimi‐ RW - - Specifies whether the "ToleranceLowerLimit" limit is
tEnabled (Page 1058) monitored.
ToleranceLowerLimi‐ RW - - Specifies whether the low limit "ToleranceLowerLi‐
tRelative (Page 1058) mit" is evaluated as a percentage or as an absolute
value.
ToleranceUpperLimit RW - - Sets the high limit for tolerance 1.
(Page 1059)
ToleranceUpperLimit‐ RW - - Specifies the color for the high limit "ToleranceUp‐
Color (Page 1059) perLimit".
ToleranceUpperLimi‐ RW - - Specifies whether the "ToleranceUpperLimit" limit is
tEnabled (Page 1060) monitored.
ToleranceUpperLimi‐ RW - - Specifies whether the high limit "ToleranceUpperLi‐
tRelative (Page 1061) mit" is to be evaluated as a percentage or as an
absolute value.
ToolTipText RW RW RW Specifies the tooltip text.
(Page 1084)
Top (Page 1085) RW RW RW Specifies the value of the Y coordinate of the selec‐
ted object.
Transparency RW - - Specifies the object transparency in percent.
(Page 1090)
TrendIndicatorColor RW - - Specifies the color for the trend view.
(Page 1103)
Unit (Page 1145) RW - - Specifies the unit of measurement.
UseAutoScaling - - - -
UseDesignColorSche‐ RW - - Specifies whether the colors defined in the global
ma (Page 1151) color scheme of the current design are to be used
for this object.

VB scripting

sional vanced
UseDesignShadowSet‐ RW - - Specifies whether the object is displayed with global
tings (Page 1152) shading.
UseExponentialFormat RW - - Specifies whether the numbers are displayed with
(Page 1155) exponentials (e.g. "1.00e+000").
Visible (Page 1207) RW RW RW Specifies whether the selected object is visible.
WarningLowerLimit RW - - Specifies the low limit for "WarningLowerLimit".
(Page 1212)
WarningLowerLimitCol‐ RW - - Specifies the color for the low limit "WarningLower‐
or (Page 1213) Limit".
WarningLowerLimitEna‐ RW - - Specifies whether the "WarningLowerLimit" limit is
WarningLowerLimitRe‐ RW - - Specifies whether the low limit "WarningLowerLimit"
lative (Page 1215) is evaluated as a percentage or as an absolute val‐
ue.
WarningUpperLimit RW - - Specifies the upper warning limit.
(Page 1217)
WarningUpperLimitCol‐ RW R R Specifies the color for the high limit "WarningUpper‐
or (Page 1218) Limit".
WarningUpperLimitEna‐ RW R R Specifies whether the high limit is to be monitored.
bled (Page 1219)
WarningUpperLimitRe‐ RW RW RW Specifies whether the high limit "WarningUpperLi‐
lative (Page 1219) mit" is to be evaluated as a percentage or as an
absolute value.
ZeroPoint (Page 1251) RW RW RW Specifies the position of the zero point as a percent‐
age of the bar height.
Table 1-8 Methods

sional vanced
Activate (Page 1253) Yes Yes Yes Enables the permanent area or the root screen.
time.

VB scripting
BatteryView (Panels, Comfort Panels, RT Advanced)
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Represents the "Charge condition" object. The BatteryView object is an element of the
ScreenItems list.

HMIBatteryView
Abbreviation Access in runtime

R Read
RW Read and write
- No access

sional vanced
Bounds - - - -
Height - - - -
Layer (Page 767) - - RW Specifies the layer in the screen that contains an ob‐
ject.
Left (Page 773) - - RW Specifies the value of the X coordinate.

VB scripting

sional vanced
Location - - - -
Name - - - -
Size - - - -
TabIndex - - - -
Top (Page 1085) - - RW Specifies the value of the Y coordinate.
Visible (Page 1207) - - RW Specifies whether the selected object is visible.
Width - - - -
Table 1-10 Methods

sional vanced
Activate (Page 1253) - - Yes Enables the permanent area or the root screen.
See also
Height (Page 723)
Width (Page 1220)
Button (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP

VB scripting
Represents the "Button" object. The Button object is an element of the ScreenItems list.
The availability of the following object properties depends on the selected mode of the "button":
Property "Text" mode "Text list" mode "Graphic" mode

TextOff x -- --
TextOn x -- --

HMIButton

R Read
RW Read and write
- No access

sional vanced
AdaptBorder RW - - Specifies whether the border of the object will be
(Page 501) dynamically adapted to the text size.
Authorization RW RW RW Specifies the operating rights of the selected object
(Page 520) in runtime.
BackColor (Page 529) RW RW RW Specifies the background color of the selected ob‐
ject.
BackFillStyle RW - - Specifies the fill pattern of the selected object.
(Page 534)
(Page 536)
(Page 537)
BackFlashingEnabled RW - - Specifies whether the background of the selected
(Page 538) object flashes in runtime.
BackFlashingRate RW - - Specifies the flash rate of the background for the
(Page 539) selected object.
BitNumber - - - -
(Page 561) line for the selected object.
BorderBrightColor3D RW - - Specifies the frame color of the following frame parts
(Page 564) in case of a 3D display of the selected object: Outer
border parts top and bottom; inner border parts bot‐
tom and right
BorderColor (Page 565) RW - - Specifies the line color of the object.
BorderFlashingColorOff RW - - Specifies the border line color of the selected object
(Page 569) for the flash state "Off".

VB scripting

sional vanced
BorderFlashingColorOn RW - - Specifies the border line color of the selected object
(Page 570) for the flash state "On".
BorderFlashingEnabled RW - - Specifies whether the border line of the selected ob‐
(Page 572) ject flashes in runtime.
BorderFlashingRate RW - - Specifies the flash rate of the border line for the se‐
BorderShadeColor3D RW - - Specifies the frame color of the following frame parts
(Page 578) in case of a 3D display of the selected object: Inner
border parts top and bottom; outer border parts bot‐
tom and right
BorderStyle (Page 579) RW - - Specifies the type of border lines for the selected
object.
BorderWidth (Page 580) RW - - Specifies the line thickness of the selected object.
BorderWidth3D RW - - Specifies the width of the inner border for the 3D
(Page 583) presentation of the selected object.
object.
DeviceStyle - - - -
der.
ated in runtime.
ES2RT_StoreAsCheck‐ - - - -
Back
FillingDirection RW - - Specifies the fill direction.
(Page 690)
(Page 688) object.
FirstGradientColor - - - -
FirstGradientOffset - - - -
FitToLargest - - - -
Flashing - - - -
FlashingColorOff RW - - Specifies the border line color of the selected object
FlashingColorOn RW - - Specifies the border line color of the selected object
FlashingEnabled RW - - Specifies whether the border line of the selected ob‐
FlashingRate RW - - Specifies the flash rate of the border line for the se‐
FocusColor (Page 706) - RW RW Specifies the color for the focus frame of the selected
object when it is in focus.

VB scripting

sional vanced
FocusWidth (Page 707) - RW RW Specifies the border width of the specified object
when the object is in focus.
Font - - - -
shown in bold.
FontItalic (Page 711) RW - - Specifies whether the text of the selected object is
shown in italics.
object.
FontUnderline RW - - Specifies whether the text of the selected object is
(Page 714) underlined.
object.
HelpText (Page 727) - RW RW Returns the tooltip that is shown in runtime as user
help for the specified object.
HorizontalAlignment RW RW RW Specifies the horizontal alignment of the text within
(Page 739) the selected object.
HorizontalPictureAlign‐ - - - -
ment
Hotkey - - - -
object.
ted object.
(Page 790)
Location - - - -
MiddleGradientColor - - - -
Mode (Page 827) RW - - Specifies the field type of the selected object.
Name - - - -
PictureAlignment RW - - Specifies the display type for the background screen
(Page 867) in the process image.
PictureAreaBottomMar‐ - - - -
gin
PictureAreaLeftMargin - - - -
PictureAreaRightMargin - - - -
PictureAreaTopMargin - - - -
PictureAutoSizing - - - -
PictureList - - - -
PictureOff (Page 869) RW - - Specifies the picture that is displayed in the "Off"
status.
PictureOn (Page 870) RW - - Specifies the screen to be displayed in the "On"
state.

VB scripting

sional vanced
Pressed (Page 875) RW - - Specifies whether the selected object is displayed in
a pressed state.
ProcessValue RW - - Specifies the default for the value to be displayed.
(Page 876)
RelativeFillLevel RW - - Specifies the fill percentage for the object.
(Page 883)
SecondGradientColor - - - -
SecondGradientOffset - - - -
ShowFillLevel RW - - Specifies whether the selected object is filled.
(Page 936)
Size - - - -
StyleItem - - - -
StyleSettings RW - - Specifies the style in which the object is displayed.
(Page 985)
TabIndex - - - -
TextAreaBottomMargin - - - -
TextAreaLeftMargin - - - -
TextAreaRightMargin - - - -
TextAreaTopMargin - - - -
TextList - - - -
TextOff (Page 1005) RW RW RW Specifies the text to be displayed in the "Off" state
of the selected object.
TextOn (Page 1005) - RW RW Specifies the text to be displayed in the "On" state
of the selected object.
TextOrientation RW - - Specifies the text orientation of the selected object.
(Page 1006)
Toggle (Page 1054) RW - - Specifies whether the selected object engages after
it has been operated in Runtime.
(Page 1084)
ted object.
(Page 1090)
TransparentColorPic‐ RW - - Specifies the color to be set to "transparent" for the
tureOff (Page 1092) "Off" state of the assigned bitmap object.
TransparentColorPictur‐ RW - - Specifies the color to be set to "transparent" for the
eOn (Page 1093) "On" state of the assigned bitmap object.
for this object.
UseDesignShadowSet‐ RW - - Specifies whether the object is displayed with the
tings (Page 1152) shading defined in the active design.
UseFirstGradient - - - -
UseSecondGradient - - - -

VB scripting

sional vanced
UseTransparentColor‐ RW - - Specifies if the transparent color defined in the
PictureOff (Page 1163) "TransparentColorPictureOff" property is used for
the "Off" state.
UseTransparentColor‐ RW - - Specifies if the transparent color defined in the
PictureOn (Page 1164) "TransparentColorPictureOff" property is used for
the "Off" state.
UseTwoHandOperation - - - -
VerticalAlignment RW RW RW Specifies the vertical alignment of the text for the
VerticalPictureAlign‐ - - - -
ment
WindowsStyle RW - - Specifies whether the object is displayed in the gen‐
(Page 1227) eral Windows style.
Table 1-12 Methods

sional vanced
time.

VB scripting
CameraControl (Panels, Comfort Panels, RT Advanced)
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Represents the "CameraControl" object. The CameraControl object is an element of the

ScreenItems list.

HMICameraControl

R Read
RW Read and write
- No access
Properties RT Pro‐ RT Ad‐ Panel RT Description

fessional vanced
AllTagTypesAl‐ - - - -
lowed
Bounds - - - -
CameraUrl - - - -
Height - - - -

VB scripting

fessional vanced
Layer (Page 767) - - RW Specifies the layer in the screen that con‐
tains an object.
Left (Page 773) - - R Returns the value of the X coordinate.
Location - - - -
MaintainAspectRa‐ - - - -
tio
MaintainOriginal‐ - - - -
Size
Name - - - -
Size - - - -
TabIndex - - - -
Top (Page 1085) - - R Returns the value of the Y coordinate.
UseUdp - - - -
Visible (Page 1207) - - R Returns whether the specified object is visi‐
ble.
Width - - - -
Table 1-14 Methods

sional vanced

VB scripting
ChannelDiagnose (RT Professional)
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Represents the "Channel diagnostics display" object. The ChannelDiagnose object is an

element of the ScreenItems list.

HMIChannelDiagnose

R Read
RW Read and write
- No access

sional vanced
Bounds - - - -
ated in runtime.
ject.

VB scripting

sional vanced
Location - - - -
Name - - - -
Size - - - -
TabIndex - - - -
Top (Page 1085) RW - - Specifies the value of the Y coordinate.
Table 1-16 Methods

sional vanced
time.
CheckBox (RT Professional)
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP

VB scripting
Represents the "Check box" object. The CheckBox object is an element of the ScreenItems
list.

HMICheckBox

R Read
RW Read and write
- No access

sional vanced
AdaptBorder RW - - Specifies whether the border of the object will be dy‐
(Page 501) namically adapted to the text size.
(Page 520)
BackColor (Page 529) RW - - Specifies the background color.
(Page 534)
(Page 536)
(Page 537)
(Page 538) time.
(Page 539)
(Page 561) line.
(Page 572) runtime.
(Page 573)
BorderWidth RW - - Specifies the line thickness.
(Page 580)
Bounds - - - -

VB scripting

sional vanced
CheckMarkAlignment RW - - Specifies whether the fields are right-aligned.
(Page 600)
CheckMarkCount RW - - Specifies the number of fields.
(Page 600)
CornerStyle (Page 638) RW - - Specifies the shape of the corners.
DrawInsideFrame RW - - Specifies whether the border line is to be shown with
(Page 658) a line thickness of greater than 1 within the border
or symmetrically to the border.
EdgeStyle (Page 660) RW - - Specifies the line style.
ated in runtime.
(Page 690)
FillPatternColor RW - - Specifies the color of the fill pattern.
(Page 688)
Flashing - - - -
FlashingColorOff RW - - Specifies the color of the border line for the flashing
FlashingColorOn RW - - Specifies the color of the border line for the flashing
FlashingEnabled RW - - Specifies whether flashing is activated for the object
FlashingRate RW - - Specifies the flash rate of the border line.
(Page 702)
Font - - - -
FontBold (Page 711) RW - - Specifies whether the text is shown in bold.
FontItalic (Page 711) RW - - Specifies whether the text is shown in italics.
FontName (Page 712) RW - - Specifies the font.
FontSize (Page 714) RW - - Specifies the font size of the text.
FontUnderline RW - - Specifies whether the text is shown underlined.
(Page 714)
ForeColor (Page 715) RW - - Specifies the font color of the text.
HorizontalAlignment RW - - Specifies the horizontal alignment of the text.
(Page 739)
Index (Page 744) RW - - Specifies the index for the selected text field.
ject.
(Page 790)
Location - - - -
LogOperation RW - - Specifies whether, after operating this object, an
(Page 797) alarm is output to the alarm system.
Name - - - -

VB scripting

sional vanced
(Page 876)
(Page 883)
(Page 936)
Size - - - -
TabIndex - - - -
Text (Page 1003) RW - - Specifies the label for the text field.
TextHandles - - - -
TextOrientation RW - - Specifies the text orientation.
(Page 1006)
Texts - - - -
ToolTipText RW - - Specifies the tooltip text.
(Page 1084)
(Page 1090)
for this object.
VerticalAlignment RW - - Specifies the vertical alignment of the text in the
(Page 1203) specified object.
Table 1-18 Methods

sional vanced
time.

VB scripting
Circle (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Represents the "Circle" object. The Circle object is an element of the ScreenItems list.

HMICircle

R Read
RW Read and write
- No access

sional vanced
Authorization RW - - Specifies the operating rights in Runtime.
(Page 520)
BackFillStyle RW RW RW Specifies the fill pattern.
(Page 534)
(Page 561) line.
BorderColor (Page 565) RW RW RW Specifies the line color.

VB scripting

sional vanced
(Page 572) runtime.
(Page 573)
BorderWidth RW RW RW Specifies the line thickness.
(Page 580)
DeviceStyle - - - -
EdgeStyle (Page 660) RW RW RW Specifies the line style.
Enabled (Page 663) RW RW RW Specifies whether the object can be operated in run‐
time.
(Page 690)
(Page 688)
Flashing - - - -
(Page 702)
Height (Page 723) RW RW RW Specifies the height.
Layer (Page 767) RW RW RW Specifies the layer in the screen that contains an ob‐
ject.
Left (Page 773) RW RW RW Specifies the value of the X coordinate.
(Page 790)
Location - - - -
Name - - - -
Radius (Page 879) RW RW RW Specifies the radius.
RadiusHeight - - - -
RadiusWidth - - - -
(Page 883)

VB scripting

sional vanced
ShowFillLevel RW - - Specifies whether the object is filled.
(Page 936)
Size - - - -
StyleItem - - - -
TabIndex - - - -
(Page 1084)
Top (Page 1085) RW RW RW Specifies the value of the Y coordinate.
(Page 1090)
for this object.
Visible (Page 1207) RW RW RW Specifies whether the object is visible.
Width (Page 1220) RW RW RW Specifies the width of the object in pixels.
Table 1-20 Methods

sional vanced
time.

VB scripting
CircleSegment (RT Professional)
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Represents the "CircleSegment" object. The CircleSegment object is an element of the

ScreenItems list.

HMICircleSegment

R Read
RW Read and write
- No access

sional vanced
(Page 520)
(Page 534)
(Page 561) line.

VB scripting

sional vanced
(Page 572) runtime.
(Page 573)
(Page 580)
Bounds - - - -
ated in runtime.
EndAngle (Page 669) RW - - Specifies the angle by which the end point deviates
from the zero position (0°).
(Page 690)
(Page 688)
Flashing - - - -
(Page 702)
ject.
(Page 790)
Location - - - -
Name - - - -
Radius (Page 879) RW - - Specifies the radius.

VB scripting

sional vanced
(Page 883)
(Page 936)
Size - - - -
StartAngle (Page 959) RW - - Specifies the angle by which the start point deviates
TabIndex - - - -
(Page 1084)
(Page 1090)
for this object.
Table 1-22 Methods

sional vanced
time.

VB scripting
CircularArc (RT Professional)
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Represents the "CircularArc" object. The CircularArc object is an element of the ScreenItems
list.

HMICircularArc

R Read
RW Read and write
- No access

sional vanced
(Page 520)
Bounds - - - -

VB scripting

sional vanced
Color (Page 603) RW - - Specifies the line color.
ated in runtime.
Flashing - - - -
(Page 702)
ject.
(Page 790)
LineWidth (Page 793) RW - - Specifies the line thickness.
Location - - - -
Name - - - -
Radius (Page 879) RW - - Specifies the radius.
Size - - - -
Style (Page 984) RW - - Specifies the line style.
TabIndex - - - -
(Page 1084)
(Page 1090)
for this object.

VB scripting
Table 1-24 Methods

sional vanced
time.
Clock (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Represents the "Clock" object. The Clock object is an element of the ScreenItems list.

Clock

R Read
RW Read and write
- No access

VB scripting

sional vanced
Analog (Page 513) RW - - Specifies whether the clock is displayed as an ana‐
log clock.
(Page 534)
BorderColor - - - -
BorderWidth - - - -
Bounds - - - -
DeviceStyle - - - -
DialColor (Page 652) RW RW RW Specifies the color of the dial for the selected object.
EdgeStyle - - - -
ated in runtime.
Flashing (Page 695) RW - - Specifies whether the selected object flashes in run‐
time.
HourNeedleHeight RW RW RW Specifies the length of the hour hand in the "Clock"
(Page 742) object.
HourNeedleWidth RW RW RW Specifies the width of the hour hand in the "Clock"
(Page 743) object.
object.
Left (Page 773) RW RW RW Specifies the value of the X coordinate of the object.
Location - - - -
LockSquaredExtent RW - - Specifies whether the size of the clock can be ad‐
(Page 796) justed with the mouse.
MinuteNeedleHeight RW RW RW Specifies the length of the minute hand in the "Clock"
(Page 826) object.
MinuteNeedleWidth RW RW RW Specifies the width of the minute hand in the "Clock"
(Page 826) object.
Name RW - - Specifies the object name.
NeedleBorderColor RW RW RW Specifies the line color of the pointer in the "Clock"
(Page 834) object.
NeedleColor RW RW RW Specifies the hand color in the "Clock" object.
(Page 835)
NeedleFillStyle RW - - Specifies whether the pointers are displayed as filled
(Page 836) or transparent.
NumberStyle - - - -

VB scripting

sional vanced
Picture (Page 867) RW - - Specifies the screen to be displayed in the graphics
object in Runtime.
SecondNeedleHeight RW RW RW Specifies the length of the seconds hand in the
(Page 905) "Clock" object.
SecondNeedleWidth RW RW RW Specifies the width of the seconds hand in the
(Page 906) "Clock" object.
ShowFocusRectangle RW - - Specifies whether the button is given a selection
(Page 937) border when it is activated in Runtime.
ShowTicks (Page 949) RW RW RW Specifies whether the marking lengths are shown in
the scale of the selected object.
Size - - - -
StyleItem - - - -
TabIndex - - - -
TickDistance - - - -
TicksColor (Page 1010) RW RW RW Specifies the color of the hour markers on the face
of the "Clock" object.
TickStyle - - - -
ted object.
(Page 1090)
for this object.
Table 1-26 Methods

sional vanced
time.

VB scripting
ComboBox (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Represents the "Check box" object. The ComboBox object is an element of the ScreenItems
list.

HMIComboBox

R Read
RW Read and write
- No access

sional vanced
AskOperationMotive RW - - Specifies whether the reason for operating this ob‐
(Page 517) ject is logged.
(Page 520)
(Page 534)

VB scripting

sional vanced
(Page 561) line.
(Page 580)
Bounds - - - -
CountVisibleItems RW - - Specifies how many lines the drop-down list is to
(Page 641) contain.
ated in runtime.
Font - - - -
(Page 714)
(Page 739)
ject.
(Page 790)
Location - - - -
Name - - - -
SelectedIndex RW - - Specifies the index of which the associated text is
(Page 911) highlighted in the combo box or list box.
SelectedText RW - - Specifies the text for the entry referenced with "Se‐
(Page 913) lectedIndex".
Size - - - -
TabIndex - - - -

VB scripting

sional vanced
TextHandles - - - -
Texts - - - -
(Page 1084)
(Page 1090)
for this object.
Table 1-28 Methods

sional vanced
Activate Yes - - Enables the permanent area or the root screen.
time.

VB scripting
Connector (RT Professional)
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Represents the "Connector" object. The Connector object is an element of the ScreenItems
list.

HMIConnector

R Read
RW Read and write
- No access

sional vanced
(Page 520)
BorderEndStyle RW - - Specifies the type of line ends.
(Page 568)
Bounds - - - -

VB scripting

sional vanced
ConnectionType RW - - Specifies the type of connector.
(Page 634)
DeviceStyle - - - -
ated in runtime.
EndStyle (Page 670) RW - - Specifies how the line end is displayed.
FirstConnectedObject - - - -
FirstConnectedObjec‐ RW - - Specifies the index number of the upper connector
tIndex (Page 692) point.
FirstConnectedObject‐ RW - - Specifies the name of the object that is docked to the
Name (Page 693) upper connector point.
Flashing - - - -
(Page 702)
LastConnectedObject - - - -
LastConnectedObjec‐ RW - - Specifies the index number of the connection point
tIndex (Page 765) to the last connected object.
LastConnectedObject‐ RW - - Specifies the name of the object that is docked to the
Name (Page 765) lower connector point.
ject.
(Page 790)
Location - - - -
Name - - - -
NoHitTest - - - -
Points - - - -
PointsCount - - - -
Size - - - -
StartStyle (Page 960) RW - - Specifies how the line start is displayed.
SwapFirstWithLastCon‐ RW - - Specifies that the first and last connection should be
nection (Page 986) swapped.

VB scripting

sional vanced
TabIndex - - - -
(Page 1084)
(Page 1090)
for this object.
Table 1-30 Methods

sional vanced
time.

VB scripting
DateTimeField (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Represents the "Date/time field" object. The DateTimeField object is an element of the
ScreenItems list.

HMIDateTimeField

R Read
RW Read and write
- No access

sional vanced
Authorization - RW RW Specifies operating rights.
(Page 520)
BackColor (Page 529) - RW RW Specifies the background color.
BackFillStyle - - - -
BorderColor (Page 565) - RW RW Specifies the line color.

VB scripting

sional vanced
BorderWidth - - - -
BottomMargin - - - -
Bounds - - - -
DeviceStyle - - - -
DisplayCentury - - - -
DisplaySystemTime - - - -
EdgeStyle - - - -
ated in runtime.
Flashing - - - -
Font - - - -
ForeColor (Page 715) - RW RW Specifies the font color of the text.
Format - - - -
Height - - - -
HelpText (Page 727) - RW RW Specifies the tooltip that is shown in Runtime as user
HorizontalAlignment - RW RW Specifies the horizontal alignment of the text.
(Page 739)
Layer (Page 767) - RW RW Specifies the layer in the screen that contains an ob‐
ject.
LeftMargin - - - -
LineWrap - - - -
Location - - - -
LongDateTimeFormat - - - -
Mode - - - -
Name - - - -
ProcessValue - - - -
RightMargin - - - -
ShowDate - - - -
ShowTime - - - -
Size - - - -
StyleItem - - - -
TabIndex - - - -
TextOrientation - - - -
TimeDisplayMode - - - -
TopMargin - - - -

VB scripting

sional vanced
ma
VerticalAlignment - RW RW Specifies the vertical alignment of the text in the
Width - - - -
Table 1-32 Methods

sional vanced
DiskSpaceView (RT Professional)
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Represents the "Memory space view" object. The DiskSpaceView object is an element of the
ScreenItems list.

VB scripting

IXDiskSpaceView

R Read
RW Read and write
- No access

sional vanced
Alarm - - - -
AlarmColor - - - -
Bounds - - - -
Drive - - - -
ated in runtime.
Free - - - -
FreePercent (Page 718) R - - Returns the measured values for the free disk space
as a percentage.
Interval (Page 752) R - - Returns the time interval for updating the displayed
measured values.
ject.
Location - - - -
Name (Page 830) R - - Returns the name.
NormalColor (Page 837) R - - Returns the color of the used memory space in the
memory space view when memory availability is not
critical.
Size - - - -
TabIndex (Page 987) R - - Returns the position in the order that the object takes
when you toggle between the objects with the tab
key.
TabIndexAlpha R - - Returns the position in the order that the object takes
(Page 988) when you toggle between the objects with the tab
key in Alpha Cursor mode.
Tolerance (Page 1055) R - - Returns the limit for the memory space view as of
which a deviation will be reported.
ToleranceColor R - - Returns the colors in which the bar of the memory
(Page 1055) space view is displayed as soon as the tolerance
range is exceeded.
Total (Page 1089) R - - Returns the storage capacity.

VB scripting

sional vanced
Used (Page 1150) R - - Returns the amount of used memory space.
UsedPercent R - - Returns the measured values for the occupied mem‐
(Page 1155) ory space as a percentage.
Warning (Page 1211) R - - Returns the percentage of occupied memory space
as of which a warning is generated.
WarningColor R - - Returns the color in which the bar of the memory
(Page 1212) space view is displayed as soon as the warning
range is reached.
Table 1-33 Methods

sional vanced
time.
Ellipse (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP

VB scripting
Represents the "Ellipse" object. The Ellipse object is an element of the ScreenItems list.

HMIEllipse

R Read
RW Read and write
- No access

sional vanced
Authorization RW - - Specifies the operating rights of the selected object
ject.
BackFillStyle RW RW RW Specifies the fill pattern of the selected object.
(Page 534)
BorderColor (Page 565) RW RW RW Specifies the line color of the selected object.
object.
BorderWidth (Page 580) RW RW RW Specifies the line thickness of the selected object.
Bounds - - - -
object.
DeviceStyle - - - -
der.

VB scripting

sional vanced
EdgeStyle (Page 660) RW RW RW Specifies the line style of the selected object.
ated in runtime.
(Page 690)
(Page 688) object.
Flashing - - - -
Height (Page 723) RW RW RW Specifies the height of the selected object.
object.
ted object.
(Page 790)
Location - - - -
Name - - - -
RadiusHeight RW RW RW Specifies the secondary axis of the specified object.
(Page 879)
RadiusWidth RW RW RW Specifies the main axis of the specified object.
(Page 880)
(Page 883)
(Page 936)
Size - - - -
StyleItem - - - -
TabIndex - - - -
(Page 1084)
ted object.
(Page 1090)
for this object.

VB scripting

sional vanced
Table 1-35 Methods
Method RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
time.
EllipseSegment (RT Professional)
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Represents the "EllipseSegment" object. The EllipseSegment object is an element of the

ScreenItems list.

VB scripting

HMIEllipseSegment

R Read
RW Read and write
- No access

sional vanced
(Page 520)
(Page 534)
(Page 561) line.
(Page 572) runtime.
(Page 573)
(Page 580)
Bounds - - - -
ated in runtime.
(Page 690)

VB scripting

sional vanced
(Page 688)
Flashing - - - -
(Page 702)
ject.
(Page 790)
Location - - - -
Name - - - -
RadiusHeight RW - - Specifies the secondary axis.
(Page 879)
RadiusWidth RW - - Specifies the main axis.
(Page 880)
(Page 883)
(Page 936)
Size - - - -
TabIndex - - - -
(Page 1084)
(Page 1090)
for this object.

VB scripting
Table 1-37 Methods

sional vanced
time.
EllipticalArc (RT Professional)
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Represents the "EllipticalArc" object. The EllipticalArc object is an element of the ScreenItems
list.

HMIEllipticalArc

R Read
RW Read and write
- No access

VB scripting

sional vanced
(Page 520)
Bounds - - - -
ated in runtime.
Flashing - - - -
(Page 702)
ject.
(Page 790)
Location - - - -
Name - - - -
(Page 879)
(Page 880)
Size - - - -

VB scripting

sional vanced
TabIndex - - - -
(Page 1084)
(Page 1090)
for this object.
Table 1-39 Methods

sional vanced
time.

VB scripting
FunctionTrendControl (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Represents the "f(x)FunctionTrendView" object. The FunctionTrendControl object is an


HMIFunctionTrendControl

R Read
RW Read and write
- No access

sional vanced
ForDesignMode
AvailableStatusbarEle‐ - - - -
ments
AvailableToolbarBut‐ - - - -
tons

VB scripting

sional vanced
BorderWidth (Page 580) RW - - Specifies the line thickness.
Bounds - - - -
Caption (Page 590) RW - - Specifies the text to be displayed in the header.
Closeable (Page 602) RW - -
ConnectTrendWindows RW - - Specifies whether the configured trend views are
(Page 635) connected.
ControlDesignMode RW - - Specifies the control design.
(Page 637)
ated in runtime.
ExportFileExtension RW - - Specifies the file extension of the export file.
(Page 678)
ExportFormatName RW - - Specifies the export file format.
(Page 682)
(Page 683) ted.
(Page 684) runtime.
GraphDirection RW - - Specifies at which border of the trend view the cur‐
(Page 720) rent values are displayed.
Height (Page 723) RW - - -
ject.
LoadDataImmediately RW - - Specifies whether the tag values are downloaded
(Page 795) from the logs for the time range to be displayed when
you call a screen.

VB scripting

sional vanced
Location - - - -
Moveable (Page 828) RW - - Specifies whether the object can be moved in run‐
time.
Name - - - -
Object - - - -
OcxGuid - - - -
OcxState - - - -
Online (Page 842) RW - - Specifies start and stop of the updating.
editor.
RTPersistence RW - - Specifies whether online configurations are retained
(Page 890) after a screen change.
ShowRuler (Page 941) RW - - Specifies whether a scale division (help line) is dis‐
played for an axis label of the object "OnlineTrend‐
Control".
ShowRulerInAxis RW - - Specifies whether rulers are also displayed in the
(Page 942) time axes.
ShowScrollbars RW - - Specifies whether scroll bars are displayed.
(Page 943)
ShowTitle (Page 950) RW - - Specifies the style of the window border and window
title for the object.
ShowTrendIcon RW - - Specifies whether an icon is displayed below the val‐
(Page 952) ue axes.
Size - - - -
in runtime.
(Page 962)
(Page 963)
StatusbarElementAuto‐ RW - - Specifies whether the width of a status bar element
Size (Page 964) referenced with "StatusbarElementIndex" is set au‐
tomatically.
StatusbarElement‐ RW - - Specifies the number of configured status bar ele‐
StatusbarElementIco‐ RW - - References a status bar element with its icon ID.
nId (Page 966)
StatusbarElementID RW - - References a status bar element with its element ID.
(Page 966)
StatusbarElementIndex RW - - References a status bar element.
(Page 967)

VB scripting

sional vanced
StatusbarElement‐ RW - - Specifies the name of a status bar element refer‐
Name (Page 968) enced with "StatusbarElementIndex".
StatusbarElementRe‐ RW - - Removes the user-defined status bar element refer‐
move (Page 969) enced with its name.
StatusbarElementRe‐ RW - - Specifies the new name of a user-defined status bar
name (Page 970) element referenced with "StatusbarElementIndex".
StatusbarElementRe‐ RW - - Specifies the position of an element referenced with
pos (Page 971) "StatusbarElementIndex" in the status bar of the ob‐
ject.
StatusbarElementText RW - - Specifies the text of a user-defined status bar ele‐
(Page 972) ment referenced with "StatusbarElementIndex".
StatusbarElementTool‐ RW - - Specifies the text for the tooltip of a user-defined
tipText (Page 973) status bar element referenced with "StatusbarEle‐
mentIndex".
Defined (Page 973) added a status bar element referenced with "Status‐
barElementIndex" as a new user-defined element.
StatusbarElementVisi‐ RW - - Specifies whether the status bar element referenced
ble (Page 974) with "StatusbarElementIndex" is displayed in the ob‐
ject.
StatusbarElementWidth RW - - Specifies the width in pixels of a status bar element
(Page 975) referenced with "StatusbarElementIndex".
(Page 976)
(Page 977)
(Page 979)
(Page 980) played.
SupportsUserDefined‐ - - - -
ToolbarButtons
TabIndex - - - -
displayed.
(Page 1062)
(Page 1063)

VB scripting

sional vanced
ToolbarButtonAuthori‐ RW - - Specifies the authorization for the selected key func‐
(Page 1067)
ToolbarButtonCount RW - - Specifies the number of configured buttons in the
ToolbarButtonHotKey RW - - Specifies the hot key for the selected object button.
(Page 1070)
ToolbarButtonID RW - - References a button with its ID.
(Page 1070)
ToolbarButtonIndex RW - - References a button.
(Page 1071)
ToolbarButtonLocked RW - - Specifies whether the locked, pressed state of a
(Page 1072) user-defined button referenced with "ToolbarButto‐
nIndex" is displayed.
ToolbarButtonName RW - - Specifies the name of a user-defined button refer‐
(Page 1073) enced with "ToolbarButtonIndex".
ToolbarButtonRemove RW - - Removes a user-defined button referenced with its
(Page 1074) name.
ToolbarButtonRename RW - - Specifies the new name of a user-defined button ref‐
(Page 1075) erenced with "ToolbarButtonIndex".
ToolbarButtonRepos RW - - Specifies the position of a button referenced with
(Page 1076) "ToolbarButtonIndex" in the toolbar of the object.
ToolbarButtonVisible RW - - Specifies whether the button referenced with "Tool‐
(Page 1079) barButtonIndex" is displayed in the toolbar.
ToolbarUseHotKeys RW - - Specifies whether the hotkeys are activated for but‐
(Page 1082) tons in the toolbar.
(Page 1083) played.
Top (Page 1085) - R R Returns the value of the Y coordinate.
TrendActualize RW - - Specifies whether the selected trend is updated.
(Page 1094)

VB scripting

sional vanced
TrendAdd (Page 1094) RW - - Creates a new trend.
TrendBeginTime RW - - Defines the start time of the time range for data
(Page 1098) transfer to the selected trend.
TrendColor (Page 1098) RW - - Specifies the color of a referenced trend in the trend
view.
TrendCount RW - - Specifies the number of configured trends.
(Page 1099)
TrendEndTime RW - - Defines the end of the time range for data connec‐
(Page 1100) tions of a selected trend.
TrendExtendedColor‐ RW - - Specifies whether the point and fill colors of the trend
Set (Page 1100) are shown.
TrendFill (Page 1101) RW - - Specifies whether the area below the trend is shown
filled.
TrendFillColor RW - - Defines the fill color of the trend.
(Page 1102)
TrendIndex (Page 1103) RW - - References a configured trend.
TrendLabel (Page 1104) RW - - Defines the label text for a trend referenced with
"TrendIndex".
TrendLineStyle RW - - Specifies which line type is used for display of the
(Page 1105) trend.
TrendLineType RW - - Specifies how the trend is displayed.
(Page 1105)
TrendLineWidth RW - - Specifies the line thickness of the selected trend in
(Page 1106) pixels.
TrendLowerLimit RW - - Specifies the low limit of a tag that is displayed in the
(Page 1107) object as a trend.
TrendLowerLimitColor RW - - Specifies the color that marks trend values which are
(Page 1107) below the value of "TrendLowerLimit".
TrendLowerLimitColor‐ RW - - Specifies whether "TrendLowerLimitColor" is used
ing (Page 1108) to identify tag values which are less than the value
of "TrendLowerLimit".
TrendMeasurePoints RW - - Specifies the number of measurement points for vis‐
(Page 1109) ualization of the selected trend.
TrendName RW - - Specifies the name of a trend referenced with "Tren‐
(Page 1109) dIndex".
TrendPointColor RW - - Specifies the color of the dots on the reference trend.
(Page 1110)
TrendPointStyle RW - - Specifies how the trend points are displayed.
(Page 1111)
TrendPointWidth RW - - Specifies the point width in pixels.
(Page 1111)
TrendProvider RW - - Specifies the data source for a selected trend.
(Page 1112)
TrendProviderCLSID RW - - Specifies the provider CLSID of the data for a trend.
(Page 1113)
TrendRangeType RW - - Specifies the time range during which the selected
(Page 1113) trend is supplied with data.

VB scripting

sional vanced
TrendRemove RW - - Removes a trend referenced with its name.
(Page 1114)
TrendRename RW - - Specifies the new name of a trend referenced with
(Page 1115) "TrendIndex".
TrendRepos RW - - Specifies the position of a trend referenced with
(Page 1115) "TrendIndex" in the trend window of the object.
Trends - - - -
TrendSelectTagNameX RW - - Specifies that the dialog for selecting the tag name
(Page 1117) of the data source of the x-axis is displayed initially
in runtime.
TrendSelectTagNameY RW - - Specifies that the dialog for selecting the tag name
(Page 1117) for the data source of the Y axis is displayed initially
in runtime.
TrendTagNameX RW - - Specifies the name of the connected HMI tag or col‐
(Page 1118) umn for the X-axis.
TrendTagNameY RW - - Specifies the name of the connected HMI tag or col‐
(Page 1119) umn for the Y-axis.
TrendTimeRangeBase RW - - Specifies the time unit for calculating the time range.
(Page 1120)
TrendTimeRangeFac‐ RW - - Specifies the factor for determining the time interval
tor (Page 1121) for which the referenced trend is displayed.
TrendTrendWindow RW - - Specifies the trend window in which the selected
(Page 1121) trend is shown.
TrendUncertainColor RW - - Specifies the color for values of uncertain status.
(Page 1122)
TrendUncertainColor‐ RW - - Specifies that values of uncertain status are to be
ing (Page 1123) highlighted.
TrendUpperLimit RW - - Specifies the high limit of a tag that is displayed in
(Page 1123) the specified object as a trend.
TrendUpperLimitColor RW - - Specifies the color that marks trend values which are
(Page 1124) above the value of "TrendUpperLimit".
TrendUpperLimitColor‐ RW - - Specifies whether the selection frame is shown with
ing (Page 1125) the color defined by the system.
TrendVisible RW - - Specifies whether the trend referenced with "Tren‐
(Page 1127) dIndex" is displayed in the object.
TrendWindowAdd RW - - Creates a new trend view.
(Page 1127)
TrendWindowCoarse‐ RW - - Specifies if the grid lines for the main scale are dis‐
Grid (Page 1128) played.
TrendWindowCoarse‐ RW - - Specifies the color of the main grid for the referenced
GridColor (Page 1129) diagram in the object.
TrendWindowCount RW - - Specifies the number of configured trend diagrams
(Page 1129) in the trend view.
TrendWindowFineGrid RW - - Specifies whether grid lines are displayed for the
(Page 1130) secondary scaling.
TrendWindowFineGrid‐ RW - - Specifies the color of the secondary grid for the ref‐
Color (Page 1131) erenced diagram in the object.

VB scripting

sional vanced
TrendWindowFore‐ RW - - Specifies whether only the grid lines for the fore‐
groundTrendGrid ground trend are displayed in the selected trend win‐
(Page 1131) dow.
TrendWindowGridIn‐ RW - - Specifies whether the grid lines for the main scaling
TrendColor (Page 1132) are displayed in the trend color.
TrendWindowHorizon‐ RW - - Specifies whether the horizontal grid lines are
talGrid (Page 1133) shown.
TrendWindowIndex RW - - References a trend view.
(Page 1133)
TrendWindowName RW - - Specifies the name of a trend view referenced with
(Page 1134) "TrendWindowIndex".
TrendWindowRemove RW - - Removes a trend view referenced with its name.
(Page 1135)
TrendWindowRename RW - - Specifies the new name of a trend view referenced
(Page 1135) with "TrendWindowIndex".
TrendWindowRepos RW - - Specifies the position of a trend view referenced with
TrendWindowRulerCol‐ RW - - Specifies the color of the ruler.
or (Page 1136)
TrendWindowRulerLay‐ RW - - Specifies the display layer of the ruler in the trend
er (Page 1137) view.
TrendWindowRuler‐ RW - - Specifies the appearance of the ruler.
Style (Page 1138)
TrendWindowRuler‐ RW - - Specifies the thickness of the ruler in pixels.
Width (Page 1139)
TrendWindows - - - -
TrendWindowSpace‐ RW - - Specifies the range proportion of the referenced di‐
Portion (Page 1139) agram in the diagram area of the object.
TrendWindowVertical‐ RW - - Specifies whether the vertical grid lines are dis‐
TrendWindowVisible RW - - Specifies whether the trend view referenced with
(Page 1143) "TrendWindowIndex" is displayed.
TrendXAxis (Page 1143) RW - - Defines the x-axis to be used for the referenced
trend.
TrendYAxis (Page 1144) RW - - Defines the y-axis to be used for the referenced
trend.
UseTrendNameAsLa‐ RW - - Specifies whether the "Name" or "Label" property is
bel (Page 1164) used as a designation for the trend in runtime.
Visible (Page 1207) - R R Specifies whether the selected object is visible.
XAxes - - - -
XAxisAdd (Page 1228) RW - - Creates a new X-axis.
XAxisAlignment RW - - Specifies the alignment of the X-axis referenced with
(Page 1229) "XAxisIndex".
XAxisAutoPrecisions RW - - Specifies whether the number of decimal places for
(Page 1229) an X-axis referenced with "XAxisIndex" is set auto‐
matically.

VB scripting

sional vanced
XAxisAutoRange RW - - Specifies whether the value range of an X-axis ref‐
(Page 1230) erenced with "XAxisIndex" is calculated automatical‐
ly.
XAxisBeginValue RW - - Specifies the lower end of the value range of an X-
(Page 1231) axis referenced with "XAxisIndex".
XAxisColor (Page 1231) RW - - Specifies the color of an X-axis referenced with
"XAxisIndex".
XAxisCount RW - - Specifies the number of configured X-axes.
(Page 1232)
XAxisEndValue RW - - Specifies the upper end of the value range of an X-
XAxisExponentialFor‐ RW - - Specifies whether the values of an X-axis referenced
mat (Page 1233) with "XAxisIndex" are displayed in exponential nota‐
tion.
XAxisIndex (Page 1234) RW - - References an X-axis.
XAxisInTrendColor RW - - Specifies whether the color of the axis referenced
(Page 1234) with "XAxisIndex" corresponds to the trend color.
XAxisLabel (Page 1235) RW - - Specifies the label text for an X-axis referenced with
"XAxisIndex".
XAxisName RW - - Specifies the name of an X-axis referenced with
XAxisPrecisions RW - - Specifies the number of decimal places to be dis‐
(Page 1236) played for the values of an X-axis referenced with
"XAxisIndex".
XAxisRemove RW - - Removes an X-axis referenced with its name.
(Page 1237)
XAxisRename RW - - Specifies the new name of an X-axis referenced with
XAxisRepos RW - - For multiple X-axes, specifies the position of an X-
XAxisScalingType RW - - Specifies the type of scaling for the X-axis refer‐
(Page 1238) enced with "XAxisIndex".
XAxisTrendWindow RW - - Specifies the trend diagram in which the axis refer‐
(Page 1239) enced with "XAxisIndex" is displayed.
XAxisVisible RW - - Specifies whether the X-axis referenced with "XAxi‐
(Page 1239) sIndex" is displayed in the object.
YAxes - - - -
YAxisAdd (Page 1240) RW - - Creates a new Y-axis.
YAxisAlignment RW - - Specifies the alignment of the Y-axis referenced with
(Page 1241) "YAxisIndex".
YAxisAutoPrecisions RW - - Specifies whether the number of decimal places is
(Page 1241) specified automatically for a Y-axis referenced with
"YAxisIndex".
YAxisAutoRange RW - - Specifies whether the value range of a Y-axis refer‐
(Page 1242) enced with "YAxisIndex" is calculated automatically.
YAxisBeginValue RW - - Specifies the lower end of the value range of a Y-axis
(Page 1242) referenced with "YAxisIndex".

VB scripting

sional vanced
YAxisColor (Page 1243) RW - - Specifies the color of a Y-axis referenced with "YAx‐
isIndex".
YAxisCount RW - - Specifies the number of configured Y-axes.
(Page 1244)
YAxisEndValue RW - - Specifies the upper end of the value range of a Y-
(Page 1244) axis referenced with "YAxisIndex".
YAxisExponentialFor‐ RW - - Specifies whether the values of a Y-axis referenced
mat (Page 1245) with "YAxisIndex" are displayed in exponential nota‐
tion.
YAxisIndex (Page 1245) RW - - References a Y-axis.
YAxisInTrendColor RW - - Specifies whether the color of the axis referenced
(Page 1246) with "YAxisIndex" corresponds to the trend color.
YAxisLabel (Page 1247) RW - - Specifies the label text for a Y-axis referenced with
"YAxisIndex".
YAxisName RW - - Specifies the name of a Y-axis referenced with "YAx‐
(Page 1247) isIndex".
YAxisPrecisions RW - - Specifies the number of decimal places to be dis‐
(Page 1248) played for the values of a Y-axis referenced with
"YAxisIndex".
YAxisRemove RW - - Removes a Y-axis referenced with its name.
(Page 1248)
YAxisRename RW - - Specifies the new name of a Y-axis referenced with
(Page 1249) "YAxisIndex".
YAxisRepos RW R R For multiple Y-axes, specifies the position of a Y-axis
(Page 1249) referenced with "YAxisIndex".
YAxisScalingType RW R R Specifies the type of scaling for the Y-axis refer‐
(Page 1250) enced with "YAxisIndex".
YAxisTrendWindow RW R R Specifies the trend diagram in which the axis refer‐
(Page 1250) enced with "YAxisIndex" is displayed.
YAxisVisible RW R R Specifies whether the Y-axis referenced with "YAxi‐
(Page 1251) sIndex" is displayed in the object.
Table 1-41 Methods

sional vanced
control.
time.
the control.

VB scripting

sional vanced
GetStatusbarElement Yes - - Returns the element of the control status bar desig‐
(Page 1292) nated by name or index as "ICCAxStatusbarEle‐
ment" type.
GetToolbarButton Yes - - Returns the control toolbar button function designa‐
(Page 1300) ted by name or index as "ICCAxToolbarButton" type.
GetTrend (Page 1303) Yes - - Returns the f(t) or f(x) trend view trend designated
by name or index as "ICCAxTrend" or "ICCAxFunc‐
tionTrend" type.
GetTrendCollection Yes - - Returns the list of all trends of the f(t) or f(x) trend
(Page 1304) view as "ICCAxCollection" type.
GetTrendWindow Yes - - Returns the trend window object of the f(t) or f(x)
(Page 1305) trend view designated by name or index as "ICCAx‐
TrendWindow" type.
GetTrendWindowCol‐ Yes - - Returns the list of all trend window objects of the f(t)
lection (Page 1306) or f(x) trend views as "ICCAxCollection" type.
GetXAxis (Page 1312) Yes - - Returns the f(x) trend view X-axis object that is speci‐
fied by name or index as "ICCAxValueAxis" type.
GetXAxisCollection Yes - - Returns a list of all f(x) trend view X-axis objects as
(Page 1313) "ICCAxCollection" type.
GetYAxis (Page 1315) Yes - - Returns the f(x) trend view Y-axis object that is speci‐
fied by name or index as "ICCAxValueAxis" type.
GetYAxisCollection Yes - - Returns the list of all f(x) trend view Y-axis objects
(Page 1316) as "ICCAxCollection" type.
MoveAxis (Page 1321) Yes - - Executes the "Move axes area" button function of
the f(t) and f(x) trend views.
NextTrend (Page 1328) Yes - - Executes the "Next trend" button function of the f(t)
and f(x) trend views.
OneToOneView Yes - - Executes the "Original view" button function of the
(Page 1328) f(t) and f(x) trend views.
PreviousTrend Yes - - Executes the "Previous trend" button function of the
ShowTagSelection Yes - - Executes the "Select data connection" button func‐
(Page 1359) tion of the control.
ShowTimeSelection Yes - - Executes the "Select time range" button function of
(Page 1360) the control.
ShowTrendSelection Yes - - Executes the "Select trends" button function of the

VB scripting

sional vanced
StartStopUpdate Yes - - Executes the "Start" or "Stop" button function of the
(Page 1361) control.
ZoomArea (Page 1368) Yes - - Executes the "Zoom area" button function of the f(t)
ZoomInOut Yes - - Executes the "Zoom +/-" button function of the f(t)
(Page 1369) and f(x) trend views.
ZoomInOutX Yes - - Executes the "Zoom X axis +/-" button function of the
(Page 1370) f(x) trend view.
ZoomInOutY Yes - - Executes the "Zoom Y axis +/-" button function of the
(Page 1371) f(x) trend view.
ZoomMove Yes - - Executes the "Move trend area" button function of
Gauge (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Represents the "Gauge" object. The Gauge object is an element of the ScreenItems list.

VB scripting

HMIGauge

R Read
RW Read and write
- No access

sional vanced
AngleMax (Page 514) RW RW RW Specifies the angle of the scale end of the "Gauge"
object.
AngleMin (Page 514) RW RW RW Specifies the angle of the scale start of the "Gauge"
object.
(Page 534)
BackPicture (Page 541) RW - - Specifies the background graphic.
BackStyle (Page 541) RW - - Specifies the background style.
BorderColor - - - -
BorderInnerStyle3D RW - - Specifies the appearance of the inner part of the ob‐
(Page 575) ject border.
BorderOuterStyle3D RW - - Specifies the appearance of the outer part of the ob‐
BorderWidth3D RW - - Specifies the width of the inner border for 3D display.
(Page 583)
Bounds - - - -
CaptionColor - RW RW Specifies the color of the text to be displayed in the
(Page 592) title bar.
CaptionFont (Page 592) RW - - Specifies the character set for the caption.
CaptionText (Page 593) RW RW RW Specifies the text to be displayed in the header.
CaptionTop (Page 594) RW - - Specifies the distance between the instrument la‐
bels and the upper edge of the object.
CenterColor (Page 598) RW RW RW Specifies the color of the center point.
CenterSize (Page 598) RW - - Specifies the diameter of the scale center point.
DangerRangeColor RW RW RW Specifies the color of the danger range on the scale
(Page 643) of the "Gauge" object.

VB scripting

sional vanced
DangerRangeStart RW RW RW Specifies at which scale value the danger range of
(Page 644) the "Gauge" object will start.
DangerRangeVisible RW RW RW Specifies whether the danger range in the scale of
(Page 645) the "Gauge" object is to be displayed.
DeviceStyle - - - -
DialColor (Page 652) RW RW RW Specifies the color of the dial for the selected object.
DialFillStyle (Page 653) RW - - Specifies the type of background.
DialPicture (Page 653) RW - - Specifies a graphic for the dial.
DialSize (Page 654) RW - - Specifies the diameter of the scale in relation to the
smaller value of the geometry attributes "Width" and
"Height".
EdgeStyle (Page 660) - - - -
ated in runtime.
Flashing (Page 695) RW - - Specifies whether the selected object flashes in run‐
time.
Gradation (Page 719) RW RW RW Specifies the value difference between two main
marks of the "Gauge" object.
InnerDialColor - - - -
InnerDialInnerDistance - - - -
InnerDialOuterDistane - - - -
object.
Location - - - -
LockSquaredExtent RW - - Specifies whether the size of the clock can be ad‐
(Page 796) justed with the mouse.
Name (Page 830) RW - - Specifies the object name.
NeedleHeight - - - -
NormalRangeColor RW RW RW Specifies the color of the normal range on the scale
NormalRangeVisible RW RW RW Specifies whether the normal range in the scale of
(Page 838) the "Gauge" object is displayed.
PointerColor (Page 872) RW RW RW Specifies the pointer color of the "Gauge" object.
(Page 876)
ScaleLabelColor RW RW RW Specifies the color of the label for the scale marks
ScaleLabelFont RW - - Specifies the font for the scale label.
(Page 898)

VB scripting

sional vanced
ScaleTickColor RW RW RW Specifies the color of the scale gradation of the
(Page 899) "Gauge" object.
ScaleTickLabelPosition RW - - Specifies the diameter of the imaginary circle on
(Page 900) which the scale tick label is location.
ScaleTickLength RW - - Specifies the length of the main scale ticks.
(Page 900)
ScaleTickPosition RW - - Specifies the diameter of the assumed circle on
(Page 901) which the scale divisions are located.
ShowDecimalPoint RW - - Specifies whether the scale is labeled with decimal
(Page 931) figures (decimal point and one decimal place) or with
whole integers.
ShowInnerDial - - - -
ShowPeakValuePointer RW RW RW Specifies whether a slave pointer will be used for the
Size - - - -
StyleItem - - - -
TabIndex - - - -
(Page 1090)
UnitColor (Page 1145) RW RW RW Specifies the text color for the unit of measurement.
UnitFont (Page 1146) RW - - Specified the font of the unit of measurement.
UnitText (Page 1146) RW RW RW Specifies the text for the unit of measurement.
UnitTop (Page 1147) RW - - Specifies the distance from the unit of measurement
to the upper edge of the object.
for this object.
WarningRangeColor RW RW RW Specifies the color of the warning range on the scale
WarningRangeStart RW RW RW Specifies at which scale value the warning range of
(Page 1216) the "Gauge" object will start.
WarningRangeVisible RW RW RW Specifies whether the warning range in the scale of
(Page 1217) the "Gauge" object is to be displayed.

VB scripting
Table 1-43 Methods

sional vanced
time.
GraphicIOField (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Represents the "Graphic I/O field" object. The GraphicIOField object is an element of the
ScreenItems list.
The availability of the following object properties depends on the selected mode:
Property "Input" "Output" "Input/Output" "Two states"

BorderColor -- -- -- x
Enabled x -- x --
FocusColor x -- x --
FocusWidth x -- x --
HelpText x -- x --
TransparentColor x x x --
UseTransparent‐ x x x --
Color

VB scripting

HMIGraphicIOField

R Read
RW Read and write
- No access

sional vanced
AboveUpperLimitColor - - - -
AdaptPicture - - - -
Authorization RW RW RW Specifies operating rights.
(Page 520)
AutoSizing - - - -
BelowLowerLimitColor - - - -
BitNumber - - - -
(Page 561) line.
(Page 572) runtime.
BorderFlashingRate - - - -
(Page 580)
Bounds - - - -
ated in runtime.

VB scripting

sional vanced
Flashing - - - -
tion
(Page 702)
FlashTransparentColor RW - - Specifies the color of the bitmap object of a flashing
(Page 704) graphic that is set to "transparent".
ject has the focus.
focus.
IsImageMiddleAligned - - - -
ject.
(Page 790)
Location - - - -
Mode - - - -
Name - - - -
OnValue - - - -
PictureList - - - -
PictureOff (Page 869) RW - - Specifies the picture that is displayed in the "Off"
status.
PictureOn (Page 870) RW - - Specifies the graphic that is displayed in the "On"
status.
PictureRotation - - - -
(Page 876)
ScrollBarOrientation - - - -
ShowScrollBar - - - -
Size - - - -
TabIndex - - - -
(Page 1084)
(Page 1090)

VB scripting

sional vanced
TransparentColor RW RW RW Specifies which color of the allocated graphic
(Page 1091) (*.bmp, *dib) is to be set to "transparent".
UseFlashTransparent‐ RW - - Specifies whether the color of the bitmap object of a
Color (Page 1156) flashing graphic is set to "transparent".
UseTransparentColor RW RW RW Specifies whether the color defined with the "Trans‐
(Page 1162) parentColor" property is shown as transparent.
Table 1-45 Methods

sional vanced
time.
GraphicView (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP

VB scripting
Represents the "Graphic view" object. The GraphicView object is an element of the
ScreenItems list.

HMIGraphicView

R Read
RW Read and write
- No access

sional vanced
AdaptPicture - - - -
(Page 520)
AutoSizing - - - -
(Page 534)
(Page 536)
(Page 537)
(Page 538) time.
(Page 539)
(Page 561) line.
(Page 572) runtime.
(Page 573)
(Page 580)
Bounds - - - -

VB scripting

sional vanced
Enabled (Page 663) RW RW RW Specifies whether the object can be operated in run‐
time.
(Page 690)
(Page 688)
Flashing - - - -
IsImageMiddleAligned - - - -
ject.
(Page 790)
Location - - - -
Name - - - -
Picture (Page 867) RW - - Specifies the screen from the WinCC project graph‐
ics to be displayed in the object in runtime.
PictureRotation - - - -
(Page 883)
ShowFillLevel RW - - Specifies whether the object is filled.
(Page 936)
Size - - - -
TabIndex - - - -
(Page 1084)
(Page 1090)
TransparentColor RW RW RW Specifies which color of the allocated graphic
(Page 1091) (*.bmp, *dib) is to be set to "transparent".
for this object.

VB scripting

sional vanced
UseTransparentColor RW RW RW Specifies whether the color defined with the "Trans‐
(Page 1162) parentColor" property is shown as transparent.
Table 1-47 Methods

sional vanced
time.
HTMLBrowser (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Represents the object "HTML Browser". The HTMLBrowser object is an element of the
ScreenItems-list.

VB scripting

HMIHTMLBrowser

R Read
RW Read and write
- No access

sional vanced
Address (Page 503) RW RW RW Specifies the web address that will be opened in the
HTML browser.
AddressEnabled - - - -
Bounds - - - -
BrowserTypeUsed - - - -
ated in runtime.
Flashing - - - -
ject.
Location - - - -
Name - - - -
ShowStatusBar RW - - Specifies whether the status bar is shown.
(Page 947)
ShowToolBar - - - -
Size - - - -
TabIndex - - - -

VB scripting
Table 1-49 Methods

sional vanced
time.
SetHtml (Page 1347) Yes - - Writes a HTML code in the display range of the
HTML browser.
See also
SetHTML (Page 1347)
IOField (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Represents the "I/O field" object. The IOField object is an element of the ScreenItems list.

VB scripting

HMIIOField

R Read
RW Read and write
- No access

sional vanced
AboveUpperLimitColor RW - - Sets the color of the specified object for the "High
(Page 493) limit violated" event.
AcceptOnExit RW - - Specifies whether the input field is confirmed auto‐
(Page 494) matically when it is left.
AcceptOnFull RW - - Specifies whether the input field will be left and con‐
(Page 494) firmed automatically when the defined number of
values has been entered.
ject.
(Page 534)
(Page 536)
(Page 537)
BelowLowerLimitColor RW - - Specifies the color for the "Low limit violated" event.
(Page 548)
BorderColor - - - -

VB scripting

sional vanced
object.
(Page 580)
ClearOnError RW - - Specifies whether an invalid input in this object is
(Page 601) deleted automatically.
ClearOnFocus RW - - Specifies whether the field entry is deleted as soon
(Page 601) as the I/O field is activated.
object.
CursorControl RW - - Specifies whether the mouse cursor jumps to the
(Page 642) next field of the TAB sequence after leaving a field.
DataFormat (Page 645) RW - - Specifies the display format of an I/O field.
DeviceStyle - - - -
EditOnFocus RW - - Specifies whether data input is immediately possible
(Page 662) if the input field is selected using the <Tab> key.
ated in runtime.
FieldLength - - - -
(Page 688) object.
Flashing - - - -
tion
Font - - - -
shown in bold.

VB scripting

sional vanced
shown in italics.
object.
object.
FormatPattern RW - - Specifies the format of the output value.
(Page 717)
HiddenInput (Page 728) RW - - Specifies whether the input value or a * for each
character is shown during the input.
HorizontalAlignment RW RW RW Specifies the horizontal alignment of the text within
InputValue (Page 750) RW - - Specifies the input value.
object.
ted object.
LeftMargin - - - -
(Page 790)
LineWrap - - - -
Location - - - -
LowerLimit (Page 798) RW - - Specifies the low limit for input values.
Mode (Page 827) RW - - Specifies the field type of the selected object.
Name - - - -
(Page 876)
RightMargin - - - -
ShiftDecimalPoint - - - -
ShowLeadingZeros - - - -
Size - - - -
StyleItem - - - -
TabIndex - - - -

VB scripting

sional vanced
TextOrientation RW - - Specifies the text orientation of the selected object.
(Page 1006)
(Page 1084)
Top (Page 1085) RW RW RW Specifies the value of the Y coordinate of the object.
TopMargin - - - -
(Page 1090)
Unit (Page 1145) RW - - Specifies the unit of measurement.
UpperLimit (Page 1148) RW - - Specifies the high limit for input values.
for this object.
UseTagLimitColors RW - - Specifies whether the violation of the configured
(Page 1162) high and low limits for the object are highlighted in
color.
UseTwoHandOperation - R R Returns whether two-hand operation is enabled.
(Page 1165)
VerticalAlignment RW RW RW Specifies the vertical alignment of the text in the
Table 1-51 Methods

sional vanced
time.
See also
BorderColor (Page 565)

VB scripting
1.5.4.3 Objects K-Z (Panels, Comfort Panels, RT Advanced, RT Professional)
Line (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Represents the "Line" object. The Line object is an element of the ScreenItems list.

HMILine

R Read
RW Read and write
- No access

sional vanced
ActualPointIndex - - - -
ActualPointLeft - - - -
ActualPointTop - - - -

VB scripting

sional vanced
ject.
BorderEndStyle RW - - Specifies the type of line ends for the selected ob‐
(Page 568) ject.
object.
Bounds - - - -
Color (Page 603) RW RW RW Specifies the line color of the selected object.
CornerStyle (Page 638) RW - - Specifies the shape of the corners of the selected
object.
DeviceStyle - - - -
ated in runtime.
EndLeft - - - -
EndStyle (Page 670) RW RW RW Specifies how the line end of the selected object is
displayed.
EndTop - - - -
FillStyle (Page 690) - RW RW Specifies the fill pattern of the selected object.
Flashing - - - -
object.
ted object.
LineEndShapeStyle RW - - Specifies the shape of the line end.
(Page 790)
LineWidth (Page 793) RW RW RW Specifies the line thickness of the selected object.
Location - - - -
Name - - - -
Points - - - -
PointsCount - - - -
RotationAngle RW - - Specifies the angle of rotation in degrees.
(Page 885)
RotationCenterLeft RW - - Specifies the X coordinate of the pivot point for the
(Page 886) object in runtime.

VB scripting

sional vanced
RotationCenterTop RW - - Specifies the Y coordinate of the pivot point for the
Size - - - -
StartLeft - - - -
StartStyle (Page 960) RW RW RW Specifies how the line start of the selected object is
displayed.
StartTop - - - -
Style (Page 984) RW RW RW Specifies the line style of the selected object.
StyleItem - - - -
TabIndex - - - -
(Page 1084)
ted object.
(Page 1090)
for this object.
Table 1-53 Methods

sional vanced
time.

VB scripting
Listbox (RT Professional)
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Represents the "Listbox" object. The Listbox object is an element of the ScreenItems list.

HMIListBox
Application
In the following example, the object with the name "ListBox1" is moved 10 pixels to the right:
'VBS21
Dim objListBox
Set objListBox = ScreenItems("ListBox1")
objListBox.Left = objListBox.Left + 10

R Read
RW Read and write
- No access

VB scripting

sional vanced
(Page 520)
BackFillStyle (Page 534) RW - - Specifies the fill pattern.
(Page 561) line.
Bounds - - - -
(Page 641) contain.
ated in runtime.
Font - - - -
(Page 714)
(Page 739)
ject.
(Page 790)
Location - - - -
Name - - - -

VB scripting

sional vanced
SelectedIndex RW - - Specifies the index of which the associated text is
(Page 911) highlighted in the combo box or list box.
SelectedText RW - - Specifies the text for the entry referenced with "Se‐
(Page 913) lectedIndex".
Size - - - -
TabIndex - - - -
TextHandles - - - -
Texts - - - -
(Page 1084)
(Page 1090)
for this object.
Table 1-54 Methods

sional vanced
time.

VB scripting
MediaPlayer (RT Professional)
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Represents the "Media Player" object. The MediaPlayer object is an element of the
ScreenItems list.

HMIMediaPlayer
Application
'VBS60
Dim objControl

R Read
RW Read and write
- No access

VB scripting

sional vanced
AspectRatio (Page 518) RW - - Specifies whether the aspect ratio of the media play‐
er is maintained when the size is changed.
AutoStart - - - -
Bounds - - - -
ated in runtime.
FileName (Page 686) RW - - Specifies the name of the file to be loaded.
ject.
Location - - - -
Name - - - -
PictureSizeMode RW - - Specifies the size adjustment between the media
(Page 871) player and the content to be displayed.
PlayCount - - - -
PlayEndless (Page 871) RW - - Specifies that the media file is to play endlessly.
PopupMenuEnabled - - - -
ShowControls RW - - Specifies that a toolbar is displayed.
(Page 930)
ShowFeatureBackward RW - - Specifies that the "Backward" button is to be dis‐
(Page 932) played in runtime.
ShowFeatureForward RW - - Specifies that the "Forward" button is displayed in
(Page 933) runtime.
ShowFeature‐ RW - - Specifies that the Media Player can be displayed as
FullScreen (Page 934) a full screen.
ShowFeatureFullVo‐ - - - -
lume
ShowFeaturePause RW - - Specifies that the "Pause" button is displayed in run‐
(Page 934) time.
ShowFeaturePlay RW - - Specifies that the "Play" button is displayed in run‐
(Page 935) time.
ShowFeatureStop RW - - Specifies that the "Stop" button is displayed in run‐
(Page 935) time.
ShowStatusBar - - - -
ShowTracker RW - - Specifies that the tracker is displayed.
(Page 951)
Size - - - -
StepSeconds RW - - Specifies the step interval in seconds after the "For‐
(Page 983) ward" or "Backward" key is pressed.

VB scripting

sional vanced
TabIndex - - - -
Table 1-56 Methods

sional vanced
Activate (Page 1253) Yes - Yes Enables the permanent area or the root screen.
time.
MultiLineEdit (RT Professional)
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Represents the "Editable text field" object. The MultiLineEdit object is an element of the
ScreenItems list.

VB scripting

HMIMultiLineEdit
Application
In the following example, the object with the name "MultiLineEdit1" is moved 10 pixels to the
right:
'VBS21
Dim objMultiLineEdit
Set objMultiLineEdit = ScreenItems("MultiLineEdit1")
objMultiLineEdit.Left = objMultiLineEdit.Left + 10

R Read
RW Read and write
- No access

sional vanced
(Page 520)
(Page 561) line.
Bounds - - - -
ated in runtime.
Font - - - -
FontName - - - -

VB scripting

sional vanced
(Page 714)
(Page 739)
ject.
(Page 790)
Location - - - -
Name - - - -
Size - - - -
TabIndex - - - -
(Page 1084)
(Page 1090)
for this object.
Table 1-58 Methods

sional vanced
time.
GetSelectionText Yes - - -
SetSelection Yes - - -
SetSelectionText Yes - - -

VB scripting
OnlineTableControl (RT Professional)
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Represents the "Table view" object. The OnlineTableControl object is an element of the
ScreenItems list.

HMIOnlineTableControl

R Read
RW Read and write
- No access

sional vanced
ForDesignMode

VB scripting

sional vanced
Bounds - - - -
Caption - - - -
(Page 595)
(Page 596)
(Page 596)
(Page 597)
time.
(Page 619) columns.
ColumnScrollbar RW - - Specifies when the horizontal scroll bar is to be dis‐
(Page 620) played.
ColumnTitleAlignment RW - - Specifies the alignment of the title in a column refer‐
(Page 630) enced with "ColumnIndex".
(Page 631)
(Page 637)
Enabled (Page 663) - - - -
EnableEdit (Page 667) RW - - Specifies whether the data shown can be edited in
runtime.
(Page 678)

VB scripting

sional vanced
(Page 682)
(Page 683) ted.
(Page 684) runtime.
FillPattern - - - -
(Page 720)
(Page 722)
table cells.
Layer - - - -
LineStyle - - - -
you call a screen.
Location - - - -
MaximumNumberOfTi‐ - - - -
meColumns
MaximumNumberOfVa‐ - - - -
lueColumns
MinimumNumberOfTi‐ - - - -
meColumns
MinimumNumberOfVa‐ - - - -
lueColumns
time.
Name - - - -
Object - - - -
OcxGuid - - - -
OcxState - - - -

VB scripting

sional vanced
editor.
RowScrollbar RW - - Specifies when the vertical scroll bar is displayed.
(Page 888)
(Page 889)
RowTitles (Page 890) RW - - Specifies whether numbered column headers are
displayed.
(Page 908)
(Page 909)
(Page 911)
(Page 912)
(Page 914) header.
(Page 915)
(Page 917) or rows.
SelectionRect RW - - Enables the use of a selection border for selected
(Page 919) cells or rows.
(Page 919) alarm window.
(Page 921)
(Page 945)
(Page 945)
Size - - - -

VB scripting

sional vanced
in runtime.
SortSequence RW - - Specifies how the sorting order is changed if the op‐
(Page 957) erator clicks on the column header in runtime.
(Page 962)
(Page 963)
tomatically.
nId (Page 966)
(Page 966)
(Page 967)
ject.
mentIndex".
ject.
(Page 976)
(Page 977)

VB scripting

sional vanced
(Page 979)
(Page 980) played.
TabIndex - - - -
the object.
TableColor2 (Page 991) RW - - Specifies the second background color of the table
rows in the object.
(Page 993) object.
displayed.
TimeColumnActualize RW - - Specifies whether the values of the time column ref‐
(Page 1027) erenced with "TimeColumnIndex" are updated.
TimeColumnAdd RW - - Creates a new time column.
(Page 1028)
TimeColumnAlignment RW - - Specifies how the text in the time column referenced
(Page 1028) with "TimeColumnIndex" is aligned.
TimeColumnBackColor RW - - Specifies the background color of the time column
(Page 1029) referenced with "TimeColumnIndex".
TimeColumnBeginTime RW - - Specifies the start of the time range for the time col‐
(Page 1030) umn referenced with "TimeColumnIndex".
TimeColumnCaption RW - - Specifies the label of the time column referenced
(Page 1030) with "TimeColumnIndex".
TimeColumnCount RW - - Specifies the number of configured time columns.
(Page 1031)
TimeColumnDateFor‐ RW - - Specifies the date format for displaying the time col‐
mat (Page 1031) umn referenced with "TimeColumnIndex".
TimeColumnEndTime RW - - Defines the end of the time range of for a time col‐
(Page 1032) umn referenced with "TimeColumnIndex".
TimeColumnForeColor RW - - Specifies the font color of the time column refer‐
(Page 1032) enced with "TimeColumnIndex".
TimeColumnHideText RW - - Specifies whether the content of the time column ref‐
(Page 1033) erenced with "TimeColumnIndex" is displayed as
text.
TimeColumnHideTitle‐ RW - - Specifies whether the header of the time column ref‐
Text (Page 1034) erenced with "TimeColumnIndex" is displayed as
text.
TimeColumnIndex RW - - References a configured time column.
(Page 1034)

VB scripting

sional vanced
TimeColumnLength RW - - Specifies the width of the time column referenced
TimeColumnMeasure‐ RW - - Specifies the number of measuring points to be dis‐
Points (Page 1035) played in the time column referenced with "TimeCo‐
lumnIndex".
TimeColumnName RW - - Specifies the name of a time column referenced with
(Page 1036) "TimeColumnIndex".
TimeColumnRange‐ RW - - Specifies the time range for a time column refer‐
Type (Page 1036) enced with "TimeColumnIndex".
TimeColumnRemove RW - - Removes a time column referenced with its name.
(Page 1037)
TimeColumnRename RW - - Specifies the new name of a time column referenced
TimeColumnRepos RW - - For multiple time columns with corresponding value
(Page 1038) columns, specifies the position of a time column ref‐
erenced with "TimeColumnIndex".
TimeColumns - - - -
TimeColumnShowDate RW - - Specifies whether the time column referenced with
(Page 1039) "TimeColumnIndex" is displayed with date and time.
TimeColumnShowIcon RW - - Specifies whether the content of the time column ref‐
(Page 1040) erenced with "TimeColumnIndex" is displayed as an
icon.
TimeColumnShowTitleI‐ RW - - Specifies whether the header of the time column ref‐
con (Page 1040) erenced with "TimeColumnIndex" is displayed as an
icon.
TimeColumnSort RW - - Specifies how a time column referenced with "Time‐
(Page 1041) ColumnIndex" is sorted.
TimeColumnSortIndex RW - - Specifies the sorting order of the time column refer‐
(Page 1041) enced in "TimeColumnIndex".
TimeColumnTimeFor‐ RW - - Specifies the time format for displaying the time col‐
mat (Page 1042) umn referenced with "TimeColumnIndex".
TimeColumnTimeRan‐ RW - - Specifies the time unit for calculating the time range
geBase (Page 1042) displayed in the time column referenced with "Time‐
ColumnIndex".
TimeColumnTimeRan‐ RW - - Specifies the factor for calculating the time range.
geFactor (Page 1043)
TimeColumnUseValue‐ RW - - Specifies whether the time column referenced with
ColumnColors "TimeColumnIndex" is displayed in the colors of the
(Page 1044) value column.
TimeColumnVisible RW - - Specifies whether the time column referenced with
(Page 1044) "TimeColumnIndex" is displayed in the table view.
TimeStepBase RW - - Specifies the time unit for the accuracy of the time
(Page 1046) stamp that is displayed in the table.
TimeStepFactor RW - - Specifies the time stamp accuracy with the "Time‐
(Page 1047) StepBase" time unit.

VB scripting

sional vanced
TitleStyle (Page 1054) RW - - Specifies whether to use a shading color for the text
in the column headers.
(Page 1062)
(Page 1063)
(Page 1067)
(Page 1070)
(Page 1070)
(Page 1071)
(Page 1074) name.

VB scripting

sional vanced
(Page 1083) played.
UseColumnBackColor RW - - Specifies the settings for the background color of the
(Page 1149) columns.
UseColumnForeColor RW - - Specifies the settings for the font color of the col‐
(Page 1149) umns.
ValueColumnAdd RW - - Creates a new value column.
(Page 1186)
ValueColumnAlignment RW - - Specifies how the text in the value column refer‐
(Page 1186) enced with "ValueColumnIndex" is aligned.
ValueColumnAutoPreci‐ RW - - Specifies whether the number of decimal places for
sions (Page 1187) a value axis referenced with "ValueColumnIndex" is
set automatically.
ValueColumnBackCol‐ RW - - Specifies the background color of the value column
or (Page 1188) referenced with "ValueColumnIndex".
ValueColumnCaption RW - - Specifies the name of the value column referenced
(Page 1188) with "ValueColumnIndex".
ValueColumnCount RW - - Specifies the number of configured value columns.
(Page 1189)
ValueColumnExponen‐ RW - - Specifies whether the values of a value column ref‐
tialFormat (Page 1189) erenced with "ValueColumnIndex" are displayed in
exponential notation.
ValueColumnForeColor RW - - Specifies the font color of the value column refer‐
(Page 1190) enced with "ValueColumnIndex".
ValueColumnHideText RW - - Specifies whether the text in the value column refer‐
(Page 1191) enced with "ValueColumnIndex" is hidden.
ValueColumnHideTitle‐ RW - - Specifies whether the text in the header of the value
Text (Page 1191) column referenced with "ValueColumnIndex" is hid‐
den.
ValueColumnIndex RW - - References a value column.
(Page 1192)

VB scripting

sional vanced
ValueColumnLength RW - - Specifies the width in characters of the value column
(Page 1192) referenced with "ValueColumnIndex".
ValueColumnName RW - - Specifies the name of a value column referenced
ValueColumnPreci‐ RW - - Specifies the number of decimal places for values in
sions (Page 1193) the value column referenced with "ValueColumnIn‐
dex".
ValueColumnProvider RW - - Specifies the data source for the value column ref‐
(Page 1194) erenced with "ValueColumnIndex".
ValueColumnProvi‐ RW - - Specifies the provider CLSID of the data for a value
derCLSID (Page 1195) column referenced with "ValueColumnIndex".
ValueColumnRemove RW - - Removes a value column referenced with its name.
(Page 1195)
ValueColumnRename RW - - Specifies the new name of a value column refer‐
(Page 1196) enced with "ValueColumnIndex".
ValueColumnRepos RW - - Specifies the position of a value column referenced
ValueColumns - - - -
ValueColumnSelect‐ RW - - Specifies that the dialog for selecting the tag name
TagName (Page 1197) of the data source for the value column referenced
with "ValueColumnIndex" is displayed in Runtime in‐
itial.
ValueColumnShowIcon RW - - Specifies whether an icon is displayed in the value
(Page 1198) column referenced with "ValueColumnIndex".
ValueColumnShowTi‐ RW - - Specifies whether an icon is displayed in the header
tleIcon (Page 1198) of the value column referenced with "ValueColum‐
nIndex".
ValueColumnSort RW - - Specifies the type of sorting for the value column
(Page 1199) referenced with "ValueColumnIndex" ".
ValueColumnSortIndex RW - - Specifies the sorting order.
(Page 1199)
ValueColumnTagName RW - - Specifies the names of the tags whose values are
(Page 1200) displayed in the value column referenced with "Val‐
ueColumnIndex".
ValueColumnTimeCol‐ RW - - Specifies the corresponding time column.
umn (Page 1200)
ValueColumnVisible RW - - Specifies whether the value column referenced with
(Page 1201) "ValueColumnIndex" is displayed in the object.
(Page 1204) played.

VB scripting
Table 1-59 Methods

sional vanced
control.
CalculateStatistic Yes - - Executes the "Calculate statistics" key function of
(Page 1260) the f(t) trend view and the table view.
time.
the control.
Edit (Page 1265) Yes - - Executes the "Edit" key function of the table view.
GetOperatorMessage Yes - - Returns the operator message object of the alarm
(Page 1275) view designated by name or index as "ICCAxOper‐
atorMessage" type.
GetOperatorMessage‐ Yes - - -
Collection
GetRow (Page 1277) Yes - - Returns the row object designated by its row number
in the table-based controls as "ICCAxDataRow" type.
tion.
ment" type.
GetTimeColumn Yes - - Returns the time column object of the table view
(Page 1298) designated by name or index as "ICCAxTimeCol‐
umn" type.
GetTimeColumnCollec‐ Yes - - Returns the list of all time column objects of the table
tion (Page 1299) view as "ICCAxCollection" type.

VB scripting

sional vanced
GetValueColumn Yes - - Returns the value column object of the f(t) trend view
(Page 1310) designated by name or index as "ICCAxValueCol‐
umn" type.
GetValueColumnCollec‐ Yes - - Returns the list of all value column objects of the f(t)
tion (Page 1311) trend view as "ICCAxCollection" type.
MoveToFirst Yes - - Executes the "First line" button function of the con‐
(Page 1321) trol.
MoveToLast Yes - - Executes the "Last data record" button function of
MoveToNext Yes - - Executes the "Next data record" button function of
MoveToPrevious Yes - - Executes the "Previous data record" button function
NextColumn Yes - - Executes the "Next column" button function of the
(Page 1327) table view.
PreviousColumn Yes - - Executes the "Previous column" button function of
(Page 1329) the table view.
SelectStatisticArea Yes - - Executes the "Set statistics range" button function of
(Page 1345) the table view.
ShowColumnSelection Yes - - Executes the "Select columns" button function of the
(Page 1349) table view.
ShowInsertValueDialog Yes - - -
StartStopUpdate Yes - - Executes the "Start" or "Stop" button function of the
(Page 1361) control.

VB scripting
OnlineTrendControl (RT Professional)
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Represents the "f(t) TrendView" object. The OnlineTrendControl object is an element of the
ScreenItems list.

HMIOnlineTrendControl

R Read
RW Read and write
- No access

sional vanced
ForDesignMode
Bounds - - - -

VB scripting

sional vanced
time.
ConnectTrendWindows RW - - Specifies whether the configured trend views are
(Page 635) connected.
(Page 637)
Enabled - - - -
ExportDirectoryChange‐ RW - - Specifies whether the directory for data export can
able (Page 677) be changed in runtime
(Page 678)
(Page 682)
(Page 683) ted.
(Page 684) runtime.
GraphDirection RW - - Specifies at which border of the trend view the cur‐
(Page 720) rent values are displayed.
Layer - - - -
you call a screen.
Location - - - -
MaximumNumberOfTi‐ - - - -
meAxes

VB scripting

sional vanced
MaximumNumberOfVa‐ - - - -
lueAxes
MinimumNumberOfTi‐ - - - -
meAxes
MinimumNumberOfVa‐ - - - -
lueAxes
time.
Name - - - -
Object - - - -
OcxGuid - - - -
OcxState - - - -
PercentageAxis RW - - Specifies that an additional axis with percentage
(Page 865) scaling is shown in the trend view.
PercentageAxisAlign‐ RW - - Specifies the alignment of the percentage axis.
ment (Page 865)
PercentageAxisColor RW - - Specifies the font and line color of the percentage
(Page 866) axis.
editor.
ShowRuler (Page 941) RW - - Specifies whether a scale division (help line) is dis‐
played for the axis label.
ShowRulerInAxis RW - - Specifies whether rulers are also displayed in the
(Page 942) time axes.
ShowScrollbars RW - - Specifies whether scroll bars are displayed.
(Page 943)
ShowStatisticRuler RW - - Specifies whether the lines defining the statistics
(Page 946) range are displayed.
ShowTrendIcon RW - - Specifies whether an icon is displayed below the val‐
(Page 952) ue axes.
Size - - - -
in runtime.
(Page 962)

VB scripting

sional vanced
(Page 963)
StatusbarElementAuto‐ RW - - Specifies whether the width of the selected status
Size (Page 964) bar element is set automatically.
StatusbarElementIco‐ RW - - Specifies the ID number and symbol assignment of
nId (Page 966) a status bar element.
(Page 966)
(Page 967)
ject.
StatusbarElementText RW - - Specifies the text of the selected status bar element.
(Page 972)
StatusbarElementTool‐ RW - - Specifies the tooltip text for the selected user-de‐
tipText (Page 973) fined status bar element.
Defined (Page 973) added the status bar element as a new user-defined
element.
ject.
StatusbarElementWidth RW - - Specifies the width of the referenced status bar ele‐
(Page 975) ment in pixels.
(Page 976)
(Page 977)
(Page 979)
(Page 980) played.
TabIndex - - - -

VB scripting

sional vanced
TimeAxes - - - -
TimeAxisAdd RW - - Creates a new time axis. The newly created time axis
(Page 1012) is automatically referenced with "TimeAxisIndex".
TimeAxisAlignment RW - - Specifies the alignment of the time axis.
(Page 1012)
TimeAxisBeginTime RW - - Specifies the start time for the display of the selected
(Page 1013) trend.
TimeAxisColor RW - - Specifies the color of the time axis.
(Page 1014)
TimeAxisCount RW - - Specifies the number of configured time axes.
(Page 1014)
TimeAxisDateFormat RW - - Defines the date format for displaying the selected
(Page 1015) time axis.
TimeAxisEndTime RW - - Specifies the end time for the display of the selected
(Page 1016) trend.
TimeAxisIndex RW - - References a time axis.
(Page 1016)
TimeAxisInTrendColor RW - - Specifies whether the color of the axis referenced
(Page 1017) with "TimeAxisIndex" corresponds to the trend color.
TimeAxisLabel RW - - Specifies the label text for a time axis referenced with
(Page 1017) "TimeAxisIndex".
TimeAxisMeasure‐ RW - - Specifies the number of measurement points to be
Points (Page 1018) displayed for the selected time axis.
TimeAxisName RW - - Specifies the name of a time axis referenced with
(Page 1019) "TimeAxisIndex".
TimeAxisOnline RW - - Specifies that the time axis is updated continuously.
(Page 1019)
TimeAxisRangeType RW - - Defines the time range setting for the selected time
(Page 1020) axis.
TimeAxisRemove RW - - Removes a time axis referenced with its name.
(Page 1020)
TimeAxisRename RW - - Specifies the new name of a time axis referenced
(Page 1021) with "TimeAxisIndex".
TimeAxisRepos RW - - Specifies the position of a time axis referenced with
(Page 1022) "TimeAxisIndex" in the trend diagram of the object.
TimeAxisShowDate RW - - Specifies whether the selected time axis is shown
(Page 1022) with date and time.
TimeAxisTimeFormat RW - - Specifies the format of the information along the time
(Page 1023) axis for the selected trend.
TimeAxisTimeRange‐ RW - - Specifies the time unit that defines the time range
Base (Page 1024) together with the time factor "TimeAxisTimeRange‐
Factor".
TimeAxisTimeRange‐ RW - - Specifies the time factor that defines the time period
Factor (Page 1024) together with the time unit "TimeAxisTimeRange‐
Base".

VB scripting

sional vanced
TimeAxisTrendWindow RW - - Specifies the trend diagram in which the axis refer‐
(Page 1025) enced with "TimeAxisIndex" is displayed.
TimeAxisVisible RW - - Specifies whether the time axis referenced with
(Page 1025) "TimeAxisIndex" is displayed in the object.
displayed.
(Page 1062)
(Page 1063)
(Page 1067)
ToolbarButtonHotKey RW - - Specifies the shortcut for the selected button of the
(Page 1070) object.
(Page 1070)
(Page 1071)
(Page 1074) name.

VB scripting

sional vanced
(Page 1083) played.
TrendAdd (Page 1094) RW - - Creates a new trend.
TrendAutoRangeBegin‐ RW - - Specifies a tag that defines the start value of the
TagName (Page 1095) trend data area.
TrendAutoRangeBegin‐ RW - - Specifies the start value of the trend data area.
Value (Page 1095)
TrendAutoRangeEnd‐ RW - - Specifies a tag that defines the end value of the trend
TagName (Page 1096) data area.
TrendAutoRangeEnd‐ RW - - Specifies the end value of the trend data area.
Value (Page 1097)
TrendAutoRange‐ RW - - Specifies how the automatic data range of the trend
Source (Page 1097) data is determined.
TrendColor (Page 1098) RW - - Specifies the color of a referenced trend in the trend
view.
TrendCount RW - - Specifies the number of configured trends.
(Page 1099)
TrendExtendedColor‐ RW - - Specifies whether the point and fill colors of the trend
Set (Page 1100) are shown.
TrendFill (Page 1101) RW - - Specifies whether the area below the trend is shown
filled.
TrendFillColor RW - - Defines the fill color of the trend.
(Page 1102)
TrendIndex RW - - References a configured trend.
(Page 1103)
TrendLabel (Page 1104) RW - - Defines the label text for a trend referenced with
"TrendIndex".
TrendLineStyle RW - - Specifies which line type is used for display of the
(Page 1105) trend.
TrendLineType RW - - Specifies how the trend is displayed.
(Page 1105)
TrendLineWidth RW - - Specifies the line thickness of the selected trend in
(Page 1106) pixels.
TrendLowerLimit RW - - Specifies the low limit of a tag that is displayed in the
(Page 1107) object as a trend.
TrendLowerLimitColor RW - - Specifies the color that marks trend values which are
(Page 1107) below the value of "TrendLowerLimit".

VB scripting

sional vanced
TrendLowerLimitColor‐ RW - - Specifies whether "TrendLowerLimitColor" is used
ing (Page 1108) to identify tag values which are less than the value
of "TrendLowerLimit".
TrendName RW - - Specifies the name of a trend referenced with "Tren‐
(Page 1109) dIndex".
TrendPointColor RW - - Specifies the color of the dots on the reference trend.
(Page 1110)
TrendPointStyle RW - - Specifies how the trend points are displayed.
(Page 1111)
TrendPointWidth RW - - Specifies the point width in pixels.
(Page 1111)
TrendProvider RW - - Specifies the data source for a selected trend.
(Page 1112)
TrendProviderCLSID RW - - Specifies the provider CLSID of the data for a trend.
(Page 1113)
TrendRemove RW - - Removes a trend referenced with its name.
(Page 1114)
TrendRename RW - - Specifies the new name of a trend referenced with
(Page 1115) "TrendIndex".
TrendRepos RW - - Specifies the position of a trend referenced with
(Page 1115) "TrendIndex" in the trend window of the object.
Trends - - - -
TrendSelectTagName RW - - Specifies that the dialog for selecting the tag name
(Page 1116) for the data source of the value axis is displayed ini‐
tially in runtime.
TrendTagName RW - - Specifies the name of the tag that supplies the value
(Page 1118) axis with data.
TrendTimeAxis RW - - Specifies the time axis to be used for the selected
(Page 1120) trend.
TrendTrendWindow RW - - Specifies the trend window in which the selected
(Page 1121) trend is shown.
TrendUncertainColor RW - - Specifies the color for values of uncertain status.
(Page 1122)
TrendUncertainColor‐ RW - - Specifies that values of uncertain status are to be
ing (Page 1123) highlighted.
TrendUpperLimit RW - - Specifies the high limit of a tag that is displayed in
(Page 1123) the specified object as a trend.
TrendUpperLimitColor RW - - Specifies the color that marks trend values which are
(Page 1124) above the value of "TrendUpperLimit".
TrendUpperLimitColor‐ RW - - Specifies whether the selection frame is shown with
ing (Page 1125) the color defined by the system.
TrendValueAlign - - - -
TrendValueAxis RW - - Specifies the value axis that is used for the trend
(Page 1126) selected.
TrendValueUnit RW - - For the trend type "Display values", specifies a unit
(Page 1126) for the values that is then attached to the values to
be displayed, e.g. "%" or "°C".

VB scripting

sional vanced
TrendVisible RW - - Specifies whether the trend referenced with ""Tren‐
(Page 1127) dIndex" is displayed in the object.
TrendWindowAdd RW - - Creates a new trend view.
(Page 1127)
TrendWindowCoarse‐ RW - - Specifies if the grid lines for the main scale are dis‐
TrendWindowCoarse‐ RW - - Specifies the color of the main grid for the referenced
GridColor (Page 1129) diagram in the object.
TrendWindowCount RW - - Specifies the number of configured trend diagrams
(Page 1129) in the trend view.
TrendWindowFineGrid RW - - Specifies whether grid lines are displayed for the
(Page 1130) secondary scaling.
TrendWindowFineGrid‐ RW - - Specifies the color of the secondary grid for the ref‐
Color (Page 1131) erenced diagram in the object.
TrendWindowFore‐ RW - - Specifies whether only the grid lines for the fore‐
groundTrendGrid ground trend are displayed in the selected trend win‐
(Page 1131) dow.
TrendWindowGridIn‐ RW - - Specifies whether the grid lines for the main scaling
TrendColor (Page 1132) are displayed in the trend color.
TrendWindowHorizon‐ RW - - Specifies whether the horizontal grid lines are
talGrid (Page 1133) shown.
TrendWindowIndex RW - - References a trend view. To access the properties
(Page 1133) of a trend view, you need to set "TrendWindowIn‐
dex".
TrendWindowName RW - - Specifies the name of a trend view referenced with
TrendWindowRemove RW - - Removes a trend view referenced with its name.
(Page 1135)
TrendWindowRename RW - - Specifies the new name of a trend view referenced
(Page 1135) with "TrendWindowIndex".
TrendWindowRepos RW - - Specifies the position of a trend view referenced with
TrendWindowRulerCol‐ RW - - Specifies the color of the ruler.
or (Page 1136)
TrendWindowRulerLay‐ RW - - Specifies the display layer of the ruler in the trend
er (Page 1137) view.
TrendWindowRuler‐ RW - - Specifies the appearance of the ruler.
Style (Page 1138)
TrendWindowRuler‐ RW - - Specifies the thickness of the ruler in pixels.
Width (Page 1139)
TrendWindows - - - -
TrendWindowSpace‐ RW - - Specifies the range proportion of the referenced di‐
Portion (Page 1139) agram in the diagram area of the object.
TrendWindowStatisti‐ RW - - Specifies the color of the statistics ruler.
cRulerColor
(Page 1140)
TrendWindowStatisti‐ RW - - Defines the graphical configurability of the lines for
cRulerStyle (Page 1141) specifying the statistics area in the trend window.

VB scripting

sional vanced
TrendWindowStatisti‐ RW - - Specifies the line thickness of the statistics ruler.
cRulerWidth
(Page 1142)
TrendWindowVertical‐ RW - - Specifies whether the vertical grid lines are dis‐
TrendWindowVisible RW - - Specifies whether the trend view referenced with
(Page 1143) "TrendWindowIndex" is displayed.
UseTrendNameAsLa‐ RW - - Specifies whether the "Name" or "Label" property is
bel (Page 1164) used as a designation for the trend in runtime.
ValueAxes - - - -
ValueAxisAdd RW - - Creates a new value axis.
(Page 1174)
ValueAxisAlignment RW - - Specifies the alignment of the value axis.
(Page 1174)
ValueAxisAutoPreci‐ RW - - Specifies whether the number of decimal places for
sions (Page 1175) a value axis referenced with "ValueAxisIndex" is set
automatically.
ValueAxisAutoRange RW - - Specifies whether the value range of a value axis
(Page 1176) referenced with "ValueAxisIndex" is calculated auto‐
matically.
ValueAxisBeginValue RW - - Specifies the lower end of the value range of a value
(Page 1176) axis referenced with "ValueAxisIndex".
ValueAxisColor RW - - Specifies the color of a value axis.
(Page 1177)
ValueAxisCount RW - - Specifies the number of configured value axes.
(Page 1178)
ValueAxisEndValue RW - - Specifies the upper end of the value range of a value
(Page 1178) axis referenced with "ValueAxisIndex".
ValueAxisExponential‐ RW - - Specifies whether the values of a value axis refer‐
Format (Page 1179) enced with "ValueAxisIndex" are displayed in expo‐
nential notation.
ValueAxisIndex RW - - References a value axis.
(Page 1179)
ValueAxisInTrendColor RW - - Specifies whether the color of the axis referenced
(Page 1180) with "ValueAxisIndex" corresponds to the trend col‐
or.
ValueAxisLabel RW - - Defines the label text for a value axis referenced with
(Page 1181) "ValueAxisIndex".
ValueAxisName RW - - Specifies the name of a value axis referenced with
ValueAxisPrecisions RW - - Specifies the number of displayed decimal places.
(Page 1182)
ValueAxisRemove RW - - Removes a value axis referenced with its name.
(Page 1182)
ValueAxisRename RW - - Specifies the new name of a value axis referenced
(Page 1183) with "ValueAxisIndex".
ValueAxisRepos RW - - Specifies the position of a value axis referenced with

VB scripting

sional vanced
ValueAxisScalingType RW - - Specifies the type of scaling for the value axis refer‐
(Page 1184) enced with "ValueAxisIndex".
ValueAxisTrendWind‐ RW - - Specifies the trend diagram in which the axis refer‐
ow (Page 1185) enced with "ValueAxisIndex" is displayed.
ValueAxisVisible RW - - Specifies whether the value axis referenced with
(Page 1185) "ValueAxisIndex" is displayed in the object.
Table 1-61 Methods

sional vanced
control.
CalculateStatistic Yes - - Executes the "Calculate statistics" key function of
(Page 1260) the f(t) trend view and the table view.
time.
the control.
GetRulerData Yes - - Returns the value of the called trend at the ruler po‐
(Page 1284) sition.
ment" type.
GetTimeAxis Yes - - Returns the f(t) trend view time axis object that is
(Page 1295) specified by name or index as "ICCAxTimeAxis"
type.
GetTimeAxisCollection Yes - - Returns a list of all f(t) trend view time axis objects
GetTrend (Page 1303) Yes - - Returns the f(t) or f(x) trend view trend designated
by name or index as "ICCAxTrend" or "ICCAxFunc‐
tionTrend" type.

VB scripting

sional vanced
GetTrendCollection Yes - - Returns the list of all trends of the f(t) or f(x) trend
GetTrendWindow Yes - - Returns the trend window object of the f(t) or f(x)
(Page 1305) trend view designated by name or index as "ICCAx‐
TrendWindow" type.
GetTrendWindowCol‐ Yes - - Returns the list of all trend window objects of the f(t)
lection (Page 1306) or f(x) trend views as "ICCAxCollection" type.
GetValueAxis Yes - - Returns the f(t) trend view value axis object that is
(Page 1307) specified by name or index as "ICCAxValueAxis"
type.
GetValueAxisCollection Yes - - Returns a list of all f(t) trend view value axis objects
MoveAxis (Page 1321) Yes - - Executes the "Move axes area" button function of
MoveRuler Yes - -
(Page 1321) trol.
NextTrend (Page 1328) Yes - - Executes the "Next trend" button function of the f(t)
OneToOneView Yes - - Executes the "Original view" button function of the
PreviousTrend Yes - - Executes the "Previous trend" button function of the
ShowPercentageAxis Yes - - Executes the "Relative axis" button function of the
(Page 1355) f(t) trend view.
ZoomArea (Page 1368) Yes - - Executes the "Zoom area" button function of the f(t)
ZoomInOut Yes - - Executes the "Zoom +/-" button function of the f(t)
(Page 1369) and f(x) trend views.
ZoomInOutTime Yes - - Executes the "Zoom time axis +/-" button function of
(Page 1369) the f(t) trend view.

VB scripting

sional vanced
ZoomInOutValues Yes - - Executes the "Zoom value axis +/-" button function
(Page 1370) of the f(t) trend view.
ZoomMove Yes - - Executes the "Move trend area" button function of
(Page 1371) the f(t) and f(x) trend views.
OptionGroup (RT Professional)
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Represents the "Option button" object. The OptionGroup object is an element of the
ScreenItems list.

HMIOptionGroup

R Read
RW Read and write
- No access

VB scripting

sional vanced
AdaptBorder RW - - Specifies whether the border of the object will be dy‐
(Page 501) namically adapted to the text size.
(Page 520)
(Page 534)
(Page 536)
(Page 537)
(Page 538) time.
(Page 539)
(Page 561) line.
(Page 572) runtime.
(Page 573)
BorderStyle - - - -
(Page 580)
Bounds - - - -
CheckMarkAlignment RW - - Specifies whether the fields are right-aligned.
(Page 600)
CheckMarkCount RW - - Specifies the number of fields.
(Page 600)
ated in runtime.

VB scripting

sional vanced
(Page 690)
(Page 688)
Flashing - - - -
(Page 702)
Font - - - -
(Page 714)
(Page 739)
ject.
(Page 790)
Location - - - -
Name - - - -
(Page 876)
(Page 883)
(Page 936)
Size - - - -
TabIndex - - - -

VB scripting

sional vanced
TextHandles - - - -
(Page 1006)
Texts - - - -
(Page 1084)
(Page 1090)
for this object.
VerticalAlignment RW - - Specifies the vertical alignment of the text in the
Table 1-63 Methods

sional vanced
time.

VB scripting
PDFview (Panels, Comfort Panels, RT Advanced)
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Represents the "PDF view" object. The PDFview object is an element of the ScreenItems list.

HMIPDFview

R Read
RW Read and write
- No access

fessional vanced
lowed
Bounds - - - -
Enabled (Page 663) - RW RW Specifies whether the selected object can
be operated in runtime.
FileName - - - -

VB scripting

fessional vanced
Height - - - Specifies the height.
Layer - RW RW Specifies the layer in the screen that con‐
tains an object.
Location - - - -
Name - - - -
Size - - - -
TabIndex - - - -
Visible - - - -
Width - - - Specifies the width of the object in pixels.
Table 1-65 Methods

sional vanced
PLCCodeViewer (RT Professional)
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Displays the "PLC Code Viewer" object. The PLCCodeViewer object is an element of the
ScreenItems list.

VB scripting

HMIPLCCodeViewer

R Read
RW Read and write
- No access

sional vanced
Bounds - - - -
ated in runtime.
ject.
Location - - - -
Name - - - -
NavigateTo (Page 833) RW RW RW Specifies the module to be jumped to.
NumberOfVisibleLines RW - - Specifies the number of visible lines in the PLC Code
(Page 839) Viewer.
PathHeaderFont RW - - Specifies the header font.
(Page 863)
Size - - - -
SymbolTableFont RW - - Specifies the font of the symbol table in the PLC
(Page 986) Code Viewer.
TabIndex - - - -
TransitionHeaderFont RW - - Specifies the font in the information area of this PLC
(Page 1089) Code Viewer.

VB scripting
Table 1-67 Methods

sional vanced
cle for a property at runtime.
method used for the specified property in/during run‐
time.
Polygon (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Represents the "Polygon" object. The Polygon object is an element of the ScreenItems list.

HMIPolygon

R Read
RW Read and write
- No access

VB scripting

sional vanced
ActualPointIndex RW - - Specifies the number of the current corner point.
(Page 499)
ActualPointLeft RW - - Specifies the X coordinate of the current corner point
(Page 499) with reference to the screen origin.
ActualPointTop RW - - Specifies the Y coordinate of the current corner point
(Page 520)
BackFillStyle (Page 534) RW RW RW Specifies the fill pattern.
(Page 561) line.
(Page 572) runtime.
(Page 573)
BorderWidth (Page 580) RW RW RW Specifies the line thickness.
Bounds - - - -
DeviceStyle - - - -
ated in runtime.
(Page 690)
FillPatternColor RW - - -
Flashing - - - -

VB scripting

sional vanced
(Page 702)
ject.
(Page 790)
LineWidth - - - -
Location - - - -
Name - - - -
Points - - - -
PointsCount (Page 873) RW - - Specifies the number of corner points of the polyline
or of the polygon.
(Page 883)
(Page 885)
(Page 936)
Size - - - -
StyleItem - - - -
TabIndex - - - -
(Page 1084)
(Page 1090)
for this object.

VB scripting
Table 1-69 Methods

sional vanced
time.
Polyline (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Represents the "Polyline" object. The Polyline object is an element of the ScreenItems list.

HMIPolyline

R Read
RW Read and write
- No access

VB scripting

sional vanced
(Page 499)
(Page 520)
BorderEndStyle RW - - Specifies the type of line ends.
(Page 568)
Bounds - - - -
Color (Page 603) RW RW RW Specifies the line color.
DeviceStyle - - - -
ated in runtime.
EndStyle (Page 670) RW RW RW Specifies how the line end is displayed.
FillStyle (Page 690) - RW RW Specifies whether the background color is displayed
with a broken line.
Flashing - - - -
(Page 702)
object.
Left (Page 773) RW RW RW Specifies the value of the X coordinate of the object.
LineEndShapeStyle RW - - Specifies the shape of the line end.
(Page 790)
LineWidth (Page 793) RW RW RW Specifies the line thickness.
Location - - - -
Name - - - -
Points - - - -

VB scripting

sional vanced
or of the polygon.
(Page 885)
Size - - - -
StartStyle (Page 960) RW RW RW Specifies how the line start is displayed.
Style (Page 984) RW RW RW Specifies the line style.
StyleItem - - - -
TabIndex - - - -
(Page 1084)
Top (Page 1085) RW RW RW Specifies the value of the Y coordinate of the object.
(Page 1090)
for this object.
Visible (Page 1207) RW RW RW Specifies whether the object is visible.
Table 1-71 Methods

sional vanced
time.

VB scripting
ProDiag overview (RT Professional)
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Represents the "ProDiagOverview" object. The ProDiagOverview object is an element of the

ScreenItems list.

HMIProDiagOverview

R Read
RW Read and write
- No access

sional vanced
ated in runtime.
Height (Page 723) RW RW RW Specifies the height.
ject.
Name - - - -

VB scripting

sional vanced
Table 1-73 Methods

sional vanced
time.
ProtectedAreaNameView (Panels, Comfort Panels, RT Advanced)
Description
6FUHHQ
6FUHHQV,WHPV
6FUHHQ,WHP
Represents the "EffectiveRangeName" (RFID)" object. The ProtectedAreaNameView object
is an element of the ScreenItems list.

HMIProtectedAreaNameView

R Read
RW Read and write
- No access

VB scripting

sional vanced
Bounds - - - -
Font - - - -
Height - - - -
ject.
Location - - - -
Name - - - -
Size - - - -
TabIndex - - - -
Width - - - -
Table 1-75 Methods

sional vanced
RangeLabelView (Panels, Comfort Panels, RT Advanced)
Description
6FUHHQ
6FUHHQV,WHPV
6FUHHQ,WHP
Represents the "EffectiveRangeName" object. The RangeLabelView object is an element of

VB scripting

HMIRangeLabelView

R Read
RW Read and write
- No access

sional vanced
Bounds - - - -
Font - - - -
Height - - - -
ject.
Location - - - -
Name - - - -
Size - - - -
TabIndex - - - -
Width - - - -
Table 1-77 Methods

sional vanced

VB scripting
RangeQualityView (Panels, Comfort Panels, RT Advanced)
Description
6FUHHQ
6FUHHQV,WHPV
6FUHHQ,WHP
Represents the "EffectiveRangeSignal" object. The RangeQualityView object is an element of

HMIRangeQualityView

R Read
RW Read and write
- No access

sional vanced
Bounds - - - -
Height - - - -
Layer (Page 767) - - RW Returns the layer in the screen in which an object is
located.
Location - - - -
Name - - - -
Size - - - -
TabIndex - - - -
Width - - - -

VB scripting
Table 1-79 Methods

sional vanced
See also
Height (Page 723)
Width (Page 1220)
RecipeView (Panels, Comfort Panels, RT Advanced)
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Displays the "Recipe view" object. The RecipeView object is an element of the ScreenItems
list.
Note
The object "Simple RecipeView" cannot be dynamized with a user-defined function.

VB scripting

R Read
RW Read and write
- No access

sional vanced
AdvancedButtonPosi‐ - - - -
tions
AdvancedView - - - -
AllowEdit - - - -
Authorization - RW RW Specifies the operating rights of the selected object
BackButtonVisible - - - -
BorderColor - - - -
BorderWidth - - - -
Bounds - - - -
or
set
Color
Color
tOffset
ColumnOrder - - - -
ColumnWidth - - - -

VB scripting

sional vanced
ComboboxFont - - - -
DataRecordNameCap‐ - - - -
tion
DataRecordNrCaption - - - -
DeviceStyle - - - -
Display3D - - - -
DisplayButton2Plc - - - -
DisplayButtonCompari‐ - - - -
son
DisplayButtonDelete - - - -
DisplayButtonFromPlc - - - -
DisplayButtonHelp - - - -
DisplayButtonNew - - - -
DisplayButtonSave - - - -
DisplayButtonSaveAs - - - -
DisplayComboBox - - - -
DisplayGridLines - - - -
DisplayLabeling - - - -
DisplayNumbers - - - -
DisplaySize - - - -
DisplayStatusBar - - - -
DisplayTable - - - -
EdgeStyle - - - -
ated in runtime.
EntryNameCaption - - - -
EntryNameColumn‐ - - - -
Width
EntryValueColFirst - - - -
EntryValueColumn‐ - - - -
Width
EntryValueFieldLength - - - -
EntryValuePos - - - -
ES2RT_ButtonPositions - - - -
ES2RT_EntryNameCo‐ - - - -
lumnWidth
ES2RT_EntryValueCo‐ - - - -
lumnWidth
ES2RT_ListAreaHeight - - - -
ES2RT_ListAreaWidth - - - -

VB scripting

sional vanced
FitToSize - - - -
Flashing - - - -
ject has the focus.
focus.
Font - - - -
HeaderFont - - - -
Height - - - -
IsVerticalScrollBarEna‐ - - - -
bled
KeyboardOnline - - - -
ject.
ListAreaHeight - - - -
ListAreaLeft - - - -
ListAreaTop - - - -
ListAreaWidth - - - -
Location - - - -
MaxNumberOfCombo‐ - - - -
BoxCharacters
MenuButtonVisible - - - -
Name - - - -
NameColumnWidth - - - -
NumberOfButtons - - - -
NumberOfLines - - - -
PaddingLeft - - - -
PaddingTop - - - -
PlcUDTFilter - - - -
ProhibitDataRecordTa‐ - - - -
gInOnlySimpleView
Recipe - - - -
RecipeName - RW RW Specifies the name of the recipe that is displayed in
(Page 881) the "Recipe view".
RecipeNameCaption - - - -
RecipeNrCaption - - - -
RecipeNrColFirst - - - -
RecipeNumber - RW RW Specifies the number of the recipe that is displayed
(Page 882) in the "Recipe view".

VB scripting

sional vanced
RecordName - RW RW Specifies the name of the recipe data record that is
(Page 882) displayed in the "Recipe view".
RecordNrColFirst - - - -
RecordNumber - R R Returns the number of the recipe data record that is
(Page 883) currently being displayed in the "Recipe view".
RenameButtonVisible - - - -
SelectionBackColor - R R Returns the background color of the selected cells.
(Page 916)
SelectionForeColor - R R Returns the foreground color of the selected cells.
(Page 918)
SimpleView - - - -
Size - - - -
StatuslineFont - - - -
StyleItem - - - -
TabIndex - - - -
TableBackColor - R R Returns the background color of the table cells.
(Page 990)
Color
TableForeColor - R R Returns the font color used in the table cells of the
(Page 993) object.
TableGridLineColor - R R Returns the color of the grid lines in the table.
(Page 994)
TableHeaderBackColor - R R Returns the background color in the header of the
(Page 995) table.
Style
BackColor
or
Width
dius
dientColor
dientOffset
TableHeaderForeColor - R R Returns the text color in the header of the table.
(Page 997)
dientColor

VB scripting

sional vanced
Bottom
gLeft
Right
Top
GradientColor
GradientOffset
Tag4DataRecord - - - -
Tag4RecipeNumber - - - -
TextualObjectPositions - - - -
TextualObjectsAutoSize - - - -
TextualObjectsBorder‐ - - - -
BackColor
Color
Width
TextualObjectsCorner‐ - - - -
Radius
TextualObjectsEdgeS‐ - - - -
tyle
TextualObjectsPadding‐ - - - -
Bottom
TextualObjectsPaddin‐ - - - -
gLeft
Right
Top
dient
ma
Gradient
condGradient
ValueCaption - - - -
ValueColumnWidth - - - -

VB scripting

sional vanced
VerticalScrolling - - - -
ViewType - - - -
Stream
VisibleItems - - - -
Width - - - -
Table 1-81 Methods

sional vanced
Rectangle (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Represents the "Rectangle" object. The Rectangle object is an element of the ScreenItems
list.

HMIRectangle

VB scripting

R Read
RW Read and write
- No access

sional vanced
ject.
BackFillStyle (Page 534) RW RW RW Specifies the fill pattern of the selected object.
object.
Bounds - - - -
object.
DeviceStyle - - - -
der.
ated in runtime.
(Page 690)
(Page 688) object.

VB scripting

sional vanced
Flashing - - - -
Height (Page 723) RW RW RW Specifies the height of the selected object.
object.
ted object.
(Page 790)
Location - - - -
Name - - - Returns the object name as STRING.
(Page 883)
RoundCornerHeight RW - - Specifies the corner radius.
(Page 887)
RoundCornerWidth RW - - Specifies the corner radius.
(Page 888)
(Page 936)
Size - - - -
StyleItem - - - -
TabIndex - - - -
(Page 1084)
ted object.
(Page 1090)
for this object.

VB scripting
Table 1-83 Methods

sional vanced
ActivateDynamic Yes - - Dynamically activates a trigger and the specified cycle
(Page 1255) for a property at runtime.
DeactivateDynamic Yes - - Deactivates the trigger of the "ActivateDynamic" meth‐
(Page 1262) od used for the specified property in/during runtime.
RoundButton (RT Professional)
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Represents the "Round button" object. The RoundButton object is an element of the
ScreenItems list.

HMIRoundButton

R Read
RW Read and write
- No access

VB scripting

sional vanced
BackColor (Page 529) RW - - Specifies the background color of the selected ob‐
ject.
(Page 534)
(Page 536)
(Page 537)
BackFlashingRate RW - - Specifies the flash rate of the background for the se‐
BorderBrightColor3D RW - - Specifies the frame color of the following frame parts
(Page 564) in case of a 3D display of the selected object: Outer
border parts top and bottom; inner border parts bot‐
tom and right
BorderShadeColor3D - - - -
object.
(Page 580)
BorderWidth3D RW - - Specifies the width of the border for 3D display of the
Bounds - - - -
object.

VB scripting

sional vanced
der.
ated in runtime.
(Page 690)
(Page 688) object.
Flashing - - - -
Font - - - -
shown in bold.
shown in italics.
object.
ForeColor (Page 715) R - - Specifies the font color of the text for the selected
object.
Height (Page 723) R - - Specifies the height of the selected object.
HorizontalAlignment R - - Specifies the horizontal alignment of the text within
Layer (Page 767) R - - Returns the layer in the screen in which an object is
located.
Left (Page 773) R - - Returns the value of the X coordinate of the object.
LineEndShapeStyle R - - Specifies the shape of the line ends.
(Page 790)
Location - - - -
Mode (Page 827) R - - Returns the field type of the specified object.
Name - - - -
PictureAlignment R - - Returns the display type for the background screen
(Page 867) in the process image.

VB scripting

sional vanced
PictureDeactivated R - - Returns the graphic that is displayed in the "Disa‐
(Page 868) bled" state.
PictureOff (Page 869) R - - Returns the graphic that is displayed in the "Off"
state.
PictureOn (Page 870) R - - Returns the screen that is displayed in the "On"
state.
Pressed (Page 875) R - - Returns whether the specified object is displayed as
pressed.
Radius (Page 879) R - - Returns the radius of the specified "Circle" object.
RelativeFillLevel R - - Returns the percentage to which the object is filled.
(Page 883)
ShowFillLevel R - - Returns whether the specified object is filled.
(Page 936)
Size - - - -
StyleSettings R - - Returns the style in which the object is displayed.
(Page 985)
TabIndex - - - -
Text (Page 1003) R - - Returns the label for the text field.
TextOrientation R - - Returns the text orientation of the specified object.
(Page 1006)
Toggle (Page 1054) R - - Returns whether the specified object engages after
it has been operated in Runtime.
ToolTipText R - - Returns the tooltip text.
(Page 1084)
Top (Page 1085) R - - Returns the value of the Y coordinate of the object.
Transparency R - - Returns the object transparency in percent.
(Page 1090)
TransparentColorDeac‐ R - - Returns the color of the assigned bitmap object to
tivatedPicture be set to "transparent" for the "Disabled" state.
(Page 1092)
TransparentColorPic‐ R - - Returns the color of the assigned bitmap object to
tureOff (Page 1092) be set to "transparent" for the "Off" state.
TransparentColorPictur‐ R - - Returns the color of the assigned bitmap object to
eOn (Page 1093) be set to "transparent" for the "On" state.
UseDesignColorSche‐ R - - Returns whether the colors defined in the global col‐
ma (Page 1151) or scheme of the current design are used for this
object.
UseDesignShadowSet‐ R - - Returns whether the object is displayed with the
UseTransparentColor‐ R - - Returns whether the transparent color specified with
DeactivatedPicture the "TransparentColorDeactivatedPicture" property
(Page 1163) is used for the "Disabled" state.
UseTransparentColor‐ R - - Returns whether the transparent color defined with
PictureOff (Page 1163) the property "TransparentColorPictureOff" is used
for the "Off" state.

VB scripting

sional vanced
UseTransparentColor‐ R - - Returns whether the transparent color defined with
PictureOn (Page 1164) the property "TransparentColorPictureOn" is used
for the "On" state.
VerticalAlignment R - - Returns the vertical alignment of the text of the speci‐
(Page 1203) fied object.
Visible (Page 1207) R - - Returns whether the specified object is visible.
Width (Page 1220) R - - Returns the width of the object in pixels.
Table 1-85 Methods

sional vanced
time.
S7GraphOverview (RT Professional)
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Represents the "GRAPH overview" object. The S7GraphOverview object is an element of the
ScreenItems list.

VB scripting

HMIS7GraphOverview

R Read
RW Read and write
- No access

sional vanced
AssociatedS7Graph‐ - - - -
DBName
AssociatedS7Graph‐ - - - -
DBTag
(Page 520)
Bounds - - - -
ated in runtime.
ErrorColor (Page 672) RW - - Specifies the color of errors in the GRAPH overview.
Errorflag (Page 674) RW - - Specifies whether an error description is displayed
in the device / detail view.
Height (Page 723) - - - -
HighlightColor RW - - Specifies the highlight color in the GRAPH overview.
(Page 728)
ject.
Location - - - -
Name - - - -
PathHeaderBackColor - - -
(Page 863)
PathHeaderFont RW - - Specifies the header font.
(Page 863)
PathHeaderTextColor RW - - Specifies the font color in the header of the GRAPH
(Page 864) overview.
SeparatorColor RW - - Specifies the color of the separation lines in the se‐
(Page 923) lection list.
Size - - - -
StepBackColor RW - - Specifies the background color of the step.
(Page 981)
StepFont (Page 982) RW - - Specifies the font color of the step.

VB scripting

sional vanced
StepTextColor RW - - Specifies the text color of the step.
(Page 983)
TabIndex - - - -
Width (Page 1220) - - - -
Table 1-87 Methods

sional vanced
time.
ScreenWindow (RT Professional)
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Represents the "ScreenWindow" object. The ScreenWindow object is an element of the

ScreenItems list.

VB scripting

HMIScreenWindow

R Read
RW Read and write
- No access

sional vanced
AdaptScreenToWindow R - - Specifies whether or not the screen visualized in a
(Page 502) screen window is adapted to fit the size of the screen
window in runtime.
AdaptWindowtoScreen R - - Specifies whether the screen window is adapted to
(Page 503) fit the screen it visualizes in runtime.
BorderEnabled R - - Specifies whether the window is displayed with a
Bounds - - - -
CaptionText (Page 593) RW - - Specifies the text to be displayed in the header.
Flashing - - - -
HorizontalScrollBarPo‐ RW - - Specifies the position of the slider in the horizontal
sition (Page 741) scroll bar.
IndipendentWindow - - - -
ject.
LeftOffset (Page 778) RW - - Sets the horizontal shift of the zero point of the dis‐
play of a screen that is larger than the screen window.
Location - - - -
MenuToolBarConfig RW - - Determines the configuration file with user-defined
(Page 803) menu and toolbars.
MonitorNumber R - - Specifies the number of the monitor whose content
(Page 828) is displayed in the screen window.
Name - - - -
ProcessTag - - - -
ScreenName R - - Specifies the screen to be displayed in the screen
(Page 903) window in runtime.
ScreenScaleMode R - - Specifies the scaling mode of the displayed screen.
(Page 904)
ServerPrefix RW - - Specifies the server on which the screen is located
that is displayed in the screen window in runtime or
returns the server name.

VB scripting

sional vanced
ShowCaption R - - Specifies whether the title bar is shown.
(Page 930)
ShowScrollbars R - - Specifies whether scroll bars are displayed.
(Page 943)
Size - - - -
TabIndex - - - -
TagPrefix (Page 1000) RW - - Specifies the tag prefix that is prefixed for all tags
contained in the screen window.
TopOffset (Page 1088) RW - - Sets the vertical shift of the zero point of the display
of a screen that is larger than the screen window.
VerticalScrollbarPosi‐ RW - - Specifies the position of the slider in the vertical
tion (Page 1205) scroll bar of the object.
WindowCloseEnabled R - - Specifies whether a window can be closed in Run‐
(Page 1223) time.
WindowMaximizeEna‐ R - - Specifies whether the object can be maximized in
WindowMovingEnabled R - - Specifies whether the object can be moved in Run‐
(Page 1224) time.
WindowOnTop R - - Specifies whether the object always remains in the
WindowSizingEnabled R - - Specifies whether the size can be changed.
(Page 1226)
WindowStartupPosition R - - Specifies the position and the mode of the screen
(Page 1227) window when an independent screen window is con‐
figured.
ZoomFactor RW - - Specifies the zoom factor of a screen or screen win‐
(Page 1252) dow.
Table 1-88 Methods

sional vanced
time.

VB scripting
ScriptDiagnostics (RT Professional)
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Represents the "ApplicationWindow" object. The ApplicationWindow object is an element of


HMIApplicationWindow

R Read
RW Read and write
- No access

sional vanced
BorderEnabled RW - - Specifies whether the window is displayed with a
Bounds - - - -
GSCRuntimeAllowed - - - -

VB scripting

sional vanced
ject.
Location - - - -
Name - - - -
ShowCaption RW - - Specifies whether the title bar is shown.
(Page 930)
Size - - - -
TabIndex - - - -
Template (Page 1002) RW - - Specifies the template for displaying window content
in the "Print job/Script diagnostics" object.
Top (Page 1085) - - - -
WindowCloseEnabled RW - - Specifies whether a window can be closed in Run‐
(Page 1223) time.
WindowMaximizeEna‐ RW - - Specifies whether the object can be maximized in
WindowMovingEnabled RW - - Specifies whether the object can be moved in Run‐
(Page 1224) time.
WindowOnTop RW - - Specifies whether the object always remains in the
WindowsContents RW - - Specifies the content of the print job or script diag‐
(Page 1225) nostics.
WindowSizingEnabled RW - - Specifies whether the size can be changed.
(Page 1226)
Table 1-90 Methods

sional vanced
AUTOHOTSPOT Yes - - Enables the permanent area or the root screen.
AUTOHOTSPOT Yes - - Dynamically activates a trigger and the specified cy‐
AUTOHOTSPOT Yes - - Deactivates the trigger of the "ActivateDynamic"
time.
See also
ActivateDynamic (Page 1255)

VB scripting
DeactivateDynamic (Page 1262)

Name (Page 830)
Slider (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Represents the "Slider" object. The Slider object is an element of the ScreenItems list.

HMISlider

R Read
RW Read and write
- No access

sional vanced
AlarmLowerLimitColor - - - -
AlarmUpperLimitColor - - - -

VB scripting

sional vanced
Authorization RW RW RW Specifies operating rights.
(Page 520)
BackFillStyle (Page 534) RW - - Specifies the fill pattern of the selected object.
BackPicture (Page 541) RW - - Specifies the background graphic.
BarBackColor RW RW RW Specifies the color of the bar background for the se‐
BarColor (Page 545) RW RW RW Specifies the color of the bar.
BarOrientation - - - -
BorderBrightColor3D RW RW RW Specifies the border color of the following border
(Page 564) parts for 3D presentation.
BorderColor - - - -
BorderInnerStyle3D RW - - Specifies the appearance of the inner part of the ob‐
BorderInnerWidth3D RW RW RW Specifies the width of the inner border for 3D display.
(Page 576)
BorderOuterStyle3D - - - -
BorderOuterWidth3D RW RW RW Specifies the width of the outer border for 3D display.
(Page 577)
BorderShadeColor3D RW RW RW Specifies the border color of the following border
(Page 578) parts for 3D presentation.
Bounds - - - -
Caption (Page 590) RW RW RW Specifies the text to be displayed in the header.
ContinousChange RW - - Specifies whether to transfer the value of the "Proc‐
(Page 636) essValue" when the mouse button is released, or
immediately on a change of the slider position in run‐
time.
DeviceStyle - - - -
EdgeStyle - - - -
ated in runtime.
Flashing (Page 695) RW - - Specifies that flashing is activated.
FocusColor (Page 706) RW RW RW Specifies the color of the focus border when the ob‐
ject has the focus.
FocusWidth (Page 707) RW RW RW Specifies the border width when the object has the
focus.
ForeColor (Page 715) RW RW RW Specifies the font color of the text.
ForeColorTransparency - - - -

VB scripting

sional vanced
LabelColor (Page 761) RW RW RW Specifies the color of the scale label.
ject.
Location - - - -
Name (Page 830) RW - - Specifies the object name.
PositionFont (Page 874) RW - - Sets the font for the label of the slider.
(Page 876)
ScaleLabelFieldLength - - - -
ScalePosition - - - -
ShowBar (Page 929) RW RW RW Specifies whether the displayed process value is al‐
so shown by a filled bar.
ShowLimitLines - - - -
ShowLimitMarkers - - - -
ShowPosition RW RW RW Adds a numerical display of the value of the slider
(Page 941) position.
ShowScale - - - -
ShowThumb (Page 948) R RW RW Displays the slider of the "Slider" object.
ShowTickLabels R RW RW Specifies whether the label is shown in the scale.
(Page 949)
ShowTicks (Page 949) R RW RW Specifies whether the marks in the scale are dis‐
played.
Size - - - -
StyleItem - - - -
TabIndex - - - -
ThumbBackColor R RW RW Specifies the background color of the slider.
(Page 1009)
ThumbPicture R - - Returns a graphic for the slider element in the slider.
(Page 1009)
TickStyle (Page 1011) R - - Returns how the marks are displayed in the scale.
Top (Page 1085) R RW RW Specifies the value of the Y coordinate.
(Page 1090)
object.

VB scripting

sional vanced
UseDesignShadowSet‐ R - - Returns whether the object is displayed with global
Visible (Page 1207) R RW RW Specifies whether the selected object is visible.
Table 1-92 Methods

sional vanced
time.
SmartClientView (Panels, Comfort Panels, RT Advanced)
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Represents the "Sm@rtClient View" object. The SmartClientView object is an element of the
ScreenItems list.

VB scripting

HMISmartClientView

R Read
RW Read and write
- No access

sional vanced
AdressPreview - - - -
AllowMenu - - - -
Bounds - - - -
ConnectionType - - - -
ConnectOnStart - - - -
ated in runtime.
EncryptCommunication - - - -
Flashing - - - -
Font - - - -
Height - - - -
ject.
LocalCursor - - - -
Location - - - -
Machine - - - -
MachineName - RW RW Sets the network ID of the device that is to be moni‐
(Page 800) tored.
Name - - - -
Password (Page 862) - RW RW Sets the password for remote monitoring.
PasswordsMustBeEn‐ - - - -
crypted
ScaleDenominator - - - -
ScaleNumerator - - - -
Scaling - - - -
ServerScale - - - -
Shared - - - -
ShowControls - - - -
Size - - - -

VB scripting

sional vanced
TabIndex - - - -
TcpPortNr - - - -
UseCurserKeyScroll - - - -
ViewOnly (Page 1206) - RW RW Specifies whether the Sm@rtClient display will be
used for remote monitoring or remote maintenance.
Width - - - -
Table 1-94 Methods

sional vanced
StatusForce (Panels, Comfort Panels, RT Advanced)
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Represents the "Watch table" object. The StatusForce object is an element of the ScreenItems
list.

VB scripting

HMIStatusForce

R Read
RW Read and write
- No access

sional vanced
Appearance - - - -
(Page 520)
BorderColor - - - -
BorderWidth - - - -
Bounds - - - -
or
set
Color
Color
tOffset
ColumnOrder - - - -
ColumnTextBit - - - -
ColumnTextConnection - - - -
ColumnTextDataType - - - -

VB scripting

sional vanced
ColumnTextDbNumber - - - -
ColumnTextFormat - - - -
ColumnTextOffset - - - -
ColumnTextRead - - - -
ColumnTextType - - - -
ColumnTextWrite - - - -
ColumnWidth - - - -
CountVisibleItems - - - -
DeviceStyle - - - -
EdgeStyle - - - -
ated in runtime.
FitToSize - - - -
Flashing - - - -
ject has the focus.
focus.
Height - - - -
ject.
ListAreaLeft - - - -
ListAreaTop - - - -
Location - - - -
Name - - - -
Object - - - -
PaddingLeft - - - -
PaddingTop - - - -
PLCFilter - - - -
(Page 916)
(Page 918)
SetOfVisibleColumns - - - -

VB scripting

sional vanced
ShowReadButton - - - -
ShowTableGridlines - RW RW Specifies whether grid lines are shown in the table.
(Page 947)
ShowWriteButton - - - -
Size - - - -
StyleItem - - - -
TabIndex - - - -
TableBackColor - RW RW Specifies the background color of the table cells.
(Page 990)
Color
TableFont - - - -
(Page 993) object.
TableGridlineColor - - - -
(Page 995) table.
Style
BackColor
or
Width
dius
dientColor
dientOffset
TableHeaderForeColor - R R Returns the text color in the header of the table of
(Page 997) the specified object.
dientColor
Bottom
gLeft
Right
Top

VB scripting

sional vanced
GradientColor
GradientOffset
ToolTipText - R R Specifies the tooltip text.
(Page 1084)
dient
ma
Gradient
condGradient
Visible (Page 1207) - R R Returns whether the specified object is visible.
Width - - - -
Table 1-96 Methods

sional vanced

VB scripting
Switch (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Represents the "Switch" object. The Switch object is an element of the ScreenItems list.
Property "Switch with text" "Switch with graphic" "Switch"

CaptionColor -- -- x
(Page 592)
CaptionText (Page 593) -- -- x
HorizontalAlignment X -- --
(Page 739)
InnerBackColorOff -- -- x
(Page 747)
InnerBackColorOn -- -- x
(Page 748)
TextOn (Page 1005) x -- x
TextOff (Page 1005) x -- x
VerticalAlignment x -- --
(Page 1203)

VB scripting

HMISwitch

R Read
RW Read and write
- No access

sional vanced
(Page 520)
BackFlashingColorOff - - - -
BackFlashingColorOn - - - -
BackFlashingEnabled - - - -
BackFlashingRate - - - -
BorderBrightColor3D - - - -
BorderColor - - - -
BorderFlashingColorOff - - - -
BorderFlashingColorOn - - - -
BorderFlashingEnabled - - - -
BorderFlashingRate - - - -
BorderShadeColor3D - - - -
BorderWidth - - - -
CaptionColor - RW RW Specifies the color of the text to be displayed in the
(Page 592) title bar.
CaptionFont - - - -
CaptionText (Page 593) - RW RW Specifies the text to be displayed in the header.
CornerStyle - - - -
DeviceStyle - - - -
DrawInsideFrame - - - -
EdgeStyle - - - -

VB scripting

sional vanced
ated in runtime.
FirstGradientColor - - - -
FirstGradientOffset - - - -
Flashing - - - -
tion
ject has the focus.
focus.
Font - - - -
Height - - - -
HorizontalAlignment - RW RW Specifies the horizontal alignment of the text.
(Page 739)
HorizontalPictureAlign‐ - - - -
ment
HotKey - - - -
InnerBackColorOff - RW RW Sets the color underneath the slider of the "Switch"
(Page 747) object for the object in OFF state.
InnerBackColorOn - RW RW Sets the color underneath the slider of the "Switch"
(Page 748) object for the object in ON state.
Layer (Page 767) - RW RW Specifies the layer in the screen that contains an
object.
LineEndShapeStyle - - - -
Location - - - -
MiddleGradientColor - - - -
Mode - - - -
Name - - - -
OnValue - - - -
PictureAreaBottomMar‐ - - - -
gin
PictureAreaLeftMargin - - - -
PictureAreaRightMargin - - - -
PictureAreaTopMargin - - - -

VB scripting

sional vanced
PictureAutoSizing - - - -
PictureOff - - - -
PictureOn - - - -
SecondGradientColor - - - -
SecondGradientOffset - - - -
ShowCaption - - - -
Size - - - -
StyleItem - - - -
SwitchOrientation - - - -
TabIndex - - - -
TextAreaBottomMargin - - - -
TextAreaLeftMargin - - - -
TextAreaRightMargin - - - -
TextAreaTopMargin - - - -
TextOff (Page 1005) - R R Returns the text that is displayed in the "Off" state.
TextOn (Page 1005) - R R Returns the text that is displayed in the "On" state.
TextOrientation - - - -
ToolTipText - R R Returns the tooltip text.
(Page 1084)
ma
UseFirstGradient - - - -
UseSecondGradient - - - -
VerticalAlignment - R R Returns the vertical alignment of the text in the speci‐
VerticalPictureAlign‐ - - - -
ment
Visible (Page 1207) - R R Returns whether the specified object is visible.
Width - - - -
Table 1-98 Methods

sional vanced

VB scripting
SymbolicIOField (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Represents the "SymbolicIOField" object. The SymbolicIOField object is an element of the

ScreenItems list.
Property "Input" "Output" "Input/Output" "Two states"

BackColor x x x x
(Page 529)
BorderColor -- x -- x
(Page 565)
BorderWidth -- -- -- x
(Page 580)
Enabled (Page 663) x -- x --
HelpText (Page 727) x -- x --
VerticalAlignment -- x -- x
(Page 1203)
HorizontalAlignment -- x -- x
(Page 739)

VB scripting

HMISymbolicIOField

R Read
RW Read and write
- No access

sional vanced
AcceptOnExit RW - - Specifies whether the input field is confirmed auto‐
(Page 494) matically when it is left.
Assignments (Page 519) RW - - Specifies a list which contains the assignments be‐
tween the output value and the output text actually
to be output.
ject.
(Page 534)
(Page 536)
(Page 537)
BitNumber (Page 549) RW - - Specifies the bit whose status must change to trigger
a value change.

VB scripting

sional vanced
object.
CaptionBackColor RW - - Specifies the background color of the caption for the
CaptionColor RW - - Specifies the color of the text that is displayed in the
(Page 592) header of the selected object.
object.
(Page 641) contain.
CursorControl RW - - Specifies whether the mouse cursor jumps to the
(Page 642) next field of the TAB sequence after leaving a field.
DeviceStyle - - - -
der.
EditOnFocus RW - - Specifies whether data input is immediately possible
(Page 662) if the input field is selected using the "Tab" key.
ated in runtime.
EvenRowBackColor - - - -
ExtraHeightOffset - - - -
FillPatternColor R - - Returns the color of the fill pattern for the specified
(Page 688) object.
Flashing - - - -
FlashingColorOff R - - Returns the color of the border line of the specified
(Page 696) object for the flashing state "Off".
FlashingColorOn R - - Returns the color of the border line for the specified
(Page 698) object for the flashing state "On".
FlashingEnabled R - - Returns whether the border line of the specified ob‐
(Page 700) ject flashes in Runtime.
tion
FlashingRate R - - Returns the flash rate of the border line of the speci‐

VB scripting

sional vanced
FocusColor - - - -
FocusWidth - - - -
Font - - - -
FontBold (Page 711) R - - Returns whether the text of the specified object is
displayed bold.
FontItalic (Page 711) R - - Returns whether the text of the specified object is
displayed italic.
FontName (Page 712) R - - Returns the font of the specified object.
FontSize (Page 714) R - - Returns the font size of the text for the specified ob‐
ject.
FontUnderline R - - Returns whether the text of the specified object is
(Page 714) displayed underlined.
ForeColor (Page 715) R RW RW Specifies the font color of the text for the selected
object.
HorizontalAlignment R RW RW Specifies the horizontal alignment of the text within
InputValue (Page 750) R - - Returns the input value.
ItemBorderStyle R - - Returns the line style of the separation lines in the
(Page 753) selection list of the specified object.
Layer (Page 767) R RW RW Specifies the layer in the screen that contains an
object.
Left (Page 773) R RW RW Specifies the value of the X coordinate of the selec‐
ted object.
LeftMargin - - - -
LineEndShapeStyle R - - Returns the shape of the line ends.
(Page 790)
Location - - - -
LogOperation R - - Returns whether an alarm is output on the alarm
(Page 797) system after operation of this object.
Mode (Page 827) R - - Returns the field type of the specified object.
Name - - - -
OnValue - - - -
ProcessValue R - - Returns the default for the value to be displayed.
(Page 876)
RightMargin - - - -
SelectBackColor R - - Returns the background color of the selected text
(Page 908) entry for the specified object.
SelectForeColor R - - Returns the color of the selected text entry for the
SeparatorBackColor R - - Returns the background color of the broken separa‐
(Page 922) tion lines in the selection list of the specified object.
SeparatorColor R - - Returns the color of the separation lines in the se‐
(Page 923) lection list of the specified object.

VB scripting

sional vanced
SeparatorCornerStyle R - - Returns the shape of the corners for the specified
(Page 923) object.
SeparatorLineEndSha‐ R - - Returns the shape of the line end for the specified
peStyle (Page 924) object.
SeparatorStyle R - - Returns the line style of the separation lines in the
(Page 925) selection list of the specified object.
SeparatorWidth R - - Returns the separation line width in the selection list
(Page 925) of the specified object.
ShowBadTagState R - - Returns whether the object is grayed out in the event
(Page 929) of a bad quality code or tag status.
ShowDropDownButton R - - Returns whether a button for the selection list is dis‐
(Page 932) played.
ShowDropDownList - - - -
Size - - - -
StyleItem - - - -
TabIndex - - - -
TextList (Page 1004) R - - Returns a list containing the output text actually to
be output for each output value.
TextOff - - - -
TextOn - - - -
TextOrientation R - - Returns the text orientation of the specified object.
(Page 1006)
ToolTipText R R R Returns the tooltip text.
(Page 1084)
Top (Page 1085) R R R Returns the value of the Y coordinate of the specified
object.
TopMargin - - - -
(Page 1090)
object.
UseDesignShadowSet‐ R - - Returns whether the object is displayed with the
VerticalAlignment R RW RW Specifies the vertical alignment of the text in the

VB scripting
Table 1-100 Methods

sional vanced
time.
SymbolLibrary (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Represents the "SymbolLibrary" object. The SymbolLibrary object is an element of the

ScreenItems list.

HMISymbolLibrary

R Read
RW Read and write
- No access

VB scripting

sional vanced
(Page 520)
BlinkColor (Page 550) RW RW RW Specifies the color in which the object flashes in run‐
time.
BlinkMode (Page 550) RW - - Specifies the type of flash graphic for the specified
object.
BlinkSpeed (Page 551) RW - - Sets the flash rate.
Bounds - - - -
ChangeMouseCursor RW - - Specifies how the appearance of the cursor changes
(Page 599) in runtime when it is above the icon.
ated in runtime.
FillColorMode RW - - Specifies the type of foreground for the selected ob‐
(Page 687) ject.
FixedAspectRatio RW - - Specifies whether the aspect ratio should be re‐
(Page 694) tained on changes of the icon size, or follow the
change dynamically.
Flashing - - - -
tion
Flip (Page 705) RW - - Specifies whether the symbol is flipped on the verti‐
cal and / or horizontal center axis of the symbol.
object.
Location - - - -
Name - - - -
Object - - - -
OcxGuid - - - -
OcxState - - - -
Rotation (Page 885) RW - - Specifies the angle of rotation in degrees.

VB scripting

sional vanced
Size - - - -
TabIndex - - - -
Table 1-102 Methods

sional vanced
time.
SysDiagControl (Panels, Comfort Panels, RT Advanced)
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Represents the "System diagnostic view" object. The SystemDiagnoseView object is an


VB scripting

HMISysDiagView

R Read
RW Read and write
- No access

sional vanced
BackgroundColor - - - -
BorderColor - - - -
BorderWidth - - - -
Bounds - - - -
BufferViewColumnOr‐ - - - -
der
BufferViewInternalRow‐ - - - -
Order
BusyText - - - -
or
set
Color
Color
tOffset
BV_ColumnWidth_Date - - - -
BV_Colum‐ - - - -
nWidth_Event
BV_Colum‐ - - - -
nWidth_EventSeverity

VB scripting

sional vanced
BV_Colum‐ - - - -
nWidth_EventState
BV_Colum‐ - - - -
nWidth_Number
BV_ColumnWidth_Time - - - -
BV_ItemText_Date - - - -
BV_ItemText_Event - - - -
BV_ItemText_EventSe‐ - - - -
verity
BV_ItemText_Even‐ - - - -
tState
BV_ItemText_Number - - - -
BV_ItemText_Time - - - -
BV_ShowItem_Date - - - -
BV_ShowItem_Event - - - -
BV_ShowItem_Even‐ - - - -
tSeverity
BV_ShowItem_Even‐ - - - -
tState
BV_ShowItem_Number - - - -
BV_ShowItem_Time - - - -
ColumnSettings - - - -
ColumnSettingsBuffer‐ - - - -
View
ComplexViewToolbar - - - -
ComplexViewToolbar‐ - - - -
Bounds
ComponentInfoText - - - -
DeviceStyle - - - -
EdgeStyle - - - -
Enabled (Page 663) R R R Returns whether the specified object can be operat‐
ed in Runtime.
EnterButtonVisible - - - -
Es2RtTableBounds - - - -
EscButtonVisible - - - -
EsPreviewType - - - -
FitToSize - - - -
FitToSizeLowerRows - - - -
FitToSizeUpperRows - - - -
Flashing - - - -
HomeButtonVisible - - - -

VB scripting

sional vanced
InfoArea_Background‐ - - - -
Color
InfoArea_ColumnsMov‐ - - - -
able
InfoArea_DefaultText‐ - - - -
Color
InfoArea_ErrorText‐ - - - -
BackgroundColor
InfoArea_ErrorTextCol‐ - - - -
or
InfoArea_FocusFrame‐ - - - -
Color
InfoArea_FocusFrame‐ - - - -
Width
InfoArea_Font - - - -
InfoArea_RootNodeText - - - -
InfoArea_Selection‐ - - - -
BackgroundColor
InfoArea_SelectionFor‐ - - - -
egroundColor
InfoArea_ShowGrid‐ - - - -
Lines
InfoArea_TableHeader‐ - - - -
BackgroundColor
InfoArea_TableHeader‐ - - - -
TextColor
InputAddressText - - - -
InspectorViewInternal‐ - - - -
ColumnOrder
InspectorViewRowOr‐ - - - -
der
ItemText_AKZ - - - -
ItemText_Descriptor - - - -
ItemText_ErrorText - - - -
ItemText_HardwareRe‐ - - - -
vision
ItemText_IMDataVer‐ - - - -
sion
ItemText_Installation‐ - - - -
Date
ItemText_LADDR - - - -
ItemText_Manufacturer‐ - - - -
ID
ItemText_Name - - - -
ItemText_OKZ - - - -

VB scripting

sional vanced
ItemText_Operation‐ - - - -
State
ItemText_OrderID - - - -
ItemText_ProfileID - - - -
ItemText_Rack - - - -
ItemText_Revision‐ - - - -
Counter
ItemText_SerialNumber - - - -
ItemText_Slot - - - -
ItemText_SoftwareRevi‐ - - - -
sion
ItemText_SpecificProfi‐ - - - -
leData
ItemText_State - - - -
ItemText_Station - - - -
ItemText_SubAddress - - - -
ItemText_SubSlot - - - -
ItemText_SubSystem - - - -
ItemText_Type - - - -
IV_ShowItem_AKZ - - - -
IV_ShowItem_Descrip‐ - - - -
tor
IV_ShowItem_ErrorText - - - -
IV_ShowItem_Hardwar‐ - - - -
eRevision
IV_ShowItem_IMData‐ - - - -
Version
IV_ShowItem_Installa‐ - - - -
tionDate
IV_ShowItem_LADDR - - - -
IV_ShowItem_Manufac‐ - - - -
turerID
IV_ShowItem_Name - - - -
IV_ShowItem_OKZ - - - -
IV_ShowItem_Opera‐ - - - -
tionState
IV_ShowItem_OrderID - - - -
IV_ShowItem_ProfileID - - - -
IV_ShowItem_Rack - - - -
IV_ShowItem_Revision‐ - - - -
Counter
IV_ShowItem_Serial‐ - - - -
Number
IV_ShowItem_Slot - - - -

VB scripting

sional vanced
IV_ShowItem_Softwar‐ - - - -
eRevision
IV_ShowItem_Specific‐ - - - -
ProfileData
IV_ShowItem_State - - - -
IV_ShowItem_Station - - - -
IV_ShowItem_SubAd‐ - - - -
dress
IV_ShowItem_SubSlot - - - -
IV_ShowItem_SubSys‐ - - - -
tem
IV_ShowItem_Type - - - -
Layer (Page 767) R R R Returns the layer in the screen in which an object is
located.
Left (Page 773) R R R Returns the value of the X coordinate.
LinesPerDiagEntry - - - -
Location - - - -
MaxToolbarRows - - - -
Name - - - -
NavigateTo (Page 833) RW - - -
NavigationButtons - - - -
NavigationPath_Font - - - -
NavigationPath_Root‐ - - - -
Text
NavigationPath_Text‐ - - - -
Color
NavigationpathDiagbuf‐ - - - -
ferDetailText
NavigationpathDiagbuf‐ - - - -
ferText
OutputAddressText - - - -
PaddingLeft - - - -
PaddingTop - - - -
RTPersistence - - - -
RTPersistenceAuthori‐ - - - -
zation
RTPersistenceType - - - -
ShowMilliseconds - - - -
ShowNavigationButtons - - - -
ShowPathInformation - - - -
ShowSplittedView - - - -

VB scripting

sional vanced
ShowToolbarBack‐ - - - -
groundColor
SimpleViewToolbar - - - -
Size - - - -
SplittedViewRatio - - - -
StyleItem - - - -
SupportsInplaceEdit - - - -
SysDiagBuffButtonVisi‐ - - - -
ble
TabIndex - - - -
Color
TableGridlineColor - - - -
Style
BackColor
or
Width
dius
dientColor
dientOffset
dientColor
Bottom
gLeft
Right
Top
GradientColor
GradientOffset
ToolBar_ButtonsHeight - - - -
ToolBar_ButtonsWidth - - - -

VB scripting

sional vanced
ToolbarAlignment - - - -
ToolbarBackgroundCol‐ - - - -
or
ToolbarButtonClick - - - -
ToolbarButtonHeight - - - -
ToolbarButtonSettings - - - -
ToolbarButtonWidth - - - -
ToolbarIconStyle - - - -
Top (Page 1085) R R R Returns the value of the Y coordinate.
UnitViewColumnOrder - - - -
UpdateButtonVisible - - - -
dient
ma
UseScadaRenderer‐ - - - -
Style
UseSystemScrollbar‐ - - - -
Width
Gradient
condGradient
UV_ColumnWidth_AKZ - - - -
UV_ColumnWidth_De‐ - - - -
scriptor
UV_ColumnWidth_In‐ - - - -
stallationDate
UV_Colum‐ - - - -
nWidth_LADDR
UV_Colum‐ - - - -
nWidth_Name
UV_ColumnWidth_OKZ - - - -
UV_ColumnWidth_Op‐ - - - -
erationState
UV_ColumnWidth_Or‐ - - - -
derID
UV_ColumnWidth_Pro‐ - - - -
fileID
UV_ColumnWidth_Rack - - - -
UV_ColumnWidth_Slot - - - -
UV_ColumnWidth_Soft‐ - - - -
wareRevision
UV_ColumnWidth_Spe‐ - - - -
cificProfileData

VB scripting

sional vanced
UV_ColumnWidth_State - - - -
UV_ColumnWidth_Sta‐ - - - -
tion
UV_ColumnWidth_Sub‐ - - - -
Address
Slot
System
UV_ColumnWidth_Type - - - -
UV_ShowItem_AKZ - - - -
UV_ShowItem_Descrip‐ - - - -
tor
UV_ShowItem_Installa‐ - - - -
tionDate
UV_ShowItem_LADDR - - - -
UV_ShowItem_Name - - - -
UV_ShowItem_OKZ - - - -
UV_ShowItem_Opera‐ - - - -
tionState
UV_ShowItem_OrderID - - - -
UV_ShowItem_ProfileID - - - -
UV_ShowItem_Rack - - - -
UV_ShowItem_Slot - - - -
UV_ShowItem_Softwar‐ - - - -
eRevision
UV_ShowItem_Specific‐ - - - -
ProfileData
UV_ShowItem_State - - - -
UV_ShowItem_Station - - - -
UV_ShowItem_SubAd‐ - - - -
dress
UV_ShowItem_SubSlot - - - -
UV_ShowItem_SubSys‐ - - - -
tem
UV_ShowItem_Type - - - -
ViewType - - - -

VB scripting
Table 1-103 Methods

sional vanced
TextField (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Represents the "TextField" object. The TextField object is an element of the ScreenItems list.

HMITextField

R Read
RW Read and write
- No access

VB scripting

sional vanced
AdaptBorder (Page 501) RW - - Specifies whether the border of the object will be dy‐
namically adapted to the text size.
(Page 520)
(Page 536)
(Page 537)
BackFlashingEnabled RW - - Specifies whether the background flashes in runtime.
(Page 538)
(Page 539)
(Page 561) line.
(Page 572) runtime.
(Page 573)
AUTOHOTSPOT RW - - Specifies the type of border lines.
Bounds - - - -
ated in runtime.
(Page 688)

VB scripting

sional vanced
Flashing - - - -
(Page 702)
Font - - - -
(Page 714)
HorizontalAlignment RW RW RW Specifies the horizontal alignment of the text.
(Page 739)
Layer (Page 767) R R R Returns the layer in the screen in which an object is
located.
LeftMargin - - - -
(Page 790)
LineWrap - - - -
Location - - - -
Name - - - -
(Page 883)
ReSizeable - - - -
RightMargin - - - -
(Page 885)
(Page 936)
Size - - - -
TabIndex - - - -
Text (Page 1003) RW RW RW Specifies the label for the text field.

VB scripting

sional vanced
(Page 1006)
ToolTipText RW R R Specifies the tooltip text.
(Page 1084)
TopMargin - - - -
(Page 1090)
for this object.
VerticalAlignment RW RW RW Specifies the vertical alignment of the text in the
Table 1-105 Methods

sional vanced
time.

VB scripting
TrendRulerControl (RT Professional)
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Represents the "Value table" object. The TrendRulerControl object is an element of the
ScreenItems list.

HMITrendRulerControl
Example
'VBS60
Dim objControl

R Read
RW Read and write
- No access

VB scripting

sional vanced
ForDesignMode
AutoPosition (Page 523) RW - - Specifies whether the value table is automatically
placed under the object that supplies the value table
with data.
AutoShow (Page 526) RW - - Specifies whether the value table is automatically
displayed.
BlockAlignment RW - - Specifies the alignment of the text within the column
(Page 552) header of the referenced block.
BlockAutoPrecision RW - - Specifies whether the number of decimal places dis‐
(Page 552) played in the current block is adjusted automatically.
BlockCaption RW - - Specifies the header for the current block.
(Page 553)
BlockCount (Page 553) RW - - Sets the number of blocks.
BlockDateFormat RW - - Specifies the date format for the current block.
(Page 554)
BlockExponentialFor‐ RW - - Specifies whether the values in the current block are
mat (Page 554) displayed in exponential notation.
BlockHideText - - - -
BlockHideTitleText RW - - Specifies whether the header of the block is dis‐
(Page 555) played as a text.
BlockId (Page 556) RW - - References a block with its block ID.
BlockIndex (Page 556) RW - - References a block.
BlockLength (Page 557) RW - - Specifies the number of characters for the current
block.
BlockName (Page 557) RW - - Specifies the name of the current block.
BlockPrecision RW - - Specifies the number of decimal places in the current
(Page 558) block.
Blocks - - - -
BlockShowDate RW - - Specifies that the date is to be displayed in the cur‐
(Page 558) rent block.
BlockShowIcon RW - - Specifies whether the content of the current block is
(Page 559) displayed as an icon.
BlockShowTitleIcon RW - - Specifies whether the header of the current block is
(Page 560) shown as an icon.

VB scripting

sional vanced
BlockTimeFormat RW - - Specifies the time format for the current block.
(Page 560)
BlockUseSourceFormat RW - - Specifies whether the format of the connected con‐
(Page 561) trol is used in the current block.
Bounds - - - -
(Page 595)
(Page 596)
(Page 596)
(Page 597)
time.
ColumnAdd (Page 605) RW - - Creates a new column.
ColumnCount RW - - Specifies the number of configured columns.
(Page 608)
ColumnIndex RW - - References a column.
(Page 612)
ColumnName RW - - Specifies the name of a column referenced with "Col‐
(Page 615) umnIndex".
ColumnRemove RW - - Removes a column referenced with its name.
(Page 618)
ColumnRepos RW - - For multiple columns, specifies the position of a col‐
(Page 618) umn referenced with "ColumnIndex".
(Page 619) columns.
Columns - - - -
ColumnScrollbar RW - - Specifies when the horizontal scroll bar is to be dis‐
(Page 620) played.
ColumnSort (Page 623) RW - - Specifies the sorting type of a column referenced
with "ColumnIndex".
ColumnSortIndex RW - - Specifies the sorting order for a column referenced
(Page 624) with "ColumnIndex" in which the columns are sorted
one after another.
ColumnTitleAlignment RW - - Specifies the alignment of the header in a column
(Page 630) referenced with "ColumnIndex".
(Page 631)

VB scripting

sional vanced
ColumnVisible RW - - Specifies whether the column referenced with "Col‐
(Page 632) umnIndex" is displayed in the object.
(Page 637)
ated in runtime.
(Page 678)
(Page 682)
(Page 683) ted.
(Page 684) runtime.
FillPattern - - - -
(Page 720)
(Page 722)
table cells.
ject.
LineStyle - - - -

VB scripting

sional vanced
Location - - - -
Moveable (Page 828) RW - - Specifies whether the object can be moved in Run‐
time.
Name - - - -
Object - - - -
OcxGuid - - - -
OcxState - - - -
editor.
RowScrollbar RW - - Specifies when the vertical scroll bar is displayed.
(Page 888)
(Page 889)
RowTitles (Page 890) RW - - Specifies whether numbered column headers are
displayed.
RulerColumns - - - -
RulerType (Page 894) RW - - Specifies the display mode of the value table.
(Page 908)
(Page 909)
(Page 911)
(Page 912)
(Page 914) header.
(Page 915)
(Page 917) or rows.
SelectionRect RW - - Specifies whether a selection frame is used for the
(Page 919) selected cells or rows.
(Page 919) alarm window.

VB scripting

sional vanced
(Page 921)
ShareSpaceWithSour‐ RW - - Specifies that the display area of the data source is
ceControl (Page 927) adapted to the size of the value table.
(Page 945)
(Page 945)
Size - - - -
in runtime.
SortSequence RW - - Specifies how the sorting order is changed if the op‐
(Page 957) erator clicks on the column header in runtime.
SourceControl RW - - Specifies the trend or table view to which the value
(Page 958) table is connected.
SourceControlType RW - - Sets the data source type.
(Page 958)
StatisticAreaColumns - - - -
StatisticResultColumns - - - -
(Page 962)
(Page 963)
tomatically.
nId (Page 966)
(Page 966)
(Page 967)
ject.

VB scripting

sional vanced
(Page 972)
mentIndex".
ject.
(Page 976)
(Page 977)
(Page 979)
(Page 980) played.
TabIndex - - - -
the object.
TableColor2 (Page 991) RW - - Specifies the second background color of the table
rows in the object.
(Page 993) object.

VB scripting

sional vanced
TitleStyle (Page 1054) RW - - Specifies whether to use a shading color for the text
in the column headers.
(Page 1062)
(Page 1063)
(Page 1067)
(Page 1070)
(Page 1070)
(Page 1071)
(Page 1074) name.

VB scripting

sional vanced
(Page 1083) played.
UseSourceBackColors RW - - Specifies the use of the background color of the data
(Page 1159) source.
UseSourceForeColors RW - - Specifies the use of the font color of the data source.
(Page 1160)
(Page 1204) played.
Table 1-106 Methods

sional vanced
time.
in the table-based controls as "ICCAxDataRow"
type.
GetRulerBlock Yes - - Returns the block object of the evaluation table des‐
(Page 1280) ignated by name or index as "ICCAxRulerBlock"
type.
GetRulerBlockCollec‐ Yes - - Returns the list of all block objects of the evaluation
tion (Page 1281) table as "ICCAxCollection" type.

VB scripting

sional vanced
GetRulerColumn Yes - - Returns the column object of the evaluation table
(Page 1282) designated by name or index as "ICCAxRulerCol‐
umn" type.
GetRulerColumnCollec‐ Yes - - Returns the list of all column objects of the evaluation
tion (Page 1283) table as "ICCAxCollection" type.
tion.
GetStatisticAreaCol‐ Yes - - Returns the column object of the statistics area win‐
umn (Page 1288) dow of the evaluation table designated by name or
index as "ICCAxRulerColumn" type.
GetStatisticAreaCo‐ Yes - - Returns the list of all column objects of the statistics
lumnCollection area window of the evaluation table as "ICCAxCol‐
(Page 1289) lection" type.
GetStatisticResultCol‐ Yes - - Returns the column object of the statistics window
umn (Page 1290) of the evaluation table designated by name or index
as "ICCAxRulerColumn" type.
GetStatisticResultCo‐ Yes - - Returns the list of all column objects of the statistics
lumnCollection window of the evaluation table as "ICCAxCollection"
(Page 1291) type.
ment" type.

VB scripting
TrendView (Panels, Comfort Panels, RT Advanced)
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Represents the "TrendView" object. The TrendView object is an element of the ScreenItems
list.

HMITrendView

R Read
RW Read and write
- No access

sional vanced
AxisXBunchCount - - - -
AxisXMarkCount - - - -
AxisXNoOfDigits - - - -
AxisXShowBunchVal‐ - - - -
ues

VB scripting

sional vanced
AxisXStyle - - - -
AxisY1BunchCount - - - -
AxisY1MarkCount - - - -
AxisY1ShowBunchVal‐ - - - -
ues
AxisY2BunchCount - - - -
AxisY2MarkCount - - - -
AxisY2ShowBunchVal‐ - - - -
ues
BackColor - - - -
BorderColor - - - -
BorderWidth - - - -
Bounds - - - -
ButtonBarHeight - - - -
or
set
Color
Color
tOffset
ColumnOrder - - - -
ColumnTextDateTime - - - -
ColumnTextTagCon‐ - - - -
nection
ColumnTextTrend - - - -
ColumnTextValue - - - -
ColumnTextXValue - - - -
ColumnWidth - - - -

VB scripting

sional vanced
Curves - - - -
DeviceStyle - - - -
DiagramAreaHeight - - - -
DiagramAreaLeft - - - -
DiagramAreaTop - - - -
DiagramAreaWidth - - - -
EdgeStyle - - - -
ated in runtime.
EnableNavigateButtons - - - -
EnableNavigateKeys - - - -
FitToSize - - - -
Flashing - - - -
FocusColor (Page 706) - RW RW Specifies the color for the focus frame of the selected
object when it is in focus.
FocusWidth (Page 707) - RW RW Specifies the border width of the specified object
when the object is in focus.
Font - - - -
GridlineAxis - - - -
GridlineColor - - - -
GridlineEnabled - - - -
GridlineFillColor - - - -
GridlineStyle - - - -
Height - - - -
HelpText (Page 727) - RW RW Specifies the tooltip that is shown in runtime as user
ject.
Left (Page 773) - RW RW Specifies the value of the X coordinate of the selec‐
ted object.
Location - - - -
Look3D - - - -
MaxNrOfCurves - - - -
MinNrOfCurves - - - -
Name - - - -
PaddingLeft - - - -
PaddingTop - - - -

VB scripting

sional vanced
RulerColor (Page 893) - RW RW Defines the color of the scale gradation (help line) of
the axis label in the specified object.
ScaleColor (Page 895) - RW RW Specifies the color of the scale of the selected ob‐
ject.
SelectionBackColor - - - -
SelectionForeColor - - - -
ShowRuler (Page 941) - RW RW Defines whether a scale division (help line) is dis‐
played for an axis label of the specified object.
ShowTableGridLines - - - -
ShowTimeAxis - - - -
ShowTimeAxisLabeling - - - -
ShowValueAxis1 - - - -
ShowValueAxis1Label - - - -
ShowValueAxis2 - - - -
ShowValueAxis2Label - - - -
ShowValueTable - - - -
ShowY1HlpLine - - - -
ShowY2HlpLine - - - -
Size - - - -
StyleItem - - - -
TabIndex - - - -
TableBackColor - RW RW Specifies the background color of the table cells for
TableColumnsWid‐ - - - -
thAndOrder
Color
TableFont - - - -
TableGridLineColor - R R Returns the color of the gridlines in the table of the
TableHeaderBackColor - R R Returns the background color in the header of the
(Page 995) table of the selected object.
Style
BackColor
or
Width
dius

VB scripting

sional vanced
dientColor
dientOffset
TableHeaderForeColor - R R Returns the text color in the header of the table of
dientColor
Bottom
gLeft
Right
Top
GradientColor
GradientOffset
TagForExternalTime - - - -
TimeAxisBegin - - - -
TimeAxisBeginTime - - - -
TimeAxisCountPoints - - - -
TimeAxisEnd - - - -
TimeAxisMode - - - -
TimeAxisRange - - - -
TimeAxisSide - - - -
TimeAxisTimeRange - - - -
ToolbarButtonsForMi‐ - - - -
gration
ToolbarEnabled - - - -
ToolbarHeight - - - -
ToolbarLeft - - - -
ToolbarStyle - - - -
ToolbarTop - - - -
ToolbarWidth - - - -
Top (Page 1085) - R R Returns the value of the Y coordinate of the selected
object.
TrendsForPrinting - - - -
dient

VB scripting

sional vanced
ma
Gradient
condGradient
ValueAxis1AutoRange - - - -
ValueAxis1Begin - - - -
ValueAxis1End - - - -
ValueAxis1LabelLength - - - -
ValueAxis1Style - - - -
ValueAxis2AutoRange - - - -
ValueAxis2Begin - - - -
ValueAxis2End - - - -
ValueAxis2LabelLength - - - -
ValueAxis2Style - - - -
ValueTableHeight - - - -
ValueTableLeft - - - -
ValueTableTop - - - -
ValueTableWidth - - - -
ValueY1HlpLine - - - -
ValueY2HlpLine - - - -
Visible (Page 1207) - R R Specifies whether the selected object is visible.
Width - - - -
Table 1-108 Methods

sional vanced
See also
Height (Page 723)
Width (Page 1220)

VB scripting
TubeArcObject (RT Professional)
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Represents the "TubeArc" object. The TubeArcObject is an element of the ScreenItems list.

HMITubeArcObject
Application
In the following example, the object with the name "TubeArcObject1" is moved 10 pixels to the
right:
'VBS24
Dim objTubeArcObject
Set objTubeArcObject = ScreenItems("TubeArcObject1")
objTubeArcObject.Left = objTubeArcObject.Left + 10

R Read
RW Read and write
- No access

VB scripting

sional vanced
(Page 520)
BackColor - - - -
Bounds - - - -
CornerStyle - - - -
DrawInsideFrame - - - -
ated in runtime.
EndAngle (Page 669) RW - - Specifies the angle at which the end point of the se‐
lected object deviates from the zero position (0°).
Flashing - - - -
ject.
LineEndShapeStyle - - - -
Location - - - -
Name - - - -
(Page 879)
(Page 880)
Size - - - -
TabIndex - - - -
(Page 1084)
(Page 1090)
for this object.

VB scripting

sional vanced
Table 1-110 Methods

sional vanced
time.
TubeDoubleTeeObject (RT Professional)
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Represents the "DoubleTee" object. The TubeDoubleTeeObject is an element of the

ScreenItems list.

HMITubeDoubleTeeObject

VB scripting
Application
In the following example, the object with the name "TubeDoubleTeeObject1" is moved 10
pixels to the right:
'VBS21
Dim objTubeDoubleTeeObject
Set objTubeDoubleTeeObject = ScreenItems("TubeDoubleTeeObject1")
objTubeDoubleTeeObject.Left = objTubeDoubleTeeObject.Left + 10

R Read
RW Read and write
- No access

sional vanced
(Page 520)
Bounds - - - -
ated in runtime.
ject.
Location - - - -
Name - - - -
Size - - - -
TabIndex - - - -
(Page 1084)
(Page 1090)
for this object.

VB scripting

sional vanced
Table 1-112 Methods

sional vanced
time.
TubePolyline (RT Professional)
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Represents the "Pipe" object. The TubePolyline object is an element of the ScreenItems list.

HMITubePolyline

VB scripting
Application
In the following example, the object with the name "TubePolyline1" is moved 10 pixels to the
right:
'VBS24
Dim objTubePolyline
Set objTubePolyline = ScreenItems("TubePolyline1")
objTubePolyline.Left = objTubePolyline.Left + 10

R Read
RW Read and write
- No access

sional vanced
(Page 499)
(Page 520)
Bounds - - - -
DeviceStyle - - - -
ated in runtime.
Layer (Page 767) RW - - Specifies the layer in the screen that contains an
object.
Location - - - -
Name - - - -
Points - - - -
or of the polygon.

VB scripting

sional vanced
Size - - - -
TabIndex - - - -
(Page 1084)
(Page 1090)
for this object.
Table 1-114 Methods

sional vanced
time.

VB scripting
TubeTeeObject (RT Professional)
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Represents the "Tee" object. The TubeTeeObject is an element of the ScreenItems list.

HMITubeTeeObject
Application
In the following example, the object with the name "TubeTeeObject1" is moved 10 pixels to
the right:
'VBS21
Dim objTubeTeeObject
Set objTubeTeeObject = ScreenItems("TubeTeeObject1")
objTubeTeeObject.Left = objTubeTeeObject.Left + 10

R Read
RW Read and write
- No access

VB scripting

sional vanced
(Page 520)
Bounds - - - -
ated in runtime.
ject.
Location - - - -
Name - - - -
(Page 885)
Size - - - -
TabIndex - - - -
(Page 1084)
(Page 1090)
for this object.

VB scripting
Table 1-116 Methods

sional vanced
time.
UserArchiveControl (RT Professional)
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Displays the "Recipe view" object. The UserArchiveControl object is an element of the
ScreenItems list.

HMIUserArchiveControl

R Read
RW Read and write
- No access

VB scripting

fessional vanced
lowed
ApplyProjectSet‐ - - - -
tingsForDesign‐
Mode
ArchiveName RW - - Sets the log name.
(Page 516)
ArchiveType RW - - Sets the log type.
(Page 517)
AutoCompleteCol‐ RW - - Specifies whether empty columns are
umns (Page 522) shown if the control is wider than the con‐
figured columns.
AutoCompleteR‐ RW - - Specifies whether empty rows are shown if
ows (Page 522) the control is longer than the number of
configured rows.
AutoSelectionCol‐ RW - - Specifies whether the colors defined by the
ors (Page 524) system are used as the selection colors for
cells and rows.
AutoSelectionRect‐ RW - - Specifies whether the selection frame is
Color (Page 525) shown with the color defined by the system.
BackColor RW - - Specifies the background color.
(Page 529)
Blocks - - - -
BorderColor RW - - Specifies the line color.
(Page 565)
(Page 580)
Bounds - - - -
Caption (Page 590) RW - - Specifies the text to be displayed in the
header.
CellCut - - - -
CellSpaceBottom RW - - Specifies the bottom margin of the table
(Page 595) cells.
CellSpaceLeft RW - - Specifies the left indent used in the table
(Page 596) cells.
CellSpaceRight RW - - Specifies the right indent used in the table
(Page 596) cells.
(Page 597)
Closeable RW - - Specifies whether the object can be closed
ColumnAlias RW - - Specifies the display name of the column
(Page 605) referenced with "ColumnIndex".

VB scripting

fessional vanced
ColumnAlignment RW - - Specifies the alignment of the column con‐
(Page 606) tent in a column referenced with "Colum‐
nIndex".
ColumnAutoPreci‐ RW - - Specifies whether the number of decimal
sions (Page 607) places for a column referenced with "Col‐
umnIndex" is set automatically.
ColumnCaption RW - - Specifies the header of the current column.
(Page 607)
ColumnCount RW - - Specifies the number of configured col‐
(Page 608) umns.
ColumnDateFor‐ RW - - Specifies the date format.
mat (Page 608)
ColumnDMVar‐ RW - - Specifies the name of a tag.
Name (Page 609)
ColumnExponen‐ RW - - Specifies whether the values of a column
tialFormat referenced with "ColumnIndex" are dis‐
(Page 609) played in exponential notation.
ColumnFlagNot‐ RW - - Specifies whether the user archive field as‐
Null (Page 610) signed to a column referenced with "Col‐
umnIndex" has to have a value.
ColumnFlagUnique RW - - Specifies whether the user archive field as‐
(Page 610) signed to a column referenced with "Col‐
umnIndex" has to have a unique value.
ColumnHideText RW - - Specifies whether the text in a column ref‐
(Page 611) erenced with "ColumnIndex" is hidden.
ColumnHideTitle‐ RW - - Specifies whether the header of a column
Text (Page 612) referenced with "ColumnIndex" is hidden.
ColumnIndex RW - - References a column.
(Page 612)
ColumnLeading‐ RW - - Specifies how many leading zeros are dis‐
Zeros (Page 613) played for the values of a column refer‐
enced with "ColumnIndex".
ColumnLength RW - - Specifies the number of characters dis‐
(Page 613) played in a column referenced with "Col‐
umnIndex".
ColumnMaxValue RW - - Specifies the maximum value defined in
(Page 614) the user archive of a column referenced
with "ColumnIndex".
ColumnMinValue RW - - Specifies the minimum value defined in the
(Page 614) user archive of a column referenced with
"ColumnIndex".
ColumnName RW - - Specifies the name of a column referenced
(Page 615) with "ColumnIndex".
ColumnPosition RW - - Specifies the position of a column refer‐
(Page 616) enced with "ColumnIndex".
ColumnPrecisions RW - - Specifies the number of decimal places in
(Page 616) a column referenced with "ColumnIndex".

VB scripting

fessional vanced
ColumnReadAc‐ RW - - Specifies the read access authorization de‐
cess (Page 617) fined in the user archive for a column refer‐
ColumnReadonly RW - - Specifies whether the values of a column
(Page 617) referenced with "ColumnIndex" can only be
read.
ColumnRepos RW - - For multiple columns, specifies the position
(Page 618) of a column referenced with "ColumnIn‐
dex".
ColumnResize RW - - Specifies whether you can change the
(Page 619) width of the columns.
Columns - - - -
ColumnScrollbar RW - - Specifies when the horizontal scroll bar is
(Page 620) to be displayed.
ColumnShowDate RW - - Specifies whether the date is to be dis‐
umnIndex".
ColumnShowIcon RW - - Specifies whether a symbol is to be dis‐
umnIndex".
ColumnShowTitleI‐ RW - - Specifies whether a symbol is to be dis‐
con (Page 622) played in a column referenced with "Col‐
umnIndex".
ColumnSort RW - - Specifies the sorting type of a column ref‐
(Page 623) erenced with "ColumnIndex".
ColumnSortIndex RW - - Specifies the sorting order for a column ref‐
(Page 624) erenced with "ColumnIndex" in which the
columns are sorted one after another.
ColumnStartValue RW - - Specifies the start value defined in the user
(Page 624) archive of a column referenced with "Col‐
umnIndex".
ColumnStrin‐ RW - - Specifies the string length defined in the
gLength (Page 625) user archive for a column referenced with
"ColumnIndex".
ColumnTimeFor‐ RW - - Specifies the time format for a column ref‐
mat (Page 629) erenced with "ColumnIndex".
ColumnTitleAlign‐ RW - - Specifies the alignment of the header in a
ment (Page 630) column referenced with "ColumnIndex".
ColumnTitles RW - - Specifies whether the column header is
ColumnType RW - - Specifies the data type defined in the user
(Page 631) archive of a column referenced with "Col‐
umnIndex".
ColumnVisible RW - - Specifies whether the column referenced
(Page 632) with "ColumnIndex" is displayed in the ob‐
ject.
ColumnWriteAc‐ RW - - Specifies the write access authorization de‐
cess (Page 633) fined in the user archive for a column refer‐

VB scripting

fessional vanced
ControlDesign‐ RW - - Specifies the control design.
Mode (Page 637)
DataProviderGuid R - - Determines the GUID of the control.
(Page 646)
DataSource - - - -
DefaultFilterEom - - - -
Enabled - - - -
EnableDelete RW - - Specifies whether data can be deleted in
(Page 667) runtime.
EnableEdit RW - - Specifies whether the data shown can be
(Page 667) edited in runtime.
EnableInsert RW - - Specifies whether data can be inserted in
(Page 668) runtime.
ExportDirectory‐ RW - - Specifies whether the data export directory
Changeable can be changed in runtime.
(Page 677)
ExportDirectory‐ RW - - Specifies the target directory for the expor‐
name (Page 678) ted runtime data.
ExportFileExten‐ RW - - Specifies the file extension of the export file.
sion (Page 678)
ExportFilename RW - - Specifies the name of the target file for the
(Page 679) exported runtime data.
ExportFilename‐ RW - - Specifies whether the export file name can
Changeable be changed in runtime.
(Page 680)
ExportFormatGuid RW - - Specifies the assignment of ID number and
(Page 681) export provider.
ExportFormat‐ RW - - Specifies the export file format.
Name (Page 682)
ExportParameters RW - - Specifies the parameters of the selected
(Page 683) format by means of the properties dialog.
ExportSelection RW - - Specifies which runtime data of the control
(Page 683) is exported.
ExportShowDialog RW - - Specifies whether the data export dialog is
(Page 684) shown in runtime.
FillPattern - - - -
Filter - - - -
FilterSQL RW - - Sets an SQL statement for the filter criteri‐
(Page 691) on.
(Page 720)

VB scripting

fessional vanced
GridLineWidth RW - - Specifies the width of the separation lines
(Page 722) in pixels.
HorizontalGrid‐ RW - - Specifies whether horizontal separating
Lines (Page 740) lines are displayed.
IconSpace RW - - Specifies the spacing between icons and
(Page 743) text in the table cells.
Layer - - - -
LineBackground‐ - - - -
Color
LineColor RW - - Specifies the color of the window separa‐
(Page 789) tion lines.
LineStyle - - - -
LineWidth RW - - Specifies the line thickness.
(Page 793)
Location - - - -
Moveable RW - - Specifies whether the object can be moved
Name - - - -
Object - - - -
OcxGuid - - - -
OcxState - - - -
PrintJob (Page 875) RW - - Specifies a print job that is created in the
"Reports" editor.
RowScrollbar RW - - Specifies when the vertical scroll bar is dis‐
(Page 888) played.
(Page 889)
RowTitles RW - - Specifies whether numbered column head‐
(Page 890) ers are displayed.
RTPersistence RW - - Specifies whether online configurations are
(Page 890) retained after a screen change.
RTPersistenceAu‐ RW - - Specifies the authorization required for on‐
thorization line configuration in runtime.
(Page 891)
RTPersistence‐ RW - - Specifies how online configurations of
Type (Page 892) WinCC are retained.
SelectArchive‐ RW - - Specifies that the selection dialog for the
Name (Page 907) data source of the recipe view is displayed
initially in Runtime.
SelectedCellColor RW - - Specifies the background color of the se‐
(Page 908) lected cell.
SelectedCellFore‐ RW - - Specifies the font color of the selected cell.
Color (Page 909)

VB scripting

fessional vanced
SelectedID RW - - Specifies the ID of the data record selected
(Page 910) in the recipe view.
SelectedRowColor RW - - Specifies the background color of the se‐
(Page 911) lected row.
SelectedRowFore‐ RW - - Specifies the font color of the selected row.
Color (Page 912)
SelectedTitleColor RW - - Specifies the background color of the se‐
(Page 914) lected table header.
SelectedTitleFore‐ RW - - Specifies the font color of the selected table
Color (Page 915) header.
SelectionColoring RW - - Specifies whether selection colors are
(Page 917) used for cells or rows.
SelectionRect RW - - Specifies whether a selection frame is used
(Page 919) for the selected cells or rows.
SelectionRectColor RW - - Specifies the color of the selection rectan‐
(Page 919) gle in the alarm window.
SelectionRect‐ RW - - Specifies the line width of the selection rec‐
Width (Page 920) tangle in the alarm window if SelectionType
equals "1".
(Page 921)
ShowSortButton RW - - Specifies whether the sorting button is
(Page 944) shown above the vertical scroll bar.
ShowSortIcon RW - - Specifies whether the sorting icon is dis‐
(Page 945) played.
(Page 945)
ShowTitle RW - - Specifies the style of the window border
(Page 950) and window title for the object.
Size - - - -
Sizeable RW - - Specifies that the size of an object can be
(Page 955) changed in runtime.
SortSequence RW - - Specifies how the sorting order is changed
(Page 957) if the operator clicks on the column header
in runtime.
StatusbarBackCol‐ RW - - Specifies the background color for status
or (Page 962) bars.
StatusbarElemen‐ RW - - Creates a new, user-defined status bar el‐
tAdd (Page 963) ement.
StatusbarElemen‐ RW - - Specifies whether the width of a status bar
tAutoSize element referenced with "StatusbarEle‐
(Page 964) mentIndex" is set automatically.
StatusbarElement‐ RW - - Specifies the number of configured status
Count (Page 965) bar elements.
StatusbarElementI‐ RW - - References a status bar element with its
conId (Page 966) icon ID.
StatusbarElemen‐ RW - - References a status bar element with its
tID (Page 966) element ID.

VB scripting

fessional vanced
StatusbarElemen‐ RW - - References a status bar element.
tIndex (Page 967)
StatusbarElement‐ RW - - Specifies the name of a status bar element
Name (Page 968) referenced with "StatusbarElementIndex".
StatusbarElemen‐ RW - - Removes the user-defined status bar ele‐
tRemove ment referenced with its name.
(Page 969)
StatusbarElemen‐ RW - - Specifies the new name of a user-defined
tRename status bar element referenced with "Status‐
(Page 970) barElementIndex".
StatusbarElemen‐ RW - - Specifies the position of an element refer‐
tRepos (Page 971) enced with "StatusbarElementIndex" in the
status bar of the object.
StatusbarElement‐ RW - - Specifies the text of a user-defined status
Text (Page 972) bar element referenced with "StatusbarE‐
lementIndex".
StatusbarElement‐ RW - - Specifies the text for the tooltip of a user-
TooltipText defined status bar element referenced with
(Page 973) "StatusbarElementIndex".
StatusbarElemen‐ RW - - Specifies whether the configuration engi‐
tUserDefined neer has added a status bar element refer‐
(Page 973) enced with "StatusbarElementIndex" as a
new user-defined element.
StatusbarElement‐ RW - - Specifies whether the status bar element
Visible (Page 974) referenced with "StatusbarElementIndex"
is displayed in the object.
StatusbarElement‐ RW - - Specifies the width in pixels of a status bar
Width (Page 975) element referenced with "StatusbarEle‐
mentIndex".
StatusbarFont RW - - Specifies the font of the texts in the status
(Page 976) bar.
StatusbarFontCol‐ RW - - Specifies the color of the texts in the status
or (Page 977) bar.
StatusbarShow‐ RW - - Specifies whether tooltips are displayed for
Tooltips (Page 978) the elements of the status bar in runtime.
(Page 979)
StatusbarUseBack‐ RW - - Specifies whether the background color of
Color (Page 979) the status bar is shown.
StatusbarVisible RW - - Specifies whether the status bar of the con‐
(Page 980) trol is displayed.
TabIndex - - - -
TableColor RW - - Specifies the background color of the table
(Page 991) rows in the object.
TableColor2 RW - - Specifies the second background color of
(Page 991) the table rows in the object.

VB scripting

fessional vanced
TableForeColor RW - - Specifies the text color used in the table
(Page 993) cells of the object.
TableForeColor2 RW - - Specifies the second text color used in the
(Page 994) table cells of the object.
TimeBase RW - - Specifies the time zone in which the time
(Page 1026) values are displayed.
TitleColor RW - - Specifies the background color of the table
(Page 1048) header.
TitleCut RW - - Specifies whether the content of the fields
(Page 1049) in a title bar is to be shortened if the column
is too narrow.
TitleDarkShadow‐ RW - - Specifies the color for the dark side of the
Color (Page 1049) 3D shading for column and row headers in
the object table.
TitleForeColor RW - - Specifies the text color for the table column
(Page 1050) and row headers of the object.
TitleGridLineColor RW - - Specifies the color of the separation lines
(Page 1051) in the title bar of the table.
TitleLightShadow‐ RW - - Specifies the color for the light side of the
Color (Page 1052) 3D shading for table column and row head‐
ers of the object.
TitleSort RW - - Specifies how sorting by column header is
(Page 1053) triggered.
TitleStyle RW - - Specifies whether to use a shading color
(Page 1054) for the text in the column headers.
(Page 1062)
ToolbarBackColor RW - - Specifies the background color of the tool‐
(Page 1063) bar.
ToolbarButtonAc‐ RW - - Specifies whether the function linked to the
tive (Page 1064) button is activated in runtime.
ToolbarButtonAdd RW - - Creates a new user-defined button in the
(Page 1065) object's toolbar.
ToolbarButtonAu‐ RW - - Specifies the authorization for the selected
thorization key function.
(Page 1065)
ToolbarButtonBe‐ RW - - Inserts a leading separator (vertical line) for
ginGroup the selected key function on the toolbar.
(Page 1066)
(Page 1067)
ToolbarButton‐ RW - - Specifies the number of configured buttons
Count (Page 1068) in the toolbar.
ToolbarButtonEna‐ RW - - Specifies whether a user-defined toolbar
bled (Page 1069) button can be operated.
ToolbarButtonHot‐ RW - - Specifies the hot key for the selected object
Key (Page 1070) button.

VB scripting

fessional vanced
(Page 1070)
ToolbarButtonIn‐ RW - - References a button.
dex (Page 1071)
ToolbarButton‐ RW - - Specifies whether the locked, pressed
Locked state of a user-defined button referenced
(Page 1072) with "ToolbarButtonIndex" is displayed.
ToolbarButton‐ RW - - Specifies the name of a user-defined but‐
Name (Page 1073) ton referenced with "ToolbarButtonIndex".
ToolbarButtonRe‐ RW - - Removes a user-defined button referenced
move (Page 1074) with its name.
ToolbarButtonRe‐ RW - - Specifies the new name of a user-defined
name (Page 1075) button referenced with "ToolbarButtonIn‐
dex".
ToolbarButtonRe‐ RW - - Specifies the position of a button refer‐
pos (Page 1076) enced with "ToolbarButtonIndex" in the
toolbar of the object.
ToolbarButtonTool‐ RW - - Specifies the tooltip text for the user-de‐
tipText (Page 1077) fined button in the toolbar.
ToolbarButtonUser‐ RW - - Specifies whether the project engineer has
Defined added the toolbar button as new user-de‐
(Page 1078) fined button.
ToolbarButtonVisi‐ RW - - Specifies whether the button referenced
ble (Page 1079) with "ToolbarButtonIndex" is displayed in
the toolbar.
ToolbarShowTool‐ RW - - Specifies whether the tooltips for the key
tips (Page 1080) functions are displayed in runtime.
ToolbarUseBack‐ RW - - Specifies whether the background color for
Color (Page 1081) the toolbar is shown.
ToolbarUseHot‐ RW - - Specifies whether the hotkeys are activa‐
Keys (Page 1082) ted for buttons in the toolbar.
ToolbarVisible RW - - Specifies whether the toolbar of the control
(Page 1083) is displayed.
UseSelectedTitle‐ RW - - Specifies whether a selection color is used
Color (Page 1158) for the headers of selected table cells.
UseTableColor2 RW - - Specifies whether a second row color is
(Page 1160) used for the representation of the table.
VerticalGridLines RW - - Specifies whether vertical separation lines
(Page 1204) are displayed.
Visible (Page 1207) RW - - Specifies whether the selected object is
visible.

VB scripting
Table 1-118 Methods

sional vanced
(Page 1255) cle for a property with VBScript during runtime.
CutRows (Page 1262) Yes - - Executes the "Cut rows" key function of the recipe
view.
time.
DeleteRows Yes - - Executes the "Delete rows" key function of the recipe
(Page 1264) view.
GetColumn Yes - - Returns the column object of the recipe view desig‐
(Page 1266) nated by name or index as "ICCAxUAColumn" type.
GetColumnCollection Yes - - Returns the list of all column objects of the recipe
in the table-based controls as "ICCAxDataRow" type.
tion.
ment" type.
(Page 1321) trol.

VB scripting

sional vanced
PasteRows Yes - - Executes the "Insert rows" button function of the rec‐
(Page 1329) ipe view.
ReadTags (Page 1335) Yes - - Executes the "Read tags" button function of the rec‐
ipe view.
ServerExport Yes - - Executes the "Export log" button function of the rec‐
ServerImport Yes - - Executes the "Import log" button function of the rec‐
ShowSelectArchive Yes - - Executes the "Select data connection" button func‐
(Page 1356) tion of the recipe view.
ShowSelection Yes - - Executes the "Selection dialog" button function of
(Page 1356) the recipe view.
ShowSelectTimeBase Yes - - Executes the "Timebase dialog" button function of
(Page 1357) the recipe view.
ShowSort (Page 1358) Yes - - Executes the "Sorting dialog" button function of the
recipe view.
WriteTags (Page 1368) Yes - - Executes the "Write tags" button function of the rec‐
ipe view.

VB scripting
UserView (Panels, Comfort Panels, RT Advanced)
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Represents the "UserView" object. The UserView object is an element of the ScreenItems list.
Note
The object "Simple UserView" cannot be dynamized with a user-defined function.

HMIUserView

R Read
RW Read and write
- No access

sional vanced
AnimationIgnore - - - -
Appearance - - - -

VB scripting

sional vanced
BackColor (Page 529) - RW RW Specifies the background color of the selected ob‐
ject.
BorderColor - - - -
BorderWidth - - - -
Bounds - - - -
Columns - - - -
ColumnTextGroup - - - -
ColumnTextLogTime - - - -
ColumnTextPassword - - - -
ColumnTextUser - - - -
DeviceStyle - - - -
EdgeStyle - - - -
ated in runtime.
Es2rtButtonPositions - - - -
FitToSize - - - -
Flashing - - - -
IsMinPasswordValue‐ - - - -
Set
object.
ted object.
Location - - - -
MinPasswordValue - - - -
Name - - - -
PaddingLeft - - - -
PaddingTop - - - -
RTPersistence - - - -

VB scripting

sional vanced
RTPersistenceAuthori‐ - - - -
zation
RTPersistenceType - - - -
(Page 916)
(Page 918)
ShowColumnHeaders - - - -
ShowTableGridlines - - - -
Size - - - -
StyleItem - - - -
TabIndex - - - -
TableBackColor - RW RW Specifies the background color of the table cells for
Color
TableFont - - - -
(Page 993) object.
TableGridLineColor - RW RW Determines the color of the gridlines in the table of
(Page 994) the given object.
(Page 995) table of the selected object.
Style
BackColor
or
Width
dius
dientColor
dientOffset
TableHeaderForeColor - RW RW Specifies the text color in the header of the table of
dientColor
Bottom

VB scripting

sional vanced
gLeft
Right
Top
GradientColor
GradientOffset
Top (Page 1085) R RW RW Specifies the value of the Y coordinate of the selec‐
ted object.
ma
Gradient
condGradient
VerticalScrolling - - - -
ViewType - - - -
Stream
Table 1-120 Methods

sional vanced
time.

VB scripting
WindowSlider (RT Professional)
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Represents the "Window slider" object. The WindowSlider object is an element of the
ScreenItems list.

HMIWindowSlider

R Read
RW Read and write
- No access

sional vanced
(Page 520)
BackColorBottom RW - - Specifies the color for the lower / right part of the
(Page 532) object.

VB scripting

sional vanced
BackColorTop RW - - Specifies the color for the upper / left part of the ob‐
(Page 533) ject.
(Page 534)
(Page 536)
(Page 537)
AUTOHOTSPOT RW - - Specifies whether the background flashes in run‐
time.
(Page 539)
(Page 561) line.
BorderFlashingEnabled - - - -
(Page 573)
(Page 580)
Bounds - - - -
ated in runtime.
(Page 690)
(Page 688)
Flashing - - - -
HighLimitColor RW - - Specifies the color of the top or right scroll button in
(Page 729) a scroll bar.
JumpToLimitsAfterMou‐ RW - - Specifies whether the slider is set to the associated
seClick (Page 761) end value.
ject.

VB scripting

sional vanced
(Page 790)
Location - - - -
LowLimitColor RW - - Specifies the color of the bottom or left scroll button
(Page 799) in a scroll bar.
MarginToBorder RW - - Specifies the width of the 3D border in pixels.
(Page 801)
MaximumValue RW - - Specifies the maximum value of the scale in the se‐
MinimumValue RW - - Specifies the minimum value of the scale in the se‐
Name - - - -
OperationSteps R - - Returns the number of steps by which the slider of
(Page 843) the scrollbar is moved with one mouse click.
ProcessValue R - - Returns the default for the value to be displayed.
(Page 876)
RelativeFillLevel R - - Returns the percentage to which the object is filled.
(Page 883)
ShowBadTagState R - - Returns whether the object is grayed out in the event
(Page 929) of a bad quality code or tag status.
ShowFillLevel R - - Returns whether the specified object is filled.
(Page 936)
Size - - - -
StyleSettings R - - Returns the style in which the object is displayed.
(Page 985)
TabIndex - - - -
TextOrientation R - - Returns the text orientation.
(Page 1006)
ThumbBackColor R - - Returns the background color of the slider.
(Page 1009)
ToolTipText R - - Returns the tooltip text.
(Page 1084)
Top (Page 1085) R - - Returns the value of the Y coordinate.
(Page 1090)
object.
UseDesignShadowSet‐ R - - Returns whether the object is displayed with global
Visible (Page 1207) R - - Returns whether the specified object is visible.

VB scripting

sional vanced
Width (Page 1220) R - - Returns the width of the object in pixels.
WindowsStyle R - - Returns whether the object is displayed in the gen‐
(Page 1227) eral Windows style.
Table 1-122 Methods

sional vanced
time.
See also
BorderFlashingEnabled (Page 572)
WLanQualityView (Panels, Comfort Panels, RT Advanced)
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP

VB scripting
Represents the "WLAN reception" object. The WLanQualityView object is an element of the
ScreenItems list.

R Read
RW Read and write
- No access

sional vanced
Bounds - - - -
Height - - - -
Layer (Page 767) - - RW Specifies the layer in the screen that contains an
object.
Location - - - -
Name - - - -
Size - - - -
TabIndex - - - -
Width - - - -
Table 1-124 Methods

sional vanced

VB scripting
ZoneLabelView (Panels, Comfort Panels, RT Advanced)
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Represents the "Zone name" object. The ZoneLabelView object is an element of the
ScreenItems list.

HMIZoneLabelView

R Read
RW Read and write
- No access

sional vanced
Bounds - - - -
Font - - - -
Height - - - -
object.

VB scripting

sional vanced
Location - - - -
Name - - - -
Size - - - -
TabIndex - - - -
Width - - - -
Table 1-126 Methods

sional vanced
ZoneQualityView (Panels, Comfort Panels, RT Advanced)
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Represents the "ZoneSignal" object. The ZoneQualityView object is an element of the

ScreenItems list.

VB scripting

R Read
RW Read and write
- No access

sional vanced
Bounds - - - -
Height - - - -
object.
Location - - - -
Name - - - -
Size - - - -
TabIndex - - - -
Width - - - -
Table 1-128 Methods

sional vanced

VB scripting
1.5.5 Properties (Panels, Comfort Panels, RT Advanced, RT Professional)
1.5.5.1 Properties A (Panels, Comfort Panels, RT Advanced, RT Professional)
AboveUpperLimitColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the color when the high limit is exceeded.
Access in runtime
● RT Advanced: No access
● RT Professional: Read and write
Syntax
Object.AboveUpperLimitColor[=Color]
Object
Required. An object of the type "ScreenItem" with the following format:
● IOField
You have no access in runtime with the following format:
● GraphicIOField
● Switch
● SymbolLibrary
● SymbolicIOField
Color
Optional. A value or a constant that specifies the color for the "High limit violated" case.
Comments
You use the "RGB" function to specify the color in RGB format (red, green, blue). To do this,
enter the appropriate decimal value for each of the three RGB values (range from 0 to 255).
For example, the color "red" is shown like this:
RGB (255, 0, 0)
You can also use the VBS color constants such as vbRed and vbGreen.
See also
IOField (Page 331)
GraphicIOField (Page 323)

VB scripting
Switch (Page 419)

SymbolLibrary (Page 428)
SymbolicIOField (Page 423)
AcceptOnExit (RT Professional)
Description
Specifies whether the input field will be confirmed automatically when it is left.
Access in runtime: Read and write
Syntax
Object.AcceptOnExit[=BOOLEAN]
Object
Required. A "ScreenItem" object with the following format:
● IOField
● SymbolicIOField
BOOLEAN
Optional TRUE, if the input field will be confirmed automatically when it is left.
See also
IOField (Page 331)
AcceptOnFull (RT Professional)
Description
Specifies whether the input field will be left and confirmed automatically when the set number
of values have been entered.
Syntax
Object.AcceptOnFull[=BOOLEAN]
Object
● IOField

VB scripting
BOOLEAN
Optional TRUE, if the input field will be left and confirmed automatically when the set number
of values have been entered.
See also
IOField (Page 331)
AccessPath (RT Professional)
Description
Returns the storage path of a screen.
Access during runtime: Read
Syntax
Object.AccessPath
Object
Necessary. A "Screen" object.
Example
In the following example, the path of the picture "ScreenWindow1" is issued:
'VBS67
Dim objScreen
Set objScreen = HMIRuntime.Screens("ScreenWindow1")
MsgBox objScreen.AccessPath
See also
Screen (Page 214)
ActiveProject (RT Professional)
Description
Returns the specified project.
Access in Runtime: Read

VB scripting
Syntax
Object.ActiveProject
Object
Required A "HMIRuntime" object.
See also
HMIRuntime (Page 207)
Project (Page 213)
ActiveScreen (Panels, Comfort Panels, RT Advanced)
Description
Returns an object of type "Screen" which shows the screen that currently has the focus.
Note
If you query the "ActiveScreen" property in a user-defined function, it may be due to a screen
saver that the property does not return a valid "screen" object but "Nothing". A system message
will be issued.
Access in runtime: Read
Syntax
Object.ActiveScreen
Object
Required. An object of the type"HMIRuntime".
Comments
Which screen is returned depends on whether the root screen or the permanent area has the
focus.

VB scripting
The ActiveScreen property returns NOTHING if no screen has the focus. That is the case, for
example, when another window has the focus. With the statement "If not [expression] is
nothing" you are able to interrogate whether a screen is to be returned:
VBS example ActiveScreen

Dim objActiveScreen
Set objActiveScreen = HmiRuntime.ActiveScreen
If not objActiveScreen is nothing then
'found an active screen
HmiRuntime.Trace("There is an active screen." & vbCrLf)
Else
'found NO active screen
HmiRuntime.Trace("There is NO active screen." & vbCrLf)
End If
See also
ActiveScreen (RT Professional)
Description
Returns an object of type "Screen" which shows the screen that currently has the focus.
Note
If you query the "ActiveScreen" property in a function, it may be due to a ScreenSavers that
the property does not return a valid "Screen" object but "Nothing" and a system alarm is
displayed.
Syntax
Object.ActiveScreen
Object
Required. An object of the type"HMIRuntime".
Comments
Which screen is returned depends on whether the root screen or the permanent area has the
focus.

VB scripting
The ActiveScreen property returns NOTHING if no screen has the focus. That is the case, for
example, when another window has the focus. With the instruction "If not [printout] Is Nothing"
you can query whether a screen is going to be returned:
'VBS_Example_ActiveScreen
Dim objActiveScreen
Set objActiveScreen = HmiRuntime.ActiveScreen
If Not objActiveScreen Is Nothing Then
'found an active screen
HmiRuntime.Trace("There is an active screen." & vbCrLf)
Else
'found NO active screen
HmiRuntime.Trace("There is NO active screen." & vbCrLf)
End If
See also
ActiveScreenItem (RT Professional)
Description
References the screen object that currently has the focus.
It is only if the screen of the respective "Screen" object is currently selected and has an input
field that the "ActiveScreenItem" property of the "Screen" object will be occupied with a valid
"ScreenItem" object. In all other cases if, for example, another screen from the "Screens" list,
an independent window within WinCC or another application is selected, this property is not
supplied on the screens, i.e. assigned "Nothing".
Application
You use the "ActiveScreenItem" object to address the properties of the object that has the
focus in Runtime.
ActiveScreenItem (Panels, Comfort Panels, RT Advanced)
Description
References the screen object which currently has the focus.
The "ActiveScreenItem" property of the "Screen" object is only assigned a valid "ScreenItem"
object if the screen of the corresponding "Screen" object is active and has an input field. In all
other cases, for example, with a different screen from the "Screens" list, an independent
window within WinCC or a different application will be selected, this property will not apply to
the screens and will be occupied with "Nothing".

VB scripting
Application
The "ActiveScreenItem" object is used to address the object property which has the focus in
runtime.
ActualPointIndex (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the number of the current corner point.
Access in runtime:
Syntax
Object.ActualPointIndex[=Int32]
Object
Required. An object of the type "ScreenItem" with the format:
● Polygon
● Polyline
● Tubepolyline
● Line
Int32
Optional. A value or a constant that specifies the number of the current corner point.
See also
Polygon (Page 378)
Polyline (Page 381)
TubePolyline (Page 463)
Line (Page 336)
ActualPointLeft (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the X coordinate of the current corner point with reference to the screen origin. The
screen source is at the top left of the object. Every corner is identified by an index which is
derived from the number ("PointCount") of the existing corners.

VB scripting
Access in runtime:
Syntax
Object.ActualPointLeft[=Int32]
Object
● Polygon
● Polyline
● Tubepolyline
● Line
Int32
Optional. A value or a constant that specifies the X coordinate of the current corner point with
reference to the screen origin.
Comments
Changing the value can have an effect on the properties "Width" (object width) and "Left" (X
coordinate of the object position).
See also
Polygon (Page 378)
Polyline (Page 381)
Line (Page 336)
ActualPointTop (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the Y coordinate of the current corner point with reference to the screen origin. The
screen source is at the top left of the object.
Access in runtime:

VB scripting
Syntax
Object.ActualPointTop[=Int32]
Object
● Polygon
● Polyline
● Tubepolyline
● Line
Int32
Optional. A value or a constant that specifies the Y coordinate of the current corner point with
reference to the screen origin.
Comments
Changing the value can have an effect on the properties "Height" (object height) and "Top" (X
coordinate of the object position).
See also
Polygon (Page 378)
Polyline (Page 381)
Line (Page 336)
AdaptBorder (RT Professional)
Description
Specifies whether the border of the object will be dynamically adapted to the text size.
Syntax
Object.AdaptBorder[=BOOLEAN]
Object
● Button
● CheckBox

VB scripting
● IOField
● OptionGroup
● SymbolicIOField
BOOLEAN
Optional.
TRUE, if the border of the object is dynamically adapted to the text size.
FALSE, if the border of the object is not dynamically adapted to the text size.
See also
Button (Page 265)
CheckBox (Page 274)
IOField (Page 331)
OptionGroup (Page 371)
AdaptPicture (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
No access in runtime.
AdaptScreenToWindow (RT Professional)
Description
Specifies whether or not the screen displayed in a screen window adapts to the size of the
screen window in runtime.
Access in runtime Read and write
Syntax
Object.AdaptScreenToWindow[=BOOLEAN]
Object
● Screenwindow
BOOLEAN
Optional.
TRUE, if the screen adapts to the screen window size.

VB scripting
FALSE, if the screen does not adapt to the screen window size.
See also
ScreenWindow (Page 404)
AdaptWindowtoScreen (RT Professional)
Description
Specifies whether the screen window adapts to the screen it displays in runtime.
Syntax
Object.AdaptWindowtoScreen[=BOOLEAN]
Object
● Screenwindow
BOOLEAN
Optional.
TRUE, if the screen window size adapts to the screen.
FALSE, if the screen window size does not adapt to the screen.
See also
Address (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the web address that will be opened in the HTML browser.
Syntax
Object.Address[=STRING]

VB scripting
Object
● HTMLBrowser
STRING
Optional. A value or a constant that contains the web address.
See also
HTMLBrowser (Page 329)
AddressEnabled (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
AdressPreview (RT Advanced)
Description
AdvancedButtonPositions (RT Advanced)
Description
AdvancedView (RT Advanced)
Description
Alarm (RT Professional)
Description

VB scripting
AlarmAreaHeight (RT Advanced)
Description
AlarmAreaWidth (RT Advanced)
Description
AlarmClasses (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
AlarmColor (RT Professional)
Description
AlarmID (RT Professional)
Description
Returns the AlarmID of the Alarm object. The AlarmID is unique and is assigned by the system.
AlarmID (readonly)
See also
Alarms (list) (Page 199)
AlarmLog (Panels, Comfort Panels, RT Advanced, RT Professional)
Description

VB scripting
AlarmLogs (RT Professional)
Description
Returns an object of type "AlarmLogs".
Syntax
Object.AlarmLogs
Object
Required A "Logging" object.
See also
Logging (Page 212)
AlarmLowerLimit (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the low limit at which the alarm is triggered.
Syntax
Object.AlarmLowerLimit[=DOUBLE]
Object
● Bar
DOUBLE
Optional A value or a constant that specifies the low limit at which the alarm is triggered.
Comments
The type of evaluation (percentage or absolute) is defined using the "AlarmLowerLimitRelative"
property.
The "AlarmLowerLimitEnable" property defines whether or not monitoring of this limit is
enabled.

VB scripting
See also
Bar (Page 257)
AlarmLowerLimitColor (RT Professional)
Description
Specifies the bar color for the "AlarmLowerLimit" limit.
The "AlarmLowerLimitEnable" property must have the value TRUE if the bar color is to change
once the limit has been reached.
Access in runtime:
Syntax
Object.AlarmLowerLimitColor[=Color]
Object
● Bar
● Slider
Color
Optional. A value or a constant that specifies the bar color for the "AlarmLowerLimit" limit.
Comments
RGB (255, 0, 0)
See also
Bar (Page 257)
Slider (Page 409)

VB scripting
AlarmLowerLimitEnabled (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies whether the "AlarmLowerLimit" limit is monitored.
Syntax
Object.AlarmLowerLimitEnabled[=BOOLEAN]
Object
● Bar
BOOLEAN
Optional TRUE, if the "AlarmLowerLimit" limit is monitored.
Comments
The following values will be defined via the properties "AlarmLowerLimit",
"AlarmLowerLimitColor" and "AlarmLowerLimitRelative":
Limit
Representation upon reaching the limit
Type of evaluation
See also
Bar (Page 257)
AlarmLowerLimitRelative (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Establish whether the lower limit at which the interrupt is triggered is evaluated as a percentage
or an absolute value.
Syntax
Object.AlarmLowerLimitRelative[=BOOLEAN]

VB scripting
Object
● Bar
BOOLEAN
Optional TRUE, if the lower limit at which the interrupt is triggered is evaluated as a percentage.
See also
Bar (Page 257)
AlarmSource (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
AlarmTextTag (RT Professional)
Description
AlarmUpperLimit (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Establishes the upper limit at which the interrupt will be triggered.
Syntax
Object.AlarmUpperLimit[=DOUBLE]
Object
● Bar
DOUBLE
Optional A value or a constant that defines the upper limit at which an interrupt will be triggered.

VB scripting
Comments
The type of evaluation (percentage or absolute) is defined using the "AlarmUpperLimitRelative"
property.
The "AlarmUpperLimitEnable" property defines whether or not monitoring of this limit is
enabled.
See also
Bar (Page 257)
AlarmUpperLimitColor (RT Professional)
Description
Specifies the bar color for the "AlarmUpperLimit" limit.
The "AlarmUpperLimitEnable" property must have the value TRUE if the bar color is to change
once the limit has been reached.
Access in runtime:
Syntax
Object.AlarmUpperLimitColor[=Color]
Object
● Bar
● Slider
Color
Optional. A value or a constant that specifies the bar color for the "AlarmUpperLimit" limit.
Comments
RGB (255, 0, 0)

VB scripting
See also
Bar (Page 257)
Slider (Page 409)
AlarmUpperLimitEnabled (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies whether the "AlarmUpperLimit" limit is monitored.
Syntax
Object.AlarmUpperLimitEnabled[=BOOLEAN]
Object
● Bar
BOOLEAN
Optional TRUE, if the "AlarmUpperLimit" limit is monitored.
Comments
The following values will be defined via the properties "AlarmUpperLimit",
"AlarmUpperLimitColor" and "AlarmUpperLimitRelative":
● Limit
● Representation upon reaching the limit
● Type of evaluation
See also
Bar (Page 257)
AlarmUpperLimitRelative (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Establish whether the upper limit at which the interrupt is triggered is evaluated as a percentage
or an absolute value.

VB scripting
Syntax
Object.AlarmUpperLimitRelative[=BOOLEAN]
Object
● Bar
BOOLEAN
Optional TRUE, if the high limit at which the interrupt is triggered is evaluated as a percentage.
See also
Bar (Page 257)
AllFilters (RT Professional)
Description
AllFiltersForHitlist (RT Professional)
Description
AllowEdit (RT Advanced)
Description
AllowMenu (RT Advanced)
Description
No access in runtime
AllServer (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies whether the alarms of all available servers are displayed.

VB scripting
Syntax
Object.AllServer[=BOOLEAN]
Object
Required. A "ScreenItem" object with the following characteristics:
● AlarmControl
BOOLEAN
Optional.
TRUE, if the alarms of all available servers are displayed.
FALSE, if only the alarms of the selected server are displayed.
See also
AlarmControl (Page 235)
AllTagTypesAllowed (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Analog (RT Professional)
Description
Specifies whether the clock should be shown as an analog clock.
Syntax
Object.Analog[=BOOLEAN]
Object
● Clock
BOOLEAN
Optional TRUE, if the clock should be shown as an analog clock.

VB scripting
See also
Clock (Page 286)
AngleMax (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the angle of the scale end of the "Gauge" object.
Syntax
Object.AngleMax[=DOUBLE]
Object
● Gauge
DOUBLE
Optional A value or a constant that specifies the angle in degrees.
Comments
The start and end of the scale gradations are described with the properties "AngleMin" and
"AngleMax" in angle degrees.
The value of the AngleMin property must always be less than the value of the AngleMax
property. The zero degree angle is located at the 3 o´clock position on the scale. Positive angle
values are counted clockwise.
See also
Gauge (Page 319)
AngleMin (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the angle of the scale start of the "Gauge" object.
Syntax
Object.AngleMin[=DOUBLE]

VB scripting
Object
● Gauge
DOUBLE
Optional A value or a constant that specifies the angle in degrees.
Comments
The start and end of the scale gradations are described with the properties "AngleMin" and
"AngleMax" in angle degrees.
The value of the AngleMin property must always be less than the value of the AngleMax
property.
The zero degree angle is located at the 3 o´clock position on the scale. Positive angle values
are counted clockwise.
See also
Gauge (Page 319)
AnimationIgnore (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Appearance (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ApplyProjectSettings (RT Professional)
Description
Specifies whether the project settings are applied from the "HMI alarms" editor.
Syntax
Object.ApplyProjectSettings[=BOOLEAN]

VB scripting
Object
● AlarmControl
BOOLEAN
Optional.
TRUE when the alarm text blocks configured in the "HMI alarms" editor are applied in the alarm
view with their properties. The alarm text blocks are displayed with these properties in the
alarm view.
FALSE when the properties are not applied.
See also
ApplyProjectSettingsForDesignMode (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ArchiveName (RT Professional)
Description
Specifies the log name.
Syntax
Object.ArchiveName[=STRING]
Object
Required. A "ScreenItem" object with the characteristics:
● UserArchiveControl
STRING
Optional. A value or a constant that specifies the log name.
See also
UserArchiveControl (Page 468)

VB scripting
ArchiveType (RT Professional)
Description
Sets the log type.
Syntax
Object.ArchiveType[=RecipeControlDataSourceType]
Object
RecipeControlDataSourceType
Optional. Value or constant that specifies the log type.
Value Designation Explanation

0 Unknown Specifies no log type.
1 Recipe Specifies that the log type is a recipe.
2 Recipe query Specifies that the log type is a recipe query.
See also
AskOperationMotive (RT Professional)
Description
Specifies whether the reason for operating this object is logged. If the object is operated in
runtime, the operator enters the reason in a dialog.
Syntax
Object.AskOperationMotive[=BOOLEAN]
Object
● ComboBox
● IOField
● ListBox

VB scripting
● SymbolicIOField
● WindowSlider
BOOLEAN
Optional.TRUE if the reason for operating this object is to be logged.
See also
ComboBox (Page 289)
IOField (Page 331)
Listbox (Page 339)
WindowSlider (Page 484)
AspectRatio (RT Professional)
Description
Specifies whether the aspect ratio of the Media Player is maintained when the size is
modified.
Access in Runtime: Read and write
Syntax
Object.AspectRatio[=BOOLEAN]
Object
Required. An object of the "ScreenItem" type with the format:
● MediaPlayer
BOOLEAN
Optional.
TRUE, if the aspect ratio of the Media Player is not maintained when the size is modified.
FALSE, if the aspect ratio of the Media Player is not maintained when the size is modified.
See also
MediaPlayer (Page 342)

VB scripting
AssignedFilters (RT Professional)
Description
AssignedHitlistFilters (RT Professional)
Description
Assignments (RT Professional)
Description
Specifies a list which contains the assignments between the output value and the output text
actually to be output. The assignments are dependent on the set list type. You define the list
type with the ListType property.
Syntax
Object.Assignments[=STRING]
Object
● SymbolicIOField
STRING
Optional Specifies a list which contains the assignments between the output value and the
output text actually to be output.
See also
AssociatedS7GraphDBName (Panels, Comfort Panels, RT Advanced, RT Professional)
Description

VB scripting
AssociatedS7GraphDBTag (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Authorization (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies operating rights.
Syntax
Object.Authorization[=HMIRTAuthorization]
Object
Required. A "ScreenItem" object with the format:
● Bar
● Button
● CheckBox*
● Circle *
● CircleSegment *
● CircularArc *
● ComboBox*
● Connector *
● DateTimeField **
● Ellipse *
● EllipseSegment *
● EllipticalArc *
● GraphicIOField
● GraphicView *
● IOField
● Line *
● ListBox *
● MultiLineEdit *
● OptionGroup *
● Polygon *

VB scripting
● Polyline *
● RecipeView **
● Rectangle *
● RoundButton *
● S7GraphOverview *
● Slider
● StatusForce **
● Switch **
● SymbolLibrary **
● SymbolicIOField
● TextField *
● TrendView
● TubeArcObject *
● TubeDoubleTeeObject *
● TubeTeeObject *
● Tubepolyline *
● UserView **
● WindowSlider *
* No access in RT Advanced
** No access in RT Professional

● AlarmView
● PLCCodeViewer
● PdfView
● ProtectedAreaNameView
● RangeLabelView
● SysDiagControl
HMIRTAuthorization
Optional. A value or a constant which specifies the operating rights.

VB scripting
AutoCompleteColumns (RT Professional)
Description
Specifies whether empty columns are shown if the control is wider than the configured
columns.
Syntax
Object.AutoCompleteColumns[=BOOLEAN]
Object
● AlarmControl
● OnlineTableControl
● TrendRulerControl
BOOLEAN
Optional.
TRUE if the empty columns are shown.
FALSE if the empty columns are not shown.
See also
OnlineTableControl (Page 347)
TrendRulerControl (Page 443)
AutoCompleteRows (RT Professional)
Description
Specifies whether empty rows are shown if the control is longer than the number of configured
rows.
Syntax
Object.AutoCompleteRows[=BOOLEAN]

VB scripting
Object
● AlarmControl
BOOLEAN
Optional.
TRUE if the empty rows are shown.
FALSE if the empty rows are not shown.
See also
AutoPosition (RT Professional)
Description
Specifies whether the value table is automatically placed below the object that supplies the
value table with data.
Syntax
Object.AutoPosition[=BOOLEAN]
Object
BOOLEAN
Optional.
TRUE, if the object is automatically placed below the data source.
FALSE, if the object is placed at the configured position.

VB scripting
See also
AutoScroll (RT Professional)
Description
Specifies whether autoscroll is used.
Syntax
Object.AutoScroll[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
Optional.
TRUE if autoscroll is used.
See also
AutoSelectionColors (RT Professional)
Description
Specifies whether the colors defined by the system are used as the selection colors for cells
and rows.
Syntax
Object.AutoSelectionColors[=BOOLEAN]
Object
● AlarmControl

VB scripting
BOOLEAN
Optional.
TRUE if the system color is used.
FALSE if the user-defined color is used.
See also
AutoSelectionRectColor (RT Professional)
Description
Specifies whether the selection frame is shown with the color defined by the system.
Syntax
Object.AutoSelectionRectColor[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
Optional.
TRUE if the system color is used.
FALSE if the user-defined color is used.

VB scripting
See also
AutoShow (RT Professional)
Description
Specifies whether the value table is shown automatically.
Syntax
Object.AutoShow[=BOOLEAN]
Object
BOOLEAN
Optional.
TRUE, if the value table is shown automatically.
FALSE, if the value table is not shown automatically.
See also
AutoSizing (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
AutoStart (RT Professional)
Description

VB scripting
AvailableStatusbarElements (RT Professional)
Description
AvailableToolbarButtons (RT Professional)
Description
AverageLast15Values (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies whether the average of the last 15 values is to be shown.
Syntax
Object.AverageLast15Values[=BOOLEAN]
Object
● Bar
BOOLEAN
Optional.
TRUE if the average of the last 15 values is to be shown.
FALSE if the average of the last 15 values is not to be shown.
See also
Bar (Page 257)
AxisXBunchCount (RT Advanced)
Description

VB scripting
AxisXMarkCount (RT Advanced)
Description
AxisXNoOfDigits (RT Advanced)
Description
AxisXShowBunchValues (RT Advanced)
Description
AxisXStyle (RT Advanced)
Description
AxisY1BunchCount (RT Advanced)
Description
AxisY1MarkCount (RT Advanced)
Description
AxisY1ShowBunchValues (RT Advanced)
Description

VB scripting
AxisY2BunchCount (RT Advanced)
Description
AxisY2MarkCount (RT Advanced)
Description
AxisY2ShowBunchValues (RT Advanced)
Description
1.5.5.2 Properties B (Panels, Comfort Panels, RT Advanced, RT Professional)
BackButtonVisible (RT Advanced)
Description
BackColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the background color.
Syntax
Object.BackColor[=Color]
Object
● AlarmControl *
● AlarmView
● Bar

VB scripting
● Button **
● CheckBox *
● Circle
● CircleSegment *
● CircularArc *
● ComboBox *
● Connector *
● Ellipse
● EllipticalArc *
● FunctionTrendControl *
● Gauge
● GraphicIOField **
● GraphicView
● IOField
● Line
● ListBox *
● MultiLineEdit *
● OnlineTableControl *
● OnlineTrendControl *
● OptionGroup *
● Polygon
● Polyline
● RecipeView **
● Rectangle
● RoundButton *
● Slider
● StatusForce **
● Switch **
● SymbolLibrary
● SymbolicIOField
● TextField
● TrendRulerControl *
● UserArchiveControl *

VB scripting
● UserView **
● WindowSlider *
* RT Advanced No access
** RT Professional No access

● TrendView
● TubeArcObject
Color
Optional. A value or a constant that specifies the background color.
Comments
RGB (255, 0, 0)
The background color is not visible if the "BorderStyle" property has the value "0".
See also
AlarmView (Page 250)
Bar (Page 257)
Button (Page 265)
CheckBox (Page 274)
Circle (Page 278)
CircleSegment (Page 281)
CircularArc (Page 284)
ComboBox (Page 289)
Connector (Page 292)
DateTimeField (Page 295)
Ellipse (Page 299)
EllipseSegment (Page 302)
EllipticalArc (Page 305)
FunctionTrendControl (Page 308)

VB scripting
Gauge (Page 319)

GraphicView (Page 326)
IOField (Page 331)
Line (Page 336)
Listbox (Page 339)
MultiLineEdit (Page 344)
OnlineTrendControl (Page 359)
Polygon (Page 378)
Polyline (Page 381)
RecipeView (Page 389)
Rectangle (Page 395)
RoundButton (Page 398)
Slider (Page 409)
StatusForce (Page 414)
Switch (Page 419)
TextField (Page 439)
TrendView (Page 453)
TubeArcObject (Page 459)
UserView (Page 480)
BackColorBottom (RT Professional)
Description
Specifies the color for the lower / right part of the object.

VB scripting
Syntax
Object.BackColorBottom[=Color]
Object
● WindowSlider
Color
Optional. A value or a constant that specifies the color for the lower / right part of the object.
Comments
RGB (255, 0, 0)
See also
BackColorTop (RT Professional)
Description
Specifies the color for the upper / left part of the object.
Syntax
Object.BackColorTop[=Color]
Object
● WindowSlider
Color
Optional. A value or a constant that specifies the color for the upper / left part of the object.

VB scripting
Comments
RGB (255, 0, 0)
See also
BackFillStyle (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the fill pattern.
Syntax
Object.BackFillStyle[=FillStyle]
Object
● Bar
● Button*
● CheckBox*
● Circle
● CircleSegment *
● Clock*
● ComboBox
● Ellipse
● Gauge*
● GraphicView*
● IOField*
● ListBox*
● OptionGroup*
● Polygon

VB scripting
● Rectangle
● RoundButton*
● Slider*
● SymbolLibrary*
● SymbolicIOField*
● TextField*
● WindowSlider*

● DateTimeField
● GraphicIOField
● Switch
FillStyle
Optional. A value or a constant that specifies the fill style.
Value VB constant Explanation

0 hmiFillStyleSolid Object is filled with the specified color
1 hmiFillStyleTransparent Transparent fill
See also
Bar (Page 257)
Button (Page 265)
CheckBox (Page 274)
Clock (Page 286)
ComboBox (Page 289)
Gauge (Page 319)
IOField (Page 331)
Listbox (Page 339)
Slider (Page 409)
Switch (Page 419)

VB scripting

BackFlashingColorOff (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the background color for flash state "Off".
Access in runtime:
Syntax
Object.BackFlashingColorOff[=Color]
Object
● Bar
● Button
● CheckBox
● GraphicView
● IOField
● OptionGroup
● RoundButton
● SymbolicIOField
● TextField
● WindowSlider
● Switch
Color
Optional. A value or a constant that specifies the color of the background for the flashing status
"off".
Comments

VB scripting
RGB (255, 0, 0)
See also
Bar (Page 257)
Button (Page 265)
CheckBox (Page 274)
IOField (Page 331)
Switch (Page 419)
BackFlashingColorOn (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the background color for flash state "On".
Access in runtime:
Syntax
Object.BackFlashingColorOn[=Color]
Object
● Bar
● Button
● CheckBox
● GraphicView
● IOField
● OptionGroup
● RoundButton
● SymbolicIOField

VB scripting
● TextField
● WindowSlider
● Switch
Color
Optional. A value or a constant that specifies the color of the background for the flashing status
"on".
Comments
RGB (255, 0, 0)
See also
Bar (Page 257)
Button (Page 265)
CheckBox (Page 274)
IOField (Page 331)
Switch (Page 419)
BackFlashingEnabled (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies whether the background flashes in runtime.
Access in runtime:

VB scripting
Syntax
Object.BackFlashingEnabled[=BOOLEAN]
Object
● Bar
● Button
● CheckBox
● GraphicView
● IOField
● OptionGroup
● RoundButton
● SymbolicIOField
● TextField
● WindowSlider
● Switch
BOOLEAN
Optional. TRUE if the background flashes in runtime.
See also
Bar (Page 257)
Button (Page 265)
CheckBox (Page 274)
IOField (Page 331)
Switch (Page 419)
BackFlashingRate (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the flash rate of the background.

VB scripting
Access in runtime:
Syntax
Object.BackFlashingRate[=FlashingRate]
Object
● Bar
● Button
● CheckBox
● GraphicView
● IOField
● OptionGroup
● RoundButton
● SymbolicIOField
● TextField
● WindowSlider
● Switch
FlashingRate
Optional. A value or a constant that specifies the flash rate of the background.

0 hmiFlashingRateSlow The length of the flashing interval is 250 ms.
1 hmiFlashingRateMedium The length of the flashing interval is 500 ms.
2 hmiFlashingRateFast The length of the flashing interval is 1000 ms.
See also
Bar (Page 257)
Button (Page 265)
CheckBox (Page 274)
IOField (Page 331)

VB scripting
Switch (Page 419)

BackgroundColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
See also
BackPicture (RT Professional)
Description
Specifies the background graphic.
Syntax
Object.BackPicture[=HmiObjectHandle]
Object
● Gauge
● Slider
HmiObjectHandle
Optional. A value or a constant that specifies the background graphic.
See also
Gauge (Page 319)
Slider (Page 409)
BackStyle (RT Professional)
Description
Specifies the background style.

VB scripting
Syntax
Object.BackStyle[=Int32]
Object
● Gauge
Int32
Optional. A value or a constant that specifies the background style.

0 Solid The rectangular background of the display is filled with the specified border
color. The scale disk is filled with the specified background color.
1 Transparent border The rectangular background of the dial gauge is transparent. The scale
disk is filled with the specified background color. As a result, a circular
display can be shown.
2 Transparent The rectangular background and the scale disk are transparent.
See also
Gauge (Page 319)
BarBackColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the color of the bar background for the selected object.
Syntax
Object.BarBackColor[=Color]
Object
● Bar
● Slider
Color
Optional. A value or a constant that specifies the color of the bar background.

VB scripting
Comments
RGB (255, 0, 0)
See also
Bar (Page 257)
Slider (Page 409)
BarBackFillStyle (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the fill style for the bar.
Syntax
Object.BarBackFillStyle[=FillStyle]
Object
● Bar
FillStyle
Optional. A value or a constant that specifies the fill pattern of the bar.

65536 hmiFillStyleTransparent Transparent fill pattern
0 hmiFillStyleSolid Solid fill pattern
131075 hmiFillStyleBackwardDiago‐ Diagonal fill pattern striped towards the top right
nal
131076 hmiFillStyleCross Checked fill pattern
131077 hmiFillStyleDiagonalCross Diagonal checked fill pattern
131074 hmiFillStyleForwardDiagonal Diagonal fill pattern striped towards the top left
131072 hmiFillStyleHorizontal Horizontal striped fill pattern
131073 hmiFillStyleVertical Vertical striped fill pattern
196608 - hmiFillStylePattern1 - hmiFill‐ Predefined fill pattern
196644 StylePattern37

VB scripting
See also
Bar (Page 257)
BarBackFlashingColorOff (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the color ###
Syntax
Object.BarBackFlashingColorOff[=Color]
Object
● Bar
Color
Optional. A value or a constant that specifies the color of ###
BarBackFlashingColorOn (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the color ###
Syntax
Object.BarBackFlashingColorOn[=Color]
Object
● Bar
Color
Optional. A value or a constant that specifies the color of ###

VB scripting
BarBackFlashingEnabled (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies whether ###
Syntax
Object.BarBackFlashingEnabled[=BOOLEAN]
Object
● Bar
BOOLEAN
Optional. TRUE, if ###
BarBackFlashingRate (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Sets the flash rate ###
Syntax
Object.BarBackFlashingRate[=FlashingRate]
Object
● Bar
FlashingRate
Optional. A value or a constant that specifies the flash rate ###
BarColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the color of the bar.

VB scripting
Syntax
Object.BarColor[=Color]
Object
● Slider
Color
Optional. A value or a constant that specifies the color of the slider.
Comments
RGB (255, 0, 0)
The range extends from the value in "MinimumValue (Page 825)" to the position of the slider.
See also
Slider (Page 409)
BarEdgeStyle (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies ###
Access in Runtime:
● RT Advanced: Read
Syntax
Object.BarEdgeStyle[=LineStyle]
Object
● Bar
LineStyle
Optional. A value or a constant, which ###

VB scripting
BarOrientation (RT Professional)
Description
Specifies the bar alignment.
Access in runtime
Syntax
Object.BarOrientation[=BarOrientation]
Object
● Bar
● Slider
BarOrientation
Optional. A value or a constant that specifies the bar direction.
Value Designation Description

0 Top The bar is aligned vertically. The maximum scale value is located at the top edge of the bar.
1 Bottom The bar is aligned vertically. The maximum scale value is located at the bottom edge of the bar.
2 Left The bar is aligned horizontally. The maximum scale value is arranged on the left.
3 Right The bar is aligned horizontally. The maximum scale value is arranged on the right.
See also
Bar (Page 257)
Slider (Page 409)
BaseScreenName (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Reads the name of the current root screen or triggers a root screen change by setting a new
screen name.

VB scripting
Syntax
Object.BaseScreenName[= STRING]
Object
Required An "HMIRuntime" object.
STRING
Optional A value or a constant that contains the screen name.
Comments
You can also use the property to establish which screen is currently being displayed.
See also
BelowLowerLimitColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the color for the "Low limit violated" event.
Access in runtime:
Syntax
Object.BelowLowerLimitColor[=Color]
Object
● IOField
● GraphicIOField
● Switch
● SymbolLibrary
● SymbolicIOField
Color
Optional. A value or a constant which specifies the color.

VB scripting
Comments
RGB (255, 0, 0)
BitNumber (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the bit whose status must change to trigger a value change.
Access in runtime:
Syntax
Object.BitNumber[=Int32]
Object
● SymbolicIOField
● Button
● GraphicIOField
Int32
Optional Specifies the bit whose status must change to trigger a value change.
Comments
The tag being used must be of type BYTE, WORD or DWORD.
See also
Button (Page 265)

VB scripting
BlinkColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the color in which the object flashes in runtime.
Syntax
Object.BlinkColor[=Color]
Object
● SymbolLibrary
Color
Optional. A value or a constant that specifies the flash color.
Comments
RGB (255, 0, 0)
See also
BlinkMode (RT Professional)
Description
Specifies the type of flash graphic for the specified object.
Syntax
Object.BlinkMode[=SymbolLibraryBlinkMode]
Object
● SymbolLibrary

VB scripting
SymbolLibraryBlinkMode
Optional. A value or a constant that specifies the type of flash picture for the specified object.

0 hmiSymbolLibraryFlashing‐ Flashing is switched off.
None
1 hmiSymbolLibraryFlashin‐ The flash picture is invisible.
gInvisible
2 hmiSymbolLibraryFlashing‐ The flash picture is given a colored, shaded surface. The
Shaded color of the surface corresponds to the settings in the prop‐
erty "BlinkColor".
3 hmiSymbolLibraryFlashing‐ The flash picture is given a colored, unshaded surface. The
Solid color of the surface corresponds to the settings in the prop‐
erty "BlinkColor".
See also
BlinkSpeed (RT Professional)
Description
Sets the flash rate.
Fast - 250: The length of the flashing interval is 250 ms. Medium - 500: The length of the
flashing interval is 500 ms.
Slow - 1000: The length of the flashing interval is 1000 ms. The default value is medium - 500.
Syntax
Object.BlinkSpeed[=FlashingRate]
Object
● SymbolLibrary
FlashingRate
Optional. A value or a constant that specifies the flash rate.

1 hmiFlashingRateMedi‐ The length of the flashing interval is 500 ms.
um

VB scripting
See also
BlockAlignment (RT Professional)
Description
Specifies the alignment of the text within the column header of the referenced block.
Syntax
Object.BlockAlignment[=HorizontalAlignment]
Object
HorizontalAlignment
Optional. A value or constant that determines the horizontal alignment.
Value VB constant Description

0 hmiAlignmentLeft The text in the column header is left-justified.
1 hmiAlignmentCentered The text in the column header is centered.
2 hmiAlignmentRight The text in the column header is right-justified.
See also
BlockAutoPrecision (RT Professional)
Description
Specifies whether the number of decimal places displayed in the current block is adjusted
automatically.
Syntax
Object.BlockAutoPrecisions[=BOOLEAN]

VB scripting
Object
BOOLEAN
Optional.
TRUE, if the number of displayed decimal places is adapted automatically.
FALSE, if the number of displayed decimal places is not adapted automatically.
See also
BlockCaption (RT Professional)
Description
Specifies the header of the current block.
Syntax
Object.BlockCaption[=STRING]
Object
STRING
Optional. A value or a constant that specifies the header of the block.
See also
BlockCount (RT Professional)
Description
Specifies the number of blocks.

VB scripting
Syntax
Object.BlockCount[=Int32]
Object
Int32
Optional. A value or a constant that specifies the number of blocks.
See also
BlockDateFormat (RT Professional)
Description
Specifies the format for date information in the current block.
Syntax
Object.BlockDateFormat[=STRING]
Object
STRING
Optional. A value or a constant that specifies the format for date information.
See also
BlockExponentialFormat (RT Professional)
Description
Specifies whether the values in the current block are displayed in exponential notation.

VB scripting
Syntax
Object.BlockExponentialFormat[=BOOLEAN]
Object
BOOLEAN
Optional.
TRUE, if the values are displayed in exponential notation.
FALSE, if the values are displayed in decimal notation.
See also
BlockHideText (RT Professional)
Description
BlockHideTitleText (RT Professional)
Description
Specifies whether the header of the block is displayed as text.
Syntax
Object.BlockHideTitleText[=BOOLEAN]
Object
BOOLEAN
Optional.
TRUE, if the header of the block is displayed as text.
FALSE, if the header of the block is not displayed as text.

VB scripting
See also
BlockId (RT Professional)
Description
References a block with its block ID. To access the properties of a block, you need to set
"BlockId".
Syntax
Object.BlockId[=Int32]
Object
Int32
Optional. A value or a constant that specifies the ID of the current block.
See also
BlockIndex (RT Professional)
Description
References a block. To access the properties of a block, you need to set "BlockIndex".
Values between 0 and "BlockIndex" minus 1 are valid for "BlockCount". The "BlockCount"
property specifies the number of configured blocks.
Syntax
Object.BlockIndex[=Int32]
Object

VB scripting
Int32
Optional. A value or a constant that specifies the number of the current block.
See also
BlockLength (RT Professional)
Description
Specifies the number of characters of the current block.
Syntax
Object.BlockLength[=Int32]
Object
Int32
Optional. A value or a constant that specifies the number of characters.
See also
BlockName (RT Professional)
Description
Specifies the name of the current block.
Syntax
Object.BlockName[=STRING]
Object

VB scripting
STRING
Optional. A value or a constant that specifies the name of the block.
See also
BlockPrecision (RT Professional)
Description
Specifies the number of decimal places in the current block.
Syntax
Object.BlockPrecisions[=Int16]
Object
Int16
Optional. A value or a constant that specifies the number of decimal places.
See also
Blocks (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
BlockShowDate (RT Professional)
Description
Specifies that the date is displayed in the current block.

VB scripting
Syntax
Object.BlockShowDate[=BOOLEAN]
Object
BOOLEAN
Optional.
TRUE, if the date is displayed in the current block.
FALSE, if the date is not displayed in the current block.
See also
BlockShowIcon (RT Professional)
Description
Specifies whether the content of the current block is displayed as an icon.
Syntax
Object.BlockShowIcon[=BOOLEAN]
Object
BOOLEAN
Optional.
TRUE, if the content of the current block is displayed as an icon.
FALSE, if the content of the current block is not displayed as an icon.
See also

VB scripting
BlockShowTitleIcon (RT Professional)
Description
Specifies whether the header of the current block is displayed as an icon.
Syntax
Object.BlockShowTitleIcon[=BOOLEAN]
Object
BOOLEAN
Optional.
TRUE, if the header of the current block is displayed as an icon.
FALSE, if the header of the current block is not displayed as an icon.
See also
BlockTimeFormat (RT Professional)
Description
Specifies the format of the time information in the current block.
Syntax
Object.BlockTimeFormat[=STRING]
Object
STRING
A value or a constant that specifies the format of the time information.

VB scripting
See also
BlockUseSourceFormat (RT Professional)
Description
Specifies whether the format of the connected control is used in the current block.
Syntax
Object.BlockUseSourceFormat[=BOOLEAN]
Object
BOOLEAN
Optional.
TRUE, if the format of the connected control is used in the current block.
FALSE, if the configured format is used in the current block.
See also
BorderBackColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the background color of the broken border line.
Access in runtime
Syntax
Object.BorderBackColor[=Color]

VB scripting
Object
● Bar
● Button
● CheckBox
● Circle
● CircleSegment
● ComboBox
● Ellipse
● EllipseSegment
● GraphicIOField
● GraphicView
● IOField
● ListBox
● MultiLineEdit
● OptionGroup
● Pölygon
● Rectangle
● RoundButton
● TextField
● WindowSlider
● AlarmView
● Clock
● DateTimeField
● Gauge
● RecipeView
● Slider
● StatusForce
● Switch
● SymbolicIOField
● SysDiagControl
● TrendView
● UserView

VB scripting
Color
Optional. A value or a constant that specifies the background color of the broken border line.
Comments
RGB (255, 0, 0)
See also
Bar (Page 257)
Button (Page 265)
CheckBox (Page 274)
Clock (Page 286)
ComboBox (Page 289)
Gauge (Page 319)
IOField (Page 331)
Listbox (Page 339)
Slider (Page 409)
Switch (Page 419)
SysDiagControl (Page 430)
UserView (Page 480)

VB scripting
BorderBrightColor3D (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the border color of the following border parts for 3D presentation:
● External frame parts at the top and bottom
● Internal frame parts at the top and right
Access in runtime:
Syntax
Object.BorderBrightColor3D[=Color]
Object
● Button
● RoundButton
● Slider*
* RT Advanced read and write access
● Switch
Color
Optional. A value or a constant that specifies the frame color.
Comments
RGB (255, 0, 0)
See also
Button (Page 265)
Slider (Page 409)
Switch (Page 419)

VB scripting
BorderColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the line color.
Access in runtime:
Syntax
Object.BorderColor[=Color]
Object
● Bar
● Button
● CheckBox
● Circle*
● CircleSegment
● ComboBox
● DateTimeField**
● Ellipse*
● EllipseSegment
● FunctionTrendControl
● GraphicIOField
● GraphicView
● IOField
● ListBox
● MultiLineEdit
● OnlineTrendControl
● OptionGroup
● Polygon*
● Rectangle*
● RoundButton
● TextField*

VB scripting
● WindowSlider
** RT Advanced read and write access, RT Professional no access

● AlarmControl
● AlarmView
● Clock
● Gauge
● RecipeView
● Slider
● StatusForce
● Switch
● SysDiagControl
● TrendView
● UserView
Color
Optional. A value or a constant that specifies the line color.
Comments
RGB (255, 0, 0)
See also
Bar (Page 257)
Button (Page 265)
CheckBox (Page 274)
Circle (Page 278)

VB scripting

Clock (Page 286)
ComboBox (Page 289)
Ellipse (Page 299)
Gauge (Page 319)
IOField (Page 331)
Listbox (Page 339)
Polygon (Page 378)
Slider (Page 409)
Switch (Page 419)
UserView (Page 480)

VB scripting
BorderEnabled (RT Professional)
Description
Returns whether the window is displayed with a border in runtime.
Syntax
Object.BorderEnabled[=BOOLEAN]
Object
● ApplicationWindow
● Screenwindow
BOOLEAN
Optional. TRUE, if the window is displayed with a border in runtime.
See also
ApplicationWindow (Page 255)
BorderEndStyle (RT Professional)
Description
Specifies the type of line ends.
Syntax
Object.BorderEndStyle[=Int32]
Object
● Connector
● Line
● Polyline
Int32
Optional. A value or a constant that specifies the type of line end.

VB scripting
See also
Line (Page 336)
Polyline (Page 381)
BorderFlashingColorOff (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the color of the border line for the flashing status "Off".
Access in runtime:
Syntax
Object.BorderFlashingColorOff[=Color]
Object
● Bar
● Button
● CheckBox
● Circle
● CircleSegment
● Ellipse
● EllipseSegment
● GraphicIOField
● GraphicView
● IOField
● OptionGroup
● Polyline
● Polygon
● Rectangle
● RoundButton
● SymbolicIOField
● TextField
● WindowSlider

VB scripting

● Switch
Color
Optional. A value or a constant that specifies the color of the border line for the flashing status
"Off".
Comments
RGB (255, 0, 0)
See also
Bar (Page 257)
Button (Page 265)
CheckBox (Page 274)
IOField (Page 331)
Switch (Page 419)
BorderFlashingColorOn (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the color of the border line for the flashing status "On".
Access in runtime:
Syntax
Object.BorderFlashingColorOn[=Color]

VB scripting
Object
● Bar
● Button
● CheckBox
● Circle
● CircleSegment
● Ellipse
● EllipseSegment
● GraphicIOField
● GraphicView
● IOField
● OptionGroup
● Polyline
● Polygon
● Rectangle
● RoundButton
● SymbolicIOField
● TextField
● WindowSlider
● Switch
Color
"On".
Comments
RGB (255, 0, 0)
See also
Bar (Page 257)
Button (Page 265)

VB scripting
CheckBox (Page 274)

IOField (Page 331)
Switch (Page 419)
BorderFlashingEnabled (RT Professional)
Description
Specifies whether the limit of the object can flash in runtime.
Access in runtime:
Syntax
Object.BorderFlashingEnabled[=BOOLEAN]
Object
● Bar
● Button
● CheckBox
● Circle
● CircleSegment
● Ellipse
● EllipseSegment
● GraphicIOField
● GraphicView
● IOField
● OptionGroup
● Polyline
● Polygon
● Rectangle

VB scripting
● RoundButton
● SymbolicIOField
● TextField
● Switch
● WindowSlider
BOOLEAN
Optional.
TRUE if the object limit can flash in runtime.
FALSE if the object limit cannot flash in runtime.
See also
Bar (Page 257)
Button (Page 265)
CheckBox (Page 274)
IOField (Page 331)
Switch (Page 419)
BorderFlashingRate (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the flash rate of the border line.
Access in runtime:
Syntax
Object.BorderFlashingRate[=FlashingRate]

VB scripting
Object
● Bar
● Button
● CheckBox
● Circle
● CircleSegment
● Ellipse
● EllipseSegment
● GraphicView
● IOField
● OptionGroup
● Polyline
● Polygon
● Rectangle
● RoundButton
● SymbolicIOField
● TextField
● WindowSlider
● GraphicIOField
● Switch
FlashingRate
Optional. A value or a constant that specifies the flash rate of the border line.

See also
Bar (Page 257)
Button (Page 265)
CheckBox (Page 274)
IOField (Page 331)

VB scripting

Switch (Page 419)
BorderInnerStyle3D (RT Professional)
Description
Specifies the appearance of the inner part of the object border.
Syntax
Object.BorderInnerStyle3D[=3DStyle]
Object
● Gauge
● Slider
3DStyle
Optional. A value or a constant that defines how the inside part of the object border is displayed.

0 hmiBorder3DStyleNone There is no inside part of the object border.
1 hmiBorder3DStyleRe‐ The object border is shown in relief.
cessed
2 hmiBorder3DSty‐ The object border is shown raised.
leRaised
3 hmiBorder3DStyleGray The object border has a uniform gray border.
4 hmiBorder3DStyleCol‐ The object border has a uniform colored border. The border color
ored corresponds to the background color.
See also
Gauge (Page 319)
Slider (Page 409)

VB scripting
BorderInnerWidth3D (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the width of the inner border for 3D display.
Syntax
Object.BorderInnerWidth3D[=Int32]
Object
● Slider
Int32
Optional. A value or a constant that specifies the width of the inner border in pixels.
See also
Slider (Page 409)
BorderOuterStyle3D (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the appearance of the outer part of the object border.
Access in runtime
Syntax
Object.BorderOuterStyle3D[=3DStyle]
Object
● Gauge
● Slider

VB scripting
3DStyle
Optional. A value or a constant that defines how the outside part of the object border is
displayed.

0 hmiBorder3DStyleNone There is no inside part of the object border.
1 hmiBorder3DStyleRe‐ The object border is shown in relief.
cessed
2 hmiBorder3DSty‐ The object border is shown raised.
leRaised
3 hmiBorder3DStyleGray The object border has a uniform gray border.
4 hmiBorder3DStyleCol‐ The object border has a uniform colored border. The border color
ored corresponds to the background color.
See also
Gauge (Page 319)
Slider (Page 409)
BorderOuterWidth3D (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the width of the outer border for 3D display.
Syntax
Object.BorderOuterWidth3D[=Int32]
Object
● Slider
Int32
Optional. A value or a constant that specifies the width of the outer border in pixels.
See also
Slider (Page 409)

VB scripting
BorderShadeColor3D (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the border color of the following border parts for 3D presentation:
● Internal frame parts at the top and bottom
● External frame parts at the bottom and right
Access in runtime:
Syntax
Object.BorderShadeColor3D[=Color]
Object
● Button
● Slider*

● RoundButton
● Switch
Color
Optional. A value or a constant that specifies the color of the shading.
Comments
RGB (255, 0, 0)
See also
Button (Page 265)

VB scripting
Slider (Page 409)

Switch (Page 419)
BorderStyle (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the type of border lines.
Syntax
Object.BorderStyle[=Int32]
Object
● Bar
● Button
● CheckBox
● Circle
● CircleSegment
● CircularArc
● ComboBox
● Connector
● Ellipse
● EllipseSegment
● EllipticalArc
● GraphicIOField
● GraphicView
● IOField
● Line
● ListBox
● MultiLineEdit
● Polygon
● Polyline
● Rectangle
● RoundButton
● SymbolicIOField

VB scripting
● TextField
● WindowSlider
● OptionGroup
Int32
Optional. A value or a constant that specifies the type of border line.
Value Description
0 Solid line
1 Dashed line
2 Dotted line
3 Dashed and dotted line
4 Dash-dot-dot line
See also
Bar (Page 257)
Button (Page 265)
CheckBox (Page 274)
ComboBox (Page 289)
IOField (Page 331)
Listbox (Page 339)
BorderWidth (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the line thickness.
Access in runtime:

VB scripting
Syntax
Object.BorderWidth[=Int32]
Object
● Ala rmControl
● Bar
● Button
● Circle *
● CircleSegment
● CheckBox
● ComboBox
● Ellipse *
● EllipseSegment
● Gauge
● GraphicIOField
● GraphicView
● IOField
● ListBox
● MultiLineEdit
● Polygon *
● Rectangle *
● OptionGroup
● RoundButton
● Slider *
● SymbolicIOField *
● TextField *
● WindowSlider

VB scripting

● AlarmView
● Clock
● DateTimeField
● RecipeView
● StatusForce
● Switch
● SysDiagControl
● TrendView
● UserView
Int32
Optional. A value or a constant that specifies the line weight in pixels.
See also
Bar (Page 257)
Button (Page 265)
CheckBox (Page 274)
Clock (Page 286)
ComboBox (Page 289)
Gauge (Page 319)
IOField (Page 331)
Listbox (Page 339)
Slider (Page 409)

VB scripting
Switch (Page 419)

UserView (Page 480)
BorderWidth3D (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the width of the inner border for 3D display.
Access in runtime
Syntax
Object.BorderWidth3D[=Int32]
Object
● Button
● Gauge
● RoundButton
● Bar
● IOField
● Switch
Int32
Optional. A value or constant that determines the width of the inside border for 3D display in
pixels.
See also
Bar (Page 257)
Button (Page 265)

VB scripting
Gauge (Page 319)

IOField (Page 331)
Switch (Page 419)
BottomMargin (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Bounds (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
BrowserTypeUsed (RT Professional)
Description
BufferViewColumnOrder (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
BufferViewInternalRowOrder (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
BusyText (Panels, Comfort Panels, RT Advanced, RT Professional)
Description

VB scripting
ButtonBackColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ButtonBackFillStyle (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ButtonBarElements (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ButtonBarHeight (RT Advanced)
Description
ButtonBarStyle (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ButtonBorderBackColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ButtonBorderColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Description

VB scripting
ButtonBorderWidth (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ButtonCornerRadius (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ButtonEdgeStyle (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ButtonFirstGradientColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ButtonFirstGradientOffset (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ButtonMiddleGradientColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ButtonPositions (RT Advanced)
Description

VB scripting
ButtonSecondGradientColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ButtonSecondGradientOffset (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
BV_ColumnWidth_Date (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
BV_ColumnWidth_Event (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
BV_ColumnWidth_EventSeverity (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
BV_ColumnWidth_EventState (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
BV_ColumnWidth_Number (Panels, Comfort Panels, RT Advanced, RT Professional)
Description

VB scripting
BV_ColumnWidth_Time (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
BV_ItemText_Date (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
BV_ItemText_Event (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
BV_ItemText_EventSeverity (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
BV_ItemText_EventState (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
BV_ItemText_Number (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
BV_ItemText_Time (Panels, Comfort Panels, RT Advanced, RT Professional)
Description

VB scripting
BV_ShowItem_Date (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
BV_ShowItem_Event (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
BV_ShowItem_EventSeverity (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
BV_ShowItem_EventState (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
BV_ShowItem_Number (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
BV_ShowItem_Time (Panels, Comfort Panels, RT Advanced, RT Professional)
Description

VB scripting
1.5.5.3 Properties C (Panels, Comfort Panels, RT Advanced, RT Professional)
CameraUrl (RT Professional)
Description
CanBeGrouped (RT Professional)
Description
Caption (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the text to be displayed in the header.
Access in runtime:
Syntax
Object.Caption[=STRING]
Object
● AlarmControl
● Slider *

VB scripting
STRING
Optional. A value or a constant that contains the text that will be shown in the title line.
See also
Slider (Page 409)
CaptionBackColor (RT Professional)
Description
Specifies the background color of the title bar.
Syntax
Object.CaptionBackColor[=Color]
Object
● SymbolicIOField
Color
Optional. A value or a constant that specifies the background color of the title bar.
Comments
RGB (255, 0, 0)
See also

VB scripting
CaptionColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the color of the text to be displayed in the title bar.
Syntax
Object.CaptionColor[=Color]
Object
● Gauge
● Switch
● SymbolicIOField
Color
Optional. A value or a constant that specifies the text color.
Comments
RGB (255, 0, 0)
See also
Gauge (Page 319)
Switch (Page 419)
CaptionFont (RT Professional)
Description
Sets the font.
Access in runtime:

VB scripting
Syntax
Object.CaptionFont[=Font]
Object
● Gauge
You have no access in runtime in the case of the following characteristic:
● Switch
Font
Optional. A value or a constant that specifies the font.
See also
Gauge (Page 319)
Switch (Page 419)
CaptionText (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the text to be displayed in the header.
Syntax
Object.CaptionText[= STRING]
Object
● Gauge
● ScreenWindow
● Switch
STRING
Optional. A value or a constant that contains the text that will be shown in the title line.
See also
Gauge (Page 319)
Switch (Page 419)

VB scripting
CaptionTop (RT Professional)
Description
Specifies the distance between the instrument labels and the upper edge of the object. You
can only position the instrument labels in line with the vertical diameter of the scale. The value
of the property refers to the height of the object. The height specifies the upper edge of the
object and the lower edge of the lettering.
Syntax
Object.CaptionTop[=DOUBLE]
Object
● Gauge
DOUBLE
Optional. A value or a constant that specifies the distance between the instrument labels and
the upper edge of the object.
Value Description
0 The lower edge of the lettering is positioned at the upper limit of the object. The text is no
longer visible as it is positioned outside the object.
1 The lower edge of the lettering is positioned on the lower limit of the selected object.
See also
Gauge (Page 319)
CellCut (RT Professional)
Description
Specifies whether the contents of the cells are abbreviated if the cells are too narrow.
Syntax
Object.CellCut[=BOOLEAN]

VB scripting
Object
● AlarmControl
BOOLEAN
Optional.
TRUE, if the contents are abbreviated.
See also
CellSpaceBottom (RT Professional)
Description
Specifies the bottom margin of the table cells.
Syntax
Object.CellSpaceBottom[=Int32]
Object
● AlarmControl
Int32
Optional. A value or constant that defines the bottom margin used in the table cells.

VB scripting
See also
CellSpaceLeft (RT Professional)
Description
Specifies the left indent used in the table cells.
Syntax
Object.CellSpaceLeft[=Int32]
Object
● AlarmControl
Int32
Optional A value or parameter that defines the left indent in the table cells.
See also
CellSpaceRight (RT Professional)
Description
Specifies the right indent used in the table cells.

VB scripting
Syntax
Object.CellSpaceRight[=Int32]
Object
Required. A "ScreenItem" object with the following formats:
● AlarmControl
Int32
Optional A value or constant that defines the right indent used in the table cells.
See also
CellSpaceTop (RT Professional)
Description
Defines the top margin of the table cells.
Syntax
Object.CellSpaceTop[=Int32]
Object
Required. A "ScreenItem" object with the following formats:
● AlarmControl
Int32
Optional A value or constant that defines the top margin used in the table cells.

VB scripting
See also
CenterColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the color of the center point.
Syntax
Object.CenterColor[=Color]
Object
● Gauge
Color
Optional. A value or a constant that specifies the color of the center.
Comments
RGB (255, 0, 0)
See also
Gauge (Page 319)
CenterSize (RT Professional)
Description
Specifies the diameter of the scale center point.

VB scripting
Syntax
Object.CenterSize[=SINGLE]
Object
● Gauge
SINGLE
Optional A value or a constant that specifies the diameter of the round scale center point.
Value range from 0.03 to 1
1: The diameter corresponds to the smaller value of the geometry attribute "Width" or "Height".
See also
Gauge (Page 319)
ChangeMouseCursor (RT Professional)
Description
Specifies how the appearance of the cursor changes in runtime when it is above the icon.
Syntax
Object.ChangeMouseCursor[=BOOLEAN]
Object
● SymbolLibrary
BOOLEAN
Optional.
TRUE, if the mouse cursor has the appearance of an arrow even when it is positioned above
the icon.
FALSE, if the mouse cursor has the appearance of a 3D arrow with a green lightning symbol.
This indicates in Runtime that the respective objective can be operated.
See also

VB scripting
CheckMarkAlignment (RT Professional)
Description
Specifies whether the fields are right-aligned.
Syntax
Object.CheckMarkAlignment[=CheckMarkAlignment]
Object
● CheckBox
● OptionGroup
CheckMarkAlignment
Optional. A value or a constant that specifies whether the fields are right-aligned.
Value Explanation
0 The fields are arranged left aligned.
1 The fields are right-aligned.
See also
CheckBox (Page 274)
CheckMarkCount (RT Professional)
Description
Specifies the number of fields.
Syntax
Object.CheckMarkCount[=Int32]
Object
● CheckBox
● OptionGroup

VB scripting
Int32
Optional. A value or a constant that specifies the number of fields. Value range from 0 to 31
See also
CheckBox (Page 274)
ClearOnError (RT Professional)
Description
Specifies whether an invalid input in this object will be deleted automatically.
Syntax
Object.ClearOnError[=BOOLEAN]
Object
● IOField
BOOLEAN
Optional TRUE, if an invalid input in this object will be deleted automatically.
See also
IOField (Page 331)
ClearOnFocus (RT Professional)
Description
Specifies whether the field entry will be deleted as soon as the I/O field is activated.
Syntax
Object.ClearOnFocus[=BOOLEAN]

VB scripting
Object
● IOField
BOOLEAN
Optional TRUE, if the field entry is deleted as soon as the I/O field is activated.
See also
IOField (Page 331)
Closeable (RT Professional)
Description
Specifies whether the object can be closed in runtime.
Syntax
Object.Closeable[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
Optional. TRUE if the object can be closed in runtime.
See also

VB scripting

Color (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the line color.
Syntax
Object.Color[=Color]
Object
● CircularArc
● Connector
● EllipticalArc
● Line
● Polyline
● TubeArcObject
● TubeDoubleTeeObject
● TubeTeeObject
● Tubepolyline
Color
Optional. A value or a constant that specifies the line color.
Comments
RGB (255, 0, 0)
See also

VB scripting

Line (Page 336)
Polyline (Page 381)
TubeDoubleTeeObject (Page 461)
TubeTeeObject (Page 466)
ColorChangeHysteresis (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies hysteresis as a percentage of the display value.
The "ColorChangeHysteresisEnable" property must have the value TRUE so that the
hysteresis can be calculated.
Syntax
Object.ColorChangeHysteresis[=DOUBLE]
Object
● Bar
DOUBLE
Optional A value or a constant that specifies the hysteresis as a percentage of the display
value.
See also
Bar (Page 257)
ColorChangeHysteresisEnabled (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Determines whether the object will be displayed with a hysteresis.

VB scripting
Syntax
Object.ColorChangeHysteresisEnabled[=BOOLEAN]
Object
● Bar
BOOLEAN
Optional TRUE, if the object will be displayed with a hysteresis.
See also
Bar (Page 257)
ColumnAdd (RT Professional)
Description
Creates a new column. The newly created column is automatically referenced with
"ColumnIndex".
Syntax
Object.ColumnAdd[=STRING]
Object
STRING
Required. A value or a constant that specifies the name of a new column.
See also
ColumnIndex (Page 612)
ColumnAlias (RT Professional)
Description
Returns the display name of the column referenced with "ColumnIndex".

VB scripting
Syntax
Object.ColumnAlias[=STRING]
Object
STRING
Optional. A value or a constant that specifies the display name of the column.
See also
ColumnAlignment (RT Professional)
Description
Specifies the alignment of the column content in a column referenced with "ColumnIndex".
Syntax
Object.ColumnAlignment[=HorizontalAlignment]
Object
HorizontalAlignment
Optional. A value or constant that determines the horizontal alignment.

0 Left The column text is left-justified.
1 Centered The column text is centered.
2 Right The column text is right-justified.
See also

VB scripting
ColumnAutoPrecisions (RT Professional)
Description
Specifies whether the number of decimal places for a column referenced with "ColumnIndex"
is set automatically.
Syntax
Object.ColumnAutoPrecisions[=BOOLEAN]
Object
BOOLEAN
Optional.
TRUE if the number of decimal places is automatically determined.
FALSE if the value of "ColumnPrecisions" is used.
See also
ColumnCaption (RT Professional)
Description
Specifies the header of the current column.
Syntax
Object.ColumnCaption[=STRING]
Object
STRING
Optional. A value or a constant that specifies the header of the current column.

VB scripting
See also
ColumnCount (RT Professional)
Description
Specifies the number of configured columns.
Syntax
Object.ColumnCount[=Int32]
Object
Int32
Optional. A value or a constant that specifies the number of configured columns.
See also
ColumnDateFormat (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the date format.
Syntax
Object.ColumnDateFormat[=STRING]
Object

VB scripting
STRING
Optional. A value or a constant that specifies the date format.
See also
ColumnDMVarName (RT Professional)
Description
Specifies the name of a tag.
Syntax
Object.ColumnDMVarName[=STRING]
Object
STRING
Optional. A value or a constant that specifies the name of a tag.
See also
ColumnExponentialFormat (RT Professional)
Description
Specifies whether the values of a column referenced with "ColumnIndex" are displayed in
Syntax
Object.ColumnExponentialFormat[=BOOLEAN]
Object

VB scripting
BOOLEAN
Optional.
TRUE if the values are displayed in exponential notation.
FALSE if the values are not displayed in exponential notation.
See also
ColumnFlagNotNull (RT Professional)
Description
Specifies whether the user archive field assigned to a column referenced with "ColumnIndex"
has to have a value.
Syntax
Object.ColumnFlagNotNull[=BOOLEAN]
Object
BOOLEAN
Optional.
TRUE, if a value is required.
FALSE, if no value is required.
See also
ColumnFlagUnique (RT Professional)
Description
Specifies whether the user archive field assigned to a column referenced with "ColumnIndex"
has to have a unique value. The values in this column must differ from one another.

VB scripting
Syntax
Object.ColumnFlagUnique[=BOOLEAN]
Object
BOOLEAN
Optional.
TRUE, if the value must be unique.
FALSE, if the value does not have to be unique.
See also
ColumnHideText (RT Professional)
Description
Specifies whether the text in a column referenced with "ColumnIndex" is hidden.
Syntax
Object.ColumnHideText[=BOOLEAN]
Object
BOOLEAN
Optional.
TRUE, if the text in the current column is hidden.
FALSE, if the text in the current column is shown.
See also

VB scripting
ColumnHideTitleText (RT Professional)
Description
Specifies whether the header of a column referenced with "ColumnIndex" is hidden.
Syntax
Object.ColumnHideTitleText[=BOOLEAN]
Object
BOOLEAN
Optional.
TRUE if the header of the referenced column is hidden.
FALSE if the header of the referenced column is displayed.
See also
ColumnIndex (RT Professional)
Description
References a column. To access the properties of a column, you need to set ""ColumnIndex"".
Values between 0 and "ColumnIndex minus 1 are valid for "ColumnCount". The
"ColumnCount" property specifies the number of configured columns.
Syntax
Object.ColumnIndex[=Int32]
Object

VB scripting
Int32
Optional. A value or a constant that the specifies the column to be edited over the index.
See also
ColumnCount (Page 607)
ColumnLeadingZeros (RT Professional)
Description
Specifies how many leading zeros are displayed for the values of a column referenced with
"ColumnIndex".
Syntax
Object.ColumnLeadingZeros[=Int32]
Object
Int32
Optional. A value or a constant that specifies the number of leading zeros. The maximum
number is 11.
See also
ColumnLength (RT Professional)
Description
Specifies the number of characters displayed in a column referenced with "ColumnIndex".
Syntax
Object.ColumnLength[=Int32]

VB scripting
Object
Int32
Optional. A value or a constant that specifies the number of characters displayed.
See also
ColumnMaxValue (RT Professional)
Description
Returns the maximum value defined in the user archive of a column referenced with
"ColumnIndex".
Syntax
Object.ColumnMaxValue[=STRING]
Object
STRING
Optional. A value or a constant that returns the maximum value of the column specified in the
user log.
See also
ColumnMinValue (RT Professional)
Description
Returns the minimum value defined in the user archive of a column referenced with
"ColumnIndex".

VB scripting
Syntax
Object.ColumnMinValue[=STRING]
Object
STRING
Optional. A value or a constant that returns the minimum value of the column specified in the
user log.
See also
ColumnName (RT Professional)
Description
Specifies the name of a column referenced with "ColumnIndex".
Syntax
Object.ColumnName[=STRING]
Object
STRING
Optional. A value or a constant that returns the name of the referenced column.
See also

VB scripting
ColumnOrder (RT Advanced)
Description
ColumnPosition (RT Professional)
Description
Specifies the position of a column referenced with "ColumnIndex".
Syntax
Object.ColumnPosition[=Int32]
Object
Int32
Optional. A value or a constant that specifies the position of the column.
See also
ColumnPrecisions (RT Professional)
Description
Specifies the number of decimal places in a column referenced with "ColumnIndex".
Syntax
Object.ColumnPrecisions[=Int16]
Object

VB scripting
Int16
Optional. A value or a constant that specifies the number of decimal places in the column.
See also
ColumnReadAccess (RT Professional)
Description
Returns the read access authorization defined in the user archive for a column referenced with
"ColumnIndex".
The number corresponds to the number that is assigned to the authorization in the "User
Administrator" editor.
Syntax
Object.ColumnReadAccess[=Int32]
Object
Int32
Optional. A value or a constant that returns the authorization for read access specified in the
user log to the column.
See also
ColumnReadonly (RT Professional)
Description
Specifies whether the values of a column referenced with "ColumnIndex" can only be read.
Syntax
Object.ColumnReadonly[=BOOLEAN]

VB scripting
Object
BOOLEAN
Optional.
TRUE, if the values of the column are read-only values.
FALSE, if the values of the column are not read-only values.
See also
ColumnRemove (RT Professional)
Description
Removes a column referenced with its name.
Syntax
Object.ColumnRemove[=STRING]
Object
STRING
Optional. A value or a constant that returns the name of the referenced column to be removed.
See also
ColumnRepos (RT Professional)
Description
For multiple columns, specifies the position of a column referenced with "ColumnIndex".
If you have changed the position of the column with "ColumnRepos", "ColumnIndex" is
assigned the value of "ColumnRepos".

VB scripting
Syntax
Object.ColumnRepos[=Int32]
Object
Int32
Optional. A value or a constant that specifies the position of the referenced column. Value
range from 0 to "ColumnCount" minus 1. Values outside this range have no effect.
0: The referenced column is positioned on the left.
See also
ColumnCount (Page 607)
ColumnResize (RT Professional)
Description
Specifies whether you can change the width of the columns.
Syntax
Object.ColumnResize[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
Optional.
TRUE if you can change the width of the columns.

VB scripting
FALSE if you cannot change the width of the columns.
See also
Columns (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ColumnScrollbar (RT Professional)
Description
Specifies when the horizontal scroll bar is to be displayed.
Syntax
Object.ColumnScrollbar[=ScrollbarVisibility]
Object
● AlarmControl
ScrollbarVisibility
Optional. A value or a constant that specifies when the horizontal scroll bar is displayed.
Value Description
0 The horizontal scroll bar is not displayed.
1 If the display area is too small for all columns, the horizontal scroll bar is displayed.
2 The horizontal scroll bar is always displayed.

VB scripting
See also
ColumnSettings (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ColumnSettingsBufferView (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ColumnShowDate (RT Professional)
Description
Specifies whether the date is to be displayed in a column referenced with "ColumnIndex".
Syntax
Object.ColumnShowDate[=BOOLEAN]
Object
BOOLEAN
Optional.
TRUE, if the date is displayed in the column.
FALSE, if the date is not displayed in the column.
See also

VB scripting
ColumnShowIcon (RT Professional)
Description
Specifies whether a symbol is to be displayed in a column referenced with "ColumnIndex".
Syntax
Object.ColumnShowIcon[=BOOLEAN]
Object
BOOLEAN
Optional.
TRUE, if an icon is displayed in the column.
FALSE, if no icon is displayed in the column.
See also
ColumnShowTitleIcon (RT Professional)
Description
Specifies whether a symbol is to be displayed in a column referenced with "ColumnIndex".
Syntax
Object.ColumnShowTitleIcon[=BOOLEAN]
Object
BOOLEAN
Optional.
TRUE, if an icon is displayed in the column.
FALSE, if no icon is displayed in the column.

VB scripting
See also
ColumnsMoveable (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ColumnSort (RT Professional)
Description
Specifies the sorting type of a column referenced with "ColumnIndex".
Syntax
Object.ColumnSort[=SortMode]
Object
SortMode
Optional. A value or a constant that specifies the sorting mode.
Value Description
0 No sorting
1 Ascending sorting from the smallest to largest value
2 Descending sorting from the largest to smallest value
See also

VB scripting
ColumnSortIndex (RT Professional)
Description
Specifies the sorting order for a column referenced with "ColumnIndex" in which the columns
are sorted one after another.
Syntax
Object.ColumnSortIndex[=Int32]
Object
Int32
Optional. A value or a constant that specifies the sorting index of the column.
Value Description
0 The sorting direction defined in the "ColumnSort (Page 622)" property is set to "No sorting".
1 The number 1 is displayed in the header. Sorting by this column takes place first.
2-4 The selected number is displayed in the header. The columns are sorted in the corresponding order.
See also
ColumnStartValue (RT Professional)
Description
Returns the start value defined in the user log of a column referenced with "ColumnIndex".
Syntax
Object.ColumnStartValue[=STRING]

VB scripting
Object
STRING
Optional. A value or a constant that returns the start value of the column specified in the user
log.
See also
ColumnStringLength (RT Professional)
Description
Returns the string length defined in the user archive for a column referenced with
"ColumnIndex".
Syntax
Object.ColumnStringLength[=Int32]
Object
Int32
Optional. A value or a constant that returns the length of the character string of the column
specified in the user log.
See also
ColumnTextAckGroup (Panels, Comfort Panels, RT Advanced, RT Professional)
Description

VB scripting
ColumnTextAlarmState (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ColumnTextAlarmText (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ColumnTextBit (RT Advanced)
Description
ColumnTextClassName (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ColumnTextConnection (RT Advanced)
Description
ColumnTextDataType (RT Advanced)
Description
ColumnTextDate (Panels, Comfort Panels, RT Advanced, RT Professional)
Description

VB scripting
ColumnTextDateTime (RT Advanced)
Description
ColumnTextDbNumber (RT Advanced)
Description
ColumnTextDevice (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ColumnTextDiagnosable (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ColumnTextFormat (RT Advanced)
Description
ColumnTextGroup (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ColumnTextLogTime (Panels, Comfort Panels, RT Advanced, RT Professional)
Description

VB scripting
ColumnTextNumber (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ColumnTextOffset (RT Advanced)
Description
ColumnTextPassword (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ColumnTextRead (RT Advanced)
Description
ColumnTextTagConnection (RT Advanced)
Description
ColumnTextTime (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ColumnTextTrend (RT Advanced)
Description

VB scripting
ColumnTextType (RT Advanced)
Description
ColumnTextUser (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ColumnTextValue (RT Advanced)
Description
ColumnTextWrite (RT Advanced)
Description
ColumnTextXValue (RT Advanced)
Description
ColumnTimeFormat (RT Professional)
Description
Specifies the time format for a column referenced with "ColumnIndex".
Syntax
Object.ColumnTimeFormat[=STRING]

VB scripting
Object
STRING
Optional. A value or a constant that specifies the time format for the column.
Value Description
Automatic The time format is set automatically.
HH:mm:ss.ms Hours:Minutes:Seconds, e.g. 15:35:44.240.
hh:mm:ss tt Hours:Minutes:Seconds AM/PM, e.g. 03:35:44 PM.
hh:mm:ss.ms tt Hours:Minutes:Seconds.Milliseconds AM/PM, e.g. 03:35:44.240 PM.
See also
ColumnTitleAlignment (RT Professional)
Description
Specifies the alignment of the header in a column referenced with "ColumnIndex".
Syntax
Object.ColumnTitleAlignment[=GridColumnHeaderHorizontalAlignment]
Object
● AlarmControl
GridColumnHeaderHorizontalAlignment
Optional. A value or a constant that specifies the column header alignment.

0 Left The column header is left-aligned.
1 Centered The column header is centered.
2 Right The column header is right-aligned.
3 As table The column header is aligned as defined in the "ColumnAlignment
(Page 605)" property for the column content.

VB scripting
See also
ColumnTitles (RT Professional)
Description
Specifies whether the column header is displayed.
Syntax
Object.ColumnTitles[=BOOLEAN]
Object
● AlarmControl
● UserArchive Control
BOOLEAN
Optional.
TRUE if the column header is displayed.
FALSE if the column header is not displayed.
See also
ColumnType (RT Professional)
Description
Returns the data type defined in the user archive of a column referenced with "ColumnIndex".

VB scripting
Syntax
Object.ColumnType[=Int32]
Object
Int32
Optional. A value or a constant that returns the data type of the column specified in the user
log.
See also
ColumnVisible (RT Professional)
Description
Specifies whether the column referenced with "ColumnIndex" is displayed in the object.
Syntax
Object.ColumnVisible[=BOOLEAN]
Object
BOOLEAN
Optional.
TRUE if the referenced column is displayed.
FALSE if the referenced column is not displayed.

VB scripting
See also
ColumnWidth (RT Advanced)
Description
ColumnWriteAccess (RT Professional)
Description
Returns the write access authorization defined in the user archive for a column referenced
with "ColumnIndex".
The number corresponds to the number that is assigned to the authorization in the "User
Administrator" editor.
Syntax
Object.ColumnWriteAccess[=Int32]
Object
Int32
Optional. A value or a constant that returns the authorization for write access specified in the
user log to the column.
See also
ComboboxFont (Panels, Comfort Panels, RT Advanced, RT Professional)
Description

VB scripting
CompatibilityMode (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ComplexViewToolbar (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ComplexViewToolbarBounds (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ComponentInfoText (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ComputerName (RT Professional)
Description
Returns the name of the computer on which the alarm object was triggered.
ComputerName (readonly)
ConfiguredAlarmClasses (RT Advanced)
Description
ConnectionType (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the type of connector. You can select one of two connection types.

VB scripting
Access in runtime:
Syntax
Object.ConnectionType[=ConnectorConnectionType]
Object
● Connector
● SmartClientView
ConnectorConnectionType
Optional. A value or a constant that specifies the type of connector.
(0): Automatic: Both objects are connected by a polyline made up of horizontal and vertical
parts.
(1): Simple: Both objects are connected by a straight line between the connecting points. The
fields are right-aligned.
See also
SmartClientView (Page 412)
ConnectOnStart (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ConnectTrendWindows (RT Professional)
Description
Specifies whether the configured trend views are connected. The requirement is that you have
configured several trend views.
The connected trend views have the following properties:
● A common X axis
● A scrollbar
● A ruler

VB scripting
Syntax
Object.ConnectTrendWindows[=BOOLEAN]
Object
BOOLEAN
Optional.
TRUE if all configured trend views are connected.
FALSE if the trend views are displayed separately.
See also
Context (RT Professional)
Description
Reads or sets the alarm object server prefix.
ContinousChange (RT Professional)
Description
Specifies whether the value of the "ProcessValue" property will be transferred when the mouse
button is released or as soon as the slider position changes in Runtime.
Syntax
Object.ContinousChange[=BOOLEAN]
Object
● Slider

VB scripting
BOOLEAN
Optional TRUE, if the value of the property "ProcessValue" will be transferred when the mouse
button is released or as soon as the slider position changes in Runtime.
See also
Slider (Page 409)
ControlDesignMode (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the control design.
Syntax
Object.ControlDesignMode[=RTControlModes]
Object
● AlarmControl
RTControlModes
Optional. A value or a constant that specifies the control design.

Project setting The design corresponds to the project settings in WinCC Explorer.
0 Simple Classic WinCC design
1 Standard New WinCC V7 design
See also

VB scripting

CornerRadius (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
CornerStyle (RT Professional)
Description
Specifies the shape of the corners.
Access in runtime:
Syntax
Object.CornerStyle[=CornerStye | LineJoinStyle]
Object
● Bar
● Button
● CheckBox
● Circle
● CircleSegment
● CircularArc
● ComboBox
● Connector
● Ellipse
● EllipseSegment
● EllipticalArc
● GraphicIOField
● GraphicView
● IOField
● Line

VB scripting
● ListBox
● MultiLineEdit
● OptionGroup
● Polygon
● Polyline
● Rectangle
● RoundButton
● SymbolicIOField
● TextField
● Tubepolyline
● WindowSlider
● Switch
● TubeArcObject
CornerStyle | LineJoinStyle
Optional. A value or a constant that specifies the shape of the corners.
Value Description
0 Solid line
1 Dashed line
2 Dotted line
4 Dash-dot-dot line
Count (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Returns the number of elements in the specified list.
Syntax
Object.Count
Object
Required A "Collection" object.

VB scripting
CountDivisions (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the number of segments in which the bar will be divided by the large marking lengths
of the scale.
Syntax
Object.CountDivisions[=Int32]
Object
● Bar
Int32
Optional A value or a constant that specifies the number of segments in which the bar will be
divided by the large marking lengths of the scale.
0-100: An object can be divided into a maximum of 100 segments
= 0: The optimum number of segments will be established automatically.
See also
Bar (Page 257)
CountOfLinesPerAlarms (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
CountOfVisibleAlarms (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
CountSubDivisions (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the number of scale marks between two main marks.

VB scripting
Syntax
Object.CountSubDivisions[= Int32]
Object
Required. A ScreenItem object with the following format
● Bar
Int32
Optional. A value or a constant that specifies the number of scale segments.
See also
Bar (Page 257)
CountVisibleItems (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies how many lines the selection list will contain. If the number of configured texts is
greater than this value, then the selection list will have a vertical scroll bar.
Access in runtime:
Syntax
Object.CountVisibleItems[=Int32]
Object
● ComboBox
● ListBox
● SymbolicIOField
● StatusForce
● TrendView
● UserView

VB scripting
Int32
Optional A value or a constant that specifies how many lines the selection list will contain.
See also
ComboBox (Page 289)
Listbox (Page 339)
UserView (Page 480)
CurrentContext (RT Professional)
Description
Returns a character string depending on the use of the function.
If the function is contained in a screen in the screen window, CurrentContext returns the
symbolic server name which supplies the screen. Example: "WinCCProject_MyComputer::"
If the function is contained in the main screen, an empty character string is returned.
Syntax
Object.CurrentContext
Object
See also
CursorControl (RT Professional)
Description
Specifies whether the mouse cursor jumps to the next field of the TAB sequence after leaving
the field.

VB scripting
Syntax
Object.CursorControl[=BOOLEAN]
Object
● IOField
● SymbolicIOField
BOOLEAN
Optional TRUE, if the mouse cursor jumps to the next field of the TAB-order after leaving the
field.
Comments
For this purpose, the "CursorMode" property must be set to TRUE.
See also
IOField (Page 331)
Curves (RT Advanced)
Description
1.5.5.4 Properties D (Panels, Comfort Panels, RT Advanced, RT Professional)
DangerRangeColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the color of the danger range on the scale of the "Gauge" object.
The "DangerRangeVisible" property must have the value TRUE so that the warning range is
displayed.
Syntax
Object.DangerRangeColor[=Color]

VB scripting
Object
● Gauge
Color
Optional. A value or a constant that specifies the color of the warning range.
Comments
RGB (255, 0, 0)
See also
Gauge (Page 319)
DangerRangeStart (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies at which scale value the danger range of the "Gauge" object will start.
The "DangerRangeColor" property must have the value TRUE so that the warning range is
displayed.
Syntax
Object.DangerRangeStart[=SINGLE]
Object
● Gauge
SINGLE
Optional. A value or a constant that specifies the scale value for the start of the warning range.
Comments
The range extends from the value "DangerRangeStart" through to the end of the scale.

VB scripting
See also
Gauge (Page 319)
DangerRangeVisible (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies whether the warning range in the scale of the "Gauge" object will be displayed.
Syntax
Object.DangerRangeVisible[=BOOLEAN]
Object
● Gauge
BOOLEAN
Optional TRUE, if the warning range will be displayed in the scale.
Comments
Specifies the color of the warning range with the "DangerRangeColor" property.
Specifies the start of the warning range with the "DangerRangeStart" property.
See also
Gauge (Page 319)
DataFormat (RT Professional)
Description
Returns the display format.
Syntax
Object.DataFormat[=IOFieldDataFormat]

VB scripting
Object
● IOField
IOFieldDataFormat
Optional. A value or a constant that returns the display format.

0 Binary The content is shown in "Binary" data format.
1 Decimal The content is shown in "Decimal" data format.
2 String Represents character strings.
3 Hexadecimal The content is shown in "Hexadecimal" data format.
See also
IOField (Page 331)
DataLogs (RT Professional)
Description
Returns an object of type "DataLogs".
Syntax
Object.DataLogs
Object
Required A "Logging" object.
See also
Logging (Page 212)
DataProviderGuid (RT Professional)
Description
Returns the GUID of the control.

VB scripting
Syntax
Object.DataProviderGuid
Object
Required. An object of the "UserArchiveControl" type.
Example
Dim objRecipeview
Set objRecipeview= HMIRuntime.Screens("Screen_1").ScreenItems("Recipeview_1")
SmartTags("Tag1") = objRecipeView.DataProviderGuid
See also
DataRecordNameCaption (RT Advanced)
Description
DataRecordNrCaption (RT Advanced)
Description
DataSet (RT Professional)
Description
Returns an object of type "DataSet".
Syntax
Object.DataSet
Object
Required A "Screen" object.

VB scripting
See also
Screen (Page 214)
DataSource (RT Professional)
Description
DefaultFilterEom (RT Professional)
Description
DefaultHitListFilterEom (RT Professional)
Description
DefaultMsgFilterSQL (RT Professional)
Description
Specifies an SQL statement as default for alarm filter.
Syntax
Object.DefaultMsgFilterSQL[=STRING]
Object
● AlarmControl
STRING
Optional. A value or a constant that specifies an SQL statement as default for alarm filter.
See also

VB scripting
DefaultSort (RT Professional)
Description
Specifies the type of sorting.
Syntax
Object.DefaultSort[=SortMode]
Object
● AlarmControl
SortMode
Optional. A value or a constant that specifies the type of sorting.
Value Explanation
0 No sorting
1 The alarms are updated starting from the bottommost line.
2 The alarms are updated starting from the topmost line.
See also
DefaultSort2 (RT Professional)
Description
Specifies the type of sorting.
Syntax
Object.DefaultSort2[=SortMode]
Object
● AlarmControl

VB scripting
SortMode
Optional. A value or a constant that specifies the type of sorting.
Value Explanation
0 No sorting
1 The alarms are updated starting from the bottommost line.
2 The alarms are updated starting from the topmost line.
See also
DefaultSort2Column (RT Professional)
Description
Specifies a column for initial sorting of the table entries.
If no value is assigned, alarms are sorted according to the following column order:
● Date/Time/Number
If you configure the "Alarm text" column as a value, for example, alarms are sorted according
to the following column order:
● Alarm text/Date/Time/Number
Syntax
Object.DefaultSort2Column[=STRING]
Object
● AlarmControl
STRING
Optional. A value or a constant that specifies the name of the column for initial sorting of the
table entries.
See also

VB scripting
DeviceStyle (RT Professional)
Description
DiagnosticsContext (RT Professional)
Description
Specifies the diagnostics context.
Syntax
Object.DiagnosticsContext[=STRING]
Object
● AlarmControl
STRING
Optional. A value or a constant that specifies the diagnostics context.
See also
DiagramAreaHeight (RT Advanced)
Description
DiagramAreaLeft (RT Advanced)
Description

VB scripting
DiagramAreaTop (RT Advanced)
Description
DiagramAreaWidth (RT Advanced)
Description
DialColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the color of the dial for the selected object.
Syntax
Object.DialColor[=Color]
Object
● Clock
● Gauge
Color
Optional. A value or a constant that specifies the color of the dial.
Comments
RGB (255, 0, 0)
See also
Clock (Page 286)
Gauge (Page 319)

VB scripting
DialFillStyle (RT Professional)
Description
Specifies the type of background.
Syntax
Object.DialFillStyle[=GaugeFillStyle]
Object
● Gauge
GaugeFillStyle
Optional. A value or a constant that specifies the type of background.

0 hmiBackStyleSolid The rectangular background of the display is filled with the specified border
color. The scale is filled with the specified background color.
1 hmiBackStyleFrameTranspar‐ The rectangular background is transparent. The scale is filled with the specified
ent background color. As a result, a circular display can be shown.
2 hmiBackStyleTransparent The rectangular background and the scale are transparent.
See also
Gauge (Page 319)
DialPicture (RT Professional)
Description
Specifies a graphic for the dial face.
Syntax
Object.DialPicture[=HmiObjectHandle]
Object
● Gauge

VB scripting
HmiObjectHandle
Optional. A value or a constant that specifies the graphic for the dial face.
See also
Gauge (Page 319)
DialSize (RT Professional)
Description
Specifies the diameter of the scale in relation to the smaller value of the geometry attributes
"Width" and "Height".
Syntax
Object.DialSize[=SINGLE]
Object
● Gauge
SINGLE
Optional A value or a constant that specifies the diameter of the scale in relation to the smaller
value of the geometry attributes "Width" and "Height".
See also
Gauge (Page 319)
Display3D (RT Advanced)
Description
DisplayButton2Plc (RT Advanced)
Description

VB scripting
DisplayButtonComparison (RT Advanced)
Description
DisplayButtonDelete (RT Advanced)
Description
DisplayButtonFromPlc (RT Advanced)
Description
DisplayButtonHelp (RT Advanced)
Description
DisplayButtonNew (RT Advanced)
Description
DisplayButtonSave (RT Advanced)
Description
DisplayButtonSaveAs (RT Advanced)
Description

VB scripting
DisplayCentury (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
DisplayComboBox (RT Advanced)
Description
DisplayGridLines (RT Advanced)
Description
DisplayLabeling (RT Advanced)
Description
DisplayNumbers (RT Advanced)
Description
DisplayOptions (RT Professional)
Description
Specifies whether alarms whose view was suppressed are displayed.
Syntax
Object.DisplayOptions[=AlarmDisplayOptions]

VB scripting
Object
● AlarmControl
AlarmDisplayOptions
Optional. A value or a constant that specifies whether alarms that were hidden are displayed.
Value Explanation
0 All messages
1 Only displayed messages
2 Only hidden messages
See also
DisplaySize (RT Advanced)
Description
DisplayStatusBar (RT Advanced)
Description
DisplaySystemTime (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
DisplayTable (RT Advanced)
Description

VB scripting
DoubleClickAction (RT Professional)
Description
Specifies the action to be executed in runtime by double-clicking on a message line.
Syntax
Object.DoubleClickAction[=AlarmControlActions]
Object
● AlarmControl
AlarmControlActions
Optional. A value or a constant that specifies the action to be executed in runtime when you
double-click on an alarm line.
Value Description Explanation

0 None No action.
1 Loop-in-alarm Calls the "Loop-in-alarm" function.
2 Open comments dialog Calls the "Comments dialog" button function.
3 Open Infotext dialog Calls the "Infotext dialog" button function.
4 Column-dependent The action is determined by the column in which you dou‐
ble-clicked.
See also
DrawInsideFrame (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies whether the border line is to be shown with a line thickness of greater than 1 within
the border or symmetrically to the border.
Access in runtime:
Syntax
Object.DrawInsideFrame[=BOOLEAN]

VB scripting
Object
● Bar
● Button
● CheckBox
● Circle
● CircleSegment
● CircularArc
● Ellipse
● EllipseSegment
● EllipticalArc
● GraphicIOField
● OptionGroup
● Rectangle
● RoundButton
● SymbolicIOField
● TextField
● WindowSlider
● Switch
● TubeArcObject
BOOLEAN
Optional. TRUE if the border line is shown with a line thickness of greater than 1 within the
border.
Drive (RT Professional)
Description

VB scripting
1.5.5.5 Properties E-F (Panels, Comfort Panels, RT Advanced, RT Professional)
EdgeStyle (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the line style.
Access in runtime:
Syntax
Object.EdgeStyle[=LineStyle]
Object
● Bar
● Button
● CheckBox
● Circle *
● CircleSegment
● ComboBox
● Ellipse *
● EllipseSegment
● GraphicIOField
● GraphicView
● IOField *
● ListBox
● MultiLineEdit
● OptionGroup
● Polygon *
● Rectangle *
● RoundButton
● SymbolicIOField
● TextField *
● WindowSlider

VB scripting

● AlarmView
● Clock
● DateTimeField
● Gauge
● RecipeView
● Slider
● StatusForce
● Switch
● SysDiagControl
● TrendView
● UserView
LineStyle
Optional. A value or a constant that specifies the line style. Value range from -1 to 4.
The objects "Ellipse", "Circle", "Rectangle" and "Polygon" support the line styles:

0 hmiLineStyleSolid Solid line
1 hmiLineStyleDash Dashed line
2 hmiLineStyleDot Dotted line
3 hmiLineStyleDashDot Dash-dot line
4 hmiLineStyleDashDot‐ Dash-dot-dot line
Dot
The objects "TextField" and "IOField" support only the line styles:

-1 hmiLineStyleNone No line
See also
Bar (Page 257)
Button (Page 265)
CheckBox (Page 274)
Circle (Page 278)
ComboBox (Page 289)
Ellipse (Page 299)

VB scripting

IOField (Page 331)
Listbox (Page 339)
Polygon (Page 378)
Gauge (Page 319)
Slider (Page 409)
Switch (Page 419)
UserView (Page 480)
EditOnFocus (RT Professional)
Description
Specifies whether the data input is immediately possible if the input field is selected using the
<Tab> key.
Syntax
Object.EditOnFocus[=BOOLEAN]

VB scripting
Object
● IOField
● SymbolicIOField
BOOLEAN
Optional TRUE, if the data input is immediately possible and the input field has been selected
using the <Tab> key.
See also
IOField (Page 331)
Enabled (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies whether the selected object can be operated in runtime.
Syntax
Object.Enabled[=BOOLEAN]
Object
● AlarmControl *
● AlarmView **
● Bar
● Button
● ChannelDiagnose *
● CheckBox *
● Circle
● CircleSegment *
● CircularArc *
● Clock
● ComboBox *
● Connector *

VB scripting
● DiscSpaceView *
● Ellipse
● EllipticalArc *
● FunctionTrendControl **
● Gauge
● GraphicIOField
● GraphicView
● HTMLBrowser
● IOField
● Line
● ListBox *
● MediaPlayer
● MultiLineEdit *
● OptionGroup *
● PLCCodeViewer **
● PdfView **
● Polygon
● Polyline
● ProDiagOverview ***
● RecipeView **
● Rectangle
● RoundButton *
● S7GraphOverview **
● Slider
● SmartClientView **
● StatusForce **
● Switch **
● SymbolLibrary
● SymbolicIOField
● SysDiagControl ****
● TextField
● TrendView **
● TubeArcObject *

VB scripting
● TubeTeeObject *
● Tubepolyline *
● UserView
● WindowSlider *
*** RT Advanced Read access
**** Read access only

BOOLEAN
Optional. T RUE, if the specified object can be operated in Runtime.
See also
Bar (Page 257)
Button (Page 265)
ChannelDiagnose (Page 273)
CheckBox (Page 274)
Circle (Page 278)
Clock (Page 286)
ComboBox (Page 289)
DiskSpaceView (Page 297)
Ellipse (Page 299)

VB scripting
Gauge (Page 319)

IOField (Page 331)
Line (Page 336)
Listbox (Page 339)
PLCCodeViewer (Page 376)
Polygon (Page 378)
Polyline (Page 381)
S7GraphOverview (Page 402)
Slider (Page 409)
Switch (Page 419)

VB scripting
UserView (Page 480)

EnableDelete (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies whether data can be deleted in runtime.
Syntax
Object.EnableDelete[=BOOLEAN]
Object
BOOLEAN
Optional.
TRUE, if data can be deleted in runtime.
FALSE, if data cannot be deleted in runtime.
See also
EnableEdit (RT Professional)
Description
Specifies whether the data shown can be edited in runtime.
Syntax
Object.EnableEdit[=BOOLEAN]
Object

VB scripting
BOOLEAN
Optional.
TRUE if the data can be changed in runtime.
FALSE if the data cannot be changed in runtime.
See also
EnableInsert (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies whether data can be inserted in runtime.
Syntax
Object.EnableInsert[=BOOLEAN]
Object
BOOLEAN
Optional.
TRUE, if data can be inserted in runtime.
FALSE, if data cannot be inserted in runtime.
See also
EnableNavigateButtons (RT Advanced)
Description

VB scripting
EnableNavigateKeys (RT Advanced)
Description
EncryptCommunication (RT Advanced)
Description
EndAngle (RT Professional)
Description
Specifies the angle by which the end point deviates from the zero position (0°).
Syntax
Object.EndAngle[=Int32]
Object
● CircleSegment
● CircularArc
● EllipseSegment
● EllipticalArc
● TubeArcObject
Int32
Optional. A value or a constant that specifies the angle by which the end point deviates from
the zero position (0°).
See also

VB scripting
EndLeft (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
EndStyle (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies how the line end is displayed.
Syntax
Object.EndStyle[=LineEndStyle]
Object
● Connector
● Line
● Polyline
LineEndStyle
Optional. A value or a constant that specifies the line-end shapes.

0 hmiLineEndStyleNone The line has no end symbol.
65536* hmiLineEndStyleArrow The line ends with an empty arrowhead.
131072 hmiLineEndStyleFilledArrow The line ends with a filled arrowhead.
196608* hmiLineEndStyleFilledArrowReversed The line ends with a reversed arrowhead.
262144* hmiLineEndStyleLine The line ends with a vertical line.
327680* hmiLineEndStyleCircle The line ends with a circle.
393216* hmiLineEndStyleFilledCircle The line ends with a filled circle.
* Only RT Professional
See also
Line (Page 336)
Polyline (Page 381)

VB scripting
EndTop (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
EnterButtonVisible (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
EntryNameCaption (RT Advanced)
Description
EntryNameColumnWidth (RT Advanced)
Description
EntryValueColFirst (RT Advanced)
Description
EntryValueColumnWidth (RT Advanced)
Description
EntryValueFieldLength (RT Advanced)
Description

VB scripting
EntryValuePos (RT Advanced)
Description
ErrorColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the color of errors in the GRAPH overview.
Syntax
Object.ErrorColor[=Color]
Object
● S7GraphOverview
Color
Optional. A value or a constant that specifies the color for errors.
Comments
RGB (255, 0, 0)
See also

VB scripting
ErrorDescription (RT Professional)
Description
Returns one of the following error descriptions in English:
Output Description
"" OK
"Operation Failed" Execution error
"Variable not found" Tag error
"Server down" Server not available.
"An error occured for one or several tags" Multi Tag Error (Error in one or several tags)
To obtain an error description, first of all carry out the Read method.
Note
If the error occurs when accessing via the TagSet object, evaluate the ErrorDescription
property for each tag of the TagSet object.
Syntax
Object.ErrorDescription
Object
Required A "Tag" object.
Example
The following example shows the error description for the "Tag1" tag:
'VBS72
Dim objTag
objtag.Read
MsgBox objTag.ErrorDescription

VB scripting
The following example adds two tags to the TagSet list and outputs the ErrorDescription
property as Trace:
'VBS179
Dim group
group.Add "Motor1"
group.Add "Motor2"
HMIRuntime.Trace "ErrorDescription: " & group.ErrorDescription & vbNewLine
The ErrorDescription property of a tag contained in the list may be accessed as follows:
HMIRuntime.Trace "ErrorDescription: " & group("Motor1").ErrorDescription & vbNewLine
See also
Tag (Page 227)
TagSet (list) (Page 231)
Errorflag (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies whether an error description is displayed in the device / detail view.
Syntax
Object.Errorflag[=BOOLEAN]
Object
● S7GraphOverview
BOOLEAN
Optional.
TRUE, if an error description is displayed in the device/detail view.
FALSE, if no error description is displayed in the device/detail view.
See also

VB scripting
ES2RT_ButtonPositions (RT Advanced)
Description
ES2RT_ColumnOrder (RT Advanced)
Description
ES2RT_ColumnWidth (RT Advanced)
Description
ES2RT_EntryNameColumnWidth (RT Advanced)
Description
ES2RT_EntryValueColumnWidth (RT Advanced)
Description
ES2RT_ListAreaHeight (RT Advanced)
Description
ES2RT_ListAreaWidth (RT Advanced)
Description

VB scripting
ES2RT_MessageAreaHeight (RT Advanced)
Description
ES2RT_MessageAreaWidth (RT Advanced)
Description
ES2RT_StoreAsCheckBack (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Es2rtButtonPositions (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Es2rtTableBounds (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
EscButtonVisible (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
EsPreviewType (Panels, Comfort Panels, RT Advanced, RT Professional)
Description

VB scripting
EvenRowBackColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ExportDelimiter (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ExportDirectoryChangeable (RT Professional)
Description
Specifies whether the data export directory can be changed in runtime.
Syntax
Object.ExportDirectoryChangeable[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
Optional.
TRUE if the directory for data export can be changed in runtime.
FALSE if the directory for data export cannot be changed in runtime.
See also

VB scripting

ExportDirectoryname (RT Professional)
Description
Defines the directory to which the exported Runtime data is written.
Syntax
Object.ExportDirectoryname[=STRING]
Object
● AlarmControl
STRING
Optional A value or a constant which specifies the directory.
See also
ExportFileExtension (RT Professional)
Description
Specifies the file extension of the export file. Only the "csv" file extension is currently supported.

VB scripting
Syntax
Object.ExportFileExtension[=STRING]
Object
● AlarmControl
STRING
Optional. Specifies the file extension of the export file.
See also
ExportFilename (RT Professional)
Description
Specifies the name of the target file for the exported runtime data.
Syntax
Object.ExportFilename[=STRING]

VB scripting
Object
● AlarmControl
STRING
Optional. Specifies the name of the target file for the exported runtime data.
See also
ExportFilenameChangeable (RT Professional)
Description
Specifies whether the export file name can be changed in runtime.
Syntax
Object.ExportFilenameChangeable[=BOOLEAN]
Object
● AlarmControl

VB scripting
BOOLEAN
Optional.
TRUE if the export file can be renamed in runtime.
FALSE if the export file cannot be renamed in runtime.
See also
ExportFormat (RT Professional)
Description
ExportFormatGuid (RT Professional)
Description
Specifies the assignment of ID number and export provider.
Syntax
Object.ExportFormatGuid[=STRING]
Object
● AlarmControl

VB scripting
STRING
Optional. A value or constant that specifies the assignment of ID number and export provider.
See also
ExportFormatName (RT Professional)
Description
Defines the export file format. Only the "csv" file format is currently available for the export.
Syntax
Object.ExportFormatName[=STRING]
Object
● AlarmControl
STRING
Optional A value or a constant that defines the file format for export.
See also

VB scripting

ExportParameters (RT Professional)
Description
Specifies the parameters of the selected format by means of the properties dialog.
Syntax
Object.ExportParameters
Object
● AlarmControl
ExportParameters
Optional. A value or constant that specifies the parameters of the selected format in the
Properties dialog.
See also
ExportSelection (RT Professional)
Description
Specifies which runtime data of the control is exported.

VB scripting
Syntax
Object.ExportSelection[=ExportRange]
Object
● AlarmControl
ExportRange
Optional. A value or a constant that specifies which runtime data of the control can be exported.

0 all All Runtime data of the control is exported.
1 Selection Selected Runtime data of the control is exported.
See also
ExportShowDialog (RT Professional)
Description
Enables the display of the export dialog during runtime.
Syntax
Object.ExportShowDialog[=BOOLEAN]

VB scripting
Object
● AlarmControl
BOOLEAN
Optional TRUE, if the dialog box is shown in Runtime.
See also
ExtendedZoomingEnable (RT Professional)
Description
Specifies whether the operator can zoom the screen in or out in runtime by turning the mouse
wheel.
Access during runtime: Read and write
Syntax
Object.ExtendedZoomingEnable[=BOOLEAN]
Object
BOOLEAN
Optional TRUE, if the operator can zoom the screen in and out in runtime.

VB scripting
Example
The following example shows how the extended zoom can be enabled for the NewPDL1
screen:
'VBS155
Dim objScreen
Set objScreen = HMIRuntime.Screens("NewPDL1")
objScreen.ExtendedZoomingEnable = 1
See also
Screen (Page 214)
ExtraHeightOffset (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
FieldLength (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
FileName (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the name of the file to be loaded.
Access in runtime:
Syntax
Object.FileName[=STRING]
Object
● MediaPlayer

VB scripting

● PdfView
STRING
Optional. A value or a constant that specifies the name of the file to be loaded.
See also
FillColorMode (RT Professional)
Description
Specifies the type of foreground for the selected object.
Syntax
Object.FillColorMode[=SymbolLibraryColorMode]
Object
● SymbolLibrary
SymbolLibraryColorMode
Optional. A value or a constant that specifies the type of foreground for the object.
Val‐ VB constant Explanation

ue
0 hmiSymbolLibraryAppearanceOriginal The surface is gray.
1 hmiSymbolLibraryAppearanceShaded The display is shaded.
2 hmiSymbolLibraryAppearanceSolid The display is solid.
3 hmiSymbolLibraryAppearanceTranspar‐ The display is gray.
ent
See also

VB scripting
FillPattern (RT Professional)
Description
FillPatternColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the color of the fill pattern.
Access in runtime
Syntax
Object.FillPatternColor[=Color]
Object
● Bar
● Button
● CheckBox
● Circle
● CircleSegment
● Ellipse
● EllipseSegment
● GraphicView
● IOField
● OptionGroup
● Polygon
● Rectangle
● RoundButton
● TextField
● WindowSlider
*: Read access only

VB scripting

● AlarmControl
● ComboBox
● DateTimeField
● ListBox
Color
Optional. A value or a constant that specifies the color of the fill pattern.
Comments
RGB (255, 0, 0)
See also
Bar (Page 257)
Button (Page 265)
CheckBox (Page 274)
Circle (Page 278)
ComboBox (Page 289)
Ellipse (Page 299)
IOField (Page 331)
Listbox (Page 339)
Polygon (Page 378)

VB scripting

FillStyle (RT Advanced)
Description
Specifies whether the background color is displayed with a broken line.
Syntax
Object.FillStyle[=LineFillStyle]
Object
● Line
● Polyline
LineFillStyle
Optional. A value or a constant that specifies the fill style.

0 hmiLineFillStyleTransparent Transparent background
1 hmiLineFillStyleSolid Object background is filled with the specified color
See also
Line (Page 336)
Polyline (Page 381)
FillingDirection (RT Professional)
Description
Specifies the fill direction.

VB scripting
Syntax
Object.FillingDirection[=FillDirection]
Object
● Button
● CheckBox
● Circle
● CircleSegment
● Ellipse
● EllipseSegment
● GraphicView
● OptionGroup
● Polygon
● Rectangle
● RoundButton
● TextField
● WindowSlider
FillDirection
Optional. A value or a constant which specifies the fill direction.
Filter (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
FilterSQL (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Sets an SQL statement for the filter criterion.

VB scripting
Syntax
Object.FilterSQL[=STRING]
Object
STRING
Optional. A value or constant that specifies the SQL statement for the filter criterion.
See also
FilterTag (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
FilterText (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
FirstConnectedObject (RT Professional)
Description
FirstConnectedObjectIndex (RT Professional)
Description
Specifies the index number of the upper connector point.
Syntax
Object.FirstConnectedObjectIndex[=Int]
Object

VB scripting

● Connector
Int
Optional. A value or a constant that specifies the index number of the upper connector point.
See also
FirstConnectedObjectName (RT Professional)
Description
Specifies the name of the object that is docked to the upper connector point.
Syntax
Object.FirstConnectedObjectName[=String]
Object
● Connector
String
Optional. A value or a constant that specifies the name of the object that is docked to the upper
connector point.
See also
FirstGradientColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
FirstGradientOffset (Panels, Comfort Panels, RT Advanced, RT Professional)
Description

VB scripting
FitToLargest (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
FitToSize (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
FitToSizeLowerRows (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
FitToSizeUpperRows (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
FixedAspectRatio (RT Professional)
Description
Specifies whether the aspect ratio should be maintained or changed when the symbol size is
altered.
Syntax
Object.FixedAspectRatio[=BOOLEAN]
Object
● SymbolLibrary
BOOLEAN
Optional TRUE, if the aspect ratio should be maintained when the symbol size is altered.

VB scripting
See also
Flashing (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies whether the selected object flashes in runtime.
Access in runtime:
Syntax
Object.Flashing[=FlashingType]
Object
● Clock
● Gauge
● Slider
● AlarmView
● Bar
● Button
● CheckBox
● Circle
● CircleSegment
● CircularArc
● Connector
● DateTimeField
● Ellipse
● EllipseSegment
● EllipticalArc
● GraphicIOField
● GraphicView
● HTMLBrowser
● IOField

VB scripting
● Line
● OptionGroup
● Polygon
● Polyline
● RecipeView
● Rectangle
● RoundButton
● ScreenWindow
● SmartClientView
● StatusForce
● Switch
● SymbolicIOField
● SymbolLibrary
● SysDiagControl
● TextField
● TrendView
● TubeArcObject
● UserView
● WindowSlider
FlashingType
Optional. A value or a constant that specifies whether the object flashes in runtime.
Designation Description
None The object does not flash in runtime.
Standard The object flashes in runtime.
FlashingColorOff (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the color of the border line for the flashing status "Off".
Access in runtime:
Syntax
Object.FlashingColorOff[=Color]

VB scripting
Object
● Button
● CheckBox
● Circle
● CircleSegment
● CircularArc
● Connector
● Ellipse
● EllipseSegment
● EllipticalArc
● IOField
● Line
● OptionGroup
● Polygon
● Polyline
● Rectangle
● RoundButton
● TextField
*: Read access only

● Bar
● Switch
● TubeArcObject
Color
"Off".
Comments
RGB (255, 0, 0)

VB scripting
See also
Button (Page 265)
Circle (Page 278)
Ellipse (Page 299)
IOField (Page 331)
Line (Page 336)
Polygon (Page 378)
Polyline (Page 381)
Bar (Page 257)
CheckBox (Page 274)
Switch (Page 419)
FlashingColorOn (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the color of the border line for the flashing status "On".
Access in runtime:
Syntax
Object.FlashingColorOn[=Color]

VB scripting
Object
● Button
● CheckBox
● Circle
● CircleSegment
● CircularArc
● Connector
● Ellipse
● EllipseSegment
● EllipticalArc
● GraphicIOField
● IOField
● Line
● OptionGroup
● Polygon
● Polyline
● Rectangle
● RoundButton
● TextField
*: Read access only

● Bar
● Switch
● TubeArcObject
Color
"On".
Comments
RGB (255, 0, 0)

VB scripting
See also
Button (Page 265)
Circle (Page 278)
Ellipse (Page 299)
IOField (Page 331)
Line (Page 336)
Polygon (Page 378)
Polyline (Page 381)
Bar (Page 257)
CheckBox (Page 274)
Switch (Page 419)
FlashingEnabled (RT Professional)
Description
Specifies whether flashing is activated for the object in runtime.
Access in runtime:
Syntax
Object.FlashingEnabled[=BOOLEAN]

VB scripting
Object
● Button
● CheckBox
● Circle
● CircleSegment
● CircularArc
● Connector
● Ellipse
● EllipseSegment
● EllipticalArc
● GraphicIOField
● IOField
● Line
● OptionGroup
● Polygon
● Polyline
● Rectangle
● RoundButton
● TextField
*: Read access only

● Bar
● Switch
● TubeArcObject
BOO LEAN
Optional.
TRUE if flashing is activated for the object in runtime.
FALSE if flashing is not activated for the object in runtime.
See also
Button (Page 265)
Circle (Page 278)

VB scripting

Ellipse (Page 299)
IOField (Page 331)
Line (Page 336)
Polygon (Page 378)
Polyline (Page 381)
Bar (Page 257)
CheckBox (Page 274)
Switch (Page 419)
FlashingOnLimitViolation (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
FlashingRate (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the flash rate of the border line.
Access in runtime:
Syntax
Object.FlashingRate[=FlashingRate]

VB scripting
Object
● Button
● CheckBox
● Circle
● CircleSegment
● CircularArc
● Connector
● Ellipse
● EllipseSegment
● EllipticalArc
● GraphicIOField
● IOField
● Line
● OptionGroup
● Polygon
● Polyline
● Rectangle
● RoundButton
● TextField
* Read access only

● Bar
● Switch
● TubeArcObject
FlashingRate
Optional. A value or a constant that specifies the flash rate of the border line.


VB scripting
See also
Button (Page 265)
Circle (Page 278)
Ellipse (Page 299)
IOField (Page 331)
Line (Page 336)
Polygon (Page 378)
Polyline (Page 381)
Bar (Page 257)
CheckBox (Page 274)
Switch (Page 419)
FlashTransparentColor (RT Professional)
Description
Specifies the color of the bitmap object of a flashing graphic that is set to "transparent".
Syntax
Object.FlashTransparentColor[=Color]
Object
● GraphicIOField

VB scripting
Color
Optional. A value or a constant that specifies the color of the bitmap object of a flashing graphic
that is set to "transparent".
Comments
RGB (255, 0, 0)
See also
Flip (RT Professional)
Description
Specifies whether the symbol is flipped on the vertical and / or horizontal center axis of the
symbol.
Syntax
Object.Flip[=SymbolLibraryFlip]
Object
● SymbolLibrary
SymbolLibraryFlip
Optional. A value or a constant that specifies whether the symbol is flipped on the vertical and /
or horizontal center axis of the symbol.

0 hmiSymbolLibraryFlipNone The symbol is not flipped.
1 hmiSymbolLibraryFlipHori‐ The symbol is flipped horizontally.
zontal
2 hmiSymbolLibraryFlipVerti‐ The symbol is flipped vertically.
cal
3 hmiSymbolLibraryFlipBoth The symbol is flipped horizontally and vertically.

VB scripting
See also
FocusColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the color of the focus border when the object has the focus.
Access in runtime:
● RT Advanced: Read and write
● RT Professional: No access
Syntax
Object.FocusColor[=Color]
Object
● AlarmView
● Button
● GraphicIOField
● RecipeView
● Slider *
● StatusForce
● Switch
● TrendView
* RT Professional read and write access
● SymbolicIOField
Color
Optional. A value or a constant that specifies the color of the focus border.
Comments
RGB (255, 0, 0)

VB scripting
See also
Slider (Page 409)
Switch (Page 419)
Button (Page 265)
FocusWidth (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the border width when the object has the focus.
Access in runtime:
Syntax
Object.FocusWidth[=Int32]
Object
● AlarmView
● Button
● GraphicIOField
● RecipeView
● Slider *
● StatusForce
● Switch
● TrendView
* RT Professional read and write access
● SymbolicIOField

VB scripting
Int32
Optional. A value or a constant that specifies the border width in pixels. Value range from 1 to
10.
See also
Slider (Page 409)
Switch (Page 419)
Button (Page 265)
Font (RT Professional)
Description
Specifies the font.
The font object has the following sub-properties
● Size (Font Size)
● Bold (yes/no)
● Name (font name)
● Italic (yes/no)
● Underline (underline yes/no)
● StrikeThrough (yes/no)
If two font properties are directly assigned, only the default property "Name" is assumed.
Access in runtime:
Syntax
Object.Font.[Size|Bold|Name|Italic|Underline|StrikeThrough][=Value]

VB scripting
Object
● AlarmControl
● Bar
● Clock
● Slider
● Button
● CheckBox
● ComboBox
● DateTimeField
● IOField
● ListBox
● MultiLineEdit
● OptionGroup
● RangeLabelView
● RecipeView
● RoundButton
● SmartClientView
● Switch
● SymbolicIOField
● TextField
● TrendView
● ZoneLabelView
Value
Optional. A value or a constant which specifies the selected subproperty.

VB scripting
Example
'VBS74
Dim objControl1
Dim objControl2
Set objControl1 = ScreenItems("Control1")
Set objControl2 = ScreenItems("Control2")
objControl2.Font.Name = objControl1.Font.Name ' take over only the type of font
See also
Clock (Page 286)
Slider (Page 409)
Bar (Page 257)
Button (Page 265)
CheckBox (Page 274)
ComboBox (Page 289)
IOField (Page 331)
Listbox (Page 339)
ProtectedAreaNameView (Page 385)
RangeLabelView (Page 386)
Switch (Page 419)
ZoneLabelView (Page 489)

VB scripting
FontBold (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies whether the text is shown in bold.
Syntax
Object.FontBold[=BOOLEAN]
Object
● Bar
● Button
● CheckBox
● ComboBox
● IOField
● ListBox
● MultiLineEdit
● OptionGroup
● RoundButton
● TextField
*: Read access only.
BOOLEAN
Optional. TRUE if the text is shown in bold.
FontItalic (RT Professional)
Description
Specifies whether the text is shown in italics.
Syntax
Object.FontItalic[=BOOLEAN]

VB scripting
Object
● Button
● CheckBox
● ComboBox
● IOField
● ListBox
● MultiLineEdit
● OptionGroup
● RoundButton
● TextField
*: Read access only
BOOLEAN
Optional. TRUE if the text is shown in italics.
See also
Button (Page 265)
CheckBox (Page 274)
ComboBox (Page 289)
IOField (Page 331)
Listbox (Page 339)
FontName (RT Professional)
Description
Specifies the font.

VB scripting
Syntax
Object.FontName[=STRING]
Object
● Bar
● Button
● CheckBox
● ComboBox
● IOField
● ListBox
● OptionGroup
● RoundButton
● TextField
*: Read access only

● MultiLineEdit
STRING
See also
Bar (Page 257)
Button (Page 265)
CheckBox (Page 274)
ComboBox (Page 289)
IOField (Page 331)
Listbox (Page 339)

VB scripting
FontSize (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the font size of the text.
Syntax
Object.FontSize[=Int32]
Object
● Bar
● Button
● CheckBox
● ComboBox
● IOField
● ListBox
● MultiLineEdit
● OptionGroup
● RoundButton
● TextField
*: Read access only.
Int32
Optional. A value or a constant that specifies the font size of the text.
FontUnderline (RT Professional)
Description
Specifies whether the text is shown underlined.
Syntax
Object.FontUnderline[=BOOLEAN]

VB scripting
Object
● Button
● CheckBox
● ComboBox
● IOField
● ListBox
● MultiLineEdit
● OptionGroup
● RoundButton
● TextField
*: Read access only
BOOLEAN
Optional. TRUE if the text is shown underlined.
ForeColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the font color of the text.
Syntax
Object.ForeColor[=Color]
Object
● Bar
● Button
● CheckBox **
● ComboBox **
● DateTimeField *
● IOField
● ListBox **
● MultiLineEdit **
● OptionGroup **

VB scripting
● RecipeView *
● RoundButton ***
● Slider
● Switch *
● SymbolLibrary
● SymbolicIOField ****
● TextField
* RT Professional No access
** RT Advanced No access
*** RT Advanced No access, RT Professional read access only
**** RT Professional Read access only
● AlarmView
Color
Optional. A value or a constant that specifies the font color of the text.
Comments
RGB (255, 0, 0)
See also
Bar (Page 257)
Button (Page 265)
CheckBox (Page 274)
ComboBox (Page 289)
IOField (Page 331)
Listbox (Page 339)

VB scripting
Slider (Page 409)

Switch (Page 419)
ForeColorTransparency (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Format (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
FormatPattern (RT Professional)
Description
Specifies the format of the output value.
Syntax
Object.FormatPattern[=STRING]
Object
● IOField
STRING
Optional. A value or a constant that specifies the format of the output value.
See also
IOField (Page 331)

VB scripting
FrameColor (RT Professional)
Description
Specifies the background color of the gauge.
Also set "background graphic" to "none".
Access in Runtime:
Syntax
Object.FrameColor[=Color]
Object
● Gauge
Color
Optional. A value or a constant that specifies the background color of the gauge.
Comments
RGB (255, 0, 0)
Free (RT Professional)
Description
FreePercent (RT Professional)
Description
Returns the measured values for the free disk space as a percentage. The values can be
queried in Runtime. The values cannot be predefined.

VB scripting
Syntax
Object.FreePercent[=Int32]
Object
● DiscSpaceView
Int32
Optional A value or a constant that returns the measured values for the free disk space as a
percentage.
See also
1.5.5.6 Properties G-H (Panels, Comfort Panels, RT Advanced, RT Professional)
Gradation (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the value difference between two main marking lengths of the "Gauge" object.
Syntax
Object.Gradation[=SINGLE]
Object
● Gauge
SINGLE
Optional A value or a constant that specifies the value difference.
See also
Gauge (Page 319)

VB scripting
GraphDirection (RT Professional)
Description
Specifies at which border of the trend view the current values are displayed.
Syntax
Object.GraphDirection[=GraphDirection]
Object
GraphDirection
Optional. A value or a constant that specifies at which margin of the trend view the current
values are displayed.
Value Explanation
0 Positive values run to the right and upwards.
-1 Positive values run to the left and upwards.
-2 Positive values run to the right and upwards.
-3 Positive values run to the right and downwards.
See also
GridlineAxis (RT Advanced)
Description
GridLineColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the color for the grid lines.

VB scripting
Access in runtime
Read and write
Syntax
Object.GridLineColor[=Color]
Object
● AlarmControl
● AlarmView*
* RT Advanced read and write access, RT Professional no access

● TrendView
Color
Optional. A value or a constant that specifies the color of the grid lines.
Comments
RGB (255, 0, 0)
See also

VB scripting
GridlineEnabled (RT Advanced)
Description
GridlineFillColor (RT Advanced)
Description
GridlineStyle (RT Advanced)
Description
GridLineWidth (RT Professional)
Description
Defines the line weight of the row/column dividers in pixels.
Syntax
Object.GridLineWidth[=Int32]
Object
● AlarmControl
Int32
Optional A value or a constant which specifies the width of the grid line.
See also

VB scripting

GSCRuntimeAllowed (RT Professional)
Description
HeaderFont (RT Advanced)
Description
Height (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the height.
Syntax
Object.Height[=Int32]
Object
Required. An object of the type "ScreenItem". This property is a standard property of the
ScreenItem object and is therefore available for all formats.
You have no access in "Runtime Advanced" and "Panel Runtime" with the following formats:
● AlarmView
● Bar
● BatteryView
● Button
● CameraControl
● Clock
● DateTimeField
● Gauge
● GraphicIOField

VB scripting
● GraphicView
● HTMLBrowser
● IOField
● Line
● MediaPlayer
● PDFView
● PLCCodeViewer
● Polygon
● Polyline
● ProDiagOverview
● RangeLabelView
● RangeQualityView
● RecipeView
● S7GraphOverview
● Slider
● SmartClientView
● StatusForce
● Switch
● SymbolicIOField
● SymbolLibrary
● SysDiagControl
● TextField
● TrendView
● UserView
● WLanQualityView
● ZoneLabelView
● ZoneQualityView
Int32
Optional. A value or a constant that specifies the height in pixels.

VB scripting
Example
The following example halves the height of all objects of the image "NewPDL1", whose name
starts with "Circle":
'VBS75
Dim objScreen
Dim objCircle
Dim lngIndex
Dim strName
lngIndex = 1
For lngIndex = 1 To objScreen.ScreenItems.Count
'
'Searching all circles
strName = objScreen.ScreenItems.Item(lngIndex).ObjectName
If "Circle" = Left(strName, 6) Then
'
'to halve the height of the circles
Set objCircle = objScreen.ScreenItems(strName)
objCircle.Height = objCircle.Height / 2
End If
Next
See also
Line (Page 336)
Polyline (Page 381)
Ellipse (Page 299)
Circle (Page 278)
Polygon (Page 378)
IOField (Page 331)
Button (Page 265)
Switch (Page 419)
Bar (Page 257)

VB scripting
Clock (Page 286)

Gauge (Page 319)
Slider (Page 409)
CheckBox (Page 274)
ScriptDiagnostics (Page 407)
UserView (Page 480)
Listbox (Page 339)
BatteryView (Page 264)
ZoneQualityView (Page 490)
WLanQualityView (Page 487)

VB scripting

RangeQualityView (Page 388)
ComboBox (Page 289)
HelpText (Panels, Comfort Panels, RT Advanced)
Description
Returns the tooltip that is shown in Runtime as an operating aid for the specified object.
Syntax
Object.HelpText[=STRING]
Object
● Button
● DateTimeField
● GraphicIOField
● IOField
● Switch
● SymbolicIOField
● TrendView
STRING
Optional. A value or constant that specifies the contents of the tooltip that is shown in runtime
as an operator aid for the specified object.

VB scripting
See also
Button (Page 265)
IOField (Page 331)
Switch (Page 419)
HiddenInput (RT Professional)
Description
Specifies whether the input value or a * for each character will be shown during the input.
Syntax
Object.HiddenInput[=BOOLEAN]
Object
● IOField
BOOLEAN
Optional TRUE, if the input value is not shown during the input. An * is shown for each character.
See also
IOField (Page 331)
HighlightColor (RT Professional)
Description
Specifies the highlight color in the GRAPH overview.
Syntax
Object.HighlightColor[=Color]

VB scripting
Object
● S7GraphOverview
Color
Optional. A value or a constant that specifies the highlight color.
Comments
RGB (255, 0, 0)
See also
HighLimitColor (RT Professional)
Description
Specifies the color of the top or right scroll button in a scroll bar.
Syntax
Object.HighLimitColor[=Color]
Object
● WindowSlider
Color
Optional. A value or a constant that specifies the color of the top or right scroll button in a scroll
bar.
Comments
RGB (255, 0, 0)

VB scripting
See also
Hitlist (RT Professional)
Description
HitlistColumnAdd (RT Professional)
Description
Creates a new alarm text block in alarm statistics. The newly created alarm text block is
automatically referenced with "HitlistColumnIndex".
Syntax
Object.HitlistColumnAdd[=STRING]
Object
● AlarmControl
STRING
Required. A value or a constant that specifies the name of the new alarm text block in alarm
statistics with "HitlistColumnName".
See also
HitlistColumnIndex (Page 731)
HitlistColumnCount (RT Professional)
Description
Specifies the number of configured alarm text blocks in alarm statistics.

VB scripting
Syntax
Object.HitlistColumnCount[=Int32]
Object
● AlarmControl
Int32
Optional. A value or a constant that specifies the number of configured alarm text blocks in
alarm statistics.
See also
HitlistColumnIndex (RT Professional)
Description
References an alarm text block selected for alarm statistics. To access the properties of a
alarm text block, you need to set "HitlistColumnIndex".
Values between 0 and "HitlistColumnIndex minus 1 are valid for "HitlistColumnCount". The
"HitlistColumnCount" property specifies the number of configured alarm text blocks.
Syntax
Object.HitlistColumnIndex[=Int32]
Object
● AlarmControl
Int32
Optional. A value or a constant that specifies, with the index, the alarm text block to be edited.
See also
HitlistColumnCount (Page 729)

VB scripting
HitlistColumnName (RT Professional)
Description
Specifies the name of an alarm statistics alarm text block referenced with "HitlistColumnIndex".
You cannot edit this name.
Syntax
Object.HitlistColumnName[=STRING]
Object
● AlarmControl
STRING
Optional. A value or a constant that specifies the name of the referenced alarm text block in
alarm statistics.
See also
HitlistColumnRemove (RT Professional)
Description
Removes an alarm statistics alarm text block referenced with its name.
Syntax
Object.HitlistColumnRemove[=STRING]
Object
● AlarmControl
STRING
Optional. A value or a constant that specifies the name of the referenced alarm statistics alarm
text block to be removed.

VB scripting
See also
HitlistColumnRepos (RT Professional)
Description
Specifies the position of an alarm text block referenced with "HitlistColumnIndex" in alarm
statistics.
If you have changed the position of the alarm text block with "HitlistColumnRepos",
"HitlistColumnIndex" is assigned the value of "HitlistColumnRepos".
Syntax
Object.HitlistColumnRepos[=Int32]
Object
● AlarmControl
Int32
Optional. A value or a constant that specifies the position of the referenced alarm text block
in alarm statistics. Value range from 0 to "HitlistColumnCount" minus 1. Values outside this
range have no effect.
0: The referenced alarm text block is positioned on the left.
See also
HitlistColumnCount (Page 729)
HitlistColumnSort (RT Professional)
Description
Specifies the sorting order in the hit list for the alarm text block that is referenced in
"HitlistColumnIndex".

VB scripting
Syntax
Object.HitlistColumnSort[=SortMode]
Object
● AlarmControl
SortMode
Optional. A value or a constant that specifies which runtime data of the control can be exported.
Value Explanation
0 No sorting
See also
HitlistColumnSortIndex (RT Professional)
Description
Specifies the sorting order of the alarm statistics alarm text block referenced with
"HitlistColumnIndex".
If you set the value to "0", the sorting criterion in "HitlistColumnSort" is removed.
Syntax
Object.HitlistColumnSortIndex[=Int32]
Object
● AlarmControl
Int32
Optional. Specifies the sorting order of the referenced alarm statistics alarm text block.
See also

VB scripting
HitlistColumnVisible (RT Professional)
Description
Specifies whether the alarm text block referenced with "HitlistColumnIndex" is displayed in
alarm statistics.
Syntax
Object.HitlistColumnVisible[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
Optional.
TRUE if the referenced alarm statistics alarm text block is displayed.
FALSE if the referenced alarm statistics alarm text block is not displayed.
See also
HitlistDefaultSort (RT Professional)
Description
Specifies the default sorting order in the table columns of alarm statistics.
Syntax
Object.HitlistDefaultSort[=SortMode]
Object
● AlarmControl

VB scripting
SortMode
Optional. A value or a constant that specifies the default sorting order in the table columns of
alarm statistics.
Value Explanation
0 The list is sorted in ascending order of frequency.
1 The list is sorted in descending order of frequency.
See also
HitlistFilter (RT Professional)
Description
HitlistMaxSourceItems (RT Professional)
Description
Specifies the maximum number of data records that can be used from the alarm log to create
alarm statistics. The value can be anything from "0 - 10000".
Syntax
Object.HitlistMaxSourceItems[=Int32]
Object
● AlarmControl
Int32
Optional. A value or a constant that specifies the maximum number of data records that can
be used from the alarm log to create alarm statistics.
See also

VB scripting
HitlistMaxSourceItemsWarn (RT Professional)
Description
Specifies that a warning is output when the maximum number of data records in the alarm
view is reached.
Syntax
Object.HitlistMaxSourceItemsWarn[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
TRUE if an alarm is output as soon as the maximum number of data records in the alarm view
is reached.
FALSE if no alarm is output when the maximum number of data records in the alarm view is
reached.
See also
HitListRelTime (RT Professional)
Description
Specifies whether the calculation period for alarm statistics is limited.
Syntax
Object.HitListRelTime [=BOOLEAN]
Object
● AlarmControl
BOOLEAN
TRUE if the specified time range is used for statistics.
FALSE if the specified time range is not used.

VB scripting
See also
HitListRelTimeFactor (RT Professional)
Description
Specifies the time factor which, alongside the time type "HitlistRelTimeFactorType
(Page 738)", determines the time period for which the alarm statistics are created.
Syntax
Object.HitListRelTimeFactor[=Int32]
Object
● AlarmControl
Int32
Optional. A value or a constant that specifies the time factor.
See also
HitlistRelTimeFactorType (RT Professional)
Description
Specifies the time unit that, together with the time factor "HitlistRelTimeFactor", defines the
time range displayed for alarm statistics.
Syntax
Object.HitListRelTimeFactorType[=AlarmControlTimeUnit)
Object
● AlarmControl

VB scripting
AlarmControlTimeUnit
Optional. A value or a constant that specifies the time unit.
Value Designation
0 Minute
1 Hour
2 Day
3 Week
4 Month
See also
HomeButtonVisible (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
HorizontalAlignment (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the horizontal alignment of the text.
Syntax
Object.HorizontalAlignment[=HorizontalAlignment]
Object
● Button
● CheckBox *
● ComboBox *
● IOField
● ListBox *
● MultiLineEdit *
● OptionGroup *

VB scripting
● RoundButton ***
● Switch **
● SymbolicIOField ****
● TextField
*** RT Advanced No access, RT Professional read access only
**** RT Professional Read access only
HorizontalAlignment
Optional. A value or a constant that specifies the horizontal alignment of the text.

0 hmiAlignmentLeft The text is left-justified.
1 hmiAlignmentCentered The text is centered horizontally in the object.
2 hmiAlignmentRight The text is right-justified in the object.
See also
Button (Page 265)
CheckBox (Page 274)
ComboBox (Page 289)
IOField (Page 331)
Listbox (Page 339)
Switch (Page 419)
HorizontalGridLines (RT Professional)
Description
Specifies whether horizontal separating lines are displayed.

VB scripting
Syntax
Object.HorizontalGridLines[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
Optional.
TRUE if horizontal separation lines are displayed.
FALSE if horizontal separation lines are not displayed.
See also
HorizontalPictureAlignment (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
HorizontalScrollBarPosition (RT Professional)
Description
Specifies the position of the slider in the horizontal scroll bar. The picture is displayed by moving
the scroll bar slider horizontally.
To display the screen as a cutout where the scroll bars are located at the left and top edge of
the screen, use the LeftOffset (Page 778)" and "TopOffset (Page 1088)" properties as the
source of this cutout.
Syntax
Object.HorizontalScrollBarPosition[=Int32]

VB scripting
Object
● ScreenWindow
Int32
Optional. A value or a constant that specifies the horizontal position of the slide in the scroll
bar.
See also
HorizontalScrollingEnabled (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Hotkey (RT Professional)
Description
HourNeedleHeight (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the length of the hour hand.
Syntax
Object.HourNeedleHeight[=Int32]
Object
● Clock
Int32
Optional. A value or a constant that specifies the length of the hour hand.
Specify the length of the hour hand as a percentage relating to the radius of the clock face.

VB scripting
See also
Clock (Page 286)
HourNeedleWidth (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the width of the hour hand.
Syntax
Object.HourNeedleWidth[=Int32]
Object
● Clock
Int32
Optional. A value or a constant that specifies the width of the hour hand.
Specify the width of the hour hand as a percentage relating to double the length of the clock
face.
See also
Clock (Page 286)
1.5.5.7 Properties I-J (Panels, Comfort Panels, RT Advanced, RT Professional)
IconSpace (RT Professional)
Description
Defines the spacing between the icons and text in the table cells. The value is active if and
icon and text are displayed.
Syntax
Object.IconSpace[=Int32]

VB scripting
Object
● AlarmControl
Int32
Optional Value that specifies the spacing.
See also
Index (RT Professional)
Description
Specifies the index for the selected text field.
Syntax
Object.Index[=Int32]
Object
● CheckBox
● ComboBox
● ListBox
● OptionGroup
Int32
Optional A value or a constant that specifies the index of the selected text field.

VB scripting
See also
CheckBox (Page 274)
ComboBox (Page 289)
Listbox (Page 339)
IndipendentWindow (RT Professional)
Description
InfoArea_BackgroundColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
InfoArea_ColumnsMovable (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
InfoArea_DefaultTextColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
InfoArea_ErrorTextBackgroundColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
InfoArea_ErrorTextColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Description

VB scripting
InfoArea_FocusFrameColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
InfoArea_FocusFrameWidth (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
InfoArea_Font (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
InfoArea_RootNodeText (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
InfoArea_SelectionBackgroundColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
InfoArea_SelectionForegroundColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
InfoArea_ShowGridLines (Panels, Comfort Panels, RT Advanced, RT Professional)
Description

VB scripting
InfoArea_TableHeaderBackgroundColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
InfoArea_TableHeaderTextColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
InnerBackColorOff (RT Advanced)
Description
Specifies the color under the slider of the "Switch" object if the object is in OFF status.
Syntax
Object.InnerBackColorOff[=Color]
Object
● Switch
Color
Optional. A value or a constant that specifies the color for the OFF status.
Comments
RGB (255, 0, 0)
See also
Switch (Page 419)

VB scripting
InnerBackColorOn (RT Advanced)
Description
Specifies the color under the slider of the "Switch" object if the object is in ON status.
Syntax
Object.InnerBackColorOn[=Color]
Object
● Switch
Color
Optional. A value or a constant that specifies the color for the ON status.
Comments
RGB (255, 0, 0)
See also
Switch (Page 419)
InnerDialColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
InnerDialInnerDistance (Panels, Comfort Panels, RT Advanced, RT Professional)
Description

VB scripting
InnerDialOuterDistance (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
InnerHeight (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies ###
Access in runtime
Syntax
Object.InnerHeight[=Int32]
Object
● Button
● IOField
● RoundButton*
*: Read access only
Int32
InnerWidth (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies ###
Syntax
Object.InnerWidth[=Int32]

VB scripting
Object
● Button
● RoundButton*
*: Read access only
Int32
InputAddressText (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
InputValue (RT Professional)
Description
Specifies the input value. The value is not displayed in the object when the property is set.
To show the value entered in the object, configure the system function
"SetPropertyByProperty" to the event "Object changed":
Relevant parameters Value

Property name Process value
Name of the property Input value
This system function is meaningful if no tag connection is configured at the output value but
the user still wants to query the specified value, for example using a script.
Syntax
Object.InputValue[=Int32]
Object
● IOField
*: Read access only
Int32
Optional. A value or a constant that specifies the input value.

VB scripting
InspectorViewInternalColumnOrder (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
InspectorViewRowOrder (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Instance (RT Professional)
Description
Returns an instance of the alarm object.
IntegerDigits (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Establishes the number of integer digits (0 to 20).
Syntax
Object.IntegerDigits[=Int32]
Object
● Bar
Int32
Optional A value or a constant that specifies the number of integer digits (0 to 20).
See also
Bar (Page 257)

VB scripting
Interval (RT Professional)
Description
Specifies the time interval for updating the displayed measured value. You enter the value in
minutes.
Syntax
Object.Interval[=Int32]
Object
● DiscSpaceView
Int32
Optional A value or a constant that specifies the time interval for updating the measured values.
See also
IsActive (RT Professional)
Description
IsImageMiddleAligned (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
IsMinPasswordValueSet (Panels, Comfort Panels, RT Advanced, RT Professional)
Description

VB scripting
IsRunningUnderCE (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
IsVerticalScrollBarEnabled (RT Advanced)
Description
ItemBorderStyle (RT Professional)
Description
Specifies the line type of the separation lines in the selection list.
Access in runtime Read
Syntax
Object.ItemBorderStyle[=Int32]
Object
● SymbolicIOField
Int32
Optional. A value or a constant that specifies the type of separation lines in the selection list.

-1 hmiLineStyleNone The selection list has no separation lines.
0 hmiLineStyleSolid The selection list has solid separation lines.
1 hmiLineStyleDash The selection list has dashed separation lines.
2 hmiLineStyleDot The selection list has dotted separation lines.
3 hmiLineStyleDashDot The selection list has dash-dot separation lines.
4 hmiLineStyleDashDotDot The selection list has dash-dot-dot separation lines.
See also

VB scripting
ItemText_AKZ (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ItemText_Descriptor (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ItemText_ErrorText (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ItemText_HardwareRevision (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ItemText_IMDataVersion (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ItemText_InstallationDate (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ItemText_LADDR (Panels, Comfort Panels, RT Advanced, RT Professional)
Description

VB scripting
ItemText_ManufacturerID (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ItemText_Name (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ItemText_OKZ (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ItemText_OperationState (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ItemText_OrderID (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ItemText_ProfileID (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ItemText_Rack (Panels, Comfort Panels, RT Advanced, RT Professional)
Description

VB scripting
ItemText_RevisionCounter (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ItemText_SerialNumber (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ItemText_Slot (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ItemText_SoftwareRevision (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ItemText_SpecificProfileData (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ItemText_State (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ItemText_Station (Panels, Comfort Panels, RT Advanced, RT Professional)
Description

VB scripting
ItemText_SubAddress (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ItemText_SubSlot (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ItemText_SubSystem (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ItemText_Type (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
IV_ShowItem_AKZ (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
IV_ShowItem_Descriptor (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
IV_ShowItem_ErrorText (Panels, Comfort Panels, RT Advanced, RT Professional)
Description

VB scripting
IV_ShowItem_HardwareRevision (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
IV_ShowItem_IMDataVersion (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
IV_ShowItem_InstallationDate (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
IV_ShowItem_LADDR (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
IV_ShowItem_ManufacturerID (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
IV_ShowItem_Name (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
IV_ShowItem_OKZ (Panels, Comfort Panels, RT Advanced, RT Professional)
Description

VB scripting
IV_ShowItem_OperationState (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
IV_ShowItem_OrderID (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
IV_ShowItem_ProfileID (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
IV_ShowItem_Rack (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
IV_ShowItem_RevisionCounter (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
IV_ShowItem_SerialNumber (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
IV_ShowItem_Slot (Panels, Comfort Panels, RT Advanced, RT Professional)
Description

VB scripting
IV_ShowItem_SoftwareRevision (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
IV_ShowItem_SpecificProfileData (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
IV_ShowItem_State (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
IV_ShowItem_Station (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
IV_ShowItem_SubAddress (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
IV_ShowItem_SubSlot (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
IV_ShowItem_SubSystem (Panels, Comfort Panels, RT Advanced, RT Professional)
Description

VB scripting
IV_ShowItem_Type (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
JumpToLimitsAfterMouseClick (RT Professional)
Description
Specifies whether the slider will be set to the associated end value. The end value is the
minimum or maximum value. To set the slider to the end value, users click on the area outside
of the current slider setting.
Syntax
Object.JumpToLimitsAfterMouseClick[=BOOLEAN]
Object
● WindowSlider
BOOLEAN
Optional. TRUE, if the slider is set to the associated end value.
See also
1.5.5.8 Properties K-L (Panels, Comfort Panels, RT Advanced, RT Professional)
KeyboardOnline (RT Advanced)
Description
LabelColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the color of the scale label.

VB scripting
Syntax
Object.LabelColor[=Color]
Object
● Slider
Color
Optional. A value or a constant that specifies the color of the scale label.
Comments
RGB (255, 0, 0)
See also
Slider (Page 409)
Language (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Determines the current Runtime language.
Syntax
Object.Language[= LONG]
Object
LONG
Optional A value or a constant that specifies the national code.

VB scripting
Comments
Specify the Runtime language in VBS with a national code, e.g. 1031 for German, 2057 for
English etc.. Refer to the VBScript basics under the topic "Current local ID (LCID) diagram"
for an overview of all the national codes.
See also
LargeTickLabelingStep (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Returns the interval at which scale sections are labeled.
Syntax
Object.LargeTickLabelingStep[=Int32]
Object
● Bar
Int32
Optional. A value or constant that returns the interval at which scale sections are labeled.
See also
Bar (Page 257)
LargeTicksBold (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies whether the long marking lengths of a scale are shown in bold.
Syntax
Object.LargeTicksBold[=BOOLEAN]

VB scripting
Object
● Bar
BOOLEAN
Optional TRUE, if the long marking lengths of a scale are shown in bold.
See also
Bar (Page 257)
LargeTicksSize (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the length of the long marking lengths of a scale.
Syntax
Object.LargeTicksSize[=Int32]
Object
● Bar
Int32
Optional A value or a constant that specifies the length of the long marking lengths of a scale.
See also
Bar (Page 257)
LastConnectedObject (RT Professional)
Description

VB scripting
LastConnectedObjectIndex (RT Professional)
Description
Specifies the index number of the connection point to the last connected object.
Syntax
Object.LastConnectedObjectIndex[=Int]
Object
● Connector
Int
Optional. A value or a constant that specifies the index number of the connection point to the
last connected object.
See also
LastConnectedObjectName (RT Professional)
Description
Specifies the name of the object that is docked to the lower connector point.
Syntax
Object.LastConnectedObjectName[=String]
Object
● Connector
String
Optional. A value or a constant that specifies the name of the object that is docked to the lower
connector point.
See also

VB scripting
LastError (RT Professional)
Description
Returns an error code regarding the success of the last operation, e.g. information on a tag
write or read process:
Code in hexadecimal notation Description

0x00000000 OK
0x80040001 Execution error
0x80040002 Tag error
0x80040003 Server not available.
0x80040004 Multi Tag Error; error in one or several tags
To obtain an error description, first of all carry out the Read method.
Note
If the error occurs when accessing via the TagSet object, evaluate the LastError property for
each tag of the TagSet object.
To obtain a statement about the quality of the supplied value, use the "QualityCode" property.
To obtain a description of the error, use the "ErrorDescription" property.
Syntax
Object.LastError
Object
Necessary. A "Tag" object.
Example
The following example shows the error code for the "Tag1" tag:
'VBS77
Dim objTag
objTag.Read
MsgBox objTag.LastError

VB scripting
The following example adds two tags to the TagSet list and outputs the LastError property as
Trace:
'VBS178
Dim group
group.Add "Motor1"
group.Add "Motor2"
HMIRuntime.Trace "LastError: " & group.LastError & vbNewLine
The LastError property of a tag contained in the list may be accessed as follows:
HMIRuntime.Trace "LastError: " & group("Motor1").LastError & vbNewLine
See also
Tag (Page 227)
TagSet (list) (Page 231)
Layer (RT Advanced, RT Professional)
Description
Returns the layer in the screen in which an object is located. There is a total of 32 layers
available, whereby Layer "0" is the bottom layer and Layer "31" the top layer.
The configured objects are initially in the background of a layer.
Syntax
Object.Layer[=Int32]
Object
● AlarmControl *
● AlarmView **
● ApplicationWindow *
● Bar
● BatteryView ***
● Button
● CameraControl ***

VB scripting
● CheckBox *
● Circle
● CircleSegment *
● CircularArc *
● Clock
● ComboBox *
● Connector *
● DiscSpaceView *
● Ellipse
● EllipticalArc *
● FunctionTrendControl **
● Gauge
● GraphicIOField
● GraphicView
● HTMLBrowser
● IOField
● Line
● ListBox *
● MediaPlayer
● MultiLineEdit *
● OptionGroup *
● Polygon
● Polyline
● ProDiagOverview ****
● ProtectedAreaNameView ***
● RangeLabelView ***
● RangeQualityView ***
● RecipeView **
● Rectangle
● RoundButton *****
● S7GraphOverview
● ScreenWindow *

VB scripting
● Slider
● StatusForce **
● Switch **
● SymbolLibrary
● SymbolicIOField ******
● SysDiagControl *******
● TextField
● TrendView **
● TubeArcObject *
● TubeTeeObject *
● Tubepolyline *
● UserView
● WLanQualityView ***
● WindowSlider *
● ZoneLabelView ***
● ZoneQualityView ***
*** Only Panel RT read and write access
**** RT Advanced read access, RT Professional read and write access
***** RT Advanced No access, RT Professional read access
****** RT Advanced read and write access, RT Professional read access
******* Read access only

Int32
Optional. A value or a constant returns the layer in the screen in which an object is located.

VB scripting
Comments
Note
The Layer property specifies the layer in which the object is located. The layer "0" is output as
layer "0".
When accessed, the layers are counted up from 1 in VBS. Therefore, address the level "1"
with layers(2).
Example
The following example displays the name and layer of all objects in the screen "NewPDL1":
'VBS78
Dim objScreen
Dim objScrItem
Dim lngAnswer
Dim lngIndex
Dim strName
lngIndex = 1
For lngIndex = 1 To objScreen.ScreenItems.Count
strName = objScreen.ScreenItems.Item(lngIndex).ObjectName
Set objScrItem = objScreen.ScreenItems(strName)
lngAnswer = MsgBox(strName & " is in layer " & objScrItem.Layer,vbOKCancel)
If vbCancel = lngAnswer Then Exit For
Next
See also
Bar (Page 257)
Button (Page 265)
CameraControl (Page 271)
CheckBox (Page 274)
Circle (Page 278)
Clock (Page 286)

VB scripting
ComboBox (Page 289)

Ellipse (Page 299)
Gauge (Page 319)
IOField (Page 331)
Line (Page 336)
Listbox (Page 339)
Polygon (Page 378)
Polyline (Page 381)
Slider (Page 409)
Switch (Page 419)

VB scripting

UserView (Page 480)
LayerDeclutteringEnable (RT Professional)
Description
Indicates whether the layers of a screen can be shown or hidden dependent on the set
minimum and maximum zoom.
Syntax
Object.LayerDeclutteringEnable
Object
Example:
The example outputs the LayerDecluttering property of the "NewPDL1" screen as Trace.
'VBS156
Dim objScreen
HMIRuntime.Trace "Enable: " & objScreen.LayerDeclutteringEnable & vbNewLine

VB scripting
See also
Screen (Page 214)
Layers (RT Professional)
Description
Returns an object of type "Layers".
Syntax
Object.Layers
Object
Required A "Screen" object.
See also
Screen (Page 214)
Left (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the value of the X coordinate.
Syntax
Object.Left[=Int32]
Object
● AlarmControl *
● AlarmView **
● ApplicationWindow *
● Bar
● BatteryView ***
● Button
● CheckBox *

VB scripting
● Circle
● CircleSegment *
● CircularArc *
● Clock
● ComboBox *
● Connector *
● DiscSpaceView *
● Ellipse
● EllipticalArc *
● Gauge
● GraphicIOField
● GraphicView
● HTMLBrowser
● IOField
● Line
● ListBox *
● MediaPlayer
● MultiLineEdit *
● OnlineTableControl *
● OnlineTrendControl *
● OptionGroup *
● Polygon
● Polyline
● ProDiagOverview ***
● ProtectedAreaNameView ***
● RangeLabelView ***
● RangeQualityView ***
● RecipeView**
● Rectangle
● RoundButton *****
● S7GraphOverview **

VB scripting
● ScreenWindow *
● Slider
● StatusForce **
● Switch **
● SymbolLibrary
● SymbolicIOField ******
● SysDiagControl *******
● TextField
● TrendView **
● TubeArcObject *
● TubeTeeObject *
● Tubepolyline *
● UserArchiveControl *
● UserView
● WLanQualityView ***
● WindowSlider *
● ZoneLabelView ***
● ZoneQualityView ***
*** Only Panel RT read and write access
**** RT Advanced read access, RT Professional read and write access
***** RT Advanced No access, RT Professional read access
****** RT Advanced read and write access, RT Professional read access
Int32
Optional. A value or a constant that contains the value of the X coordinate in pixels (measured
from the top left edge of the screen).
Comments
The X coordinate refers to the top left corner of the rectangle that surrounds the object. The
screen limits are also monitored in runtime. If the assigned coordinate value exceeds the
display size, the user-defined function is interrupted with an error message.

VB scripting
See also
Bar (Page 257)
BorderWidth (Page 579)
CameraControl (Page 271)
Button (Page 265)
CheckBox (Page 274)
Circle (Page 278)
Clock (Page 286)
ComboBox (Page 289)
Ellipse (Page 299)
Gauge (Page 319)
IOField (Page 331)
Line (Page 336)
Listbox (Page 339)

VB scripting

Polygon (Page 378)
Polyline (Page 381)
Slider (Page 409)
Switch (Page 419)
UserView (Page 480)

VB scripting
LeftMargin (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
LeftOffset (RT Professional)
Description
Specifies the horizontal shift of zero point of the display of a screen that is larger than the
screen window. The shift refers to the left edge of the screen window.
The screen is displayed cut. The picture scroll bars are located at the left and upper edge of
the picture.
If you wish to display the screen in the screen window with horizontal and vertical offset of the
screen scroll bars, use the "HorizontalScrollBarPosition (Page 740)" and
"VerticalScrollbarPosition (Page 1205) properties for the offset.
Syntax
Object.LeftOffset[=Int32]
Object
● Screenwindow
Int32
Optional. A value or a constant that specifies the horizontal shift of the screen display's zero
point from the left margin of the screen window.
See also
Limit4LowerLimit (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the lower limit for ""Reserve4".
The "Limit4LowerLimitEnabled" property must be set to TRUE so that the limit "Reserve4""
can be monitored.

VB scripting
Syntax
Object.Limit4LowerLimit[=DOUBLE]
Object
● Bar
DOUBLE
Optional A value or a constant that specifies the low limit for "Reserve4".
Comments
The "Limit4LowerLimitRelative" property specifies whether the object is evaluated as a
percentage or absolutely.
See also
Bar (Page 257)
Limit4LowerLimitColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the color for the low limit "Reserve4".
The "Limit4LowerLimitEnabled" property must have the value TRUE if the bar color is to
change once the limit has been reached.
Syntax
Object.Limit4LowerLimitColor[=Color]
Object
Required. An object of the type ""ScreenItem" with the following format:
● Bar
Color
Optional. A value or a constant that specifies the color for the lower limit ""Reserve4".
Comments

VB scripting
RGB (255, 0, 0)
See also
Bar (Page 257)
Limit4LowerLimitEnabled (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies whether the lower limit ""Reserve4"" is to be monitored.
Syntax
Object.Limit4LowerLimitEnabled[=BOOLEAN]
Object
● Bar
BOOLEAN
Optional TRUE, if the lower limit ""Reserve4" is to be monitored.
Comments
The following values will be specified with the properties ""Limit4LowerLimit",
"Limit4LowerLimitColor" and "Limit4LowerLimitRelative"":
● Limit
See also
Bar (Page 257)
Limit4LowerLimitRelative (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies whether the low limit "Reserve4" is evaluated as a percentage or as an absolute
value.

VB scripting
Syntax
Object.Limit4LowerLimitRelative[=BOOLEAN]
Object
● Bar
BOOLEAN
Optional.
TRUE if the low limit "Reserve4" is to be evaluated as a percentage.
FALSE if the low limit "Reserve4" is to be evaluated as an absolute value.
See also
Bar (Page 257)
Limit4UpperLimit (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the lower limit for "Reserve4".
The "Limit4UpperLimitEnabled"" property must be set to TRUE so that the limit ""Reserve4"
can be monitored.
Syntax
Object.Limit4UpperLimit[=DOUBLE]
Object
● Bar
DOUBLE
Optional A value or a constant that specifies the upper limit for "Reserve4".
Comments
The "Limit4UpperLimitRelative" property specifies whether the object is evaluated as a

VB scripting
See also
Bar (Page 257)
Limit4UpperLimitColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the color for the upper limit ""Reserve4".
The "Limit4UpperLimitEnabled"" property must have the value TRUE if the bar color is to
Syntax
Object.Limit4UpperLimitColor[=Color]
Object
● Bar
Color
Optional. A value or a constant that specifies the color for the upper limit "Reserve4".
Comments
RGB (255, 0, 0)
See also
Bar (Page 257)
Limit4UpperLimitEnabled (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies whether the upper limit "Reserve4" is to be monitored.

VB scripting
Syntax
Object.Limit4UpperLimitEnabled[=BOOLEAN]
Object
● Bar
BOOLEAN
Optional TRUE, if the upper limit ""Reserve4" is to be monitored.
Comments
The following values are defined via the properties ""Limit4UpperLimit",
"Limit4UpperLimitColor" and "Limit4UpperLimitRelative":
● Limit
See also
Bar (Page 257)
Limit4UpperLimitRelative (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies whether the high limit "Reserve4" is to be evaluated as a percentage or as an
absolute value.
Syntax
Object.Limit4UpperLimitRelative[=BOOLEAN]
Object
● Bar
BOOLEAN
Optional.
TRUE if the low limit "Reserve4" is to be evaluated as a percentage.
FALSE if the low limit "Reserve4" is to be evaluated as an absolute value.

VB scripting
See also
Bar (Page 257)
Limit5LowerLimit (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the lower limit for "Reserve5"".
The "Limit5LowerLimitEnabled" property must be set to TRUE so that the limit ""Reserve5"
can be monitored.
Syntax
Object.Limit5LowerLimit[=DOUBLE]
Object
● Bar
DOUBLE
Optional A value or a constant that specifies the lower limit for "Reserve5"".
Comments
The "Limit5LowerLimitRelative" property specifies whether the object is evaluated as a
See also
Bar (Page 257)
Limit5LowerLimitColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the color for the lower limit ""Reserve5"".
The "Limit5LowerLimitEnabled" property must have the value TRUE if the bar color is to
Syntax
Object.Limit5LowerLimitColor[=Color]

VB scripting
Object
● Bar
Color
Optional. A value or a constant that specifies the color for the lower limit ""Reserve5".
Comments
RGB (255, 0, 0)
See also
Bar (Page 257)
Limit5LowerLimitEnabled (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies whether the lower limit "Reserve5" is to be monitored.
Syntax
Object.Limit5LowerLimitEnabled[=BOOLEAN]
Object
● Bar
BOOLEAN
Optional TRUE, if the lower limit ""Reserve5" is to be monitored.

VB scripting
Comments
The following values will be defined via the properties "Limit5LowerLimit",
"Limit5LowerLimitColor" and "Limit5LowerLimitRelative":
● Limit
See also
Bar (Page 257)
Limit5LowerLimitRelative (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies whether the lower limit ""Reserve5" is to be evaluated as a percentage or as an
absolute value.
Syntax
Object.Limit5LowerLimitRelative[=BOOLEAN]
Object
Required. An object of the "ScreenItem" type with the following format:
● Bar
BOOLEAN
Optional.
TRUE if the low limit ""Reserve5" is to be evaluated as a percentage.
FALSE if the low limit ""Reserve5" is to be evaluated as an absolute value.
See also
Bar (Page 257)
Limit5UpperLimit (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the lower limit for "Reserve5".
The ""Limit5UpperLimitEnabled" property must be set to TRUE so that the limit ""Reserve5"
can be monitored.

VB scripting
Syntax
Object.Limit5UpperLimit[=DOUBLE]
Object
● Bar
DOUBLE
Optional A value or a constant that specifies the upper limit for ""Reserve5".
Comments
The "TypeLimitHigh5" property specifies whether the object is evaluated as a percentage or
absolutely.
See also
Bar (Page 257)
Limit5UpperLimitColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the color for the upper limit "Reserve5"".
The "Limit5UpperLimitEnabled" property must have the value TRUE if the bar color is to
Syntax
Object.Limit5UpperLimitColor[=Color]
Object
● Bar
Color
Optional. A value or a constant that specifies the color for the upper limit ""Reserve5".

VB scripting
Comments
RGB (255, 0, 0)
See also
Bar (Page 257)
Limit5UpperLimitEnabled (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies whether the upper limit "Reserve5" is to be monitored.
Syntax
Object.Limit5UpperLimitEnabled[=BOOLEAN]
Object
● Bar
BOOLEAN
Optional TRUE, if the upper limit ""Reserve5"" is to be monitored.
See also
Bar (Page 257)
Limit5UpperLimitRelative (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies whether the high limit "Reserve5" is to be evaluated as a percentage or as an
absolute value.
Syntax
Object.Limit5UpperLimitRelative[=BOOLEAN]

VB scripting
Object
● Bar
BOOLEAN
Optional.
TRUE if the high limit "Reserve5" is to be evaluated as a percentage.
FALSE if the high limit "Reserve5" is to be evaluated as an absolute value.
See also
Bar (Page 257)
LimitRangeCollection (RT Professional)
Description
LineAlarmView (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
LineBackgroundColor (RT Professional)
Description
LineColor (RT Professional)
Description
Specifies the color of the window separation lines.
Syntax
Object.LineColor[=Color]

VB scripting
Object
● AlarmControl
Color
Optional. A value or a constant that specifies the color of the window separation lines.
Comments
RGB (255, 0, 0)
See also
LineEndShapeStyle (RT Professional)
Description
Specifies the shape of the line ends.
Access in runtime:
Syntax
Object.LineEndShapeStyle[=LineEndShapeStyle]

VB scripting
Object
● Bar
● Button
● CheckBox
● Circle
● CircleSegment
● CircularArc
● ComboBox
● Connector
● Ellipse
● EllipseSegment
● EllipticalArc
● GraphicIOField
● GraphicView
● IOField
● Line
● ListBox
● MultiLineEdit
● OptionGroup
● Polygon
● Polyline
● Rectangle
● RoundButton *
● TextField
● WindowSlider
* Read access only
● Switch
● TubeArcObject

VB scripting
LineEndShapeStyle
Optional. A value or a constant that specifies the form of the line ends.
Value Description
0 Rounded
1 Flush
2 Rectangular
See also
Bar (Page 257)
Button (Page 265)
CheckBox (Page 274)
Circle (Page 278)
ComboBox (Page 289)
Ellipse (Page 299)
IOField (Page 331)
Line (Page 336)
Listbox (Page 339)
Polygon (Page 378)
Polyline (Page 381)
Switch (Page 419)

VB scripting
LinesPerDiagEntry (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
LineStyle (RT Professional)
Description
LineWidth (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the line thickness.
Access in runtime:
Syntax
Object.LineWidth[=Int32]
Object
● AlarmControl
● CircularArc
● Connector
● EllipticalArc
● Line *
● Polyline *
● TubeArcObject
● TubeTeeObject

VB scripting
● Tubepolyline
● Polygon
Int32
Optional. A value or a constant that specifies the line weight in pixels.
See also
Line (Page 336)
Polyline (Page 381)
Polygon (Page 378)
LineWrap (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ListAreaHeight (Panels, Comfort Panels, RT Advanced, RT Professional)
Description

VB scripting
ListAreaLeft (RT Advanced)
Description
ListAreaTop (RT Advanced)
Description
ListAreaWidth (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
LoadDataImmediately (RT Professional)
Description
Specifies whether in the event of a screen refresh the tag values should be downloaded from
the archives for the time range that is to be shown.
Syntax
Object.LoadDataImmediately[=BOOLEAN]
Object
BOOLEAN
Optional TRUE, if in the event of a screen the tag values should be downloaded from the
archives for the time range that is to be shown.

VB scripting
See also
LocalCursor (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Location (RT Professional)
Description
LockSquaredExtent (RT Professional)
Description
Specifies whether the size of the clock can be adjusted with the mouse.
Syntax
Object.LockSquaredExtent[=BOOLEAN]
Object
● Clock
● Gauge
BOOLEAN
Optional TRUE, if the size of the clock can be adjusted by dragging the mouse on the selection
points to the desired aspect ratio.
See also
Clock (Page 286)
Gauge (Page 319)

VB scripting
Logging (RT Professional)
Description
Returns an object of type "Logging".
Syntax
Object.Logging
Object
See also
LogOperation (RT Professional)
Description
Specifies whether, after operating this object, an alarm is output on the alarm system.
Syntax
Object.LogOperation[=BOOLEAN]
Object
● CheckBox
● ComboBox
● IOField
● ListBox
● OptionGroup
● WindowSlider
*: Read access only
BOOLEAN
Optional TRUE, if, after operating this object, an alarm is output on the alarm system.

VB scripting
LongDateTimeFormat (RT Advanced)
Description
LongTermArchiveConsistency (RT Professional)
Description
Specifies how alarms are displayed in the alarm view when the "Historical alarm list (long-
term)" is configured.
Syntax
Object.LongTermArchiveConsistency[= BOOLEAN]
Object
● AlarmControl
BOOLEAN
Optional.
TRUE if the 1000 most recent alarms are displayed on the client of all servers or the redundant
server pair in the "Historical alarm list" (long-term) display.
FALSE if 1000 alarms are displayed in the "Historical alarm list" (long-term) display on the
single-user system, server or client for each server, or for each redundant server pair.
See also
Look3D (RT Advanced)
Description
LowerLimit (RT Professional)
Description
Specifies the lower limit for input values.

VB scripting
Syntax
Object.LowerLimit[=DOUBLE]
Object
● IOField
DOUBLE
Optional A value or a constant that specifies the lower limit for input values.
See also
IOField (Page 331)
LowLimitColor (RT Professional)
Description
Specifies the color of the bottom or left scroll button in a scroll bar.
Syntax
Object.LowLimitColor[=Color]
Object
● WindowSlider
Color
Optional. A value or a constant that specifies the color of the bottom or left scroll button in a
scroll bar.
Comments
RGB (255, 0, 0)

VB scripting
See also
1.5.5.9 Properties M-N (Panels, Comfort Panels, RT Advanced, RT Professional)
Machine (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
MachineName (RT Advanced)
Description
Specifies the network code of the device that is to be monitored.
Enter the name or the port of the device as the network code.
Syntax
Object.MachineName[=STRING]
Object
● SmartClientView
STRING
Optional A value or a constant that contains the network code.
See also
MaintainAspectRatio (RT Professional)
Description

VB scripting
MaintainOriginalSize (RT Professional)
Description
MarginToBorder (RT Professional)
Description
Specifies the width of the 3D border in pixels. The value of the width is dependent on the size
of the object.
Syntax
Object.MarginToBorder[=Int32]
Object
● WindowSlider
Int32
Optional A value or a constant that specifies the width of the 3D border in pixels.
See also
MaximumNumberOfTimeAxes (RT Professional)
Description
MaximumNumberOfTimeColumns (RT Professional)
Description

VB scripting
MaximumNumberOfValueAxes (RT Professional)
Description
MaximumNumberOfValueColumns (RT Professional)
Description
MaximumValue (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the maximum value of the scale in the selected object.
Syntax
Object.MaximumValue[=DOUBLE | Int32 | SINGLE]
Object
● Bar
● Gauge
● Slider
● WindowSlider*
*: Read access only
DOUBLE | Int32 | SINGLE

Optional A value or a constant that specifies the maximum value. The data type depends on
the format.
● DOUBLE: Bar
● Int32: Slider, WindowsSlider
● SINGLE: Gauge

VB scripting
MaxNrOfCurves (RT Advanced)
Description
MaxNumberOfComboBoxCharacters (RT Advanced)
Description
MaxToolbarRows (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
MenuButtonVisible (RT Advanced)
Description
MenuToolBarConfig (RT Professional)
Description
Determines the configuration file with user-defined menu and toolbars.
Syntax
Object.MenuToolBarConfig[=HmiObjectHandle]
Object
● ScreenWindow
HmiObjectHandle
Optional. A value or a constant that specifies the configuration file with user-defined menu and
toolbars.

VB scripting
MessageAreaHeight (RT Advanced)
Description
MessageAreaLeft (RT Advanced)
Description
MessageAreaTop (RT Advanced)
Description
MessageAreaWidth (RT Advanced)
Description
MessageBlockAlignment (RT Professional)
Description
Specifies the designation of an alarm text block referenced with "MessageBlockIndex" in the
column header.
Also set "ApplyProjectSettings" to "FALSE".
Syntax
Object.MessageBlockAlignment [=HorizontalAlignment]
Object
● AlarmControl

VB scripting
HorizontalAlignment
Optional. A value or constant that determines the alignment.

0 Left The designation of the block in the column header is left-jus‐
tified.
1 Centered The designation of the block in the column header is centered.
2 Right The designation of the block in the column header is right-
justified.
See also
ApplyProjectSettings (Page 514)
MessageBlockAutoPrecisions (RT Professional)
Description
Specifies whether the number of decimal places for an alarm text block referenced with
"MessageBlockIndex" is automatically determined.
Syntax
Object.MessageBlockAutoPrecisions[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
Optional.
FALSE if the value of "MessageBlockPrecisions" is used.
See also
MessageBlockIndex (Page 811)

VB scripting
MessageBlockCaption (RT Professional)
Description
Specifies the designation in the column header for an alarm text block referenced with
"MessageBlockIndex". The designation entered is effective in all runtime languages.
Syntax
Object.MessageBlockCaption[=STRING]
Object
● AlarmControl
STRING
Optional. Specifies the designation in the column header for the selected alarm text block.
See also
MessageBlockCount (RT Professional)
Description
Specifies the number of configured alarm text blocks.
Syntax
Object.MessageBlockCount[=Int32]
Object
● AlarmControl
Int32
Optional. A value or a constant that specifies the number of configured alarm text blocks.

VB scripting
See also
MessageBlockDateFormat (RT Professional)
Description
Specifies the date format for displaying the alarms.
Syntax
Object.MessageBlockDateFormat[=STRING]
Object
● AlarmControl
STRING
Optional. A value or a constant that specifies the date format used for displaying alarms.
Value Explanation
Automatic The date format is set automatically.
dd.MM.yy Day.Month.Year, e.g. 24.12.10.
dd.MM.yyyy Day.Month.Year, e.g. 24.12.2010.
dd/MM/yy Day/Month/Year, e.g. 24/12/10.
dd/MM/yyyy Day/Month/Year, e.g. 24/12/2010.
See also
MessageBlockExponentialFormat (RT Professional)
Description
Specifies whether the values of an alarm text block referenced with "MessageBlockIndex" are
displayed in exponential notation.

VB scripting
Syntax
Object.MessageBlockExponentialFormat[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
Optional.
FALSE if the values are displayed in decimal notation.
See also
MessageBlockFlashOn (RT Professional)
Description
Specifies whether the content of an alarm text block referenced with "MessageBlockIndex"
flashes in runtime when an alarm appears.
Syntax
Object.MessageBlockFlashOn[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
Optional.
TRUE if the content of the alarm text block flashes.
FALSE if the content of the alarm text block does not flash.

VB scripting
See also
MessageBlockHideText (RT Professional)
Description
Specifies whether the content of an alarm text block referenced with "MessageBlockIndex" is
displayed as text.
Syntax
Object.MessageBlockHideText[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
Optional.
TRUE if the content is not displayed as text.
FALSE if the content is displayed as text.
See also
MessageBlockHideTitleText (RT Professional)
Description
Specifies whether the header of an alarm text block referenced with "MessageBlockIndex" is
displayed as text.

VB scripting
Syntax
Object.MessageBlockHideTitleText[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
Optional.
TRUE if the header is not displayed as text.
FALSE if the header is displayed as text.
See also
MessageBlockId (RT Professional)
Description
Specifies the assignment of ID number and alarm text block in the alarm view.
Syntax
Object.MessageBlockId[=Int32]
Object
● AlarmControl
Int32
Optional Specifies the assignment of ID number and alarm text block in the alarm view.
See also

VB scripting
MessageBlockIndex (RT Professional)
Description
References an alarm text block. To access the properties of an alarm text block, you need to
set "MessageBlockIndex".
Values between 0 and "MessageBlockIndex" minus 1 are valid for "MessageBlockCount". The
"MessageBlockCount" property specifies the number of configured alarm text blocks.
Syntax
Object.MessageBlockIndex[=Int32]
Object
● AlarmControl
Int32
Optional. A value or a constant that specifies, with the index, the alarm text block to be edited.
See also
MessageBlockCount (Page 805)
MessageBlockLeadingZeros (RT Professional)
Description
Specifies whether the entries in an alarm text block referenced with "MessageBlockIndex" are
displayed with leading zeros.
Syntax
Object.MessageBlockLeadingZeros[=Int32]
Object
● AlarmControl

VB scripting
Int32
Optional.
1 if the entries in the alarm text block are displayed with leading zeros.
0 if the entries in the alarm text block are displayed without leading zeros.
See also
MessageBlockLength (RT Professional)
Description
Specifies the length in characters of the content of an alarm text block referenced with
"MessageBlockIndex".
Syntax
Object.MessageBlockLength[=Int32]
Object
● AlarmControl
Int32
Optional. Value which specifies the length of the alarm text block.
See also
MessageBlockName (RT Professional)
Description
Specifies the name of an alarm text block referenced with "MessageBlockIndex".

VB scripting
Syntax
Object.MessageBlockName[=STRING]
Object
● AlarmControl
STRING
Optional. A value or a constant that specifies the name of the referenced alarm text block.
MessageBlockPrecisions (RT Professional)
Description
Specifies the number of decimal places for values in an alarm text block referenced with
"MessageBlockIndex".
Syntax
Object.MessageBlockPrecisions[=Int16]
Object
● AlarmControl
Int16
Optional. Specifies the number of decimal places.
See also
MessageBlockSelected (RT Professional)
Description
Specifies whether an alarm text block referenced with "MessageBlockIndex" is selected.
Also set "ApplyProjectSettings (Page 514)" to "FALSE".

VB scripting
Syntax
Object.MessageBlockSelected[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
Optional. TRUE if the alarm text block is selected.
See also
MessageBlockShowDate (RT Professional)
Description
Specifies whether to display both the date and time in the "Time" alarm text block.
Syntax
Object.MessageBlockShowDate[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
Optional.
TRUE if both date and time are displayed.
FALSE if the time is displayed.
See also

VB scripting
MessageBlockShowIcon (RT Professional)
Description
Specifies whether the content of an alarm text block referenced with "MessageBlockIndex" is
displayed as an icon.
Syntax
Object.MessageBlockShowIcon[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
Optional.
TRUE if the content is displayed as an icon.
FALSE if the content is not displayed as an icon.
See also
MessageBlockShowTitleIcon (RT Professional)
Description
Specifies whether the header of an alarm text block referenced with "MessageBlockIndex" is
displayed as text.
Syntax
Object.MessageBlockShowTitleIcon[=BOOLEAN]
Object
● AlarmControl

VB scripting
BOOLEAN
Optional.
TRUE if the header is shown as an icon.
FALSE if the header is not shown as an icon.
See also
MessageBlockTextId (RT Professional)
Description
Specifies the designation of an alarm text block referenced with "MessageBlockIndex" using
a text ID from the text library. The designation is adapted automatically if the runtime language
is changed.
Syntax
Object.MessageBlockTextId[=Int32]
Object
● AlarmControl
Int32
Optional. Specifies the name of the selected alarm text block using a text ID number.
MessageBlockTimeFormat (RT Professional)
Description
Specifies which time format or duration format is used for displaying alarms.
Syntax
Object.MessageBlockTimeFormat[=STRING]

VB scripting
Object
● AlarmControl
STRING
Optional. A value or a constant that specifies the time format or duration format used for
displaying alarms.
The following time formats are available:
Value Explanation
HH:mm:ss Hours:Minutes:Seconds, e.g. 15:35:44
HH:mm:ss.ms Hours:Minutes:Seconds.Milliseconds, e.g. 15:35:44.240.
The following duration formats are available:
Value Explanation
Automatic The duration format is determined automatically.
d H:mm:ss Day Hours:Minutes:Seconds, e.g. 1 2:03:55.
H:mm:ss. Hours:Minutes:Seconds, e.g. 26:03:55.
m:ss Minutes:Seconds, Example: 1563:55.
s Seconds, e.g. 93835.
See also
MessageBlockType (RT Professional)
Description
Returns the type of an alarm text block referenced with "MessageBlockIndex".
Syntax
Object.MessageBlockType[=AlarmBlockType]
Object
● AlarmControl

VB scripting
AlarmBlockType
Optional. A value or a constant that returns the type of alarm text block.
Value Explanation
0 The alarm text block is a system block.
1 The alarm text block is a user text block.
2 The alarm text block is a parameter block.
3 The alarm text block belongs to the alarm text blocks of the alarm statistics.
See also
MessageColumnAdd (RT Professional)
Description
Creates a new alarm text block. The newly created alarm text block is automatically referenced
with "MessageColumnIndex".
Syntax
Object.MessageColumnAdd[=STRING]
Object
● AlarmControl
STRING
Required. A value or a constant that specifies the name of the new alarm text block with
"MessageColumnName".
See also
MessageColumnIndex (Page 819)
MessageColumnCount (RT Professional)
Description
Specifies the number of configured alarm text blocks.

VB scripting
Syntax
Object.MessageColumnCount[=Int32]
Object
● AlarmControl
Int32
Optional. A value or a constant that specifies the number of configured alarm text blocks.
See also
MessageColumnIndex (RT Professional)
Description
References an alarm text block selected for the alarm list. To access the properties of an alarm
text block, you need to set "MessageColumnIndex".
Values between 0 and "MessageColumnIndex" minus 1 are valid for "MessageColumnCount".
The "MessageColumnCount" property specifies the number of configured alarm text blocks.
Syntax
Object.MessageColumnIndex[=Int32]
Object
● AlarmControl
Int32
Optional. A value or a constant that specifies, with the index, the alarm text block selected for
the alarm list.
See also
MessageColumnCount (Page 817)

VB scripting
MessageColumnName (RT Professional)
Description
Specifies the name of an alarm text block referenced with "MessageColumnIndex".
Syntax
Object.MessageColumnName[=STRING]
Object
● AlarmControl
STRING
Optional. A value or a constant that specifies the name of the referenced alarm text block.
See also
MessageColumnRemove (RT Professional)
Description
Removes an alarm text block referenced with its name.
Syntax
Object.MessageColumnRemove[=STRING]
Object
● AlarmControl
STRING
Optional. A value or a constant that specifies the name of the referenced alarm text block to
be removed.

VB scripting
See also
MessageColumnRepos (RT Professional)
Description
For multiple alarm text blocks, specifies the position of an alarm text block referenced with
"MessageColumnIndex".
If you have changed the position of the alarm text block with "MessageColumnRepos",
"MessageColumnIndex" is assigned the value of "MessageColumnRepos".
Syntax
Object.MessageColumnRepos[=Int32]
Object
● AlarmControl
Int32
Optional. A value or a constant that specifies the position of the referenced alarm text block.
Value range from 0 to "MessageColumnCount" minus 1. Values outside this range have no
effect.
0: The referenced alarm text block is positioned on the left.
See also
MessageColumnCount (Page 817)
MessageColumnSort (RT Professional)
Description
Specifies how the content of an alarm text block referenced with "MessageColumnIndex" is
sorted.

VB scripting
Syntax
Object.MessageColumnSort[=SortMode]
Object
● AlarmControl
SortMode
Optional. A value or a constant that specifies sorting for the referenced alarm text block.
Value Explanation
0 No sorting
See also
MessageColumnSortIndex (RT Professional)
Description
Defines the sorting order of the alarm text block referenced in "MessageColumnIndex". If you
set the value to "0", the sorting criterion is removed in "MessageColumnSort".
Syntax
Object.MessageColumnSortIndex[=Int32]
Object
● AlarmControl
Int32
Optional Defines the sorting order of the alarm text block referenced in
"MessageColumnIndex".
See also

VB scripting
MessageColumnVisible (RT Professional)
Description
Specifies whether the alarm text block referenced with "MessageColumnIndex" is displayed.
Syntax
Object.MessageColumnVisible[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
Optional.
TRUE if the referenced alarm text block is displayed.
FALSE if the referenced alarm text block is not displayed.
See also
MessageListType (RT Professional)
Description
Specifies the content to be displayed.
Syntax
Object.MessageListType[=AlarmListType]
Object
● AlarmControl

VB scripting
AlarmListType
Optional. A value or a constant that specifies the content.
Value Explanation
0 The alarms currently active are displayed upon screen refresh.
1 The "Historical alarm list" (short-term) display is activated upon screen refresh. The alarm
view shows logged alarms and alarms currently pending.
The display is updated immediately on activation of new messages.
2 The "Historical alarm list" (long-term) display is activated after a screen change. The alarm
view only displays logged alarms, which the user can comment.
3 Only the currently locked alarms are displayed after a screen change.
4 The configured statistical calculations for logged alarms are displayed after a screen
change.
5 Only previously hidden alarms are displayed after a screen change.
See also
MiddleGradientColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
MinimumNumberOfTimeAxes (RT Professional)
Description
MinimumNumberOfTimeColumns (RT Professional)
Description
MinimumNumberOfValueAxes (RT Professional)
Description

VB scripting
MinimumNumberOfValueColumns (RT Professional)
Description
MinimumValue (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the minimum value of the scale in the selected object.
Syntax
Object.MinimumValue[=DOUBLE | Int32 | SINGLE]
Object
● Bar
● Gauge
● Slider
● WindowSlider*
*: Read access only

Optional A value or a constant that specifies the minimum value. The data type depends on
the format.
● DOUBLE: Bar
● Int32: Slider, WindowsSlider
● SINGLE: Gauge
MinNrOfCurves (RT Advanced)
Description

VB scripting
MinPasswordValue (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
MinuteNeedleHeight (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the length of the minute hand.
Syntax
Object.MinuteNeedleHeight[=Int32]
Object
● Clock
Int32
Optional. A value or a constant that specifies the length of the minute hand.
Specify the length of the minute hand as a percentage relating to the radius of the clock face.
See also
Clock (Page 286)
MinuteNeedleWidth (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the width of the minute hand.
Syntax
Object.MinuteNeedleWidth[=Int32]
Object
● Clock

VB scripting
Int32
Optional. A value or a constant that specifies the width of the minute hand.
Specify the width as a percentage relating to double the length of the minute hand.
See also
Clock (Page 286)
Mode (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the mode for the behavior of a text object in runtime.
Access in runtime
Syntax
Object.Mode[=Type]
Object
● Button
● IOField
● RoundButton*
*: Read access only

● DateTimeField
● GraphicIOField
● Switch

VB scripting
Type
Optional. A value or a constant that specifies the mode for the behavior of a text object in
runtime.

0 hmiIOFieldOutput Output field
1 hmiIOFieldInput Input field
2 hmiIOFieldInOutput Input and output field
MonitorNumber (RT Professional)
Description
Returns the number of the monitor whose contents are shown in the screen window.
The monitor number refers to the number of monitors set in Microsoft Windows: "Control Panel
> Display > Settings > Display"
Syntax
Object.MonitorNumber[=Int32]
Object
● Screenwindow
Int32
Optional. A value or a constant that specifies the number of the displayed monitor.
See also
Moveable (RT Professional)
Description
Specifies whether the object can be moved in runtime.
Syntax
Object.Moveable[=BOOLEAN]

VB scripting
Object
● AlarmControl
BOOLEAN
Optional.
TRUE if the window can be moved in runtime.
FALSE if the window is fixed in runtime.
See also
MsgFilterSQL (RT Professional)
Description
Specifies one or several SQL statements for user-defined selection of the alarms. Several
customized selections are connected with "OR". If you have configured a fixed selection
"DefaultMsgFilterSQL", the SQL statements of "DefaultMsgFilterSQL" and "MsgFilterSQL" are
connected with "AND".
Syntax
Object.MsgFilterSQL[=STRING]
Object
● AlarmControl

VB scripting
STRING
Optional. A value or constant that specifies the SQL statements for user-defined selection of
messages.
See also
Name (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Returns the object name as STRING. The returned value is dependent upon the used object.
Syntax
Object.Name[=STRING]
Object
● Clock
● DiscSpaceView *
● Gauge
● Slider
* Read access only
● AlarmControl
● AlarmView
● BatteryView
● Bar
● Button
● ChannelDiagnose
● CheckBox
● Circle
● CircleSegment
● CircularArc
● ComboBox

VB scripting
● Connector
● DateTimeField
● Ellipse
● EllipseSegment
● EllipticalArc
● GraphicIOField
● GraphicView
● HTMLBrowser
● IOField
● Line
● ListBox
● MediaPlayer
● MultiLineEdit
● OptionGroup
● PLCCodeViewer
● ProDiagOverview
● Polygon
● Polyline
● RangeLabelView
● RecipeView
● Rectangle
● RoundButton
● S7GraphOverview
● ScreenWindow
● SmartClientView
● StatusForce
● Switch
● SymbolLibrary
● SymbolicIOField
● SysDiagControl

VB scripting
● TextField
● TrendView
● TubeArcObject
● TubeTeeObject
● Tubepolyline
● UserView
● WLanQualityView
● WindowSlider
● ZoneLabelView
● ZoneQualityView
String
Optional. A value or a constant that returns the object name.
Comments
Dependent on the specified object, the following object names will be returned:
● Tag: Name of the tag without server or tag prefix.
● Project: Name of the current runtime project.
● DataItem: Name of the DataItem object.
● Layer: Name of the layer.
● FunctionTrendControl: Name of the trend referenced by the "Index" property.
Note
Use the "Name" property to address a tag in the Tags" list. Tag names are structured in
WinCC according to the following scheme:
<Tag prefix><Name of tag>
If you only specify the tag name, the tag prefix is applied from the screen window shortcut.

VB scripting
Example
The following example returns the name of the current Runtime project as Trace:
Table 1-129
'VBS160
HMIRuntime.Trace "Name: " & HMIRuntime.ActiveProject.Name & vbNewLine
NameColumnWidth (RT Advanced)
Description
NavigateTo (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the module to be jumped to.
Syntax
Object.NavigateTo[=String]
Object
● PLCCodeViewer
● SysDiagControl *
* RT Advanced No access, RT Professional read access only
String
Optional. A value or a constant that specifies the module.
NavigationButtons (Panels, Comfort Panels, RT Advanced, RT Professional)
Description

VB scripting
NavigationPath_Font (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
NavigationPath_RootText (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
NavigationPath_TextColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
NavigationpathDiagbufferDetailText (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
NavigationpathDiagbufferText (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
NeedleBorderColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the line color of the pointer.
Syntax
Object.NeedleBorderColor[=Color]

VB scripting
Object
● Clock
Color
Optional. A value or a constant that specifies the line color of the pointer.
Comments
RGB (255, 0, 0)
See also
Clock (Page 286)
NeedleColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the pointer color.
Also specify with ""NeedleFillStyle" that the pointer color is to be displayed.
Syntax
Object.NeedleColor[=Color]
Object
● Clock
Color
Optional. A value or a constant that specifies the pointer color.
Comments
RGB (255, 0, 0)

VB scripting
See also
Clock (Page 286)
NeedleFillStyle (RT Professional)
Description
Specifies whether the pointers are displayed as filled or transparent.
Syntax
Object.NeedleFillStyle[=THmiFillStyle]
Object
● Clock
THmiFillStyle
Optional. A value or a constant that specifies whether the pointers are filled or transparent.

0 hmiFillStyleSolid The pointers appear transparent and are indicated by a margin in
the foreground color.
65536 hmiFillStyleTransparent The pointers are filled in the pointer fill color and indicated by a
margin in the foreground color.
See also
Clock (Page 286)
NeedleHeight (Panels, Comfort Panels, RT Advanced, RT Professional)
Description

VB scripting
NoHitTest (RT Professional)
Description
NormalColor (RT Professional)
Description
Specifies the color of the utilized memory in the memory space view when the memory space
utilization is in the non-critical range.
Syntax
Object.NormalColor[=Color]
Object
● DiscSpaceView
Color
Optional. A value or a constant that specifies the color of the memory display in the normal
range.
Comments
You use the "RGB" function to define the color in RGB format (red, green, blue). To do this,
you specify the corresponding decimal value for each of the three RGB values (value range
from 0 to 255). The "Red" color is displayed as follows, for example:
RGB (255, 0, 0)
See also
NormalRangeColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the color of the normal range on the scale of the "Gauge" object.

VB scripting
The "NormalRangeVisible" property must have the value TRUE for the normal range to be
displayed.
Syntax
Object.NormalRangeColor[=Color]
Object
● Gauge
Color
Optional. A value or a constant that specifies the color of the normal range.
Comments
RGB (255, 0, 0)
See also
Gauge (Page 319)
NormalRangeVisible (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies whether the normal range in the scale of the "Gauge" object is displayed.
Syntax
Object.NormalRangeVisible[=BOOLEAN]
Object
● Gauge
BOOLEAN
Optional TRUE, if the normal range will be displayed in the scale.

VB scripting
Comments
Specify the color of the normal range with the "NormalRangeColor" property.
See also
Gauge (Page 319)
NumberOfButtons (RT Professional)
Description
NumberOfLines (RT Advanced)
Description
NumberOfVisibleLines (RT Professional)
Description
Specifies the number of visible lines in the PLC code display.
Syntax
Object.NumberOfVisibleLines[=Int32]
Object
● PLCCodeViewer
Int32
Optional. A value or a constant that specifies the number of lines in the PLC code display.
See also

VB scripting
NumberStyle (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
1.5.5.10 Properties O-P (Panels, Comfort Panels, RT Advanced, RT Professional)
Object (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ObjectSizeDeclutteringEnable (RT Professional)
Description
Specifies whether only the objects within a set size range are displayed.
Syntax
Object.ObjectSizeDeclutteringEnable
Object
Example
The example outputs the Decluttering properties of the screen "NewPDL1" as Trace.
'VBS157
Dim objScreen
HMIRuntime.Trace "Min: " & objScreen.ObjectSizeDeclutteringMin & vbNewLine
HMIRuntime.Trace "Max: " & objScreen.ObjectSizeDeclutteringMax & vbNewLine
See also
Screen (Page 214)

VB scripting
ObjectSizeDeclutteringMax (RT Professional)
Description
Returns the upper size range for the display suppression of objects of the specified screen as
LONG.
Syntax
Object.ObjectSizeDeclutteringMax
Object
Example
'VBS157
Dim objScreen
See also
Screen (Page 214)
ObjectSizeDeclutteringMin (RT Professional)
Description
Returns the lower size range for the display suppression of objects of the specified screen as
LONG.
Syntax
Object.ObjectSizeDeclutteringMin
Object

VB scripting
Example
'VBS157
Dim objScreen
See also
Screen (Page 214)
OcxGuid (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
OCXState (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
OcxStateForEs2Rt (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Online (RT Professional)
Description
Specifies start and stop of the updating.
Syntax
Object.Online[=BOOLEAN]

VB scripting
Object
BOOLEAN
Optional.
TRUE if the updated display is to be stopped. The values are buffered and updated when the
button is clicked again.
FALSE if the updated display is to be continued.
See also
OnValue (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
OperationSteps (RT Professional)
Description
Specifies by how many steps the slider of the scrollbar is moved with one mouseclick.
Syntax
Object.OperationSteps[=Int32]
Object
Required. An object of the type ""ScreenItem" with the format:
● WindowSlider
Int32
Optional. A value or a constant which specifies by how many steps the slider of the scrollbar
is moved with one mouse-click.

VB scripting
See also
OperatorAlarms (RT Professional)
Description
OperatorMessageId (RT Professional)
Description
Specifies the assignment of ID number and trigger event in the alarm view.
Syntax
Object.OperatorMessageId[=Int32]
Object
● AlarmControl
Int32
Optional. A value or constant that specifies the assignment of ID number and trigger event in
the alarm view.

0 Lock Trigger event "Lock"
1 Unlock "Unlock" Trigger Event
2 Hide Trigger event "Hide"
3 Unhide Trigger event "Unhide"
4 Ackn Trigger event "Acknowledge"
See also

VB scripting
OperatorMessageIndex (RT Professional)
Description
References an operator message event. You can assign the values of other properties to a
specific operator message by using the property.
Syntax
Object.OperatorMessageIndex[=Int32]
Object
● AlarmControl
Int32
Optional. A value or a constant that specifies the alarm event for an operator input alarm.
Value Explanation
0 Message event "Lock"
1 "Unlock" Message Event
2 Message event "Hide"
3 Message event "Unhide"
4 Message event "Acknowledge"
See also
OperatorMessageName (RT Professional)
Description
Specifies the name which is referenced with the "OperatorMessageIndex" event in message
events for operator messages.
Syntax
Object.OperatorMessageName[=STRING]
Object
● AlarmControl

VB scripting
STRING
Optional. A value or a constant that specifies the name that is referenced with the
"OperatorMessageIndex" event in alarm events for operator input alarms.
Value Explanation
Lock Message event "Lock"
Unlock Message event "Enable"
Hide Message event "Hide"
Unhide Message event "Unhide"
Quit Message event "Ackn."
See also
OperatorMessageNumber (RT Professional)
Description
Specifies a message number for the operator message of the selected message event if you
do not use the operator message of WinCC.
Syntax
Object.OperatorMessageNumber[=Int32]
Object
● AlarmControl
Int32
Optional. Specifies a message number for the operator message of the selected message
event.
See also
OperatorMessageSelected (RT Professional)
Description
Activates the message events in the list that trigger operator messages.

VB scripting
Syntax
Object.OperatorMessageSelected[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
Optional.
TRUE if the alarm events in the list that trigger operator input alarms are activated.
See also
OperatorMessageSource1 (RT Professional)
Description
Specifies a alarm text block of the operated message to be added to "Process value block 1"
of the operator message configured here.
Syntax
Object.OperatorMessageSource1[=STRING]
Object
● AlarmControl
STRING
Optional. Specifies a alarm text block of the operated message to be added to "Process value
block 1" of the operator message configured here.
Example
An operator message is to be generated to indicate that a message was locked. The content
of "User text block 1" of the locked message, e.g. "Motor faulty" should be displayed in "Process
value block 1" of the operator message. Select "1" at process value as the alarm text block
lock of the operated alarm "User text block 1".

VB scripting
See also
Description
Syntax
Object
● AlarmControl
STRING
Example
value block 1" of the operator message. Select "2" at process value as the alarm text block of
the operated alarm "User text block 1".
See also
Description
Syntax

VB scripting
Object
● AlarmControl
STRING
Example
See also
Description
Syntax
Object
● AlarmControl
STRING
Example

VB scripting
See also
Description
Syntax
Object
● AlarmControl
STRING
Example
See also
Description
Syntax

VB scripting
Object
● AlarmControl
STRING
Example
See also
Description
Syntax
Object
● AlarmControl
STRING
Example

VB scripting
See also
Description
Syntax
Object
● AlarmControl
STRING
Example
See also
Description
Syntax

VB scripting
Object
● AlarmControl
STRING
Example
See also
Description
Syntax
Object
● AlarmControl
STRING
Example
value block 1" of the operator message. Select "10" at process value as the alarm text block
of the operated alarm "User text block 1".

VB scripting
See also
OperatorMessageSourceType1 (RT Professional)
Description
Specifies whether the content of the alarm text block in the operator input alarm is to be
transferred as text or as a value.
Syntax
Object.OperatorMessageSourceType1[=TransferAs]
Object
● AlarmControl
TransferAs
Optional. A value or a constant that specifies how the alarm text block is displayed in the
operator input alarm.
The following settings are available:

0 Text The alarm text block is shown as text.
1 Value The alarm text block is shown as a value.
See also
Description
Syntax

VB scripting
Object
● AlarmControl
TransferAs

See also
Description
transferred as text or as value.
Syntax
Object
● AlarmControl
TransferAs


VB scripting
Description
Syntax
Object
● AlarmControl
TransferAs

See also
Description
Syntax
Object
● AlarmControl

VB scripting
TransferAs

See also
Description
Syntax
Object
● AlarmControl
TransferAs

See also

VB scripting
Description
Syntax
Object
● AlarmControl
TransferAs

See also
Description
Syntax
Object
● AlarmControl

VB scripting
TransferAs

See also
Description
Syntax
Object
● AlarmControl
TransferAs

See also

VB scripting
Description
Syntax
Object
● AlarmControl
TransferAs

See also
OutputAddressText (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
PaddingBottom (Panels, Comfort Panels, RT Advanced, RT Professional)
Description

VB scripting
PaddingLeft (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
PaddingRight (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
PaddingTop (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
PageMode (RT Professional)
Description
Enables paging is in the long-term archive list. Allows you to display all messages of the short-
term archive in the long-term archive list. Use the "PageModeMessageNumber" property to
determine the number of messages displayed per page. The page up/down buttons of the
toolbar can be used if paging is enabled.
Syntax
Object.PageMode[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
Optional.
TRUE if scrolling in the historical alarm list (long-term) is possible.
FALSE if scrolling in the historical alarm list (long-term) is not possible.
See also

VB scripting
PageModeMessageNumber (RT Professional)
Description
Defines the number of messages shown per page when paging the long-term archive list.
Syntax
Object.PageModeMessageNumber[=Int32]
Object
● AlarmControl
Int32
Optional A value or constant that specifies the number of messages per page.
See also
Password (RT Advanced)
Description
Determines the password for the loading of the remote monitor.
Syntax
Object.Password[=STRING]
Object
● SmartClientView
STRING
Optional A value or constant that contains the password for establishing remote monitoring.
See also

VB scripting
PasswordsMustBeEncrypted (RT Advanced)
Description
Path (RT Professional)
Description
Returns the path of the current project without the file names as STRING. For a WinCC client
without its own path, the path is returned in UNC format, otherwise the local path is returned.
Syntax
Object.Path
Object
Necessary. A "Project" object.
Example
The following example returns the project path as Trace:
'VBS161
HMIRuntime.Trace "Path: " & HMIRuntime.ActiveProject.Path & vbNewLine
See also
Project (Page 213)
PathHeaderBackColor (RT Professional)
Description
PathHeaderFont (RT Professional)
Description
Specifies the header font.

VB scripting
Syntax
Object.PathHeaderFont[=Font]
Object
● PLCCodeViewer
● S7GraphOverview
Font
Optional. A value or a constant that specifies the font of the header.
See also
PathHeaderTextColor (RT Professional)
Description
Specifies the font color in the header of the GRAPH overview.
Syntax
Object.PathHeaderTextColor[=Color]
Object
● S7GraphOverview
Color
Optional. A value or a constant that specifies the font color in the header of the S7-GRAPH
overview.
Comments
RGB (255, 0, 0)

VB scripting
See also
PercentageAxis (RT Professional)
Description
Specifies that an additional axis with percentage scaling is shown in the trend view.
Syntax
Object.PercentageAxis[=BOOLEAN]
Object
BOOLEAN
Optional.
TRUE, if an axis with percentage scaling is shown.
FALSE, if only value and time axes are shown.
See also
PercentageAxisAlignment (RT Professional)
Description
Specifies the alignment of the percentage axis.
Syntax
Object.PercentageAxisAlignment[=AxisAlignment]

VB scripting
Object
AxisAlignment
Optional. Value or constant that specifies the alignment of the percentage axis.

0 Left The axis with percentage scaling is left-aligned.
1 Right The axis with percentage scaling is right-aligned
See also
PercentageAxisColor (RT Professional)
Description
Specifies the font color and line color of the percentage axis.
Syntax
Object.PercentageAxisColor[=Color]
Object
Color
Optional. A value or a constant that specifies the color of the percentage axis.
Comments
RGB (255, 0, 0)
See also

VB scripting
Picture (RT Professional)
Description
Specifies the screen from the WinCC project graphics to be displayed in the object in runtime.
Syntax
Object.Picture[=HmiObjectHandle]
Object
Required. An object of the type " "ScreenItem" with the format:
● Clock
● GraphicView
HmiObjectHandle
Optional. A value or a constant that specifies the screen from the WinCC project graphics to
be displayed in the object in runtime.
PictureAlignment (RT Professional)
Description
Specifies the display type for the background screen in the process image.
Syntax
Object.PictureAlignment[=PictureAlignment]
Object
● Button
● RoundButton*
*: Read access only
PictureAlignment
Optional A value or a constant that specifies the display type for the background screen in the
process image.

VB scripting
PictureAreaBottomMargin (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
PictureAreaLeftMargin (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
PictureAreaRightMargin (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
PictureAreaTopMargin (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
PictureAutoSizing (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
PictureDeactivated (RT Professional)
Description
Specifies the graphic from the WinCC project graphics that is displayed in the "Disabled" status.
Syntax
Object.PictureDeactivated[=HmiObjectHandle]

VB scripting
Object
● Roundbutton
HmiObjectHandle
Optional. A value or a constant that specifies the picture that will be displayed in the
"Deactivated" status.
See also
PictureList (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
PictureOff (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the picture that is displayed in the "Off" status.
Access in runtime:
Syntax
Object.PictureOff[=HmiObjectHandle]
Object
● Button
● GraphicIOField
● RoundButton*
*: Read access only
● Switch
HmiObjectHandle
Optional A value or a constant that specifies the picture that will be displayed in the "Off" status.

VB scripting
Comments
The picture (*.BMP or *.DIB) must be in the "GraCS" folder of the current project so that you
can integrate it.
PictureOn (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the screen that will be displayed in the "on" state.
Access in runtime:
Syntax
Object.PictureOn[=HmiObjectHandle]
Object
● Button
● GraphicIOField
● RoundButton*
*: Read access only
● Switch
HmiObjectHandle
Optional A value or a constant that specifies the screen that will be displayed in the "on" state.
Comments
The screen (*.BMP or *.DIB) must be in the "GraCS" folder of the current project in order to
be able to integrate it.
PictureRotation (Panels, Comfort Panels, RT Advanced, RT Professional)
Description

VB scripting
PictureSizeMode (RT Professional)
Description
Specifies the size adaptation between Media Player and the contents to be displayed.
Syntax
Object.PictureSizeMode[=PictureSizeMode]
Object
● MediaPlayer
PictureSizeMode
Optional. Value or constant that specifies the size adaptation between Media Player and the
contents to be displayed.

0 Fit object size to con‐ Specifies that the size of the Media Player is adapted to the size
tent of the contents to be displayed.
1 Fit content to object Specifies that the contents to be displayed are adapted to the size
size of the Media Player.
See also
PlayCount (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
PlayEndless (RT Professional)
Description
Specifies that the media file is repeated in an endless loop.
Syntax
Object.PlayEndless[=BOOLEAN]

VB scripting
Object
● MediaPlayer
BOOLEAN
Optional.
TRUE, if the media file is repeated in an endless loop.
FALSE, if the media file is played only once.
See also
PLCFilter (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
PlcUDTFilter (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
PointerColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the pointer color of the "Gauge" object.
Syntax
Object.PointerColor[=Color]
Object
● Gauge
Color
Optional. A value or a constant that specifies the pointer color.

VB scripting
Comments
RGB (255, 0, 0)
See also
Gauge (Page 319)
Points (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
PointsCount (RT Professional)
Description
Specifies the number of corner points of the polyline or of the polygon.
Access in runtime:
Syntax
Object.PointsCount[=Int32]
Object
● Polygon
● Polyline
● Tubepolyline
● Connector
● Line
Int32
Optional. A value or a constant that specifies the number of corner points of the polyline.

VB scripting
PopupMenuEnabled (RT Professional)
Description
PositionFont (RT Professional)
Description
Sets the font for the label of the slider.
Syntax
Object.PositionFont[=Font]
Object
● Slider
Font
Optional. Value or constant that specifies the font.
Precision (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the number of decimal places (0 to 20).
Syntax
Object.Precision[=Int32]
Object
● Bar
Int32
Optional A value or a constant that specifies the number of decimal places (0 to 20).

VB scripting
See also
Bar (Page 257)
PreferredUseOnAck (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Pressed (RT Professional)
Description
Specifies whether the selected object is displayed in a pressed state.
Syntax
Object.Pressed[=BOOLEAN]
Object
● Button
● RoundButton*
*: Read access only
BOOLEAN
Optional. TRUE, if the selected object is displayed in a pressed state.
PrintJob (RT Professional)
Description
Specifies a print job that is created in the "Reports" editor.
Syntax
Object.PrintJob[=HmiObjectHandle]

VB scripting
Object
● AlarmControl
HmiObjectHandle
Optional. A value or a constant that specifies the layout of the printout.
See also
ProcessTag (RT Professional)
Description
ProcessValue (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the default for the value to be displayed.
This value will be used in runtime if the associated tag is not connected or has not been updated
when the screen starts.
Access in runtime:

VB scripting
Syntax
Object.ProcessValue[=DOUBLE | Int32 | Object | SINGLE]
Object
● Bar
● CheckBox
● Gauge
● GraphicIOField
● IOField
● OptionGroup
● Slider
● WindowsSlider*
*: Read access only
● Button
● DateTimeField
● Switch
● SymbolLibrary

Optional. A value or a constant that includes the default value. The data type depends on the
format.
● DOUBLE: Bar
● Int32: CheckBox, GraphicIOField, OptionGroup, Slider, SymbolicIOField, WindowsSlider
● Object: IOField
● SINGLE: Gauge
Comments
If you want to assign the "ProcessValue" SmartTags property, then you must formulate the
assignment as follows:
'Examples for the assignment of SmartTags
'Example 1
IOField.ProcessValue = SmartTags("TagName").Value
'Example 2
HmiRuntime.Screens("Screen_1").ScreenItems("IOField_1").ProcessValue =
SmartTags("Tag_1").Value

VB scripting
ProgID (RT Professional)
Description
In the case of non-WinCC controls, the version-independent ProgID is returned as the type.
ProhibitDataRecordTagInOnlySimpleView (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
1.5.5.11 Properties Q-R (Panels, Comfort Panels, RT Advanced, RT Professional)
QualityCode (RT Professional)
Description
Returns the quality of a tag value after reading the tag as SHORT. After a tag has been written,
the value is invalid.
Syntax
Object.QualityCode
Object
Necessary. An object of the "HMIRuntime" type.
Example
The following example indicates the quality of the read value when no errors have occurred
during the reading process:
'VBS83
Dim objTag
Dim lngLastErr
objTag.Read
lngLastErr = objTag.LastError
If 0 = lngLastErr Then
MsgBox objTag.QualityCode
End If

VB scripting
See also
Tag (Page 227)
Radius (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the radius.
Syntax
Object.Radius[=Int32]
Object
● Circle
● CircleSegment
● CircularArc
● RoundButton
Int32
Optional. A value or constant which determines the radius in pixels.
RadiusHeight (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the secondary axis.
Syntax
Object.RadiusHeight[=Int32]
Object
● Ellipse
● EllipseSegment
● EllipticalArc
● TubeArcObject

VB scripting

● Circle
Int32
Optional. A value or constant which determines the secondary axis in pixels.
See also
Ellipse (Page 299)
Circle (Page 278)
RadiusWidth (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the main axis.
Syntax
Object.RadiusWidth[=Int32]
Object
● Ellipse
● EllipseSegment
● EllipticalArc
● TubeArcObject
● Circle
Int32
Optional. A value or constant which determines the main axis in pixels.
See also
Ellipse (Page 299)

VB scripting

Circle (Page 278)
Recipe (RT Advanced)
Description
RecipeName (RT Advanced)
Description
Returns the name of the recipe that is currently being displayed in the "Recipe view".
Syntax
Object.RecipeName[=STRING]
Object
● RecipeView
STRING
Optional A value or a constant that returns the name of the recipe.
See also
RecipeNameCaption (RT Advanced)
Description
RecipeNrCaption (RT Advanced)
Description

VB scripting
RecipeNrColFirst (RT Advanced)
Description
RecipeNumber (RT Advanced)
Description
Returns the number of the recipe that is currently being displayed in the "Recipe view".
Syntax
Object.RecipeNumber[=Int32]
Object
● RecipeView
Int32
Optional A value or a constant that returns the number of the recipe.
See also
RecordName (RT Advanced)
Description
Returns the name of the recipe data record that is currently being displayed in the "Recipe
view".
Syntax
Object.RecordName[=STRING]
Object
● RecipeView

VB scripting
STRING
Optional A value or a constant that returns the name of the recipe data record.
See also
RecordNrColFirst (RT Advanced)
Description
RecordNumber (RT Advanced)
Description
Returns the number of the recipe data record that is currently being displayed in the "Recipe
view".
Syntax
Object.RecordNumber[=Int32]
Object
● RecipeView
Int32
Optional A value or a constant that returns the number of the recipe data record.
See also
RelativeFillLevel (RT Professional)
Description
Specifies the fill percentage for the object.

VB scripting
Syntax
Object.RelativeFillLevel[=Int32]
Object
● Button
● CheckBox
● Circle
● Ellipse
● EllipseSegment
● GraphicView
● OptionGroup
● Polygon
● Rectangle
● RoundButton*
● TextField
● WindowsSlider*
*: Read access only
● CircleSegment
Int32
Optional. A value or a constant that specifies the fill percentage of the object.
RenameButtonVisible (RT Advanced)
Description
ReSizeable (Panels, Comfort Panels, RT Advanced, RT Professional)
Description

VB scripting
RightMargin (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Rotation (RT Professional)
Description
Specifies the angle of rotation in degrees. The angle of rotation is measured counterclockwise.
Syntax
Object.Rotation[=SymbolLibraryRotation]
Object
● SymbolLibrary
SymbolLibraryRotation
Optional. A value or a constant that specifies the angle of rotation in degrees.

0 hmiSymbolLibraryRotationNone The object rotates by 0 degrees.
90 hmiSymbolLibraryRotation90Degree The object rotates by 90 degrees.
RotationAngle (RT Professional)
Description
Specifies the angle of rotation in degrees.
Syntax
Object.RotationAngle[=Int32]

VB scripting
Object
● Line
● Polygon
● Polyline
● TextField
● TubeTeeObject
Int32
Optional A value or a constant that specifies the angle of rotation in degrees.
Comments
In Runtime the object rotates clockwise on the reference point.
See also
Line (Page 336)
Polygon (Page 378)
Polyline (Page 381)
RotationCenterLeft (RT Professional)
Description
Specifies the X coordinate of the pivot point for the object in runtime.
Syntax
Object.RotationCenterLeft[=Int32]
Object
● Line
● Polygon
● Polyline
● TextField*
*: Read access only

VB scripting
Int32
Optional. A value or a constant that specifies the X coordinates of the pivot point to rotate the
object in runtime.
Comments
The value of the X coordinate is relative to the object width. Specify the value as a percentage
from the left edge of the rectangle that surrounds the object.
RotationCenterTop (RT Professional)
Description
Specifies the Y coordinate of the pivot point for the object in runtime.
Syntax
Object.RotationCenterTop[=Int32]
Object
● Line
● Polygon
● Polyline
● TextField*
*: Read access only
Int32
Optional. A value or a constant that specifies the Y coordinates of the pivot point to rotate the
object in Runtime.
Comments
The value of the Y coordinate is relative to the object width. Specify the value as a percentage
from the upper edge of the rectangle that surrounds the object.
RoundCornerHeight (RT Professional)
Description
Specifies the corner radius. Enter the value as a percentage of half the height of the object.

VB scripting
Syntax
Object.RoundCornerHeight[=Int32]
Object
● Rectangle
Int32
Optional A value or a constant that specifies the corner radius.
RoundCornerWidth (RT Professional)
Description
Specifies the corner radius. Enter the value as a percentage of half the width of the object.
Syntax
Object.RoundCornerWidth[=Int32]
Object
● Rectangle
Int32
Optional A value or a constant that specifies the corner radius.
RowScrollbar (RT Professional)
Description
Specifies when the vertical scroll bar is displayed.
Syntax
Object.RowScrollbar[=ScrollbarVisibility]
Object
● AlarmControl

VB scripting
ScrollbarVisibility
Optional. A value or a constant that specifies when the vertical scroll bar is displayed.
Value Explanation
0 The vertical scroll bar is not displayed.
1 The vertical scroll bar is displayed if the display area is too small for all rows.
2 The vertical scroll bar is always displayed.
See also
RowTitleAlignment (RT Professional)
Description
Specifies the type of row header alignment.
Syntax
Object.RowTitleAlignment[=HorizontalAlignment]
Object
● AlarmControl
HorizontalAlignment
Optional. A value or a constant that specifies the row header alignment.

0 Left The row headers are aligned left.
1 Centered The row headers are aligned to center.
2 Right The row headers are aligned right.

VB scripting
See also
RowTitles (RT Professional)
Description
Specifies whether numbered column headers are displayed.
Syntax
Object.RowTitles[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
Optional. TRUE if numbered column headers are displayed.
See also
RTPersistence (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies whether online configurations are retained after a screen change.
Also set "RTPersistenceType" to 1 or 2.

VB scripting
Access in runtime:
Syntax
Object.RTPersistence[=RTPersistence]
Object
● AlarmControl
● SysDiagControl
● UserView
RTPersistence
Optional. A value or a constant that specifies whether online configurations are retained after
a screen change.
Value Explanation
0 The current online configurations are discarded at the next picture change.
1 The current online configurations are retained at the next picture change.
2 All online configurations made are lost. The screen is set to the content originally configured.
RTPersistenceAuthorization (RT Professional)
Description
Specifies the authorization required for online configuration in runtime.
Access in runtime:
Syntax
Object.RTPersistenceAuthorization[=HmiObjectHandle]

VB scripting
Object
● AlarmControl
You have no access in runtime in the case of the following characteristic:
● SysDiagControl
● UserView
HmiObjectHandle
Optional. A value or a constant that specifies the user rights in runtime.
See also
UserView (Page 480)
RTPersistenceType (RT Professional)
Description
Specifies how online configurations of WinCC are retained.
Access in Runtime:
● RT Professional: Read
Syntax
Object.RTPersistenceType

VB scripting
Object
● AlarmControl
● SysDiagControl
● UserView
RTPersistenceType
Optional. A value or a constant that specifies how online configurations are retained by WinCC.
Value Explanation
0 Online configurations are discarded. These are lost at the next picture change.
1 Online configurations are retained during Runtime. These are lost on exiting.
2 Online configurations are retained permanently. These are also available after restart.
RulerColor (RT Advanced)
Description
Specifies the color of the scale gradation (help line) of the axis label.
Syntax
Object.RulerColor[=Color]
Object
● TrendView
Color
Optional. A value or a constant that specifies the color of the scale gradation.

VB scripting
Comments
RGB (255, 0, 0)
See also
RulerColumns (RT Professional)
Description
RulerType (RT Professional)
Description
Specifies the display mode of the value table.
Syntax
Object.RulerType[=TrendRulerControlType]
Object
TrendRulerControlType
Optional. A value or a constant that specifies the display mode of the value table.

0 Ruler Specifies that a ruler window is displayed. The ruler window shows the coordinate
values of the trends on the ruler or values of a selected line in the table.
1 Extreme values Specifies that the statistics area window is displayed. The statistics area window shows
the values at the low limit and high limit of the trends between two rulers or of the
selected area in the table.
2 Statistics Specifies that a statistics window is displayed. The statistics window shows the statis‐
tical evaluation of the trend between two rulers or of the selected values in the table.

VB scripting
See also
1.5.5.12 Properties S (Panels, Comfort Panels, RT Advanced, RT Professional)
S7Device (RT Advanced)
Description
ScaleColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the color of the scale.
Syntax
Object.ScaleColor[=Color]
Object
● Bar
● TrendView
Color
Optional. A value or a constant that specifies the color of the scale.
Comments
ScreenItem object with the format "Bar": For the color to be displayed, the property
""ShowScale" must have the value TRUE.
RGB (255, 0, 0)

VB scripting
ScaleDenominator (Panels, Comfort Panels, RT Advanced)
Description
Defines the counter for scaling on the client.
Syntax
Object.ScaleDenominator=[Int]
Object
Required. A "ScreenItem" object with the format "SmartClientView".
Int
Optional. A value or a constant that specifies the value.
See also
ScaleDenominator (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ScaleGradation (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the distance between two large marking lengths of the scale.
Syntax
Object.ScaleGradation[=DOUBLE]
Object
● Bar
DOUBLE
Optional A value or a constant that specifies the distance between two large marking lengths
of the scale.

VB scripting
See also
Bar (Page 257)
ScaleLabelColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the color of the label for the scale marks of the "Gauge" object.
Syntax
Object.ScaleLabelColor[=Color]
Object
● Gauge
Color
Optional. A value or a constant that specifies the label color of the scale gradation.
Comments
RGB (255, 0, 0)
See also
Gauge (Page 319)
ScaleLabelFieldLength (Panels, Comfort Panels, RT Advanced, RT Professional)
Description

VB scripting
ScaleLabelFont (RT Professional)
Description
Specifies the font for the scale label.
Syntax
Object.ScaleLabelFont[=Font]
Object
● Gauge
Font
Optional. A value or a constant that specifies the font for scale labeling.
ScaleLabelingDoubleLined (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ScaleNumerator (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ScalePosition (RT Professional)
Description
Specifies the position of the scale.
Also set "ShowScale" to "TRUE".
Access in runtime:
Syntax
Object.ScalePosition[=ScalePosition]

VB scripting
Object
● Bar
● Slider
ScalePosition
Optional. A value or a constant that specifies the position of the scale.

0 hmiScalePositionLeftUp For a vertical bar, the scale is displayed at the top. For a horizontal bar the scale will
be shown at the left.
1 hmiScalePositionRightDown For a vertical bar, the scale is displayed at the bottom. For a horizontal bar the scale
will be shown at the right.
ScaleStart (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ScaleTickColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the color of the scale gradation of the "Gauge" object.
Syntax
Object.ScaleTickColor[=Color]
Object
● Gauge
Color
Optional. A value or a constant that specifies the color of the scale gradation.
Comments

VB scripting
RGB (255, 0, 0)
ScaleTickLabelPosition (RT Professional)
Description
Specifies the diameter of the assumed circle on which the label of the scale divisions is located.
Syntax
Object.ScaleTickLabelPosition[=DOUBLE]
Object
● Gauge
DOUBLE
Optional A value or a constant that specifies the diameter of the assumed circle on which the
label of the scale division is located.
Value range from 0 to 1
0: The label is located in the center of the scale.
1: The diameter of the assumed circle for the label is the smaller value of the geometry
properties "Width" and "Height". A part of the label can lie outside the object limits and is
therefore invisible.
See also
Gauge (Page 319)
ScaleTickLength (RT Professional)
Description
Specifies the length of the main markings for the scale division. The value refers to half the
smaller value of the geometry properties "Width" and "Height".
The length of the marking lengths for the fine divisions is 0.5* scale width.
Syntax
Object.ScaleTickLength[=DOUBLE]

VB scripting
Object
● Gauge
DOUBLE
Optional A value or a constant that specifies the length of the main markings of the scale.
Value range 0 to scale end value
0: There are no scale divisions. The divisions of the scale in the areas are not visible.
Scale end value: The scale division ranges from the mid-point of the scale disc to the value
specified by the scale end value.
See also
Gauge (Page 319)
ScaleTickPosition (RT Professional)
Description
Specifies the diameter of the assumed circle on which the scale divisions are located.
The main markings of the scale divisions lie with their outward-facing ends on this circle.
Syntax
Object.ScaleTickPosition[=DOUBLE]
Object
● Gauge
DOUBLE
Optional A value or a constant that specifies the diameter of the assumed circle on which the
scale divisions are located.
Value range from 0 to 1
0: The scale divisions are located in the center of the scale.
1: The diameter of the assumed circle for the label is the scale divisions is the smaller value
of the geometry properties ""Width" and "Height".
See also
Gauge (Page 319)

VB scripting
Scaling (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ScalingType (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the type of bar scaling.
Also set "ShowScale" to "TRUE".
Syntax
Object.ScalingType[=BarScalingType]
Object
● Bar
BarScalingType
Optional. A value or a constant that specifies the type of bar scaling.
Value VB constant Description Explanation

0 hmiBarScalingLinear Linear The large marks are distributed evenly over the scale. The dis‐
tance between the large marks corresponds to the value of
"LargeTicksSize".
1 hmiBarScalingLogarithmic Logarithmic The distribution of the large marks on the scale follows a loga‐
rithmic function.
The representation of low values is very strongly highlighted.
2 hmiBarScalingNegativeLo‐ Negative loga‐ The distribution of the large marks on the scale follows a negative
garithmic rithmic logarithmic function. The representation of high values is very
strongly highlighted.
3 hmiBarScalingAutomatic Automatic The large marks are distributed evenly over the scale. The dis‐
tance between the large marks is specified automatically.
4 hmiBarScalingTangent Tangents The distribution of the large marks on the scale highlights the
representation of the low and high values.
5 hmiBarScalingQuadratic Square The distribution of the large marks follows a square function. The
representation of high values is highlighted.
6 hmiBarScalingCubic Cubic The distribution of the large marks on the scale follows a cubic
function. This highlights the representation of large values.

VB scripting
See also
Bar (Page 257)
ScreenItems (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Returns the ScreenItems list.
Syntax
Object.ScreenItems
Object
Required A "ScreenItems"." object.
See also
ScreenItems (list) (Page 219)
ScreenName (RT Professional)
Description
Specifies the screen to be displayed in the screen window in runtime.
Syntax
Object.ScreenName[=HmiObjectHandle]
Object
● ScreenWindow
HmiObjectHandle
Optional A value or a constant that specifies the screen to be displayed in the screen window
in runtime.
See also

VB scripting
Screens (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Returns the Screens listing. The Screens list contains two elements: The first element with the
index 0 represents the permanent area. The second element with the index 1 represents the
root screen. Alternatively, the two elements can be addressed by means of their names. Use
"Overview" for the permanent area and "Base" for the root screen.
Note
The alarm window and the alarm indicator are not contained in the Screens list, even if they
have the focus in Runtime.
Syntax
Object.Screens
Object
Required. An object of the type "Screens".
See also
Screen object (list) (Page 221)
ScreenScaleMode (RT Professional)
Description
Specifies the scaling mode of the displayed screen.
Syntax
Object.ScreenScaleMode[=ScreenScaleModeType]
Object
● ScreenWindow
ScreenScaleModeType
Optional. A value or a constant that specifies the scaling mode of the displayed screen.

VB scripting
ScrollBarOrientation (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
SecondGradientColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
SecondGradientOffset (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
SecondNeedleHeight (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the length of the second hand.
Syntax
Object.SecondNeedleHeight[=Int32]
Object
● Clock
Int32
Optional. A value or a constant that specifies the length of the second hand.
Specify the length of the second hand as a percentage relating to the radius of the clock face.
See also
Clock (Page 286)

VB scripting
SecondNeedleWidth (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the width of the second hand.
Syntax
Object.SecondNeedleWidth[=Int32]
Object
● Clock
Int32
Optional. A value or a constant that specifies the width of the second hand. Specify the width
as a percentage relating to double the length of the second hand.
See also
Clock (Page 286)
SecurityForSimpleViewEnabled (RT Advanced)
Description
SegmentColoring (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the type of color change to be displayed if the limits are exceeded.
Syntax
Object.SegmentColoring[=THmiBarColorType]
Object
● Bar

VB scripting
THmiBarColorType
Optional. A value or a constant that specifies the type of color change. Value range from 0 to
1.

0 hmiBarColorEntire Color change applied to the entire bar.
1 hmiBarColorSegmented Color change applied to segments.
See also
Bar (Page 257)
SelectArchiveName (RT Professional)
Description
Specifies that the selection dialog for the data source of the recipe view is displayed initially
in runtime.
Syntax
Object.SelectArchiveName[=BOOLEAN]
Object
BOOLEAN
Optional.
TRUE, if the selection dialog for the data source of the recipe view is displayed in the screen.
FALSE, if no selection dialog for the data source of the recipe view is displayed in the screen.
See also

VB scripting
SelectBackColor (RT Professional)
Description
Specifies the background color of the selected text entry.
Syntax
Object.SelectBackColor[=Color]
Object
● SymbolicIOField
Color
Optional. A value or a constant that specifies the background color of the selected text entry.
Comments
RGB (255, 0, 0)
See also
SelectedCellColor (RT Professional)
Description
Specifies the background color of the selected cell.
Syntax
Object.SelectedCellColor[=Color]

VB scripting
Object
● AlarmControl
Color
Optional. A value or a constant which specifies the background color.
Comments
RGB (255, 0, 0)
See also
SelectedCellForeColor (RT Professional)
Description
Specifies the font color of the selected cell.
Syntax
Object.SelectedCellForeColor[=Color]
Object
● AlarmControl

VB scripting
Color
Optional. A value or a constant which specifies the font color.
Comments
RGB (255, 0, 0)
See also
SelectedID (RT Professional)
Description
Returns the ID of the data record selected in the recipe view.
Syntax
Object.SelectedID[=Int32]
Object
Int32
Optional. A value or a constant that returns the ID of the selected data record.
Value Description
0 None valid data record selected, e.g. in the event of a connection error.
-1 The edit line is selected.

VB scripting
See also
SelectedIndex (RT Professional)
Description
Defines the index of which the associated text is highlighted in the combo box or list box.
The maximum value is the number of lines (NumberLines) of the object.
Syntax
Object.SelectedIndex[=Int32]
Object
● ComboBox
● ListBox
Int32
Optional A value or a constant that specifies the index of the text highlighted.
See also
ComboBox (Page 289)
Listbox (Page 339)
SelectedRowColor (RT Professional)
Description
Specifies the background color of the selected row.
Syntax
Object.SelectedRowColor[=Color]

VB scripting
Object
● AlarmControl
Color
Comments
RGB (255, 0, 0)
See also
SelectedRowForeColor (RT Professional)
Description
Specifies the font color of the selected row.
Syntax
Object.SelectedRowForeColor[=Color]
Object
● AlarmControl

VB scripting
Color
Comments
RGB (255, 0, 0)
See also
SelectedText (RT Professional)
Description
Specifies the text for the entry referenced with "SelectedIndex".
Syntax
Object.SelectedText[=STRING]
Object
● ComboBox
● ListBox
STRING
Optional. A value or a constant that specifies the text for an entry.

VB scripting
See also
ComboBox (Page 289)
Listbox (Page 339)
SelectedTitleColor (RT Professional)
Description
Specifies the background color of the selected table header.
Also set "UseSelectedTitleColor" to "TRUE".
Syntax
Object.SelectedTitleColor[=Color]
Object
● AlarmControl
Color
Comments
RGB (255, 0, 0)
See also

VB scripting
SelectedTitleForeColor (RT Professional)
Description
Specifies the font color of the selected table header.
Also set "UseSelectedTitleColor" to "TRUE".
Syntax
Object.SelectedTitleForeColor[=Color]
Object
● AlarmControl
Color
Comments
RGB (255, 0, 0)
See also
SelectForeColor (RT Professional)
Description
Specifies the color of the selected text entry.

VB scripting
Syntax
Object.SelectForeColor[=Color]
Object
● SymbolicIOField
Color
Optional. A value or a constant that specifies the color of the selected text entry.
Comments
RGB (255, 0, 0)
See also
SelectionBackColor (RT Advanced)
Description
Specifies the background color of the selected cells.
Syntax
Object.SelectionBackColor[=Color]
Object
● AlarmView
● RecipeView*
● StatusForce
● UserView
*: Read access only

VB scripting

● TrendView
Color
Optional. A value or constant that specifies the background color of the selected row.
Comments
RGB (255, 0, 0)
SelectionColoring (RT Professional)
Description
Specifies whether selection colors are used for cells or rows.
Syntax
Object.SelectionColoring[=GridSelectionColoring]
Object
● AlarmControl
GridSelectionColoring
Optional. A value or a constant that specifies whether highlight colors are used for cells or
rows.

0 None No selection colors for cells and rows.
1 Cell Selection color for cell.
2 Row Selection color for row.
3 Cell and row Selection colors for cell and row.

VB scripting
See also
SelectionForeColor (RT Advanced)
Description
Specifies the foreground color of the selected cells.
Syntax
Object.SelectionForeColor[=Color]
Object
● AlarmView
● RecipeView*
● StatusForce
● UserView
*: Read access only
● TrendView
Color
Optional. A value or constant that specifies the background color of the selected row.
Comments
RGB (255, 0, 0)

VB scripting
SelectionRect (RT Professional)
Description
Specifies whether a selection frame is used for the selected cells or rows.
Syntax
Object.SelectionRect[=GridSelectionBorder]
Object
● AlarmControl
GridSelectionBorder
Optional. A value or a constant that specifies whether a selection border is used for the selected
cell or rows.

0 None No selection border is drawn for selected cells or rows.
1 Cell A selection border is drawn for the selected cell.
2 Row A selection border is drawn for the selected row.
See also
SelectionRectColor (RT Professional)
Description
Specifies the color of the selection rectangle in the alarm window.
Also set "SelectionType" to "1" or "2".

VB scripting
Syntax
Object.SelectionRectColor[=Color]
Object
● AlarmControl
Color
Optional. A value or a constant which specifies the color.
Comments
RGB (255, 0, 0)
See also
SelectionRectWidth (RT Professional)
Description
Specifies the line width of the selection rectangle in the alarm window if SelectionType equals
"1".
Syntax
Object.SelectionRectWidth[=Int32]

VB scripting
Object
● AlarmControl
Int32
Optional A value or a constant which specifies the line width.
See also
SelectionType (RT Professional)
Description
Specifies the number of lines you can mark.
Syntax
Object.SelectionType[=GridSelectionType]
Object
● AlarmControl
GridSelectionType
Optional A value or a constant that specifies the number of lines that you can select.

VB scripting

0 None No line is selected.
1 Single selection One line can be selected.
2 Multiple selection Several lines can be selected.
See also
SeparateLineForAlarmText (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
SeparatorBackColor (RT Professional)
Description
Specifies the background color of the broken separation lines in the selection list.
Syntax
Object.SeparatorBackColor[=Color]
Object
● SymbolicIOField
Color
Optional. A value or a constant that specifies the background color of the broken separation
lines in the selection list.
Comments

VB scripting
RGB (255, 0, 0)
See also
SeparatorColor (RT Professional)
Description
Specifies the color of the separation lines in the selection list.
Syntax
Object.SeparatorColor[=Color]
Object
● S7GraphOverview
* Read access only
Color
Optional. A value or a constant that specifies the color of the separation lines in the selection
list.
Comments
RGB (255, 0, 0)
SeparatorCornerStyle (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Returns the shape of the corners for the separation line.

VB scripting
Syntax
Object.SeparatorCornerStyle[=CornerStyle]
Object
● SymbolicIOField
CornerStyle
Optional. A value or a constant that returns the shape of the corners of the separation line.
Value Description
0 Solid line
1 Dashed line
2 Dotted line
4 Dash-dot-dot line
SeparatorLineEndShapeStyle (RT Professional)
Description
Returns the shape of the line ends for the separation line.
Syntax
Object.SeparatorLineEndShapeStyle[=LineEndShapeStyle]
Object
● SymbolicIOField
LineEndShapeStyle
Optional. A value or a constant that returns the shape of the line ends for the separation line.
Value Designation
-1 Flush
0 Rounded
1 Rectangular

VB scripting
SeparatorStyle (RT Professional)
Description
Specifies the line type of the separation lines in the selection list.
Syntax
Object.SeparatorStyle[=LineStyle]
Object
● SymbolicIOField
LineStyle
Optional. A value or a constant that specifies the type of separation lines in the selection list.

-1 hmiLineStyleNone The selection list has no separation lines.
0 hmiLineStyleSolid The selection list has solid separation lines.
1 hmiLineStyleDash The selection list has dashed separation lines.
2 hmiLineStyleDot The selection list has dotted separation lines.
3 hmiLineStyleDashDot The selection list has dash-dot separation lines.
4 hmiLineStyleDashDotDot The selection list has dash-dot-dot separation lines.
SeparatorWidth (RT Professional)
Description
Specifies the width of the separation lines in the selection list.
Syntax
Object.SeparatorWidth[=Int32]
Object
● SymbolicIOField
Int32
Optional. A value or a constant that specifies the width of separation lines in the selection list.

VB scripting
See also
ServerNames (RT Professional)
Description
Specifies the servers of a distributed system from which the object receives data. The
information is given in the following form: NameServer1;NameServer2;NameServer3.
Syntax
Object.ServerNames[=STRING]
Object
● AlarmControl
STRING
Optional. A value or a constant that specifies the servers of a distributed system from which
the object receives data.
See also
ServerPrefix (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the server on which the screen is located that is displayed in the screen window in
runtime or returns the server name.
Enter the server name followed by two colons: "<Server name>::". There is no check whether
the server actually exists.
Syntax
Object.ServerPrefix[=String]
Object
● ScreenWindow

VB scripting
String
Optional. A value or a constant which specifies the server name.
ServerScale (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
SetOfVisibleColumns (RT Advanced)
Description
Shared (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ShareSpaceWithSourceControl (RT Professional)
Description
Specifies that the display area of the data source is adapted to the size of the value table.
Syntax
Object.ShareSpaceWithSourceControl[=BOOLEAN]
Object
BOOLEAN
Optional.
TRUE if the size of the data source is adjusted to the size of the value table.
FALSE; if the size of the data source is not adapted to the size of the value table.

VB scripting
See also
ShiftDecimalPoint (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ShowAcknowledgeButton (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ShowAlarmsFromDate (RT Advanced)
Description
Specifies that only those message events are displayed that are saved in this tag.
Syntax
Object.ShowAlarmsFromDate[=HmiObjectHandle]
Object
● AlarmView
HmiObjectHandle
Optional A value or a constant which specifies that only those message events are displayed
that are saved in this tag.
See also
ShowAlarmsToAcknowledge (Panels, Comfort Panels, RT Advanced, RT Professional)
Description

VB scripting
ShowBadTagState (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Defines whether the object is grayed out when a bad quality code or tag status is detected.
Syntax
Object.ShowBadTagState[=BOOLEAN]
Object
● Bar
● CheckBox
● IOField
● OptionGroup
● WindowSlider *
* Read access only
BOOLEAN
Optional.
TRUE if the object is grayed out or the settings for the grid color are used when the quality
code or the the tag status is poor.
ShowBar (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies whether the displayed process value is also shown by a filled bar.
Syntax
Object.ShowBar[=BOOLEAN]
Object
● Slider

VB scripting
BOOLEAN
Optional. TRUE if the process value is also shown by a filled bar.
See also
Slider (Page 409)
ShowCaption (RT Professional)
Description
Specifies whether the title bar is shown.
Access in runtime:
Syntax
Object.ShowCaption[=BOOLEAN]
Object
● ScreenWindow
● Switch
BOOLEAN
Optional. TRUE if the header is shown.
ShowColumnHeaders (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ShowControls (RT Professional)
Description
Specifies that a toolbar is displayed.

VB scripting
Access in runtime:
Syntax
Object.ShowControls[=BOOLEAN]
Object
● MediaPlayer
● SmartClientView
BOOLEAN
Optional.
TRUE, if a toolbar is displayed.
FALS E, if no toolbar will be displayed.
ShowDate (RT Advanced)
Description
ShowDecimalPoint (RT Professional)
Description
Specifies whether the scale is identified with decimal figures (decimal point and one decimal
place) or with whole integers.
Syntax
Object.ShowDecimalPoint[=BOOLEAN]
Object
● Gauge

VB scripting
BOOLEAN
Optional TRUE, if the scale is identified with decimal figures (decimal point and one decimal
place).
See also
Gauge (Page 319)
ShowDropDownButton (RT Professional)
Description
Returns whether a button for the selection list is displayed.
Syntax
Object.ShowDropDownButton[=BOOLEAN]
Object
● SymbolicIOField
BOOLEAN
Optional.
TRUE if a button is displayed for the selection list.
FALSE, if no button for the selection list is displayed.
See also
ShowDropDownList (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ShowFeatureBackward (RT Professional)
Description
Specifies that the "Backward" button is to be displayed in runtime.

VB scripting
Syntax
Object.ShowFeatureBackward[=BOOLEAN]
Object
● MediaPlayer
BOOLEAN
Optional.
TRUE, if the "Backward" button is displayed.
FALSE if no "Backward" button is displayed.
See also
ShowFeatureForward (RT Professional)
Description
Specifies that the "Forward" button is displayed in runtime.
Syntax
Object.ShowFeatureForward[=BOOLEAN]
Object
● MediaPlayer
BOOLEAN
Optional.
TRUE, if the "Forward" button is displayed.
FALSE if no "Forward" button is displayed.
See also

VB scripting
ShowFeatureFullScreen (RT Professional)
Description
Specifies that the Media Player can be displayed as a full screen.
Syntax
Object.ShowFeatureFullScreen[=BOOLEAN]
Object
● MediaPlayer
BOOLEAN
Optional.
TRUE, if the "Full screen" button is displayed in the toolbar of the Media Player.
FALSE, if no "Full screen" button is displayed in the toolbar of the Media Player.
See also
ShowFeatureFullVolume (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ShowFeaturePause (RT Professional)
Description
Specifies that the "Pause" button is displayed in runtime.
Syntax
Object.ShowFeaturePause[=BOOLEAN]

VB scripting
Object
● MediaPlayer
BOOLEAN
Optional.
TRUE, if the "Pause" button is displayed in runtime.
FALSE, if no "Pause" button is displayed in runtime.
See also
ShowFeaturePlay (RT Professional)
Description
Specifies that the "Play" button is displayed in runtime.
Syntax
Object.ShowFeaturePlay[=BOOLEAN]
Object
● MediaPlayer
BOOLEAN
Optional.
TRUE, if the "Play" button is displayed in runtime.
FALSE, if no "Play" button is displayed in runtime.
See also
ShowFeatureStop (RT Professional)
Description
Specifies that the "Stop" button is displayed in runtime.

VB scripting
Syntax
Object.ShowFeatureStop[=BOOLEAN]
Object
● MediaPlayer
BOOLEAN
Optional.
TRUE, if the "Stop" button is displayed in runtime.
FALSE, if no "Stop" button is displayed in runtime.
See also
ShowFillLevel (RT Professional)
Description
Specifies whether the selected object is filled.
Syntax
Object.ShowFillLevel[=BOOLEAN]
Object
● Button
● CheckBox
● Circle
● CircleSegment
● Ellipse
● EllipseSegment
● GraphicView
● OptionGroup
● Polygon

VB scripting
● Rectangle
● RoundButton*
● TextField
● WindowsSlider*
*: Read access only
BOOLEAN
Optional.TRUE, if the selected object is filled.
ShowFocusRectangle (RT Professional)
Description
Specifies whether the button is given a selection border when it is activated in Runtime.
Syntax
Object.ShowFocusRectangle[=BOOLEAN]
Object
● Clock
BOOLEAN
Optional TRUE, if the button is given a selection border when it is activated in Runtime.
See also
Clock (Page 286)
ShowHelpButton (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ShowHorizontalGridlines (Panels, Comfort Panels, RT Advanced, RT Professional)
Description

VB scripting
ShowInnerDial (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ShowLargeTicksOnly (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies whether only large scale marks are shown.
Syntax
Object.ShowLargeTicksOnly[=BOOLEAN]
Object
● Bar
BOOLEAN
Optional TRUE if only large scale marks are shown.
See also
Bar (Page 257)
ShowLeadingZeros (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ShowLimitLines (Panels, Comfort Panels, RT Advanced, RT Professional)
Description

VB scripting
ShowLimitRanges (RT Professional)
Description
ShowLimitMarkers (RT Professional)
Description
Specifies whether the limit values are shown as a scale value.
Access in runtime:
Syntax
Object.ShowLimitMarkers[=BOOLEAN]
Object
● Bar
● Slider
BOOLEAN
Optional. TRUE, if the limit value is shown as a scale value.
ShowLoopInAlarmButton (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ShowMilliseconds (Panels, Comfort Panels, RT Advanced, RT Professional)
Description

VB scripting
ShowNavigationButtons (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ShowPathInformation (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ShowPeakValuePointer (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies whether a slave pointer will be used for the selected object.
The slave pointer shows the maximum pointer deflection provided in Runtime while the process
screen is loaded. If you reload the process screen, the slave pointer will be reset.
Syntax
Object.ShowPeakValuePointer[=BOOLEAN]
Object
● Gauge
BOOLEAN
Optional TRUE, if the slave pointer is used.
See also
Gauge (Page 319)
ShowPendingAlarms (Panels, Comfort Panels, RT Advanced, RT Professional)
Description

VB scripting
ShowPosition (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies whether the value of the current slider position should also be displayed numerically.
The value is then displayed beneath the slider.
Syntax
Object.ShowPosition[=BOOLEAN]
Object
● Slider
BOOLEAN
Optional TRUE if the value is also shown numerically.
See also
Slider (Page 409)
ShowProcessValue (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ShowReadButton (RT Advanced)
Description
ShowRuler (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies whether a scale division (help line) is displayed for an axis label of the object.

VB scripting
Syntax
Object.ShowRuler[=BOOLEAN]
Object
● TrendView
BOOLEAN
Optional. TRUE, if the scale gradation is shown.
ShowRulerInAxis (RT Professional)
Description
Specifies whether rulers are also displayed in the time axes.
Syntax
Object.ShowRulerInAxis[=BOOLEAN]
Object
BOOLEAN
Optional.
TRUE if the rulers are also displayed in the time axes.
FALSE if the rulers are not displayed in the time axes.
See also

VB scripting
ShowScale (RT Professional)
Description
Specifies whether the values are also shown in a scale.
Access in runtime:
Syntax
Object.ShowScale[=BOOLEAN]
Object
● Bar
● Slider
BOOLEAN
Optional. TRUE, if the values will also be shown in a scale.
ShowScrollBar (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ShowScrollbars (RT Professional)
Description
Specifies whether scroll bars are displayed.
Syntax
Object.ShowScrollbars[=BOOLEAN]

VB scripting
Object
● ScreenWindow
BOOLEAN
Optional. TRUE if scroll bars are displayed.
ShowSignForPositiveLabel (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ShowSortButton (RT Professional)
Description
Specifies whether the sorting button is shown above the vertical scroll bar. Click this sorting
button to sort the selected column based on the configured sorting criteria. The sorting button
is not displayed if the table does not contain a vertical scroll bar.
Syntax
Object.ShowSortButton[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
Optional.
TRUE if the sort button is displayed. You can sort the selected column.

VB scripting
See also
ShowSortIcon (RT Professional)
Description
Specifies whether the sorting icon is displayed.
Syntax
Object.ShowSortIcon[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
Optional.
TRUE if the sort icon is displayed.
FALSE if the sort icon is not displayed.
See also
ShowSortIndex (RT Professional)
Description
Specifies whether a sort index is displayed.

VB scripting
Syntax
Object.ShowSortIndex[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
Optional.
TRUE if a sort index is displayed.
FALSE if a sort index is not displayed.
See also
ShowSplittedView (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ShowStatisticRuler (RT Professional)
Description
Specifies whether the lines that define the statistics area are shown.
Syntax
Object.ShowStatisticRuler[=BOOLEAN]

VB scripting
Object
BOOLEAN
Optional.
TRUE, if the lines for the statistics area are shown.
FALSE, if no lines for the statistics area are shown.
See also
ShowStatusBar (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies whether the status bar is shown.
Access in runtime:
Syntax
Object.ShowStatusBar[=BOOLEAN]
Object
● HTMLBrowser
● MediaPlayer
BOOLEAN
Optional. TRUE, if the status bar is shown.
ShowTableGridlines (RT Advanced)
Description
Specifies whether grid lines are shown in the table.

VB scripting
Access in runtime:
Syntax
Object.ShowTableGridlines[=BOOLEAN]
Object
● StatusForce
● TrendView
● UserView
BOOLEAN
Optional. TRUE if grid lines are shown in the table.
ShowThumb (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies whether the slider of the "Slider" object will be displayed.
Access in runtime:
Syntax
Object.ShowThumb[=BOOLEAN]
Object
● Slider
BOOLEAN
Optional. TRUE, if the slider is shown.
See also
Slider (Page 409)

VB scripting
ShowTickLabels (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies whether the label is shown in the scale.
Access in runtime
● RT Profession al: Read
Syntax
Object.ShowTickLabels[=BOOLEAN]
Object
● Slider
● Bar
BOOLEAN
Optional. TRUE if the label is shown.
Comments
The increments for the measured value are automatically established dependent upon the
specified measurement range and the size of the object.
ShowTicks (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies whether the marks in the scale are displayed.
Syntax
Object.ShowTicks[=BOOLEAN]
Object
● Clock
● Slider*
* RT Professional, read access only

VB scripting
BOOLEAN
Optional. TRUE if the marks are shown.
See also
Clock (Page 286)
Slider (Page 409)
ShowTime (RT Advanced)
Description
ShowTimeAxis (RT Advanced)
Description
ShowTimeAxisLabeling (RT Advanced)
Description
ShowTitle (RT Professional)
Description
Specifies the style of the window border and window title for the object.
Syntax
Object.ShowTitle[=WindowHeaderStyle]
Object
● AlarmControl

VB scripting
WindowHeaderStyle
Optional. A value or constant that specifies the style of the window border for the object.
Value Description
0 Neither window border not title are displayed.
1 A narrow window border with title is displayed.
2 A standard window border with title is displayed.
See also
ShowToolBar (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ShowToolbarBackgroundColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ShowTracker (RT Professional)
Description
Specifies that the tracker is displayed.

VB scripting
Syntax
Object.ShowTracker[=BOOLEAN]
Object
● MediaPlayer
BOOLEAN
Optional.
TRUE, if the tracker is displayed.
FALSE, if no tracker is displayed.
See also
ShowTrendIcon (RT Professional)
Description
Specifies whether an icon is displayed below the value axes. The icon indicates the trend
currently displayed in the foreground.
Syntax
Object.ShowTrendIcon[=BOOLEAN]
Object
BOOLEAN
Optional.
TRUE if the icon is displayed.
FALSE if the icon is not displayed.
See also

VB scripting
ShowTrendIndicator (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies whether the tendency (increasing or falling) of the measurement value that is to be
monitored is shown with a small arrow.
Syntax
Object.ShowTrendIndicator[=BOOLEAN]
Object
● Bar
BOOLEAN
Optional TRUE, if the tendency (increasing or falling) of the measurement value that is to be
monitored is shown with a small arrow.
See also
Bar (Page 257)
ShowValueAxis1 (RT Advanced)
Description
ShowValueAxis1Label (RT Advanced)
Description
ShowValueAxis2 (RT Advanced)
Description

VB scripting
ShowValueAxis2Label (RT Advanced)
Description
ShowValueTable (RT Advanced)
Description
ShowWriteButton (RT Advanced)
Description
ShowY1HlpLine (RT Advanced)
Description
ShowY2HlpLine (RT Advanced)
Description
SimpleView (RT Advanced)
Description
SimpleViewToolbar (Panels, Comfort Panels, RT Advanced, RT Professional)
Description

VB scripting
Size (RT Professional)
Description
Sizeable (RT Professional)
Description
Specifies that the size of an object can be changed in Runtime.
Syntax
Object.Sizeable[=BOOLEAN]
Object
● AlarmControl
Sizable
Optional. A value or a constant that specifies whether the size of the object can be modified.
See also

VB scripting
SmartTags (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Returns the SmartTags list.
Syntax
Object.SmartTags
Object
Required A ""HMIRuntime" object.
See also
SortByTimeDirection (RT Advanced)
Description
Specifies whether the last alarm received is shown at the top (ascending sorting order).
Syntax
Object.SortByTimeDirection[=SortByTimeDirection]
Object
Required. An object of the type "ScreenItems" with the following format:
● AlarmView
SortByTimeDirection
Optional. A value or a constant that specifies the sorting order in the object.

0 Descending The last alarm received is shown at the top.
1 Ascending The last alarm received is shown at the bottom.
See also

VB scripting
SortByTimeEnabled (RT Advanced)
Description
Specifies whether alarm sorting can be altered according to the time.
Syntax
Object.SortByTimeEnabled[=BOOLEAN]
Object
Required. An object of the type "ScreenItems" with the following format:
● AlarmView
BOOLEAN
Optional. TRUE if sorting can be altered by the device operator.
See also
SortSequence (RT Professional)
Description
Specifies how the sorting order is changed if the operator clicks on the column header in
runtime.
Syntax
Object.SortSequence[=GridSortSequence]
Object
● AlarmControl

VB scripting
GridSortSequence
Optional. A value or a constant that specifies how the sorting order will be changed by a mouse
click.

0 Up/down/none You can toggle between ascending, descending and no sorting by means
of mouse click.
1 Up/down You can toggle between ascending and descending sorting order by
means of mouse click.
SourceControl (RT Professional)
Description
Specifies the trend or table view that is connected to the value table.
Syntax
Object.SourceControl[=HmiObjectHandle]
Object
HmiObjectHandle
Optional. A value or a constant that specifies the trend or table view that is connected to the
value table.
See also
SourceControlType (RT Professional)
Description
Specifies the type of data source.
Syntax
Object.SourceControlType[=TrendRulerControlSourceControlType]

VB scripting
Object
TrendRulerControlSourceControlType
Optional. Value or constant that specifies the type of the data source of the value table.

0 None Specifies no type for the data source of the value table.
1 f(t) trend view Specifies that the data source is an f(t) trend view
2 Table view Specifies that the data source is a table view
3 f(x) trend view Specifies that the data source is an f(x) trend view
See also
SplittedViewRatio (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
StartAngle (RT Professional)
Description
Specifies the angle by which the start point deviates from the zero position (0°).
Syntax
Object.StartAngle[=Int32]
Object
● CircleSegment
● CircularArc
● EllipseSegment
● EllipticalArc
● TubeArcObject

VB scripting
Int32
Optional. A value or a constant that specifies the angle by which the start point deviates from
the zero position (0°).
See also
StartLeft (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
StartStyle (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies how the line start is displayed.
Syntax
Object.StartStyle[=LineEndStyle]
Object
● Connector
● Line
● Polyline
LineEndStyle
Optional. A value or constant which determines the line start. Value range from 0 to 6.

0 hmiLineEndStyleNone The line has no start symbol.
1 hmiLineEndStyleArrow The line starts with an arrowhead.
2 hmiLineEndStyleFilledArrow The line starts with a filled arrowhead.

VB scripting

3 hmiLineEndStyleFilledArrowReversed The line starts with a reversed arrowhead.
4 hmiLineEndStyleLine The line starts with a vertical line.
5 hmiLineEndStyleCircle The line starts with a circle.
6 hmiLineEndStyleFilledCircle The line starts with a filled circle.
StartTop (RT Professional)
Description
StartValue (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Defines the absolute value of the zero point of the scale indicator.
Syntax
Object.StartValue[=DOUBLE]
Object
● Bar
DOUBLE
Optional A value or a constant that specifies the absolute value of the zero point for the scale
indicator.
See also
Bar (Page 257)
State (RT Professional)
Description
Returns the status of a message.

VB scripting
The following table shows the possible states of a message:
State Alarm Log Status

1 Came In
2 Went Out
5 Came in and comment
6 Gone and comment
StatisticAreaColumns (RT Professional)
Description
StatisticResultColumns (RT Professional)
Description
StatusbarBackColor (RT Professional)
Description
Specifies the background color for status bars.
Also set "StatusbarUseBackColor" to "TRUE".
Syntax
Object.StatusbarBackColor[=Color]
Object
● AlarmControl

VB scripting
Color
Optional. A value or a constant that specifies the background color of the status bar.
Comments
RGB (255, 0, 0)
See also
StatusbarElementAdd (RT Professional)
Description
Creates a new, user-defined status bar element. The newly created element is automatically
referenced with "StatusbarElementIndex".
Syntax
Object.StatusbarElementAdd[=STRING]
Object
● AlarmControl

VB scripting
STRING
Required. A value or a constant that specifies the name of the new user-defined element of
the status bar with "StatusbarElementName".
See also
StatusbarElementIndex (Page 967)
StatusbarElementAutoSize (RT Professional)
Description
Specifies whether the width of a status bar element referenced with "StatusbarElementIndex"
is set automatically.
Syntax
Object.StatusbarElementAutoSize[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
Optional.
TRUE if the width of the selected element is set automatically.
FALSE if the width of the selected element is not set automatically.

VB scripting
See also
StatusbarElementCount (RT Professional)
Description
Specifies the number of configured status bar elements.
Syntax
Object.StatusbarElementCount[=Int32]
Object
● AlarmControl
Int32
Optional. A value or a constant that specifies the number of configured status bar elements.
See also

VB scripting
StatusbarElementIconId (RT Professional)
Description
References a status bar element with its icon ID.
The referencing of an element with its icon ID does not depend on the actual order of the
elements.
Syntax
Object.StatusbarElementIconId[=Int32]
Object
● AlarmControl
Int32
Optional. A value or a constant that specifies the status bar element to be edited with the icon
ID.
See also
StatusbarElementID (RT Professional)
Description
References a status bar element with its element ID. To access the properties of a status bar
element, you need to set ""StatusbarElementID"".

VB scripting
The referencing of an element with its element ID does not depend on the actual order of the
elements. The element ID are listed in the inspector window of the object under "Properties >
Properties > Status bar > Status bar - Elements".
Syntax
Object.StatusbarElementID[=Int32]
Object
● AlarmControl
Int32
Optional. A value or a constant that specifies the status bar element to be edited with the
element ID.
See also
StatusbarElementIndex (RT Professional)
Description
References a status bar element. To access the properties of a status bar element, you need
to set ""StatusbarElementIndex"".
Values between 0 and "StatusbarElementCount minus 1 are valid for
"StatusbarElementIndex". The "StatusbarElementCount" property specifies the number of
configured status bar elements.

VB scripting
Syntax
Object.StatusbarElementIndex[=Int32]
Object
● AlarmControl
Int32
Optional. A value or a constant that specifies the status bar element to be edited with the index.
See also
StatusbarElementCount (Page 964)
StatusbarElementName (RT Professional)
Description
Specifies the name of a status bar element referenced with "StatusbarElementIndex".
Syntax
Object.StatusbarElementName[=STRING]
Object
● AlarmControl

VB scripting
STRING
Optional. A value or a constant that specifies the name of the referenced status bar element.
See also
StatusbarElementRemove (RT Professional)
Description
Removes the user-defined status bar element referenced with its name.
Syntax
Object.StatusbarElementRemove[=STRING]
Object
● AlarmControl
STRING
Optional. A value or a constant that specifies the name of the referenced user-defined element
of the status bar to be removed.

VB scripting
See also
StatusbarElementRename (RT Professional)
Description
Specifies the new name of a user-defined status bar element referenced with
"StatusbarElementIndex".
Syntax
Object.StatusbarElementRename[=STRING]
Object
● AlarmControl
STRING
Optional. A value or constant that specifies the new name of the selected user-defined status
bar element.
See also

VB scripting

StatusbarElementRepos (RT Professional)
Description
Specifies the position of an element referenced with "StatusbarElementIndex" in the status bar
of the object.
If you have changed the position of the element with "StatusbarElementRepos",
"StatusbarElementIndex" is assigned the value of "StatusbarElementRepos".
Syntax
Object.StatusbarElementRepos[=Int32]
Object
● AlarmControl
Int32
Optional. A value or a constant that specifies the position of the referenced element in the
status bar. Value range from 0 to "StatusbarElementCount" minus 1. Values outside this range
have no effect.
0: The element referenced is positioned on the left.
See also
StatusbarElementCount (Page 964)

VB scripting

StatusbarElements (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
StatusbarElementText (RT Professional)
Description
Specifies the text of a user-defined status bar element referenced with
Syntax
Object.StatusbarElementText[=STRING]
Object
● AlarmControl
STRING
Optional. A value or a constant that specifies the text of the selected element of the status bar.
See also

VB scripting
StatusbarElementTooltipText (RT Professional)
Description
Specifies the text for the tooltip of a user-defined status bar element referenced with
Syntax
Object.StatusbarElementTooltipText[=STRING]
Object
● AlarmControl
STRING
Optional. A value or a constant that specifies the tooltip text for the selected user-defined status
bar element.
See also
StatusbarElementUserDefined (RT Professional)
Description
Specifies whether the configuration engineer has added a status bar element referenced with
"StatusbarElementIndex" as a new user-defined element.

VB scripting
Syntax
Object.StatusbarElementUserDefined[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
Optional.
TRUE if the status bar element is user-defined.
FALSE if the status bar element is specified by the system.
See also
StatusbarElementVisible (RT Professional)
Description
Specifies whether the status bar element referenced with "StatusbarElementIndex" is
displayed in the object.
Syntax
Object.StatusbarElementVisible[=BOOLEAN]

VB scripting
Object
● AlarmControl
BOOLEAN
Optional. TRUE if the referenced status bar element is displayed.
See also
StatusbarElementWidth (RT Professional)
Description
Specifies the width in pixels of a status bar element referenced with "StatusbarElementIndex".
Also set "StatusbarElementAutoSize (Page 963)" to "FALSE".
Syntax
Object.StatusbarElementWidth[=Int32]
Object
● AlarmControl

VB scripting
Int32
Optional. A value or constant that specifies the width of the referenced status bar element in
pixels.
See also
StatusbarFont (RT Professional)
Description
Specifies the font of the texts in the status bar.
Syntax
Object.StatusbarFont[=Font]
Object
● AlarmControl
Font
Optional. A value or constant that specifies the font of the texts in the status bar.

VB scripting
See also
StatusbarFontColor (RT Professional)
Description
Specifies the color of the texts in the status bar.
Syntax
Object.StatusbarFontColor[=Color]
Object
● AlarmControl
Color
Optional. A value or constant that specifies the color of the texts in the status bar.
Comments
RGB (255, 0, 0)

VB scripting
See also
StatusbarShowTooltips (RT Professional)
Description
Specifies whether tooltips are displayed for the elements of the status bar in runtime.
Syntax
Object.StatusbarShowTooltips[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
Optional.
TRUE if the tooltips are shown.
FALSE if the tooltips are not shown.
See also

VB scripting

StatusbarText (RT Professional)
Description
Specifies the default text in the status bar.
Syntax
Object.StatusbarText[=STRING]
Object
● AlarmControl
STRING
Optional A value or a constant that specifies the default text in the status bar.
See also
StatusbarUseBackColor (RT Professional)
Description
Specifies whether the background color of the status bar is shown.

VB scripting
Syntax
Object.StatusbarUseBackColor[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
Optional.
TRUE if the background color of the status bar is displayed.
FALSE if the background color of the status bar is not displayed.
See also
StatusbarVisible (RT Professional)
Description
Specifies whether the status bar of the control is displayed.
Syntax
Object.StatusbarVisible[=BOOLEAN]

VB scripting
Object
● AlarmControl
BOOLEAN
Optional.
TRUE if the status bar is displayed.
FALSE if the status bar is not displayed.
See also
StatuslineFont (RT Advanced)
Description
StepBackColor (RT Professional)
Description
Specifies the background color of the step.
Syntax
Object.StepBackColor[=Color]

VB scripting
Object
● S7GraphOverview
Color
Optional. A value or a constant that specifies the background color of the step.
Comments
RGB (255, 0, 0)
See also
StepFont (RT Professional)
Description
Specifies the font color of the step.
Syntax
Object.StepFont[=Font]
Object
● S7GraphOverview
Font
See also

VB scripting
StepSeconds (RT Professional)
Description
Specifies the step interval in seconds after actuating the "Forward" or "Backward" button.
Syntax
Object.StepSeconds[=Int32]
Object
● MediaPlayer
Int32
Optional. A value or a constant that specifies the step interval in seconds after actuating the
"Forward" or "Backward" button.
See also
StepTextColor (RT Professional)
Description
Specifies the text color of the step.
Syntax
Object.StepTextColor[=Color]
Object
● S7GraphOverview
Color
Optional. A value or a constant that specifies the background color of the step.

VB scripting
Comments
RGB (255, 0, 0)
See also
Style (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the line style.
Syntax
Object.Style[=LineStyle]
Object
● CircularArc
● Connector
● EllipticalArc
● Line
● Polyline
LineStyle
Optional. A value or a constant that specifies the line style. Value range from 0 to 4.

1 hmiLineStyleDash Dashed line
2 hmiLineStyleDot Dotted line
3 hmiLineStyleDashDot Dash-dot line
4 hmiLineStyleDashDotDot Dash-dot-dot line

VB scripting
StyleItem (RT Professional)
Description
StyleSettings (RT Professional)
Description
Specifies the style in which the object is displayed.
Syntax
Object.StyleSettings[=WinCCStyle]
Object
● Button
● RoundButton*
● Window Slider*
*: Read access only
WinCCStyle
Optional. A value or a constant that specifies the style in which the object is displayed.

0 User Defined Specifies that the object is displayed according to your settings.
1 Global Specifies that the object is displayed in the globally set design.
2 Windows Style Specifies that the object is displayed in the Windows style.
SupportsInplaceEdit (RT Professional)
Description
SupportsS7DiagnosticsInSimpleView (RT Advanced)
Description

VB scripting
SupportsUserDefinedToolbarButtons (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
SwapFirstWithLastConnection (RT Professional)
Description
Specifies that the first and last connection should be swapped.
Syntax
Object.SwapFirstWithLastConnection[=Boolean]
Object
● Connector
Boolean
Optional. A value or a constant which specifies that the first and last connection are swapped.
See also
SwitchOrientation (RT Advanced)
Description
SymbolTableFont (RT Professional)
Description
Specifies the font of the symbol table in the PLC code display.
Syntax
Object.SymbolTableFont[=Font]

VB scripting
Object
● PLCCodeViewer
Font
Optional. A value or a constant that specifies the font in the symbol table in the PLC code
display.
See also
SysDiagBuffButtonVisible (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
1.5.5.13 Properties T (Panels, Comfort Panels, RT Advanced, RT Professional)
TabIndex (RT Professional)
Description
Specifies the position that the object takes in the order if you toggle between the objects with
the tabulator key in Alpha-Cursor mode.
Access in runtime:
Syntax
Object.TabIndex[=Int32]
Object
● DiscSpaceView
●
Int32
Optional. A value or a constant which specifies the position in the tabulator order.

VB scripting
TabIndexAlpha (RT Professional)
Description
Specifies the position that the object takes in the order if you toggle between the objects with
the tabulator key in Alpha-Cursor mode.
Access in runtime:
Syntax
Object.TabIndexAlpha[=Int32]
Object
● DiscSpaceView
● AlarmControl
● AlarmView
● Bar
● BatteryView
● Button
● ChannelDiagnose
● CheckBox
● Circle
● CircleSegment
● CircularArc
● Clock
● ComboBox
● Connector
● DateTimeField
● Ellipse
● EllipseSegment
● EllipticalArc
● Gauge

VB scripting
● GraphicIOField
● GraphicView
● HTMLBrowser
● IOField
● Line
● ListBox
● MediaPlayer
● MultiLineEdit
● OptionGroup
● PLCCodeViewer
● Polygon
● Polyline
● RangeLabelView
● RecipeView
● Rectangle
● RoundButton
● S7GraphOverview
● ScreenWindow
● Slider
● SmartClientView
● StatusForce
● Switch
● SymbolLibrary
● SymbolicIOField
● SysDiagControl
● TextField
● TrendView
● TubeArcObject
● TubeTeeObject

VB scripting
● Tubepolyline
● UserView
● WLanQualityView
● WindowsSlider
● ZoneLabelView
● ZoneQualityView
Int32
Optional. A value or a constant which specifies the position in the tabulator order.
TableBackColor (RT Advanced)
Description
Specifies the background color of the table cells.
Syntax
Object.TableBackColor[=Color]
Object
● AlarmView
● RecipeView*
● StatusForce
● TrendView
● UserView
*: Read access only
Color
Optional. A value or constant which determines the background color of the table cells.
Comments
RGB (255, 0, 0)

VB scripting
TableColor (RT Professional)
Description
Specifies the background color of the table rows in the object.
Syntax
Object.TableColor[=Color]
Object
● AlarmControl
Color
Optional. A value or constant that specifies the background color of the table rows.
Comments
RGB (255, 0, 0)
See also
TableColor2 (RT Professional)
Description
Specifies the second background color of the table rows in the object.
Also set "UseTableColor2 (Page 1160)" to "TRUE".

VB scripting
Syntax
Object.TableColor2[=Color]
Object
● AlarmControl
Color
Optional. A value or constant that specifies the second background color of the table rows.
Comments
RGB (255, 0, 0)
See also
TableColumnsWidthAndOrder (RT Advanced)
Description
TableEvenRowBackColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Description

VB scripting
TableFont (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
TableForeColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the text color used in the table cells of the object.
Syntax
Object.TableForeColor[=Color]
Object
● AlarmControl
● AlarmView
● RecipeView*
● StatusForce
● UserView
*: Read access only
Color
Optional. A value or a constant that specifies the text color used in the table cells.
Comments
RGB (255, 0, 0)

VB scripting
TableForeColor2 (RT Professional)
Description
Specifies the second text color used in the table cells of the object.
Also set "UseTableColor2 (Page 1160)" to "TRUE".
Syntax
Object.TableForeColor2[=Color]
Object
● AlarmControl
Color
Optional. A value or a constant that specifies the second font color used in the table cells.
Comments
RGB (255, 0, 0)
See also
TableGridLineColor (RT Advanced)
Description
Specifies the color of the grid lines in the table.

VB scripting
Access in runtime:
Syntax
Object.TableGridLineColor[=Color]
Object
● RecipeView*
● TrendView*
● UserView
*: Read access only

● StatusForce
● SysDiagControl
Color
Optional. A value or constant which determines the color of the gridlines of the table.
Comments
RGB (255, 0, 0)
TableHeaderBackColor (RT Advanced)
Description
Specifies the background color in the header of the table.
Syntax
Object.TableHeaderBackColor[=Color]

VB scripting
Object
● AlarmView
● RecipeView*
● StatusForce
● TrendView*
● UserView
*: Read access only
Color
Optional. A value or a constant that specifies the background color in the header.
Comments
RGB (255, 0, 0)
TableHeaderBackFillStyle (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
TableHeaderBorderBackColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
TableHeaderBorderColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Description

VB scripting
TableHeaderBorderWidth (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
TableHeaderCornerRadius (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
TableHeaderEdgeStyle (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
TableHeaderFirstGradientColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
TableHeaderFirstGradientOffset (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
TableHeaderFont (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
TableHeaderForeColor (RT Advanced)
Description
Specifies the text color in the header of the table.

VB scripting
Syntax
Object.TableHeaderForeColor[=Color]
Object
● AlarmView
● RecipeView*
● StatusForce*
● TrendView*
● UserView
*: Read access only
Color
Optional. A value or a constant that specifies the text color in the header.
Comments
RGB (255, 0, 0)
TableHeaderMiddleGradientColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
TableHeaderPaddingBottom (RT Advanced)
Description
TableHeaderPaddingLeft (RT Advanced)
Description

VB scripting
TableHeaderPaddingRight (RT Advanced)
Description
TableHeaderPaddingTop (RT Advanced)
Description
TableHeaderSecondGradientColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
TableHeaderSecondGradientOffset (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Tag4DataRecord (RT Advanced)
Description
Tag4RecipeNumber (RT Advanced)
Description
TagForExternalTime (RT Advanced)
Description

VB scripting
TagPrefix (RT Professional)
Description
Specifies the tag prefix that is prefixed for all tags contained in the screen window. In this way,
a screen that is embedded in a screen window retains access to its own tags while another
accesses other tags.
The change to the tag prefix does not become effective until the screen is reloaded. The change
is effected automatically during a screen change. Without screen change the change is only
effect if the screen name is re-assigned.
The prefix is freely definable but must match the name of the structure tag.
Note
Assigning a user data type
You can also select a user data type for a screen that is integrated in a screen window.
Afterwards, the data type elements are assigned directly from the selected user data type.
Note
Tag prefix versus indirectly addressed tags
Avoid use of tag prefixes and indirectly addressed tags at the same time.
Syntax
Object.TagPrefix[= STRING]
Object
● ScreenWindow
STRING
Optional. A value or a constant that specifies the tag prefix.
Example
The "InOutput" screen should be displayed in the screen window. The "InOutput" screen
contains three I/O fields that are linked to a structure tag. The structure tag consists of the
elements .IO1, .IO2, .IO3; one element for each I/O field. The element name is preceded by
a period. The period is necessary for addressing the elements of the structure tags as structure
elements with the correct syntax.
Three such structure tags with the structure names Struct1, Struct2 and Struct3 are defined
in the project, for example.
In this case, the tag prefix is the structure name. Specify "Struct2" as tag prefix, for example.
The I/O fields in the "InOutput" screen are then linked to the elements of structure tag "Struct2".

VB scripting
Tag prefix: "Struct2":

● Output value (first IO field): .IO1
● Output value (second IO field): .IO2
● Output value (third IO field): .IO3
The current tag connection in the screen window:
● Output value (first I/O field): Struct2.EA1
● Output value (second I/O field): Struct2.EA2
● Output value (third I/O field): Struct2.EA3
See also
Tags (RT Professional)
Description
Returns an object of type "Tags".
Syntax
Object.Tags
Object
Necessary. An object of the "HMIRuntime" type.
Example
The following example accesses the tag "Tag1":
'VBS86
Dim objTag
See also

VB scripting
TcpPortNr (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Template (RT Professional)
Description
Specifies the template for displaying the window content in the "Print job/Script diagnostic"
object.
Syntax
Object.Template[=TemplateType]
Object
TemplateType
Optional. A value or a constant that specifies the template.
The following templates are possible depending on the value of the property
"WindowsContents (Page 1225)":
Window Contents = Global Script

● "GSC diagnostics"
The "Script diagnostic" object is supplied by applications of the Global Script. The results
of the diagnosis system are displayed.
● "GSC Runtime"
The "Script diagnostic" object is supplied by applications of the Global Script. The analysis
results regarding characteristics in Runtime are displayed.
Window Contents = Print Jobs

● "All Jobs":
The "Print job" object is supplied by the logging system. The available reports are displayed
as a list.
● "All Jobs - Context Menu":
as a list. The shortcut menu enables the selection of print options, display of a print preview
as well as a printout of the log.

VB scripting
● "Job Detail View":

in a selection menu. Detailed information is displayed for the selected report.
● "Selected Jobs - Context Menu":
as a list. This list only contains reports which you have activated the option "Mark for print
job list" in the "Print Job Properties" dialog. The shortcut menu enables the selection of
print options, display of a print preview as well as a printout of the log.
See also
Text (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the label for the text field.
Syntax
Object.Text[=STRING]
Object
● CheckBox
● ComboBox
● ListBox
● MultiLineEdit
● OptionGroup
● RoundButton
● TextField
STRING
Optional. A value or a constant that specifies the labeling.
TextAreaBottomMargin (Panels, Comfort Panels, RT Advanced, RT Professional)
Description

VB scripting
TextAreaLeftMargin (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
TextAreaRightMargin (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
TextAreaTopMargin (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
TextHandles (RT Professional)
Description
TextList (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Returns the text list that supplies the object with values.
Access in runtime
Syntax
Object.TextList[=HmiObjectHandle]
Object
● SymbolicIOField
You have no access in runtime with the following formats:
● Button

VB scripting
HmiObjectHandle
Optional. A value or a constant that returns the text list that supplies the object with values.
See also
Button (Page 265)
TextOff (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the text that will be displayed in the "Off" status.
Syntax
Obje ct.TextOff[=STRING]
Object
● Button
● Switch*
* RT Advanced read access only, RT Professional no access

● SymbolicIOField
STRING
Optional. A value or a constant that specifies the labeling for the "off" status.
Comments
The property is only available if the referenced object is of the "Text" type.
TextOn (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the text that will be displayed in the "On" status.

VB scripting
Syntax
Object.TextOn[=STRING]
Object
● Button
● Switch*
* RT Advanced read access only, RT Professional no access

● SymbolicIOField
STRING
Optional. A value or a constant that specifies the labeling for the "on" status.
Comments
The property is only available if the referenced object is of the "Text" type.
TextOrientation (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the text orientation.
Access in runtime:
Syntax
Object.TextOrientation[=TextOrientation]
Object
● Button
● CheckBox
● IOField
● OptionGroup
● RoundButton*

VB scripting
● TextField
● WindowSlider*
*: Read access only
● DateTimeField
● Switch
TextOrientation
Optional. A value or a constant that specifies the text orientation.

0 hmiTextHorizontal The text is shown horizontally.
-1 hmiTextRotated90Degree The text is shown vertically and left-justified.
1 hmiTextRotated270Degree The text is shown vertically and right-justified.
Texts (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
TextualObjectPositions (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
TextualObjectsAutoSize (RT Advanced)
Description
TextualObjectsBorderBackColor (RT Advanced)
Description

VB scripting
TextualObjectsBorderColor (RT Advanced)
Description
TextualObjectsBorderWidth (RT Advanced)
Description
TextualObjectsCornerRadius (RT Advanced)
Description
TextualObjectsEdgeStyle (RT Advanced)
Description
TextualObjectsPaddingBottom (RT Advanced)
Description
TextualObjectsPaddingLeft (RT Advanced)
Description
TextualObjectsPaddingRight (RT Advanced)
Description

VB scripting
TextualObjectsPaddingTop (RT Advanced)
Description
ThumbBackColor (RT Professional)
Description
Specifies the background color of the slider.
Syntax
Object.ThumbBackColor[=Color]
Object
● Slider
● WindowSlider
Color
Optional. A value or a constant that specifies the background color of the slider.
Comments
RGB (255, 0, 0)
See also
Slider (Page 409)
ThumbPicture (RT Professional)
Description
Specifies a graphic for the slider element in the slider.

VB scripting
Syntax
Object.ThumbPicture[=HmiObjectHandle]
Object
● Slider
HmiObjectHandle
Optional. A value or constant that specifies the graphic for the slider element in the slider.
See also
Slider (Page 409)
TickDistance (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
TicksColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the color of the hour markers on the face of the "Clock" object.
Syntax
Object.TicksColor[=Color]
Object
● Clock
Color
Optional. A value or a constant that specifies the color of the hour markers.

VB scripting
Comments
RGB (255, 0, 0)
See also
Clock (Page 286)
TickStyle (RT Professional)
Description
Specifies how the marks are displayed in the scale.
Also set "ShowTicks" to "TRUE".
Access in runtime:
Syntax
Object.TickStyle[=SliderTickStyle]
Object
● Slider
● Clock
SliderTickStyle
Optional. A value or a constant that specifies how the marks are displayed in the scale.

0 hmiSliderTickStyleNone The scale has no marks.
1 hmiSliderTickStyleEffect1 The large scale marks are shown in white with black
shadow marks. The small scale marks are shown in
black.
2 hmiSliderTickStyleEffect2 The large scale marks are shown in black with white
shadow marks. The small scale marks are shown in
black.
3 hmiSliderTickStyleNormal All scale marks are shown in black.

VB scripting
Comments
Automatic scaling can show two marks in the scale so close together that they look like one
broad mark. To correct this effect, lengthen or shorten the slider.
TimeAxes (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
TimeAxisAdd (RT Professional)
Description
Creates a new time axis. The newly created time axis is automatically referenced with
"TimeAxisIndex".
Syntax
Object.TimeAxisAdd[=STRING]
Object
STRING
Required. A value or a constant that specifies the name of the new time axis with
"TimeAxisName".
TimeAxisAlignment (RT Professional)
Description
Specifies the alignment of the time axis.
Syntax
Object.TimeAxisAlignment[=AxisAlignment]

VB scripting
Object
AxisAlignment
Optional. A value or a constant that specifies the alignment.

0 Bottom The time axis selected is displayed below the trend.
1 Top The time axis selected is displayed above the trend.
See also
TimeAxisBegin (RT Advanced)
Description
TimeAxisBeginTime (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the start time for the display of the time axis referenced with "TimeAxisIndex".
Access in runtime:
Syntax
Object.TimeAxisBeginTime[=DateTime]
Object
● TrendView
DateTime
Optional. A value or a constant that specifies the start time for the display of the specified trend.

VB scripting
TimeAxisColor (RT Professional)
Description
Specifies the color of the time axis referenced with "TimeAxisIndex".
Syntax
Object.TimeAxisColor[=Color]
Object
Color
Optional. A value or a constant that specifies the color of the time axis.
Comments
RGB (255, 0, 0)
See also
TimeAxisCount (RT Professional)
Description
Specifies the number of configured time axes.
Syntax
Object.TimeAxisCount[=Int32]
Object

VB scripting
Int32
Optional. A value or a constant that specifies the number of configured time axes.
See also
TimeAxisCountPoints (RT Advanced)
Description
TimeAxisDateFormat (RT Professional)
Description
Specifies the date format for displaying the time axis referenced with "TimeAxisIndex".
Syntax
Object.TimeAxisDateFormat[=STRING]
Object
STRING
Optional. A value or a constant that specifies the date format.
See also
TimeAxisEnd (RT Advanced)
Description

VB scripting
TimeAxisEndTime (RT Professional)
Description
Specifies the end time for the display of the selected trend. Whether or not the information is
evaluated depends on the "Autorange", "UseTimeRange(i)" and "ShareTimeAxis" properties.
Syntax
Object.TimeAxisEndTime[=DateTime]
Object
DateTime
Optional A value or a constant that specifies the end time for the display of the specified trend.
See also
TimeAxisIndex (RT Professional)
Description
References a time axis. To access the properties of a time axis, you need to set
""TimeAxisIndex"".
Values between 0 and "TimeAxisIndex" minus 1 are valid for "TimeAxisCount". The
"TimeAxisCount" property specifies the number of configured time axes.
Syntax
Object.TimeAxisIndex[=Int32]
Object
Int32
Optional. A value or a constant that specifies, with the index, the time axis to be edited.

VB scripting
See also
TimeAxisCount (Page 1013)
TimeAxisInTrendColor (RT Professional)
Description
Specifies whether the color of the time axis referenced with "TimeAxisIndex" corresponds to
the trend color.
Syntax
Object.TimeAxisInTrendColor[=BOOLEAN]
Object
BOOLEAN
Optional.
TRUE if the referenced axis is shown in the trend color. The value of "TimeAxisColor" is not
effective.
FALSE if the referenced axis is shown in the color specified in "TimeAxisColor".
See also
TimeAxisIndex (Page 1015)
TimeAxisLabel (RT Professional)
Description
Specifies the label text for a time axis referenced with "TimeAxisIndex".
Syntax
Object.TimeAxisLabel[=STRING]

VB scripting
Object
STRING
Optional. A value or a constant that specifies the label text for the referenced time axis.
See also
TimeAxisMeasurePoints (RT Professional)
Description
Specifies the number of measuring points displayed for the time axis referenced with
"TimeAxisIndex".
Syntax
Object.TimeAxisMeasurePoints[=Int32]
Object
Int32
Optional. A value or a constant that specifies the number of measurement points.
See also
TimeAxisMode (RT Advanced)
Description

VB scripting
TimeAxisName (RT Professional)
Description
Specifies the name of a time axis referenced with "TimeAxisIndex".
Syntax
Object.TimeAxisName[=STRING]
Object
STRING
Optional. A value or a constant that specifies the name of the referenced time axis.
See also
TimeAxisOnline (RT Professional)
Description
Specifies that the time axis is updated on an ongoing basis.
Syntax
Object.TimeAxisOnline[=BOOLEAN]
Object
BOOLEAN
Optional.
TRUE, if the time axis is updated on an ongoing basis.
FALSE, if the time axis is not updated on an ongoing basis.

VB scripting
See also
TimeAxisRange (RT Advanced)
Description
TimeAxisRangeType (RT Professional)
Description
Defines the time range setting for the time axis referenced with "TimeAxisIndex".
Syntax
Object.TimeAxisRangeType[=TimeRangeMode]
Object
TimeRangeMode
Optional. A value or a constant that specifies the settings for the time range.

0 Time span Start time and time range are specified for the time column.
1 End time Start time and end time are specified for the time column.
2 Measurement points Defines the start time and the number of measurement points
for the time column.
See also
TimeAxisRemove (RT Professional)
Description
Removes a time axis referenced with its name.

VB scripting
Syntax
Object.TimeAxisRemove[=STRING]
Object
STRING
Optional. A value or a constant that returns the name of the referenced time axis to be removed.
See also
TimeAxisRename (RT Professional)
Description
Specifies the new name of a time axis referenced with "TimeAxisIndex".
Syntax
Object.TimeAxisRename[=STRING]
Object
STRING
Optional. A value or a constant that specifies the new name of the selected time axis.
See also

VB scripting
TimeAxisRepos (RT Professional)
Description
Specifies the position of a time axis referenced with "TimeAxisIndex" in the trend diagram of
the object.
If you have changed the position of the time axis with "TimeAxisRepos", "TimeAxisIndex" is
assigned the value of "TimeAxisRepos".
Syntax
Object.TimeAxisRepos[=Int32]
Object
Int32
Optional. A value or a constant that specifies the position of the referenced time axis. Value
range from 0 to "TimeAxisCount" minus 1. Values outside this range have no effect.
0: The referenced time axis is positioned outside.
See also
TimeAxisShowDate (RT Professional)
Description
Specifies whether the time axis referenced with "TimeAxisIndex" is displayed with date and
time.
Syntax
Object.TimeAxisShowDate[=BOOLEAN]
Object

VB scripting
BOOLEAN
Optional.
TRUE, if date and time are displayed. The date format is specified using the
"TimeAxisDateFormat" property.
FALSE, if the date is not displayed. Only the time is displayed.
See also
TimeAxisSide (RT Advanced)
Description
TimeAxisTimeFormat (RT Professional)
Description
Specifies the format of the information along the time axis for the selected trend.
Syntax
Object.TimeAxisTimeFormat[=STRING]
Object
STRING
Optional. A value or a constant which defines the format for the time axis.
See also
TimeAxisTimeRange (RT Advanced)
Description

VB scripting
TimeAxisTimeRangeBase (RT Professional)
Description
Specifies the time unit that defines the time range together with the time factor
"TimeAxisTimeRangeFactor".
Syntax
Object.TimeAxisTimeRangeBase[=TagLoggingTimeUnit]
Object
TagLoggingTimeUnit
Optional. A value or a constant that specifies the time unit.
Value Designation
500 500 ms
1000 1 second
60000 1 minute
3600000 1 hour
86400000 1 day
See also
TimeAxisTimeRangeFactor (RT Professional)
Description
Specifies the time factor that together with time unit "TimeAxisTimeRangeBase" determines
the time period.
Syntax
Object.TimeAxisTimeRangeFactor[=Int16]

VB scripting
Object
Int16
Optional. A value or a constant that specifies the time factor.
See also
TimeAxisTrendWindow (RT Professional)
Description
Specifies the trend diagram in which the axis referenced with "TimeAxisIndex" is displayed.
Syntax
Object.TimeAxisTrendWindow[=STRING]
Object
STRING
Optional. A value or a constant that specifies the name of the trend diagram.
See also
TrendWindowCount (Page 1129)
TimeAxisVisible (RT Professional)
Description
Specifies whether the time axis referenced with "TimeAxisIndex" is displayed in the object.

VB scripting
Syntax
Object.TimeAxisVisible[=BOOLEAN]
Object
BOOLEAN
Optional.
TRUE if the referenced time axis is shown.
FALSE if the referenced time axis is hidden.
See also
TimeBase (RT Professional)
Description
Specifies the time zone in which the time values are displayed.
Syntax
Object.TimeBase[=TimeBase]
Object
● AlarmControl

VB scripting
TimeBase
Optional. A value or a constant that specifies the time zone.

0 hmiTimeBaseLocalTime‐ Local time
zone
1 hmiTimeBaseServerTi‐ Time zone of the server
mezone
2 hmiTimeBaseUTC UTC (Universal Time Coordinated)
3 hmiTimeBaseProjectSet‐ Project settings
ting
Comments
You can specify the time mode for a particular HMI device in the project tree, in the object
properties of the HMI device.
See also
TimeColumnActualize (RT Professional)
Description
Specifies whether the values of the time column referenced with "TimeColumnIndex" are
updated.
Syntax
Object.TimeColumnActualize[=BOOLEAN]
Object
BOOLEAN
Optional.
TRUE if the time column is updated.

VB scripting
FALSE if the time column is not updated. This setting is useful for comparing tables.
See also
TimeColumnAdd (RT Professional)
Description
Creates a new time column. The newly created time column is automatically referenced with
"TimeColumnIndex".
Syntax
Object.TimeColumnAdd[=STRING]
Object
STRING
Required. A value or a constant that specifies the name of the new time column with
"TimeColumnName".
See also
TimeColumnIndex (Page 1034)
TimeColumnAlignment (RT Professional)
Description
Specifies how the text in the time column referenced with "TimeColumnIndex" is aligned.
Syntax
Object.TimeColumnAlignment [=HorizontalAlignment]

VB scripting
Object
HorizontalAlignment
Optional. A value or a constant that specifies how the text in the referenced time column is
aligned.

1 hmiAlignmentCentered The text is centered.
2 hmiAlignmentRight The text is right-justified.
See also
TimeColumnBackColor (RT Professional)
Description
Specifies the background color of the time column referenced with "TimeColumnIndex".
Also set "UseColumnBackColor (Page 1149)" to "TRUE" and
"TimeColumnUseValueColumnColors (Page 1044)" to "FALSE".
Syntax
Object.TimeColumnBackColor[=Color]
Object
Color
Optional. A value or a constant that specifies the background color of the selected time column.
Comments
RGB (255, 0, 0)

VB scripting
See also
TimeColumnBeginTime (RT Professional)
Description
Specifies the start of the time range for the time column referenced with "TimeColumnIndex".
Syntax
Object.TimeColumnBeginTime[=DateTime]
Object
DateTime
Optional. A value or a constant that specifies the starting time for the selected time column.
See also
TimeColumnCaption (RT Professional)
Description
Specifies the label of the time column referenced with "TimeColumnIndex".
Syntax
Object.TimeColumnCaption[=STRING]
Object
STRING
Optional. A value or a constant that specifies the caption of the time column.

VB scripting
See also
TimeColumnCount (RT Professional)
Description
Specifies the number of configured time columns.
Syntax
Object.TimeColumnCount[=Int32]
Object
Int32
Optional A value or a constant that specifies the number of configured time columns.
See also
TimeColumnDateFormat (RT Professional)
Description
Specifies the date format for displaying the time column referenced with "TimeColumnIndex".
Syntax
Object.TimeColumnDateFormat[=STRING]
Object
STRING
Optional. A value or a constant that specifies the date format for displaying the selected time
column.

VB scripting
The following date formats are available:
Value Explanation
dd.MM.yy Day.Month.Year, e.g., 24.12.13.
dd.yyyyd.MM Day.Month.Year, e.g., 24.12.2013.
dd/MM/yy Day/Month/Year, e.g., 24/12/13.
dd/MM/yyyy Day/Month/Year, e.g., 24/12/2013.
TimeColumnEndTime (RT Professional)
Description
Defines the end of the time range of for a time column referenced with "TimeColumnIndex".
Syntax
Object.TimeColumnBeginTime[=DateTime]
Object
DateTime
Optional. A value or constant that specifies the end time.
See also
TimeColumnForeColor (RT Professional)
Description
Specifies the font color of the time column referenced with "TimeColumnIndex".
Also set "UseColumnForeColor (Page 1149)" to "TRUE" and
"TimeColumnUseValueColumnColors (Page 1044)" to "FALSE".
Syntax
Object.TimeColumnForeColor[=Color]

VB scripting
Object
Color
Optional. A value or a constant that specifies the font color of the selected time column.
Comments
RGB (255, 0, 0)
See also
TimeColumnHideText (RT Professional)
Description
Specifies whether the content of the time column referenced with "TimeColumnIndex" is
displayed as text.
Syntax
Object.TimeColumnHideText[=BOOLEAN]
Object
BOOLEAN
Optional.
TRUE if the content is not displayed as text.
FALSE if the content is displayed as text.
See also

VB scripting
TimeColumnHideTitleText (RT Professional)
Description
Specifies whether the header of the time column referenced with "TimeColumnIndex" is
displayed as text.
Syntax
Object.TimeColumnHideTitleText[=BOOLEAN]
Object
BOOLEAN
Optional.
TRUE if the header is not displayed as text.
FALSE if the header is displayed as text.
See also
TimeColumnIndex (RT Professional)
Description
References a configured time column. To access the properties of a time column, you need
to set ""TimeColumnIndex"".
Values between 0 and "TimeColumnCount" minus 1 are valid for "TimeColumnIndex". The
property "TimeColumnCount" specifies the number of configured time columns.
Syntax
Object.TimeColumnIndex[=Int32]
Object

VB scripting
Int32
Optional. A value or a constant that specifies, with the index, the time column to be edited.
TimeColumnLength (RT Professional)
Description
Specifies the width of the time column referenced with "TimeColumnIndex".
Syntax
Object.TimeColumnLength[=Int32]
Object
Int32
Optional. A value or a constant that specifies the width of the selected time column.
See also
TimeColumnMeasurePoints (RT Professional)
Description
Specifies the number of measuring points to be displayed in the time column referenced with
"TimeColumnIndex".
Syntax
Object.TimeColumnMeasurePoints[=Int32]
Object
Int32
Optional. A value or constant that specifies the number of measurement points.

VB scripting
See also
TimeColumnName (RT Professional)
Description
Specifies the name of a time column referenced with "TimeColumnIndex".
Syntax
Object.TimeColumnName[=STRING]
Object
STRING
Optional. A value or a constant that specifies the name of the referenced time column.
See also
TimeColumnRangeType (RT Professional)
Description
Specifies the time range for a time column referenced with "TimeColumnIndex".
Syntax
Object.TimeColumnRangeType[=TimeRangeMode]
Object

VB scripting
TimeRangeMode
Optional. A value or a constant that specifies the time range for the selected time column.

0 Time range Start time and time range are specified for the time column.
1 Start to end time Start time and end time are specified for the time column.
2 Number of measurement Defines the start time and the number of measurement points
points for the time column.
See also
TimeColumnRemove (RT Professional)
Description
Removes a time column referenced with its name.
Syntax
Object.TimeColumnRemove[=STRING]
Object
STRING
Optional. A value or a constant that returns the name of the referenced time column to be
removed.
See also
TimeColumnRename (RT Professional)
Description
Specifies the new name of a time column referenced with "TimeColumnIndex".

VB scripting
Syntax
Object.TimeColumnRename[=STRING]
Object
STRING
Optional. A value or a constant that specifies the new name of the selected time column.
See also
TimeColumnRepos (RT Professional)
Description
For multiple time columns with corresponding value columns, specifies the position of a time
column referenced with "TimeColumnIndex".
If you have changed the position of the time column with "TimeColumnRepos",
"TimeColumnIndex" is assigned the value of "TimeColumnRepos".
Syntax
Object.TimeColumnRepos[=Int32]
Object
Int32
Optional. A value or a constant that specifies the position of the referenced time column with
the corresponding value columns. Value range from 0 to "TimeColumnCount" minus 1. Values
outside this range have no effect.
0: The referenced time column is positioned on the left.

VB scripting
See also
TimeColumnCount (Page 1030)
TimeColumns (RT Professional)
Description
TimeColumnShowDate (RT Professional)
Description
Specifies whether the time column referenced with "TimeColumnIndex" is displayed with date
and time.
Also set the date format with "TimeColumnDateFormat (Page 1030)".
Syntax
Object.TimeColumnShowDate[=BOOLEAN]
Object
BOOLEAN
Optional.
TRUE, if date and time are displayed.
FALSE if only the time is displayed.
See also

VB scripting
TimeColumnShowIcon (RT Professional)
Description
Specifies whether the content of the time column referenced with "TimeColumnIndex" is
Syntax
Object. [=BOOLEAN]
Object
BOOLEAN
Optional.
TRUE if the content is displayed as an icon.
FALSE if the content is not displayed as an icon.
TimeColumnShowTitleIcon (RT Professional)
Description
Specifies whether the header of the time column referenced with "TimeColumnIndex" is
Syntax
Object.TimeColumnShowTitleIcon[=BOOLEAN]
Object
BOOLEAN
Optional.
TRUE if the header is shown as an icon.
FALSE if the header is not shown as an icon.

VB scripting
See also
TimeColumnSort (RT Professional)
Description
Specifies how a time column referenced with "TimeColumnIndex" is sorted.
Syntax
Object.TimeColumnSort[=SortMode]
Object
SortMode
Optional. A value or a constant that specifies how the time column referenced in
"TimeColumnIndex" is sorted.

0 No No sorting
1 Ascending Ascending order, starting at the lowest value.
2 Descending Descending order, starting at the highest value.
See also
TimeColumnSortIndex (RT Professional)
Description
Specifies the sorting order of the time column referenced by "TimeColumnIndex". If you set
the value to "0", the sorting criterion is removed in "TimeColumnSort".
Syntax
Object.TimeColumnSortIndex[=Int32]

VB scripting
Object
Int32
Optional. Value or constant that specifies the sorting order of the time column referenced by
"TimeColumnIndex". If you set the value to "0", the sorting criterion is removed in
"TimeColumnSort".
TimeColumnTimeFormat (RT Professional)
Description
Specifies the time format for displaying the time column referenced with "TimeColumnIndex".
Syntax
Object.TimeColumnTimeFormat[=STRING]
Object
STRING
Optional. A value or a constant that specifies the time format for displaying the selected time
column.
Value Explanation
HH:mm:ss.ms Hours:Minutes:Seconds, e.g. 15:35:44.240.
See also
TimeColumnTimeRangeBase (RT Professional)
Description
Specifies the time unit for calculating the time range displayed in the time column referenced
with "TimeColumnIndex".

VB scripting
The time range is calculated with a time unit and a time factor. The time factor is specified in
"TimeColumnTimeRangeFactor (Page 1043)".
Syntax
Object.TimeColumnTimeRangeBase[=TagLoggingTimeUnit]
Object
TagLoggingTimeUnit
Optional. A value or a constant that specifies the time unit for determining the time range.
Value Description
500 500 ms
1000 1 second
60000 1 minute
3600000 1 hour
86400000 1 day
See also
TimeColumnTimeRangeFactor (RT Professional)
Description
Defines the factor for calculating the time range. Only integer factors are valid.
Syntax
Object.TimeColumnTimeRangeFactor[=Int16]
Object
Int16
Optional A value or a constant that specifies the factor to determine the time range.

VB scripting
See also
TimeColumnUseValueColumnColors (RT Professional)
Description
Specifies whether the time column referenced with "TimeColumnIndex" is displayed in the
colors of the value column.
Syntax
Object.TimeColumnUseValueColumnColors[=BOOLEAN]
Object
BOOLEAN
Optional.
TRUE if the selected time column is displayed in the value column colors. The settings in
"TimeColumnBackColor (Page 1028)" and "TimeColumnForeColor (Page 1031)" are disabled.
FALSE if the selected time column is displayed in the colors specified in
"TimeColumnBackColor (Page 1028)" and "TimeColumnForeColor (Page 1031)"
See also
TimeColumnVisible (RT Professional)
Description
Specifies whether the time column referenced with "TimeColumnIndex" is displayed in the
table view.
Syntax
Object.TimeColumnVisible[=BOOLEAN]

VB scripting
Object
BOOLEAN
Optional.
TRUE if the referenced time column is displayed in the table.
FALSE if the referenced time column is not displayed in the table.
See also
TimeDisplayMode (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
TimeStamp (RT Professional)
Description
Returns the time stamp of the last read access of a tag in local time as DATE.
Syntax
Object.TimeStamp
Object
Required A "Tag" object.
Comments
To show the TimeStamp property in plain text, use the VBS function "FormatDateTime(Date[,
NamedFormat])". The output is dependent on the language setting. To adjust the language,
use the VBS function "SetLocale´()".
If you want to return the time stamp sorted by date, day and time, use the NamedFormat
parameter or the VBS functions like Year, WeekDay, Day, Hour, Minute, Second. The name
of a week day can be obtained using the VBS function WeekdayName.

VB scripting
Examples
The following example issues the time stamp of the tag "Tag11" with the aid of the function
"FormatDateTime":
'VBS87
Dim objTag
Dim lngCount
lngCount = 0
objTag.Read
SetLocale("en-gb")
MsgBox FormatDateTime(objTag.TimeStamp) 'Output: e.g. 06/08/2002 9:07:50
MsgBox Year(objTag.TimeStamp) 'Output: e.g. 2002
MsgBox Month(objTag.TimeStamp) 'Output: e.g. 8
MsgBox Weekday(objTag.TimeStamp) 'Output: e.g. 3
MsgBox WeekdayName(Weekday(objTag.TimeStamp)) 'Output: e.g. Tuesday
MsgBox Day(objTag.TimeStamp) 'Output: e.g. 6
MsgBox Hour(objTag.TimeStamp) 'Output: e.g. 9
MsgBox Minute(objTag.TimeStamp) 'Output: e.g. 7
MsgBox Second(objTag.TimeStamp) 'Output: e.g. 50
For lngCount = 0 To 4
MsgBox FormatDateTime(objTag.TimeStamp, lngCount)
Next
'lngCount = 0: Output: e.g. 06/08/2002 9:07:50
'lngCount = 1: Output: e.g. 06 August 2002
'lngCount = 2: Output: e.g. 06/08/2002
'lngCount = 3: Output: e.g. 9:07:50
'lngCount = 4: Output: e.g. 9:07
The following example issues the time stamp of the tag "Tag1":
'VBS88
Dim objTag
objTag.Read
MsgBox objTag.TimeStamp
See also
Tag (Page 227)
TimeStepBase (RT Professional)
Description
Specifies the time unit for the exactness of the time stamp displayed in the table. The exactness
is determined by multiplying the factor and time unit.

VB scripting
Syntax
Object.TimeStepBase[=TimeStepBase]
Object
TimeStepBase
Optional. A value or a constant that specifies the time unit for the exactness of the time stamp.

0 Exact Specifies that only values with exactly identical time stamp are displayed
within a row of the table.
1000 Base1s Specifies that the time range is the factor of the base with 1 ms.
100 Base100ms Specifies that the time range is the factor of the base with 100 ms.
See also
TimeStepFactor (RT Professional)
Description
Specifies the exactness of the time stamp that is formed with time unit "TimeStepBase".
You determine the exactness by multiplying the factor and time unit. For example, if you want
to display all values that occurred within 3 seconds in the same row, you enter "3" for the factor
and "Base1s" for the time unit.
The entered factor has no effect if "exact" is selected for the time unit.
Syntax
Object.TimeStepFactor[=Int32]
Object
Int32
Optional. A value or a constant that specifies the time factor for the exactness of the time stamp.

VB scripting
See also
TitleColor (RT Professional)
Description
Specifies the background color of the table header.
Syntax
Object.TitleColor[=Color]
Object
● AlarmControl
Color
Optional. A value or a constant that specifies the background color of the table header.
Comments
RGB (255, 0, 0)
See also

VB scripting
TitleCut (RT Professional)
Description
Specifies whether the content of the fields in a title bar is to be shortened if the column is too
narrow.
Syntax
Object.TitleCut[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
Optional TRUE if the column headers in the title bar are shortened if the column is too narrow.
See also
TitleDarkShadowColor (RT Professional)
Description
Specifies the color for the dark side of the 3D shading for column and row headers in the object
table.
Also set "TitleStyle (Page 1054)" to "1".
Syntax
Object.TitleDarkShadowColor[=Color]

VB scripting
Object
● AlarmControl
Color
Optional. A value or a constant that specifies the color for the dark side of the 3D shading.
Comments
RGB (255, 0, 0)
See also
TitleForeColor (RT Professional)
Description
Specifies the text color for the table column and row headers of the object.
Syntax
Object.TitleForeColor[=Color]
Object
● AlarmControl

VB scripting
Color
Optional. A value or constant that specifies the font color in the column and row headers of
the table.
Comments
You use the "RGB" function to define the color in RGB format (red, green, blue). Enter the
corresponding decimal value for each of the three RGB values (range from 0 to 255). The
"Red" color is displayed as follows, for example:
RGB (255, 0, 0)
See also
TitleGridLineColor (RT Professional)
Description
Specifies the color of the separation lines in the title bar of the table.
Syntax
Object.TitleGridLineColor[=Color]
Object
● AlarmControl
Color
Optional. A value or a constant that specifies the color of the separation lines in the title bar of
the table.

VB scripting
Comments
RGB (255, 0, 0)
See also
TitleLightShadowColor (RT Professional)
Description
Specifies the color for the light side of the 3D shading for table column and row headers of the
object.
Also set "TitleStyle (Page 1054)" to "1".
Syntax
Object.TitleLightShadowColor[=Color]
Object
● AlarmControl
Color
Optional. A value or a constant that specifies the color for the light side of the 3D shading.
Comments

VB scripting
RGB (255, 0, 0)
See also
TitleSort (RT Professional)
Description
Specifies how sorting by column header is triggered.
Syntax
Object.TitleSort[=GridSortTrigger]
Object
● AlarmControl
GridSortTrigger
Optional. A value or constant that specifies how to trigger sorting by column header.
Value Explanation
0 Sorting by column header is disabled.
1 Sorting is triggered by clicking in the column header.
2 Sorting is triggered by double-clicking in the column title.
See also

VB scripting
TitleStyle (RT Professional)
Description
Specifies whether to use a shading color for the text in the column headers.
Syntax
Object.TitleStyle[=GridHeaderStyle]
Object
● AlarmControl
GridHeaderStyle
Optional. A value or a constant that specifies whether the text in the columns headers is
displayed with shading.
Value Explanation
0 No shading color is used. Flat header style.
1 Enables the use of shading colors. 3D representation of the header.
See also
Toggle (RT Professional)
Description
Specifies whether the selected object engages after it has been operated in Runtime.
Syntax
Object.Toggle[=BOOLEAN]

VB scripting
Object
● Button
● RoundButton*
*: Read access only
BOOLEAN
Optional. TRUE, if the selected object engages after it has been operated in runtime.
Tolerance (RT Professional)
Description
Specifies the limit for the storage space display as of which a deviation will be reported.
Syntax
Object.Tolerance[=Int32]
Object
● DiscSpaceView
Int32
Optional. A value or a constant that specifies the limit for the disk space view as of which a
deviation is reported.
See also
ToleranceColor (RT Professional)
Description
Specifies the colors in which the bars of the memory space display are shown as soon as the
tolerance range is exceeded.
Syntax
Object.ToleranceColor[=Color]

VB scripting
Object
● DiscSpaceView
Color
Optional. A value or a constant that specifies the colors in which the bars of the storage space
display will be shown as soon as the tolerance range is exceeded.
Comments
RGB (255, 0, 0)
See also
ToleranceLowerLimit (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Sets the low limit for tolerance 1.
Syntax
Object.ToleranceLowerLimit[=DOUBLE]
Object
● Bar
DOUBLE
Optional A value or a constant that specifies the low limit for tolerance 1.

VB scripting
Comments
The following values will be defined via the properties "ToleranceLowerLimit",
"ToleranceLowerLimitColor" and "ToleranceLowerLimitRelative":
● Limit
See also
Bar (Page 257)
ToleranceLowerLimitColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the color for the lower limit "ToleranceLowerLimit"".
The "ToleranceLowerLimitEnabled" property must have the value TRUE if the bar color is to
Syntax
Object.ToleranceLowerLimitColor[=Color]
Object
● Bar
Color
Optional. A value or a constant that specifies the color for the lower limit "ToleranceLowerLimit"
".
Comments
RGB (255, 0, 0)
See also
Bar (Page 257)

VB scripting
ToleranceLowerLimitEnabled (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies whether the "ToleranceLowerLimit" limit is monitored. The limit, the display when the
limit has been reached, and the type of evaluation are set with the properties
"ToleranceLowerLimit", "ToleranceLowerLimitColor" and "ToleranceLowerLimitRelative".
Syntax
Object.ToleranceLowerLimitEnabled[=BOOLEAN]
Object
● Bar
BOOLEAN
Optional TRUE, if the "ToleranceLowerLimit" limit is monitored.
See also
Bar (Page 257)
ToleranceLowerLimitRelative (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies whether the low limit "ToleranceLowerLimit" is evaluated as a percentage or as an
absolute value.
Syntax
Object.ToleranceLowerLimitRelative[=BOOLEAN]
Object
● Bar
BOOLEAN
Optional.
TRUE if the low limit "ToleranceLowerLimit" is to be evaluated as a percentage.
FALSE if the low limit "ToleranceLowerLimit" is to be evaluated as an absolute value.

VB scripting
See also
Bar (Page 257)
ToleranceUpperLimit (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Sets the high limit for tolerance 1.
Syntax
Object.ToleranceUpperLimit[=DOUBLE]
Object
● Bar
DOUBLE
Optional A value or a constant that specifies the high limit for tolerance 1.
Comments
The following values will be specified via the properties "ToleranceUpperLimit",
"ToleranceUpperLimitColor" and "ToleranceUpperLimitRelative":
● Limit
See also
Bar (Page 257)
ToleranceUpperLimitColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the color for the high limit "ToleranceUpperLimit".
Syntax
Object.ToleranceUpperLimitColor[=Color]

VB scripting
Object
● Bar
Color
Optional. A value or a constant that specifies the color for the upper limit
"ToleranceUpperLimit"".
Comments
RGB (255, 0, 0)
See also
Bar (Page 257)
ToleranceUpperLimitEnabled (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies whether the "ToleranceUpperLimit"" limit is to be monitored.
Syntax
Object.ToleranceUpperLimitEnabled[=BOOLEAN]
Object
● Bar
BOOLEAN
Optional TRUE, if the "ToleranceUpperLimit" limit is to be monitored.

VB scripting
Comments
The following values will be specified with the properties "ToleranceUpperLimit",",
"ToleranceUpperLimitColor" and "ToleranceUpperLimitRelative":
● Limit
See also
Bar (Page 257)
ToleranceUpperLimitRelative (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies whether the higher limit "ToleranceUpperLimit"" is to be evaluated as a percentage
or as an absolute value.
Syntax
Object.ToleranceUpperLimitRelative[=BOOLEAN]
Object
● Bar
BOOLEAN
Optional.
TRUE if the high limit "ToleranceUpperLimit" is to be evaluated as a percentage.
FALSE if the high limit "ToleranceUpperLimit" is to be evaluated as an absolute value.
See also
Bar (Page 257)
ToolBar_ButtonsHeight (Panels, Comfort Panels, RT Advanced, RT Professional)
Description

VB scripting
ToolBar_ButtonsWidth (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ToolbarAlignment (RT Professional)
Description
Specifies the position of the toolbar.
Access in runtime:
Syntax
Object.ToolbarAlignment[=ToolbarPosition]
Object
● AlarmControl
● SysDiagControl
ToolbarPosition
Optional. A value or a constant that specifies the position of the toolbar within the object.
Value Designation
0 Top
1 Bottom
2 Left
3 Right

VB scripting
ToolbarBackColor (RT Professional)
Description
Specifies the background color of the toolbar.
Also set "ToolbarUseBackColor (Page 1081)" to "TRUE".
Syntax
Object.ToolbarBackColor[=Color]
Object
● AlarmControl
Color
Optional. A value or a constant that specifies the background color of the toolbar.
Comments
RGB (255, 0, 0)
See also

VB scripting
ToolbarBackgroundColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ToolbarButtonActive (RT Professional)
Description
Specifies whether the function linked to the button is activated in runtime. Clicking the button
in Runtime triggers the corresponding function.
Syntax
Object.ToolbarButtonActive[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
Optional.
TRUE if the function assigned to the key is active.
FALSE if the function assigned to the key is not active. You can connect your own functions
to the key by local scripts.
See also

VB scripting
ToolbarButtonAdd (RT Professional)
Description
Creates a new user-defined button in the object's toolbar. The newly created button is
automatically referenced with "ToolbarButtonIndex".
Syntax
Object.ToolbarButtonAdd[=STRING]
Object
● AlarmControl
STRING
Required. A value or a constant that specifies the name of the new button in the toolbar with
"ToolbarButtonName".
See also
ToolbarButtonIndex (Page 1071)
ToolbarButtonAuthorization (RT Professional)
Description
Specifies the authorization for the selected key function. The authorizations are configured in
the user administration.

VB scripting
Syntax
Object.ToolbarButtonAuthorization[=Int32]
Object
● AlarmControl
Int32
Optional. A value or constant that specifies the authorization for the selected key function.
See also
ToolbarButtonBeginGroup (RT Professional)
Description
Inserts a leading separator (vertical line) for the selected key function on the toolbar. These
separators can be used to group the icons of the button functions.
Syntax
Object.ToolbarButtonBeginGroup[=BOOLEAN]
Object
● AlarmControl

VB scripting
BOOLEAN
Optional.
TRUE if a separator is inserted in front of the selected key function.
FALSE if no separator is inserted in front of the selected key function.
See also
ToolbarButtonClick (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Clicks a toolbar button. You call the function of the corresponding button using the ID of the
button.
Access in runtime:
Syntax
Object.ToolbarButtonClick[=Int32]
Object
● AlarmControl
● SysDiagControl*

VB scripting
*: Read access only
Int32
Optional. A value or a constant that specifies the ID of the button that is clicked.
ToolbarButtonCount (RT Professional)
Description
Specifies the number of configured buttons in the toolbar.
Syntax
Object.ToolbarButtonCount[=Int32]
Object
● AlarmControl
Int32
Optional. A value or a constant that specifies the number of configured buttons in the toolbar.
See also

VB scripting
ToolbarButtonEnabled (RT Professional)
Description
Enables operation of custom toolbar buttons.
Syntax
Object.ToolbarButtonEnabled[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
Optional TRUE if operation is enabled for the selected user-defined key in the toolbar.
See also
ToolbarButtonHeight (Panels, Comfort Panels, RT Advanced, RT Professional)
Description

VB scripting
ToolbarButtonHotKey (RT Professional)
Description
Specifies the hot key for the selected object button. Enter the hot key in ASCII coding, e.g.
"112" for the <F1> key.
Also set "ToolbarUseHotKeys (Page 1082)" to "TRUE".
Syntax
Object.ToolbarButtonHotKey[=Int32]
Object
● AlarmControl
Int32
Optional. A value or a constant that specifies the shortcut for the selected button.
See also
TrendIndex (Page 1103)
ToolbarButtonID (RT Professional)
Description
References a button with its ID. To access the properties of a status bar element, you need to
set ""ToolbarButtonID"".

VB scripting
The referencing of a button with its ID does not depend on the actual order of the buttons. The
ID are listed in the inspector window of the object under "Properties > Properties > Toolbar >
Toolbar - Buttons".
Syntax
Object.ToolbarButtonID[=Int32]
Object
● AlarmControl
Int32
Optional. A value or a constant that specifies, with the ID, the toolbar buttons to be edited.
See also
ToolbarButtonClick (Page 1066)
ToolbarButtonIndex (RT Professional)
Description
References a button. To access the properties of a button, you need to set
""ToolbarButtonIndex"".
Values between 0 and "ToolbarButtonCount" minus 1 are valid for "ToolbarButtonIndex". The
"ToolbarButtonCount" property specifies the number of configured buttons.

VB scripting
Syntax
Object.ToolbarButtonIndex[=Int32]
Object
● AlarmControl
Int32
Optional. A value or a constant that specifies, with the index, the button to be edited.
See also
ToolbarButtonCount (Page 1067)
ToolbarButtonLocked (RT Professional)
Description
Specifies whether the locked, pressed state of a user-defined button referenced with
"ToolbarButtonIndex" is displayed.
Syntax
Object.ToolbarButtonLocked[=BOOLEAN]
Object
● AlarmControl

VB scripting
BOOLEAN
TRUE if the pressed state is displayed for the referenced user-defined button in the toolbar.
See also
ToolbarButtonName (RT Professional)
Description
Specifies the name of a user-defined button referenced with "ToolbarButtonIndex".
Syntax
Object.ToolbarButtonName[=STRING]
Object
● AlarmControl
STRING
Optional. A value or a constant that specifies the name of the referenced user-defined button.

VB scripting
See also
ToolbarButtonRemove (RT Professional)
Description
Removes a user-defined button referenced with its name.
Syntax
Object.ToolbarButtonRemove[=STRING]
Object
● AlarmControl
STRING
Optional. A value or a constant that specifies the name of the referenced user-defined button
to be removed.
See also

VB scripting

ToolbarButtonRename (RT Professional)
Description
Specifies the new name of a user-defined button referenced with "ToolbarButtonIndex".
Syntax
Object.ToolbarButtonRename[=STRING]
Object
● AlarmControl
STRING
Optional. A value or a constant that specifies the new name of the selected user-defined button.
See also

VB scripting
ToolbarButtonRepos (RT Professional)
Description
Specifies the position of a button referenced with "ToolbarButtonIndex" in the toolbar of the
object.
If you have changed the position of the button with "ToolbarButtonRepos",
"ToolbarButtonIndex" is assigned the value of "ToolbarButtonRepos".
Syntax
Object.ToolbarButtonRepos[=Int32]
Object
● AlarmControl
Int32
Optional. A value or a constant that specifies the position of the referenced button in the toolbar.
Value range from 0 to "ToolbarButtonCount" minus 1. Values outside this range have no effect.
0: The referenced button is positioned on the left.
See also
ToolbarButtonCount (Page 1067)

VB scripting
ToolbarButtons (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ToolbarButtonSettings (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ToolbarButtonsForMigration (RT Advanced)
Description
ToolbarButtonTooltipText (RT Professional)
Description
Specifies the tooltip text for the user-defined button in the toolbar.
Syntax
Object.ToolbarButtonTooltipText[=STRING]
Object
● AlarmControl
STRING
Optional A value or a constant that specifies the tooltip text for the selected user-defined button.

VB scripting
See also
ToolbarButtonUserDefined (RT Professional)
Description
Specifies whether the project engineer has added the toolbar button as new user-defined
button.
Syntax
Object.ToolbarButtonUserDefined[=BOOLEAN]
Object
● AlarmControl
Boolean
Optional.
TRUE if the toolbar key is user-defined.
FALSE if the toolbar key is specified by the system.
See also

VB scripting

ToolbarButtonVisible (RT Professional)
Description
Specifies whether the button referenced with "ToolbarButtonIndex" is displayed in the toolbar.
Syntax
Object.ToolbarButtonVisible[=<BOOLEAN>]
Object
● AlarmControl
BOOLEAN
Optional.
TRUE if the referenced button is shown.
FALSE if the referenced button is hidden.
See also

VB scripting
ToolbarButtonWidth (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ToolbarEnabled (RT Advanced)
Description
ToolbarHeight (RT Advanced)
Description
ToolbarIconStyle (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ToolbarLeft (RT Advanced)
Description
ToolbarShowTooltips (RT Professional)
Description
Specifies whether the tooltips for the key functions are displayed in runtime. The property can
be dynamized with the ToolbarShowTooltips name. The property for specifying the tooltip text
is "ToolbarButtonTooltipText".
Syntax
Object.ToolbarShowTooltips[=BOOLEAN]

VB scripting
Object
● AlarmControl
BOOLEAN
Optional.
TRUE if the tooltips are shown.
FALSE if the tooltips are not shown.
See also
ToolbarStyle (RT Advanced)
Description
ToolbarTop (RT Advanced)
Description
ToolbarUseBackColor (RT Professional)
Description
Specifies whether the background color for the toolbar is shown.

VB scripting
Syntax
Object.ToolbarUseBackColor[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
Optional.
TRUE if the background color of the toolbar is displayed.
FALSE if the background color of the toolbar is not displayed.
See also
ToolbarUseHotKeys (RT Professional)
Description
Specifies whether the hotkeys are activated for buttons in the toolbar. The hot keys are defined
for each button with "ToolbarButtonHotKey (Page 1069)".
Syntax
Object.ToolbarUseHotKeys[=BOOLEAN]

VB scripting
Object
● AlarmControl
BOOLEAN
Optional. TRUE if the hot keys are activated.
See also
ToolbarVisible (RT Professional)
Description
Specifies whether the toolbar of the control is displayed.
Syntax
Object.ToolbarVisible[=BOOLEAN]
Object
● AlarmControl

VB scripting
BOOLEAN
Optional.
TRUE if the toolbar is displayed.
FALSE if the toolbar is not displayed.
See also
ToolbarWidth (RT Advanced)
Description
ToolTipText (RT Advanced, RT Professional)
Description
Specifies the tooltip text.
Syntax
Object.ToolTipText[=STRING]
ToolTipText
● Bar
● Button
● CheckBox
● Circle
● CircleSegment
● CircularArc
● ComboBox

VB scripting
● Connector
● Ellipse
● EllipseSegment
● EllipticalArc
● GraphicIOField
● GraphicView
● IOField
● Line
● ListBox
● MultiLineEdit
● OptionGroup
● Polygon
● Polyline
● Rectangle
● RoundButton *
● StatusForce *
● Switch *
● TextField
● TubeArcObject
● TubeTeeObject
● Tubepolyline
● WindowSlider *
* Read access only
STRING
Optional. A value or a constant that specifies the tooltip text.
Top (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the value of the Y coordinate.

VB scripting
Syntax
Object.Top[=Int32]
Object
● AlarmControl
● AlarmView
● Bar
● BatteryView
● Button
● ChannelDiagnose
● CheckBox
● Circle
● CircleSegment
● CircularArc
● Clock
● ComboBox
● Connector
● DateTimeField
● DiscSpaceView
● Ellipse
● EllipseSegment
● EllipticalArc
● Gauge
● GraphicIOField
● GraphicView
● HTMLBrowser
● IOField
● Line
● ListBox
● MediaPlayer
● MultiLineEdit
● OptionGroup

VB scripting
● PLCCodeViewer
● Polygon
● Polyline
● ProDiagOverview
● RangeLabelView
● RecipeView *
● Rectangle
● RoundButton *
● S7GraphOverview
● ScreenWindow
● Slider **
● SmartClientView
● StatusForce *
● Switch *
● SymbolLibrary
● SysDiagControl *
● TextField
● TrendView *
● TubeArcObject
● TubeTeeObject
● Tubepolyline
● UserView **
● WLanQualityView
● WindowSlider *
● ZoneLabelView
● ZoneQualityView
* Read access only
** RT Professional read access only

VB scripting

Int32
Optional. A value or a constant that contains the value of the Y coordinate in pixels (measured
from the top left edge of the screen).
Comments
The Y coordinate refers to the top left corner of the rectangle that surrounds the object. The
screen limits are also monitored in runtime. If the assigned coordinate value exceeds the
display size, the user-defined function is interrupted with an error message.
TopMargin (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
TopOffset (RT Professional)
Description
Specifies the vertical shift of zero point of the display of a screen that is larger than the screen
window. The shift refers to the top edge of the screen window.
The screen is displayed cut. The picture scroll bars are located at the left and upper edge of
the picture.
If you wish to display the screen in the screen window with horizontal and vertical offset of the
screen scroll bars, use the "HorizontalScrollBarPosition (Page 740)" and
"VerticalScrollbarPosition (Page 1205) properties for the offset.
Syntax
Object.TopOffset[=Int32]
Object
● Screenwindow
Int32
Optional. A value or a constant that specifies the vertical shift of the screen display's zero point
from the top margin of the screen window.

VB scripting
See also
Total (RT Professional)
Description
Specifies the memory capacity.
Syntax
Object.Total[=DOUBLE]
Object
● DiskSpaceView
DOUBLE
Optional. A value or a constant that specifies the memory capacity.
TransitionHeaderFont (RT Professional)
Description
Specifies the font in the information area of this PLC code display.
Syntax
Object.TransitionHeaderFont[=Font]
Object
● PLCCodeViewer
Font
See also

VB scripting
Transparency (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the object transparency in percent.
0 = no transparency; 100 = complete transparency (invisible).
The text and fields of the graphic objects are only transparent with "100."
In runtime, a completely transparent object (invisible) is also functional.
Syntax
Object.Transparency[=Int32]
Object
● Bar
● Button
● CheckBox
● Circle
● CircleSegment
● CircularArc
● Clock
● ComboBox
● Connector
● Ellipse
● EllipseSegment
● EllipticalArc
● Gauge
● GraphicIOField
● GraphicView
● IOField
● Line
● ListBox
● MultiLineEdit
● OptionGroup
● Polygon
● Polyline

VB scripting
● Rectangle
● RoundButton *
● Slider *
● TextField
● TubeArcObject
● TubeTeeObject
● Tubepolyline
● WindowSlider *
* Read access only
** RT Professional, read access only
Int32
Optional. A value or constant that specifies the transparency of the object in percent.
TransparentColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies which color of the allocated graphic (*.bmp, *dib) is to be set to "transparent".
Also specify with "UseTransparentColor" that the color is to be shown as transparent.
Syntax
Object.TransparentColor[=Color]
Object
● GraphicIOField
● GraphicView
Color
Optional. A value or a constant that specifies the color that will be shown transparent.
Comments

VB scripting
RGB (255, 0, 0)
TransparentColorDeactivatedPicture (RT Professional)
Description
Sets the color of the assigned bitmap object to "transparent" for the "disabled" status.
Syntax
Object.TransparentColorDeactivatedPicture[=Color]
Object
● RoundButton
Color
Optional A value or a constant that specifies which color of the allocated bitmap object will be
set to transparent" for the status "disabled".
Comments
You can use the "RGB" function to define the color in RGB format (red, green, blue). To do
this, enter the appropriate decimal value for each of the three RGB values (range from 0 to
255). For example, the color "red" is shown like this: RGB(255, 0, 0). You can also use the
VBS color constants such as vbRed and vbGreen.
The "PicDeactUseTransColor" property must have the value TRUE so that the color can be
set to "transparent".
See also
TransparentColorPictureOff (RT Professional)
Description
Specifies which color of the allocated bitmap object will be set to transparent" for the "off"
status.

VB scripting
Syntax
Object.TransparentColorPictureOff[=Color]
Object
● Button
● RoundButton*
*: Read access only
Color
Optional. A value or a constant that specifies which color of the allocated bitmap object will be
set to transparent" for the "off" status.
Comments
RGB (255, 0, 0)
TransparentColorPictureOn (RT Professional)
Description
Specifies which color of the allocated bitmap object will be set to transparent" for the "on"
status.
The "PicDownUseTransColor" property must have the value TRUE so that the color can be
set to "transparent".
Syntax
Object.TransparentColorPictureOn[=Color]
Object
● Button
● RoundButton*
*: Read access only

VB scripting
Color
Optional. A value or a constant that specifies which color of the allocated bitmap object will be
set to "transparent" for the "on" status.
Comments
RGB (255, 0, 0)
TrendActualize (RT Professional)
Description
Specifies whether the selected trend is updated.
Syntax
Object.TrendActualize[=BOOLEAN]
Object
BOOLEAN
Optional.
TRUE if the selected trend is always updated.
FALSE if the selected trend is not updated. This setting is useful when a logged trend is
compared with a current trend.
See also
TrendAdd (RT Professional)
Description
Creates a new trend. The newly created trend is automatically referenced with "TrendIndex".

VB scripting
Syntax
Object.TrendAdd[=STRING]
Object
STRING
Required. A value or a constant that specifies the name of the new trend with "TrendName".
TrendAutoRangeBeginTagName (RT Professional)
Description
Specifies a tag that defines the start value of the data range of the trend. You specify
additionally using the "TrendAutoRangeSource (Page 1097)" property that the data range of
the trend is determined dynamically.
Syntax
Object.TrendAutoRangeBeginTagName[=STRING]
Object
STRING
Optional. A value or a constant that specifies the tag for the start value.
See also
TrendAutoRangeBeginValue (RT Professional)
Description
Specifies the start value of the data range of the trend. You specify additionally using the
"TrendAutoRangeSource (Page 1097)" property that the data range of the trend is set statically.

VB scripting
Syntax
Object.TrendAutoRangeBeginValue[=DOUBLE]
Object
DOUBLE
Optional. A value or a constant that specifies the start value of the data range of the trend.
See also
TrendAutoRangeEndTagName (RT Professional)
Description
Specifies a tag that defines the end value of the data range of the trend. You specify additionally
using the "TrendAutoRangeSource (Page 1097)" property that the data range of the trend is
determined dynamically.
Syntax
Object.TrendAutoRangeEndTagName[=STRING]
Object
STRING
Optional. A value or a constant that specifies the tag for the end value.
See also
TrendAutoRangeEndValue (RT Professional)
Description
Specifies the end value of the data range of the trend. You specify additionally using the
"TrendAutoRangeSource (Page 1097)" property that the data range of the trend is set statically.

VB scripting
Syntax
Object.TrendAutoRangeEndValue[=DOUBLE]
Object
DOUBLE
Optional. A value or a constant that specifies the end value of the data range of the trend.
See also
TrendAutoRangeSource (RT Professional)
Description
Specifies how the automatic data range of the trend data is determined.
Syntax
Object.TrendAutoRangeSource[=AutorangeSourceType]
Object
AutorangeSourceType
Optional. A value or a constant that specifies the type of data range.

VB scripting

x Adapt automatically Specifies that the displayed value range is automatically
adapted to the current values.
1 Dynamic range Specifies that the low limit and high limit of the displayed val‐
ue range is formed from the values of connected online tags.
The tags of the low limit and high limit are mapped in the
"TrendAutoRangeBeginTagName (Page 1094)" and "Tren‐
dAutoRangeEndTagName (Page 1095)" properties.
2 Static range Specifies that the displayed value range is defined by the
configuration of the low limit and high limit of the value range.
The values of the low limit and high limit are mapped in the
"TrendAutoRangeBeginValue (Page 1094)" and "TrendAu‐
toRangeEndValue (Page 1095)" properties.
TrendBeginTime (RT Professional)
Description
Defines the start time of the time range for data transfer to the selected trend.
Syntax
Object.TrendBeginTime[=DateTime]
Object
DateTime
Optional. Defines the start time for data supply for the selected trend.
See also
TrendColor (RT Professional)
Description
Specifies the color of the trend line of a referenced trend of the trend view.

VB scripting
Syntax
Object.TrendColor[=Color]
Object
Color
Optional. A value or a constant that specifies the color of the trend line of a referenced trend
in the object.
Comments
You use the "RGB" function to define the color in RGB format (red, green, blue). Enter the
corresponding decimal value for each of the three RGB values (range from 0 to 255). The
"Red" color is displayed as follows, for example:
RGB (255, 0, 0)
See also
TrendCount (RT Professional)
Description
Specifies the number of configured trends.
Syntax
Object.TrendCount[=Int32]
Object

VB scripting
Int32
Optional. A value or a constant that specifies the number of configured trends.
See also
TrendEndTime (RT Professional)
Description
Defines the end of the time range for data connections of a selected trend.
Syntax
Object.TrendEndTime[=DateTime]
Object
DateTime
Optional. Specifies the end time for data supply for the selected trend.
See also
TrendExtendedColorSet (RT Professional)
Description
Specifies whether the point and fill colors of the trend are shown.
Syntax
Object.TrendExtendedColorSet[=BOOLEAN]

VB scripting
Object
BOOLEAN
Optional.
TRUE if the settings in "TrendFillColor (Page 1102)" and "TrendPointColor (Page 1110)" are
effective.
FALSE if the settings for point and fill color are not effective.
See also
TrendFill (RT Professional)
Description
Specifies whether the area below the trend is shown filled.
If "TrendExtendedColorSet (Page 1099)" is set to "FALSE", the trend color is also used as the
fill color.
Syntax
Object.TrendFill[=BOOLEAN]
Object
BOOLEAN
Optional.
TRUE if the area beneath the trend is filled.
FALSE if the trend is not shown filled.

VB scripting
See also
TrendFillColor (RT Professional)
Description
Defines the fill color of the trend.
The setting is effective if the properties "TrendFill (Page 1100)" and "TrendExtendedColorSet
(Page 1099)" are also set to "TRUE".
Syntax
Object.TrendFillColor[=Color]
Object
Color
Optional. A value or a constant that specifies the fill color of the selected trend.
Comments
RGB (255, 0, 0)
See also

VB scripting
TrendIndex (RT Professional)
Description
References a configured trend. To access the properties of a trend, you need to set
""TrendIndex"".
Values between 0 and "TrendCount" minus 1 are valid for "TrendIndex". The "TrendCount"
property specifies the number of configured trends.
Syntax
Object.TrendIndex[=Int32]
Object
Int32
Optional. A value or a constant that specifies, with the index, the trend to be edited.
See also
TrendCount (Page 1098)
TrendIndicatorColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the color for the trend view. The trend indicator represents the tendency (rising or
falling) of the measurement value that is to be monitored with a small arrow. To activate the
trend indicator, the property "ShowTrendIndicator" must have the value "TRUE".
Syntax
Object.TrendIndicatorColor[=Color]
Object
● Bar

VB scripting
Color
Optional. A value or a constant that specifies the color of the trend indicator.
Comments
RGB (255, 0, 0)
See also
Bar (Page 257)
TrendLabel (RT Professional)
Description
Defines the label text for a trend referenced with "TrendIndex".
Syntax
Object.TrendLabel[=STRING]
Object
STRING
Optional. A value or a constant that specifies the label text for the referenced trend.
See also

VB scripting
TrendLineStyle (RT Professional)
Example
Specifies which line type is used for display of the trend.
Syntax
Object.TrendLineStyle[=LineStyle]
Object
LineStyle
Optional. A value or a constant that specifies the type of line for displaying the trend.
Value Explanation
0 The trend is shown as a solid line.
1 The trend is visualized as dashed line.
2 The trend is visualized as dotted line.
3 The trend is visualized as dot-dash line.
4 The trend is visualized as dash-dot-dot line.
See also
TrendLineType (RT Professional)
Description
Specifies how the trend is displayed.
Syntax
Object.TrendLineType[=TrendLineTypeScada]

VB scripting
Object
TrendLineTypeScada
Optional. A value or a constant that specifies how the trend is displayed.
Value Explanation
0 Only the trend dots are displayed.
1 Visualizes a trend with linear interconnection of points.
2 Visualizes a stepped trend and its interconnected points.
See also
TrendLineWidth (RT Professional)
Description
Specifies the line thickness of the selected trend in pixels.
Syntax
Object.TrendLineWidth[=Int32]
Object
Int32
Optional. A value or a constant that specifies the line weight of the selected trend in pixels.
See also

VB scripting
TrendLowerLimit (RT Professional)
Description
Specifies the low limit of a tag that is displayed in the object as a trend. If the tag drops below
the value of "TrendLowerLimit", the affected trend dots are marked in the color set in
"TrendLowerLimitColor (Page 1107)".
Using the "TrendLowerLimitColoring (Page 1108)" property, specify additionally that the
display of the low limit violation is activated.
Syntax
Object.TrendLowerLimit[=DOUBLE]
Object
DOUBLE
Optional. A value or a constant that specifies the lower limit for a tag displayed in a trend view.
See also
TrendLowerLimitColor (RT Professional)
Description
Specifies the color that marks the trend values that are below the value of "TrendLowerLimit
(Page 1106)".
The setting is effective if the "TrendLowerLimitColoring (Page 1108)" property has the value
"TRUE".
Syntax
Object.TrendLowerLimitColor[=Color]

VB scripting
Object
Color
Optional. A value or a constant that specifies the color of trend values below the
"TrendLowerLimit (Page 1106)" value.
Comments
RGB (255, 0, 0)
TrendLowerLimitColoring (RT Professional)
Description
Specifies whether "TrendLowerLimitColor" is used to identify tag values which are less than
the value of "TrendLowerLimit".
Syntax
Object.TrendLowerLimitColoring[=BOOLEAN]
Object
BOOLEAN
Optional.
TRUE if the "TrendLowerLimitColor" property is effective.
FALSE if the "TrendLowerLimitColor" property is not effective.

VB scripting
TrendMeasurePoints (RT Professional)
Description
Specifies the number of measurement points for visualization of the selected trend.
Defines the number of value pairs provided to the trend from a user archive.
Syntax
Object.TrendMeasurePoints[=Int32]
Object
Int32
Optional. A value or a constant that specifies the number of measurement points or value pairs
for the selected trend.
See also
TrendName (RT Professional)
Description
Specifies the name of a trend referenced with "TrendIndex".
Syntax
Object.TrendName[=STRING]
Object
STRING
Optional. A value or a constant that specifies the name of the referenced trend.

VB scripting
See also
TrendPointColor (RT Professional)
Description
Specifies the color of the dots on the reference trend.
The setting is effective if the "TrendExtendedColorSet (Page 1099)" property has the value
"TRUE".
Syntax
Object.TrendPointColor[=Color]
Object
Color
Optional. A value or a constant that specifies the color of the dots in the referenced trend.
Comments
RGB (255, 0, 0)
See also

VB scripting
TrendPointStyle (RT Professional)
Description
Specifies how the trend points are displayed.
Syntax
Object.TrendPointStyle[=PointStyle]
Object
PointStyle
Optional. A value or a constant that specifies how the dots in the trend are displayed.
Value Explanation
0 The points are not displayed. The set dot width is disabled.
1 The trend points are visualized with a size of one pixel. The set dot width is disabled.
2 The dots are displayed as square. The set dot width is enabled.
3 The dots are displayed as circles. The set dot width is enabled.
See also
TrendPointWidth (RT Professional)
Description
Specifies the dot weight in pixels. You can only define the dot weight for "square" and "circular"
dots.
Syntax
Object.TrendPointWidth[=Int32]

VB scripting
Object
Int32
Optional A value or a constant that specifies the dot weight of the selected trend in pixels.
See also
TrendProvider (RT Professional)
Description
Specifies the data source for a selected trend.
Syntax
Object.TrendProvider[=DataSourceType]
Object
DataSourceType
Optional. A value or a constant that specifies the data source for the selected trend.

0 None No data source configured for implementation in Runtime by means of
a user-defined function.
1 Logging tags Data source with archive tags of a process value archive.
2 HMI tags Data supply with tag values of HMI tags
3 Recipe data Data supply with columns of a recipe
See also

VB scripting
TrendProviderCLSID (RT Professional)
Description
Specifies the provider CLSID of the data for a trend.
Syntax
Object.TrendProviderCLSID[=STRING]
Object
STRING
Optional. A value or a constant that specifies the provider CLSID.
Value Description
No configured data supply in order to establish a connection in Run‐
time via a script.
{416A09D2-8B5A-11D2- Data source with archive tags of a process value archive.
8B81-006097A45D48}
{A3F69593-8AB0-11D2- Data supply with online
A440-00A0C9DBB64E} tags from tag management.
{2DC9B1C8-4FC1-41B1- Data supply with columns of a user log.
B354-3E469A13FBFD}
See also
TrendRangeType (RT Professional)
Description
Specifies the time range during which the selected trend is supplied with data.
You can only define the number of measuring points if you select user archives as the data
source.

VB scripting
Syntax
Object.TrendRangeType[=TimeRangeMode]
Object
TimeRangeMode
Optional. A value or a constant that specifies the time range during which the selected trend
is supplied with data.

0 Time range Defines the start time and the time range for the data connec‐
tion.
1 Start to end time Defines the start and end time for the data connection.
2 Number of measurement Defines the start time and the number of measurement points
points for the data connection.
See also
TrendRemove (RT Professional)
Description
Removes a trend referenced with its name.
Syntax
Object.TrendRemove[=STRING]
Object
STRING
Optional. A value or a constant that specifies the name of the referenced trend to be removed.

VB scripting
See also
TrendRename (RT Professional)
Description
Specifies the new name of a trend referenced with "TrendIndex".
Syntax
Object.TrendRename[=STRING]
Object
STRING
Optional. A value or a constant that specifies the new name of the selected trend.
See also
TrendRepos (RT Professional)
Description
Specifies the position of a trend referenced with "TrendIndex" in the trend window of the object.
If you have changed the position of the trend with "TrendRepos", "TrendIndex" is assigned the
value of "TrendRepos".
Syntax
Object.TrendRepos[=Int32]

VB scripting
Object
Int32
Optional. A value or a constant that specifies the position of the referenced trend in the trend
window. Value range from 0 to "TrendCount" minus 1. Values outside this range have no effect.
0: The referenced trend is positioned at the front.
See also
TrendCount (Page 1098)
Trends (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
TrendSelectTagName (RT Professional)
Description
Specifies that the dialog for selecting the tag name for the data source of the value axis is
displayed initially in runtime.
Syntax
Object.TrendSelectTagName[=BOOLEAN]
Object
BOOLEAN
Optional.

VB scripting
TRUE, if the dialog for selecting the tag name for the data source of the value axis is displayed
in the screen.
FALSE, , if no dialog for selecting the tag name for the data source of the value axis is displayed
in the screen.
TrendSelectTagNameX (RT Professional)
Description
Specifies that the dialog for selecting the tag name of the data source of the x-axis is displayed
initially in runtime.
Syntax
Object.TrendSelectTagNameX[=BOOLEAN]
Object
BOOLEAN
Optional. TRUE if the dialog for selecting the tag name of the data source of the X-axis is
displayed in the screen.
See also
TrendSelectTagNameY (RT Professional)
Description
Specifies that the dialog for selecting the tag name for the data source of the Y axis is displayed
initially in runtime.
Syntax
Object.TrendSelectTagNameY[=BOOLEAN]

VB scripting
Object
BOOLEAN
Optional. TRUE if the dialog for selecting the tag name of the data source of the Y-axis is
See also
TrendsForPrinting (RT Advanced)
Description
TrendTagName (RT Professional)
Description
Specifies the name of the tag that supplies the value axis with data.
Syntax
Object.TrendTagName[=STRING]
Object
STRING
Optional. A value or a constant that specifies the name of the tag for the value axis.
TrendTagNameX (RT Professional)
Description
Specifies the name of the connected HMI tag or column for the X-axis. You select an HMI tag
or a column with the selection button.

VB scripting
Syntax
Object.TrendTagNameX[=STRING]
Object
STRING
Optional A value or a constant that specifies the name of the HMI tag or column for the X axis.
See also
TrendTagNameY (RT Professional)
Description
Specifies the name of the connected HMI tag or column for the Y-axis. You select an HMI tag
or a column with the selection button.
Syntax
Object.TrendTagNameY[=STRING]
Object
STRING
Optional A value or a constant that specifies the name of the HMI tag or column for the Y axis.
See also

VB scripting
TrendTimeAxis (RT Professional)
Description
Specifies the time axis to be used for the selected trend.
Syntax
Object.TrendTimeAxis[=STRING]
Object
STRING
Optional. A value or a constant that specifies the time axis for the selected trend.
See also
TrendTimeRangeBase (RT Professional)
Description
Specifies the time unit for calculating the time range.
Syntax
Object.TrendTimeRangeBase[=TagLoggingTimeUnit]
Object
TagLoggingTimeUnit
Optional. A value or a constant that specifies the time unit for determining the time range.
Value Description
500 500 ms
1000 1 second

VB scripting
Value Description
60000 1 minute
3600000 1 hour
86400000 1 day
See also
TrendTimeRangeFactor (RT Professional)
Description
Specifies the factor for determining the time interval for which the referenced trend is displayed.
You determine the time span by multiplying the factor and time unit.
The setting is effective if "TrendRangeType (Page 1112)" property has the value "0".
Syntax
Object.TrendTimeRangeFactor[=Int32]
Object
Int32
Optional. A value or a constant that specifies the factor for determining the time span of the
referenced trend.
TrendTrendWindow (RT Professional)
Description
Defines the trend window for visualizing the trend selected.
Define the available trend windows in the "Trend window" tab.
Syntax
Object.TrendTrendWindow[=STRING]

VB scripting
Object
STRING
Optional A value or constant that specifies the name of the trend window for the selected trend.
See also
TrendUncertainColor (RT Professional)
Description
Specifies the color for values of uncertain status.
Syntax
Object.TrendUncertainColor[=Color]
Object
Color
Optional. A value or a constant that specifies the color of the values of uncertain status in the
selected trend.
Comments
RGB (255, 0, 0)

VB scripting
See also
TrendUncertainColoring (RT Professional)
Description
Specifies that values of uncertain status are to be highlighted.
Syntax
Object.TrendUncertainColoring[=BOOLEAN]
Object
BOOLEAN
Optional.
TRUE if values of uncertain status are highlighted.
See also
TrendUpperLimit (RT Professional)
Description
Specifies the high limit of a tag that is displayed in the specified object as a trend. If the tag
exceeds the value of "TrendUpperLimit", the relevant trend dots are marked in the color
specified with "TrendUpperLimitColor (Page 1124)".
Also specify with "TrendUpperLimitColoring (Page 1125)" that limit violation display is
activated.
Syntax
Object.TrendUpperLimit[=DOUBLE]

VB scripting
Object
DOUBLE
Optional. A value or a constant that specifies the higher limit for values in the selected trend.
See also
TrendUpperLimitColor (RT Professional)
Description
Specifies the color that marks trend values which are above the value of "TrendUpperLimit
(Page 1122)".
The setting is effective if "TrendUpperLimitColoring (Page 1125)" has the value "TRUE".
Syntax
Object.TrendUpperLimitColor[=Color]
Object
Color
Optional. A value or a constant that specifies the color of trend values above the
"TrendUpperLimit (Page 1122)" value.
Comments
The "Red" color is displayed as follows, for example:
RGB (255, 0, 0)

VB scripting
See also
TrendUpperLimitColoring (RT Professional)
Description
Specifies whether the selection frame is shown with the color defined by the system.
Syntax
Object.TrendUpperLimitColoring[=BOOLEAN]
Object
BOOLEAN
Optional.
TRUE if the "TrendUpperLimitColor" property is enabled.
FALSE if the "TrendUpperLimitColor" property is disabled.
See also
TrendValueAlign (Panels, Comfort Panels, RT Advanced, RT Professional)
Description

VB scripting
TrendValueAxis (RT Professional)
Description
Specifies the value axis that is used for the trend selected.
Syntax
Object.TrendValueAxis[=STRING]
Object
STRING
Optional. A value or a constant that specifies the value axis for the selected trend.
See also
ValueAxisCount (Page 1178)
TrendValueUnit (RT Professional)
Description
Specifies a unit of the values for the "Display values" trend type. The unit is dependent on the
value to be displayed, e.g., "%" or "°C".
Syntax
Object.TrendValueUnit[=STRING]
Object
STRING
Optional. A value or a constant that specifies the unit for the values of the value axis.

VB scripting
See also
TrendVisible (RT Professional)
Description
Specifies whether the trend referenced with "TrendIndex" is displayed in the object.
Syntax
Object.TrendVisible[=BOOLEAN]
Object
BOOLEAN
Optional.
TRUE, if the referenced trend is displayed.
FALSE, if the referenced trend is not displayed.
See also
TrendWindowAdd (RT Professional)
Description
Creates a new trend view. The newly created trend view is automatically referenced with
"TrendWindowIndex".
Syntax
Object.TrendWindowAdd[=STRING]

VB scripting
Object
STRING
Required. A value or a constant that specifies the name of the new trend view with
"TrendWindowName".
See also
TrendWindowIndex (Page 1133)
TrendWindowCoarseGrid (RT Professional)
Description
Specifies if the grid lines for the main scale are displayed.
Syntax
Object.TrendWindowCoarseGrid[=BOOLEAN]
Object
BOOLEAN
Optional.
TRUE if the grid lines for the main scale are displayed.
FALSE if the grid lines for the main scale are not displayed.
See also

VB scripting
TrendWindowCoarseGridColor (RT Professional)
Description
Specifies the color of the main grid for the referenced diagram in the object.
Syntax
Object.TrendWindowCoarseGridColor[=Color]
Object
Color
Optional. A value or a constant that specifies the color of the main grid for the referenced
diagram.
Comments
RGB (255, 0, 0)
See also
TrendWindowCount (RT Professional)
Description
Specifies the number of configured trend diagrams in the trend view.
Syntax
Object.TrendWindowCount[=Int32]

VB scripting
Object
Int32
Optional. A value or a constant that specifies the number of configured trend diagrams in the
trend view.
See also
TrendWindowFineGrid (RT Professional)
Description
Specifies whether grid lines are displayed for the secondary scaling.
Syntax
Object.TrendWindowFineGrid[=BOOLEAN]
Object
BOOLEAN
Optional.
TRUE if the grid lines for the secondary scale are displayed.
FALSE if the grid lines for the secondary scale are not displayed.
See also

VB scripting
TrendWindowFineGridColor (RT Professional)
Description
Specifies the color of the secondary grid for the referenced diagram in the object.
Syntax
Object.TrendWindowFineGridColor[=Color]
Object
Color
Optional. A value or a constant that specifies the color of the help grid for the referenced
diagram.
Comments
RGB (255, 0, 0)
See also
TrendWindowForegroundTrendGrid (RT Professional)
Description
Specifies whether only the grid lines for the foreground trend are displayed in the selected
trend window.

VB scripting
Syntax
Object.TrendWindowForegroundTrendGrid[=BOOLEAN]
Object
BOOLEAN
Optional.
TRUE if the grid lines for the foreground trend are displayed in the trend window.
FALSE if the grid lines for all trends are displayed in the trend window.
See also
TrendWindowGridInTrendColor (RT Professional)
Description
Specifies whether the grid lines for the main scaling are displayed in the trend color.
Syntax
Object.TrendWindowGridInTrendColor[=BOOLEAN]
Object
BOOLEAN
Optional.
TRUE if the grid lines are displayed in the trend color.
FALSE if the grid lines are displayed in the color set in "TrendWindowCoarseGridColor
(Page 1128)".

VB scripting
See also
TrendWindowHorizontalGrid (RT Professional)
Description
Specifies whether the horizontal grid lines are shown.
Syntax
Object.TrendWindowHorizontalGrid[=BOOLEAN]
Object
BOOLEAN
TRUE: The horizontal grid lines are displayed.
FALSE: The horizontal grid lines are not displayed.
See also
TrendWindowIndex (RT Professional)
Description
References a trend view. To access the properties of a trend view, you need to set
""TrendWindowIndex"".
Values between 0 and "TrendWindowCount" minus 1 are valid for "TrendWindowIndex". The
"TrendWindowCount" property specifies the number of configured trend views.
Syntax
Object.TrendWindowIndex[=Int32]

VB scripting
Object
Int32
Optional. A value or a constant that specifies, with the index, the trend view to be edited.
See also
TrendWindowName (RT Professional)
Description
Specifies the name of a trend view referenced with "TrendWindowIndex".
Syntax
Object.TrendWindowName[=STRING]
Object
STRING
Optional. A value or a constant that specifies the name of the referenced trend view.
See also

VB scripting
TrendWindowRemove (RT Professional)
Description
Removes a trend view referenced with its name.
Syntax
Object.TrendWindowRemove[=STRING]
Object
STRING
Optional. A value or a constant that specifies the name of the referenced trend view to be
removed.
See also
TrendWindowRename (RT Professional)
Description
Specifies the new name of a trend view referenced with "TrendWindowIndex".
Syntax
Object.TrendWindowRename[=STRING]
Object
STRING
Optional. A value or a constant that specifies the new name of the selected trend view.

VB scripting
See also
TrendWindowRepos (RT Professional)
Description
Specifies the position of a trend view referenced with "TrendWindowIndex".
If you have changed the position of the trend view with "TrendWindowRepos",
"TrendWindowIndex" is assigned the value of "TrendWindowRepos".
Syntax
Object.TrendWindwRepos[=Int32]
Object
Int32
Optional. A value or a constant that specifies the position of the referenced trend view. Value
range from 0 to "TrendWindowCount" minus 1. Values outside this range have no effect.
0: The referenced trend view is positioned at the front.
See also
TrendWindowRulerColor (RT Professional)
Description
Specifies the color of the ruler.
The setting is effective if the "TrendWindowRulerStyle (Page 1138)" property has the value
"1".

VB scripting
Syntax
Object.TrendWindowRulerColor[=Color]
Object
Color
Optional. A value or a constant that specifies the color of the ruler.
Comments
RGB (255, 0, 0)
See also
TrendWindowRulerLayer (RT Professional)
Description
Specifies the display layer of the ruler in the trend view.
Syntax
Object.TrendWindowRulerLayer[=RulerLayer]
Object

VB scripting
RulerLayer
Optional. A value or a constant that specifies the display layer of the ruler in the trend view.
Value Explanation
0 The ruler is visualized on a layer under the grid.
1 The ruler is positioned on top of the trend and under the grid.
2 The ruler is positioned on top of the trend.
See also
TrendWindowRulerStyle (RT Professional)
Description
Specifies the appearance of the ruler.
Syntax
Object.TrendWindowRulerStyle[=RulerStyle]
Object
RulerStyle
Optional. A value or a constant that specifies how the ruler is displayed.
Value Explanation
0 The ruler is displayed as a single black line.
1 The ruler is displayed in the configured color and line width.
See also

VB scripting
TrendWindowRulerWidth (RT Professional)
Description
Specifies the thickness of the ruler in pixels.
The setting is effective if the "TrendWindowRulerStyle (Page 1137)" property has the value
"1".
Syntax
Object.TrendWindowRulerWidth[=Int32]
Object
Int32
Optional. A value or a constant that specifies the width of the ruler in pixels.
See also
TrendWindows (RT Professional)
Description
TrendWindowSpacePortion (RT Professional)
Description
Specifies the range proportion of the referenced diagram in the diagram area of the object.
Syntax
Object.TrendWindowSpacePortion[=Int32]

VB scripting
Object
Int32
Optional. A value or constant that specifies the range proportion of the referenced diagram in
the diagram area of the object.
Comments
The amount of each range proportion can be calculated from the total number of range
components. If, for example, you have configured a total of three diagrams, a range proportion
of "1" each will result in three diagrams of equal size. To increase the size of range components
in relation to each other, increase the range proportion of one or more diagrams.
See also
TrendWindowStatisticRulerColor (RT Professional)
Description
Specifies the color of the statistics ruler. You specify additionally using the
"TrendWindowStatisticRulerStyle (Page 1141)" property that the statistics ruler can be
configured graphically.
Syntax
Object.TrendWindowStatisticRulerColor[=Color]
Object
Color
Optional. A value or a constant that specifies the color of the statistics ruler.

VB scripting
Comments
RGB (255, 0, 0)
See also
TrendWindowStatisticRulerStyle (RT Professional)
Description
Defines the graphical configurability of the lines for specifying the statistics area in the trend
window.
Syntax
Object.TrendWindowStatisticRulerStyle[=RulerStyle]
Object
RulerStyle
Optional. A value or a constant that specifies whether the statistics ruler can be configured
graphically.

0 Simple The ruler is displayed as a simple black line.
1 Graphic The ruler is displayed in the configured color and line width.
See also

VB scripting
TrendWindowStatisticRulerWidth (RT Professional)
Description
Specifies the line width of the statistics ruler. You specify additionally using the
"TrendWindowStatisticRulerStyle (Page 1140)" property that the statistics ruler can be
configured graphically.
Syntax
Object.TrendWindowStatisticRulerWidth[=Int32]
Object
Int32
Optional. A value or a constant that specifies the line width of the statistics ruler.
See also
TrendWindowVerticalGrid (RT Professional)
Description
Specifies whether the vertical grid lines are displayed.
Syntax
Object.TrendWindowVerticalGrid[=BOOLEAN]
Object
BOOLEAN
Optional.
TRUE if the vertical grid lines are displayed.
FALSE if the vertical grid lines are not displayed.

VB scripting
See also
TrendWindowVisible (RT Professional)
Description
Specifies whether the trend view referenced with "TrendWindowIndex" is displayed.
Syntax
Object.TrendWindowVisible[=BOOLEAN]
Object
BOOLEAN
Optional.
TRUE if the referenced trend view is displayed.
FALSE if the referenced trend view is not displayed.
See also
TrendXAxis (RT Professional)
Description
Defines the X axis to be used for the referenced trend.
Syntax
Object.TrendXAxis[=STRING]

VB scripting
Object
STRING
Optional. A value or constant that specifies the name of the X-axis used for the referenced
trend.
See also
TrendYAxis (RT Professional)
Description
Specifies which Y axis is to be used for the referenced trend.
Syntax
Object.TrendYAxis[=STRING]
Object
STRING
Optional. A value or a constant that specifies the name of the Y-axis used for the referenced
trend.
See also

VB scripting
1.5.5.14 Properties U-W (Panels, Comfort Panels, RT Advanced, RT Professional)
Unit (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the unit of measurement.
Syntax
Object.Unit[=STRING]
Object
● Bar
● IOField
STRING
Optional. A value or a constant that specifies the unit of measurement.
See also
Bar (Page 257)
IOField (Page 331)
UnitColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the text color for the unit of measurement.
Syntax
Object.UnitColor[=Color]
Object
● Gauge
Color
Optional. A value or a constant that specifies the text color for the measurement unit.

VB scripting
Comments
RGB (255, 0, 0)
See also
Gauge (Page 319)
UnitFont (RT Professional)
Description
Specifies the font of the unit of measurement.
Syntax
Object.UnitFont[=Font]
Object
● Gauge
Font
See also
Gauge (Page 319)
UnitText (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the text for the unit of measurement.
Syntax
Object.UnitText[=STRING]

VB scripting
Object
● Gauge
STRING
Optional. A value or a constant that specifies the text for the measurement unit.
Comments
Enter a text to show, for example, the physical unit of the value displayed.
See also
Gauge (Page 319)
UnitTop (RT Professional)
Description
Specifies the distance from the unit of measurement to the upper edge of the object. The
lettering can only be positioned along the vertical diameter of the scale. The value of the
property refers to the height of the object and is measured from the upper edge of the object
to the lower edge of the lettering.
Syntax
Object.UnitTop[=DOUBLE]
Object
● Gauge
DOUBLE
Optional. A value or a constant that specifies the distance between the measurement unit and
the upper edge of the object.
Value Description
0 The lower edge of the lettering is positioned on the upper limit of the selected object. The
text is no longer visible as it is positioned outside the object.
1 The lower edge of the lettering is positioned on the lower limit.
See also
Gauge (Page 319)

VB scripting
UnitViewColumnOrder (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
UpdateButtonVisible (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
UpperLimit (RT Professional)
Description
Specifies the upper limit for input values.
Syntax
Object.UpperLimit[=DOUBLE]
Object
● IOField
DOUBLE
Optional A value or a constant that specifies the upper limit for input values.
See also
IOField (Page 331)
UseAutoScaling (Panels, Comfort Panels, RT Advanced, RT Professional)
Description

VB scripting
UseButtonFirstGradient (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
UseButtonSecondGradient (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
UseColumnBackColor (RT Professional)
Description
Specifies the settings for the background color of the columns.
Syntax
Object.UseColumnBackColor[=BOOLEAN]
Object
BOOLEAN
Optional.
TRUE if the background color configured in "TableColor (Page 990)" is used.
FALSE if the background color configured for the columns in the table view is used.
See also
UseColumnForeColor (RT Professional)
Description
Specifies the settings for the font color of the columns.

VB scripting
Syntax
Object.UseColumnForeColor[=BOOLEAN]
Object
BOOLEAN
Optional.
TRUE if the font color specified with "TableForeColor (Page 992)" is used.
FALSE, if the font color specified for the columns in the table view is used.
See also
UseCurserKeyScroll (RT Advanced)
Description
See also
Used (RT Professional)
Description
Returns the size of the used disk space.
Syntax
Object.Used[=DOUBLE]
Object
● DiscSpaceView
DOUBLE
Optional A value or a constant that returns the size of the used disk space.

VB scripting
See also
UseDesignColorSchema (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies whether the colors defined in the global color scheme of the current design are to
be used for this object.
Access in runtime:
Syntax
Object.UseDesignColorSchema[=BOOLEAN]
Object
Required. An object of the "ScreenItem" type with the following format:
● Bar
● Button
● CheckBox
● Circle
● CircleSegment
● CircularArc
● Clock
● ComboBox
● Connector
● Ellipse
● EllipseSegment
● EllipticalArc
● Gauge
● GraphicView
● IOField
● Line
● ListBox
● MultiLineEdit
● OptionGroup

VB scripting
● Polygon
● Polyline
● Rectangle
● RoundButton*
● Slider*
● TextField
● TubeArcObject
● TubeTeeObject
● Tubepolyline
● WindowSlider*
*: Read access only

● AlarmView
● DateTimeField
● RecipeView
● StatusForce
● Switch
● SysDiagControl
● TrendView
● UserView
BOOLEAN
Optional.
TRUE if the object is displayed with the colors from the global color scheme defined for this
object type.
FALSE if the object is displayed with the colors as per the settings in the object.
UseDesignShadowSettings (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies whether the object is displayed with global shading. The global shading is specified
in the current design.

VB scripting
Syntax
Object.UseDesignShadowSettings[=BOOLEAN]
Object
● Bar
● Button
● CheckBox
● CircleSegment
● CircularArc
● Clock
● ComboBox
● Connector
● EllipseSegment
● EllipticalArc
● Gauge
● GraphicIOField
● GraphicView
● IOField
● Line
● ListBox
● MultiLineEdit
● OptionGroup
● Polyline
● RoundButton
● Slider
● SymbolicIOField
● TextField
● TubeArcObject
● TubeTeeObject
● Tubepolyline
● WindowSlider
● CircleSegment

VB scripting
BOOLEAN
Optional.
TRUE if the object is displayed with the global shading specified for this object type.
FALSE if the object is displayed without shadowing.
See also
Circle (Page 278)
Ellipse (Page 299)
Line (Page 336)
Polygon (Page 378)
Polyline (Page 381)
Bar (Page 257)
Button (Page 265)
CheckBox (Page 274)
Clock (Page 286)
ComboBox (Page 289)
Gauge (Page 319)
IOField (Page 331)
Listbox (Page 339)
Slider (Page 409)

VB scripting

UsedPercent (RT Professional)
Description
Specifies the measured value for the used disk space as a percentage. The values can be
queried in Runtime. The values cannot be predefined.
Syntax
Object.UsedPercent[=Int32]
Object
● DiscSpaceView
Int32
Optional A value or a constant that returns the measured values for the used disk space as a
percentage.
See also
UseExponentialFormat (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies whether the figures are shown exponentially (e.g. "1.00e+000").
Syntax
Object.UseExponentialFormat[=BOOLEAN]
Object
● Bar
BOOLEAN
Optional TRUE, if the figures are shown exponentially (e.g. "1.00e+000").

VB scripting
See also
Bar (Page 257)
UseFirstGradient (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
UseFlashTransparentColor (RT Professional)
Description
Specifies whether the color of the bitmap object of a flashing graphic will be set to
""transparent".
Syntax
Object.UseFlashTransparentColor[=BOOLEAN]
Object
● "GraphicIOField"
BOOLEAN
Optional. TRUE, if the color of the bitmap object of a flashing graphic will be set to "transparent".
See also
UseMessageColor (RT Professional)
Description
Specifies whether the agreed colors of the message classes are displayed.
Syntax
Object.UseMessageColor [=BOOLEAN]

VB scripting
Object
● AlarmControl
BOOLEAN
Optional.
TRUE if the colors are displayed.
FALSE if the color settings specified for the table content on the "Layout" tab are effective.
See also
UserData (Professional) (RT Professional)
Description
Specifies the value that is passed to the VB script when a user-defined menu entry or toolbar
button is executed.
Use the "Data" field in the "Menus and toolbars" editor to pass a parameter to the procedure.
Syntax
Object.UserData[=String]
Object
Required A "Item"-type object.
String
Optional. A value or constant that is passed to the VB script when a user-defined menu entry
or toolbar button is executed.

VB scripting
Example
The following example shows the script "ChangeScreen" that is executed when you click a
user-defined menu item. You transfer the screen name to the script with the "Data" field.
Sub ChangeScreen (ByVal Item)

Dim objScreen, strScreenName
' "UserData" contains the screen name specified
' in editor menus and toolbars.
strScreenName = Item.Userdata
HMIRuntime.BaseScreenName = strScreenName
End Sub
UserName (RT Professional)
Description
Returns the name of the user who triggered the alarm object.
UseScadaRendererStyle (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
UseSecondGradient (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
UseSelectedTitleColor (RT Professional)
Description
Specifies whether a selection color is used for the headers of selected table cells.
Syntax
Object.UseSelectedTitleColor[=BOOLEAN]

VB scripting
Object
● AlarmControl
BOOLEAN
Optional.
TRUE if a highlight color is used. The "Background" and "Font" settings are active in Runtime.
FALSE if a highlight color is not used. The "Background" and "Font" settings are disabled in
Runtime.
See also
UseSourceBackColors (RT Professional)
Description
Specifies that the background color of the data source is used.
Syntax
Object.UseSourceBackColors[=BOOLEAN]
Object
BOOLEAN
Optional.
TRUE, if the background color of the connected trend or table view is used.
FALSE, if the background color configured in the value table is used.

VB scripting
See also
UseSourceForeColors (RT Professional)
Description
Specifies that the font color of the data source is used.
Syntax
Object.UseSourceForeColors[=BOOLEAN]
Object
BOOLEAN
Optional.
TRUE, if the font color of the connected trend or table view is used.
FALSE, if the font color configured in the value table is used.
See also
UseSystemScrollbarWidth (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
UseTableColor2 (RT Professional)
Description
Specifies whether a second row color is used for the representation of the table.

VB scripting
Syntax
Object.UseTableColor2[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
Optional.
TRUE if the background colors from "TableColor (Page 990)" and "TableColor2 (Page 990)"
are used alternately.
FALSE if the background colors from "TableColor (Page 990)" are used for all rows.
See also
TableColor2 (Page 990)
UseTableHeaderFirstGradient (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
UseTableHeaderSecondGradient (Panels, Comfort Panels, RT Advanced, RT Professional)
Description

VB scripting
UseTagLimitColors (RT Professional)
Description
Specifies whether the violation of the configured high and low limits for the object are
highlighted in color.
Syntax
Object.UseTagLimitColors[=BOOLEAN]
Object
● IOField
BOOLEAN
Optional. TRUE if the limits are highlighted in color.
See also
IOField (Page 331)
UseTransparentColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies whether the color defined with the "TransparentColor" property is shown as
transparent.
Syntax
Object.UseTransparentColor[=BOOLEAN]
Object
● GraphicIOField
● GraphicView
BOOLEAN
Optional. TRUE if the specified color is to be shown as transparent.

VB scripting
See also
UseTransparentColorDeactivatedPicture (RT Professional)
Description
Specifies if the transparent color defined with the property
"TransparentColorDeactivatedPicture" for the status "disabled" will be used.
Syntax
Object.UseTransparentColorDeactivatedPicture[=BOOLEAN]
Object
● RoundButton
BOOLEAN
Optional. TRUE, if the transparent color defined with the property
"TransparentColorDeactivatedPicture" for the status "disabled" is used.
See also
UseTransparentColorPictureOff (RT Professional)
Description
Specifies if the transparent color defined with the property "TransparentColorPictureOff" for
the "off" status will be used.
Syntax
Object.UseTransparentColorPictureOff[=BOOLEAN]

VB scripting
Object
● Button
● RoundButton*
*: Read access only
BOOLEAN
"TransparentColorPictureOff" for the "off" status is used.
UseTransparentColorPictureOn (RT Professional)
Description
Specifies if the transparent color defined with the property "TransparentColorPictureOn" for
the "on" status will be used.
Syntax
Object.UseTransparentColorPictureOn[=BOOLEAN]
Object
● Button
● RoundButton*
*: Read access only
BOOLEAN
"TransparentColorPictureOn" for the "on" status is used.
UseTrendNameAsLabel (RT Professional)
Description
Specifies whether the "Name" or "Label" property is used as a designation for the trend in
runtime.
Syntax
Object.UseTrendNameAsLabel[=BOOLEAN]

VB scripting
Object
BOOLEAN
Optional.
TRUE if the name configured under "Properties > Properties > Trends > Name" is used.
FALSE if the name configured under "Properties > Properties > Trends > Label" is used.
See also
UseTwoHandOperation (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
UseUdp (RT Professional)
Description
UV_ColumnWidth_AKZ (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
UV_ColumnWidth_Descriptor (Panels, Comfort Panels, RT Advanced, RT Professional)
Description

VB scripting
UV_ColumnWidth_InstallationDate (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
UV_ColumnWidth_LADDR (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
UV_ColumnWidth_Name (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
UV_ColumnWidth_OKZ (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
UV_ColumnWidth_OperationState (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
UV_ColumnWidth_OrderID (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
UV_ColumnWidth_ProfileID (Panels, Comfort Panels, RT Advanced, RT Professional)
Description

VB scripting
UV_ColumnWidth_Rack (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
UV_ColumnWidth_Slot (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
UV_ColumnWidth_SoftwareRevision (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
UV_ColumnWidth_SpecificProfileData (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
UV_ColumnWidth_State (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
UV_ColumnWidth_Station (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
UV_ColumnWidth_SubAddress (Panels, Comfort Panels, RT Advanced, RT Professional)
Description

VB scripting
UV_ColumnWidth_SubSlot (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
UV_ColumnWidth_SubSystem (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
UV_ColumnWidth_Type (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
UV_ShowItem_AKZ (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
UV_ShowItem_Descriptor (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
UV_ShowItem_InstallationDate (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
UV_ShowItem_LADDR (Panels, Comfort Panels, RT Advanced, RT Professional)
Description

VB scripting
UV_ShowItem_Name (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
UV_ShowItem_OKZ (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
UV_ShowItem_OperationState (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
UV_ShowItem_OrderID (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
UV_ShowItem_ProfileID (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
UV_ShowItem_Rack (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
UV_ShowItem_Slot (Panels, Comfort Panels, RT Advanced, RT Professional)
Description

VB scripting
UV_ShowItem_SoftwareRevision (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
UV_ShowItem_SpecificProfileData (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
UV_ShowItem_State (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
UV_ShowItem_Station (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
UV_ShowItem_SubAddress (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
UV_ShowItem_SubSlot (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
UV_ShowItem_SubSystem (Panels, Comfort Panels, RT Advanced, RT Professional)
Description

VB scripting
UV_ShowItem_Type (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Value (RT Professional)
Description
Specifies a value for the object being used or returns it.
Access during runtime: Read and write
Syntax
Object.Value[=VARIANT]
Object
Necessary. An object of type "Tag", "DataItem" or "ScreenItem" with the format "Gauge".
VARIANT
Optional The value that is specified dependent on the object being used:
● Tag.Value: returns the tag value for the last read access or specifies the future tag value.
Use the "Read" method to read the tag value from the "Value" property. You assign a new
tag value to the "Value" property with the "Write" method.
● Dataset.Value: Specifies a value or returns a copy of the value or the object reference.
When returning object references, ensure that the object reference is multithread-capable.
● ScreenItem("Gauge_1").Value: Specifies the value to which the pointer points. The value
range within the values set via the properties "ValueMin",and "ValueMax".
Examples
The following example writes a new value in the "Tag1" tag:
'VBS94
Dim objTag
objTag.Value = 50
objTag.Write

VB scripting
The example shows how to add a value to a list of tags and output it as a trace. After that, the
value is changed, output again and then removed. It make sense to perform this in several
different actions:
'VBS198
HMIRuntime.DataSet.Add "motor1", 23
HMIRuntime.DataSet("motor1").Value = 55
See also
DataItem (Page 202)
Tag (Page 227)
Gauge (Page 319)
ValueAxes (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ValueAxis1AutoRange (RT Advanced)
Description
ValueAxis1Begin (RT Advanced)
Description
ValueAxis1End (RT Advanced)
Description

VB scripting
ValueAxis1LabelLength (RT Advanced)
Description
ValueAxis1Style (RT Advanced)
Description
ValueAxis2AutoRange (RT Advanced)
Description
ValueAxis2Begin (RT Advanced)
Description
ValueAxis2End (RT Advanced)
Description
ValueAxis2LabelLength (RT Advanced)
Description
ValueAxis2Style (RT Advanced)
Description

VB scripting
ValueAxisAdd (RT Professional)
Description
Creates a new value axis. The newly created value axis is automatically referenced with
"ValueAxisIndex".
Syntax
Object.ValueAxisAdd[=STRING]
Object
STRING
Required. A value or a constant that specifies the name of the new value axis with
"ValueAxisName".
See also
ValueAxisIndex (Page 1179)
ValueAxisAlignment (RT Professional)
Description
Specifies the alignment of the value axis referenced with "ValueAxisIndex".
Syntax
Object.ValueAxisAlignment[=AxisAlignment]
Object

VB scripting
AxisAlignment
Optional. A value or a constant that specifies the alignment of the value axis.

0 Left The value axis selected is displayed to the left of the trend
1 Right The value axis selected is displayed to the right of the trend.
See also
ValueAxisAutoPrecisions (RT Professional)
Description
Specifies whether the number of decimal places for a value axis referenced with
"ValueAxisIndex" is set automatically.
Syntax
Object.ValueAxisAutoPrecisions[=BOOLEAN]
Object
BOOLEAN
Optional.
FALSE if the value of "ValueAxisPrecisions" is used.
See also
ValueAxisPrecisions (Page 1182)

VB scripting
ValueAxisAutoRange (RT Professional)
Description
Specifies whether the value range of a value axis referenced with "ValueAxisIndex" is
calculated automatically.
Syntax
Object.ValueAxisAutoRange[=BOOLEAN]
Object
BOOLEAN
Optional.
TRUE if the value range is calculated automatically.
FALSE if the value range is specified with "ValueAxisBeginValue" and "ValueAxisEndValue".
See also
ValueAxisBeginValue (Page 1176)
ValueAxisEndValue (Page 1178)
ValueAxisBeginValue (RT Professional)
Description
Specifies the lower end of the value range of a value axis referenced with "ValueAxisIndex".
Also set "ValueAxisAutoRange" to "FALSE".
Syntax
Object.ValueAxisBeginValue[=DOUBLE]
Object

VB scripting
DOUBLE
Optional. A value or a constant that specifies the low limit of the value range of the referenced
value axis.
See also
ValueAxisAutoRange (Page 1175)
ValueAxisColor (RT Professional)
Description
Specifies the color of a value axis referenced with "ValueAxisIndex". This property is only
evaluated if the "ValueAxisInTrendColor (Page 1180)" property is set to "FALSE".
Syntax
Object.ValueAxisColor[=Color]
Object
Color
Optional. A value or a constant that specifies the color of the value axis.
Comments
RGB (255, 0, 0)
See also

VB scripting
ValueAxisCount (RT Professional)
Description
Specifies the number of configured value axes.
Syntax
Object.ValueAxisCount[=Int32]
Object
Int32
Optional. A value or a constant that specifies the number of configured value axes.
See also
ValueAxisEndValue (RT Professional)
Description
Specifies the upper end of the value range of a value axis referenced with "ValueAxisIndex".
Also set "ValueAxisAutoRange" to "FALSE".
Syntax
Object.ValueAxisEndValue[=DOUBLE]
Object
DOUBLE
Optional. A value or a constant that specifies the high limit of the value range of the referenced
value axis.

VB scripting
See also
ValueAxisAutoRange (Page 1175)
ValueAxisExponentialFormat (RT Professional)
Description
Specifies whether the values of a value axis referenced with "ValueAxisIndex" are displayed
in exponential notation.
Syntax
Object.ValueAxisExponentialFormat[=BOOLEAN]
Object
BOOLEAN
Optional.
See also
ValueAxisIndex (RT Professional)
Description
References a value axis. To access the properties of a value axis, you need to set
""ValueAxisIndex"".
Values between 0 and "ValueAxisCount" minus 1 are valid for "ValueAxisIndex". The
"ValueAxisCount" property specifies the number of configured value axes.

VB scripting
Syntax
Object.ValueAxisIndex[=Int32]
Object
Int32
Optional. A value or a constant that specifies, with the index, the value axis to be edited.
See also
ValueAxisInTrendColor (RT Professional)
Description
Specifies whether the color of the axis referenced with "ValueAxisIndex" corresponds to the
trend color.
Syntax
Object.ValueAxisInTrendColor[=BOOLEAN]
Object
BOOLEAN
Optional.
TRUE if the referenced axis is shown in the trend color. The value of "ValueAxisColor" is not
effective.
FALSE if the referenced axis is shown in the color specified in "ValueAxisColor".
See also

VB scripting
ValueAxisLabel (RT Professional)
Description
Defines the label text for a value axis referenced with "ValueAxisIndex".
Syntax
Object.ValueAxisLabel[=STRING]
Object
STRING
Optional. A value or a constant that specifies the label text for the referenced value axis.
See also
ValueAxisName (RT Professional)
Description
Specifies the name of a value axis referenced with "ValueAxisIndex".
Syntax
Object.ValueAxisName[=STRING]
Object
STRING
Optional. A value or a constant that specifies the name of the referenced value axis.

VB scripting
See also
ValueAxisPrecisions (RT Professional)
Description
Specifies the number of decimal places for the label of the value axis referenced with
"ValueAxisIndex".
Syntax
Object.ValueAxisPrecisions[=Int16]
Object
Int16
See also
ValueAxisRemove (RT Professional)
Description
Removes a value axis referenced with its name.
Syntax
Object.ValueAxisRemove[=STRING]
Object

VB scripting
STRING
Optional. A value or a constant that specifies the name of the referenced value axis to be
removed.
See also
ValueAxisRename (RT Professional)
Description
Specifies the new name of a value axis referenced with "ValueAxisIndex".
Syntax
Object.ValueAxisRename[=STRING]
Object
STRING
Optional. A value or a constant that specifies the new name of the value axis.
See also
ValueAxisRepos (RT Professional)
Description
Specifies the position of a value axis referenced with "ValueAxisIndex".
If you have changed the position of the value axis with "ValueAxisRepos", "ValueAxisIndex"
is assigned the value of "ValueAxisRepos".
Syntax
Object.ValueAxisRepos[=Int32]

VB scripting
Object
Int32
Optional. A value or a constant that specifies the position of the referenced value axis. Value
range from 0 to "ValueAxisCount" minus 1. Values outside this range have no effect.
0: The referenced value axis is positioned outside.
See also
ValueAxisScalingType (RT Professional)
Description
Specifies the type of scaling for the value axis referenced with "ValueAxisIndex".
Syntax
Object.ValueAxisScalingType[=AxisScalingType]
Object
AxisScalingType
Optional. A value or a constant that specifies the type of scaling for the referenced value axis.
Value VB constant Designation

0 hmiBarScalingLinear Linear
1 hmiBarScalingLogarithmic Logarithmic
2 hmiBarScalingNegativeLogarithmic Negative logarithmic
See also

VB scripting
ValueAxisTrendWindow (RT Professional)
Description
Specifies the trend diagram in which the axis referenced with "ValueAxisIndex" is displayed.
Syntax
Object.ValueAxisTrendWindow[=STRING]
Object
STRING
See also
ValueAxisVisible (RT Professional)
Description
Specifies whether the value axis referenced with "ValueAxisIndex" is displayed in the object.
Syntax
Object.ValueAxisVisible[=BOOLEAN]
Object
BOOLEAN
Optional.
TRUE if the referenced value axis is displayed.
FALSE if the referenced value axis is not displayed.

VB scripting
See also
ValueCaption (RT Advanced)
Description
ValueColumnAdd (RT Professional)
Description
Creates a new value column. The newly created value column is automatically referenced with
"ValueColumnIndex".
Syntax
Object.ValueColumnAdd[=STRING]
Object
STRING
Required. A value or a constant that specifies the name of the new value column with
"ValueColumnName".
See also
ValueColumnIndex (Page 1192)
ValueColumnAlignment (RT Professional)
Description
Specifies how the text in the value column referenced with "ValueColumnIndex" is aligned.

VB scripting
Syntax
Object.ValueColumnAlignment[=HorizontalAlignment]
Object
HorizontalAlignment
Optional. A value or a constant that specifies how the text in the referenced value column is
aligned.

1 hmiAlignmentCentered The text is centered.
2 hmiAlignmentRight The text is right-justified.
See also
ValueColumnAutoPrecisions (RT Professional)
Description
Specifies whether the number of decimal places for a value axis referenced with
"ValueColumnIndex" is set automatically.
Syntax
Object.ValueColumnAutoPrecisions[=BOOLEAN]
Object
BOOLEAN
Optional.
FALSE if the value of "ValueColumnPrecisions" is used.

VB scripting
See also
ValueColumnPrecisions (Page 1193)
ValueColumnBackColor (RT Professional)
Description
Specifies the background color of the value column referenced with "ValueColumnIndex".
Also set "UseColumnBackColor (Page 1148)" to "TRUE".
Syntax
Object.ValueColumnBackColor[=Color]
Object
Color
Optional. A value or a constant that specifies the background color.
Comments
RGB (255, 0, 0)
See also
ValueColumnCaption (RT Professional)
Description
Specifies the name of the value column referenced with "ValueColumnIndex".

VB scripting
Syntax
Object.ValueColumnCaption[=STRING]
Object
STRING
Optional. A value or a constant that specifies the name of the value column.
See also
ValueColumnCount (RT Professional)
Description
Specifies the number of configured value columns.
Syntax
Object.ValueColumnCount[=Int32]
Object
Int32
Optional. A value or a constant that specifies the number of configured value columns.
See also
ValueColumnExponentialFormat (RT Professional)
Description
Specifies whether the values of a value column referenced with "ValueColumnIndex" are
displayed in exponential notation.

VB scripting
Syntax
Object.ValueColumnExponentialFormat[=BOOLEAN]
Object
BOOLEAN
Optional.
See also
ValueColumnForeColor (RT Professional)
Description
Specifies the font color of the value column referenced with "ValueColumnIndex".
Also set "UseColumnForeColor (Page 1148)" to "TRUE".
Syntax
Object.ValueColumnForeColor[=Color]
Object
Color
Comments
RGB (255, 0, 0)

VB scripting
See also
ValueColumnHideText (RT Professional)
Description
Specifies whether the text in the value column referenced with "ValueColumnIndex" is hidden.
Syntax
Object.ValueColumnHideText[=BOOLEAN]
Object
BOOLEAN
Optional.
TRUE, if the text in the value column is hidden.
FALSE, if the text in the value column is displayed.
See also
ValueColumnHideTitleText (RT Professional)
Description
Specifies whether the text in the header of the value column referenced with
"ValueColumnIndex" is hidden.
Syntax
Object.ValueColumnHideTitleText[=BOOLEAN]
Object

VB scripting
BOOLEAN
Optional.
TRUE, if the text in the header of the value column is hidden.
FALSE, if the text in the header of the value column is displayed.
See also
ValueColumnIndex (RT Professional)
Description
References a value column. To access the properties of a value column, you need to set
""ValueColumnIndex"".
Values between 0 and "ValueColumnCount" minus 1 are valid for "ValueColumnIndex". The
"ValueColumnCount" property specifies the number of configured value columns.
Syntax
Object.ValueColumnIndex[=Int32]
Object
Int32
Optional. A value or a constant that specifies, with the index, the value column to be edited.
See also
ValueColumnCount (Page 1188)
ValueColumnLength (RT Professional)
Description
Specifies the width in characters of the value column referenced with "ValueColumnIndex".

VB scripting
Syntax
Object.ValueColumnLength[=Int32]
Object
Int32
Optional. A value or a constant that specifies the number of characters displayed.
See also
ValueColumnName (RT Professional)
Description
Specifies the name of a value column referenced with "ValueColumnIndex".
Syntax
Object.ValueColumnName[=STRING]
Object
STRING
Optional. A value or a constant that specifies the name of the referenced value column.
See also
ValueColumnPrecisions (RT Professional)
Description
Specifies the number of decimal places for values in the value column referenced with
"ValueColumnIndex".

VB scripting
Syntax
Object.ValueColumnPrecisions[=Int16]
Object
Int16
Optional. A value or constant that specifies the number of decimal places.
See also
ValueColumnProvider (RT Professional)
Description
Specifies the data source for the value column referenced with "ValueColumnIndex".
Syntax
Object.ValueColumnProvider[=STRING]
Object
STRING
Optional. A value or a constant that specifies the data supply of a value column.
Value Description
Logging tags Data source with archive tags of a process value archive.
Tags Data supply with online
tags from tag management.
See also

VB scripting
ValueColumnProviderCLSID (RT Professional)
Description
Specifies the provider CLSID of the data for a value column referenced with
"ValueColumnIndex".
Syntax
Object.ValueColumnProviderCLSID[=STRING]
Object
STRING
Optional. A value or a constant that specifies the provider CLSID.
Value Description
{416A09D2-8B5A-11D2-8B81-006097A Data source with archive tags of a process value archive.
45D48}
{A3F69593-8AB0-11D2- Data supply with online
A440-00A0C9DBB64E} tags from tag management.
See also
ValueColumnRemove (RT Professional)
Description
Removes a value column referenced with its name.
Syntax
Object.ValueColumnRemove[=STRING]
Object

VB scripting
STRING
Optional. A value or a constant that specifies the name of the referenced value column to be
removed.
See also
ValueColumnRename (RT Professional)
Description
Specifies the new name of a value column referenced with "ValueColumnIndex".
Syntax
Object.ValueColumnRename[=STRING]
Object
STRING
Optional. A value or a constant that specifies the new name of the value column.
See also
ValueColumnRepos (RT Professional)
Description
Specifies the position of a value column referenced with "ValueColumnIndex".
If you have changed the position of the value column with "ValueColumnRepos",
"ValueColumnIndex" is assigned the value of "ValueColumnRepos".
Syntax
Object.ValueColumnRepos[=Int32]

VB scripting
Object
Int32
Optional. A value or a constant that specifies the position of the referenced value column.
Value range from 0 to "ValueColumnCount" minus 1. Values outside this range have no effect.
0: The referenced value column is positioned on the left.
See also
ValueColumnCount (Page 1188)
ValueColumns (RT Professional)
Description
ValueColumnSelectTagName (RT Professional)
Description
Specifies that the dialog for selecting the tag name of the data source for the value column
referenced with "ValueColumnIndex" is displayed in Runtime initial.
Syntax
Object.ValueColumnSelectTagName[=BOOLEAN]
Object
BOOLEAN
Optional.
TRUE, if the dialog for selecting the tag name for the data source of the value column is
FALSE, if no dialog for selecting the tag name for the data source of the value column is

VB scripting
See also
ValueColumnShowIcon (RT Professional)
Description
Specifies whether an icon is displayed in the value column referenced with
"ValueColumnIndex".
Syntax
Object.ValueColumnShowIcon[=BOOLEAN]
Object
BOOLEAN
Optional.
TRUE, if an icon is shown.
FALSE, if no icon is shown.
See also
ValueColumnShowTitleIcon (RT Professional)
Description
Specifies whether an icon is displayed in the header of the value column referenced with
"ValueColumnIndex".
Syntax
Object.ValueColumnShowTitleIcon[=BOOLEAN]
Object

VB scripting
BOOLEAN
Optional.
TRUE, if an icon is shown in the title of the current column.
FALSE, if no icon is shown in the title of the current column.
See also
ValueColumnSort (RT Professional)
Description
Specifies the type of sorting for the value column referenced with "ValueColumnIndex".
Syntax
Object.ValueColumnSort[=SortMode]
Object
SortMode
Optional. A value or a constant that specifies the type of sorting in the current column.

0 No sorting The values in the column are not sorted.
1 Ascending order The values in the value column are sorted from lowest to highest value,
starting from the top row.
2 Descending order The values in the value column are sorted from highest to the lowest value,
starting from the lowest row.
See also
ValueColumnSortIndex (RT Professional)
Description
Specifies the sorting order.

VB scripting
Syntax
Object.ValueColumnSortIndex[=Int32]
Object
Int32
Optional. A value or a constant that specifies the order when sorting.
See also
ValueColumnTagName (RT Professional)
Description
Specifies the names of the tags whose values are displayed in the value column referenced
with "ValueColumnIndex".
Syntax
Object.ValueColumnTagName[=STRING]
Object
STRING
Optional. A value or a constant that specifies the name of the tag whose values are displayed
in the current column.
See also
ValueColumnTimeColumn (RT Professional)
Description
Specifies the associated time column.

VB scripting
Syntax
Object.ValueColumnTimeColumn[=STRING]
Object
STRING
Optional. A value or a constant that specifies the associated time column.
See also
ValueColumnVisible (RT Professional)
Description
Specifies whether the value column referenced with "ValueColumnIndex" is displayed in the
object.
Syntax
Object.ValueColumnVisible[=BOOLEAN]
Object
BOOLEAN
Optional.
TRUE if the referenced value column is displayed.
FALSE if the referenced value column is not displayed.
See also

VB scripting
ValueColumnWidth (RT Advanced)
Description
ValueTableHeight (RT Advanced)
Description
ValueTableLeft (RT Advanced)
Description
ValueTableTop (RT Advanced)
Description
ValueTableWidth (RT Advanced)
Description
ValueY1HlpLine (RT Advanced)
Description
ValueY2HlpLine (RT Advanced)
Description

VB scripting
VerticalAlignment (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the vertical alignment of the text in the specified object.
Syntax
Object.VerticalAlignment[=VerticalAlignment]
Object
● Button
● CheckBox
● DateTimeField
● IOField
● OptionGroup
● RoundButton *
● Switch *
● SymbolicIOField **
● TextField
* Read access only
** RT Professional, read access only
VerticalAlignment
Optional. A value that specifies the vertical alignment.

0 hmiAlignmentTop The text is shown at the top.
1 hmiAlignmentMiddle The text is shown in the middle.
2 hmiAlignmentBottom The text is shown at the bottom.
See also
Button (Page 265)
IOField (Page 331)
Switch (Page 419)

VB scripting

CheckBox (Page 274)
VerticalGridLines (RT Professional)
Description
Specifies whether vertical separation lines are displayed.
Syntax
Object.VerticalGridLines[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
Optional.
TRUE if vertical separation lines are displayed.
FALSE if vertical separation lines are not displayed.
See also
VerticalPictureAlignment (Panels, Comfort Panels, RT Advanced, RT Professional)
Description

VB scripting
VerticalScrollBarEnabled (RT Advanced)
Description
VerticalScrollbarPosition (RT Professional)
Description
Specifies the position of the slider in the object's vertical scroll bar. The screen is displayed in
the screen window with the vertical shift of the scroll bar's slider.
To display the screen as a cutout where the scroll bars are located at the left and top edge of
the screen, use the LeftOffset (Page 777)" and "LeftOffset (Page 777)" properties as the source
of this cutout.
Syntax
Object.VerticalScrollBarPosition[=Int32]
Object
● Screenwindow
Int32
Optional. A value or a constant that specifies the vertical position of the slider in the object's
scroll bar.
See also
TopOffset (Page 1087)
VerticalScrolling (Panels, Comfort Panels, RT Advanced, RT Professional)
Description

VB scripting
VerticalScrollingEnabled (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ViewOnly (RT Advanced)
Description
Specifies whether the Sm@rtClient display will be used for remote monitoring or remote
maintenance.
Remote maintenance means that settings can be changed on the monitored device.
Remote monitoring means that settings of the monitored device cannot be changed.
Syntax
Object.ViewOnly[=BOOLEAN]
Object
● SmartClientView
BOOLEAN
Optional TRUE, if the Sm@rtClient display is to be used only for remote monitoring.
See also
ViewType (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
ViewTypeForSaveStream (Panels, Comfort Panels, RT Advanced, RT Professional)
Description

VB scripting
Access in Runtime:
Syntax
Object.ViewTimeForSaveStream[=[!]: AlarmViewBasicMode | Int16 | PasswordViewType]
Object
● RecipeView
● AlarmView
● UserView
[!]: AlarmViewBasicMode | Int16 | PasswordViewType:

Optional. tbd tbd tbd tbd are.
Visible (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies whether the selected object is visible.
Syntax
Object.Visible[=BOOLEAN]
Object
Required. An object of the type "ScreenItem"" with the format:
● AlarmControl
● AlarmView
● Bar
● BatteryView
● Button
● ChannelDiagnose
● CheckBox
● CircleSegment

VB scripting
● CircularArc
● ComboBox
● Connector
● DateTimeField
● DiscSpaceView
● EllipseSegment
● EllipticalArc
● Gauge
● GraphicIOField
● GraphicView
● HTMLBrowser
● IOField
● ListBox
● MediaPlayer
● MultiLineEdit
● OptionGroup
● PLCCodeViewer
● ProDiagOverview
● RangeLabelView
● RecipeView
● RoundButton
● S7GraphOverview
● ScreenWindow
● SmartClientView
● StatusForce
● Switch
● SymbolLibrary
● SymbolicIOField
● SysDiagControl

VB scripting
● TrendView
● TubeArcObject
● TubeTeeObject
● Tubepolyline
● WLanQualityView
● WindowSlider
● ZoneLabelView
● ZoneQualityView
● PdfView
BOOLEAN
Optional. TRUE, if the object is visible.
See also
Bar (Page 257)
Button (Page 265)
CheckBox (Page 274)
Circle (Page 278)
Clock (Page 286)
ComboBox (Page 289)
Ellipse (Page 299)

VB scripting
Gauge (Page 319)

IOField (Page 331)
Line (Page 336)
Listbox (Page 339)
Polygon (Page 378)
Polyline (Page 381)
Slider (Page 409)
Switch (Page 419)

VB scripting

UserView (Page 480)
VisibleItems (RT Advanced)
Description
Warning (RT Professional)
Description
Specifies the percentage of used memory space as of which a warning is to be generated.
Syntax
Object.Warning[=Int32]
Object
● DiskSpaceView
Int32
Optional. A value or a constant that specifies the percentage of used storage space as of which
a warning is generated.
See also

VB scripting
WarningColor (RT Professional)
Description
Specifies the color in which the bar of the memory space view will be shown as soon as the
warning level is reached.
Syntax
Object.WarningColor[=Color]
Object
● DiskSpaceView
Color
Optional. A value or a constant that specifies the color in which the bar of the storage space
display will be shown as soon as the warning area is exceeded.
Comments
RGB (255, 0, 0)
See also
WarningLowerLimit (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the lower limit for "WarningLowerLimit".
The "WarningLowerLimitEnable" property must have the value "TRUE" for the limit to be
monitored.
Syntax
Object.WarningLowerLimit[=DOUBLE]

VB scripting
Object
● Bar
DOUBLE
Optional A value or a constant that specifies the lower limit for "WarningLowerLimit".
Comments
The following values will be specified with the properties "WarningLowerLimitColor" and
"WarningLowerLimitRelative":
See also
Bar (Page 257)
WarningLowerLimitColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the color for the low limit "WarningLowerLimit".
The "WarningLowerLimitEnable" property must have the value "TRUE" if the bar color is to
change when the limit is reached.
Syntax
Object.WarningLowerLimitColor[=Color]
Object
● Bar
Color
Optional. A value or a constant that specifies the color for the lower limit "WarningLowerLimit".
Comments
RGB (255, 0, 0)

VB scripting
The following values are defined with the "WarningUpperLimit", "WarningUpperLimitColor" and
"WarningUpperLimitRelative" properties:
● Limit
See also
Bar (Page 257)
WarningLowerLimitEnabled (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies whether the "WarningLowerLimit" limit is to be monitored.
Syntax
Object.WarningLowerLimitEnabled[=BOOLEAN]
Object
● Bar
BOOLEAN
Optional TRUE, if the "WarningLowerLimit" limit is monitored.
Comments
The following values will be defined via the properties "WarningLowerLimit",
"WarningLowerLimitColor" and "WarningLowerLimitRelative":
● Limit
See also
Bar (Page 257)

VB scripting
WarningLowerLimitRelative (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies whether the low limit "WarningLowerLimit" is evaluated as a percentage or as an
absolute value.
Syntax
Object.WarningLowerLimitRelative[=BOOLEAN]
Object
● Bar
BOOLEAN
Optional.
TRUE if the low limit "WarningLowerLimit" is to be evaluated as a percentage.
FALSE if the low limit "WarningLowerLimit" is to be evaluated as an absolute value.
See also
Bar (Page 257)
WarningRangeColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the color of the warning range on the scale of the "Gauge" object.
The "WarningRangeVisible" property must have the value TRUE so that the warning range is
displayed.
Syntax
Object.WarningRangeColor[=Color]
Object
● Gauge
Color
Optional. A value or a constant that specifies the color of the warning range.

VB scripting
Comments
RGB (255, 0, 0)
See also
Gauge (Page 319)
WarningRangeStart (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies at which scale value the warning range of the "Gauge" object will start.
The "WarningRangeVisible" property must have the value TRUE so that the warning range is
displayed.
Syntax
Object.WarningRangeStart[=SINGLE]
Object
● Gauge
SINGLE
Optional A value or a constant that contains the scale value for the start of the warning range.
Comments
The range extends from the value "Warning" through to the value "Danger". If no range is
activated for "Danger", the range for "Warning" extends to the end of the scale.
See also
Gauge (Page 319)

VB scripting
WarningRangeVisible (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies whether the warning range in the scale of the "Gauge" object will be displayed.
Syntax
Object.WarningRangeVisible[=BOOLEAN]
Object
● Gauge
BOOLEAN
Optional TRUE, if the warning range will be displayed in the scale.
Comments
Specifies the color of the warning range with the "WarningRangeColor" property.
Specifies the start of the warning range with the "WarningRangeStart" property.
See also
Gauge (Page 319)
WarningUpperLimit (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the upper warning limit.
The "WarningUpperLimitEnabled"" property must have the value TRUE so that the limit is
monitored.
Syntax
Object.WarningUpperLimit[=DOUBLE]
Object
● Bar

VB scripting
DOUBLE
Optional A value or a constant that specifies the higher limit.
Comments
"WarningUpperLimitColor" defines the display for when the limit is reached.
"WarningUpperLimitRelative" specifies the type of evaluation.
See also
Bar (Page 257)
WarningUpperLimitColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the color for the high warning limit.
The ""WarningUpperLimitEnabled" property must have the value TRUE if the bar color is to
Access in runtime
Syntax
Object.WarningUpperLimitColor[=Color]
Object
● Bar
Color
Optional. A value or a constant that specifies the color for the higher limit.
Comments
RGB (255, 0, 0)

VB scripting
See also
Bar (Page 257)
WarningUpperLimitEnabled (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies whether the higher limit is to be monitored.
Access in runtime:
Syntax
Object.WarningUpperLimitEnabled[=BOOLEAN]
Object
● Bar
BOOLEAN
Optional. TRUE, if the higher limit is monitored.
WarningUpperLimitRelative (RT Professional)
Description
Specifies whether the high limit "WarningUpperLimit" is to be evaluated as a percentage or as
an absolute value.
Syntax
Object.WarningUpperLimitRelative[=BOOLEAN]
Object
● Bar
BOOLEAN
Optional. TRUE if the low limit "WarningUpperLimit" is to be evaluated as a percentage.

VB scripting
See also
Bar (Page 257)
Width (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies the width of the object in pixels.
Syntax
Object.Width[=Int32]
Object
● AlarmControl
● AlarmView*
● ChannelDiagnose
● CircularArc
● ComboBox
● DiscSpaceView
● EllipticalArc
● FunctionTrendControl*
● GraphicIOField*
● GraphicView*
● HTMLBrowser*
● ListBox
● MediaPlayer*
● MultiLineEdit
● PLCCodeViewer*
● ProDiagOverview*
● S7GraphOverview*
● ScreenWindow
● SmartClientView

VB scripting
● Switch*
● SymbolLibrary*
● TrendView*
● TubeArcObject
● TubeTeeObject
● WindowSlider
*: You have no access in "Runtime Advanced" and "Panel Runtime".
Int32
Optional. A value or a constant that specifies the width of the object in pixels.
See also
Bar (Page 257)
Button (Page 265)
CheckBox (Page 274)
Circle (Page 278)
Clock (Page 286)
ComboBox (Page 289)
Ellipse (Page 299)
Gauge (Page 319)

VB scripting

IOField (Page 331)
Line (Page 336)
Listbox (Page 339)
Polygon (Page 378)
Polyline (Page 381)
Slider (Page 409)
Switch (Page 419)

VB scripting

UserView (Page 480)
WindowCloseEnabled (RT Professional)
Description
Indicates whether a window can be closed in runtime.
Syntax
Object.WindowCloseEnabled[=BOOLEAN]
Object
● ScreenWindow
BOOLEAN
Optional. TRUE, if the window can be closed in runtime.
See also
WindowMaximizeEnabled (RT Professional)
Description
Returns whether the object can be maximized in runtime.
Syntax
Object.WindowMaximizeEnabled[=BOOLEAN]

VB scripting
Object
● Screenwindow
BOOLEAN
Optional.
TRUE if the object can be maximized in runtime.
FALSE if the object cannot be maximized in runtime.
See also
WindowMovingEnabled (RT Professional)
Description
Returns whether the object can be moved in runtime.
Syntax
Object.WindowMovingEnabled[=BOOLEAN]
Object
● Screenwindow
BOOLEAN
Optional.
TRUE if the object can be moved in runtime.
FALSE if the object cannot be moved in runtime.
See also

VB scripting
WindowOnTop (RT Professional)
Description
Returns whether the object always remains in the foreground in runtime.
Syntax
Object.WindowOnTop[=BOOLEAN]
Object
● Screenwindow
BOOLEAN
Optional.
TRUE if the object is always in the foreground in runtime.
FALSE if the object is not always in the foreground in runtime.
See also
WindowsContents (RT Professional)
Description
Returns the content of the print job or script diagnostics.
Syntax
Object.WindowsContents[=WindowContent]
Object

VB scripting
WindowContent
Optional. A value or a constant that returns the content displayed in the object.
Function An application of the global script is displayed. The templates used for this are defined in the
"Template (Page 1001)" property:
● GSC diagnostics
The results of the diagnostics system are displayed.
● GSC Runtime
The analysis results on characteristics in runtime are displayed.
Print jobs A report is displayed.
The templates used for this are specified in the "Template (Page 1001)" property:
See also
WindowSizingEnabled (RT Professional)
Description
Indicates whether the size can be changed.
Syntax
Object.WindowSizingEnabled[=BOOLEAN]
Object
● ScreenWindow
BOOLEAN
Optional. TRUE, if the size can be changed.
See also

VB scripting
WindowsStyle (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Specifies whether the object is displayed in the general Windows style.
Access in runtime:
● RT Advanced: NoAccess
Syntax
Object.WindowsStyle[=BOOLEAN]
Object
● Button
● WindowSlider
● Switch
BOOLEAN
Optional. TRUE, if the object will be displayed in the general Windows style.
See also
Button (Page 265)
Switch (Page 419)
WindowStartupPosition (RT Professional)
Description
Returns the position and the mode of the screen window when an independent screen window
is configured. Set "IndipendentWindow (Page 744)" to "TRUE".
Syntax
Object.WindowsStartupPosition[=PositionMode]

VB scripting
Object
● ScreenWindow
PositionMode
Optional. A value or a constant that returns the position and the mode of the screen window.
Maximized The screen window is adjusted to the monitor size.
As configured The screen window is displayed in the configured size and at the configured
position.
Centered The screen window is displayed in the configured size in a central position.
See also
1.5.5.15 Properties X-Z (Panels, Comfort Panels, RT Advanced, RT Professional)
XAxes (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
XAxisAdd (RT Professional)
Description
Creates a new X-axis. The newly created X-axis is automatically referenced with "XAxisIndex".
Syntax
Object.XAxisAdd[=STRING]
Object
STRING
Required. A value or a constant that specifies the name of the new X-axis with "XAxisName".

VB scripting
See also
XAxisIndex (Page 1234)
XAxisAlignment (RT Professional)
Description
Specifies the alignment of the X-axis referenced with "XAxisIndex".
Syntax
Object.XAxisAlignment[=AxisAlignment]
Object
AxisAlignment
Optional. A value or a constant that specifies the alignment of the X-axis in relation to the trend
window:
Value Designation
0 Left
1 Right
See also
XAxisAutoPrecisions (RT Professional)
Description
Specifies whether the number of decimal places for an X-axis referenced with "XAxisIndex" is
set automatically.
Syntax
Object.XAxisAutoPrecisions[=BOOLEAN]

VB scripting
Object
BOOLEAN
Optional.
FALSE if the value of "XAxisPrecisions" is used.
See also
XAxisAutoRange (RT Professional)
Description
Specifies whether the value range of an X-axis referenced with "XAxisIndex" is calculated
automatically.
Syntax
Object.XAxisAutoRange[=BOOLEAN]
Object
BOOLEAN
Optional.
FALSE if the value range is specified with "XAxisBeginValue" and "XAxisEndValue".
See also
XAxisEndValue (Page 1232)
XAxisBeginValue (Page 1231)

VB scripting
XAxisBeginValue (RT Professional)
Description
Specifies the lower end of the value range of an X-axis referenced with "XAxisIndex".
Also set "XAxisAutoRange" to "FALSE".
Syntax
Object.XAxisBeginValue[=DOUBLE]
Object
DOUBLE
X-axis.
See also
XAxisAutoRange (Page 1229)
XAxisColor (RT Professional)
Description
Specifies the color of an X-axis referenced with "XAxisIndex".
Also set "XAxisInTrendColor" to "FALSE".
Syntax
Object.XAxisColor[=Color]
Object

VB scripting
Color
Optional. A value or a constant that specifies the color of the referenced axis.
Comments
RGB (255, 0, 0)
See also
XAxisCount (RT Professional)
Description
Specifies the number of configured X-axes.
Syntax
Object.XAxisCount[=Int32]
Object
Int32
Optional. A value or a constant that specifies the number of configured X-axes.
See also
XAxisEndValue (RT Professional)
Description
Specifies the upper end of the value range of an X-axis referenced with "XAxisIndex".
Also set "XAxisAutoRange" to "FALSE".

VB scripting
Syntax
Object.XAxisEndValue[=DOUBLE]
Object
DOUBLE
X-axis.
See also
XAxisAutoRange (Page 1229)
XAxisExponentialFormat (RT Professional)
Description
Specifies whether the values of an X-axis referenced with "XAxisIndex" are displayed in
Syntax
Object.XAxisExponentialFormat[=BOOLEAN]
Object
BOOLEAN
Optional.

VB scripting
See also
XAxisIndex (RT Professional)
Description
References an X-axis. To access the properties of an X-axis, you need to set ""YAxisIndex"".
Values between 0 and "XAxisCount" minus 1 are valid for "XAxisIndex". The "XAxisCount"
property specifies the number of configured X-axes.
Syntax
Object.XAxisIndex[=Int32]
Object
Int32
Optional. A value or a constant that specifies, with the index, the X-axis to be edited.
See also
XAxisCount (Page 1231)
XAxisInTrendColor (RT Professional)
Description
Specifies whether the color of the axis referenced with "XAxisIndex" corresponds to the trend
color.
Syntax
Object.XAxisInTrendColor[=BOOLEAN]

VB scripting
Object
BOOLEAN
Optional.
TRUE if the referenced axis is shown in the trend color. The value of "XAxisColor" is not
effective.
FALSE if the referenced axis is shown in the color specified in "XAxisColor".
See also
XAxisLabel (RT Professional)
Description
Specifies the label text for an X-axis referenced with "XAxisIndex".
Syntax
Object.XAxisLabel[=STRING]
Object
STRING
Optional. A value or a constant that specifies the label text for the referenced X-axis.
See also
XAxisName (RT Professional)
Description
Specifies the name of an X-axis referenced with "XAxisIndex".

VB scripting
Syntax
Object.XAxisName[=STRING]
Object
STRING
Optional. A value or a constant that specifies the name of the referenced X-axis.
See also
XAxisPrecisions (RT Professional)
Description
Specifies the number of decimal places to be displayed for the values of an X-axis referenced
with "XAxisIndex".
Also set "XAxisAutoPrecisions" to "FALSE".
Syntax
Object.XAxisPrecisions[=Int16]
Object
Int16
See also

VB scripting
XAxisRemove (RT Professional)
Description
Removes an X-axis referenced with its name.
Syntax
Object.XAxisRemove[=STRING]
Object
STRING
Optional. A value or a constant that specifies the name of the referenced X-axis to be removed.
See also
XAxisRename (RT Professional)
Description
Specifies the new name of an X-axis referenced with "XAxisIndex".
Syntax
Object.XAxisRename[=STRING]
Object
STRING
Optional. A value or a constant that specifies the new name of the X-axis.
See also

VB scripting
XAxisRepos (RT Professional)
Description
For multiple X-axes, specifies the position of an X-axis referenced with "XAxisIndex".
If you have changed the position of the X-axis with "XAxisRepos", "XAxisIndex" is assigned
the value of "XAxisRepos".
Syntax
Object.XAxisRepos[=Int32]
Object
Int32
Optional. A value or a constant that specifies the position of the referenced X-axis. Value range
from 0 to "XAxisCount" minus 1. Values outside this range have no effect.
0: The referenced X-axis is positioned outside.
See also
XAxisCount (Page 1231)
XAxisScalingType (RT Professional)
Description
Specifies the type of scaling for the X-axis referenced with "XAxisIndex".
Syntax
Object.XAxisScalingType[=AxisScalingType]
Object

VB scripting
AxisScalingType
Optional. A value or a constant that specifies the type of scaling of the referenced X axis.

See also
XAxisTrendWindow (RT Professional)
Description
Specifies the trend diagram in which the axis referenced with "XAxisIndex" is displayed.
Syntax
Object.XAxisTrendWindow[=STRING]
Object
STRING
See also
XAxisVisible (RT Professional)
Description
Specifies whether the X-axis referenced with "XAxisIndex" is displayed in the object.

VB scripting
Syntax
Object.XAxisVisible[=BOOLEAN]
Object
BOOLEAN
Optional.
TRUE, if the referenced X axis is displayed.
FALSE, if the referenced X axis is not displayed.
See also
YAxes (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
YAxisAdd (RT Professional)
Description
Creates a new Y-axis. The newly created Y-axis is automatically referenced with "YAxisIndex".
Syntax
Object.YAxisAdd[=STRING]
Object
STRING
Required. A value or a constant that specifies the name of the new Y-axis with "YAxisName".

VB scripting
See also
YAxisIndex (Page 1245)
YAxisAlignment (RT Professional)
Description
Specifies the alignment of the Y-axis referenced with "YAxisIndex".
Syntax
Object.YAxisAlignment[=AxisAlignment]
Object
AxisAlignment
Optional. A value or a constant that specifies the alignment of the Y-axis with regard to the
trend window:
Value Designation
0 Left
1 Right
See also
YAxisAutoPrecisions (RT Professional)
Description
Specifies whether the number of decimal places is specified automatically for a Y-axis
referenced with "YAxisIndex".
Syntax
Object.YAxisAutoPrecisions[=BOOLEAN]

VB scripting
Object
BOOLEAN
Optional.
FALSE if the value of "YAxisPrecisions" is used.
See also
YAxisAutoRange (RT Professional)
Description
Specifies whether the value range of a Y-axis referenced with "YAxisIndex" is calculated
automatically.
Syntax
Object.YAxisAutoRange[=BOOLEAN]
Object
BOOLEAN
Optional.
FALSE if the value range is specified with "YAxisBeginValue" and "YAxisEndValue".
See also
YAxisBeginValue (RT Professional)
Description
Specifies the lower end of the value range of a Y-axis referenced with "YAxisIndex".

VB scripting
Also set "YAxisAutoRange" to "FALSE".

Syntax
Object.YAxisBeginValue[=DOUBLE]
Object
DOUBLE
Y-axis.
See also
YAxisColor (RT Professional)
Description
Specifies the color of a Y-axis referenced with "YAxisIndex".
Also set "YAxisInTrendColor" to "FALSE".
Syntax
Object.YAxisColor[=Color]
Object
Color
Optional. A value or a constant that specifies the color of the referenced axis.
Comments
RGB (255, 0, 0)

VB scripting
See also
YAxisCount (RT Professional)
Description
Specifies the number of configured Y-axes.
Syntax
Object.YAxisCount[=Int32]
Object
Int32
Optional. A value or a constant that specifies the number of configured Y-axes.
See also
YAxisEndValue (RT Professional)
Description
Specifies the upper end of the value range of a Y-axis referenced with "YAxisIndex".
Also set "YAxisAutoRange" to "FALSE".
Syntax
Object.YAxisEndValue[=DOUBLE]
Object

VB scripting
DOUBLE
Y-axis.
See also
YAxisExponentialFormat (RT Professional)
Description
Specifies whether the values of a Y-axis referenced with "YAxisIndex" are displayed in
Syntax
Object.YAxisExponentialFormat[=BOOLEAN]
Object
BOOLEAN
Optional.
See also
YAxisIndex (RT Professional)
Description
References a Y-axis. To access the properties of a Y-axis, you need to set ""YAxisIndex"".
Values between 0 and "YAxisCount" minus 1 are valid for "YAxisIndex". The "YAxisCount"
property specifies the number of configured Y-axes.

VB scripting
Syntax
Object.YAxisIndex[=Int32]
Object
Int32
Optional. A value or a constant that specifies, with the index, the Y-axis to be edited.
See also
YAxisInTrendColor (RT Professional)
Description
Specifies whether the color of the axis referenced with "YAxisIndex" corresponds to the trend
color.
Syntax
Object.YAxisInTrendColor[=BOOLEAN]
Object
BOOLEAN
Optional.
TRUE if the referenced axis is shown in the trend color. The value of "YAxisColor" is not
effective.
FALSE if the referenced axis is shown in the color specified in "YAxisColor".
See also
YAxisIndex (Page 1244)

VB scripting
YAxisLabel (RT Professional)
Description
Specifies the label text for a Y-axis referenced with "YAxisIndex".
Syntax
Object.YAxisLabel[=STRING]
Object
STRING
Optional. A value or a constant that specifies the label text for the referenced Y-axis.
See also
YAxisName (RT Professional)
Description
Specifies the name of a Y-axis referenced with "YAxisIndex".
Syntax
Object.YAxisName[=STRING]
Object
STRING
Optional. A value or a constant that specifies the name of the referenced Y-axis.
See also

VB scripting
YAxisPrecisions (RT Professional)
Description
Specifies the number of decimal places to be displayed for the values of a Y-axis referenced
with "YAxisIndex".
Also set "YAxisAutoPrecisions" to "FALSE".
Syntax
Object.YAxisPrecisions[=Int16]
Object
Int16
See also
YAxisRemove (RT Professional)
Description
Removes a Y-axis referenced with its name.
Syntax
Object.YAxisRemove[=STRING]
Object
STRING
Optional. A value or a constant that specifies the name of the referenced Y-axis to be removed.

VB scripting
See also
YAxisRename (RT Professional)
Description
Specifies the new name of a Y-axis referenced with "YAxisIndex".
Syntax
Object.YAxisRename[=STRING]
Object
STRING
Optional. A value or a constant that specifies the new name of the selected Y-axis.
See also
YAxisRepos (RT Professional)
Description
For multiple Y-axes, specifies the position of a Y-axis referenced with "YAxisIndex".
If you have changed positioning of the Y-axis with "YAxisRepos", "YAxisIndex" receives the
value of "YAxisRepos".
Access in runtime
Syntax
Object.YAxisRepos[=Int32]
Object

VB scripting
Int32
Optional. A value or a constant that specifies the position of the referenced Y-axis. Value range
from 0 to "YAxisCount" minus 1. Values outside this range have no effect.
0: The referenced Y-axis is positioned outside.
YAxisScalingType (RT Professional)
Description
Specifies the type of scaling for the Y-axis referenced with "YAxisIndex".
Access in runtime
Syntax
Object.YAxisScalingType[=AxisScalingType]
Object
AxisScalingType
Optional. A value or a constant that specifies the type of scaling of the referenced Y axis.

YAxisTrendWindow (RT Professional)
Description
Specifies the trend diagram in which the axis referenced with "YAxisIndex" is displayed.
Access in runtime
Syntax
Object.YAxisTrendWindow[=STRING]

VB scripting
Object
STRING
YAxisVisible (RT Professional)
Description
Specifies whether the Y-axis referenced with "YAxisIndex" is displayed in the object.
Access in runtime
Syntax
Object.YAxisVisible[=BOOLEAN]
Object
BOOLEAN
Optional.
TRUE, if the referenced Y axis is displayed.
FALSE, if the referenced Y axis is not displayed.
ZeroPoint (RT Professional)
Description
Specifies the position of the zero point as a percentage of the bar height. The zero point can
also be located outside of the displayed area.
The "ScalingType" property must be set to "Auto".
The "ShowScale" property must be set to "TRUE".
Syntax
Object.ZeroPoint[=Int32]

VB scripting
Object
● Bar
Int32
Optional A value or a constant that specifies the position of the zero point as a percentage of
the bar height.
See also
Bar (Page 257)
ZoomFactor (RT Professional)
Description
Specifies the zoom factor of a screen or screen window.
Syntax
Object.ZoomFactor[=Int32]
Object
● ScreenWindow
Int32
Optional. A value or a constant that specifies the zoom factor for displaying the embedded
graphic.
See also

VB scripting
1.5.6 Methods (Panels, Comfort Panels, RT Advanced, RT Professional)
1.5.6.1 Methods A-G (Panels, Comfort Panels, RT Advanced, RT Professional)
Activate (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
It only makes sense to use the Activate method with the following operable screen objects. An
error message is output at screen objects which cannot be operated, for example rectangles.
● IOField
● Switch
● SymbolLibrary
● TrendView
● HTMLBrowser
● Slider
● GraphicIOField
● SymbolicIOField
● Button
● AlarmControl
● UserView
● SmartClientView
● StatusForce
In Runtime Advanced and Panels, the permanent area is activated when the method is applied
to a screen object. Use the "BaseScreenName" property to activate a screen that has not been
selected.
Syntax
Expression.Activate()
Expression
Required. An output which returns an object of the "Screen" or "ScreenItem" type.
Parameters
--

VB scripting
Example
Dim objO
Set objO = HMIRuntime.Screens("Screen_1").ScreenItems("IO-Field_1")
objO.Activate
See also
Screen (Page 214)
CheckBox (Page 274)
Circle (Page 278)
Clock (Page 286)
Ellipse (Page 299)
Gauge (Page 319)
IOField (Page 331)
Switch (Page 419)

VB scripting

UserView (Page 480)
Slider (Page 409)
Polyline (Page 381)
Polygon (Page 378)
Listbox (Page 339)
Line (Page 336)
Bar (Page 257)
Button (Page 265)
ActivateDynamic (RT Professional)
Description
Dynamically activates a trigger and the specified cycle for a property at runtime. This requires
a VB script at the property as well as a trigger set to "On demand". Every time the trigger is
activated a different activation cycle can be used.
Syntax
Expression.ActivateDynamic (ByVAl Property name As String, ByVal
Cycle name As Cycle)

VB scripting
Expression
Required. An expression that returns an object of the type "ScreenItem".
Parameters
Parameter Description
Property name Property to which trigger relates. Use the VBS
name of the property.
Cycle name Name of activation cycle, e.g. "CycleTime1s".
See also
CheckBox (Page 274)
Circle (Page 278)
Clock (Page 286)
Ellipse (Page 299)
Gauge (Page 319)
IOField (Page 331)

VB scripting
UserView (Page 480)

Slider (Page 409)
Polyline (Page 381)
Polygon (Page 378)
Listbox (Page 339)
Line (Page 336)
Bar (Page 257)
Button (Page 265)
Add (RT Professional)
Description of TagSet Object

Adds a tag to the list. A tag may be added to the tag object by using name or reference.
syntax
Expression.Add [Tag]
Expression
Necessary. An expression which returns an object of type "TagSet".

VB scripting
Parameters
VARIANT
Parameters Description
Tag Name of a WinCC tag or reference to a tag object
to be added to the list.
Example:
In the following example, a TagSet object is generated and a tag is added.
'VBS170
Dim group
group.Add "Motor1"
Tag objects may also be added as follows.
'VBS171
Dim Tag
Set Tag = HMIRuntime.Tags("Motor2")
Dim group2
Set group2 = HMIRuntime.Tags.CreateTagSet
group2.Add Tag
Description of DataSet Object

Adds a value or object reference to the list.
Note
The Data Set Object does not support classes.
Objects of type Screen, Screens, ScreenItem, ScreenItems, Tag and TagSet cannot be
included in the DataSet list.
For object references it must be ascertained that objects are multiread-enabled.
syntax
Expression.Add [vtName], [vtUserData]
Expression
Necessary. An expression which returns an object of type "DataSet".

VB scripting
Parameters
VARIANT
vtName Name by which value or tag are to be added to list.
vtUserData Value to be added to list.
Example:
In this example, a value is included in the DataSet list.
'VBS172
HMIRuntime.DataSet.Add "Motor1",23
See also
DataSet (list) (Page 205)
AttachDB method (RT Professional)
Description
Executes the "Connect backup" key function of the control.
Syntax
Expression.AttachDB()
Expression
Parameters
--
See also

VB scripting
CalculateStatistic (RT Professional)
Description
Executes the "Calculate statistics" key function of the f(t) trend view and the table view.
Syntax
Expression.CalculateStatistic()
Expression
Parameters
--
See also
CopyRows (RT Professional)
Description
Executes the "Copy lines" key function of the control.
Syntax
Expression.CopyRows()
Expression
Parameters
--
See also

VB scripting
Create (RT Professional)
Description
Creates a new Alarm object.
Syntax
Expression.Create (VARIANT vtApplication)
Expression
Required. An expression which returns an object of type "Alarm".
Parameters
VARIANT
vtApplication Name of alarm object (optional)
See also
CreateTagSet (RT Professional)
Description
Creates a new TagSet object. This object may be used for optimized multi-tag access.
syntax
Expression.CreateTagSet()
Expression
Parameters
VARIANT

VB scripting
Example:
The following example shows how to create a TagSet object.
'VBS168
'Build a Reference to the TagSet Object
Dim group
See also
CutRows (RT Professional)
Description
Executes the "Cut rows" key function of the recipe view.
Syntax
Expression.CutRows()
Expression
Parameters
--
See also
DeactivateDynamic (RT Professional)
Description
Deactivates the trigger of the "ActivateDynamic" method used for the specified property in/
during runtime.
Syntax
Expression.DeactivateDynamic(ByVal Property name As String)

VB scripting
Expression
Parameters
Property name Property, whose trigger is disabled. Use the VBS
name of the property.
See also
CheckBox (Page 274)
Circle (Page 278)
Clock (Page 286)
Ellipse (Page 299)
Gauge (Page 319)
IOField (Page 331)
UserView (Page 480)

VB scripting

Slider (Page 409)
Polyline (Page 381)
Polygon (Page 378)
Listbox (Page 339)
Line (Page 336)
Bar (Page 257)
Button (Page 265)
DeleteRows (RT Professional)
Description
Executes the "Delete rows" key function of the recipe view.
Syntax
Expression.DeleteRows()
Expression
Parameters
--
See also

VB scripting
DetachDB (RT Professional)
Description
Executes the "Disconnect backup" key function of the control.
Syntax
Expression.DetachDB()
Expression
Parameters
--
See also
Edit (RT Professional)
Description
Executes the "Edit" key function of the table view.
Syntax
Expression.Edit()
Expression
Parameters
--

VB scripting
See also
Export (RT Professional)
Description
Executes the "Export log" or "Export data" key function of the control.
Syntax
Expression.Export()
Expression
Parameters
--
See also
GetColumn (RT Professional)
Description
Returns the column object of the recipe view designated by name or index as
"ICCAxUAColumn" type.
Syntax
Ausdruck.GetColumn(ByVal vIndex As Variant)

VB scripting
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
VARIANT
vIndex Index or name of the column of the recipe view
Example
'VBS312
Dim ctrl
Dim objColumn
Set ctrl = ScreenItems("RecipeControl")
Set objColumn = ctrl.GetColumn("Field1")
objColumn.Length = 30
Set objColumn = ctrl.GetColumn(3)
objColumn.Align = 2
Note
When you use the "Get..." methods to access properties from the Control object list rather than
with the Control object, you have to omit the prefix of the property with the name of the list.
For the "Column" listing, for example, you write "objColumn.Align" instead of
"objColumn.ColumnAlign".
See also
GetColumnCollection (RT Professional)
Description
Returns the list of all column objects of the recipe view as "ICCAxCollection" type.
Syntax
Ausdruck.GetColumnCollection()

VB scripting
Expression
Parameters
--
Features and functions of the ICCAxCollection

The following properties are available for the ICCAxCollection:
● Count
● Item
The following functions are available for the ICCAxCollection:
● AddItem(vName) As Object
● RemoveItem(vIndex)
Example
'VBS313
Dim ctrl
Dim coll
Dim field
Set ctrl = ScreenItems("RecipeControl")
Set coll = ctrl.GetColumnCollection
HMIRuntime.Trace "Number of fields:" & coll.Count & vbCrLf
For Each field In coll
HMIRuntime.Trace field.Name & vbCrLf
HMIRuntime.Trace field.Type & vbCrLf
HMIRuntime.Trace field.Length & vbCrLf
HMIRuntime.Trace field.Caption & vbCrLf
Next
See also
GetHistlistColumnCollection (RT Professional)
Description
Returns the list of all column objects of the message view hit list as "ICCAxCollection" type.

VB scripting
Syntax
Expression.GetHitlisteColumnCollection()
Expression
Parameters
--

● Count
● Item
Example
'VBS315
Dim ctrl
Dim coll
Dim hitlistcol
Set ctrl = ScreenItems("AlarmControl")
Set coll = ctrl.GetHitlistColumnCollection
HMIRuntime.Trace "Number of hitlist columns:" & coll.Count & vbCrLf
For Each hitlistcol In coll
HMIRuntime.Trace hitlistcol.Index & vbCrLf
HMIRuntime.Trace hitlistcol.Name & vbCrLf
HMIRuntime.Trace hitlistcol.Sort & vbCrLf
HMIRuntime.Trace hitlistcol.SortIndex & vbCrLf
Next
See also

VB scripting
GetHitlistColumn (RT Professional)
Description
Returns the column object of the message view hit list designated by name or index as
"ICCAxMessageColumn" type.
Syntax
Expression.GetHitlistColumn(ByVal vIndex As Variant)
Expression
Parameters
VARIANT
vIndex Index or name of hitlist column
Example
'VBS314
Dim ctrl
Dim objHitlistColumn
Set objHitlistColumn = ctrl.GetHitlistColumn("Date")
objHitlistColumn.Sort = 2
Set objHitlistColumn = ctrl.GetHitlistColumn("AverageComeGo")
objHitlistColumn.Visible = FALSE
Note
For the "HitlistColumn" listing, for example, you write "objHitlistColumn.Visible" instead of
"objHitlistColumn.HitlistColumnVisible".
See also

VB scripting
GetMessageBlock (RT Professional)
Description
Returns the message block of the message view designated by name or index as
"ICCAxMessageBlock" type.
Syntax
Expression.GetMessageBlock(ByVal vIndex As Variant)
Expression
Parameters
VARIANT
vIndex Index or name of message block.
Example
'VBS316
Dim ctrl
Dim objMsgBlock
Set objMsgBlock = ctrl.GetMessageBlock("Date")
objMsgBlock.Align = 2
Set objMsgBlock = ctrl.GetMessageBlock("Number")
objMsgBlock.LeadingZeros = 4
Note
For the "MessageBlock" listing, for example, you write "objMsgBlock.Align" instead of
"objMsgBlock.MessageBlockAlign".
See also

VB scripting
GetMessageBlockCollection (RT Professional)
Description
Returns the list of all message block objects of the message view as "ICCAxCollection" type.
Syntax
Expression.GetMessageBlockCollection()
Expression
Parameters
--

● Count
● Item
Example
'VBS317
Dim ctrl
Dim coll
Dim msgblock
Set coll = ctrl.GetMessageBlockCollection
For Each msgblock In coll
msgblock.Align = 1
msgblock.Length = 12
msgblock.Selected = TRUE
Next

VB scripting
Note
For the "MessageBlock" listing, for example, you write "msgblock.Align" instead of
"msgblock.MessageBlockAlign".
See also
GetMessageColumn (RT Professional)
Description
Returns the column object of the message view designated by name or index as
"ICCAxMessageColumn" type.
Syntax
Expression.GetMessageColumn(ByVal vIndex As Variant)
Expression
Parameters
VARIANT
vIndex Index or name of column in message list.
Example
'VBS318
Dim ctrl
Dim objMessColumn
Set objMessColumn = ctrl.GetMessageColumn("Date")
objMessColumn.Visible = FALSE
Set objMessColumn = ctrl.GetMessageColumn("Number")
objMessColumn.Sort = 1

VB scripting
Note
For the "MessageColumn" listing, for example, you write "objMessColumn.Visible" instead of
"objMessColumn.MessageColumnVisible".
See also
GetMessageColumnCollection (RT Professional)
Description
Returns the list of all column objects of the message view as "ICCAxCollection" type.
Syntax
Expression.GetMessageColumnCollection()
Expression
Parameters
--

● Count
● Item

VB scripting
Example
'VBS319
Dim ctrl
Dim coll
Dim msgcol
Set coll = ctrl.GetMessageColumnCollection
HMIRuntime.Trace "Number of message columns:" & coll.Count & vbCrLf
For Each msgcol In coll
HMIRuntime.Trace msgcol.Index & vbCrLf
HMIRuntime.Trace msgcol.Name & vbCrLf
HMIRuntime.Trace msgcol.Sort & vbCrLf
HMIRuntime.Trace msgcol.SortIndex & vbCrLf
Next
See also
GetOperatorMessage (RT Professional)
Description
Returns the operator message object of the message view designated by name or index as
"ICCAxOperatorMessage" type.
Syntax
Expression.GetOperatorMessage(ByVal vIndex As Variant)
Expression
Parameters
VARIANT
vIndex Index or name of operator message

VB scripting
Example
'VBS320
Dim ctrl
Dim objOpMess
Set objOpMess = ctrl.GetOperatorMessage(0)
objOpMess.Source1 = "Number"
objOpMess.SourceType1 = 1
Note
For the "OperatorMessage" listing, for example, you write "objOpMess.Source1" instead of
"objOpMess.OperatorMessageSource1".
See also
GetOperatorMessageCollection (RT Professional)
Description
Returns the list of all operator message objects of the message view as "ICCAxCollection"
type.
Syntax
Expression.GetOperatorMessageCollection()
Expression
Parameters
--

VB scripting

● Count
● Item
Example
'VBS321
Dim ctrl
Dim coll
Dim opmsg
Set coll = ctrl.GetOperatorMessageCollection
For Each opmsg In coll
HMIRuntime.Trace opmsg.Index & vbCrLf
HMIRuntime.Trace opmsg.Name & vbCrLf
HMIRuntime.Trace opmsg.Number & vbCrLf
HMIRuntime.Trace opmsg.Selected & vbCrLf
Next
See also
GetRow (RT Professional)
Description
Returns the row object defined by its row number in the table-based controls as
"ICCAxDataRow" type.
Syntax
Expression.GetRow(ByVal IRow As Long)
Expression
Required An expression that returns an object of the "ScreenItem" type.

VB scripting
Parameters
Long
IRow Number of the desired line of the control.
Example
'VBS356
Dim coll
Dim ctrl
Dim lIndex
Dim lCellIndex
Set ctrl = ScreenItems("UAControl")
Set coll = ctrl.GetRowCollection
'enumerate and trace out row numbers
For lIndex = 1 To coll.Count
HMIRuntime.trace "Row: " & (ctrl.GetRow(lIndex).RowNumber) & " "
'enumerate and trace out column titles and cell texts
For lCellIndex = 1 To ctrl.GetRow(lIndex).CellCount
HMIRuntime.trace ctrl.GetRow(0).CellText(lCellIndex) & " "
HMIRuntime.trace ctrl.GetRow(lIndex).CellText(lCellIndex) & " "
Next
HMIRuntime.trace vbNewLine
Next
Note
When you use the "Get..." methods to access properties from the control object list rather than
with the control object, you have to omit the prefix of the property with the name of the list.
For the "Row" listing, for example, you write "objRow.CellCount" instead of
"objRow.RowCellCount".
See also

VB scripting
GetRowCollection (RT Professional)
Description
Returns the list of all row objects of the table-based controls type "ICCAxDataRowCollection".
Syntax
Expression.GetRowCollection()
Expression
Parameters
--
Properties of the ICCAxDataRowCollection

The ICCAxDataRowCollection refers to runtime data. The data is read-only. It is not possible
to add and edit the data.
The following properties are available for the ICCAxDataRowCollection:
● Count - Determines the number of rows in the collection.
● Item - Access to an individual row within the collection via the row number. Numbering runs
from 1 to Count. A Row object is returned.
Example
'VBS357
Dim ctrl
Dim coll
Dim lIndex
Dim lCellIndex
Set coll = ctrl.GetRowCollection
HMIRuntime.Trace "Number of message rows:" & coll.Count & vbCrLf
'enumerate and trace out row numbers
For lIndex = 1 To coll.Count
HMIRuntime.Trace "Row: " & (ctrl.GetRow(lIndex).RowNumber) & " "
For lCellIndex = 1 To ctrl.GetRow(lIndex).CellCount
HMIRuntime.Trace ctrl.GetMessageColumn(lCellIndex -1).Name & " "
HMIRuntime.Trace ctrl.GetRow(lIndex).CellText(lCellIndex) & " "
Next
HMIRuntime.Trace vbNewLine
Next

VB scripting
See also
GetRulerBlock (RT Professional)
Description
Returns the block object of the evaluation table designated by name or index as
"ICCAxRulerBlock" type.
Syntax
Expression.GetRulerBlock(ByVal vIndex As Variant)
Expression
Parameters
VARIANT
vIndex Index or name of the block in the evaluation table
Example
'VBS322
Dim ctrl
Dim objRulerBlock
Set ctrl = ScreenItems("RulerControl")
Set objRulerBlock = ctrl.GetRulerBlock(0)
objRulerBlock.Caption = "RulerBlock1"
Set objRulerBlock = ctrl.GetRulerBlock("Name")
objRulerBlock.Length = 10

VB scripting
Note
For the "RulerBlock" listing, for example, you write "objRulerBlock.Caption" instead of
"objRulerBlock.BlockCaption".
See also
GetRulerBlockCollection (RT Professional)
Description
Returns the list of all block objects of the evaluation table as "ICCAxCollection" type.
Syntax
Expression.GetRulerBlockCollection()
Expression
Parameters
--

● Count
● Item

VB scripting
Example
'VBS323
Dim ctrl
Dim coll
Dim rulerblock
Set coll = ctrl.GetRulerBlockCollection
For Each rulerblock In coll
rulerblock.Align = 1
rulerblock.Length = 12
Next
Note
For the "RulerBlock" listing, for example, you write "rulerblock.Align" instead of
"rulerblock.RulerBlockAlign".
See also
GetRulerColumn (RT Professional)
Description
Returns the column object of the evaluation table designated by name or index as
"ICCAxRulerColumn" type.
Syntax
Expression.GetRulerColumn(ByVal vIndex As Variant)
Expression
Parameters
VARIANT
vIndex Index or name of the column of the evaluation

VB scripting
Example
'VBS324
Dim ctrl
Dim objRulercol
Set objRulercol = ctrl.GetRulerColumn("Name")
objRulercol.Sort = 0
Set objRulercol = ctrl.GetRulerColumn("ValueY")
objRulercol.Visible = FALSE
Note
For the "RulerColumn" listing, for example, you write "objRulercol.Visible" instead of
"objRulercol.ColumnVisible".
See also
GetRulerColumnCollection (RT Professional)
Description
Returns the list of all column objects of the evaluation table as "ICCAxCollection" type.
Syntax
Expression.GetRulerColumnCollection()
Expression
Parameters
--

VB scripting

● Count
● Item
Example
'VBS325
Dim ctrl
Dim coll
Dim rulercol
Set coll = ctrl.GetRulerColumnCollection
HMIRuntime.Trace "Number of ruler columns:" & coll.Count & vbCrLf
For Each rulercol In coll
HMIRuntime.Trace rulercol.Index & vbCrLf
HMIRuntime.Trace rulercol.Name & vbCrLf
HMIRuntime.Trace rulercol.Sort & vbCrLf
HMIRuntime.Trace rulercol.SortIndex & vbCrLf
Next
See also
GetRulerData (RT Professional)
Description
Returns the value of the called trend at the ruler position.
Syntax
Expression.GetRulerData(ByVal RulerIndex As Long, pvValue As
Variant, Optional pvTimeStamp As Variant, Optional pvFlags As
Varian) Long
Expression
Necessary. An expression which returns an object of the "Trend" type.

VB scripting
Parameters
RulerIndex 0 =Ruler
pvValue Value of X axis
pvTimeStamp Time or value of the Y axis
pvFlags Qualitycode
Example
'VBS326
Dim ctrl
Dim objTrend
Dim objIOField1
Dim objIOField2
Dim rulvalue
Dim rultime
Set ctrl = ScreenItems( "Control1" )
Set objTrend = ctrl.GetTrend( "Trend 1" )
Set objIOField1 = ScreenItems( "I/O Field1" )
Set objIOField2 = ScreenItems( "I/O Field2" )
objTrend.GetRulerData 0, rulvalue, rultime
objIOField1.OutputValue = rulvalue
objIOField2.OutputValue = rultime
See also
GetSelectedRow (RT Professional)
Description
Returns the selected row object of a table-based control as "ICCAxDataRow" type.
Syntax
Expression.GetSelectedRow()
Expression
Parameters
--

VB scripting
Example
'VBS358
Dim ctrl
Dim lCellIndex
Dim lCellCount
Dim headingRow
Dim selectedRow
Set ctrl = ScreenItems("TableControl")
Set headingRow = ctrl.GetRow(0)
Set selectedRow = ctrl.GetSelectedRow
lCellCount = headingRow.CellCount
For lCellIndex = 1 To lCellCount
HMIRuntime.trace headingRow.CellText(lCellIndex) & ": "
HMIRuntime.trace selectedRow.CellText(lCellIndex)
Next
Note
See also
GetSelectedRows (RT Professional)
Description
Returns the selected row objects of a table-based control as type "ICCAxDataRow" for multiple
selection.
Syntax
Expression.GetSelectedRows()

VB scripting
Expression
Parameters
--
Example
'VBS359
Dim ctrl
Dim lCellIndex
Dim lCellCount
Dim lRowIndex
Dim lRowCount
Dim headingRow
Dim selectedRow
Dim selectedRows
Set headingRow = ctrl.GetRow(0)
Set selectedRows = ctrl.GetSelectedRows
lCellCount = headingRow.CellCount
lRowCount = selectedRows.Count
'enumerate selected rows
For lRowIndex = 1 To lRowCount
Set selectedRow = selectedRows(lRowIndex)
HMIRuntime.Trace "Row number: " & CStr(lRowIndex) & vbNewLine
For lCellIndex = 1 To lCellCount
HMIRuntime.trace headingRow.CellText(lCellIndex) & ": "
HMIRuntime.trace selectedRow.CellText(lCellIndex)
Next
Next
Note
See also

VB scripting

GetStatisticAreaColumn (RT Professional)
Description
Returns the column object of the statistic area window of the evaluation window designated
by name or index as "ICCAxRulerColumn" type.
Syntax
Ausdruck.GetStatisticAreaColumn(ByVal vIndex As Variant)
Expression
Parameters
VARIANT
vIndex Index or name of column of statistics area window.
Example
'VBS327
Dim ctrl
Dim objStatAreaCol
Set objStatAreaCol = ctrl.GetStatisticAreaColumn("DatasourceY")
objStatAreaCol.Visible = FALSE
Set objStatAreaCol = ctrl.GetStatisticAreaColumn("ValueY(LL)")
objStatAreaCol.Sort = 1
Note
For the "StatisticAreaColumn" listing, for example, you write "objStatAreaCol.Visible" instead
of "objStatAreaCol.ColumnVisible".

VB scripting
See also
GetStatisticAreaColumnCollection (RT Professional)
Description
Returns the list of all column objects of the statistic area window of the evaluation table as
"ICCAxCollection" type.
Syntax
Ausdruck.GetStatisticAreaColumnCollection()
Expression
Parameters
--

● Count
● Item

VB scripting
Example
'VBS328
Dim ctrl
Dim coll
Dim statcol
Set coll = ctrl.GetStatisticAreaColumnCollection
HMIRuntime.Trace "Number of statistic Area columns:" & coll.Count & vbCrLf
For Each statcol In coll
HMIRuntime.Trace statcol.Index & vbCrLf
HMIRuntime.Trace statcol.Name & vbCrLf
HMIRuntime.Trace statcol.Sort & vbCrLf
HMIRuntime.Trace statcol.SortIndex & vbCrLf
Next
See also
GetStatisticResultColumn (RT Professional)
Description
Returns the column object of the statistic window of the evaluation window designated by name
or index as "ICCAxRulerColumn" type.
Syntax
Ausdruck.GetStatisticResultColumn(ByVal vIndex As Variant)
Expression
Parameters
VARIANT
vIndex Index or name of column of statistics window.

VB scripting
Example
'VBS329
Dim ctrl
Dim objStatResCol
Set objStatResCol = ctrl.GetStatisticResultColumn("MaxValue")
objStatResCol.Visible = FALSE
Set objStatResCol = ctrl.GetStatisticResultColumn("Average")
objStatResCol.Sort = 2
Note
For the "StatisticResultColumn" listing, for example, you write "objStatResCol.Visible" instead
of "objStatResCol.ColumnVisible".
See also
GetStatisticResultColumnCollection (RT Professional)
Description
Returns the list of all column objects of the statistic window of the evaluation table as
Syntax
Ausdruck.GetStatisticResultColumnCollection()
Expression
Parameters
--

VB scripting

● Count
● Item
Example
'VBS330
Dim ctrl
Dim coll
Dim statcol
Set coll = ctrl.GetStatisticResultColumnCollection
HMIRuntime.Trace "Number of statistic result columns:" & coll.Count & vbCrLf
For Each statcol In coll
HMIRuntime.Trace statcol.Index & vbCrLf
HMIRuntime.Trace statcol.Name & vbCrLf
HMIRuntime.Trace statcol.Sort & vbCrLf
HMIRuntime.Trace statcol.SortIndex & vbCrLf
Next
See also
GetStatusbarElement (RT Professional)
Description
Returns the element of the control status bar designated as name or index as type
"ICCAxStatusbarElement".
Syntax
Ausdruck.GetStatusbarElement(ByVal vIndex As Variant)
Expression

VB scripting
Parameters
VARIANT
vIndex Index or name of status bar element.
Example
'VBS331
Dim ctrl
Dim objStatusBar
Set objStatusBar = ctrl.GetStatusbarElement(1)
objStatusBar.Visible = FALSE
Set objStatusBar = ctrl.GetStatusbarElement(3)
objStatusBar.Width = 10
Note
For the "StatusbarElement" listing, for example, you write "objStatusBar.Visible" instead of
"objStatusBar.StatusbarElementVisible".
See also
GetStatusbarElementCollection (RT Professional)
Description
Returns the list of all status bar elements of the control as type "ICCAxCollection".
Syntax
Ausdruck.GetStatusbarElementCollection()

VB scripting
Expression
Parameters
--

● Count
● Item
Example
'VBS332
Dim ctrl
Dim coll
Dim statelement
Set ctrl = ScreenItems.Item("Control1")
Set coll = ctrl.GetStatusbarElementCollection
HMIRuntime.Trace "Number of statusbar elements:" & coll.Count & vbCrLf
For Each statelement In coll
HMIRuntime.Trace statelement.Name & vbCrLf
HMIRuntime.Trace statelement.Width & vbCrLf
HMIRuntime.Trace statelement.Text & vbCrLf
Next
Note
For the "StatusbarElement" listing, for example, you write "statelement.Name" instead of
"statelement.StatusbarElementName".
See also

VB scripting

GetTimeAxis (RT Professional)
Description
Returns the time object that is specified by name or index for the f(t) trend view as
"ICCAxTimeAxis" type.
Syntax
Expression.GetTimeAxis(ByVal vIndex As Variant)
Expression
Necessary. Expression that returns an object of the "ScreenItem" type.
Parameters
VARIANT
vIndex Index or name of time axis.
Example
'VBS333
Dim ctrl
Dim objTimeAxis
Set ctrl = ScreenItems("OnlineTrendControl")
Set objTimeAxis = ctrl.GetTimeAxis(1)
objTimeAxis.Visible = FALSE
Set objTimeAxis = ctrl.GetTimeAxis("axis 2")
objTimeAxis.Label = "Time axis 2"
objTimeAxis.DateFormat = "dd.MM.yy"
objTimeAxis.TimeFormat = "HH:mm:ss.ms"
objTimeAxis.RangeType = 2
'The format to be used for date and time entries depends on the
'regional settings and language options in the operating system.
objTimeAxis.BeginTime = "06.04.2010 9:33:18"
'objTimeAxis.BeginTime = "04/06/2010 9:33:18"
objTimeAxis.MeasurePoints = 100

VB scripting
Note
For the "TimeAxis" listing, for example, you write "objTimeAx.Visible" instead of
"objTimeAx.TimeAxisVisible".
See also
GetTimeAxisCollection (RT Professional)
Description
Returns a list of all time objects of the f(t) trend view as "ICCAxCollection" type.
Syntax
Expression.GetTimeAxisCollection()
Expression
Parameters
--

The following properties are available for ICCAxCollection:
● Count
● Item
The following functions are available for ICCAxCollection:

VB scripting
Example
'VBS334
Dim ctrl
Dim objTrendWnd
Dim objTimeAxis1
Dim objTimeAxis2
Dim objTrend
Set objTrendWnd = ctrl.GetTrendWindowCollection.AddItem("myWindow")
Set objTimeAxis1 = ctrl.GetTimeAxisCollection.AddItem("TimeAxis2010")
Set objTimeAxis2 = ctrl.GetTimeAxisCollection.AddItem("TimeAxis2011")
objTimeAxis1.TrendWindow = objTrendWnd.Name
objTimeAxis1.Label = "2010"
objTimeAxis1.RangeType = 1
objTimeAxis1.BeginTime = "01.01.2010 0:00:00"
'objTimeAxis1.BeginTime = "01/01/2010 0:00:00"
objTimeAxis1.EndTime = "31.12.2010 11:59:59"
'objTimeAxis1.EndTime = "12/31/2010 11:59:59"
objTimeAxis2.TrendWindow = objTrendWnd.Name
objTimeAxis2.Label = "2011"
objTimeAxis2.RangeType = 1
objTimeAxis2.BeginTime = "01.01.2011 0:00:00"
'objTimeAxis2.BeginTime = "01/01/2011 0:00:00"
objTimeAxis2.EndTime = "31.12.2011 11:59:59"
'objTimeAxis2.EndTime = "12/31/2011 11:59:59"
Set objTrend = ctrl.GetTrendCollection.AddItem("myTrend1")
objTrend.TrendWindow = objTrendWnd.Name
objTrend.TimeAxis = objTimeAxis1.Name
objTrend.TimeAxis = objTimeAxis2.Name
Note
For the "TimeAxis" listing, for example, you write "objTimeAxis1.Label" instead of
"objTimeAxis1.TimeAxisLabel".
See also

VB scripting
GetTimeColumn (RT Professional)
Description
Returns the time column object of the table view designated by name or index as "ICCAxTime
Column" type.
Syntax
Ausdruck.GetTimeColumn(ByVal vIndex As Variant)
Expression
Parameters
VARIANT
vIndex Index or name of time column.
Example
'VBS335
Dim ctrl
Dim objTimeCol
Set objTimeCol = ctrl.GetTimeColumn("Timecolumn1")
objTimeCol.ShowDate = FALSE
Set objTimeCol = ctrl.GetTimeColumn("Timecolumn2")
objTimeCol.Visible = FALSE
Note
For the "TimeColumn" listing, for example, you write "objTimeColumn.ShowDate" instead of
"objTimeColumn.TimeColumnShowDate".
See also

VB scripting
GetTimeColumnCollection (RT Professional)
Description
Returns the list of all time column objects of the table view as "ICCAxCollection" type.
Syntax
Expression.GetTimeColumnCollection()
Expression
Parameters
--

The following properties are available for ICCAxCollection:
● Count
● Item
The following functions are available for ICCAxCollection:

VB scripting
Example
'VBS336
Dim ctrl
Dim objTimeCol1
Dim objTimeCol2
Dim coll
Dim timecol
Set objTimeCol1 = ctrl.GetTimeColumnCollection.AddItem("TimeColumn2010")
Set objTimeCol2 = ctrl.GetTimeColumnCollection.AddItem("TimeColumn2011")
objTimeCol1.Caption = "2010"
objTimeCol1.RangeType = 1
objTimeCol1.BeginTime = "01.01.2010 0:00:00"
'objTimeCol1.BeginTime = "01/01/2010 0:00:00"
objTimeCol1.EndTime = "31.12.2010 11:59:59"
'objTimeCol1.EndTime = "12/31/2010 11:59:59"
objTimeCol2.Caption = "2011"
objTimeCol2.RangeType = 0
objTimeCol2.BeginTime = "01.01.2011 0:00:00"
'objTimeCol2.BeginTime = "01/01/2011 0:00:00"
objTimeCol2.TimeRangeFactor = 1
objTimeCol2.TimeRangeBase = 3600000
Set coll = ctrl.GetTimeColumnCollection
For Each timecol In coll
timecol.Align = 1
timecol.Length = 12
timecol.BackColor = RGB(240,240,0)
timecol.ForeColor = RGB(130,160,255)
Next
See also
GetToolbarButton (RT Professional)
Description
Returns the button function designated by name or index on the control toolbar as
"ICCAxToolbarButton" type.
Syntax
Ausdruck.GetToolbarButton(ByVal vIndex As Variant)

VB scripting
Expression
Parameters
VARIANT
vIndex Index or name of toolbar button function.
Example
'VBS337
Dim ctrl
Dim toolbu
Set toolbu = ctrl.GetToolbarButton ("ShowHelp")
HMIRuntime.Trace "Name: " & toolbu.Name & vbCrLf
HMIRuntime.Trace "Index: " & toolbu.Index & vbCrLf
HMIRuntime.Trace "Hotkey: " & toolbu.HotKey & vbCrLf
Note
For the "ToolbarButton" listing, for example, you write "toolbu.Index" instead of
"toolbu.ToolbarButtonIndex".
See also
GetToolbarButtonCollection (RT Professional)
Description
Returns the list of all button functions of the control toolbar as "ICCAxCollection" type.

VB scripting
Syntax
Ausdruck.GetToolbarButtonCollection()
Expression
Parameters
--

● Count
● Item
The following methods are available for the ICCAxCollection:
Example
'VBS338
Dim ctrl
Dim coll
Dim toolbu
Set coll = ctrl.GetToolbarButtonCollection
HMIRuntime.Trace "Number of toolbar buttons:" & coll.Count & vbCrLf
For Each toolbu In coll
HMIRuntime.Trace toolbu.Name & vbCrLf
HMIRuntime.Trace "Hotkey: " & toolbu.HotKey & vbCrLf
HMIRuntime.Trace "Authorization: " & toolbu.PasswordLevel & vbCrLf
Next
See also

VB scripting
GetTrend (RT Professional)
Description
Returns the f(t) or f(x) trend view designated by name or index as "ICCAxTrend" or
"ICCAxFunctionTrend" type.
Syntax
Ausdruck.GetTrend(ByVal vIndex As Variant)
Expression
Parameters
VARIANT
vIndex Index or name of curve.
Example for Runtime Professional
'VBS339
Dim ctrl
Dim objTrend
Set objTrend = ctrl.GetTrend( "Trend 1" )
objTrend.PointStyle = 1
objTrend.LineWidth = 4
Set objTrend = ctrl.GetTrend(2)
objTrend.Provider = 1
objTrend.TagName = "Archive\ArchiveTag2"
Note
For the "Trend" listing, for example, you write "objTrend.PointStyle" instead of
"objTrend.TrendPointStyle".
See also

VB scripting
GetTrendCollection (RT Professional)
Description
Returns the list of all trends of the f(t) or f(x) trend view as "ICCAxCollection" type.
Syntax
Ausdruck.GetTrendCollection()
Expression
Parameters
--

● Count
● Item
'VBS340
Dim ctrl
Dim objTrendWnd
Dim objTimeAxis
Dim objValAxis
Dim objTrend
Set objTimeAxis = ctrl.GetTimeAxisCollection.AddItem("myTimeAxis")
Set objValAxis = ctrl.GetValueAxisCollection.AddItem("myValueAxis")
objTimeAxis.TrendWindow = objTrendWnd.Name
objValAxis.TrendWindow = objTrendWnd.Name
objTrend.Provider = 1
objTrend.TagName = "Archive\ArchiveTag1"
objTrend.TimeAxis = objTimeAxis.Name
objTrend.ValueAxis = objValAxis.Name

VB scripting
Note
For the "Trend" listing, for example, you write "objTrend.TagName" instead of
"objTrend.TrendTagName".
See also
GetTrendWindow (RT Professional)
Description
Returns the trend view object of the f(t) trend view or the f(x) trend view designated by name
or index as "ICCAxTrendWindow" type.
Syntax
Ausdruck.GetTrendWindow(ByVal vIndex As Variant)
Expression
Parameters
VARIANT
vIndex Index or name of curve window.

VB scripting
'VBS341
Dim ctrl
Dim objTrendWnd
Set objTrendWnd = ctrl.GetTrendWindow(1)
objTrendWnd.Visible = FALSE
Set objTrendWnd = ctrl.GetTrendWindow("trend window 2")
objTrendWnd.VerticalGrid = TRUE
objTrendWnd.FineGrid = TRUE
Note
For the "TrendWindow" listing, for example, you write "objTrendWnd.Visible" instead of
"objTrendWnd.TrendWindowVisible".
See also
GetTrendWindowCollection (RT Professional)
Description
Returns the list of all trend window objects of the f(t) trend display or the f(x) trend display as
Syntax
Ausdruck.GetTrendWindowCollection()
Expression
Required. An expression that returns an object of the "ScreenItem" type.
Parameters
--

VB scripting

● Count
● Item
'VBS342
Dim ctrl
Dim objTrendWnd
Dim objTimeAxis
Dim objValAxis
Set objTimeAxis = ctrl.GetTimeAxisCollection.AddItem("myTimeAxis")
Set objValAxis = ctrl.GetValueAxisCollection.AddItem("myValueAxis")
objTimeAxis.TrendWindow = objTrendWnd.Name
objValAxis.TrendWindow = objTrendWnd.Name
See also
GetValueAxis (RT Professional)
Description
Returns the value axis object of the f(t) trend view designated by name or index as
"ICCAxValueAxis" type.
Syntax
Ausdruck.GetValueAxis(ByVal vIndex As Variant)
Expression

VB scripting
Parameters
VARIANT
vIndex Index or name of the value axis
Example
'VBS343
Dim ctrl
Dim objValAxis
Set objValAxis = ctrl.GetValueAxis(1)
objValAxis.Visible = FALSE
Set objValAxis = ctrl.GetValueAxis("axis 2")
objValAxis.Label = "Value axis 2"
objValAxis.ScalingType = 0
objValAxis.Precisions = 2
objValAxis.AutoRange = TRUE
Note
For the "ValueAxis" listing, for example, you write "objValueAx.Visible" instead of
"objValueAx.ValueAxisVisible".
See also
GetValueAxisCollection (RT Professional)
Description
Returns the list of all value axis objects of the f(t) trend view as "ICCAxCollection" type.
Syntax
Ausdruck.GetValueAxisCollection()
Expression

VB scripting
Parameters
--

● Count
● Item
Example
'VBS344
Dim ctrl
Dim objTrendWnd
Dim objValAxis1
Dim objValAxis2
Dim objTrend
Set objValAxis1 = ctrl.GetValueAxisCollection.AddItem("myValueAxis1")
Set objValAxis2 = ctrl.GetValueAxisCollection.AddItem("myValueAxis2")
objValAxis1.TrendWindow = objTrendWnd.Name
objValAxis1.Label = "Value1"
objValAxis2.TrendWindow = objTrendWnd.Name
objValAxis2.inTrendColor = TRUE
objTrend.ValueAxis = objValAxis1.Name
objTrend.ValueAxis = objValAxis2.Name
Note
For the "ValueAxis" listing, for example, you write "objValueAxis1.Label" instead of
"objValueAxis1.ValueAxisLabel".
See also

VB scripting
GetValueColumn (RT Professional)
Description
Returns the value column object defined by name or index for the tabular view as
"ICCAxValueColumn" type.
Syntax
Expression.GetValueColumn(ByVal vIndex As Variant)
Expression
Parameters
VARIANT
vIndex Index or name of the value column of the f(t) trend view.
Example
'VBS345
Dim ctrl
Dim objValueColumn
Set objValueColumn = ctrl.GetValueColumn("Valuecolumn1")
objValueColumn.Precisions = 4
Set objValueColumn = ctrl.GetValueColumn(2)
objValueColumn.ExponentialFormat = TRUE
Note
For the "ValueColumn" listing, for example, you write "objValueColumn.Precisions" instead of
"objValueColumn.ValueColumnPrecisions".
See also

VB scripting
GetValueColumnCollection (RT Professional)
Description
Returns the list of all value column objects of the f(t) trend view as "ICCAxCollection" type.
Syntax
Ausdruck.GetValueColulmnCollection()
Expression
Parameters
--

● Count
● Item

VB scripting
Example
'VBS346
Dim ctrl
Dim objValCol1
Dim objValCol2
Dim coll
Dim valcol
Set objValCol1 = ctrl.GetValueColumnCollection.AddItem("ValueColumn1")
Set objValCol2 = ctrl.GetValueColumnCollection.AddItem("ValueColumn2")
objValCol1.Caption = "Value Archive"
objValCol1.Provider = 1
objValCol1.TagName = "ProcessValueArchive\arch1"
objValCol1.TimeColumn = "TimeColumn1"
objValCol2.Caption = "Value Tag"
objValCol2.Provider = 2
objValCol2.TagName = "tagxx"
objValCol2.TimeColumn = "TimeColumn2"
Set coll = ctrl.GetValueColumnCollection
For Each valcol In coll
valcol.Align = 2
valcol.Length = 10
valcol.AutoPrecisions = TRUE
Next
See also
GetXAxis (RT Professional)
Description
Returns the X axis object of the f(x) trend view designated by name or index as
Syntax
Ausdruck.GetXAxis(ByVal vIndex As Variant)
Expression

VB scripting
Parameters
VARIANT
vIndex Index or name of X axis.
Example
'VBS347
Dim ctrl
Dim objXAx
Set ctrl = ScreenItems("FunctionTrendControl")
Set objXAx = ctrl.GetXAxis(1)
objXAx.Visible = FALSE
Set objXAx = ctrl.GetXAxis("axis 2")
objXAx.Label = "X axis 2"
objXAx.ScalingType = 0
objXAx.Precisions = 2
objXAx.Color = RGB(109,109,109)
Note
For the "XAxis" listing, for example, you write "objXAx.Visible" instead of "objXAx.XAxisVisible".
See also
GetXAxisCollection (RT Professional)
Description
Returns the list of all X axis objects of the f(x) trend view as "ICCAxCollection" type.
Syntax
Ausdruck.GetXAxisCollection()
Expression

VB scripting
Parameters
--

● Count
● Item
Example
'VBS348
Dim ctrl
Dim objXAxis1
Dim objXAxis2
Dim coll
Dim axes
Set objXAxis1 = ctrl.GetXAxisCollection.AddItem("myXAxis1")
objXAxis1.Label = "temperature"
Set objXAxis2 = ctrl.GetXAxisCollection.AddItem("myXAxis2")
objXAxis2.Label = "pressure"
Set coll = ctrl.GetXAxisCollection
HMIRuntime.Trace "Number of XAxis:" & coll.Count & vbCrLf
For Each axes In coll
HMIRuntime.Trace axes.Name & vbCrLf
HMIRuntime.Trace axes.Label & vbCrLf
Next
Note
For the "XAxis" listing, for example, you write "objXAxis1.Label" instead of
"objXAxis1.XAxisLabel".
See also

VB scripting
GetYAxis (RT Professional)
Description
Returns the Y axis object of the f(x) trend view designated by name or index as
Syntax
Ausdruck.GetYAxis(ByVal vIndex As Variant)
Expression
Parameters
VARIANT
vIndex Index or name of Y axis.
Example
'VBS349
Dim ctrl
Dim objYAx
Set objYAx = ctrl.GetYAxis(1)
objYAx.Visible = FALSE
Set objYAx = ctrl.GetYAxis("axis 2")
objYAx.Label = "Y axis 2"
objYAx.Align = 0
objYAx.Precisions = 3
objYAx.EndValue = 90.000
objYAx.BeginValue = 10.000
Note
For the "YAxis" listing, for example, you write "objYAx.Visible" instead of "objYAx.YAxisVisible".
See also

VB scripting
GetYAxisCollection (RT Professional)
Description
Returns the list of all Y axis objects of the f(x) trend view as "ICCAxCollection" type.
Syntax
Ausdruck.GetYAxisCollection()
Expression
Parameters
--

● Count
● Item
Example
'VBS350
Dim ctrl
Dim objYAxis1
Dim objYAxis2
Dim coll
Dim axes
Set objYAxis1 = ctrl.GetXAxisCollection.AddItem("myYAxis1")
objYAxis1.Label = "temperature"
Set objYAxis2 = ctrl.GetXAxisCollection.AddItem("myYAxis2")
objYAxis2.Label = "pressure"
Set coll = ctrl.GetYAxisCollection
HMIRuntime.Trace "Number of YAxis:" & coll.Count & vbCrLf
For Each axes In coll
HMIRuntime.Trace axes.Name & vbCrLf
HMIRuntime.Trace axes.Label & vbCrLf
Next

VB scripting
Note
For the "YAxis" listing, for example, you write "objYAxis1.Label" instead of
"objYAxis1.YAxisLabel".
See also
1.5.6.2 Methods H-R (Panels, Comfort Panels, RT Advanced, RT Professional)
HideAlarm (RT Professional)
Description
Executes the "Hide alarm" button function of the alarm view.
Syntax
Expression.HideAlarm()
Expression
Parameter
--
See also
InsertData (RT Professional)
Description
Adds data to the called trend.

VB scripting
Syntax
Expression.InsertData(dblAxisX As Variant, dblAxisY As Variant)
Expression
Necessary. An expression which returns an object of the "Trend" type.
Parameters
dblAxisX Value of X axis
dblAxisY Value of Y axis
Example
'VBS300
Dim lngFactor
Dim dblAxisX
Dim dblAxisY
Dim objTrendControl
Dim objTrend
Set objTrendControl = ScreenItems("Control1")
Set objTrend = objTrendControl.GetTrend("Trend 1")
For lngFactor = -100 To 100
dblAxisX = CDbl(lngFactor * 0.02)
dblAxisY = CDbl(dblAxisX * dblAxisX + 2 * dblAxisX + 1)
objTrend.InsertData dblAxisX, dblAxisY
Next
Item (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Returns an element from a list.
Syntax
Expression.Item(Index)
Expression
Necessary. An expression which returns a list.

VB scripting
Parameters
Index
The name or the index number of an element of the list:
● ScreenItems-Listing: Use an object name, e.g.
"HmiRuntime.Screens(1).ScreenItems("Circle")", or the index number.
● Screens-Listing: Use either the name or the index number.
● SmartTags-Listing: You can only use the tag name as index in the SmartTags list. A
counting of all tags is not possible.
If the transferred value does not correspond with an element in the list, an error occurs. The
return value has the value "Nothing".
On Error Resume Next

Dim screen
Set screen = HmiRuntime.Screens("Screen_1")
If (screen is Nothing)
then...
Else...
End If
Best practice for optimizing auto-completion support is to use combined addressing by means
of screen name and object name, e.g.
"HmiRuntime.Screens("Screen").ScreenItems("Circle")".
Example
The item method is the default method for lists. Therefore, the results are the same for the
following two examples:
'VBS_Example_Item
HMIRuntime.Screens.Item(1)
HMIRuntime.Screens(1)
Both instructions reference the respective base screen.
See also
ScreenItems (list) (Page 219)

VB scripting
LockAlarm (RT Professional)
Description
Executes the "Disable alarm" button function of the alarm view.
Syntax
Expression.LockAlarm()
Expression
Parameter
--
See also
LoopInAlarm (RT Professional)
Description
Executes the "Loop in alarm" button function of the alarm view.
Syntax
Expression.LoopInAlarm()
Expression
Parameter
--
See also

VB scripting
MoveAxis (RT Professional)
Description
Executes the "Move axes area" button function of the f(t) and f(x) trend views.
Syntax
Expression.MoveAxis()
Expression
Parameter
--
See also
MoveToFirst (RT Professional)
Description
Executes the "First line" button function of the control.
Syntax
Expression.MoveToFirst()
Expression
Parameters
--
See also

VB scripting
MoveToFirstLine (RT Professional)
Description
Executes the "First alarm" button function of the alarm view.
Syntax
Expression.MoveToFirstLine()
Expression
Parameter
--
See also
MoveToFirstPage (RT Professional)
Description
Executes the "First page" button function of the alarm view.
Syntax
Expression.MoveToFirstPage()
Expression
Parameter
--
See also

VB scripting
MoveToLast (RT Professional)
Description
Executes the "Last data record" button function of the control.
Syntax
Expression.MoveToLast()
Expression
Parameters
--
See also
MoveToLastLine (RT Professional)
Description
Executes the "Last alarm" button function of the alarm view.
Syntax
Expression.MoveToLastLine()
Expression
Parameters
--
See also

VB scripting
MoveToLastPage (RT Professional)
Description
Executes the "Last page" button function of the alarm view.
Syntax
Expression.MoveToLastPage()
Expression
Parameter
--
See also
MoveToNext (RT Professional)
Description
Executes the "Next data record" button function of the control.
Syntax
Expression.MoveToNext()
Expression
Parameters
--
See also

VB scripting
MoveToNextLine (RT Professional)
Description
Executes the "Next alarm" button function of the alarm view.
Syntax
Expression.MoveToNextLine()
Expression
Parameter
--
See also
MoveToNextPage (RT Professional)
Description
Executes the "Next page" button function of the alarm view.
Syntax
Expression.MoveToNextPage()
Expression
Parameter
--
See also

VB scripting
MoveToPrevious (RT Professional)
Description
Executes the "Previous data record" button function of the control.
Syntax
Expression.MoveToPrevious()
Expression
Parameters
--
See also
MoveToPreviousLine (RT Professional)
Description
Executes the "Previous alarm" button function of the alarm view.
Syntax
Expression.MoveToPreviousLine()
Expression
Parameter
--
See also

VB scripting
MoveToPreviousPage (RT Professional)
Description
Executes the "Previous page" button function of the alarm view.
Syntax
Expression.MoveToPreviousPage()
Expression
Parameter
--
See also
NextColumn (RT Professional)
Description
Executes the "Next column" button function of the table view.
Syntax
Expression.NextColumn()
Expression
Parameter
--
See also

VB scripting
NextTrend (RT Professional)
Description
Executes the "Next trend" button function of the f(t) and f(x) trend views.
Syntax
Expression.NextTrend()
Expression
Parameters
--
See also
OneToOneView (RT Professional)
Description
Executes the "Original view" button function of the f(t) and f(x) trend views.
Syntax
Expression.OneToOneView()
Expression
Parameters
--
See also

VB scripting
PasteRows (RT Professional)
Description
Executes the "Insert rows" button function of the recipe view.
Syntax
Expression.PasteRows()
Expression
Parameter
--
See also
PreviousColumn (RT Professional)
Description
Executes the "Previous column" button function of the table view.
Syntax
Expression.PreviousColumn()
Expression
Parameter
--
See also

VB scripting
PreviousTrend (RT Professional)
Description
Executes the "Previous trend" button function of the f(t) and f(x) trend views.
Syntax
Expression.PreviousTrend()
Expression
Parameters
--
See also
Print (RT Professional)
Description
Executes the "Print" button function of the control.
Syntax
Expression.Print()
Expression
Parameters
--
See also

VB scripting

QuitHorn (RT Professional)
Description
Executes the "Alarm annunciator acknowledgment" button function of the alarm view.
Syntax
Expression.QuitHorn()
Expression
Parameter
--
See also
QuitSelected (RT Professional)
Description
Executes the "Single acknowledgment" button function of the alarm view.
Syntax
Expression.QuitSelected()
Expression
Parameter
--
See also

VB scripting
QuitVisible (RT Professional)
Description
Executes the "Group acknowledgment" button function of the alarm view.
Syntax
Expression.QuitVisible()
Expression
Parameter
--
See also
Read (RT Professional)
Description of Tag Object

Reads out the status of a tag (tag object) shortly after the moment it was called. At the same
time, the tag object is provided with the values read. Upon reading a tag, its value, quality code
and time stamp are determined. The "LastError" property can be used to determine whether
the call was successful.
The "Name" and "Tagprefix" properties are not changed by this.
If the value of the tag is read successfully, the properties of the tag object are assigned the
following values:
Property Allocation
Value Tag values
Name Tag name (unchanged)
QualityCode Quality level
Timestamp Current tag time stamp
LastError 0
ErrorDescription ""

VB scripting
If the value of the tag is not read successfully, the properties of the tag object are assigned
the following values:
Property Allocation
Value VT_Empty
QualityCode Bad Out of Service
Timestamp 0
LastError Read operation error codes
ErrorDescription Error description on LastError
syntax
Expression.Read([Readmode])
Expression
Necessary. An expression which returns a tag object. The return value of the Read method is
the value of the tag read out.
Parameters
The optional "Readmode" parameter enables the distinction between two types of reading:
0 The tag value is read from the process image
(cache). 0 is the default value.
1 The value of a tag is read directly from AS or chan‐
nel (direct).
If the "Readmode" parameter is omitted, the value is read from the process image by default.
The return value of the Read method is the tag value read out as VARIANT.
Reading From the Process Image

When reading from the process image, the tag is logged on and, from that moment, polled
cyclically from the PLC. The login cycle is dependent on the configured trigger. The value is
read from the tag image by WinCC. For Close Picture, the tag actions are ended again. The
call is characterized by the following:
● The value is read by WinCC from the tag image.
● The call is faster in comparison to direct reading (except with the first call: The first call
basically takes longer because the value from the PLC must be read out and logged on.)
● The duration of the call is not dependent on the bus load or AS.
Behavior in actions with a tag trigger
All of the tags contained in the tag trigger are already known with Open Picture and are
registered with the defined monitoring time. Since all tags are requested at once, the best
possible optimization can be targeted from the channel. If a tag, contained in the trigger, is
requested with Read during an action, the value already exists and is transferred directly to

VB scripting
the call. If a tag is requested which is not contained in the trigger, the behavior is the same as
with a standard trigger.
Behavior in actions with a cyclic trigger
tags are registered with half of the cycle time with the first call. For every other call, the value
is present.
Behavior in event-driven actions
The tag is registered in the "upon change" mode with the first call. Process tags that are
registered in the "upon change" mode correspond with a cyclic read job with a cycle time of
1s.
If an event (e.g. mouse click) requests a value asynchronously, the tag is transferred to the
tag image. The tag is requested cyclically from the AS as of this point in time and therefore
increases the basic load. To bypass this increase in the basic load, the value can also be read
synchronously. The synchronous call causes a one-off increase in the communication load
but the tag is not transferred to the tag image.
Direct reading
In the case of direct reading, the current value is returned. The tag is not registered cyclically,
the value is requested from the AS one time only. Direct reading has the following properties:
● The value is read explicitly from the AS.
● The call takes longer compared to reading from the process image.
● The duration of the call is dependent on the bus load and AS, amongst other things.
Example
Reading a tag directly from AS or channel
'VBS100
Dim objTag
Dim vntValue
vntValue = objTag.Read(1) 'Read direct
MsgBox vntValue
Reading a tag from the process image
'VBS101
Dim objTag
Dim vntValue
vntValue = objTag.Read 'Read from cache
MsgBox vntValue

VB scripting

The TagSet object offers the option of reading several tags in one call.
Functionality here is mostly identical with that of a tag object. In the following, only deviations
thereof are described.
Expression
Reading From the Process Image

The TagSet object offers the advantage of requesting several tags in one read command. The
tags are registered in the process image as a group, improving performance in the process.
Direct reading
Since one call may process several read commands, performance is enhanced in comparison
to single calls.
Example
The following example shows how tags are included in the TagSet list, how tag values are
imported and subsequently read.
'VBS174
Dim group
group.Add "Motor1"
group.Add "Motor2"
group.Read
HMIRuntime.Trace "Motor1: " & group("Motor1").Value & vbNewLine
HMIRuntime.Trace "Motor2: " & group("Motor2").Value & vbNewLine
If the optional parameter "Readmode" is set to 1, the process tags are not registered but read
directly from AS or channel.
group.Read 1
ReadTags (RT Professional)
Description
Executes the "Read tags" button function of the recipe view.

VB scripting
Syntax
Expression.ReadTags()
Expression
Parameter
--
See also
Refresh (RT Professional)
Description
Drawing all visible pictures again.
syntax
Expression.Refresh
Expression
Necessary. An expression which returns a "Screens" or "Screen" type object.
Parameter
--
Examples
The first example forces all visible pictures to be drawn again:
'VBS149
HMIRuntime.Screens.Refresh
The second example forces the basic picture to be immediately redrawn:
'VBS150
HMIRuntime.Screens(1).Refresh

VB scripting
See also
Screen (Page 214)
Remove (RT Professional)

Removes a tag from the TagSet list. The tag may be removed by name or reference to a tag
object.
Syntax
Expression.Remove [Tag]
Expression
Required An expression that returns an object of type "TagSet".
Parameters
VARIANT
Tag Name of a WinCC tag or reference to a tag object
to be removed from the list.
Example
The following example shows how several tags are included in the TagSet list, and how to
remove a tag again.
'VBS175
Dim group
group.Add "Motor1"
group.Add "Motor2"
group.Remove "Motor1"

Deletes the element specified in parameter "Name" from a list.

VB scripting
Syntax
Expression.Remove [Name]
Expression
Required An expression which returns an object of type "DataSet".
Parameters
VARIANT
Name Name of the object to be removed from the list.
Example
The example shows how to remove the object "motor1" from the list.
'VBS166
Description of objects Logging, AlarmLogs, DataLogs

The method deletes previously swapped-in log segments from the Runtime project.
Log segments that were deleted using the "Remove" method are removed from the "Common
logging" folder of the project.
The call may require a somewhat longer time period, depending on the log data. This may
block the processing of subsequent scripts. Blockage of actions within the picture may be
avoided if you start the call in a Global Scripting action, such as starting the action through a
trigger tag.
The process of disconnecting and clearing logs creates a CPU load. This will affect
performance.
Note
Calling up the "Remove" method is presently only possible at the server. There is an example,
however, which shows how the method may be started by the client from a server.
Syntax
Objects Logging, AlarmLogs

Expression.Remove [TimeFrom] [TimeTo] [TimeOut] [ServerPrefix]
Expression
Required An expression that returns an object of type "Logging" or "AlarmLogs".

VB scripting
Object DataLogs
Expression.Remove [TimeFrom] [TimeTo] [TimeOut] [Type] [ServerPrefix]
Expression
Required An expression that returns an object of type "DataLogs".
Parameters
TimeFrom
Point in time, from which the logs are to be cleared.
When specifying the time information, a short form is also possible. This is described in the
"Time format" section.
TimeTo
Time up to which log segments are to be cleared.
"Time Format" section.
Timeout
Timeout in milliseconds.
If you enter "-1" as a value, the wait will be infinite. If you enter a value of "0", there will be no
wait.
Type
Type of log.
The parameter can (optionally) be used only to delete log segments of the tag logging.
The following values can be entered:
Assigned value Type Description

1 hmiDataLogFast Tag Logging Fast data
2 hmiDataLogSlow Tag Logging Slow data
3 hmiDataLogAll Tag Logging Fast and Slow data
ServerPrefix
Reserved for future versions.
Return value
If an error occurred during deletion of the log segments, the method will return an error alarm.
Additional information may be found under the subject heading "Error alarms from database
area".

VB scripting
Time format
The format for specifying time information is defined as follows: YYYY-MM-DD hh:mm:ss,
where YYYY represents the year, MM the month, DD the day, hh the hour, mm the minute
and ss the second. For example, the time of 2 minutes and one second past 11 o'clock on July
26, 2004 is displayed as follows: 2004-07-26 11:02:01.
For parameters "TimeFrom" and "TimeTo" the statement of data and time is also possible in
short form. Not all format fields must be filled in this case. The short form means that the
information on date and time may be lacking one or several parameters, beginning with the
value for seconds. For example, the time may be specified in the "YYYY-MM" or "YYYY-MM-
DD hh" format. Using the statement "TimeFrom" = "2004-09" and "TimeTo" = "2004-10-04" all
log segments between September 2004 up to and including October 4.
Example
In the following example, log segments within a certain time period that were swapped in
(again) after the fact are removed and the return value is output as a trace.
'VBS182
HMIRuntime.Trace "Ret: " & HMIRuntime.Logging.Remove("2004-08-22","2004-09-22",-1) &
vbNewLine
In the following example, all log segments that were swapped-in (again) after the fact are
removed and the return value is output as a trace.
'VBS183
HMIRuntime.Trace "Ret: " & HMIRuntime.Logging.Remove("","",-1) & vbNewLine
See also
Logging (Page 212)
RemoveAll (RT Professional)

Deletes all tags from a TagSet list.
syntax
Expression.RemoveAll

VB scripting
Expression
Parameters
--
Example:
The following example shows how several tags are included in the TagSet list, and how to
remove all tags again.
'VBS176
Dim group
group.Add "Motor1"
group.Add "Motor2"
group.RemoveAll

Deletes all values or object references from a DataSet list.
syntax
Expression.RemoveAll
Expression
Necessary. An expression which returns an object of type "DataSet".
Parameters
--
Example:
The example shows how all objects are removed from the list.
'VBS167
HMIRuntime.DataSet.RemoveAll
See also

VB scripting
Restore (RT Professional)
Description of objects Logging, AlarmLogs, DataLogs

The method adds swapped-out log segments to the Runtime project.
Upon swapping-in, the log segments are copied to the "Common logging" folder of the project.
Therefore the appropriate storage capacity must be available.
The call may require a somewhat longer time period, depending on the log data. This may
block the processing of subsequent scripts. Blockage of actions within the picture may be
avoided if you start the call in a Global Scripting action, such as starting the action through a
trigger tag.
The connecting/copying of the logs generates a CPU load because the SQL server
experiences additional load, especially if signature checking is activated. Copying of log
segments will slow down hard disk access.
If signature checking is activated, an error message is returned if an unsigned or modified log
is to be swapped in. There is always only one error alarm returned, even if several errors
occurred during a swap-in process. Additionally, a WinCC system alarm is generated for each
log segment. An entry is added to the Windows event viewer in the "Application" section. This
provides the opportunity to check which log segments are creating the error.
● With an unsigned log, the return value "0x8004720F" is returned. The event viewer contains
the entry "Validation of database <db_name> failed! No signature found!".
The log is swapped in.
● With a changed log, the return value "0x80047207" is returned. The event viewer contains
the entry "Validation of database <db_name> failed!".
The log is not swapped in.
Note
Calling up the "Restore" method is presently only possible at the server. There is an
example, however, which shows how the method may be started by the client from a server.
Syntax
Objects Logging, AlarmLogs

Expression.Restore [SourcePath] [TimeFrom] [TimeTo] [TimeOut]
[ServerPrefix]
Expression
Required An expression that returns an object of type "Logging" or "AlarmLogs".
Object DataLogs
Expression.Restore [SourcePath] [TimeFrom] [TimeTo] [TimeOut] [Type]
[ServerPrefix]

VB scripting
Expression
Required An expression that returns an object of type "DataLogs".
Parameters
SourcePath
Path to log data.
TimeFrom
Point in time, from which the logs are to be swapped in.
"Time format" section.
TimeTo
Time up to which log segments are to be swapped in.
"Time Format" section.
Timeout
Timeout in milliseconds.
If you enter "-1" as a value, the wait will be infinite. If you enter a value of "0", there will be no
wait.
Type
Type of log.
The parameter can (optionally) be used only to store log segments of the tag logging.
The following values can be entered:
Assigned value Type Description

1 hmiDataLogFast Tag Logging Fast data
2 hmiDataLogSlow Tag Logging Slow data
3 hmiDataLogAll Tag Logging Fast and Slow data
ServerPrefix
Reserved for future versions.
Return value
If an error occurred while swapping in log segments, the method will return an error message.
Additional information may be found under the subject heading "Error alarms from database
area".

VB scripting
Time format
The format for specifying time information is defined as follows: YYYY-MM-DD hh:mm:ss,
where YYYY represents the year, MM the month, DD the day, hh the hour, mm the minute
and ss the second. For example, the time of 2 minutes and one second past 11 o'clock on July
26, 2004 is displayed as follows: 2004-07-26 11:02:01.
For parameters "TimeFrom" and "TimeTo" the statement of data and time is also possible in
short form. Not all format fields must be filled in this case. The short form means that the
information on date and time may be lacking one or several parameters, beginning with the
value for seconds. For example, the statement may be in the form of "YYYY-MM" or "YYYY-
MM-DD hh". Using the statement "TimeFrom" = "2004-09" and "TimeTo" = "2004-10-04" all
log segments between September 2004 up to and including October 4.
Example
In the following example, all log segments since the start of the specified time period are
swapped in again, and the return value is output as a trace.
'VBS184
HMIRuntime.Trace "Ret: " & HMIRuntime.Logging.Restore("D:\Folder","2004-09-14","",-1) &
vbNewLine
In the following example, all Tag Logging Slow log segments in the specified time period are
'VBS185
HMIRuntime.Trace "Ret: " & HMIRuntime.Logging.DataLogs.Restore("D:\Folder","2004-09-14
12:30:05","2004-09-20 18:30",-1,2) & vbNewLine
In the following example, all Alarm Logging log segments up to the specified time period are
'VBS186
HMIRuntime.Trace "Ret: " & HMIRuntime.Logging.AlarmLogs.Remove("","2004-09-20",-1) &
vbNewLine
See also
Logging (Page 212)

VB scripting
1.5.6.3 Methods S-Z (Panels, Comfort Panels, RT Advanced, RT Professional)
SelectAll (RT Professional)
Description
Selects all rows in a table-based control.
Syntax
Expression.SelectAll()
Expression
Parameters
--
See also
SelectedStatisticArea (RT Professional)
Description
Executes the "Set statistics range" button function of the table view.
Syntax
Expression.SelectedStatisticArea()
Expression
Parameter
--

VB scripting
See also
SelectRow (RT Professional)
Description
Selects a specific row in a table-based control.
Syntax
Expression.SelectRow ByVal IRow As Long, Optional bExtendSelection
As Boolean
Expression
Parameters
IRow Number of the row to be selected.
bExtendSelection Indicates as an option whether the current selection will be extended. Is only rel‐
evant if multiple selections are possible.
Example
● Row 1 is currently selected. If SelectRow 4, True is called, then row 1 and row 4 are
selected.
● Row 1 is currently selected. If SelectRow 4, False or SelectRow 4 is called without
an optional parameter, then only row 4 is selected.
See also
ServerExport (RT Professional)
Description
Executes the "Export log" button function of the recipe view.

VB scripting
Syntax
Expression.ServerExport()
Expression
Parameter
--
See also
ServerImport (RT Professional)
Description
Executes the "Import log" button function of the recipe view.
Syntax
Expression.ServerImport()
Expression
Parameter
--
See also
SetHTML (RT Professional)
Description
Writes a HTML code in the display range of the HTML browser.
Syntax
Epression.SetHTML string

VB scripting
Expression
Required. An expression which returns an "HTMLBrowser" type object.
Example
Dim objBrowser
Set objBrowser= HMIRuntime.Screens("Screen_1").ScreenItems("HTML-Browser_1")
objBrowser.SetHTML "<h1>This is a title</h1><p>This is a <b>bold</b> text.</p>"
See also
SetOperationLock (RT Professional)
Description
Temporarily switches off the operability of a screen window. The respective screen window
can be defined as transparent. You determine the level of transparency yourself.
Note
This function is available for all screen windows except for the root screen.
Note
The contents of the temporary inoperable screen window are not updated on a PC with
Windows 7 operating system.
The contents of the screen window are updated continuously on a PC with Windows 8 or
Windows 10.
Syntax
Expression.SetOperationLock(ByVal LockState as Bool, ByVal
TransparencyLevel as Long)
Expression
Parameters
True The operability of the screen window was switched off temporarily.
False The operability of the screen window was switched off temporarily.
Value Value for the transparency of the screen window

VB scripting
Example
In the following example, you make the contents of the screen window "MyLockedWindow"
inoperable in the Screen_1 screen by setting the "SetOperationLock" parameter to "true":
HmiRuntime.Screens("Screen_1").ScreenItems("MyLockedWindow").SetOperationL
ock true, 20
The number "20" determines the transparency of the screen window.

If you set the "SetOperationLock" parameter to "false", the "MyLockedWindow" screen window
can be operated again.
HmiRuntime.Screens("Screen_1").ScreenItems("MyLockedWindow").SetOperationL
ock true, 20
ShowColumnSelection (RT Professional)
Description
Executes the "Select columns" button function of the table view.
Syntax
Expression.ShowColumnSelection()
Expression
Parameter
--
See also
ShowComment (RT Professional)
Description
Executes the "Comment dialog" button function of the alarm view.
Syntax
Expression.ShowComment()

VB scripting
Expression
Parameters
--
See also
ShowDisplayOptionsDialog (RT Professional)
Description
Executes the "Display options dialog" button function of the alarm view.
Syntax
Expression.ShowDisplayOptionsDialog()
Expression
Parameter
--
See also
ShowEmergencyQuitDialog (RT Professional)
Description
Executes the "Emergency acknowledgment" button function of the alarm view.
Syntax
Expression.ShowEmergencyQuitDialog()
Expression

VB scripting
Parameter
--
See also
ShowHelp (RT Professional)
Description
Executes the "Help" button function of the control.
Syntax
Expression.ShowHelp()
Expression
Parameters
--
See also
ShowHideList (RT Professional)
Description
Executes the "List of alarm to hide" button function of the alarm view.
Syntax
Expression.ShowHideList()

VB scripting
Expression
Parameter
--
See also
ShowHitList (RT Professional)
Description
Executes the "Hit list" button function of the alarm view.
Syntax
Expression.ShowHitList()
Expression
Parameter
--
See also
ShowInfoText (RT Professional)
Description
Executes the "About dialog" button function of the alarm view.
Syntax
Expression.ShowInfoText()
Expression

VB scripting
Parameter
--
See also
ShowLockDialog (RT Professional)
Description
Executes the "Lock dialog" button function of the alarm view.
Syntax
Expression.ShowLockDialog()
Expression
Parameter
--
See also
ShowLockList (RT Professional)
Description
Executes the "Lock list" button function of the alarm view.
Syntax
Expression.ShowLockList()
Expression
Parameter
--

VB scripting
See also
ShowLongTermArchiveList (RT Professional)
Description
Executes the "Historical alarm list (long-term)" button function of the alarm view.
Syntax
Expression.ShowLongTermArchiveList()
Expression
Parameter
--
See also
ShowMessageList (RT Professional)
Description
Executes the "Alarm list" button function of the alarm view.
Syntax
Expression.ShowMessageList()
Expression
Parameter
--
See also

VB scripting
ShowPercentageAxis (RT Professional)
Description
Executes the "Relative axis" button function of the f(t) trend view.
Syntax
Expression.ShowPercentageAxis()
Expression
Parameter
--
See also
ShowPropertyDialog (RT Professional)
Description
Executes the "Configuration dialog" button function of the control.
Syntax
Expression.ShowPropertyDialog()
Expression
Parameters
--
See also

VB scripting

ShowSelectArchive (RT Professional)
Description
Executes the "Select data connection" button function of the recipe view.
Syntax
Expression.ShowSelectArchive()
Expression
Parameter
--
See also
ShowSelection (RT Professional)
Description
Executes the "Selection dialog" button function of the recipe view.
Syntax
Expression.ShowSelection()
Expression
Parameter
--
See also

VB scripting
ShowSelectionDialog (RT Professional)
Description
Executes the "Selection dialog" button function of the alarm view.
Syntax
Expression.ShowSelectionDialog()
Expression
Parameter
--
See also
ShowSelectTimeBase (RT Professional)
Description
Executes the "Timebase dialog" button function of the recipe view.
Syntax
Expression.ShowSelectTimeBase()
Expression
Parameter
--
See also

VB scripting
ShowShortTermArchiveList (RT Professional)
Description
Executes the "Historical alarm list (short-term)" button function of the alarm view.
Syntax
Expression.ShowShortTermArchiveList()
Expression
Parameter
--
See also
ShowSort (RT Professional)
Description
Executes the "Sorting dialog" button function of the recipe view.
Syntax
Expression.ShowSort()
Expression
Parameter
--
See also

VB scripting
ShowSortDialog (RT Professional)
Description
Executes the "Sorting dialog" button function of the alarm view.
Syntax
Expression.ShowSortDialog()
Expression
Parameter
--
See also
ShowTagSelection (RT Professional)
Description
Executes the "Select data connection" button function of the control.
Syntax
Expression.ShowTagSelection()
Expression
Parameters
--
See also

VB scripting
ShowTimebaseDialog (RT Professional)
Description
Executes the "Timebase dialog" button function of the alarm view.
Syntax
Expression.ShowTimebaseDialog()
Expression
Parameter
--
See also
ShowTimeSelection (RT Professional)
Description
Executes the "Select time range" button function of the control.
Syntax
Expression.ShowTimeSelection()
Expression
Parameters
--
See also

VB scripting
ShowTrendSelection (RT Professional)
Description
Executes the "Select trends" button function of the f(t) and f(x) trend views.
Syntax
Expression.ShowTrendSelection()
Expression
Parameters
-- -
See also
StartStopUpdate (RT Professional)
Description
Executes the "Start" or "Stop" button function of the control.
Syntax
Expression.StartStopUpdate()
Expression
Parameters
--
See also

VB scripting
Stop (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Closes WinCC Runtime.
Syntax
Expression.Stop()
Expression
Required. An expression which returns an object of the type "HMIRuntime".
Parameters
--
See also
Trace (Panels, Comfort Panels, RT Advanced, RT Professional)
Description
Returns a user-defined text through the operating system channel for debug alarms.
The HMIRuntime.Trace method works only for WinCC Runtime Professional. The text
transferred as a parameter can be displayed with the "Print job/Script diagnostics" object or
the "ApDiag" diagnostics tool. The "ApDiag" diagnostics tool is installed by default with Runtime
Professional. The diagnostics tool is available at the following path: "C:\Program Files
(x86)\Siemens\Automation\SCADA-RT_V11\WinCC\uTools".You can find additional
information on the Internet (https://support.industry.siemens.com/cs/de/en/view/102777629).
If a trace is needed for Runtime Advanced or on a panel, the "ShowSystemAlarm" system
function can be used.
Syntax
Expression.Trace"STRING"
Expression
Required An expression which returns an "HMIRuntime" type object.
Parameters
STRING
The text which is issued as a debug alarm.

VB scripting
Example
In the following example a debug alarm is issued:
'VBS example trace
HMIRuntime.Trace "Customized error message"
See also
UnhideAlarm (RT Professional)
Description
Executes the "Unhide alarm" button function of the alarm view.
Syntax
Expression.UnhideAlarm()
Expression
Parameter
--
See also
UnlockAlarm (RT Professional)
Description
Executes the "Unlock alarm" button function of the alarm view.
Syntax
Expression.UnlockAlarm()
Expression

VB scripting
Parameter
--
See also
UnselectAll (RT Professional)
Description
Removes all selections from the cells of a table-based control.
Syntax
Expression.UnselectAll()
Expression
Parameters
--
See also
UnselectRow (RT Professional)
Description
Removes the selections from a specific cell of a table-based control.
Syntax
Expression.UnselectRow(ByVal IRow As Long)
Expression

VB scripting
Parameters
Long
IRow Number of rows whose selection will be removed.
See also
Write (RT Professional)
Description of Tag Object

Writes a value to a tag. The "LastError" property can be used to determine whether the call
was successful.
If the value of the tag is set successfully, the properties of the tag object are assigned the
following values:
Property Allocation
Value Tag values set by the user (unchanged)
Timestamp 0
LastError 0
ErrorDescription ""
If the value of the tag is not set successfully, the properties of the tag object are assigned the
following values:
Property Allocation
Value Tag values set by the user (unchanged)
Timestamp 0
LastError Write operation error codes
ErrorDescription Error description on LastError
syntax
Expression.Write [Value],[Writemode]

VB scripting
Expression
Necessary. An expression which returns a tag object.
Parameters
The value to be written can be transferred directly to the method as a parameter. If the
parameter is not specified, the value in the "Value" property is used. The "Writemode" option
parameter can be used to select whether the tag value should be written synchronously or
asynchronously. If the "Writemode" parameter is not used, writing is performed asynchronously
as its default value.
During the writing process, no information is supplied on the status of the tags.
The "Value" property contains the value which was set before or during the writing operation,
therefore is may not correspond to the real current value of the tag. If the data on the tag should
be updated, use the Read method.
Value (optional) The tag value is specified. The specified value
overwrites the value in the "Value" property in the
tag object.
The tag value is not specified. The tag receives the
current value from the "Value" property of the tag
object.
Writemode (optional) 0 or empty: The tag value is written asynchronous‐
ly. 0 is the default value.
1: The tag value is written synchronously.
On asynchronous writing, it is written immediately into the tag image. The user does not receive
any feedback if the value has been written in the programmable controller, too.
In the case of synchronous writing (direct to the PLC), the writing operation actually occurs
when the PLC is ready to operate. The use receives a check-back message if the writing
operation was not successful.
Example
Asynchronous writing
'VBS104
Dim objTag
Set objTag = HMIRuntime.Tags("Var1")
objTag.Value = 5
objTag.Write
MsgBox objTag.Value

VB scripting
or
'VBS105
Dim objTag
objTag.Write 5
MsgBox objTag.Value
Synchronous writing
'VBS106
Dim objTag
objTag.Value = 5
objTag.Write ,1
MsgBox objTag.Value
or
'VBS107
Dim objTag
objTag.Write 5, 1
MsgBox objTag.Value

The TagSet object offers the option of writing several tags in one call.
Functionality here is mostly identical with that of a tag object. In the following, only deviations
thereof are described.
Expression
Parameters
In order to write different values, the "Value" property of individual tag objects must be set, and
write must be called thereafter without the "Value" parameter. Since the write commands are
grouped into one call, it results in improved performance compared to single calls.
In a TagSet object, it is not possible to pass on a value using the "Write" method. Individual
values must be set using the "Value" property of the individual tag objects.

VB scripting
Example
The following example shows how tags are included in the TagSet list, how tag values are set
and subsequently written.
'VBS173
Dim group
group.Add "Wert1"
group.Add "Wert2"
group("Wert1").Value = 3
group("Wert2").Value = 9
group.Write
If you set the optional parameter "Writemode" equal to 1, the process tags are written
synchronously (directly to AS).
group.Write 1
WriteTags (RT Professional)
Description
Executes the "Write tags" button function of the recipe view.
Syntax
Expression.WriteTags()
Expression
Parameter
--
See also
ZoomArea (RT Professional)
Description
Executes the "Zoom area" button function of the f(t) and f(x) trend views.

VB scripting
Syntax
Expression.ZoomArea()
Expression
Parameters
--
See also
ZoomInOut (RT Professional)
Description
Executes the "Zoom +/-" button function of the f(t) and f(x) trend views.
Syntax
Expression.ZoomInOut()
Expression
Parameters
--
See also
ZoomInOutTime (RT Professional)
Description
Executes the "Zoom time axis +/-" button function of the f(t) trend view.
Syntax
Expression.ZoomInOutTime()

VB scripting
Expression
Parameter
--
See also
ZoomInOutValues (RT Professional)
Description
Executes the "Zoom value axis +/-" button function of the f(t) trend view.
Syntax
Expression.ZoomInOutValues()
Expression
Parameter
--
See also
ZoomInOutX (RT Professional)
Description
Executes the "Zoom X axis +/-" button function of the f(x) trend view.
Syntax
Expression.ZoomInOutX()
Expression

VB scripting
Parameters
--
See also
ZoomInOutY (RT Professional)
Description
Executes the "Zoom Y axis +/-" button function of the f(x) trend view.
Syntax
Expression.ZoomInOutY()
Expression
Parameters
--
See also
ZoomMove (RT Professional)
Description
Executes the "Move trend area" button function of the f(t) and f(x) trend views.
Syntax
Expression.ZoomMove()
Expression
Parameters
--

VB scripting
See also

VB scripting

C scripting (RT Professional) 2
2.1.1 ActivateNextScreen (RT Professional)
Description
WinCC saves the names of the screens opened by the user during runtime as well as the
sequence in which these screens were opened.
Can only be used in C scripting.
The maximum size of the screen buffer is specified in the "Runtime settings > Screens > Screen
buffer" editor.
The ActivateNextScreen system function now opens the screen that was opened before the
last call of ActivatePreviousScreen.
Syntax
BOOL ActivateNextScreen();
Return value
TRUE
System function completed without errors.
FALSE
An error has occurred.
Example
The ActivateNextScreen function is used in the following program code to call the next screen
and to save the return value to the b_error tag.

C scripting (RT Professional)
{
BOOL b_error;
//Open next screen

b_error = ActivateNextScreen();
if(b_error)
{
// User defined code if
// function succeeds without error
...
}
else
{
// User defined code in case of error
...
}
...
}
2.1.2 ActivatePreviousScreen (RT Professional)
Description
WinCC saves the names of the screens opened by the user during runtime as well as the
sequence in which these screens were opened.
The system function can be used in C scripting only.
The maximum size of the screen buffer is specified in the "Runtime settings > Screens > Screen
buffer" editor.
The ActivatePreviousScreen system function now opens the screen which was open before
the currently open screen.
Syntax
BOOL ActivatePreviousScreen();
Return value
TRUE
FALSE

Example
The ActivatePreviousScreen function is used in the following program code to call the previous
screen and to save the return value to the b_error tag.
{
BOOL b_error;
//Open previous screen

b_error = ActivatePreviousScreen();
if(b_error)
{
...
}
else
{
...
}
...
}
2.1.3 ActivateScreen (RT Professional)
Description



Parameters
Screen name
Object number
Note
Example
'User-defined code
2.1.4 ActivateScreenInScreenWindow (RT Professional)
Description
Performs a screen change to the specified screen in a specified screen window.

ActivateScreenInScreenWindow (Screen name, Screen window, New screen name)


ActivateScreenInScreenWindow Screen_name, Screen_window, New_screen_name
Parameters
Screen name
Name of the screen to be displayed in the screen window.
Screen window
Name of the screen window in which the new screen is to be displayed.
New screen name

Name of the new screen to be displayed in the screen window.
Example
The ActivateScreenInScreenWindow function is used in the following program code to activate
the "Screen_2" screen when you click a button.
{
// i.e. when pressing a button
ActivateScreenInScreenWindow (GetParentScreen(screenName),
GetParentScreenWindow(screenName), "Screen_2");
...
}
2.1.5 ActivateStartScreen (RT Professional)
Description
Opens the configured start screen.
Syntax
BOOL ActivateStartScreen();

Return value
TRUE
FALSE
Example
The ActivateStartScreen function is used in the following program code to call the configured
start screen and to save the return value to the b_error tag.
{
BOOL b_error;
//Open start screen

b_error = ActivateStartScreen();
if(b_error)
{
...
}
else
{
...
}
...
}
2.1.6 ActivateStoredScreen (RT Professional)
Description
Opens the screen saved with the StoreScreen system function.
Syntax
BOOL ActivateStoredScreen();

Return value
TRUE
FALSE
Example
The ActivateStoredScreen function is used in the following program code to call the stored
screen and to save the return value to the b_error tag.
{
BOOL b_error;
//Open stored screen

b_error = ActivateStoredScreen();
if(b_error)
{
...
}
else
{
...
}
...
}
See also
StoreScreen (Page 1485)
2.1.7 DateToSystemTime (RT Professional)
Description
Converts a date-clock time specification in DATE format into the SYSTEMTIME data format.


DateToSystemTime (Value, Pointer to Date/Time)
Syntax
DateToSystemTime(Value, PointerToTime);
Parameters
Value
Value in DATE data format
PointerToTime
Pointer to the result in the SYSTEMTIME format
Return value
TRUE
FALSE

Example
BOOL BRet;
SYSTEMTIME st_1, st_2;
DATE d_1, d_2; // wtypes.h. DATE type. Visual Studio documnetation.
GetSystemTime( &st_1 );
printf( "st_1.wYear = %d \r\n", st_1.wYear );

printf( "st_1.wMonth = %d \r\n", st_1.wMonth );
printf( "st_1.wDayOfWeek = %d \r\n", st_1.wDayOfWeek );
printf( "st_1.wDay = %d \r\n", st_1.wDay );printf( "st_1.wHour = %d \r\n", st_1.wHour );
printf( "st_1.wMinute = %d \r\n", st_1.wMinute );
printf( "st_1.wSecond = %d \r\n", st_1.wSecond );
printf( "st_1.wMilliseconds = %d \r\n", st_1.wMilliseconds );
BRet = SystemTimeToDate( st_1, &d_1 );

printf( "DATE d = %ld \r\n \r\n", d_1 );
printf( "DATE d = %lf \r\n \r\n", d_1 );
printf( "DATE d = %f \r\n \r\n", d_1 );
BRet = DateToSystemTime( d_1, &st_2 );

printf( "st_2.wDay = %d \r\n", st_2.wDay );
printf( "st_2.wHour = %d \r\n", st_2.wHour );
printf( "st_2.wMilliseconds = %d \r\n \r\n \r\n", st_2.wMilliseconds );
2.1.8 DecreaseTag (RT Professional)
Description
X=X-a
Note



Parameters
Tag
Value
Example
The following program code decrements the value at the varX tag by the value at the value
tag. The value entered is saved to the old_value tag and output along with the new varX value.
{
BYTE varX;
BYTE value;
//user input
...
//Decrease tag
DecreaseTag(varX, value);

printf ("User input: %i\r\n, Result of function DecreaseTag: %i\r\n", old_value, varX);
...
}
2.1.9 GetLocalScreen (RT Professional)
Description
Returns a pointer to the screen name.

Syntax
char* GetLocalScreen(ScreenName);
Parameters
ScreenName
Pointer to the name of the screen.
Return value
Note
The syntax of the transferred call parameter "ScreenName" must correspond to that formed
by the graphics system for the screen paths:
en_name>...
Principle
A "Screen_A" contains a "Screen_window_B". Another screen is called in the screen window
and visualized as minimized image, etc.
Calling screens in the screen windows

1. "Screen_window_B" displays "Screen_C".
"Screen_C" contains "Screen_window_D".
2. "Screen_window_D" displays "Screen_E".
Pointer to the screen name

Returns the system function GetLocalScreen(ScreenName) in the next step with the
following values:
● "Screen_E", if the system function is called in "Screen_E"
● "Screen_C", if the system function is called in "Screen_C"
● "Screen_A", if the system function is called in "Screen_A"

Example
The following program code saves the return value of the function GetLocalScreen to the
pszScrName tag. If the return value is valid (not NULL), it is saved with maximum_MAX_PATH
characters to the szScrName tag.
{
char* pszScrName = NULL;
char szScrName[_MAX_PATH+1];
//Get the Local Screen

pszScrName = GetLocalScreen(lpszScreenName);
//Copy the string

if (pszScrName != NULL)
{
strncpy(szScrName,pszScrName,_MAX_PATH);
// print local screen name
printf ("Local screen name: %s\r\n", szScrName);
}
...
}
2.1.10 GetLinkedTag (RT Professional)
Description
Returns the name of the tag which is logically linked to the specified object property.
Syntax
char* GetLinkedTag(ScreenName, Object, NameOfProperty);
Parameters
ScreenName
Object
Pointer to the name of the object.
NameOfProperty
Pointer to the name of the object property.

Return value
Pointer to the name of the tag which is logically linked to the specified object property.
Note
Return value for user data types on the faceplate
If a user data type is directly interconnected on the faceplate, no tag name is returned. A tag
name is only returned if the structure elements of the user data type are interconnected
individually on the faceplate.
Example
The following program code saves the return value of function "GetLinkedTag" to the
"pszVarName" tag. If the return value is valid, it is saved with the maximum path length to the
szVAarName tag. The saved return value can be processed in a following code.
char CFunktion()
{
char* pszVarName = NULL;
char szVarName[_MAX_PATH+1]; //Get the TagName
pszVarName = GetLinkedVariable("gs_stand_graph_00","Textfield6","Visible"); //Copy the
string
if (strcmp (pszVarName,"")!= 0)
{
strncpy(szVarName,pszVarName,_MAX_PATH);
}
else printf("The property 'visible' is not dynamized\r\n");
//User defined code where the
//user can do something with the returnvalue
...
}
2.1.11 GetLanguageByLocaleID (RT Professional)
Description
Determines the current Runtime language.
Syntax
DWORD GetLanguageByLocaleID ();

Return value
Language ID.
The following assignments apply (hexadecimal language code):
Symbolic name Value(hexadecimal) Abbreviation

LANG_ARABIC 0x0401
LANG_AFRIKAANS 0x0436
LANG_ALBANIAN 0x041C
LANG_BASQUE 0x042D
LANG_BULGARIAN 0x0402
LANG_BYELORUSSIAN 0x0423
LANG_CATALAN 0x0403
LANG_CHINESE 0x0804
LANG_CROATIAN 0x041A
LANG_CZECH 0x0405 CSY
LANG_DANISH 0x0406 DAN
LANG_DUTCH 0x0413 NLD
LANG_ENGLISH 0x0409 ENU
LANG_ESTONIAN 0x0425
LANG_FAEROESE 0x0438
LANG_FARSI 0x0429
LANG_FINNISH 0x040B FIN
LANG_FRENCH 0x040C FRA
LANG_GERMAN 0x0407 DEU
LANG_GREEK 0x0408
LANG_HEBREW 0x040D
LANG_HUNGARIAN 0x040E HUN
LANG_ICELANDIC 0x040F ISL
LANG_INDONESIAN 0x0421
LANG_ITALIAN 0x0410 ITA
LANG_JAPANESE 0x0411
LANG_KOREAN 0x0412
LANG_LATVIAN 0x0426
LANG_LITHUANIAN 0x0427
LANG_NORWEGIAN 0x0414 NOR
LANG_POLISH 0x0415 PLK
LANG_PORTUGUESE 0x0416 PTB
LANG_ROMANIAN 0x0418
LANG_RUSSIAN 0x0419 RUS
LANG_SLOVAK 0x041B SKY
LANG_SLOVENIAN 0x0424
LANG_SORBIAN 0x042E
LANG_SPANISH 0x040A ESP


LANG_SWEDISH 0x041D SVE
LANG_THAI 0x041E
LANG_TURKISH 0x041F TRK
LANG_UKRAINIAN 0x0422
Example
The following program code reads out the current Runtime language and saves the return
value in the rt_language tag.
The saved return value can be processed in the following code (in this case, with printf output).
{
DWORD rt_language;
//Get the current language

rt_language = GetLanguageByLocaleID ();
//print language code

printf ("Language code: %d\r\n", rt_language);
...
}
2.1.12 GetParentScreen (RT Professional)
Description
The function determines the name of the parent screen from a specified screen path.
Syntax
char* GetParentScreen(ScreenName);
Parameters
ScreenName
Pointer to the name of the screen. The syntax of the transferred call parameter Screen name
must correspond to that formed by the graphics system for the screen paths:

en_name>...
Note
Return value
Name of the parent screen.
Principle

Example
The following program code saves the return value of function GetParentScreen to the
pszScrName tag. If the return value is valid (not NULL), it is saved with maximum_MAX_PATH
characters to the szScrName tag.
{
//Get the Parent Screen

pszScrName = GetParentScreen(lpszScreenName);
//Copy the string

{
// print Screen name
printf ("Screen name: %s\r\n", szScrName);
}
...
}
2.1.13 GetParentScreenWindow (RT Professional)
Description
The function determines the name of the parent screen window from a transferred screen path.
Syntax
char* GetParentScreenWindow(ScreenName);
Parameters
ScreenName
Pointer to the name of the screen. The syntax of the transferred Screen name call parameter
must correspond to that formed by the graphics system for the screen paths:
<Screen name>.<screen window name>:<screen name>.<screen window name>:<screen
name>...The "." character is used to distinguish between screen and screen object names.

The ":" character is used for the hierarchy structuring. Therefore, use only the "-" or "_" as a
delimiter in the name designations.
Note
Return value
Name of the parent screen window.
Principle

Example
The following program code saves the return value of the function GetParentScreenWindow
to the pszScrName tag. If the return value is valid (not NULL), it is saved with
maximum_MAX_PATH characters to the szScrName tag.
{
//Get the Parent Screen Window

pszScrName = GetParentScreenWindow(lpszScreenName);
//Copy the string

{
// print name of the parent screen window
printf ("Parent screen window: %s\r\n", szScrName);
}
...
}
2.1.14 GetProp (RT Professional)
2.1.14.1 GetPropBOOL (RT Professional)
Description
Returns the current status of a property of data type "BOOL".
Syntax
BOOL GetPropBOOL(ScreenName, Object, NameOfTheProperty)
Parameters
ScreenName
Screen name
Object
Object name You must set the parameter Object = NULL if the function call relates to a screen
object property.

NameOfTheProperty
Name of the object property
Return value
TRUE
FALSE
Example
The following program code reads out whether the object is visible or not. The value is saved
to the b_error tag.
{
BOOL b_error;
//Get the property Visible

b_error = GetPropBOOL("gs_graph_iofield","IOField1","Visible");
if(b_error)
{
// User defined code if the
// object is visible
...
}
else
{
// object is not visible
...
}
}
A specific code is processed, depending on the return value.
2.1.14.2 GetPropChar (RT Professional)
Description
Returns the value of a property of data type "Char".
Syntax
Char* GetPropChar(ScreenName, Object, NameOfTheProperty)

Parameters
ScreenName
Screen name
Object
object property.
NameOfTheProperty
Return value
Value of the property in data type "Char".
Example
The following program code reads the tooltip text from the object using the GetPropChar
function and processes it as follows:
1. Saves the return value in the pszProp tag
2. Validation of the return value: Step 3 follows if the value is valid (not NULL).
3. The first 13 characters of the character sequence are saved in the szProp tag.
{
char* pszProp = NULL;
char szProp[14];
//Get the property Tooltiptext

pszProp = GetPropChar("lpszScreenName","IOField1","Tooltiptext");
if(pszProp != NULL)
{
//Copy the string and trim
strncpy(szProp,pszProp,13);
// print trimmed string
printf ("Short description of tooltip: %s\r\n", szProp);
}
...
}

2.1.14.3 GetPropDouble (RT Professional)
Description
Returns the value of a property of data type "Double".
Syntax
double GetPropDouble(ScreenName, Object, NameOfTheProperty)
Parameters
ScreenName
Screen name
Object
object property.
NameOfTheProperty
Return value
Value of the property in data type "Double".
Example
The following program code reads the "BackColor" property (background color of the
"Button_1" object) by means of GetPropDouble function and processes the return value as
follows:
1. Saving the return value to the szprop tag
3. Output of the background color

{
double szProp = NULL;
//Get the property of the IO Field 1

szprop = GetPropDouble("Screen_1","Button_1","BackColor");
if(szProp != NULL)
{
// print output value
printf ("Background color: %s\r\n", szProp);}
}
...
}
2.1.14.4 GetPropLong (RT Professional)
Description
Returns the status of a property of data type "long".
Syntax
long GetPropLong(ScreenName, Object, NameOfTheProperty)
Parameters
ScreenName
Screen name
Object
object property.
NameOfTheProperty
Return value
Value of the property in data type "long".

Example
The following program code reads the CaptionBackColor property (background color of the
TemperatureField object) by means of GetPropLong function and processes the return value
as follows:
1. Saving the return value to the szProp tag
3. Output
{
long szProp = NULL;
//Get the property Tooltiptext

szProp = GetPropLong("Screen_1","TemperatureField","CaptionBackColor");
if(szProp != NULL)
{
// print caption
printf ("Caption of window: %d\r\n", szProp);
}
...
}
2.1.15 GetServerTagPrefix (RT Professional)
Description
In order for a WinCC client in a distributed system to access tags of the associated server, the
tag names must be expanded to include the server prefix.
Note
This system function is not supported at present.
A pointer of type "char" to server prefix, tag prefix, and window prefix is returned in each case.
The user is not permitted to change the memory (including no strcat) or release it.
Syntax
void GetServerTagPrefix(ppszServerPrefix, ppszTagPrefix, ppszWindowPrefix);

Return value
ppszServerPrefix
Pointer to a pointer that references the server prefix
ppszTagPrefix
Pointer to a pointer that references the tag prefix
ppszWindowPrefix
Pointer to a pointer that references the window prefix
Example
The following program code retrieves the server prefix, tag prefix and window prefix checks
their validity. If an error occurs, a text is output and the function is exited. If the check is
successful a tag name is created and returned. Processing is executed as follows:
1. Declaration of pointer pszServerPrefix, pszTagPrefix and pszWindowPrefix for the three
prefixes
2. Initialization of the nServerPrefixLen, nTagPrefixLen and nTagLen tags
They serve as a buffer for the string length of the prefixes to be read out.
3. Initialization of the myTagName tag
4. Reading out of server prefix, tag prefix and window prefix
5. Case distinction: Server prefix
– No server prefix returned: a text is output and the function is exited.
– Server prefix returned: Its length is determined and saved in the nServerPrefixLen tag.
6. If a tag prefix is returned, its length is determined and saved in the nTagPrefixLen tag.
7. Determines the length of the tag name and saves it in the nTagLen tag.
8. Case distinction: Permissible length for tag name
– Permissible length exceeded: a text is output and the function is exited.
– Permissible length not exceeded: The tag name required for a client environment is
compiled.

{
char* pszServerPrefix;
char* pszTagPrefix;
char* pszWindowPrefix;
int nServerPrefixLen = 0;
int nTagPrefixLen = 0;
int nTagLen = 0;
char myTagName[MAX_DM_VAR_NAME+1];
//Initialize the return value

memset(myTagName,0,MAX_DM_VAR_NAME + 1);
//Get the serverprefix the tagprefix and the windowprefix

GetServerTagPrefix(&pszServerPrefix, &pszTagPrefix, &pszWindowPrefix);
//If a serverprefix exists

if (pszServerPrefix)
{
//Get the length of the string
nServerPrefixLen = strlen(pszServerPrefix);
}
Else
{
printf("No server prefix was returned.");
return;
}
//If a tagprefix exists

if (pszTagPrefix)
{
//Get the length of the string
nTagPrefixLen = strlen(pszTagPrefix);
}
//Get the length of the tag

nTagLen = strlen("TagName");
//Check if the lenght of the

//ServerPrefix+TagPrefix+VarName + the double points < MAX_DM_VAR_NAME)
if (nServerPrefixLen + nTagPrefixLen + nTagLen+2 < MAX_DM_VAR_NAME)
{
sprintf(myTagName,"%s::%s%s",pszServerPrefix,pszTagPrefix,"TagName");
...
}
Else
{
printf("The resulting string is too long.");
return;
}
}

2.1.16 GetTag (RT Professional)
2.1.16.1 GetTag functions (RT Professional)
Description
The GetTagXXX function calculates the value of a tag of the specified data type.
Can only be used in C scripting:
The following table shows the different GetTag functions for reading the tag value:
Type Function name Parameter PLC data type HMI data

type
BOOL GetTagBit Tag Tag_Name Binary tag Bool
BYTE GetTagByte Tag Tag_Name Unsigned 8-bit USInt
char* GetTagChar Tag Tag_Name Text tag 8-bit or String or
text tag 16-bit WString
SYSTEM‐ GetTagDateTime Tag Tag_Name DTL DateTime

TIME
double GetTagDouble Tag Tag_Name Floating point 64-bit LReal
DWORD GetTagDWord Tag Tag_Name Unsigned 32-bit UDInt
float GetTagFloat Tag Tag_Name Floating point 32-bit Real
BOOL GetTagRaw Tag Tag_Name, Raw data type Raw
BYTE* pValue,
DWORD size
signed char GetTagSByte Tag Tag_Name Signed 8-bit SInt
long int GetTagSDWord Tag Tag_Name Signed 32-bit DInt
short int GetTagSWord Tag Tag_Name Signed 16-bit Int
WORD GetTagWord Tag Tag_Name Unsigned 16-bit UInt
Syntax
<Type><FunctionName><(Parameter)>;
Example: BYTE GetTagByte(Tag_Name);
Parameter
Tag_Name
Tag name
pValue
Pointer to a byte field containing the value of the raw data tags.

size
Length of the byte field in bytes
Return value
Value of the tags in the specified type.
System function "GetTagChar" returns a pointer to a string that contains the tag value.
System function "GetTagRaw" returns TRUE or FALSE:
TRUE: System function completed without errors.
FALSE: An error has occurred.
Example
The following program code uses the GetTagByte function to read out the value of the
gs_tag_byte tag and saves it to the bvalue tag.
{
BYTE bvalue;
//Get the current value of the tag

bvalue = GetTagByte("gs_tag_byte");
// print value
printf ("Value of gs_tag_byte: %d\r\n", bvalue);
...
}
2.1.16.2 GetTagDateTime function (RT Professional)
Function
Determines the value of a tag of data type "Date/Time".
Syntax
SYSTEMTIME GetTagDateTime(Tag_Name);
Parameter
Tag_Name
Name of the tag

Return value
Value of the tag in the data type "Date/Time".
2.1.16.3 GetTagMultiStateQCWait functions (RT Professional)
Description
The values, status, and quality code of several tags are established and saved in the repsective
addresses in the specified format . The values are read explicitly from the AS.
Two DWORD arrays are transferred, in the member of which the status and quality codes of
the individual tags will be located after the system function has been called. The size of the
arrays must be large enough to provide sufficient storage space for the status and quality
codes.
Syntax
BOOL GetTagMultiStateQCWait(pdwState, pdwQualityCode, pFormat);
Parameters
pdwState
Field in which the status of the individual tags is created after the system function cycle.
pdwQualityCode
Field in which the quality code of the individual tag is created after the system function cycle.
pFormat
Format description (type) for all requested tags, followed by the name and address of the value
for each tag.
Return value
TRUE
FALSE

Example
The following program code uses the GetTagMultiStateQCWait function to read the value from
the "gs_tag_XXX" tag and saves these values to the Ivalue1, Ivalue2 tags, etc.
1. Preprocessor definition for "DATA_SIZE" (in this case for 5 tags)
2. Creating the DWord fields
– dwState Tag status field
– dwQc Field for quality codes
3. Tag definition for buffering
4. Execution of the function GetTagMultiStateQCWait
The value read is written to the addresses of the tags.
{
#define DATA_SIZE 5
DWORD dwState[DATA_SIZE];
DWORD dwQC[DATA_SIZE];
//define all Datas

BOOL lValue1;
long lValue2 ;
char* szValue3;
double dblValue4 ;
WORD lValue5 ;
//Set the tags

GetTagMultiStateQCWait(dwState,dwQC,"%d%d%s%f%d",
"gs_tag_bit",&lValue1,
"gs_tag_SByte",&lValue2,
"gs_tag_char",&szValue3,
"gs_tag_float",&dblValue4,
"gs_tag_word",&lValue5);

...
}
See also
Quality codes of HMI tags (Page 1550)
Constants (Page 1555)

2.1.16.4 GetTagMultiStateWait functions (RT Professional)
Description
The values and status of several tags are determined and saved in the respective addresses
in the specified format. The values are read explicitly from the AS.
The system function must be given a DWORD array, in the member of which the status of the
individual tags will be located after the system function has been called. The size of the array
must be large enough to provide sufficient storage space for the status.
Syntax
BOOL GetTagMultiStateWait(pdwState, pFormat);
Parameters
pdwState
Field in which the tag status is saved.
pFormat
Format description (type) for all requested tags, followed by the name and address of the value
for each tag.
Return value
TRUE
FALSE
Example
The following program code uses the GetTagMultiStateWait function to read the value from
the "gs_tag_XXX" tag and saves these values to the Ivalue1, Ivalue2 tags, etc.
1. Preprocessor definition for "DATA_SIZE" (in this case for 5 tags)
2. Creating DWord field dwState for the tag status
3. Tag definition for buffering
4. Execution of the function GetTagMultiStateWait
The value read is written to the addresses of the tags.

{
#define DATA_SIZE 5
DWORD dwState[DATA_SIZE];
//define all Datas

BOOL lValue1;
long lValue2 ;
char* szValue3;
double dblValue4 ;
WORD lValue5 ;
//Set the tags

GetTagMultiStateWait(dwState,"%d%d%s%f%d",
"gs_tag_bit",&lValue1,
"gs_tag_SByte",&lValue2,
"gs_tag_char",&szValue3,
"gs_tag_float",&dblValue4,
"gs_tag_word",&lValue5);

...
}
See also
2.1.16.5 GetTagMultiWait functions (RT Professional)
Description
The values of several tags are determined and saved in the respective addresses in the
specified format. The value is read explicitly from the AS. The system function uses SysMalloc
to allocate memory to the tag value.
Syntax
BOOL GetTagMultiWait(pFormat,...);

Parameters
pFormat
Format description for all requested tags along with name and address of the value for each
tag.
Return value
TRUE
FALSE
Example
The GetTagMultiWait function is used in the following program code to read several tags of
different types:
1. Declaration of three tags as memory for three different tag types
2. Declaration of the boolean tag ok for buffering the return value (TRUE/FALSE)
3. Reading the three tags and saving the values to the corresponding addresses.
The return value of the function is saved to the ok tag.
4. Output of the three tags with tag type prefix
DWORD dwVar1Value;
char* szVar2Value;
//memory for values allocated via SysMalloc
double dbVar3Value;
BOOL ok;
ok=GetTagMultiWait("%d%s%f", "Ernie_word", &dwVar1Value,

"Ernie_char", &szVar2Value,
"Ernie_double", &dbVar3Value);
printf("Word %d, String %s, Double %f\r\n",

dwVar1Value, szVar2Value, dbVar3Value);
2.1.16.6 GetTagState functions (RT Professional)
Description
The GetTagStateXXX function calculates the value of a tag of the specified data type. It also
returns the status of the tags.


The following table lists the different GetTagStateXXX functions for reading the tag value:
Type Function name Parameters PLC data type HMI data

type
BOOL GetTagBitState Tag Tag_Name, Binary tag Bool
PDWORD lp_dwstate
BYTE GetTagByteState Tag Tag_Name, Unsigned 8-bit Byte
PDWORD lp_dwstate
char* GetTagCharState Tag Tag_Name, Text tag 8-bit or text tag 16- String
PDWORD lp_dwstate bit
double GetTagDoubleS‐ Tag Tag_Name, Floating point 64-bit Double
tate PDWORD lp_dwstate
DWORD GetTagDWord‐ Tag Tag_Name, Unsigned 32-bit UInteger
State PDWORD lp_dwstate
float GetTagFloatState Tag Tag_Name, Floating point 32-bit Float
PDWORD lp_dwstate
BOOL GetTagRawState Tag Tag_Name, BYTE* Raw data type Raw
pValue, DWORD size,
PDWORD lp_dwstate
signed GetTagSByteState Tag Tag_Name, Signed 8-bit Byte
char PDWORD lp_dwstate
long int GetTagSDWord‐ Tag Tag_Name, Signed 32-bit Integer
short int GetTagSWord‐ Tag Tag_Name, Signed 16-bit Short
WORD GetTagWordState Tag Tag_Name, Unsigned 16-bit UShort
PDWORD lp_dwstate
Syntax
Example: BOOL GetTagBitState(Tag_Name, lp_dwstate);
Parameters
Tag_Name
Tag name
lp_dwstate
Pointer to a DWORD to which the tag status is saved on completion of the system function
cycle.
pValue

size
Return value
The system function "GetTagCharState" returns a pointer to a value of the tag of data type
"char".
System function "GetTagRawState" returns TRUE or FALSE:
Example
The following program code uses the GetTagBitState function to read out the value of the
gs_tag_bit tag and saves it to the bValue tag.
The status is stored in the address of the dwState tag.
A specific code will be executed, depending on the return value in bValue (TRUE/FALSE).
{
DWORD dwState;
BOOL bValue;
dwState = 0xFFFFFFFF;
//Get the tag value

//dwstate is the tag state
bValue = GetTagBitState("gs_tag_bit",&dwState);
//Create a string which includes the tag value

if (bValue)
{
// value of the tag is true
...
}
else
{
// value of the tag is false
...
}
}
See also

2.1.16.7 GetTagStateQC functions (RT Professional)
Description
The GetTagStateQC function calculates the value of a tag of the specified data type. It also
returns the status and quality code of the tags.
The following table shows the different GetTagStateQC functions for reading the tag value:
Type Function name Parameters PLC data type HMI data type
BOOL GetTagBitStateQC Tag Tag_Name, Binary tag Bool
PDWORD lp_dwstate,
PDWORD pdwQuality‐
Code
BYTE GetTagByteStateQC Tag Tag_Name, Unsigned 8-bit UByte
PDWORD lp_dwstate,
Code
char* GetTagCharSta‐ Tag Tag_Name, Text tag 8-bit or text tag 16- String
teQC PDWORD lp_dwstate, bit
Code
double GetTagDoubleSta‐ Tag Tag_Name, Floating point 64-bit Double
teQC PDWORD lp_dwstate,
Code
DWOR GetTagDWordSta‐ Tag Tag_Name, Unsigned 32-bit UInteger
D teQC PDWORD lp_dwstate,
Code
float GetTagFloatSta‐ Tag Tag_Name, Floating point 32-bit Float
Code
BOOL GetTagRawStateQC Tag Tag_Name, BYTE Raw data type Raw
pValue[], DWORD size,
PDWORD lp_dwstate,
Code
signed GetTagSByteSta‐ Tag Tag_Name, Signed 8-bit Byte
char teQC PDWORD lp_dwstate,
Code
long int GetTagSDWordSta‐ Tag Tag_Name, Signed 32-bit Integer
Code

short GetTagSWordSta‐ Tag Tag_Name, Signed 16-bit Short
int teQC PDWORD lp_dwstate,
Code
WORD GetTagWordSta‐ Tag Tag_Name, Unsigned 16-bit UShort
Code
Syntax
Example: BOOL GetTagBitStateQC(Tag_Name, lp_dwstate, pdwQualityCode);
Parameters
Tag_Name
Tag name
lp_dwstate
cycle.
pdwQualityCode
Pointer on a DWORD in which the quality code of the tag is created after the system function
cycle.
pValue
size
Return value
The system function "GetTagCharStateQC" returns a pointer to a value of the tag of data type
"char".
The system function "GetTagRawStateQC" returns TRUE or FALSE:

Example
The following program code uses the GetTagBitStateQC function to read the value from the
gs_tag_bit tag and saves it to the ok tag.
The status and quality code is saved to the dwState and dwQC addresses of the tag.
A specific code will be executed, depending on the return value in the tag (TRUE/FALSE).
{
DWORD dwState;
DWORD dwQC;
BOOL ok;
//Get the tag value

ok = GetTagBitStateQC("gs_tag_bit",&dwState,&dwQC);

if (ok)
{
// succeeded, print tag value
printf ("Value at dwState: %x\r\n", dwState);
printf ("Value at dwQC: %x\r\n", dwQC);
...
}
else
{
// failed
}
}
See also
2.1.16.8 GetTagStateQCWait functions (RT Professional)
Description
The GetTagStateQCWait function calculates the value of a tag of the specified data type. The
value is read explicitly from the AS. It also returns the status and quality code of the tags.

The following table lists the different GetTagStateQCWait functions for reading the tag value:

type
BOOL GetTagBitStateQCWait Tag Tag_Name, Binary tag Bool
PDWORD lp_dwstate,
Code
BYTE GetTagByteStateQC‐ Tag Tag_Name, Unsigned 8-bit UByte
Wait PDWORD lp_dwstate,
Code
char* GetTagCharStateQC‐ Tag Tag_Name, Text tag 8-bit or text tag 16- String
Wait PDWORD lp_dwstate, bit
Code
double GetTagDoubleStateQC‐ Tag Tag_Name, Floating point 64-bit Double
Code
DWOR GetTagDWordStateQC‐ Tag Tag_Name, Unsigned 32-bit UInteger
D Wait PDWORD lp_dwstate,
Code
float GetTagFloatStateQC‐ Tag Tag_Name, Floating point 32-bit Float
Code
BOOL GetTagRawStateQC‐ Tag Tag_Name, BYTE Raw data type Raw
Wait pValue[], DWORD size,
PDWORD lp_dwstate,
Code
signed GetTagSByteStateQC‐ Tag Tag_Name, Signed 8-bit Byte
char Wait PDWORD lp_dwstate,
Code
long int GetTagSDWordSta‐ Tag Tag_Name, Signed 32-bit Integer
teQCWait PDWORD lp_dwstate,
Code
short GetTagSWordStateQC‐ Tag Tag_Name, Signed 16-bit Short
int Wait PDWORD lp_dwstate,
Code
WORD GetTagWordStateQC‐ Tag Tag_Name, Unsigned 16-bit UShort
Code

Syntax
Example: BOOL GetTagBitStateQC(Tag_Name, lp_dwstate, pdwQualityCode);
Parameters
Tag_Name
Tag name
lp_dwstate
cycle.
pdwQualityCode
Pointer on a DWORD in which the quality code of the tag is created after the system function
cycle.
pValue
size
Return value
The system function "GetTagCharStateQCWait" returns a pointer to a value of the tag of data
type "char".
The system function "GetTagRawStateQCWait" returns TRUE or FALSE:
Example
The following program code uses the GetTagBitStateQCWait function to read the value from
the gs_tag_bit tag and saves it to the bValue tag.

{
DWORD dwState;
DWORD dwQC;
BOOL bValue;
//Get the tag value

bValue = GetTagBitStateQCWait("gs_tag_bit",&dwState,&dwQC);

if (bValue)
{
...
}
else
{
...
}
}
See also
2.1.16.9 GetTagStateWait functions (RT Professional)
Description
The GetTagStateWait function calculates the value of a tag of the specified data type. The
value is read explicitly from the AS. It also returns the status of the tags.
The following table lists the different GetTagStateWait functions for reading the tag value:

type
BOOL GetTagBitStateWait Tag Tag_Name, PDWORD Binary tag Bool
lp_dwstate
BYTE GetTagByteState‐ Tag Tag_Name, PDWORD Unsigned 8-bit UByte
Wait lp_dwstate


type
char* GetTagCharState‐ Tag Tag_Name, PDWORD Text tag 8-bit or String
Wait lp_dwstate text tag 16-bit
double GetTagDoubleState‐ Tag Tag_Name, PDWORD Floating point 64- Double
Wait lp_dwstate bit
DWORD GetTagDWordState‐ Tag Tag_Name, PDWORD Unsigned 32-bit UInteger
Wait lp_dwstate
float GetTagFloatState‐ Tag Tag_Name, PDWORD Floating point 32- Float
Wait lp_dwstate bit
BOOL GetTagRawState‐ Tag Tag_Name, BYTE* Raw data type Raw
Wait pValue, DWORD size,
PDWORD lp_dwstate
signed char GetTagSByteState‐ Tag Tag_Name, PDWORD Signed 8-bit Byte
Wait lp_dwstate
long int GetTagSDWordState‐ Tag Tag_Name, PDWORD Signed 32-bit Integer
Wait lp_dwstate
short int GetTagSWordState‐ Tag Tag_Name, PDWORD Signed 16-bit Short
Wait lp_dwstate
WORD GetTagWordState‐ Tag Tag_Name, PDWORD Unsigned 16-bit UShort
Wait lp_dwstate
Syntax
<Type><FunctionName><(Parameter)>
Example: BOOL GetTagBitStateWait(Tag_Name, lp_dwstate)
Parameters
Tag_Name
Tag name
lp_dwstate
cycle.
pValue
size
Return value
The system function "GetTagCharStateWait" returns a pointer to a value of the tag of data type
"char".

The system function "GetTagRawState" returns TRUE or FALSE:

Example
The following program code uses the GetTagBitStateWait function to read the value from the
gs_tag_bit tag and saves it to the bValue tag.
The status is stored in the address of the dwState tag.
{
DWORD dwState;
BOOL bValue;
//Get the tag value

bValue = GetTagBitStateWait("gs_tag_bit",&dwState);

if (bValue)
{
...
}
else
{
...
}
}
See also
2.1.16.10 GetTagValue functions (RT Professional)
Description
Enables the transfer of a value in the form of a variant. Determines the pointer on the results
structure that contains the value.

Syntax
BOOL GetTagValue(lpdmVarKey, lpdmresult, lpdmError);
Parameters
lpdmVarKey
Pointer to a structure of data type "DM_VARKEY"
lpdmresult
Pointer to a structure of data type "DM_VAR_UPDATE_STRUCT"
lpdmError
Pointer on the structure that contains the error description.
Return value
TRUE
FALSE
Example
The GetTagValue function is used in the following program code to calculate the value in
varKey.

A specific code will be executed, depending on the return value in keyFound (TRUE/FALSE).
{
DM_VARKEY varKey;
DM_VAR_UPDATE_STRUCT result;
CMN_ERROR error:
BOOL keyFound;
//Get the tag value

keyFound = GetTagValue(&varKey, &result, &error);
if (keyFound)
{
// print tag value
printf ("Value of varKey: %d\r\n", &varKey);
...
}
else
{
// failed
...
}
}
2.1.16.11 GetTagValueStateQC functions (RT Professional)
Description
structure that contains the value. It also returns the status and quality code of the tags.
Syntax
BOOL GetTagValueStateQC(lpdmVarKey, lpdmresult, lpdmError);
Parameters
lpdmVarKey
lpdmresult
Pointer to a structure of data type "DM_VAR_UPDATE_STRUCTEX"
lpdmError

Return value
TRUE
FALSE
Example
The GetTagValueStateQC function is used in the following program code to calculate the value
in varKey.
{
DM_VARKEY varKey;
DM_VAR_UPDATE_STRUCTEX result;
CMN_ERROR error:
// to clarify (DM_VAR_UPDATE_STRUCTEX already contains QualityCode)
DWORD dwState;
DWORD dwQC;
BOOL keyFound;
//Get the tag value

keyFound = GetTagValueStateQC(&varKey, &result, &error,&dwState,&dwQC);
if (keyFound)
{
...
}
else
{
...
}
}
2.1.16.12 GetTagValueStateQCWait functions (RT Professional)
Description
structure that contains the value. The value is read explicitly from the AS. It also returns the
status and quality code of the tags.

Syntax
BOOL GetTagValueStateQCWait(lpdmVarKey, lpdmresult, lpdmError);
Parameters
lpdmVarKey
lpdmresult
Pointer to a structure of data type "DM_VAR_UPDATE_STRUCTEX"
lpdmError
Return value
TRUE
FALSE
Example
The following program code uses the function GetTagValueStateQCWait for reading

{
DM_VARKEY varKey;
DM_VAR_UPDATE_STRUCTEX result;
CMN_ERROR error:
// to clarify (DM_VAR_UPDATE_STRUCTEX already contains QualityCode)
DWORD dwState;
DWORD dwQC;
BOOL keyFound;
//Get the tag value

keyFound = GetTagValueStateQC(&varKey, &result, &error,&dwState,&dwQC);
if (keyFound)
{
...
}
else
{
...
}
}
2.1.16.13 GetTagValueWait functions (RT Professional)
Description
structure that contains the value. The value is read directly from the AS.
Syntax
BOOL GetTagValueWait(lpdmVarKey, lpdmresult, lpdmError);
Parameters
lpdmVarKey
lpdmresult
Pointer to a structure of data type "DM_VAR_UPDATE_STRUCT"

lpdmError
Pointer on the structure that contains the error description
Return value
TRUE
FALSE
Example
The GetTagValueWait function is used in the following program code to calculate the value in
varKey.
{
DM_VARKEY varKey;
CMN_ERROR error:
BOOL keyFound;
//Get the tag value

keyFound = GetTagValueWait(&varKey, &result, &error);
if (keyFound)
{
// succeeded, key found
// print tag value
...
}
else
{
// failed
}
...
}
2.1.16.14 GetTagWait functions (RT Professional)
Description
The GetTagWaitXXX function calculates the value of a tag of the specified data type. The value
is read explicitly from the AS.


The following table shows the different GetTagWait functions for reading the tag value:
BOOL GetTagBitWait Tag Tag_Name Binary tag Bool
BYTE GetTagByteWait Tag Tag_Name Unsigned 8-bit UByte
char* GetTagCharWait Tag Tag_Name Text tag 8-bit or text tag 16- String
bit
double GetTagDoubleWait Tag Tag_Name Floating point 64-bit Double
DWORD GetTagDWordWait Tag Tag_Name Unsigned 32-bit UInteger
float GetTagFloatWait Tag Tag_Name Floating point 32-bit Float
BOOL GetTagRawWait Tag Tag_Name, Raw data type Raw
BYTE* pValue,
DWORD size
char GetTagSByteWait Tag Tag_Name Signed 8-bit Byte
long int GetTagSDWord‐ Tag Tag_Name Signed 32-bit Integer
Wait
short int GetTagSWordWait Tag Tag_Name Signed 16-bit Short
WORD GetTagWordWait Tag Tag_Name Unsigned 16-bit UShort
Syntax
Example: BYTE GetTagByteWait(Tag_Name);
Parameters
Tag_Name
Tag name
pValue
Return value
System function "GetTagCharWait" returns a pointer to a string that contains the tag value.
System function "GetTagRawWait" returns TRUE or FALSE:

Example
The following program code uses the GetTagByteWait function to read the value from the
gs_tag_byte tag and saves it to the bvalue tag.
{
BYTE bvalue;
//Get the current value of the tag

bvalue = GetTagByteWait("gs_tag_byte");
// print value
printf ("Value of gs_tag_byte: %d\r\n", bvalue);
...
}
2.1.17 IncreaseTag (RT Professional)
Description
X=X+a
Note



Parameters
Tag
Value
Example
The following program code increments the value of the varX tag by the value in the value tag.
The value entered is saved to the old_value tag and output along with the new varX value.
{
BYTE varX;
BYTE value;
//user input
...
//Increase tag
IncreaseTag(varX, value);

printf ("User input: %i\r\n, Result of function IncreaseTag: %i\r\n", old_value, varX);
...
}
2.1.18 InquireLanguage (RT Professional)
Description
Determines all languages configured in the text library for the runtime.
Use Pointer to a counter to specify the storage location for language IDs.
Syntax
DWORD* InquireLanguage(PointerToACounter);
Parameters
PointerToACounter
Pointer to the number of language IDs found

Return value
Pointer to a field containing the established language IDs.
The following assignments apply (hexadecimal language code):

LANG_ARABIC 0x0401
LANG_BASQUE 0x042D
LANG_BYELORUSSIAN 0x0423
LANG_CATALAN 0x0403
LANG_CHINESE 0x0404
LANG_CZECH 0x0405 CSY
LANG_DANISH 0x0406 DAN
LANG_DUTCH 0x0413 NLD
LANG_ENGLISH 0x0409 ENU
LANG_FARSI 0x0429
LANG_FINNISH 0x040B FIN
LANG_FRENCH 0x040C FRA
LANG_GERMAN 0x0407 DEU
LANG_GREEK 0x0408
LANG_HEBREW 0x040D
LANG_HUNGARIAN 0x040E HUN
LANG_ICELANDIC 0x040F ISL
LANG_ITALIAN 0x0410 ITA
LANG_KOREAN 0x0412
LANG_LATVIAN 0x0426
LANG_NORWEGIAN 0x0414 NOR
LANG_POLISH 0x0415 PLK
LANG_PORTUGUESE 0x0416 PTB
LANG_RUSSIAN 0x0419 RUS
LANG_SLOVAK 0x041B SKY
LANG_SORBIAN 0x042E
LANG_SPANISH 0x040A ESP


LANG_SWEDISH 0x041D SVE
LANG_THAI 0x041E
LANG_TURKISH 0x041F TRK
Example
The following program code uses the InquireLanguage function to query the language
configured at runtime and processes these as follows:
1. Saving the queried language ID to the tag language
2. Saving the number of languages to the tag count
3. Formatted output of the ID and number of languages
{
DWORD count;
DWORD* language;
int i;
//Count the installed languages

language = InquireLanguage(&count);
printf("##################### INQUIRE LANGUAGE ####################");

//Print out the count of languages
printf ( "\r\nCount Languages=%d\r\n", count );
//print out which languages are installed

for (i=1;i<=count; i++)
{
printf ("\r\n%d.language=%x", i,*language++);
}
}
2.1.19 InverseLinearScaling (RT Professional)
Description

Note
must be used.
the auxiliary tags.


Parameters
X
Y
b
a

Example
{
BYTE varX;
BYTE Yvalue = 10;
BYTE bvalue = 3;
BYTE avalue = 4;


...
}
2.1.20 InvertBit (RT Professional)
Description

InvertBit (Tag)

InvertBit Tag
Parameters
Tag

Example
Dim myTag
Dim myOutputField

'Get current value

bValue=myTag.Value
'Save current value

bSaved=bValue
'Invert Bit
InvertBit myTag
bValue=myTag.Value

{
BOOL bStatus = 0;
//Invert variable
invertBit(bStatus);

...
}
2.1.21 InvertBitInTag (RT Professional)
Description

Note
function instead.


Parameters
Tag
Bit

Example
Dim myTag
Dim myOutputField

'Get current value

bValue=myTag.Value
'Save current value

bSaved=bValue

bitposition=2
InvertBit myTag, bitposition
bValue=myTag.Value

{
BYTE bStatusWord;

...
}
2.1.22 IsUserAuthorized (RT Professional)
Description
Authentication of users.

Syntax
BOOL IsUserAuthorized(AuthorizationNumber);
Parameters
AuthorizationNumber
Authorization (numerical) to be verified.
Return value
TRUE
The user has the specified authorization.
FALSE
The user does not have the specified authorization.
Example
The following program code authenticates users by means of IsUserAuthorized function and
writes the value to the boolean tag ok.
{
BOOL ok;
DWORD authnumber;
//Check authorization and return value

ok = IsUserAuthorized (authnumber);
//error handling
if(ok)
{
// user authorized
printf ( "User is authorized." );
}
else
{
// user not authorized
printf ( "Authorization failed." );
}
...
}
The return value is output.

2.1.23 LinearScaling (RT Professional)
Description
Note
must be used.
the auxiliary tags.


Parameters
Y
a
X
b

Example
{
BYTE Yvar;
BYTE Xvalue = 10;
BYTE bvalue = 3;
BYTE avalue = 4;
// linear scaling

...
}
2.1.24 ReportJob (RT Professional)
Description
A print job or the preview for a print job is started depending on the value of the NameOfMethod
parameter.
Syntax
void ReportJob(PrintJobName, NameOfMethod)
Parameters
PrintJobName
Pointer to the name of the print job
NameOfMethod
Defines whether to start the print job or a print job preview:
● PRINTJOB: Print job is started.
● PREVIEW: Preview of the print job is started.

Example
The following program code executes a preview or print job for each content of the printmethod
tag. The printmethod tag is read by an I/O field that is connected to the strPrintJobMethod tag.
{
char* pszPrintjobName;
char* printmethod;
//Get the print method

printf("Input PRINTJOB for printing or PREVIEW for a quick view");
printmethod = GetTagChar("strPrintJobMethod")
//Print job or show preview

ReportJob(&PrintjobName, printmethod);
//error handling
if(printmethod=="PRINTJOB")
{
// message for printing completed
printf("printing done");
...
}
else
{
// job is a preview or failed
...
}
}
2.1.25 ResetBit (RT Professional)
Description

ResetBit (Tag)

ResetBit Tag

Parameters
Tag
Example
Dim myTag
Dim myOutputField

'Set value
bValue=1
myTag.Value=bValue
'Save current value

bSaved=bValue
'Reset Bit
ResetBit myTag
bValue=myTag.Value

{
BOOL bStatus = 1;
//Reset bit
ResetBit (bStatus);

...
}

2.1.26 ResetBitInTag (RT Professional)
Description
Note
function instead.


Parameters
Tag
Bit

Example
Dim myTag
Dim myOutputField

'Save current value

bValue=myTag.Value
bSaved=bValue
'Reset Bit
bitposition=2
ResetBitInTag myTag, bitposition
bValue=myTag.Value

{
BYTE bSaved;

ResetBitInTag ("bStatusWord", bitposition);

...
}
2.1.27 Set_Focus (RT Professional)
Function
Sets the focus on the specified object.

Syntax
BOOL Set_Focus(lpszPictureName, lpszObjectName)
Parameters
lpszPictureName
Screen name
lpszObjectName
Object name
Return value
TRUE
The function has been completed without any errors.
FALSE
2.1.28 SetBit (RT Professional)
Description

SetBit (Tag)

SetBit Tag
Parameters
Tag

Example
Dim myTag
Dim myOutputField

'Set value
bValue=0
myTag.Value=bValue
'Save current value

bSaved=bValue
'Set Bit
SetBit myTag
bValue=myTag.Value

{
BOOL bStatus = 0;
//Set bit
SetBit (bStatus);

...
}
2.1.29 SetBitInTag (RT Professional)
Description

Note
function instead.


Parameters
Tag
Bit
Note

Example
Dim myTag
Dim myOutputField

'Save current value

bValue=myTag.Value
bSaved=bValue
'Set Bit in tag

bitposition=1
SetBitInTag "bStatusWord", bitposition
bValue=myTag.Value

strResult="Old Value: "& bSaved & "New Value: " & bValue
{
BYTE bSaved;

SetBitInTag ("bStatusWord", bitposition);

2.1.30 SetLanguageByLocaleID (RT Professional)
Description
Changes the language setting in Runtime.

Syntax
BOOL SetLanguageByLocaleID(dwLocaleID);
Parameters
dwLocaleID
Language ID of the language to be set
Return value
TRUE
FALSE

Example
The following program code uses the SetLanguage function to set the current runtime language
to German and saves the return value to the ok tag.
{
BOOL ok;
DWORD old_language;
DWORD new_language;
//Get the current language and save it

old_language = GetLanguageByLocaleID ();
//Set the current language to German

ok = SetLanguageByLocaleID (0x0407);
//Get the current language and save it

new_language = GetLanguageByLocaleID ();
//error handling
if(ok)
{
// succeeded
printf ( "RT language is now German." );
}
else
{
// failed
printf ( "RT language was not updated." );
}
//print language code
printf ("Former language code: %d\r\n", old_language);
printf ("Current language code: %d\r\n", new_language);
}
See also
GetLanguageByLocaleID (Page 1385)
2.1.31 SetLanguageByName (RT Professional)
Description
Changes the language setting in Runtime by the country name of the language to be set.


SetLanguageByName (Language))
Syntax
Bool SetLanguageByName(lpszLanguage);
Parameters
lpszLanguage
Pointer to the language abbreviation according to "RFC 1766" format.
Return value
TRUE
FALSE
2.1.32 SetProp (RT Professional)
2.1.32.1 SetPropBOOL (RT Professional)
Description
Sets an object property of data type "BOOL".
Syntax
BOOL SetPropBOOL(ScreenName, Object, NameOfTheProperty, Value)
Parameters
ScreenName
Screen name
Object
object property.

NameOfTheProperty
Value
Value assigned to the object property of data type "BOOL".
Return value
TRUE
FALSE
Example
The following program code uses the SetPropBool function to set the property of the
gs_graph_iofield object to "Visible". The return value is saved to the ok tag.
{
BOOL ok;
//Set the visibility TRUE

ok = SetPropBOOL("gs_graph_iofield","IOField1","Visible",TRUE);
//error handling
if(ok)
{
// succeeded
printf ( "IO field is visible." );
}
else
{
// failed
printf ( "Error - visibility not set" );
}
...
}
2.1.32.2 SetPropChar (RT Professional)
Description
Sets an object property of data type "char".

Syntax
BOOL SetPropChar(ScreenName, Object, NameOfTheProperty, Value)
Parameters
ScreenName
Screen name
Object
object property.
NameOfTheProperty
Value
Value assigned to the object property of data type "char".
Return value
TRUE
FALSE

Example
The following program code uses the SetPropChar function to set the Tooltiptext property of
the gs_graph_iofield object to the "Tooltiptext 1" value. The return value is saved to the ok tag.
{
BOOL ok;
//Set the property Tooltiptext

ok = SetPropChar("Screen_1","gs_graph_iofield","ToolTipText","Tooltiptext 1");
//error handling
if(ok)
{
// succeeded
printf ( "Property of Tooltiptext is now Tooltiptext 1." );
}
else
{
// failed
printf ( "Error - property not set" );
}
...
}
2.1.32.3 SetPropDouble (RT Professional)
Description
Sets an object property of data type "Double".
Syntax
BOOL SetPropDouble(ScreenName, Object, NameOfTheProperty, Value)
Parameters
ScreenName
Screen name
Object
object property.
NameOfTheProperty

Value
Value assigned to the object property of data type "double".
Return value
TRUE
FALSE
Example
The following program code accesses an object property in the screenName screen. In this
example, the SetPropDouble function sets the property (radius) of "Circle_1" to the value 10.
The return value is saved to the ok tag.
{
BOOL ok;
//Set the property of circle

ok = SetPropDouble(screenName,"Circle_1","Radius",10);
//error handling
if(ok)
{
// succeeded
printf ( "Radius was set." );
}
else
{
// failed
printf ( "Error - radius not set" );
}
...
}
2.1.32.4 SetPropLong (RT Professional)
Description
Sets an object property of data type "long".

Syntax
BOOL SetPropLong(ScreenName, Object, NameOfTheProperty, Value)
Parameters
ScreenName
Screen name
Object
object property.
NameOfTheProperty
Value
Value assigned to the object property of data type "long".
Return value
TRUE
FALSE

Example
The following program code uses the SetPropLong function to change the foreground color of
an object: In "Screen_1", the "ForeColor property of the "Button1" object is set to the value
65333 (red). The return value is saved to the ok tag.
{
BOOL ok;
//Set the property Tooltiptext

ok = SetPropLong("Screen_1","Button1","ForeColor",65333);
//error handling
if(ok)
{
// succeeded
printf ( "Color was set." );
}
else
{
// failed
printf ( "Error - color not set" );
}
...
}
2.1.33 SetPropertyByConstant (RT Professional)
Description
Specifies the value of an object property as a string.

SetPropertyByConstant (Screen name, screen object, name of the property, value)

SetPropertyByConstant Screen_name, Screen_object, Property_name, Value
If you want to change the property of a screen, the parameter "Object" must be empty. For this
purpose, use the following syntax, for example:
SetPropertyByConstant Screen_name, Property_name, Value

Parameters
Screen name
Screen object
Name of the object whose property is changed.

Value
The value assigned to the property.
Example
The SetPropertyByConstant function is used in the following program code to change an object

'User defined code

...
{

...
}

Example: Changing a screen property

The SetPropertyByConstant function is used in the following program code to change a screen
property: In the "Trends" screen, the "Backcolor" property is set to the value 255.

SetPropertyByConstant "Trends", "Trends", "Backcolor", "255"
'User defined code

...
{
SetPropertyByConstant ("Trends", "Trends", "Backcolor", "255");

...
}
Alternatively, use the password ZERO or a space-string instead of the second parameter
(object).
2.1.34 SetPropertyByProperty (RT Professional)
Description
Specifies the value of an object property with another object property.

SetPropertyByProperty (screen name, object, property name, target screen name, target
screen object, target property name)

SetPropertyByProperty Screen_name, Screen_object, Property_name,
Source_screen_name, Source_screen_object, Source_property_name
If you want to specify the property of a screen with another screen property, the parameters
"Object" and "Destination object" must be empty. For this purpose, use the following syntax,
for example:

SetPropertyByProperty Screen_name, Property_name, Source_screen_name,

Source_property_name
Parameters
Screen name
Object
Name of the object whose property value is transferred to the target object.
Property name
Name of the property whose value is transferred to the target object.
Target screen name

Name of the screen that contains the target object.
Target screen object

Name of the target object for which a property is changed.
Target property name

Example
The following program code uses the SetPropertyByProperty function to set the property
"ToolbarButtonClick" of the object "Control_1" in the original screen Trend_1": on the
corresponding property in the destination screen "Trend_2".

'Name of source picture: Trend_1
'Name of target picture: Trend_2
SetPropertyByProperty "Trend_1", "Control_1", "ToolbarButtonClick", "Trend_2",

"Control_2", "ToolbarButtonClick"
'User defined code

...

{
//Name of source picture: Trend_1
//Name of target picture: Trend_2
SetPropertyByProperty ("Trend_1", "Control_1", "ToolbarButtonClick", "Trend_2",

"Control_2", "ToolbarButtonClick");

...
}
2.1.35 SetPropertyByTag (RT Professional)
Description
Specifies the value of an object property with a tag value.

SetPropertyByTag (Screen name, screen object, name of the property, tag name)

SetPropertyByTag Screen_name, Screen_object, Property_name, Tag_name
If you want to specify the property of a screen by means of a tag value, the "Object" parameter
must be empty. For this purpose, use the following syntax, for example:
SetPropertyByTag Screen_name, Property_name, Tag_name
Parameters
Screen name
Screen object
Name of the object containing the property to be set with the tag value.

Name of the property that is set with the tag value.

Tag name
Name of the tag that contains the value of the property.
Example
property: When you click on the object, the object name and the screen in which the object is
located are transferred. The CaptionText in the screen window contains the value of the
HMI_value_1 tag.

SetPropertyByTag screenName, objectName, "CaptionText", "HMI_value_1"
'User defined code

...
{
SetPropertyByTag (screenName, objectName, "CaptionText", "HMI_value_1");

...
}
Example

'User defined code

...

{

...
}
2.1.36 SetPropertyByTagIndirect (RT Professional)
Description
Writes the value of an indirect addressed tag to an object property. The tag transferred as
parameter contains the name of a second tag the value of which is read.

SetPropertyByTagIndirect (Screen name, screen object, name of the property, , tag name)

SetPropertyByTagIndirect Screen_name, Screen_object, Property_name, Tag_name
If you want to specify the property of a screen by means of a tag, the "Object" parameter must
be empty. For this purpose, use the following syntax, for example:
SetPropertyByTagIndirect Screen_name, Property_name, Tag_name
Parameters
Screen name
Screen object
Name of the object whose property you want to change.

Name of the property to be changed.

Tag name
Name of the tag which, in turn, contains the name of the tag whose value is read.
Example
The SetPropertyByTagIndirect function is used in the following program code to change an
object property: .

SetPropertyByTagIndirect GetParentScreen(screenName), GetParentScreenWindow(screenName),
"ScreenName", "HMI_value_1"
'User defined code

...
{
SetPropertyByTagIndirect (GetParentScreen(screenName), GetParentScreenWindow(screenName),
"ScreenName", "HMI_value_1");

...
}
2.1.37 SetTag (RT Professional)
2.1.37.1 SetTag functions (RT Professional)
Description
The SetTagXXX function calculates the value of a tag of the specified data type.
The following table shows the different SetTag functions for setting the tag value:
Function name Parameter PLC data type HMI data type

SetTagBit Tag Tag_Name, Binary tag Bool
short int value
SetTagByte Tag Tag_Name, Unsigned 8-bit USInt
BYTE value
SetTagDateTime Tag Tag_Name, DTL DateTime
SYSTEMTIME val‐
ue

Function name Parameter PLC data type HMI data type

SetTagChar Tag Tag_Name, Text tag 8-bit or text tag 16-bit String or WString
LPSTR value
SetTagDouble Tag Tag_Name, Floating point 64-bit LReal
double value
SetTagDWord Tag Tag_Name, Unsigned 32-bit UDInt
DWORD value
SetTagFloat Tag Tag_Name, Floating point 32-bit Real
float value
SetTagRaw Tag Tag_Name, Raw data type Raw
BYTE* pValue,
DWORD size
SetTagSByte Tag Tag_Name, Signed 8-bit SInt
char value
SetTagSDWord Tag Tag_Name, Signed 32-bit DInt
long int value
SetTagSWord Tag Tag_Name, Signed 16-bit Int
short int value
SetTagWord Tag Tag_Name, Unsigned 16-bit UInt
WORD value
Note
Error message when using a tag of WString type
If you use a WString type tag in a SetTag system function that was converted into a C script,
an error message is generated in the Global Script diagnostics window when the function is
executed. The function is correctly executed despite the error message.
The following SetTag functions are affected:
● SetTagWithOperatorEvent
● SetTagIndirect
● SetTagByTagIndirect
● SetTagIndirectByTagIndirect
● SetTagByProperty
● SetTagIndirectByProperty
Syntax
BOOL<FunctionName><(Parameter)>;
Example: BOOL SetTagBit(Tag_Name, value);
Parameter
Tag_Name
Tag name

value
Value of the tags in the specified data type.
pValue
size
Return value
TRUE
However, no check is made to verify that the tag was written without any errors.
FALSE
Example
The following program code uses the SetTagBit function to set the value of the gs_tag_bit tag
to TRUE and saves the return value to the ok tag.
{
BOOL ok;
BOOL bvalue;

ok = SetTagBit("gs_tag_bit", TRUE);
//error handling
if(ok)
{
// succeeded
}
else
{
// failed
}
...
}

See also
VariableStateType property (Page 1554)
2.1.37.2 SetTagDateTime (RT Professional)
Function
Sets the value of a tag of data type "Date/Time".
Syntax
BOOL SetTagDateTime(Tag_Name, value);
Parameter
Tag_Name
Tag name
value
Value of the tag in the data type "Date/Time".
Return value
TRUE
The function itself has been completed without any errors.
FALSE
2.1.37.3 SetTagMultiStateWait functions (RT Professional)
Description
Sets the values of several tags. The system function will end only after the AS has reported
the acceptance of the value.
The system function must be given a DWORD array, in the member of which the status of the
individual tags will be located after the system function has been called. The size of the array
must be large enough to provide sufficient storage space for the status.

Syntax
BOOL SetTagMultiStateWait(pdwState, pFormat,...);
Parameters
pdwState
Field in which the tag status is saved.
pFormat
Format description for all the requested tags along with the name and value for each tag.
Return value
TRUE
FALSE
Example
The following program code uses the SetTagMultiStateWait function to set the value of several
tags.
1. Creation of a DWord arrays of the necessary size (number of tags)
2. Creation of the tags that will contain the values to be transferred to the WinCC tags by
means of the SetTagMultiStateWait function
3. Writing the values of the recently declared tags to the WinCC tags:
– gs_tag_bit including the tag value "lValue1"
– gs_tag_SByte including the tag value in the address "&lValue2"
– etc.

{
#define DATA_SIZE 5
DWORD dwData[DATA_SIZE];
//define all tags

BOOL lValue1;
long lValue2;
char szValue3[_MAX_PATH];
float lValue4;
char lValue5;
// Fill the tags with the values

// you want to set into the WinCC tags
...
//Set the WinCC tags

SetTagMultiStateWait(dwData,"%d%d%s%f%d","gs_tag_bit",lValue1,
"gs_tag_SByte",lValue2,
"gs_tag_char",szValue3,
"gs_tag_float",lValue4,
"gs_tag_word",lValue5);
...
}
See also
2.1.37.4 SetTagMultiWait functions (RT Professional)
Description
The values of several tags are set in the specified format. The system function will end only
after the AS has reported the acceptance of the value.
Syntax
BOOL SetTagMultiWait(pFormat,...);
Parameters
pFormat
Format description for all the requested tags along with the name and value for each tag.

Return value
TRUE
FALSE
Example
The following program code uses the SetTagMultiWait function to change the value of several
tags. The return value is saved to the ok tag.
{
BOOL ok;
//memory for values allocated via SysMalloc
DWORD dwVar1Value;
char* szVar2Value;
double dbVar3Value;
//settings
ok=SetTagMultiWait("%d%s%f", "Ernie_word", 16,
"Ernie_char", "Hallo Welt",
"Ernie_double", 55.4711);
//error handling
if(ok)
{
// succeeded
// Get values and print

GetTagMultiWait("%d%s%f", "Ernie_word", &dwVar1Value,

}
else
{
// failed
}
...
}

Example
The GetTagMultiWait function is used in the following program code to read several tags of
different types:
1. Declaration of three tags as memory for three different tag types
2. Declaration of the boolean tag ok for buffering the return value (TRUE/FALSE)
3. Reading the three tags and saving the values to the corresponding addresses.
The return value of the function is saved to the ok tag.
4. Output of the three tags with tag type prefix
DWORD dwVar1Value;
char* szVar2Value;
//Memory for the tag value is allocated by the function SysMalloc
double dbVar3Value;
BOOL ok;
ok=GetTagMultiWait("%d%s%f", "Ernie_word", &dwVar1Value,


2.1.37.5 SetTagState functions (RT Professional)
Description
Sets the value of a tag of a specified data type. It also returns the status of the tags.
The following table lists the different SetTagStateXXX functions for reading the tag value:
Function name Parameters PLC data type HMI data type

SetTagBitState Tag Tag_Name, short Binary tag Bool
int value, PDWORD
lp_dwstate
SetTagByteS‐ Tag Tag_Name, BYTE Unsigned 8-bit UByte
tate value, PDWORD
lp_dwstate
SetTagChar‐ Tag Tag_Name, LPSTR Text tag 8-bit or text tag 16- String
State value, PDWORD bit
lp_dwstate
SetTagDou‐ Tag Tag_Name, double Floating point 64-bit Double
bleState value, PDWORD
lp_dwstate


SetTagDWord‐ Tag Tag_Name, Unsigned 32-bit UInteger
State DWORD value,
PDWORD lp_dwstate
SetTagFloat‐ Tag Tag_Name, float Floating point 32-bit Float
State value, PDWORD
lp_dwstate
SetTagRaw‐ Tag Tag_Name, BYTE* Raw data type Raw
State pValue, DWORD size,
PDWORD lp_dwstate
SetTagSByteS‐ Tag Tag_Name, signed Signed 8-bit Byte
tate char value, PDWORD
lp_dwstate
SetTagSDWord‐ Tag Tag_Name, long int Signed 32-bit Integer
State value, PDWORD
lp_dwstate
SetTagSWord‐ Tag Tag_Name, short Signed 16-bit Short
State int value, PDWORD
lp_dwstate
SetTagWord‐ Tag Tag_Name, WORD Unsigned 16-bit UShort
State value, PDWORD
lp_dwstate
Syntax
BOOL <FunctionName><(Parameter)>;
Example: BOOL SetTagBitState(Tag_Name, value, lp_dwstate);
Parameters
Tag_Name
Tag name
value
Value of the tags of a specified type.
lp_dwstate
cycle.
pFormat
Format description for all the requested tags along with name and value for each tag.
pValue
size

Return value
TRUE
FALSE
Example
The following program code uses the SetTagBitState function to set the value of the gs_tag_bit
tag to TRUE and saves the return value to the ok tag. ""&dwstate" is the address of the tag in
which the tag status is stored.
{
DWORD dwstate;
BOOL ok;
//Load dwState with default values

dwstate = 0xFFFFFFFF;
//Set the value of the tag to TRUE
ok = SetTagBitState("gs_tag_bit",TRUE,&dwstate);
//error handling
if(ok)
{
// succeeded
printf ("Status of gs_tag_bit: %d\r\n", dwstate);
}
else
{
// failed
}
...
}
See also

2.1.37.6 SetTagStateWait functions (RT Professional)
Description
Sets the value of a tag of a specified data type. The system function will end only after the AS
has reported the acceptance of the value. It also returns the status of the tags.
The following table lists the different SetTagStateWait functions for setting the tag value:

SetTagBitState‐ Tag Tag_Name, short Binary tag Bool
Wait int value, PDWORD
lp_dwstate
SetTagByteState‐ Tag Tag_Name, BYTE Unsigned 8-bit UByte
Wait value, PDWORD
lp_dwstate
SetTagCharState‐ Tag Tag_Name, Text tag 8-bit or text tag 16- String
Wait LPSTR value, bit
PDWORD lp_dwstate
SetTagDoubleSta‐ Tag Tag_Name, double Floating point 64-bit Double
teWait value, PDWORD
lp_dwstate
SetTagDWordSta‐ Tag Tag_Name, Unsigned 32-bit UInteger
teWait DWORD value,
PDWORD lp_dwstate
SetTagFloatState‐ Tag Tag_Name, float Floating point 32-bit Float
Wait value, PDWORD
lp_dwstate
SetTagRawState‐ Tag Tag_Name, BYTE* Raw data type Raw
Wait pValue, DWORD size,
PDWORD lp_dwstate
SetTagSByteSta‐ Tag Tag_Name, char Signed 8-bit Byte
teWait value, PDWORD
lp_dwstate
SetTagSDWord‐ Tag Tag_Name, long Signed 32-bit Integer
StateWait int value, PDWORD
lp_dwstate
SetTagSWordSta‐ Tag Tag_Name, short Signed 16-bit Short
teWait int value, PDWORD
lp_dwstate
SetTagWordState‐ Tag Tag_Name, Unsigned 16-bit UShort
Wait WORD value,
PDWORD lp_dwstate
Syntax
BOOL<FunctionName><(Parameter)>;
Example: BOOL SetTagBitStateWait(Tag_Name, value, lp_dwstate);

Parameters
Tag_Name
Tag name
value
lp_dwstate
cycle.
pValue
size
Return value
TRUE
FALSE
Example
The following program code uses the SetTagBitStateWait function to set the value of the
gs_tag_bit tag to TRUE and saves the return value to the ok tag. ""&dwstate" is the address
of the tag in which the tag status is stored.

{
DWORD dwstate;
BOOL ok;
//Load dwState with default values

dwstate = 0xFFFFFFFF;
//Set the value of the tag to TRUE
ok = SetTagBitStateWait("gs_tag_bit",TRUE,&dwstate);
//error handling
if(ok)
{
// succeeded
printf ("Status of gs_tag_bit: %d\r\n", dwstate);
}
else
{
// failed
}
...
}
See also
2.1.37.7 SetTagValue functions (RT Professional)
Description
Enables the transfer of a value in the form of a variant and sets the pointer to the value of data
type "Variant".
Syntax
BOOL SetTagValue(lpdmVarKey, lpdmValue, dwState, lpdmError);
Parameters
lpdmVarKey

lpdmValue
Pointer to a structure of data type "Variant". Refer to relevant technical references for the
description of data type VARIANT.
lpdmError
Return value
TRUE
FALSE
Example
The SetTagValue function is used in the following program code to transfer the value in varKey.
{
// tags for setting the value
DM_VARKEY varKey;
LPVARIANT value;
LPCMN_ERROR error1:
// tags for getting the value

CMN_ERROR error:
BOOL keyFound;
ok = SetTagValue(&varKey, &value, &error1);
if (keyFound)
{
// succeeded, get the new value
GetTagValue(&varKey, &result, &error);
// print tag value
...
}
else
{
// failed
...
}
}

2.1.37.8 SetTagValueWait functions (RT Professional)
Description
Enables the transfer of a value in the form of a variant and sets the pointer to the value of data
type "Variant". The system function will end only after the AS has reported the acceptance of
the value.
Syntax
BOOL SetTagValueWait(lpdmVarKey, lpdmValue, dwState, lpdmError);
Parameters
lpdmVarKey
lpdmValue
Pointer to a structure of data type "Variant". Refer to relevant technical references for the
description of data type VARIANT.
dwState
Status of the tags that is returned after the system function cycle.
lpdmError
Return value
TRUE
There is no check to see if the tag was written without any errors.
FALSE
Example
The SetTagValueWait function is used in the following program code to transfer the value in
varKey.

{
// tags for setting the value
DM_VARKEY varKey;
LPVARIANT value;
LPCMN_ERROR error1:
// tags for getting the value

CMN_ERROR error:
BOOL keyFound;
ok = SetTagValueWait(&varKey, &value, &error1);
if (keyFound)
{
// succeeded, get the new value
GetTagValueWait(&varKey, &result, &error);
// print tag value
...
}
else
{
// failed
...
}
}
2.1.37.9 SetTagWait functions (RT Professional)
Description
Sets the value of a tag of a specified data type. The system function will end only after the AS
has reported the acceptance of the value.
The following table lists the different SetTagWait functions for setting the tag value:

SetTagBitWait Tag Tag_Name, short Binary tag Bool
int value
SetTagByte‐ Tag Tag_Name, BYTE Unsigned 8-bit UByte
Wait value
SetTagChar‐ Tag Tag_Name, char* Text tag 8-bit or text tag 16- String
Wait value bit
SetTagDouble‐ Tag Tag_Name, double Floating point 64-bit Double
Wait value


SetTagDWord‐ Tag Tag_Name, Unsigned 32-bit UInteger
Wait DWORD value
SetTagFloat‐ Tag Tag_Name, float Floating point 32-bit Float
Wait value
SetTagRaw‐ Tag Tag_Name, BYTE* Raw data type Raw
Wait pValue, DWORD size
SetTagSByte‐ Tag Tag_Name, char Signed 8-bit Byte
Wait value
SetTagSDWord‐ Tag Tag_Name, long int Signed 32-bit Integer
Wait value
SetTagSWord‐ Tag Tag_Name, short Signed 16-bit Short
Wait int value
SetTagWord‐ Tag Tag_Name, WORD Unsigned 16-bit UShort
Wait value
Syntax
BOOL <FunctionName><(Parameter)>;
Example: BOOL SetTagBitWait(Tag_Name, value);
Parameters
Tag_Name
Tag name
value
pValue
size
Return value
TRUE
FALSE

Example
The following program code uses the SetTagBitWait function to set the value of the gs_tag_bit
tag to TRUE and saves the return value to the ok tag.
{
BOOL ok;
BOOL bvalue;

ok = SetTagBitWait("gs_tag_bit", TRUE);
//error handling
if(ok)
{
// succeeded
bvalue = GetTagBitWait("gs_tag_bit");
}
else
{
// failed
}
...
}
2.1.37.10 SetTag (RT Professional)
Description
Note
tag.

SetTag (Tag, Value)

SetTag Tag, Value

Parameters
Tag
Value
Note
Example
{
BOOL ok;
BOOL bvalue;

//error handling
if(ok)
{
// succeeded
}
else
{
// failed
}
...
}
2.1.37.11 SetTagByProperty (RT Professional)
Description
Specifies a tag value with the value of an object property. The change is also logged in the
alarm system.


SetTagIndirectByProperty (tag name, screen name, screen object, name of the property, with
or without operator event)

SetTagByProperty Tag_name, Screen_name, Screen_object, Property_name,
Parameters
Tag name
Name of the tag whose value is specified by the object property.
Screen name
Screen object
Name of the object whose property supplies the tag value.

Name of the property that supplies the tag value.

Example
The following program code returns the value of the selected text when you click in a combo
box.
{
char* rt_value;
SetTagByProperty (rt_value, screenName, objectName, "SelectedText",

...
}

2.1.37.12 SetTagByTagIndirect (RT Professional)
Description
Writes the value of an indirect addressed tag to a tag. The tag transferred as parameter
contains the name of a second tag the value of which is read. The change in the alarm system
is logged via an operator input alarm.

SetTagIndirectByTagIndirect (name of the tag, tag name, with or without operator input alarm)

SetTagByTagIndirect Tag_name, Source_tag_name, With_or_without_operator_event
Parameters
Name of the tag

Tag name
Name of a string tag which contains the name of a tag which supplies the tag value.

0 (hmiWithoutOperatorEvent) = Without operator input alarm
Example
The following program code writes the value of the tag Tag4 to the tag Tag1.
{
SetTagByTagIndirect ("Tag1", "IndirectRead", hmiWithoutOperatorEvent);
...
}

2.1.37.13 SetTagIndirect (RT Professional)
Description
Writes a value to an indirect addressed tag. The tag transferred as output parameter contains
the name of a second tag the value of which is changed by the function. The change in the
alarm system is logged via an operator input alarm.

SetTagIndirect (tag name, , value, with or without operator event)

SetTagIndirect Tag_name, Value, With_or_without_operator_event
Parameters
Tag name
Value
Value which is to be written.

Example
The following program code writes the value "value" to the tag Tag3.
{
int value;

SetTagIndirect ("IndirectWrite", "value", hmiWithoutOperatorEvent);
...
}

2.1.37.14 SetTagIndirectByProperty (RT Professional)
Description
Writes the value of an object property to an indirectly addressed tag. The tag transferred as
output parameter contains the name of a second tag the value of which is changed by the
function. The change in the alarm system is logged via an operator input alarm.

SetTagIndirectByProperty (Tag name, Screen name, Screen object, Name of the property,
With or without operator event)

SetTagIndirectByProperty Tag_name, Screen_name, Screen_object, Property_name,
Parameters
Tag name
Screen name
Screen object
Name of the object whose property supplies the value.

Name of the property which supplies the value.

0 (hmiWithoutOperatorEvent) = Without input alarm

Example
The following program code writes the value of the object property "Background color" to the
tag Tag2.
{
SetTagIndirectByProperty ("IndirectWrite", screenName, objectName, "BackColor",
...
}
2.1.37.15 SetTagIndirectByTagIndirect (RT Professional)
Description
Writes the value of an indirectly addressed tag to an indirectly addressed tag. The tag
transferred as output parameter contains the name of a second tag the value of which is
changed by the function. The tag transferred as parameter contains the name of a second tag
the value of which is read. The change in the alarm system is logged via an operator input
alarm.

SetTagIndirectByTagIndirect (Tag name, Tag name, With or without operator input alarm)

SetTagIndirectByTagIndirect Tag_name, Source_tag_name, With_or_without_operator_event
Parameters
Tag name
Tag name
Name of the indirect tag that returns the tag value.


Example
The following program code writes the value of the tag "Tag4" to the tag "Tag2".
{
SetTagIndirectByTagIndirect ("IndirectWrite", "IndirectRead");
...
}
2.1.37.16 SetTagIndirectWithOperatorEvent (RT Professional)
Description
Specifies the indirect name for a tag. The change is also logged in the alarm system.

SetTagIndirectWithOperatorInputAlarm (Tag name (output), LpValue)

SetTagIndirectWithOperatorEvent
Parameters
Tag name (output)

Name of the tag to which the tag name is written.
LpValue
Name of the tag written to the tag.
2.1.37.17 SetTagWithOperatorEvent (RT Professional)
Description
Specifies the value for a tag. The change is also logged in the alarm system.

SetTagWithOperatorEvent (name of the tag, value)


SetTagWithOperatorEvent Tag_name, Value
Parameters
Name of the tag

Value
Value written to the tag.
Example
The following program code transfers the value from the "value" tag to the "result" tag when
you click the corresponding button.

SetTagWithOperatorEvent result, value
...
{
SetTagWithOperatorEvent ("result", "value");
...
}
2.1.38 StartProgram (RT Professional)
Description
Starts the specified program with the specified parameters.
The system function can be used in C scripting only
Syntax
void StartProgram(Program_name, Program_parameters, Display_mode,
Wait_for_program_end);

Parameters
Program_name
Path and name of the program to be started.
Program_parameters
Parameters to be used for start-up. Information on the possible parameters can be found in
the description of the program to be started.
Display_mode
Defines the display mode in which the program is started:
0 (hmiShowNormal) = Display in window
1 (hmiShowMinimized) = Display in minimized window
2 (hmiShowMaximized) = Display in maximized window
3 (hmiShowMinimizedAndInactive) = Display in inactive and minimized window
Wait_for_program_end
The parameter is not evaluated by WinCC Runtime Professional.
Example
The following program code starts the calc.exe program in the minimized window.
{
BOOL Wait_for_program_end;
float number;
//start the program calc.exe

StartProgram("C:\\Winnt\\system32\\calc.exe",number,hmiShowMinimized,
Wait_for_program_end);
...
}
2.1.39 StopRuntime (RT Professional)
Description

StopRuntime (Mode)


StopRuntime Mode
Parameters
Mode
Example

2.1.40 StoreScreen (RT Professional)
Description
Saves the current screen. This screen can be opened with the ActivateStoredScreen system
function.
Syntax
BOOL StoreScreen();
Return value
TRUE

FALSE
Example
The following program code writes the return value of the StoreScreen function to the
screen_stored tag and calls the stored screen, provided that this was saved without errors.
{
BOOL screen_stored;
screen_stored = StoreScreen();
//user defined code
...
//error handling
if(screen_stored)
{
// succeeded
ActivateStoredScreen();
printf ( "Stored screen is now activated.\r\n" );
}
else
{
// failed
printf ( "Error - no screen stored." );
}
...
}
See also
ActivateStoredScreen (Page 1378)
2.1.41 SystemTimeToDate (RT Professional)
Description
Converts a date-clock time specification in SYSTEMTIME format into the DATE data format.

SystemTimeToDate (value, pointer to time)
Syntax
SystemTimeToDate(Value, PointerToTime);

Parameters
Value
Value in SYSTEMTIME data format
Pointer to time
Pointer to the result in the DATE format
Return value
TRUE
FALSE
Example
BOOL BRet;
SYSTEMTIME st_1, st_2;
DATE d_1, d_2; // wtypes.h. DATE type. Visual Studio documnetation.
GetSystemTime( &st_1 );

printf( "st_1.wDay = %d \r\n", st_1.wDay );printf( "st_1.wHour = %d \r\n", st_1.wHour );
printf( "st_1.wMilliseconds = %d \r\n", st_1.wMilliseconds );
BRet = SystemTimeToDate( st_1, &d_1 );

printf( "DATE d = %ld \r\n \r\n", d_1 );
printf( "DATE d = %lf \r\n \r\n", d_1 );
printf( "DATE d = %f \r\n \r\n", d_1 );
BRet = DateToSystemTime( d_1, &st_2 );

printf( "st_2.wDay = %d \r\n", st_2.wDay );
printf( "st_2.wHour = %d \r\n", st_2.wHour );
printf( "st_2.wMilliseconds = %d \r\n \r\n \r\n", st_2.wMilliseconds );

2.1.42 TriggerOperatorEvent (RT Professional)
Description
The TriggerOperatorEvent system function triggers an operator input alarm.
Syntax
int TriggerOperatorEvent(dwFlags, dwMsgNum, lpszObjectName, dwMyTextID, doValueOld,
doValueNew, pszComment);
Parameter
dwFlags
FLAG_COMMENT_PARAMETER (0x001): Specifies that the comment is input by means of

the parameter.
FLAG_COMMENT_DIALOG (0x003): Specifies that the comment is input by means of a dialog.
FLAG_TEXTID_PARAMETER (0x100): Specifies that the comment is specified by means of
a Text ID.
dwMsgNum
Number of the operator input alarm that is triggered.
lpszObjectName
Pointer to the name of the tag with the old value and the new value.
dwMyTextID
ID of the text to be used as comment.
doValueOld
Old value.
doValueNew
New value.
pszComment
Pointer to the text to be used as comment.
Return value
TRUE
The system function has been completed without any errors.

FALSE
2.1.43 UA (Recipe) (RT Professional)
2.1.43.1 uaArchiveClose (RT Professional)
Description
Terminates the connection to the current recipe.
Syntax
BOOL uaArchiveClose (
UAHARCHIVE hArchive )
Parameters
UAHARCHIVE hArchive
Handle of the recipe. This handle is generated using uaQueryArchive or
uaQueryArchiveByName.
Return value
TRUE
Successful closing of the recipe
FALSE
Error
2.1.43.2 uaArchiveDelete (RT Professional)
Description
Deletes the data from a recipe. The configured recipe, however, is retained.
Syntax
BOOL uaArchiveDelete (

UAHARCHIVE hArchive,
LPCSTR pszWhere )
Parameters
UAHARCHIVE hArchive
LPCSTR pszWhere
This string contains the SQL selection expression. It defines which data records are to be
deleted. The expression is equivalent to the SQL instruction "DELETE FROM <archive>
WHERE pszWhere".
Warning! If this string is empty, the entire recipe will be deleted.
Return value
TRUE
Successful deletion of the recipe
FALSE
Error
2.1.43.3 uaArchiveExport (RT Professional)
Description:
Exports the current recipe to a log in CSV format.
Syntax
BOOL uaArchiveExport (
LPCSTR pszDestination,
LONG lType,
LONG lOptions )

Parameters
UAHARCHIVE hArchive
Handle of the recipe. This handle is generated using UaQueryArchive or
UaQueryArchiveByName.
LPCSTR pszDestination
File name of the target archive.
LONG lType
Data format of the target archive. Two formats are available:
● UA_FILETYPE_DEFAULT = 0: Default file format = CSV
● UA_FILETYPE_CSV = 1: CSV file format
LONG lOptions
Reserved for future expansions. Must be 0.
Return value
TRUE
Successful export of the recipe
FALSE
Error
2.1.43.4 uaArchiveGetCount (RT Professional)
Description
Reads the number of data records.
Syntax
LONG uaArchiveGetCount(
LONG * plCount )
Parameters
UAHARCHIVE hArchive
uaQueryArchiveByName .

LONG plCount
Pointer to a tag in which the number of data records should be stored.
Return value
Number of data records.
0 = Log is empty or error has occurred. Must be queried by means of uaGetLastError() .
2.1.43.5 uaArchiveGetFieldLength (RT Professional)
Description
Reads the length of a field in the current data record.
Syntax
LONG uaArchiveGetFieldLength(
LONG lField )
Parameters
UAHARCHIVE hArchive
LONG lField
Field number, with lField = 1 addressing the first field.
Return value
Length of the current field.
2.1.43.6 uaArchiveGetFieldName (RT Professional)
Description
Reads the name of a field in the current data record.

Syntax
VOID uaArchiveGetFieldName (
LONG lField,
LPCSTR pszName,
LONG cMaxLen )
Parameters
UAHARCHIVE hArchive
LONG lField
LPCSTR pszName
Field Name
LONG cMaxLen
Maximum length
2.1.43.7 uaArchiveGetFields (RT Professional)
Description
Reads the number of configured data fields, which also includes the "ID", "Last User", and
"Last Access" fields. In the Runtime calls, the indexes of the configured fields are indicated 1
to N. The field ID has the index 0. The fields "Last User" and "Last Access" are appended to
the end of the configured fields.
Syntax
LONG uaArchiveGetFields (
Parameters
UAHARCHIVE hArchive

Return value
Number of configured fields.
2.1.43.8 uaArchiveGetFieldType (RT Professional)
Description
Reads the type of a field in the current data record.
Syntax
LONG uaArchiveGetFieldType (
LONG lField )
Parameters
UAHARCHIVE hArchive
LONG lField
Return value
Type of the current field.
The symbolic definitions of the field types are:
UA_FIELDTYPE_INTEGER
UA_FIELDTYPE_DOUBLE
UA_FIELDTYPE_STRING
UA_FIELDTYPE_DATETIME
2.1.43.9 uaArchiveGetFieldValueDate (RT Professional)
Description
Reads the date and time of a field in the current data record.

Syntax
BOOL uaArchiveGetFieldValueDate (
LONG lField,
LPSYSTEMTIME pstDateTime )
Parameters
UAHARCHIVE hArchive
LONG lField
LPSYSTEMTIME pstDateTime
Pointer to a tag of the type SYSTEMTIME
Return value
TRUE
Successful reading of date and time
FALSE
Error
2.1.43.10 uaArchiveGetFieldValueDouble (RT Professional)
Description
Reads the Double value of a field in the current data record.
BOOL uaArchiveGetFieldValueDouble (
LONG lField,
double* pdValue )
Parameters
UAHARCHIVE hArchive

LONG lField
double* pdValue
Pointer to tag for the current field content.
Return value
TRUE
Successful reading of field value
FALSE
Error
2.1.43.11 uaArchiveGetFieldValueFloat (RT Professional)
Description
Reads Float value of a field in the current data record.
Syntax
BOOL uaArchiveGetFieldValueFloat (
LONG lField,
FLOAT* pfValue )
Parameters
UAHARCHIVE hArchive
LONG lField
FLOAT* pfValue
Pointer to Float tag for the current field content.
Return value
TRUE


FALSE
Error
2.1.43.12 uaArchiveGetFieldValueLong (RT Professional)
Description
Reads the Long Integer value of a field in the current data record.
Syntax
BOOL uaArchiveGetFieldValueLong (
LONG lField,
LONG* pdValue )
Parameters
UAHARCHIVE hArchive
LONG lField
LONG* pdValue
Pointer to Long tag for the current field content.
Return value
TRUE
FALSE
Error

2.1.43.13 uaArchiveGetFieldValueString (RT Professional)
Description
Reads the string of a field in the current data record.
Syntax
BOOL uaArchiveGetFieldValueString (
LONG lField,
LPSTR pszString,
LONG cMaxLen )
Parameters
UAHARCHIVE hArchive
LONG lField
LPCSTR pszString
Field value as string.
LONG cMaxLen
Maximum length of the string.
Return value
TRUE
FALSE
Error
2.1.43.14 uaArchiveGetFilter (RT Professional)
Description
Reads the filter of the current data record. Additional information can be found in the appendix
under "SQL Statements".

Syntax
VOID uaArchiveGetFilter (
LPSTR pszFilter,
LONG cMaxLen )
Parameters
UAHARCHIVE hArchive
LPSTR pszFilter
Read filter.
LONG cMaxLen
Maximum length
2.1.43.15 uaArchiveGetID (RT Professional)
Description
uaArchiveGetID reads the ID of the recipe.
The recipe ID serves internal purposes and may differ from the number given in the recipe.
Syntax
LONG uaArchiveGetID (
Parameters
UAHARCHIVE hArchive

Return value
ID of the recipe.
2.1.43.16 uaArchiveGetName (RT Professional)
Description
Reads the name of the recipe.
Syntax
VOID uaArchiveGetName (
LPSTR pszName,
LONG cMaxLen )
Parameters
UAHARCHIVE hArchive
LPSTR pszName
Pointer to buffer for recipe name.
LONG cMaxLen
Maximum length
Example
char Filling [40];
uaArchiveGetName( hArchive, bottling, 39 );
2.1.43.17 uaArchiveGetSor (RT Professional)
Description
uaArchiveGetSort reads the sorting of the recipe.

Syntax
VOID uaArchiveGetSort (
LPSTR pszSort,
LONG cMaxLen )
Parameters
UAHARCHIVE hArchive
LPCSTR pszSort
Sorting
LONG cMaxLen
Maximum length
2.1.43.18 uaArchiveImport (RT Professional)
Description
uaArchivImport imports a recipe with CSV data format. The structure of the destination recipe
must be identical to that of the imported recipe.
Syntax
BOOL uaArchiveImport (
LPCSTR pszSource,
LONG lType,
LONG lOptions )
Parameters
UAHARCHIVE hArchive
LPCSTR pszSource
File name of the source archive.

LONG lType
Data format of the source archive. Two formats are available:
UA_FILETYPE_DEFAULT = 0: Default file format = CSV
UA_FILETYPE_CSV = 1: CSV file format
LONG lOptions
Reserved for future expansions. Must be 0.
Return value
TRUE
Successful import of the recipe.
FALSE
Error
2.1.43.19 uaArchiveInsert (RT Professional)
Description
Inserts the local data record buffer into the current database. Before you call uaArchiveInsert,
use the "uaArchiveSetFieldValue..." system functions to enter the data in the fields of the local
data buffer so that the new data record contains useful data.
Use system function "uaArchiveSetFieldValueLong" to enter the internal column "ID" in the
current data record. Can only be used in C scripting.
Syntax
BOOL uaArchiveInsert (
Parameters
UAHARCHIVE hArchive
Return value
TRUE
Successful insertion of the data record.

2.1.43.20 uaArchiveMoveFirst (RT Professional)
Description
Goes to the first data record.
Syntax
BOOL uaArchiveMoveFirst (
Parameters
UAHARCHIVE hArchive
Return value
TRUE
Successful jumping in the recipe
FALSE
Error
2.1.43.21 uaArchiveMoveLast (RT Professional)
Description
Goes to the last data record.
Syntax
BOOL uaArchiveMoveLast (
Parameters
UAHARCHIVE hArchive

Return value
TRUE
FALSE
Error
2.1.43.22 uaArchiveMoveNext (RT Professional)
Description
Goes to the next data record.
Syntax
BOOL uaArchiveMoveNext (
Parameters
UAHARCHIVE hArchive
Return value
TRUE
FALSE
Error
2.1.43.23 uaArchiveMovePrevious (RT Professional)
Description
Goes to the previous data record.
Syntax
BOOL uaArchiveMovePrevious (

Parameters
UAHARCHIVE hArchive
Return value
TRUE
FALSE
Error
2.1.43.24 uaArchiveOpen (RT Professional)
Description
uaArchiveOpen must be called before all RT functions (e.g. uaArchiveMoveFirst,
uaArchiveMoveLast, uaArchiveMoveNext, uaArchiveMovePrevious, uaArchiveDelete,
uaArchiveUpdate, uaArchiveInsert, uaArchiveGetID, uaArchiveGetFields,
uaArchiveGetFieldType, uaArchiveGetFieldValueDate, uaArchiveGetFieldValueDouble,
uaArchiveGetFieldValueFloat, uaArchiveGetFieldValueLong, uaArchiveGetFieldValueString,
uaArchiveSetFieldValueDate, uaArchiveSetFieldValueDouble, uaArchiveSetFieldValueFloat,
uaArchiveSetFieldValueLong and uaArchiveSetFieldValueString).
Note
Sort and filter recipes
You may apply the "uaArchiveSetSort" and "uaArchiveSetFilter" system functions to a recipe
without having to open this recipe by means of "uaArchiveOpen".
Syntax
BOOL uaArchiveOpen (

Parameters
UAHARCHIVE hArchive
Return value
TRUE
Successful opening of the recipe
FALSE
Error
2.1.43.25 uaArchiveReadTagValues (RT Professional)
Description
Reads the current value from the field tag.
Syntax
BOOL uaArchiveReadTagValues (
LONG* pnFields,
LONG cFields,
LONG lOptions )
Parameters
UAHARCHIVE hArchive
LONG* pnFields
Reserved for future applications (NULL)
LONG cFields
Number of field indices transferred (size of array pnFields).
Reserved for future applications (0)

LONG lOptions
In the case of all other values of lOptions, the data is inserted at the position of the pointer.
Return value
TRUE
Successful reading in the recipe
FALSE
Error
2.1.43.26 uaArchiveReadTagValuesByName (RT Professional)
Description
Reads the tag values in the current data.
Syntax
BOOL uaArchiveReadTagValuesByName (
LPCSTR pszFields,
LONG lOptions )
Parameters
UAHARCHIVE hArchive
LPCSTR pszFields
LONG lOptions
Return value
TRUE
FALSE

Error
2.1.43.27 uaArchiveRequery (RT Professional)
Description
On completion of the call of uaArchiveSetFilter and uaArchiveSetSort, reload the recipe by
means of uaArchiveRequery.
Note
Sort and filter recipes
You may apply the "uaArchiveSetSort" and "uaArchiveSetFilter" system functions to a recipe
without having to open this recipe by means of "uaArchiveOpen". In this case you do no have
to call the system function "uaArchiveRequery".
Call uaArchiveRequery in the following situations as well:

● If you have made inputs in the recipe view.
● If you have made inputs in the "Recipes" editor that are to be transferred to the table cell.
Syntax
BOOL uaArchiveRequery(
Parameters
UAHARCHIVE hArchive
Return value
TRUE
Successful requery
FALSE
Error

2.1.43.28 uaArchiveSetFieldValueDate (RT Professional)
Description
Writes the date and time into a field of the current data record.
Syntax
BOOL uaArchiveSetFieldValueDate (
LONG lField,
Parameters
UAHARCHIVE hArchive
LONG lField
Field number, with lField = 1 addressing the first configured field. The ID field is addressed
with lField = 0.
LPSYSTEMTIME pstDateTime
Date and Time
Return value
TRUE
Successful writing of date and time
FALSE
Error
2.1.43.29 uaArchiveSetFieldValueDouble (RT Professional)
Description
Writes a Double value into a field of the current data record.

Syntax
BOOL uaArchiveSetFieldValueDouble (
LONG lField,
double dValue )
Parameters
UAHARCHIVE hArchive
LONG lField
The field number, where lField = 1 is addressing the first configured field. The ID field is
addressed with lField = 0.
double dValue
Field value
Return value
TRUE
Successful writing of field value
FALSE
Error
2.1.43.30 uaArchiveSetFieldValueFloat (RT Professional)
Description:
Writes a Float value into a field of the current data record.
Syntax
BOOL uaArchiveSetFieldValueFloat (
LONG lField,
float fValue )

Parameters:
UAHARCHIVE hArchive
LONG lField
Field number, with lField = 1 addressing the first configured field. The ID field is addressed
with lField = 0.
float fValue
Field value
Return value:
TRUE
FALSE
Error
2.1.43.31 uaArchiveSetFieldValueLong (RT Professional)
Description
Writes a Long Integer value into a field of the current data record.
Syntax
BOOL uaArchiveSetFieldValueLong (
LONG lField,
LONG dValue )
Parameters
UAHARCHIVE hArchive
LONG lField
addressed with lField = 0.

LONG dValue
Field value
Return value
TRUE
FALSE
Error
2.1.43.32 uaArchiveSetFieldValueString (RT Professional)
Description
Writes a String into a field of the current data record.
Syntax
BOOL uaArchiveSetFieldValueString (
LONG lField,
LPCSTR pszString )
Parameters
UAHARCHIVE hArchive
LONG lField
addressed with lField = 0 .
LPCSTR pszString
Field value
Return value
TRUE
FALSE

Error
2.1.43.33 uaArchiveSetFilter (RT Professional)
Description
Sets the filter. You can call the system function without having opened the recipe with
"uaArchiveOpen".
Note
If you have opened the recipe with "uaArchiveOpen", reload the recipe after filtering by means
of "uaArchiveRequery".
Syntax
VOID uaArchiveSetFilter (
LPSTR pszFilter )
Parameters
UAHARCHIVE hArchive
LPSTR pszFilter
Filter to be set.
2.1.43.34 uaArchiveSetSort (RT Professional)
Description
Sets the sorting of the recipe. You can call the system function without having opened the
recipe with "uaArchiveOpen".
Note
If you have opened the recipe with "uaArchiveOpen", reload the recipe after sorting by means
of "uaArchiveRequery".

Syntax
BOOL uaArchiveSetSort (
LPSTR pszSort )
Parameters
UAHARCHIVE hArchive
LPCSTR pszSort
Sorting
Return value
TRUE
Successful setting of the sorting
FALSE
Error
2.1.43.35 uaArchiveUpdate (RT Professional)
Description
Updates the open recipe. All data changes of a recipe are transferred to the database. The
configuration of the recipe remains unchanged.
Syntax
BOOL uaArchiveUpdate (
Parameters
UAHARCHIVE hArchive

Return value
TRUE
Successful update of the recipe
FALSE
"Update_failed" error = 106
This error occurs when there is a consistency violation. Example: The "Field requires a value"
flag is set in a field, but no value has been entered there.
2.1.43.36 uaArchiveWriteTagValues (RT Professional)
Description
Writes the values of the current data record into the tags.
Syntax
BOOL uaArchiveWriteTagValues (
LONG* pnFields,
LONG cFields,
LONG lOptions )
Parameters
UAHARCHIVE hArchive
LONG* pnFields
LONG cFields
LONG lOptions
Return value
TRUE

FALSE
Error
2.1.43.37 uaArchiveWriteTagValuesByName (RT Professional)
Description
Writes the values of the current data record into the tags. The access is based on the names
of the recipe and field.
Syntax
BOOL uaArchiveWriteTagValuesByName (
LPCSTR pszFields,
LONG lOptions )
Parameters
UAHARCHIVE hArchive
LPCSTR pszFields
LONG lOptions
Return value
TRUE
FALSE
Error
2.1.43.38 uaConnect (RT Professional)
Description
Establishes connection to recipes (Runtime).

Syntax
BOOL uaConnect (
UAHCONNECT* phConnect )
Parameters
UAHCONNECT* phConnect
Pointer to handle for newly connected recipe.
Return value
TRUE
Successful connection of a recipe
FALSE
Error
2.1.43.39 uaDisconnect (RT Professional)
Description
If a connection to recipes (Runtime) exists, it will be disconnected.
Syntax
BOOL uaDisconnect (
UAHCONNECT hConnect )
Parameters
UAHCONNECT hConnect
Handle for the connected recipe (Runtime). The handle is generated using uaConnect.
Return value
TRUE
Successful disconnection of a recipe
FALSE

Error
2.1.43.40 uaGetArchive (RT Professional)
Description
Reads the recipe configuration.
Syntax
BOOL uaGetArchive (
UAHCONFIG hConfig,
long lArchive,
UACONFIGARCHIVE* pArchive )
Parameters
UAHCONFIG hConfig,
Configuration handle of the recipe. This handle is generated using uaQueryConfiguration.
long lArchive,
Archive index (0 to (uaGetNumArchives()-1))
UACONFIGARCHIVE* pArchive
Pointer to buffer for receiving the recipe configuration
Return value
TRUE
Successful access to the recipe
FALSE
Error
2.1.43.41 uaGetField (RT Professional)
Description:
Reads the field configuration.

Syntax
BOOL uaGetField (
UAHCONFIG hConfig,
long lArchive,
long lField,
UACONFIGFIELD* pField )
Parameters:
UAHCONFIG hConfig,
long lArchive,
long lField,
The field number; if lField = 0 the first field is addressed.
UACONFIGFIELD* pArchive
Pointer to buffer for receiving the field configuration.
Return value
TRUE
Successful access to the recipe
FALSE
Error
2.1.43.42 uaGetLastError (RT Professional)
Description
The system functions of the WinCC script language return a BOOL value; TRUE corresponds
to error-free processing. If FALSE is returned, you can use "uaGetLastError()" and
"uaGetLastHResult()" to read the error of the last system function.
If you do not call uaGetLastError() until several system functions have been processed,
uaGetLastError() will return the most recent error. You should call a "uaGetLastError()" and
"uaGetLastHResult()" system function whenever FALSE is returned to identify the system
function that triggered the error.
Example:

if ( uaArchiveGetFieldValueLong ( hArchive, Index, &IntValue ) ==

TRUE )
printf( "Field Value = %u\n", IntValue );
else
printf("Error calling uaArchiveGetFieldValueLong: %d / %08lx\n",
uaGetLastError(), uaGetLastHResult());
You should always query system functions that do not return a value (VOID) by calling
uaGetLastError() .
Example:
uaArchiveGetFilter(hArchive, pszFilter, cMaxLen);
INT nUAError = uaGetLastError ( );
if ( UA_ERROR_SUCCESS != nUAError)
{
printf( "Filter = [%s]\n", pszFilter );
}
else
{
printf("Error calling uaArchiveGetFilter: %d, hr=0x%08lX\n",
nUAError, uaGetLastHResult());
}
INT uaGetLastError()
Return value
Error status of the last system function executed. uaGetLastError() can return the following
errors:
UA_ERROR_SUCCESS
UA_ERROR_GENERIC
UA_ERROR_CONNECT_FAILED
UA_ERROR_OPEN_FAILED
UA_ERROR_CLOSE_FAILED
UA_ERROR_REQUERY_FAILED
UA_ERROR_MOVE_FAILED
UA_ERROR_INSERT_FAILED
UA_ERROR_UPDATE_FAILED
UA_ERROR_DELETE_FAILED
UA_ERROR_IMPORT_FAILED

UA_ERROR_EXPORT_FAILED
UA_ERROR_READ_FAILED
UA_ERROR_WRITE_FAILED
UA_ERROR_GET_FAILED
UA_ERROR_SET_FAILED
UA_ERROR_INVALID_NAME
UA_ERROR_INVALID_TYPE
UA_ERROR_INVALID_NUMRECS
UA_ERROR_INVALID_COMMTYPE
UA_ERROR_INVALID_LENGTH
UA_ERROR_INVALID_PRECISION
UA_ERROR_NULL_POINTER
UA_ERROR_INVALID_POINTER
UA_ERROR_INVALID_HANDLE
UA_ERROR_INVALID_INDEX
UA_ERROR_SERVER_UNKNOWN
These error constants as well as the predefines of the user archive routines are located in
CCUACAPI.H.
2.1.43.43 uaGetLastHResult (RT Professional)
Description
Reads the last occurred COM error. This system function is used primarily to analyze
incompatibility in the COM implementation or to identify registry errors and communication
errors.
This system function must always be called in addition to UAGetLastError if one of the user
archive system functions (e.g uaConnect) returns the value "FALSE" to signal an error.
Syntax
LONG uaGetLastHResult()
Return value
Last occurred COM error

2.1.43.44 uaGetNumArchives (RT Professional)
Description
Reads the number of recipes currently configured.
Syntax
LONG uaGetNumArchives (
UAHCONFIG hConfig )
Parameters
UAHCONFIG hConfig
Return value
Number of recipes currently configured. In case of an error, -1 will be returned.
2.1.43.45 uaGetNumFields (RT Professional)
Description
Supplies the number of the configured fields. The "ID", "Last User" and "Last Access" fields
are not included. Indexes are specified from 0 to uaGetNumFields() -1 in the configuration
calls.
Syntax
LONG uaGetNumFields (
UAHCONFIG hConfig,
long lArchive )
Parameters
UAHCONFIG hConfig,
long lArchive,

Return value
Number of configured fields. In case of an error, -1 will be returned.
2.1.43.46 uaQueryArchive (RT Professional)
Description
Establishes a connection to the recipe for Runtime operation. UaQueryArchive creates the
handle UAHARCHIVE.
Syntax
BOOL uaQueryArchive (
UAHCONNECT hConnect,
LONG lArchive,
UAHARCHIVE* phArchive )
Parameters
UAHCONNECT hConnect
Handle of the connected recipe (Runtime). The handle is generated using uaConnect.
LONG lArchive
ID of the archive to be connected
UAHARCHIVE* phArchive
Pointer to handle of the recipe
Return value
TRUE
Successful generation of the handle to the recipe.
FALSE
Error
Comment
If you use User Archives functions in a client project that works with redundant server pairs,
the user archives connection cannot be switched automatically to the new master when
switching masters. In this case, all user archives calls return the LastError
UA_ERROR_SERVER_UNKNOWN = 1004, which means that the user programs must
execute a new uaQueryArchive() or uaQueryArchiveByName() and uaArchiveOpen().

2.1.43.47 uaQueryArchiveByName (RT Professional)
Description
Establishes a connection to the recipe for Runtime operation using the recipe name.
UaQueryArchiveByName creates the UAHARCHIVE handle for the recipe.
Syntax
BOOL uaQueryArchiveByName (
LPCSTR pszName,
Parameters
UAHCONNECT hConnect
Handle of the connected recipe (Runtime). The handle is generated using uaConnect.
LPCSTR pszName
Name of the recipe. With a client project, you can add a server prefix with ‘::‘ to the recipe
name as a separator, if a server other than the default server is used.
UAHARCHIVE* phArchive
Pointer to handle of the recipe
Return value
TRUE
Successful generation of the handle to the recipe.
FALSE
Error
Comment
If you use User Archives functions in a client project that works with redundant server pairs,
the user archives connection cannot be switched automatically to the new master when
switching masters. In this case, all user archives calls return the LastError
UA_ERROR_SERVER_UNKNOWN = 1004, which means that the user programs must
execute a new uaQueryArchive() or uaQueryArchiveByName() and uaArchiveOpen().

2.1.43.48 UaQueryConfiguration (RT Professional)
Description
Establishes a connection to the recipe for the configuration.
Syntax
BOOL uaQueryConfiguration (
UAHCONFIG* phConfig )
Parameters
UAHCONFIG* phConfig,
Pointer to handle of the recipe.
Return value
TRUE
Successful access to recipe
FALSE
Error
2.1.43.49 uaReleaseArchive (RT Professional)
Description
Releases the connection to the current recipe.
Syntax
BOOL uaReleaseArchive (
Parameters
UAHARCHIVE hArchive

Return value
TRUE
Successful release of connection to the recipe.
FALSE
Error
Comment
The "hArchive" handle must be set to "NULL" on successful release to make absolutely sure
that the "UA_ERROR_INVALID_HANDLE" error is triggered on further use of the invalid handle
and without the respective function dwelling at the COM interface for a longer period of time.
2.1.43.50 uaReleaseConfiguration (RT Professional)
Description
Releases connection to recipes (configuration).
Syntax
BOOL uaReleaseConfiguration (
UAHCONFIG hConfig,
BOOL bSave )
Parameters
UAHCONFIG hConfig
BOOL bSave
Saves changes made to the configuration before releasing the connection to recipes for the
configuration.
TRUE = Save Changes, FALSE = Discard Changes
Warning: Save changes (bSave = TRUE) may only be used when Runtime
is not active! You can check whether Runtime is active by requesting uaIsActive().
Return value
TRUE
Successful connection release
FALSE

2.2 C-bib (RT Professional)
Error
2.2.1 ctype functions (RT Professional)
Function overview
The following ctype functions are available:
● long int isalnum (long int x);
● long int isalpha (long int x);
● long int isdigit (long int x);
● long int isgraph (long int x);
● long int islower (long int x);
● long int isprint (long int x);
● long int ispunct (long int x);
● long int isspace (long int x);
● long int isupper (long int x);
● long int isxdigit (long int x);
● long int tolower (long int x);
● long int toupper (long int x);
For a description of the ctype functions see the specialist literature on programming language
C.
The functions can be used in C scripts only.
2.2.2 Function group c_bib (RT Professional)
Introduction
The c_bib function group contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio

● stdlib
● string
● time
stdio itself is again divided into:
● char_io
● directio
● error
● file
● file_pos
● output
For a description of these functions see the relevant specialist literature.
Specific features of WinCC functions

The localtime function behaves as follows when the date is issued:
● The counting of the months begins with 0.
● The years are counted as of 1990, starting with 0.
Only 360 characters of the functions of the C library printf(), sprintf(), fprintf() can be edited in
WinCC.
2.2.3 math functions (RT Professional)
Function overview
The following math functions are available:
● double acos (double x);
● double asin (double x);
● double atan (double x);
● double atan2 (double x, double y);
● double ceil (double x);
● double cos (double x);
● double cosh (double x);
● double exp (double x);
● double fabs (double x);
● double floor (double x);
● double fmod (double x, double y);

● double frexp (double x, long int* y);

● double ldexp (double x, long int y);
● double log (double x);
● double log10 (double x);
● double modf (double x, double* y);
● double pow (double x, double y);
● double sin (double x);
● double sinh (double x);
● double sqrt (double x);
● double tan (double x);
● double tanh (double x);
For a description of the math functions see the specialist literature on programming language
C.
2.2.4 memory functions (RT Professional)
Function overview
The following memory functions are available:
● long int memcmp (const void* cs, const void* ct, size_t n);
● void* memchr (const void* cs, long int c, size_t n);
● void* memcpy (void* s, const void* ct, size_t n);
● void* memmove (void* s, const void* ct, size_t n);
● void* memset (void* s, long int c, size_t n);
For a description of the memory functions see the specialist literature on programming
language C.

2.2.5 multibyte functions (RT Professional)
Function overview
The following multibyte functions are available:
● int _ismbcalnum( unsigned int c )
● int _ismbcalpha( unsigned int c )
● int _ismbcdigit( unsigned int c )
● int _ismbcgraph( unsigned int c )
● int _ismbclower( unsigned int c )
● int _ismbcprint( unsigned int c )
● int _ismbcpunct( unsigned int c )
● int _ismbcspace( unsigned int c )
● int _ismbcupper( unsigned int c )
● int _mbscmp(const unsigned char *string1, const unsigned char *string2 )
● int _mbsncmp( const unsigned char *string1, const unsigned char *string2, size_t count )
● int _mbsrchr( const unsigned char *string, unsigned int c )
● size_t _mbscspn( const unsigned char *string, const unsigned char *strCharSet )
● size_t _mbsspn( const unsigned char *string, const unsigned char *strCharSet )
● size_t _mbstrlen( const char *string )
● size_t _mbslen( const unsigned char *string )
● unsigned char *_mbscat( unsigned char *strDestination, const unsigned char *strSource)
● unsigned char *_mbschr( const unsigned char *string, unsigned int c )
● unsigned char *_mbscpy( unsigned char *strDestination, const unsigned char *strSource )
● unsigned char *_mbsdec( const unsigned char *start, const unsigned char *current )
● unsigned char *_mbsinc( const unsigned char *current ) size_t _mbclen( const unsigned
char *c );
● unsigned char *_mbsncat( unsigned char *strDest, const unsigned char *strSource, size_t
count)
● unsigned char *_mbsncpy( unsigned char *strDest, const unsigned char *strSource, size_t
count)
● unsigned char *_mbspbrk( const unsigned char*string, const unsigned char *strCharSet )
● unsigned char *_mbsstr( const unsigned char *string, const unsigned char *strCharSet )
● unsigned char *_mbstok( unsigned char*strToken, const unsigned char *strDelimit )
A description of the multibyte functions can be found in the specialist literature on programming
language C.

2.2.6 stdio functions (RT Professional)
Function overview
The following stdio functions are available:
● char* fgets (char* s, long int n, FILE* stream);
● char* tmpnam (char* s);
● FILE* fopen (const char* name, const char* mode);
● FILE* freopen (const char* filename, const char* mode, FILE* stream);
● FILE* tmpfile ();
● fprintf();
● long int fclose (FILE* stream);
● long int feof (FILE* stream);
● long int ferror (FILE* stream);
● long int fflush (FILE* stream);
● long int fgetc (FILE* stream);
● long int fgetpos (FILE* stream, fpos_t* ptr);
● long int fputc (long int c, FILE* stream);
● long int fputs (const char* s, FILE* stream);
● long int fseek (FILE* stream, long int offset, long int origin);
● long int fsetpos (FILE* stream, const fpos_t* ptr);
● long int ftell (FILE* stream);
● long int getc (FILE* stream);
● long int putc (long int c, FILE* stream);
● long int remove (const char* filename);
● long int rename (const char* oldname, const char* newname);
● long int setvbuf (FILE* stream, char* buf, long int mode, size_t size);
● long int ungetc (long int c, FILE* stream);
● long int vfprintf (FILE* stream, const char* format, va_list arg);
● long int vsprintf (char* s, const char* format, va_list arg);
● printf();
● size_t fread (void* ptr, size_t size, size_t nobj, FILE* stream);
● size_t fwrite (void* ptr, size_t size, size_t nobj, FILE* stream);
● void clearerr (FILE* stream);
● void rewind (FILE* stream);
● void setbuf (FILE* stream, char* buf);

For a description of the studio functions see the specialist literature on programming language
C.
2.2.7 stdlib functions (RT Professional)
Function overview
The following stdlib functions are available:
● char* getenv (const char* name);
● div_t div (long int num, long int denom);
● double atof (const char* s);
● double strtod (const char* s, char** endp);
● ldiv_t ldiv (long int num, long int denom);
● long int abs (long int n);
● long int atoi (const char* s);
● long int atol (const char* s);
● long int labs (long int n);
● long int rand ();
● long int srand (unsigned long int seed);
● long int strtol (const char* s, char** endp, long int base);
● long int system (const char* s);
● unsigned long int strtoul (const char* s, char** endp, long int base);
● void abort ();
● void* bsearch (const void* key, const void* base, size_t n, size_t size, long int(* cmp) (const
● void* calloc (size_t nobj, size_t size);
● void exit (long int status);
● void free (void* p);
● void* keyval, const void* datum));
● void* malloc (size_t size);
● void qsort (void* base, size_t n, size_t size, long int* cmp, const void* , const void* );
● void* realloc (void* p, size_t size);
For a description of the stdlib functions see the specialist literature on programming language
C.

2.2.8 string functions (RT Professional)
Function overview
The following string functions are available:
● char* strcat (char* s, const char* ct);
● char* strchr (const char* cs, long int c);
● char* strcpy (char* s, const char* ct);
● char* strerror (size_t n);
● char* strncat (char* s, const char* ct, size_t n);
● char* strncpy (char* s, const char* ct, size_t n);
● char* strpbrk (const char* cs, const char* ct);
● char* strrchr (const char* cs, long int c);
● char* strstr (const char* cs, const char* ct);
● char* strtok (char* s, const char* ct);
● long int strcmp (const char* cs, const char* ct);
● long int strncmp (const char* cs, const char* ct, size_t n);
● size_t strcspn (const char* cs, const char* ct);
● size_t strlen (const char* cs);
● size_t strspn (const char* cs, const char* ct);
For a description of the string functions see the specialist literature on programming language
C.
2.2.9 time functions (RT Professional)
Function overview
The following time functions are available:
● char* asctime (const struct tm* tp);
● char* ctime (const time_t* tp);
● clock_t clock ();
● double difftime (time_t time2, time_t time1);
● size_t strftime (char* s, size_t smax, const char* fmt, const struct tm* tp);
● struct tm* gmtime (const time_t* tp);
● struct tm* localtime (const time_t* tp);

2.3 Structure definition (RT Professional)
● time_t mktime (struct tm* tp);

● time_t time (time_t* tp);
For a description of the time functions see the specialist literature on programming language
C.
2.3.1 Structure definition CCAPErrorExecute (RT Professional)
typedef struct {
DWORD dwCurrentThreadID; Thread ID of the current thread
DWORD dwErrorCode1; Error code 1
DWORD dwErrorCode2; Error code 2
BOOL bCycle; cycle/acycle
char* szApplicationName; Name of the application
char* szFunctionName; Name of the function
char* szTagName; Name of the tag
LPVOID lpParam; Pointer to the action stack
DWORD dwParamSize; Size of the action stack
DWORD dwCycle; Cycle of the tag
CMN_ERROR* pError; Pointer to CMN_ERROR
} CCAPErrorExecute;
Members
The meaning of the individual error IDs and the structure elements depending on them are
specified in the following table:
100700 0 x x x x x Action requires exception

1
100700 1 x x x x x Exception when access‐
1 ing the return result
100700 4097 x x x x x Stack overflow while exe‐
1 cuting the action
100700 4098 x x x x x The action contains a di‐
1 vision by 0
100700 4099 x x x x x The action contains an ac‐
1 cess to a non-existing
symbol
100700 4100 x x x x x The action contains an ac‐
1 cess violation

100700 0 x x x Function is not known

4
100700 1 x x Action does not include a
5 P code.
100700 2 x x Incorrect function name
5
100700 4 x x x x x Return value type is inva‐
5 lid
100700 32768f x x x x x Ciss Compiler error when
5 f loading the action
100700 0 x x x x x x x Tag is not defined
6
100700 1 x x x x x x x Tag timeout
6
100700 2 x x x x x x x x Tag cannot be returned in
6 the desired format
100700 3 x x x x x x x x Tag returns status viola‐
6 tion, status present in
CMN_ERROR.dwError1
100700 1 x x x x x x Error with PDLRTGetProp
7
100700 2 x x x x x x Error with PDLRTSetProp
7
100700 3 x x x x x x Error with DM call
7
Error structure
The OnErrorExecute function uses the error structure to evaluate or to output error messages,
if marked by an "x" in the pError column.
2.3.2 Structure definition CCAPTime (RT Professional)
typedef struct {
DWORD dwCurrentThreadID; ThreadID of the current Thread
DWORD dwCode; Code
BOOL bCycle; cycle/acycle
char* szApplicationName; Name of the Application
char* szFunctionName; Name of the Function
LPVOID lpParam; Pointer to the Action-Stack
DWORD dwParamSize; size of the Action-Stack
double dblTime;
DWORD dwFlags; flags
} CCAPTime;

Members
dwCode
The structure element dwCode provides information on calling of OnTime:
dwCode = 113 Call with time definition for each action

dwCode = 114 Call with time monitoring for each action
dwFlags
The structure element dwFlags provides information on the output type:
dwFlags = TRUE The results are output to a file

dwFlags = FALSE The results are output to the diagnostics window
2.3.3 Structure definition CMN_ERROR (RT Professional)
struct CMNERRORSTRUCT {
DWORD dwError1,
DWORD dwError2,
DWORD dwError3,
DWORD dwError4,
DWORD dwError5;
TCHAR szErrorText[MAX_ERROR_LEN];
}
CMN_ERROR
Description
The extended error structure contains the error code and an error text for the error that has
occurred. Each application can use the error structure to evaluate or to output error messages.
Members
dwError1 .. dwError5
These entries can be used in any way by the API functions.
The API descriptions inform about the values the respective entries contain in case of an error.
If not specified otherwise, the error codes are present in dwError1.

szErrorText
Buffer for the text description of the error cause
The content is determined from the resources and therefore language-dependent.
2.3.4 Structure definition DM_TYPEREF (RT Professional)
typedef struct {
DWORD dwType;
DWORD dwSize;
char szTypeName[MAX_DM_TYPE_NAME + 1];
}
DM_TYPEREF;
Members
dwType
Specifies the tag type
dwType PLC data type HMI data type

DM_VARTYPE_BIT Binary tag Bool
DM_VARTYPE_SBYTE Signed 8-bit value Byte
DM_VARTYPE_BYTE Unsigned 8-bit value UByte
DM_VARTYPE_SWORD Signed 16-bit value Short
DM_VARTYPE_WORD Unsigned 16-bit value UShort
DM_VARTYPE_SDWORD Signed 32-bit value Integer
DM_VARTYPE_DWORD Unsigned 32-bit value UInteger
DM_VARTYPE_FLOAT Floating-point number 32-bit IEEE 754 Float
DM_VARTYPE_DOUBLE Floating-point number 64-bit IEEE 754 Double
DM_VARTYPE_TEXT_8 Text tag, 8-bit character set Char
DM_VARTYPE_TEXT_16 Text tag, 16-bit character set String
DM_VARTYPE_RAW Raw data type Raw
DM_VARTYPE_STRUCT Structure tag Struct
DM_VARTYPE_TEXTREF Text reference tag String
dwSize
Specifies the length of the data type in bytes.
szTypeName
In the case of structure tags, contains the name of the structure type

2.3.5 Structure definition DM_VAR_UPDATE_STRUCT (RT Professional)
typedef struct {
DM_TYPEREF dmTypeRef;
DM_VARKEY dmVarKey;
VARIANT dmValue;
DWORD dwState;
}
DM_VAR_UPDATE_STRUCT;
Members
dmTypeRef
Contains information on the data type. For performance reasons, nothing is entered into this
structure in case of cyclic requests.
dmVarKey
Specifies the tags to be edited.
dmValue
Tag value
Upon access to the value of the VARIANT a ".u." has to be inserted between the name of the
VARIANT and the name of the member.
Example
// Supply variant
myVariant.vt = VT_I4;
myVariant.u.lVal = 233;
A description of the data type VARIANT can be found in the associated documentation. The
VARIANT dmValue must be initialized with VariantInit() before first use and enabled again with
VariantClear(&dmValue) after use. For this reason, the structure
DM_VAR_UPDATE_STRUCT must not be deleted with ZeroMemory() or memset().
dwState
Identifies the tag status.

2.3.6 Structure definition DM_VAR_UPDATE_STRUCTEX (RT Professional)
typedef struct {
DM_VARKEY dmVarKey;
VARIANT dmValue;
DWORD dwState;
DWORD dwQualityCode;
}
DM_VAR_UPDATE_STRUCTEX;
Members
dmTypeRef
Contains information on the data type. For performance reasons, nothing is entered into this
structure in case of cyclic requests.
dmVarKey
Specifies the tags to be edited.
dmValue
Tag value
Upon access to the value of the VARIANT a ".u." has to be inserted between the name of the
VARIANT and the name of the member.
Example
// Supply variant
myVariant.vt = VT_I4;
myVariant.u.lVal = 233;
A description of the data type VARIANT can be found in the associated documentation. The
VARIANT dmValue must be initialized with VariantInit() before first use and enabled again with
VariantClear(&dmValue) after use. For this reason, the structure
DM_VAR_UPDATE_STRUCTEX must not be deleted with ZeroMemory() or memset().
dwState
Identifies the tag status.
dwQualityCode
Identifies the QualityCode tag.

2.3.7 Structure definition DM_VARKEY (RT Professional)
typedef struct {
DWORD dwKeyType;
DWORD dwID;
char szName[ MAX_DM_VAR_NAME + 1 ];
LPVOID lpvUserData;
}
DM_VARKEY;
Members
dwKeyType
Defines whether the tag is to be addressed by a key ID or by its name.
DM_VARKEY_ID Specification via key ID
DM_VARKEY_NAME Specification via tag name
dwID
Contains the key ID of the tags if dwKey type is set accordingly.
szName
Contains the name of the tag if dwKey type is set accordingly.
lpvUserData
Pointer to application-specific data
2.3.8 Structure definition LINKINFO (RT Professional)
typedef struct {
LINKTYPE LinkType;
DWORD dwCycle;
TCHAR szLinkName[256];
}
LINKINFO;

Members
LinkType
LinkType are enumeration constants defined in the "Trigger.h" file. They are to be integrated
into your script with the "#include "Trigger.h" command and the corresponding enumeration
constants.
BUBRT_LT_NOLINK 0 no shortcut
BUBRT_LT_VARIABLE_DIRECT 1 direct tag
BUBRT_LT_VARIABLE_INDIRECT 2 indirect tag
BUBRT_LT_ACTION 3 C action
BUBRT_LT_ACTION_WIZARD 4 Dynamic Dialog
BUB_LT_DIRECT_CONNECTION 5 Direct connection
BUBRT_LT_ACTION_WIZARD_INPROC 6 Dynamic Dialog
For the SetLink function, only the enumeration constants BUBRT_LT_VARIABLE_DIREKT

and BUBRT_LT_VARIABLE_INDIRECT may be used. The GetLink function allows to return
all listed enumeration constants.
dwCycle
Update cycle time
255 Picture cycle

235 Window Cycle
0 Upon change
1 250ms
2 500 ms
3 1s
4 2s
5 5s
6 10s
7 1min
8 5min
9 10min
10 1h
11-1 User cycle 1-5
5
szLinkName
Tag name

2.3.9 Structure definition MSG_FILTER_STRUCT (RT Professional)
typedef struct {
CHAR szFilterName[MSG_MAX_TEXTLEN+1];
WORD dwFilter;
SYSTEMTIME st[2];
DWORD dwMsgNr[2];
DWORD dwMsgClass;
DWORD dwMsgType[MSG_MAX_CLASS];
DWORD dwMsgState;
WORD wAGNr[2];
WORD wAGSubNr[2];
DWORD dwArchivMode;
char szTB[MSG_MAX_TB][
MSG_MAX_TB_CONTENT+1]
DWORD dwTB;
Double dPValue[MSG_MAX_PVALUE][2];
DWORD dwPValue[2];
DWORD dwMsgCounter[2];
DWORD dwQuickSelect;
}
MSG_FILTER_STRUCT;
Description
In this structure the criteria are specified.
Members
dwFilter
The filter conditions are defined by means of the following constants from the file "m_global.h":
MSG_FILTER_DATE_FROM Date from

MSG_FILTER_DATE_TO Date to
MSG_FILTER_TIME_FROM Time from
MSG_FILTER_TIME_TO Time to
MSG_FILTER_NR_FROM Message number from
MSG_FILTER_NR_TO Message number to
MSG_FILTER_CLASS Message classes
MSG_FILTER_STATE Message status
MSG_FILTER_AG_FROM AS number from
MSG_FILTER_AG_TO AS number to
MSG_FILTER_AGSUB_FROM AG subnumber from
MSG_FILTER_AGSUB_TO AG subnumber to
MSG_FILTER_TEXT Message texts
MSG_FILTER_PVALUE Process values

MSG_FILTER_COUNTER_FROM Internal message counter from

MSG_FILTER_COUNTER_TO Internal message counter to
MSG_FILTER_PROCESSMSG Process messages
MSG_FILTER_SYSMSG System messages
MSG_FILTER_BEDMSG Operator messages
MSG_FILTER_DATE Date from to
MSG_FILTER_TIME Time from to
MSG_FILTER_NR Message number from to
MSG_FILTER_VISIBLEONLY Display visible messages
MSG_FILTER_HIDDENONLY Display hidden messages
st
Date/time from - to
Where st[0] is the start time (from), st[1] the end time (to)
Assign these fields for the criteria: MSG_FILTER_DATE, MSG_FILTER_DATE_FROM,
MSG_FILTER_DATE_TO, MSG_FILTER_TIME, MSG_FILTER_TIME_FROM, bzw.
MSG_FILTER_TIME_TO
If the current time is needed to pass a SYSTEMTIME- parameter, use the GetLocalTime
function and not GetSystemTime.. There is usually a considerable difference between these
two functions.
dwMsgNr
Message number from - to
Where dwMsgNr[0] is start no. (from), dwMsgNr[1] the end no. (to)
Assign these fields for the criteria: MSG_FILTER_NR, MSG_FILTER_NR_FROM bzw.
MSG_FILTER_NR_TO
dwMsgClass
Message classes bit-coded.
Assign this field for the criterion: MSG_FILTER_CLASS
dwMsgType
Message type per alarm class, bit-coded
Assign this field for the criterion: MSG_FILTER_CLASS
dwMsgState
Message status bit-coded.
Assign this field for the criterion: MSG_FILTER_STATE
wAGNr
AGNr from - to
Assign these fields for the criteria: MSG_FILTER_AG_FROM or MSG_FILTER_AG_TO

wAGSubNr
AGSubNr from - to
Assign this field for the criteria: MSG_FILTER_AGSUB_FROM or MSG_FILTER_AGSUB_TO
dwArchivMode
Logging / reporting
Must be assigned 0.
szTB
Texts of the text blocks
Assign these fields for the criterion: MSG_FILTER_TEXT
dwTB
Active text blocks (from - to, bit-coded)
Assign this field for the criterion: MSG_FILTER_TEXT
dPValue
Process values from - to
Assign these fields for the criterion: MSG_FILTER_PVALUE
dwPValue
Active process values (from - to, bit-coded)
Assign this field for the criterion: MSG_FILTER_PVALUE
dwMsgCounter
Internal message counter from - to
Assign these fields for the criteria: MSG_FILTER_COUNTER_FROM,
MSG_FILTER_COUNTER_TO
dwQuickSelect
Quick selection for hour, day, month
The parameter is reserved for future upgrades and must be preset to 0.
Assign this field for the criterion: MSG_FILTER_QUICKSELECT
LOWORD Type:
MSG_FILTER_QUICK_MONTH Quick selection last n months

MSG_FILTER_QUICK_DAYS Quick selection last n days
MSG_FILTER_QUICK_HOUR Quick selection last n hours
HIWORD Number: 1...n

The end time of the quick selection refers to the current system time of the local computer.
The start time is calculated back n * ( months, days, hours ).

2.3.10 Structure definition MSG_RTDATA_STRUCT (RT Professional)
typedef struct {
DWORD dwMsgState;
DWORD dwMsgNr;
SYSTEMTIME stMsgTime;
DWORD dwTimeDiff;
DWORD dwCounter;
DWORD dwFlags;
WORD wPValueUsed;
WORD wTextValueUsed;
double dPValue[MSG_MAX_PVALUE];
MSG_TEXTVAL_STRUCT mtTextValue[MSG_MAX_PVALUE];
}
MSG_RTDATA_STRUCT;
Members
dwMsgState
Message status
MSG_STATE_COME 0x00000001 Message came in

MSG_STATE_GO 0x00000002 Message went out
MSG_STATE_QUIT 0x00000003 Message acknowledged
MSG_STATE_LOCK 0x00000004 Message locked
MSG_STATE_UNLOCK 0x00000005 Alarm locked
MSG_STATE_QUIT_SYSTEM 0x00000010 Message acknowledged by system
MSG_STATE_QUIT_EMERGENCY 0x00000011 Emergency acknowledgement
MSG_STATE_QUIT_HORN 0x00000012 Alarm alert acknowledgment
MSG_STATE_COMEGO 0x00000013 Message came in and went out, only displayed in the "Current
messages" display
MSG_STATE_UPDATE 0x00010000 Bit for message update
MSG_STATE_RESET 0x00020000 Bit for message reset
MSG_STATE_SUMTIME 0x00040000 Bit active for daylight savings time
MSG_STATE_INSTANCE 0x00080000 Bit for instance message (n messages of a no.)
dwMsgNr
Message number
stMsgTime
Date/Time: Telegram time depending on the calling function
dwTimeDiff
Duration coming/Telegram time in seconds
dwCounter
Internal message counter

dwFlags
Message flags in the database
MSG_FLAG_SUMTIME 0x00000001 Daylight savings time active

MSG_FLAG_COMMENT 0x00000002 Message has comments
MSG_FLAG_ARCHIV 0x00000004 Archiving
MSG_FLAG_PROTOCOL 0x00000008 Logging
MSG_FLAG_TEXTVALUES 0x00000010 Message has values accompanying the text
MSG_FLAG_TIMEINVALID 0x00000020 Bit for invalid date/time stamp
MSG_FLAG_INSTANCE 0x00000040 Instance message identification (185269)
wPValueUsed
Process values used, bit-coded. Every bit may only be set in one of the two structure elements
"wPValueUsed" or "wTextValueUsed". An accompanying value may either be a number or a
text.
wTextValueUsed
text values used, bit-coded. Every bit may only be set in one of the two structure elements
"wPValueUsed" or "wTextValueUsed". An accompanying value may either be a number or a
text.

Runtime API (RT Professional) 3
3.1 Runtime API (RT Professional)
Introduction
Runtime API describes the open programming interface of WinCC. By means of the API
functions, you make use of the internal functions of WinCC in separate applications and access
data of HMI tags or archive data.
Note
Siemens assumes no liability and makes no warranty that data and information transported
via API interfaces are compatible with software of third parties.
We expressly point out that improper use of the API interface can result in data loss or
production outage.
Examples:
● MSRTCreateMsgPlus(): Create alarm
● DMGetValue(): Get tag value
Requirements
● Programming environment is installed, e.g., MS Visual Studio
● WinCC Runtime Professional is installed.
Use
You use the API functions in the following places:
● Within WinCC: In user-defined C-functions and local C-scripts.
● Outside of WinCC: In Windows applications that are created in the C/C++ programming
language. To use Runtime API in the programming languages C# or VB.net, you must
program a corresponding conversion.
Include files and Lib files

In order to generate executable code, you require the Include files and Lib files. You can find
these files in the directory:
● %ProgramFiles%\SIEMENS\Automation\SCADA-RT_V11\WinCC\include
● %ProgramFiles%\SIEMENS\Automation\SCADA-RT_V11\WinCC\lib

Runtime API (RT Professional)
3.2 Data management functions (RT Professional)
3.2.1 Basics (RT Professional)
3.2.1.1 Overview of structures (RT Professional)
Overview
DM_CONNECTION_DATA (Page 1567) Connection data

DM_CONNKEY (Page 1568) List connection data (filter structure)
DM_CYCLE_INFO (Page 1569) Update cycles
DM_DATA_SERVICE (Page 1570) Data transport channel
DM_DIRECTORY_INFO (Page 1571) Path and file names of the configuration data
DM_DLGOPTIONS (Page 1572) Dialog specifications
DM_MACHINE_TABLE (Page 1574) Format conversion
DM_PROJECT_INFO (Page 1575) Project information
DM_SD_TARGET_APP (Page 1579) Specification of applications
DM_SD_TARGET_MACHINE (Page 1578) Computer information
DM_SEND_DATA_STRUCT (Page 1576) Specification of partners for data exchange
DM_TYPEREF (Page 1579) Tag type preference
DM_VAR_UPDATE_STRUCTEX (Page 1583) Get tag values
DM_VAR_UPDATE_STRUCT (Page 1581) Get tag values
DM_VARFILTER (Page 1586) Selection of tags
DM_VARGRP_DATA (Page 1588) Information about a tag group
DM_VARGRPKEY (Page 1589) Specification of a tag group
DM_VARIABLE_DATA4 (Page 1592) Including information about a tag group
DM_VARIABLE_DATA (Page 1590) Including information about a tag group
DM_FORMAT_INFO (Page 1573) Format conversion
DM_VARKEY (Page 1594) Specification of a tag
DM_VARLIMIT (Page 1597) Tag limits
MCP_NEWVARIABLE_DATA_4 (Page 1600) Tag definition
MCP_NEWVARIABLE_DATA_5 (Page 1602) Tag definition
MCP_NEWVARIABLE_DATA_EX4 (Page 1606) Tag definition
MCP_NEWVARIABLE_DATA_EX (Page 1604) Tag definition
MCP_NEWVARIABLE_DATA (Page 1598) Tag definition
MCP_VARIABLE_COMMON_EX (Page 1610) Tag description
MCP_VARIABLE_COMMON (Page 1608) Tag description
MCP_VARIABLE_LIMITS_EX (Page 1616) Tag limits
MCP_VARIABLE_LIMITS5 (Page 1614) Tag limits
MCP_VARIABLE_LIMITS (Page 1612) Tag limits
MCP_VARIABLE_PROTOCOL_EX (Page 1619) Tag limit handling

MCP_VARIABLE_PROTOCOL (Page 1617) Tag limit handling

MCP_VARIABLE_SCALES (Page 1620) Tag scaling
See also
Overview of the functions (Page 1549)
3.2.1.2 Overview of the functions (RT Professional)
Overview
DM_ENUM_CYCLES_PROC (Page 1642) List update cycles (callback)

DM_ENUM_FORMATS_PROC (Page 1639) List format conversions (callback)
DM_NOTIFY_PROC (Page 1633) Notification function
DMActivateRTProject (Page 1621) Activate project
DMChangeDataLocale (Page 1629) Language switch (notify applications)
DMConnect (Page 1630) Make connection to the Data Manager
DMDeactivateRTProject (Page 1635) Deactivate runtime project
DMDisconnect (Page 1636) Terminate connection to the Data Manager
DMEnumNumberFormats (Page 1638) List format conversions
DMEnumUpdateCycles (Page 1641) List update cycles
DMExitWinCCEx (Page 1645) Exit WinCC with defaults
DMExitWinCC (Page 1644) Exit WinCC
DMGetConnectionState (Page 1648) Query connection to the Data Manager
DMGetHotkey (Page 1650) Get hotkey ID
DMGetMachineInfo (Page 1651) Query startup parameters of an application
DMGetMachineTable (Page 1652) Query computer list
See also
DMGetDataLocale (Page 1649)
Overview of structures (Page 1548)
Conversion routines (Control Center) (Page 1561)

3.2.1.3 Quality codes of HMI tags (RT Professional)
Introduction
The "Quality Code" is required to evaluate the status and quality of a tag. The quality of the
entire value transfer and value processing of the respective HMI tag is summarized in the
indicated Quality Code. For example, it is possible to determine from the Quality Code whether
the current value is a start value or substitute value.
The quality codes are prioritized. If several codes occur at the same time, the Quality Code
reflecting the lowest quality is displayed.
Evaluation of Quality Codes

You can evaluate the Quality Code in a number of different ways:
● Evaluation with VB functions
● Evaluation with C functions
● Evaluation using the "Quality Code changed" event of an I/O field.
Note
In order to include the entire value transfer and value processing in the Quality Code for a
process tag, the connected automation system must support the Quality Code. When
configuring the PLC tags in the automation system, make sure there is enough memory
space for the Quality Code. In an S7 automation system, for example, the Quality Code
requires an additional byte, which is appended to the process value. To prevent errors, this
byte must be taken into account when configuring a tag, for instance at the end of a data
block.
Structure
The Quality Code has the following binary structure:
QQSSSSLL
Q: Quality
S: Substatus of the quality
L: Limits. This value is optional.
Note
The Quality Code shown in the "Quality" table are base values for the quality stages. Making
use of the substatus and limit elements gives rise to intermediate values over and above the
quality stage concerned.

Quality
The first two digits specify the quality of the tag.
Q Q S S S S L L
2 2 2 2 2 2 2 2
7 6 5 4 3 2 1 0
Bad - The value is not useful 0 0 - - - - - -

Uncertain - The quality of the value is less than normal, but the value may still 0 1 - - - - - -
be useful.
Good (Non-Cascade) - The quality of the value is good. Possible alarm condi‐ 1 0 - - - - - -
tions may be indicated by the sub-status.
Good (Cascade) - The value may be used in control. 1 1 - - - - - -
Substatus
The quality alone is not enough. Individual qualities are divided into substatuses. The Quality
Code is binary-coded. The value must be converted to hexadecimal format for analysis of the
Quality Code.
Quality Codes of Tags

Possible Quality Code are listed in the following table. At the top of the table, you find the
Quality Code reflecting the lowest quality, while the Quality Code reflecting the highest quality
is shown at the bottom of the table. The Quality Code representing the highest quality is
assigned the lowest priority, while the Quality Code representing the lowest quality is assigned
the highest priority. If several statuses occur for one tag in the process, the poorest code is
passed on.
Code Quality Q Q SSSSL L

(Hex)
0x23 Bad Device passivated - Diagnostic alerts inhibited 0 0 1 0 0 0 1 1
0x3F Bad Function check - Local override 0 0 1 1 1 1 1 1
0x1C Bad Out of Service - The value is not reliable because the block is 0 0 0 1 1 1 - -
not being evaluated, and may be under construction by a con‐
figurer. Set if the block mode is O/S.
0x73 Uncertain Simulated value - Start 0 1 1 1 0 0 1 1
0x74 Uncertain Simulated value - End 0 1 1 1 0 1 - -
0x84 Good Active Update event - Set if the value is good and the block 1 0 0 0 0 1 - -
(Non- has an active Update event.
Cascade)
0x24 Bad Maintenance alarm - More diagnostics available. 0 0 1 0 0 1 - -
0x18 Bad No Communication, with no usable value - Set if there has 0 0 0 1 1 0 - -
never been any communication with this value since it was
last "Out of Service".
0x14 Bad No Communication, with last usable value - Set if this value 0 0 0 1 0 1 - -
had been set by communication, which has now failed.
0x0C Bad Device Failure - Set if the source of the value is affected by a 0 0 0 0 1 1 - -
device failure.


(Hex)
0x10 Bad Sensor failure 0 0 0 1 0 0 - -
0x08 Bad Not Connected - Set if this input is required to be connected 0 0 0 0 1 0 - -
and is not connected.
0x04 Bad Configuration Error - Set if the value is not useful because 0 0 0 0 0 1 - -
there is some inconsistency regarding the parameterization
or configuration, depending on what a specific manufacturer
can detect.
0x00 Bad non-specific - There is no specific reason why the value is bad. 0 0 0 0 0 0 - -
Used for propagation.
0x28 Bad Process related - Substitute value 0 0 1 0 1 0 - -
0x2B Bad Process related - No maintenance 0 0 1 0 1 0 1 1
0x68 Uncertain Maintenance demanded 0 1 1 0 1 0 - -
0x60 Uncertain Simulated value - Set when the process value is written by the 0 1 1 0 0 0 - -
operator while the block is in manual mode.
0x64 Uncertain Sensor calibration 0 1 1 0 0 1 - -
0x5C Uncertain Configuration error 0 1 0 1 1 1 - -
0x58 Uncertain Sub-normal 0 1 0 1 1 0 - -
0x54 Uncertain Engineering Unit Range Violation - Set if the value lies outside 0 1 0 1 0 1 - -
of the set of values defined for this parameter. The Limits de‐
fine which direction has been exceeded.
0x50 Uncertain Sensor conversion not accurate 0 1 0 1 0 0 - -
0x4B Uncertain Substitute (constant) 0 1 0 0 1 0 1 1
0x78 Uncertain Process related - No maintenance 0 1 1 1 1 0 - -
0x4C Uncertain Initial Value - Value of volatile parameters during and after 0 1 0 0 1 1 - -
reset of the device or of a parameter.
0x48 Uncertain Substitute value - Predefined value is used instead of the cal‐ 0 1 0 0 1 0 - -
culated one. This is used for fail safe handling.
0x44 Uncertain Last Usable Value - Whatever was writing this value has stop‐ 0 1 0 0 0 1 - -
ped doing so. This is used for fail safe handling.
0x40 Uncertain Non-specific - There is no specific reason why the value is 0 1 0 0 0 0 - -
uncertain. Used for propagation.
0xE0 Good Initiate Fail Safe (IFS) - The value is from a block that wants 1 1 1 0 0 0 - -
(Cas‐ its downstream output block (e.g. AO) to go to Fail Safe.
cade)
0xD8 Good Local Override (LO) - The value is from a block that has been 1 1 0 1 1 0 - -
(Cas‐ locked out by a local key switch or is a Complex AO/DO with
cade) interlock logic active. The failure of normal control must be
propagated to a function running in a host system for alarm
and display purposes. This also implies "Not Invited".
0xD4 Good Do Not Select (DNS) - The value is from a block which should 1 1 0 1 0 1 - -
(Cas‐ not be selected, due to conditions in or above the block.
cade)
0xCC Good Not Invited (NI) - The value is from a block which does not 1 1 0 0 1 1 - -
(Cas‐ have a target mode that would use this input.
cade)


(Hex)
0xC8 Good Initialization Request (IR) - The value is an initialization value 1 1 0 0 1 0 - -
(Cas‐ for a source (back calculation input parameter), because the
cade) lower loop is broken or the mode is wrong.
0xC4 Good Initialization Acknowledge (IA) - The value is an initialized val‐ 1 1 0 0 0 1 - -
(Cas‐ ue from a source (cascade input, remote-cascade in, and re‐
cade) mote-output in parameters).
0xC0 Good OK - No error or special condition is associated with this value. 1 1 0 0 0 0 - -
(Cas‐
cade)
0xA0 Good Initiate fail safe 1 0 1 0 0 0 - -
(Non-
Cascade)
0x98 Good Unacknowledged Critical Alarm - Set if the value is good and 1 0 0 1 1 0 - -
(Non- the block has an unacknowledged Alarm with a priority greater
Cascade) than or equal to 8.
0x94 Good Unacknowledged Advisory Alarm - Set if the value is good and 1 0 0 1 0 1 - -
(Non- the block has an unacknowledged Alarm with a priority less
Cascade) than 8.
0x90 Good Unacknowledged Update event - Set if the value is good and 1 0 0 1 0 0 - -
(Non- the block has an unacknowledged Update event.
Cascade)
0x8C Good Active Critical Alarm - Set if the value is good and the block 1 0 0 0 1 1 - -
(Non- has an active Alarm with a priority greater than or equal to 8.
Cascade)
0x88 Good Active Advisory Alarm - Set if the value is good and the block 1 0 0 0 1 0 - -
(Non- has an active Alarm with a priority less than 8.
Cascade)
0xA8 Good Maintenance demanded 1 0 1 0 1 0 - -
(Non-
Cascade)
0xA4 Good Maintenance required 1 0 1 0 0 1 - -
(Non-
Cascade)
0xBC Good Function check - Local override 1 0 1 1 1 1 - -
(Non-
Cascade)
0x80 Good OK - No error or special condition is associated with this value. 1 0 0 0 0 0 - -
(Non-
Cascade)
Limit
The Quality Codes can be further subdivided by limits. Limits are optional.
Q Q S S S S L L
O.K. - The value is free to move. - - - - - - 0 0
Low limited - The value has acceded its low limits. - - - - - - 0 1

High limited - The value has acceded its high limits. - - - - - - 1 0

Constant (high and low limited) - The value cannot move, no matter what the - - - - - - 1 1
process does.
Quality Codes in Communication with OPC

For communication via "OPC", the Quality Codes that the OPC does not support are converted.
Quality Code in WinCC Quality Code in OPC

0x48 0x40
0x4C 0x40
0x5C 0x40
0x60 0x40
0x80...0xD4 0xC0
0xD8 0xC0
See also
SetTag (Page 1458)
GetTag (Page 1399)
3.2.1.4 VariableStateType property (RT Professional)
Description
Returns the type of tag supervision that dynamizes a property or event: No supervision, quality
code or tag status. Read access.
Index VariableStateType
0 hmiNoVariableState
1 hmiVariableQCState
2 hmiVariableState

Example
The "GetVariableStateType()" procedure reads the type of supervision for the current
document. In this example, the type of supervision is output in a message:
Sub GetVariableStateType()
'VBA819
Dim objDyn As HMIDynamicDialog
Set objDyn =
ActiveDocument.Properties("Width").CreateDynamic(hmiDynamicCreationTypeDynamicDialog,
"'TestVal'")
MsgBox objDyn.VariableStateType
objDyn.Delete
End Sub
See also
Conversion routines (Control Center) (Page 1561)
SetTag (Page 1458)
GetTag (Page 1399)
3.2.1.5 Constants (RT Professional)
General definitions
MAX_DM_OHIO_MACHINES 64 Maximum number of PCs in a project

MAX_DM_OHIO_APPLICATIONS 32 Maximum number of local client applications
MAX_DM_UPDATE_CYCLES 15 Maximum number of update cycles
MAX_DM_SYSTEM_CYCLES 10 Of total update cycles, 10 are system cycles
MAX_DM_USER_CYCLES 5 and 5 are user cycles
MAX_DM_VAR_NAME 128 Maximum length of a tag name
MAX_DM_TYPE_NAME 128 Maximum length of a data type name
MAX_DM_GROUP_NAME 64 Maximum length of a tag group name
MAX_DM_CYCLE_NAME 64 Maximum length of a cycle time text
MAX_DM_FORMAT_NAME 64 Maximum length of a format specification
MAX_DM_SCALE_NAME 64 Maximum length of a scaling specification
MAX_DM_SCALE_PARAM_NAME 64 Maximum length of a scaling parameter description
MAX_DM_MEMBER_NAME 32 Maximum length for members of combined types
MAX_DM_INFOTEXT_LEN 255 Maximum length of an info text
MAX_DM_SHIFT_NAME_LEN 32 Maximum length of a shift name
MAX_DM_SHIFTS 16 Maximum number of shifts per day

MAX_DM_SHIFT_HOLYDAYS 30 Maximum number of holidays in shift schedule

MAX_DM_SHIFT_HOLYNAME 64 Maximum length of the name of a holiday
MAX_DM_SERVICE_NAME 32 Maximum length of a service name
MAX_DM_APP_NAME 32 Maximum length of a logical application name
MAX_DM_DSN_NAME 32 Maximum length of data source name of the database
MAX_DM_UNIT_NAME 65 Maximum length of a unit
MAX_DM_CONNECTION_NAME 32 Maximum length of a connection
MAX_DM_VAR_SPECIFIC 25 Maximum length of the specific part of a tag in GAPI
MAX_DM_CON_SPECIFIC 128 Maximum length of the specific part of a connection
in GAPI
MAX_DM_CON_COMMON 128 Maximum length of the specific part of a connection
in GAPI
MAX_DM_VARTYPE_TEXT_LEN 255 Maximum length of a text tag
Tag types
DM_VARTYPE_BIT 1 Binary tag

DM_VARTYPE_SBYTE 2 Signed 8-bit value
DM_VARTYPE_BYTE 3 Unsigned 8-bit value
DM_VARTYPE_SWORD 4 Signed 16-bit value
DM_VARTYPE_WORD 5 Unsigned 16-bit value
DM_VARTYPE_SDWORD 6 Signed 32-bit value
DM_VARTYPE_DWORD 7 Unsigned 32-bit value
DM_VARTYPE_FLOAT 8 Floating-point number 32-bit IEEE 754
DM_VARTYPE_DOUBLE 9 Floating-point number 64-bit IEEE 754
DM_VARTYPE_TEXT_8 10 Text tag, 8-bit character set
DM_VARTYPE_TEXT_16 11 Text tag, 16-bit character set
DM_VARTYPE_RAW 12 Raw data type
DM_VARTYPE_STRUCT 14 Structure tag
DM_VARTYPE_TEXTREF 18 Text reference from text lib
Property flags
DM_SIMULATION_MODE 0x00000001 Tag is being simulated (no write access to

the process)
DM_INTERNAL_VAR 0x00000002 Internal tag
DM_EXTERNAL_VAR 0x00000004 External tag
DM_HAS_MIN_LIMIT 0x00000008 Tag has a fixed low limit
DM_HAS_MAX_LIMIT 0x00000010 Tag has a fixed high limit
DM_HAS_DEFAULT_VALUE 0x00000020 Tag has a substitute value
DM_HAS_STARTUP_VALUE 0x00000040 Tag has an initial value
DM_USE_DEFAULT_ON_STARTUP 0x00000080 Enter substitute value at system start
DM_USE_DEFAULT_ON_MAX 0x00000100 Enter substitute value when high limit is vio‐
lated

DM_USE_DEFAULT_ON_MIN 0x00000200 Enter substitute value when low limit is vio‐

lated
DM_USE_DEFAULT_ON_COMM_ER‐ 0x00000400 Substitute value on connection error
ROR
DM_WRITE_ACCESS_APPLICATION 0x00000800 Applications may write the tag
DM_WRITE_ACCESS_PROCESS 0x00001000 Tag may be written by the process
DM_INTERNAL_VAR_LOKAL 0x00002000 Internal tag, update 1 = Local computer / 0
= Project-wide
DM_INVISIBLE 0x00004000 Do not display tag on the interface in Control
Center
DM_EXTERNAL_LOCK 0x00008000 Tag generated externally and can only be
deleted externally
Logging flags
DM_NOTIFY_MAX_LIMIT 0x00000001 Log entry on reaching the high limit

DM_NOTIFY_MIN_LIMIT 0x00000002 Log entry on reaching the low limit
DM_NOTIFY_FORMAT_ERROR 0x00000004 Log entry on conversion error
DM_NOTIFY_ACCESS_FAULT 0x00000008 Log entry on prohibited write access
DM_NOTIFY_APPLICATION_WRITE 0x00000010 Log entry on write access by application
DM_NOTIFY_PROCESS_WRITE 0x00000020 Log entry on write access by process
Status flags
You can monitor the tag status of individual WinCC tags in Runtime. The tag status also
includes violations of the configured measuring range limits as well as the status of the
connection between WinCC and the automation system.
The quality code includes information about the quality of a tag, regardless of where this code
was formed. It takes into consideration the status of the entire value transfer and value
processing.
If a violation occurs at the low limit of the measuring range in the system, for example, the
quality code "0x55" is always reported. This measuring range violation can occur in the WinCC
data manager as well as in the field device. You can use the tag status to determine whether
this measuring range violation occurred in WinCC or before the value was transferred to
WinCC.
If the tag status reports a limit violation with the code 0x0010, for example, the low range limit
configured in WinCC has been violated. If the tag status does not report a limit violation, the
quality code transferred to WinCC already contained the limit violation.
0x0000 No error
DM_VARSTATE_NOT_ESTABLISHED 0x0001 Connection to partner not established
DM_VARSTATE_HANDSHAKE_ERROR 0x0002 Protocol error
DM_VARSTATE_HARDWARE_ERROR 0x0004 Network module defective
DM_VARSTATE_MAX_LIMIT 0x0008 Configured high limit violated
DM_VARSTATE_MIN_LIMIT 0x0010 Configured low limit violated
DM_VARSTATE_MAX_RANGE 0x0020 Format limit exceeded

DM_VARSTATE_MIN_RANGE 0x0040 Format limit fallen below

DM_VARSTATE_CONVERSION_ERROR 0x0080 Display conversion error (in conjunction with
DM_VARSTATE_..._RANGE))
DM_VARSTATE_STARTUP_VALUE 0x0100 Initial value of tag
DM_VARSTATE_DEFAULT_VALUE 0x0200 Substitute value of tag
DM_VARSTATE_ADDRESS_ERROR 0x0400 Addressing error in channel
DM_VARSTATE_INVALID_KEY 0x0800 Tag not found/not available
DM_VARSTATE_ACCESS_FAULT 0x1000 Access to tag denied
DM_VARSTATE_TIMEOUT 0x2000 Timeout/no feedback from channel
DM_VARSTATE_SERVERDOWN 0x4000 Server is down
Notification classes
DM_NOTIFY_CLASS_ERROR 0x00000001 Notification code contains error ID

DM_NOTIFY_CLASS_WARNING 0x00000002 Notification code contains warning
DM_NOTIFY_CLASS_DATA 0x00000003 Notification code contains data type
Notification codes
DM_NOTIFY_SHUTDOWN 0x00000001 Class Error : Data Manager is shutting

down
DM_NOTIFY_PROCESSNET_ERROR 0x00000002 Class Error : Error on process bus
DM_NOTIFY_SYSNET_ERROR 0x00000003 Class Error : Error on system bus
DM_NOTIFY_QUEUE_50_PERCENT 0x00000001 Class Warning : Fill level of application
queue 50%
queue 60%
queue 70%
queue 80%
queue 90%
DM_NOTIFY_QUEUE_OVERFLOW 0x00000006 Class Warning : Application queue over‐
flow
DM_NOTIFY_CYCLES_CHANGED 0x00000010 Class Warning => Read in cycles again
DM_NOTIFY_MACHINES_CHANGED 0x00000011 Class Warning : Computer list
DM_NOTIFY_PROJECT_OPENED 0x00000012 Class Warning: Project is being loaded
DM_NOTIFY_PROJECT_CLOSED 0x00000013 Class Warning: Project is being closed
DM_NOTIFY_SYSTEM_LOCALE 0x00000014 Switch language (resources)
DM_NOTIFY_DATA_LOCALE 0x00000015 Switch language (configuration data)
DM_NOTIFY_PROJECT_RUNTIME 0x00000016 Project activated in runtime mode
DM_NOTIFY_PROJECT_EDIT 0x00000017 Runtime mode for project deactivated
DM_NOTIFY_HOTKEY_CHANGE 0x00000018 The hotkeys have changed
DM_NOTIFY_APPLICATION_DATA 0x00000001 Class Data : Data sent by application

DM_NOTIFY_VARIABLE_DATA 0x00000002 Class Data : Tag data

DM_NOTIFY_SERVERDOWN 0x00000022 Server is down
DM_NOTIFY_SERVERUP 0x00000023 Server is ready for operation
Computer type
Computer type 0 Server

1 Client
Registered messages
DM_OHIOLANGUAGE "WM_OHIOLANGUAGE"
Internal system tag

DM_VAR_CURRENT_LANGUAGE "OHIOCurrentLanguage"
See also
3.2.1.6 Error messages (RT Professional)
Overview
The following error messages can be returned by the API functions in the CMN_ERROR error
structure:
DM_E_SYS_ERROR 0x10000000 If this bit is set in dwError1 of error

structure CMN_ERROR, then dwEr‐
ror2 contains the system error code.
DM_E_OK 0x00000000 No error
DM_E_CANCEL 0x00000001 User has selected "Cancel" in a dia‐
log
DM_E_FILE 0x00000002 Error during file operation
DM_E_UPDATE 0x00000003 Updating project
DM_E_NO_RT_PRJ 0x00000004 No project in runtime mode
DM_E_NOT_SUPPORTED 0x00000005 Requested service unavailable
DM_E_ALREADY_CONNECTED 0x00000006 Connection to the Data Manager al‐
ready established
DM_E_NOT_CONNECTED 0x00000007 No connection to the Data Manager
DM_E_INVALID_TAID 0x00000008 Invalid transaction ID
DM_E_INVALID_KEY 0x00000009 Tag not found
DM_E_INVALID_TYPE 0x0000000A Invalid tag type
DM_E_MAX_LIMIT 0x0000000B High limit of the tag violated

DM_E_MIN_LIMIT 0x0000000C Low limit of the tag violated

DM_E_MAX_RANGE 0x0000000D High limit of the format conversion
violated
DM_E_MIN_RANGE 0x0000000E Low limit of the format conversion
violated
DM_E_ACCESS_FAULT 0x0000000F Prohibited write access to a tag
DM_E_TIMEOUT 0x00000010 Timeout error
DM_E_ALREADY_EXIST 0x00000011 Object to be created already exists
DM_E_PARAM 0x00000012 Invalid parameter
DM_E_INV_PRJ 0x00000013 Cannot find/load specified project
DM_E_UNKNOWN 0x00000014 Unknown error
DM_E_OOM 0x00000015 Insufficient free memory available
DM_E_NOT_CREATED 0x00000016 Project could not be created
DM_E_MACHINE_NOT_FOUND 0x00000017 Computer not found
DM_E_NO_INFO_FOUND 0x00000018 Cannot find startup information
DM_E_INTERNAL 0x00000019 Internal processing error
DM_E_INVALID_LOCALE 0x0000001A Incorrect local ID
DM_E_COMMUNICATION 0x0000001B Incorrect local ID
DM_E_DONT_EXIST 0x0000001C Object does not exist
e.g.: attempt was made to create a
tag, and specified connection does
not exist
DM_E_ALREADY_ACTIVATED 0x0000001D Project is in runtime mode
e.g.: attempt is made to activate a
project that is already in runtime
mode.
DM_E_NO_OPEN_PROJECT 0x0000001E No project is open.
DM_E_ALREADY_DEACTIVATED 0x0000001F Project is not in runtime mode
DM_E_NO_RIGHTS 0x00000020 Wrong CreatorID transferred
DM_E_NOT_DELETED 0x00000021 Object could not be deleted
DM_E_LICENSE 0x00000022 Software protection: No license
DM_E_LICENSE_LIMIT 0x00000023 Software protection: Limit reached/
exceeded
DM_E_INVALID_OBJECTTYPE 0x00000024 Invalid object type
DM_E_OP_REQUIERES_PRJEDITMODE 0x00000025 Project is in runtime mode
e.g.: operation requires that the
project is not activated.
DM_E_INTERFACE 0x00000026 Internal error while accessing interfa‐
ces
DM_E_UNIT_NOT_FOUND 0x00000027 Unit not found
DM_E_CONNECTION_NOT_FOUND 0x00000028 Connection not found
See also
CMN_ERROR (Page 2497)

3.2.1.7 Conversion routines (Control Center) (RT Professional)
Overview
No. Conversion routines for the "Signed 8-bit value" data type
0 CharToSignedByte
1 CharToUnsignedByte
2 CharToUnsignedWord
3 CharToUnsignedDword
4 CharToSignedWord
5 CharToSignedDword
6 CharToMSBByte
7 CharToMSBWord
8 CharToMSBDword
9 CharToBCDByte
10 CharToBCDWord
11 CharToBCDDword
12 CharToSignedBCDByte
13 CharToSignedBCDWord
14 CharToSignedBCDDword
15 CharToExtSignedBCDByte
16 CharToExtSignedBCDWord
17 CharToExtSignedBCDDword
18 CharToAikenByte
19 CharToAikenWord
20 CharToAikenDword
21 CharToSignedAikenByte
22 CharToSignedAikenWord
23 CharToSignedAikenDword
24 CharToExcessByte
25 CharToExcessWord
26 CharToExcessDword
27 CharToSignedExcessByte
28 CharToSignedExcessWord
29 CharToSignedExcessDword
> 29 (CharToSignedByte)
No. Conversion routines for the "Unsigned 8-bit value" data type
0 ByteToUnsignedByte
1 ByteToUnsignedWord
2 ByteToUnsignedDword
3 ByteToSignedByte

4 ByteToSignedWord
5 ByteToSignedDword
6 ByteToBCDByte
7 ByteToBCDWord
8 ByteToBCDDword
9 ByteToAikenByte
10 ByteToAikenWord
11 ByteToAikenDword
12 ByteToExcessByte
13 ByteToExcessWord
14 ByteToExcessDword
> 14 (ByteToUnsignedByte)
No. Conversion routines for the "Signed 16-bit value"

data type
0 ShortToSignedWord
1 ShortToUnsignedByte
2 ShortToUnsignedWord
3 ShortToUnsignedDword
4 ShortToSignedByte
5 ShortToSignedDword
6 ShortToMSBByte
7 ShortToMSBWord
8 ShortToMSBDword
9 ShortToBCDByte
10 ShortToBCDWord
11 ShortToBCDDword
12 ShortToSignedBCDByte
13 ShortToSignedBCDWord
14 ShortToSignedBCDDword
15 ShortToExtSignedBCDByte
16 ShortToExtSignedBCDWord
17 ShortToExtSignedBCDDword
18 ShortToAikenByte
19 ShortToAikenWord
20 ShortToAikenDword
21 ShortToSignedAikenByte
22 ShortToSignedAikenWord
23 ShortToSignedAikenDword
24 ShortToExcessByte
25 ShortToExcessWord
26 ShortToExcessDword
27 ShortToSignedExcessByte

28 ShortToSignedExcessWord
29 ShortToSignedExcessDword
> 29 (ShortToSignedWord)
No. Conversion routines for the "Unsigned 16-bit val‐

ue" data type
0 WordToUnsignedWord
1 WordToUnsignedByte
2 WordToUnsignedDword
3 WordToSignedByte
4 WordToSignedWord
5 WordToSignedDword
6 WordToBCDByte
7 WordToBCDWord
8 WordToBCDDword
9 WordToAikenByte
10 WordToAikenWord
11 WordToAikenDword
12 WordToExcessByte
13 WordToExcessWord
14 WordToExcessDword
15 WordToSimaticBCDCounter
16 WordToSimaticCounter
> 16 (WordToUnsignedWord)
No. Conversion routines for the "Signed 32-bit value"

data type
0 LongToSignedDword
1 LongToUnsignedByte
2 LongToUnsignedWord
3 LongToUnsignedDword
4 LongToSignedByte
5 LongToSignedWord
6 LongToMSBByte
7 LongToMSBWord
8 LongToMSBDword
9 LongToBCDByte
10 LongToBCDWord
11 LongToBCDDword
12 LongToSignedBCDByte
13 LongToSignedBCDWord
14 LongToSignedBCDDword

15 LongToExtSignedBCDByte
16 LongToExtSignedBCDWord
17 LongToExtSignedBCDDword
18 LongToAikenByte
19 LongToAikenWord
20 LongToAikenDword
21 LongToSignedAikenByte
22 LongToSignedAikenWord
23 LongToSignedAikenDword
24 LongToExcessByte
25 LongToExcessWord
26 LongToExcessDword
27 LongToSignedExcessByte
28 LongToSignedExcessWord
29 LongToSignedExcessDword
30 LongToSimaticBCDTimer
31 (LongToSignedDword)
34 LongToSimaticTimer
> 34 (LongToSignedDword)
No. Conversion routines for the "Unsigned 32-bit val‐

ue" data type
0 DwordToUnsignedDword
1 DwordToUnsignedByte
2 DwordToUnsignedWord
3 DwordToSignedByte
4 DwordToSignedWord
5 DwordToSignedDword
6 DwordToBCDByte
7 DwordToBCDWord
8 DwordToBCDDword
9 DwordToAikenByte
10 DwordToAikenWord
11 DwordToAikenDword
12 DwordToExcessByte
13 DwordToExcessWord
14 DwordToExcessDword
15 DwordToSimaticBCDTimer
16 (DwordToUnsignedDword)

19 DwordToSimaticTimer
> 19 (DwordToUnsignedDword)
No. Conversion routines for the "Floating-point num‐

ber 32-bit IEEE 754" data type
0 FloatToFloat
1 FloatToUnsignedByte
2 FloatToUnsignedWord
3 FloatToUnsignedDword
4 FloatToSignedByte
5 FloatToSignedWord
6 FloatToSignedDword
7 FloatToDouble
8 FloatToMSBByte
9 FloatToMSBWord
10 FloatToMSBDword
11 FloatToBCDByte
12 FloatToBCDWord
13 FloatToBCDDword
14 FloatToSignedBCDByte
15 FloatToSignedBCDWord
16 FloatToSignedBCDDword
17 FloatToExtSignedBCDByte
18 FloatToExtSignedBCDWord
19 FloatToExtSignedBCDDword
20 FloatToAikenByte
21 FloatToAikenWord
22 FloatToAikenDword
23 FloatToSignedAikenByte
24 FloatToSignedAikenWord
25 FloatToSignedAikenDword
26 FloatToExcessByte
27 FloatToExcessWord
28 FloatToExcessDword
29 FloatToSignedExcessByte
30 FloatToSignedExcessWord
31 FloatToSignedExcessDword
32 FloatToSimaticBCDTimer
33 (FloatToFloat)
34 (FloatToFloat)
35 (FloatToFloat)
36 FloatToS5Float

37 FloatToSimaticTimer
> 37 (FloatToFloat)
No. Conversion routines for the "Floating-point num‐

ber 64-bit IEEE 754" data type
0 DoubleToDouble
1 DoubleToUnsignedByte
2 DoubleToUnsignedWord
3 DoubleToUnsignedDword
4 DoubleToSignedByte
5 DoubleToSignedWord
6 DoubleToSignedDword
7 DoubleToFloat
8 DoubleToMSBByte
9 DoubleToMSBWord
10 DoubleToMSBDword
11 DoubleToBCDByte
12 DoubleToBCDWord
13 DoubleToBCDDword
14 DoubleToSignedBCDByte
15 DoubleToSignedBCDWord
16 DoubleToSignedBCDDword
17 DoubleToExtSignedBCDByte
18 DoubleToExtSignedBCDWord
19 DoubleToExtSignedBCDDword
20 DoubleToAikenByte
21 DoubleToAikenWord
22 DoubleToAikenDword
23 DoubleToSignedAikenByte
24 DoubleToSignedAikenWord
25 DoubleToSignedAikenDword
26 DoubleToExcessByte
27 DoubleToExcessWord
28 DoubleToExcessDword
29 DoubleToSignedExcessByte
30 DoubleToSignedExcessWord
31 DoubleToSignedExcessDword
32 DoubleToSimaticBCDTimer
33 (DoubleToDouble)
34 (DoubleToDouble)
35 (DoubleToDouble)
36 DoubleToS5Float

37 DoubleToSimaticTimer
> 37 (DoubleToDouble)
See also
3.2.2 Structures (RT Professional)
3.2.2.1 DM_CONNECTION_DATA (RT Professional)
Declaration
typedef struct {
CHAR szConnection[
MAX_DM_CONNECTION_NAME +3];
CHAR szUnitName[MAX_DM_UNIT_NAME +1];
CHAR szCommon[MAX_DM_CON_COMMON +1];
CHAR szSpecific[MAX_DM_CON_SPECIFIC +1];
DWORD dwVarNum;
}
DM_CONNECTION_DATA;
Members
szConnection
Name of the logical connection
szUnitName
Names of the channel unit
szCommon
The parameter is reserved for future development.
szSpecific
szSpecific contains the address parameters for the connection, e.g. Ethernet address, slot
number.... Refer to the communication manual for PLC-specific details.
This is the same value that is displayed in the Parameter column of the properties of a tag in
WinCC.
dwVarNum
Number of assigned tags

Required files
dmclient.h
API functions
DM_ENUM_CONNECTION_PROC (Page 1794) List connection data (callback)
See also
DM_ENUM_CONNECTION_PROC (Page 1794)
3.2.2.2 DM_CONNKEY (RT Professional)
Declaration
typedef struct {
CHAR szName[ MAX_DM_CONNECTION_NAME + 1 ];
LPVOID lpvUserData;
}
DM_CONNKEY;
Members
szName
Name of the logical connection
lpvUserData
Pointer to application-specific data
Required files
dmclient.h
API functions
DMEnumConnectionData (Page 1791) List connection data
See also
DMEnumConnectionData (Page 1791)

3.2.2.3 DM_CYCLE_INFO (RT Professional)
Declaration
typedef struct {
DWORD dwCycleTime;
DWORD dwCycleIndex;
char szDescription[ MAX_DM_CYCLE_NAME + 1 ];
}
DM_CYCLE_INFO;
Members
dwCycleTime
Time base of the update cycle
dwCycleIndex
identifies the order within the list of update cycles.
"On change" Index: 0

"250ms" Index: 1
: :
"User cycle 5" Index: 15
szDescription
Description of the update cycle.
Required files
dmclient.h
API functions
See also
DM_ENUM_CYCLES_PROC (Page 1642)

3.2.2.4 DM_DATA_SERVICE (RT Professional)
Declaration
typedef struct {
DWORD dwTeleType;
char szService[MAX_DM_SERVICE_NAME + 1];
char szSendingApp[MAX_DM_APP_NAME + 1];
DWORD dwSendingMachine;
DWORD dwDataSize;
BYTE byData[1];
}
DM_DATA_SERVICE;
Members
dwTeleType
The parameter is reserved for future development and must be preset to 0.
szService
Name of the data transport channel. This name corresponds to the one assigned during the
installation of the service (DMInstallDataService).
szSendingApp
logical name of the sender. This name corresponds to the application name specified for
DMConnect.
dwSendingMachine
Index of the computer from which the packet was sent (0 - .63). All computers registered in
the computer list can be accessed by their index for the API functions. The first entry in the
computer list has the index "0".
dwDataSize
Size of the data packet in bytes:Data[0] ... byData[dwDataSize - 1]
byData
Pointer to the data
Required files
dmclient.h
API functions
DM_DATA_SERVICE_PROC (Page 1670) List data transport channels (callback), install data
transport channel (callback)

See also
DM_DATA_SERVICE_PROC (Page 1670)
3.2.2.5 DM_DIRECTORY_INFO (RT Professional)
Declaration
typedef struct {
char szProjectDir[_MAX_PATH + 1 ];
char szProjectAppDir[_MAX_PATH + 1 ];
char szGlobalLibDir[_MAX_PATH + 1 ];
char szProjectLibDir[_MAX_PATH + 1 ];
char szLokalProjectAppDir[_MAX_PATH + 1 ];
}
DM_DIRECTORY_INFO;
Members
szProjectDir
Full path of the project directory, e.g. D:\WinCC\Projekt1
szProjectAppDir
Full path of the subdirectory of the application in the project directory, e.g.:D:\WinCC
\Projekt1\GraCS
szGlobalLibDir
Full path of the cross-project library directory, e.g. D:\WinCC\aplib
szProjectLibDir
Full path of the project-based library directory, e.g. D:\WinCC\Projekt1\Library
szLokalProjectAppDir
Full path of the subdirectory of the application in the project directory on the local computer.
Required files
dmclient.h
API functions
DMGetProjectDirectory (Page 1659) Get path and file names of the configuration data

See also
DMGetProjectDirectory (Page 1659)
3.2.2.6 DM_DLGOPTIONS (RT Professional)
Declaration
typedef struct {
DWORD dwFlags;
LPRECT lprcPreference;
DM_TEST_DROP_TARGET_PROC lpfnTestDropTarget;
DM_DROP_TARGET_PROC lpfnDropTarget;
LPVOID lpvUser;
}
DM_DLGOPTIONS;
Members
dwFlags
dwFlags is used to specify the reaction of the dialog or dialog box:
DM_DLG_NOT_MODAL The tag dialog is not modal.

DM_DLG_NOT_MOVEABLE The dialog box is not movable.
DM_DLG_DRAGDROP Objects in the dialog box can be edited with drag-
and-drop.
lprcPreference
Pointer to a RECT type structure with information about the size of the dialog box. If
lprcPreference == NULL, the dialog appears centered and with a predefined size.
lpfnTestDropTarget
The parameter is reserved for future development and must be preset to NULL.
lpfnDropTarget
lpvUser
Pointer to application-specific data.
Required files
dmclient.h

API functions
DMShowVarDatabase (Page 1758) Open tag selection dialog

DMShowVarDatabaseMulti (Page 1763) Open tag selection dialog
See also
DMShowVarDatabase (Page 1758)
DMShowVarDatabaseMulti (Page 1763)
3.2.2.7 DM_FORMAT_INFO (RT Professional)
Declaration
typedef struct {
DWORD dwID;
char szName[MAX_DM_FORMAT_NAME + 1];
}
DM_FORMAT_INFO;
Members
dwID
Number of the conversion routine to be used. You can find more detailed information in the
"Conversion routines" section.
szName
Name of the conversion routine to be used. You can find more detailed information in the
Required files
dmclient.h
API functions
See also
DM_ENUM_FORMATS_PROC (Page 1639)

3.2.2.8 DM_MACHINE_TABLE (RT Professional)
Declaration
typedef struct {
LONG nNumMachines;
LONG nLocalMachine;
DM_SD_TARGET_MACHINE tm[MAX_DM_OHIO_MACHINES];
}
DM_MACHINE_TABLE;
Members
nNumMachines
Number of computers in the project (the max. number MAX_DM_OHIO_MACHINES may not
be exceeded).
nLocalMachine
Index of the entry of the local computer in the computer list.
All computers registered in the computer list can be accessed by their index for the API
functions. The first entry in the computer list has the index "0".
tm
Full DM_SD_TARGET_MACHINE (Page 1578) type array with information about the
computers involved in the project. Only nNumMachines of these structures are passed here,
however (therefore max. usable index = (nMumMachines - 1) ).
Required files
dmclient.h
API functions
DMGetMachineTable (Page 1652) Query computer list
See also
DM_SD_TARGET_MACHINE (Page 1578)
DMGetMachineTable (Page 1652)

3.2.2.9 DM_PROJECT_INFO (RT Professional)
Declaration
typedef struct {
char szProjectFile[ _MAX_PATH + 1 ];
char szDSNName[ MAX_DM_DSN_NAME + 1 ];
DWORD dwDataLocale;
}
DM_PROJECT_INFO;
Members
szProjectFile
File name of the project, including path and extension.
szDSNName
Data source name of the database
dwDataLocale
Code of the language that is used during configuration.
Required files
dmclient.h
API functions
DM_ENUM_OPENED_PROJECTS_PROC List projects (open) (callback)

(Page 1657)
DMEnumOpenedProjects (Page 1656) Get project information
See also
DM_ENUM_OPENED_PROJECTS_PROC (Page 1657)
DMEnumOpenedProjects (Page 1656)
DMGetProjectInformation (Page 1660)

3.2.2.10 DM_SEND_DATA_STRUCT (RT Professional)
Declaration
typedef struct {
BOOL fHighPriority;
char szService[MAX_DM_SERVICE_NAME + 1];
DWORD dwTargetMachineFlags;
DWORD dwTargetMachines;
DM_SD_TARGET_MACHINE dmTargetMachine[
MAX_DM_OHIO_MACHINES];
DWORD dwTargetApps;
DM_SD_TARGET_APP dmTargetApp[
MAX_DM_OHIO_APPLICATIONS];
DWORD dwDataSize;
BYTE byData[1];
}
DM_SEND_DATA_STRUCT;
Members
fHighPriority
fHighPriority indicates the priority for the data communication:
1 High priority
0 Normal priority
szService
Name of the service to be used. In order for an application to receive data, not only do the
conditions of dwTargetMachineFlags have to be met, but also the corresponding service has
to be installed through DMInstallDataService.
dwTargetMachineFlags
dwTargetMachineFlags indicate the applications to which data should be set with the
DMSendApplicationData function.
DM_SD_LOCAL Only to local applications (excludes all other flags!)

All other flags are currently not allowed and are reserved for
future development!
DM_SD_ALL_MACHINES To all computers in the project.
(The parameter is reserved for future development)
DM_SD_ALL_SERVERS To all servers in the project.
DM_SD_ALL_CLIENTS To all clients in the project.
DM_SD_RELATED_MACHINES To all clients that belong to the same server as the local host

DM_SD_FIRST_SERVER (The parameter is reserved for future development)

DM_SD_PRIMARY_SERVER (The parameter is reserved for future development)
DM_SD_EXCEPT_LOCAL To all computers, except local ones, that meet the address de‐
scription.
dwTargetMachines
Number of completed structures dmTargetMachine.
Reserved for future development, must be filled with 0.
dmTargetMachine
Pointer to the DM_SD_TARGET_MACHINE (Page 1578) structure for specifying the computer
to which the data is to be sent. Only the szMachineName parameter is relevant here.
Reserved for future development, should be fully initialized with 0L.
dwTargetApps
Number of completed structures dmTargetApp.
dmTargetApp
DM_SD_TARGET_APP (Page 1579) type structures contain the names of the applications to
which the data is to be sent.
dwDataSize
Amount of data to be sent in bytes
byData
Array containing the data to be sent
Comments
The DMSendApplicationData function is only implemented locally.
The members present in this structure for remote access are reserved for future development.
dwTargetMachineFlags can only be filled with DM_SD_LOCAL, any other specification results
in errors, and dwTargetMachines must be 0L.
Required files
dmclient.h
API functions
DMSendApplicationData (Page 1674) Data communication with applications

See also
DMSendApplicationData (Page 1674)
DM_SD_TARGET_MACHINE (Page 1578)
DM_SD_TARGET_APP (Page 1579)
3.2.2.11 DM_SD_TARGET_MACHINE (RT Professional)
Declaration
typedef struct {
BOOL fServer;
BOOL fLocal;
char szMachineName[
MAX_COMPUTERNAME_LENGTH + 1];
}
DM_SD_TARGET_MACHINE;
Members
fServer
Indicates whether the computer at hand is a server or a client.
The parameter is not relevant for the purposes of data communication
(DM_SEND_DATA_STRUCT).
fLocal
Indicates whether the querying application is running on the local computer or another
computer configured in the network.
The parameter is not relevant for the purposes of data communication
(DM_SEND_DATA_STRUCT).
szMachineName
Computer name
Comments
DM_SD_TARGET_MACHINE is part of the DM_MACHINE_TABLE (Page 1574) and
DM_SEND_DATA_STRUCT (Page 1576) structures.
Required files
dmclient.h

See also
DM_MACHINE_TABLE (Page 1574)
DM_SEND_DATA_STRUCT (Page 1576)
3.2.2.12 DM_SD_TARGET_APP (RT Professional)
Declaration
typedef struct {
char szAppName[MAX_DM_APP_NAME + 1];
}
DM_SD_TARGET_APP;
Members
szAppName
For szAppName, use the name of the application used for calling DMConnect.
Comments
DM_SD_TARGET_APP is part of the DM_SEND_DATA_STRUCT (Page 1576) structure.
Required files
dmclient.h
See also
3.2.2.13 DM_TYPEREF (RT Professional)
Declaration
typedef struct {
DWORD dwType;
DWORD dwSize;
char szTypeName[MAX_DM_TYPE_NAME + 1];
}
DM_TYPEREF;

Members
dwType
The type of tag is specified in dwType:
DM_VARTYPE_BIT Binary tag

DM_VARTYPE_SBYTE Signed 8-bit value
DM_VARTYPE_BYTE Unsigned 8-bit value
DM_VARTYPE_SWORD Signed 16-bit value
DM_VARTYPE_WORD Unsigned 16-bit value
DM_VARTYPE_SDWORD Signed 32-bit value
DM_VARTYPE_DWORD Unsigned 32-bit value
DM_VARTYPE_FLOAT Floating-point number 32-bit IEEE 754
DM_VARTYPE_DOUBLE Floating-point number 64-bit IEEE 754
DM_VARTYPE_TEXT_8 Text tag, 8-bit character set
DM_VARTYPE_RAW Raw data type
DM_VARTYPE_STRUCT Structure tag
DM_VARTYPE_TEXTREF Text reference from text lib
Values >=1024 User-defined structure types
This type ID is needed in some calls, for example, for filters to
identify a specific structure type.
dwSize
dwSize specifies the length of the data type (in bytes) on the OS.
szTypeName
The name of the structure type for structure tags is in szTypeName.
Comments
DM_TYPEREF is used in the DM_VAR_UPDATE_STRUCT (Page 1581) and
DM_VARIABLE_DATA (Page 1590) structures.
Required files
dmclient.h
API functions
DMGetVarType (Page 1728) Get data type of a tag

See also
DM_VAR_UPDATE_STRUCT (Page 1581)
DMGetVarType (Page 1728)
DM_VARIABLE_DATA (Page 1590)
DM_VAR_UPDATE_STRUCTEX (Page 1583)
DM_VARIABLE_DATA4 (Page 1592)
3.2.2.14 DM_VAR_UPDATE_STRUCT (RT Professional)
Declaration
typedef struct {
DM_VARKEY dmVarKey;
VARIANT dmValue;
DWORD dwState;
}
DM_VAR_UPDATE_STRUCT;
Members
dmTypeRef
The DM_TYPEREF (Page 1579) structure contains information on the tag type.
Exception: For performance reasons, nothing is entered into this structure in case of cyclic
requests.
dmVarKey
The tag to be processed is specified through the DM_VARKEY (Page 1594) structure.

dmValue
Tag value.
Note
The dmValue VARIANT must be initialized with VariantInit(&dmValue) before its first use and
then released with VariantClear(&dmValue) after its use.
Only an array of several DM_VAR_UPDATE_STRUCT can be pre-initialized before its first use
with ZeroMemory() or memset(). This affects the VARIANT dmValue contained here like a
VariantInit(&dmValue), since 0 corresponds to a VT_EMPTY.
The DM_VAR_UPDATE_STRUCT structure may not be cleared with ZeroMemory() or
memset() once it has been used. VARIANT then contains data that may be of the VT_BSTR
type.
If the tag type is VT_BSTR, problems can occur in memory management (memory leak), if no
VariantClear(&dmValue) is made before allocated DM_VAR_UPDATE_STRUCT structures
are deleted with delete[].
(0x0000) No error
DM_VARSTATE_NOT_ESTABLISHED (0x0001) Connection to partner not establish‐
ed
DM_VARSTATE_HANDSHAKE_ERROR (0x0002) Protocol error
DM_VARSTATE_HARDWARE_ERROR (0x0004) Network module faulty
DM_VARSTATE_MAX_LIMIT (0x0008) Configured high limit violated
DM_VARSTATE_MIN_LIMIT (0x0010) Configured low limit violated
DM_VARSTATE_MAX_RANGE (0x0020) High format limit violated
DM_VARSTATE_MIN_RANGE (0x0040) Low format limit violated
DM_VARSTATE_CONVERSION_ERROR (0x0080) Display conversion error (in conjunc‐
tion with DM_VAR‐
STATE_..._RANGE)
DM_VARSTATE_STARTUP_VALUE (0x0100) Initialization value of tag
DM_VARSTATE_DEFAULT_VALUE (0x0200) Substitute value of tag
DM_VARSTATE_ADDRESS_ERROR (0x0400) Addressing error in the channel
DM_VARSTATE_INVALID_KEY (0x0800) Tag not found / not available
DM_VARSTATE_ACCESS_FAULT (0x1000) Access to tag not permitted
DM_VARSTATE_TIMEOUT (0x2000) Timeout / no feedback from channel
DM_VARSTATE_SERVERDOWN (0x4000) Server is down
Required files
dmclient.h
API functions
DM_NOTIFY_VARIABLE_PROC (Page 1808) Get tag values (callback)

DMGetValue (Page 1691) Get tag values

See also
DM_NOTIFY_VARIABLE_PROC (Page 1808)
DM_VARKEY (Page 1594)
DMGetValue (Page 1691)
DM_TYPEREF (Page 1579)
3.2.2.15 DM_VAR_UPDATE_STRUCTEX (RT Professional)
Declaration
typedef struct {
DM_VARKEY dmVarKey;
VARIANT dmValue;
DWORD dwState;
DWORD dwQualityCode;
}
DM_VAR_UPDATE_STRUCTEX;
Members
dmTypeRef
Exception: For performance reasons, nothing is entered into this structure in case of cyclic
requests.
dmVarKey
The tag to be processed is specified through the DM_VARKEY (Page 1594) structure.

dmValue
Tag value.
Note
The VARIANT dmValue must be initialized with VariantInit(&dmValue) before its first use and
then released with VariantClear(&dmValue) after its use.
Only an array of several DM_VAR_UPDATE_STRUCT can be pre-initialized before its first use
with ZeroMemory() or memset(). This affects the VARIANT dmValue contained here like a
VariantInit(&dmValue), since 0 corresponds to a VT_EMPTY.
The DM_VAR_UPDATE_STRUCTEX structure may not be cleared with ZeroMemory() or
memset() once it has been used. VARIANT then contains data that may be of the VT_BSTR
type.
If the tag type is VT_BSTR, problems can occur in memory management (memory leak), if no
VariantClear(&dmValue) is made before allocated DM_VAR_UPDATE_STRUCTEX structures
are deleted with delete[].
dwState
Indicates whether the value of the tag was successfully changed or whether errors have
occurred:

DM_VARSTATE_HARDWARE_ERROR 0x0004 Network module faulty
DM_VARSTATE_MAX_RANGE 0x0020 High format limit violated
DM_VARSTATE_MIN_RANGE 0x0040 Low format limit violated
DM_VARSTATE_CONVERSION_ERROR 0x0080 Display conversion error (in conjunction
with DM_VARSTATE_..._RANGE)
DM_VARSTATE_STARTUP_VALUE 0x0100 Initialization value of tag
DM_VARSTATE_ADDRESS_ERROR 0x0400 Addressing error in the channel
DM_VARSTATE_INVALID_KEY 0x0800 Tag not found / not available
DM_VARSTATE_ACCESS_FAULT 0x1000 Access to tag not permitted
DM_VARSTATE_TIMEOUT 0x2000 Timeout / no feedback from channel
DM_VARSTATE_SERVERDOWN 0x4000 Server is down
dwQualityCode
Quality code of the tag value.
The quality code is formed as follows:
WinCC DM tag status Quality code according to Profibus PA/

OPC
DM_VARSTATE_SERVERDOWN (0x4000) Server is down Bad, out of service, 0x1C

DM_VARSTATE_HARDWARE_ERROR Network module faulty Bad, device failure, 0x0C

(0x0004)
DM_VARSTATE_NOT_ESTABLISHED Connection to partner not estab‐ Bad, not connected, 0x08
(0x0001) lished
DM_VARSTATE_TIMEOUT (0x2000) Timeout / no feedback from chan‐ Uncertain, last usable value, 0x44
nel
DM_VARSTATE_HANDSHAKE_ERROR Protocol error Bad, no communication (no usable val‐
(0x0002) ue), 0x18
DM_VARSTATE_ADDRESS_ERROR Addressing error in the channel Bad, configuration error, value not ac‐
(0x0400) cepted, 0x04
DM_VARSTATE_INVALID_KEY (0x0800) Tag not found / not available Bad, configuration error, value not ac‐
cepted, 0x04
DM_VARSTATE_ACCESS_FAULT (0x1000) Access to tag not permitted Bad, configuration error, value not ac‐
cepted, 0x04
DM_VARSTATE_MAX_RANGE (0x0020) High format limit violated Uncertain, engineering unit range viola‐
tion, high limit gesetzt, 0x56
DM_VARSTATE_MIN_RANGE (0x0040) Low format limit violated Uncertain, engineering unit range viola‐
tion, low limit gesetzt, 0x55
DM_VARSTATE_CONVERSION_ERROR Display conversion error Uncertain, engineering unit range viola‐
(0x0080) tion, ohne limits gesetzt, 0x54
DM_VARSTATE_MAX_LIMIT (0x0008) Configured high limit violated Indicate with Limit-Bit HIGH, 0x01, OR‐
ed together with the other tag status,
e.g. good (cascade), ok, results in 0xC2
DM_VARSTATE_MIN_LIMIT (0x0010) Configured low limit violated Indicate with Limit-Bit LOW, 0x02, OR‐
ed together with the other tag status,
e.g. good (cascade), ok, results in 0xC1
DM_VARSTATE_STARTUP_VALUE Initialization value of tag Uncertain, initial value, 0x4C
(0x0100)
DM_VARSTATE_DEFAULT_VALUE Substitute value of tag Uncertain, substitute-set, 0x48
(0x0200)
Required files
dmclient.h
API functions
DM_NOTIFY_VARIABLEEX_PROC (Page 1819) Get tag values (callback)

DMGetValueEx (Page 1693) Get tag values
See also
DM_NOTIFY_VARIABLEEX_PROC (Page 1819)
DMGetValueEx (Page 1693)

3.2.2.16 DM_VARFILTER (RT Professional)
Declaration
typedef struct {
DWORD dwFlags;
DWORD dwNumTypes;
LPDWORD pdwTypes;
LPSTR lpszGroup;
LPSTR lpszName;
LPSTR lpszConn;
}
DM_VARFILTER;
Members
dwFlags
The dwFlags parameter can be used to set a selection criterion for the tags:
DM_VARFILTER_TYPE 0x00000001 The tag type (pdwTypes) is used as the selection crite‐
rion.
DM_VARFILTER_GROUP 0x00000002 The group name (lpszGroup) is used as the selection
criterion.
DM_VARFILTER_NAME 0x00000004 The tag name (lpszName) is used as the selection cri‐
terion.
DM_VARFILTER_CONNECTION 0x00000008 The name of the logical connection (lpszConn) is used
as the selection criterion.
DM_VARFILTER_FAST_CALLBACK 0x00010000 (Flag for DMEnumVariables): If this flag is set, the call‐
back data is no longer buffered. The callback therefore
returns the data directly from the database.
The advantage of the flag is a faster response before
the first callback is sent. At the same time, it avoids
heavy memory load for a large amounts of data.
Caution
You may not call any other DMClient function in this
callback. A blockade may otherwise occur.
DM_VARFILTER_LOCAL_ONLY 0x00020000 (Flag for DMEnumVariables): If this flag is set, only local
tags are enumerated. Tags used in the project from oth‐
er servers are not required.
dwNumTypes
Number of tag types specified in pdwTypes.
pdwTypes
pdwTypes identifies the tag types that are to be used as a selection criterion.



The DM_VARTYPE_RAW, DM_VARTYPE_STRUCT and DM_VARTYPE_TEXTREF types

are not supported.
Specify the appropriate TypID in order to select structured tags with self-defined structures.
Use the GAPIEnumTypes function to determine the TypID.
lpszGroup
Pointer to the name of the tag group. This name should be used as a selection criterion.
Wildcards are prohibited.
lpszName
Pointer to the name of a tag. This name should be used as a selection criterion. Wildcards are
prohibited.
lpszConn
Pointer to the name of a logical connection. This name should be used as a selection criterion.
Wildcards are prohibited.
Required files
dmclient.h
API functions
DMEnumVariables (Page 1688) List tag names

See also
DMEnumVariables (Page 1688)

3.2.2.17 DM_VARGRP_DATA (RT Professional)
Declaration
typedef struct {
CHAR szName[ MAX_DM_VAR_NAME + 1 ];
DWORD dwCreatorID;
WORD dwVarNum;
LPVOID lpvUserData;
}
DM_VARGRP_DATA;
Members
szName
Name of the tag group
dwCreatorID
In the creator identification, you can determine who created an object.
The values 0 – 10100 and 11000 – 11100 are reserved for internal or specific systems.
dwVarNum
Number of tags within the tag group
lpvUserData
Required files
dmclient.h
API functions
DM_ENUM_VARGRP_PROC (Page 1687) List information about a tag group (callback)
See also
DM_ENUM_VARGRP_PROC (Page 1687)

3.2.2.18 DM_VARGRPKEY (RT Professional)
Declaration
typedef struct {
CHAR szName[ MAX_DM_VAR_NAME + 1 ];
LPVOID lpvUserData;
}
DM_VARGRPKEY;
Members
szName
Name of the tag group
lpvUserData
Required files
dmclient.h
API functions
DMEnumVarGrpData (Page 1683) List information about a tag group
See also
DMEnumVarGrpData (Page 1683)

3.2.2.19 DM_VARIABLE_DATA (RT Professional)
Declaration
typedef struct {
DM_VARLIMIT dmVarLimit;
VARIANT dmStart;
VARIANT dmDefault;
DWORD dwNotify;
DWORD dwFlags;
CHAR szSpecific[MAX_DM_VAR_SPECIFIC +1];
CHAR szGroup[MAX_DM_GROUP_NAME +1];
CHAR szConnection[
CHAR szChannel[_MAX_PATH +1];
CHAR szUnit[MAX_DM_UNIT_NAME +1];
}
DM_VARIABLE_DATA;
Members
dmTypeRef
dmVarLimit
The DM_VARLIMIT (Page 1597) structure contains information on the limits of a tag.
dmStart
Start value of the tag. Must be release with VariantClear(&dmStart) after use.
dmDefault
Substitute value of tag. Must be release with VariantClear(&dmDefault) after use.
dwNotify
dwNotify specifies the events that generate a report entry:
DM_NOTIFY_MAX_LIMIT 0x00000001 On reaching the high limit

DM_NOTIFY_MIN_LIMIT 0x00000002 On reaching the low limit
DM_NOTIFY_FORMAT_ERROR 0x00000004 On conversion error
DM_NOTIFY_ACCESS_FAULT 0x00000008 On prohibited write access
DM_NOTIFY_APPLICATION_WRITE 0x00000010 On write access by application
DM_NOTIFY_PROCESS_WRITE 0x00000020 On write access by process

dwFlags
indicates how the substitute value should be used:

DM_USE_DEFAULT_ON_STARTUP 0x00000080 Enter substitute value at system
start
DM_USE_DEFAULT_ON_MAX 0x00000100 Enter substitute value when high
limit is violated
DM_USE_DEFAULT_ON_MIN 0x00000200 Enter substitute value when low
limit is violated
DM_USE_DEFAULT_ON_COMM_ER‐ 0x00000400 Substitute value on connection
ROR error
szSpecific
szSpecific contains the address relationship of the tag, for example, data block and byte in the
block etc. Refer to the communication manual for PLC-specific details.
This is the same value that appears in the properties of a tag in WinCC in the Parameter column.
szGroup
Name of the group to which the tag belongs.
This value is not provided for server tags on the multi-client.
szConnection
Name of the logical connection to which the tag is linked.
szChannel
File name of the channel driver.
szUnit
Name of the channel unit to which the tag is linked.
Required files
dmclient.h
API functions
DM_ENUM_VARIABLE_PROC (Page 1678) List information about a tag (callback)
See also
DM_ENUM_VARIABLE_PROC (Page 1678)

DM_VARLIMIT (Page 1597)

DMEnumVarData (Page 1676)
3.2.2.20 DM_VARIABLE_DATA4 (RT Professional)
Declaration
typedef struct {
DM_VARLIMIT dmVarLimit;
VARIANT dmStart;
VARIANT dmDefault;
DWORD dwNotify;
DWORD dwFlags;
CHAR szSpecific[MAX_DM_VAR_SPECIFIC +1];
CHAR szGroup[MAX_DM_GROUP_NAME +1];
CHAR szConnection[
CHAR szChannel[_MAX_PATH +1];
CHAR szUnit[MAX_DM_UNIT_NAME +1];
MCP_VARIABLE_SCALES Scaling;
DWORD dwASDataSize;
DWORD dwOSDataSize;
DWORD dwVarProperty;
DWORD dwFormat;
}
DM_VARIABLE_DATA4;
Members
dmTypeRef
dmVarLimit
The DM_VARLIMIT (Page 1597) structure contains information on the limits of a tag.
dmStart
Start value of the tag. Must be release with VariantClear(&dmStart) after use.
dmDefault
Substitute value of tag. Must be release with VariantClear(&dmDefault) after use.
dwNotify
dwNotify specifies the events that generate a report entry:
DM_NOTIFY_MAX_LIMIT 0x00000001 On reaching the high limit

DM_NOTIFY_MIN_LIMIT 0x00000002 On reaching the low limit

DM_NOTIFY_FORMAT_ERROR 0x00000004 On conversion error

DM_NOTIFY_ACCESS_FAULT 0x00000008 On prohibited write access
DM_NOTIFY_APPLICATION_WRITE 0x00000010 On write access by application
DM_NOTIFY_PROCESS_WRITE 0x00000020 On write access by process
dwFlags
Indicates how the substitute value should be used:

DM_USE_DEFAULT_ON_STARTUP 0x00000080 Enter substitute value at system
start
DM_USE_DEFAULT_ON_MAX 0x00000100 Enter substitute value when high
limit is violated
DM_USE_DEFAULT_ON_MIN 0x00000200 Enter substitute value when low
limit is violated
DM_USE_DEFAULT_ON_COMM_ERROR 0x00000400 Substitute value on connection
error
szSpecific
WinCC.
szGroup
szConnection
Name of the logical connection to which the tag is linked.
szChannel
File name of the channel driver.
szUnit
Name of the channel unit to which the tag is linked.
Scaling
MCP_VARIABLE_SCALES (Page 1620) Structure with the description of tag scaling.
dwASDataSize
Length of the tags in the PLC (number of bits)
dwOSDataSize
Length of the tags in the OS (number of bits)

dwVarProperty
Indicates whether this is an internal or external tag:
DM_INTERNAL_VAR 0x00000002 Internal tag

DM_EXTERNAL_VAR 0x00000004 External tag
dwFormat
Number of the conversion routine used. You can find more detailed information in the
Required files
dmclient.h
API functions
DM_ENUM_VARIABLE_PROC4 (Page 1682) List information about a tag (callback)
See also
DMEnumVarData4 (Page 1679)
DM_ENUM_VARIABLE_PROC4 (Page 1682)
MCP_VARIABLE_SCALES (Page 1620)
3.2.2.21 DM_VARKEY (RT Professional)
Declaration
typedef struct {
DWORD dwKeyType;
DWORD dwID;
char szName[ MAX_DM_VAR_NAME + 1 ];
LPVOID lpvUserData;
}
DM_VARKEY;

Members
dwKeyType
dwKeyType defines whether the tag is to be addressed by a key ID or by its name.
DM_VARKEY_ID Specification via key ID

DM_VARKEY_NAME Specification via tag name
When DM_VARKEY is used as the return structure, both types can be set if the key ID and
tag name are returned.
When DM_VARKEY is used as a source parameter, the tag name should be preferably set,
since the server prefix can only be specified there. If the key ID is used, operation is always
local.
dwID
Contains the key ID of the tag, if dwKeyType is set accordingly.
szName
Contains the name of the tag, if dwKeyType is set accordingly.
lpvUserData
Comments
The DM_VARKEY structure is part of the DM_VAR_UPDATE_STRUCT (Page 1581) structure.
Required files
dmclient.h
API functions
DM_ENUM_TYPEMEMBERS_PROC_EX List tags in a structured tag (callback)

(Page 1783)
DM_ENUM_TYPEMEMBERS_PROC List tags in a structured tag (callback)
(Page 1779)
DM_ENUM_VAR_PROC (Page 1690) List tag names (callback)
DM_NOTIFY_SELECT_VAR_PROC (Page 1769) Open tag selection dialog (callback)
DMEnumVarData (Page 1676) List information about a tag
DMGetValueWait (Page 1704) Get tag values with update
DMGetVarLimits (Page 1721) Get limits of a tag
DMGetVarInfo (Page 1710) Get tag ID, get tag name
DMGetVarType (Page 1728) Get data type of a tag
DMSetValue (Page 1734) Change tag values

DMSetValueMessage (Page 1740) Change tag values with alarm output

DMSetValueWait (Page 1744) Change tag values with notification
DMSetValueWaitMessage (Page 1749) Change tag values with notification and alarm out‐
put
DMStartVarUpdate (Page 1806) Define update tags
See also
DMStartVarUpdate (Page 1806)
DMGetValueWait (Page 1704)
DMGetVarInfo (Page 1710)
DMGetVarLimits (Page 1721)
DMSetValue (Page 1734)
DMSetValueMessage (Page 1740)
DMSetValueWait (Page 1744)
DMSetValueWaitMessage (Page 1749)
DM_ENUM_VAR_PROC (Page 1690)
DM_ENUM_TYPEMEMBERS_PROC (Page 1779)
DM_ENUM_TYPEMEMBERS_PROC_EX (Page 1783)
DM_NOTIFY_SELECT_VAR_PROC (Page 1769)
DMStartVarUpdateEx (Page 1809)
DMGetValueWaitEx (Page 1706)
DM_ENUM_TYPEMEMBERS_PROC_EX4 (Page 1786)
MSG_CSDATA_STRUCT_PLUS (Page 2383)

3.2.2.22 DM_VARLIMIT (RT Professional)
Declaration
typedef struct {
VARIANT dmMaxRange;
VARIANT dmMinRange;
VARIANT dmMaxLimit;
VARIANT dmMinLimit;
}
DM_VARLIMIT;
Members
dmMaxRange
High limit of the format conversion
dmMinRange
Low limit of the format conversion
dmMaxLimit
High limit of the tag.
dmMinLimit
Low limit of the tag.
Comments
DM_VARLIMIT is part of the DM_VARIABLE_DATA (Page 1590) structure. All VARIANT must
be release with VariantClear(&dmxxx) after use.
Required files
dmclient.h
API functions
DMGetVarLimits (Page 1721) Get limits of a tag
See also

3.2.2.23 MCP_NEWVARIABLE_DATA (RT Professional)
Declaration
typedef struct {
DWORD dwFlags;
char szProjectFile[_MAX_PATH +1];
char szConnection[
char szVarName[MAX_DM_VAR_NAME +1];
char szGroupName[MAX_DM_GROUP_NAME +1];
MCP_VARIABLE_COMMON Common;
MCP_VARIABLE_PROTOCOL Protocol;
MCP_VARIABLE_LIMITS Limits;
char szSpecific[MAX_DM_VAR_SPECIFIC +1];
}
MCP_NEWVARIABLE_DATA;
Members
dwFlags
dwFlags indicates how the tag should be processed:
MCP_NVAR_FLAG_CREATE 1 Create tag

MCP_NVAR_FLAG_MODIFY 2 Change tag (not to be used in
RT)
MCP_NVAR_FLAG_TEST 3 Check for existence of a tag
The flags must not be ORed.
szProjectFile
Name of the project file, including path and extension.
The name of the project file can be determined with DMEnumOpenedProjects or in RT with
DMGetRuntimeProject.
If an empty string is entered, an internal DMEnumOpenedProjects is performed on the currently
open project.
Only the currently open project can be specified in runtime. Any other entry is rejected with an
error (DM_E_NOT_CONNECTED).
szConnection
Name of the logical connection assigned to the tag.
szVarName
Name of the tag to be processed.
szGroupName

If a specified group name is in a connection other than that specified in szConnection, the
group name is ignored without an error message and the tag is created directly in the
connection.
If a group name is specified that does not yet exist, the group is implicitly created.
When a tag is changed with MCP_NVAR_FLAG_MODIFY, a change in the group name is
ignored without an error message.
Common
MCP_VARIABLE_COMMON (Page 1608) Structure with the description of the tag.
Protocol
The MCP_VARIABLE_PROTOCOL (Page 1617) structure with the description of how limit
violations are handled by the tag.
Limits
MCP_VARIABLE_LIMITS (Page 1612) Structure with the limits of the tag.
szSpecific
WinCC.
Comments
The MCP_NEWVARIABLE_DATA_EX (Page 1604) structure has a similar use for extended
functionality.
Required files
dmclient.h
API functions
GAPICreateNewVariable (Page 1771) Create tag
See also
GAPICreateNewVariable (Page 1771)
MCP_VARIABLE_PROTOCOL (Page 1617)
MCP_VARIABLE_COMMON (Page 1608)
MCP_VARIABLE_LIMITS (Page 1612)
MCP_NEWVARIABLE_DATA_EX (Page 1604)

3.2.2.24 MCP_NEWVARIABLE_DATA_4 (RT Professional)
Declaration
typedef struct {
DWORD dwFlags;
char szConnection[
MCP_VARIABLE_LIMITS Limits;
}
MCP_NEWVARIABLE_DATA_4;
Members
dwFlags

MCP_NVAR_FLAG_MODIFY 2 Change tag (if not available, then
re-create) (not to be used in RT)
szProjectFile
The name of the project file can be determined with DMEnumOpenedProjects or in runtime
with DMGetRuntimeProject.
open project.
Only the currently open project can be specified in runtime. Any other specification is rejected
with the error, DM_E_NOT_CONNECTED.
szConnection
szVarName

szGroupName
connection.
Common
Protocol
Limits
MCP_VARIABLE_LIMITS (Page 1612) Structure with the limits of the tag.
szSpecific
WinCC.
Scaling
Comments
The MCP_NEWVARIABLE_DATA_EX4 (Page 1606) structure has a similar use for extended
functionality.
Required files
dmclient.h
API functions
GAPICreateNewVariable4 (Page 1772) Create tag

GAPICreateNewVariableEx4 (Page 1775) Create tag with Creator ID

See also
GAPICreateNewVariable4 (Page 1772)
MCP_NEWVARIABLE_DATA_EX4 (Page 1606)
GAPICreateNewVariableEx4 (Page 1775)
3.2.2.25 MCP_NEWVARIABLE_DATA_5 (RT Professional)
Declaration
typedef struct {
DWORD dwFlags;
char szConnection[
MCP_VARIABLE_LIMITS5 Limits;
}
MCP_NEWVARIABLE_DATA_5;
Members
dwFlags

MCP_NVAR_FLAG_MODIFY 2 Change tag (if not available, then
re-create) (not to be used in RT)
szProjectFile


open project.
szConnection
szVarName
szGroupName
connection.
Common
Protocol
Limits
MCP_VARIABLE_LIMITS5 (Page 1614) Structure with the limits of the tag.
szSpecific
WinCC.
Scaling
Comments
The MCP_NEWVARIABLE_DATA_EX4 (Page 1606) structure has a similar use for extended
functionality.
Required files
dmclient.h

API functions
GAPICreateNewVariable5 (Page 1774) Create tag with Creator ID
See also
MCP_VARIABLE_LIMITS5 (Page 1614)
3.2.2.26 MCP_NEWVARIABLE_DATA_EX (RT Professional)
Declaration
typedef struct {
DWORD dwFlags;
char szConnection[
MCP_VARIABLE_COMMON_EX Common;
MCP_VARIABLE_PROTOCOL_EX Protocol;
MCP_VARIABLE_LIMITS_EX Limits;
char szSpecific[MAX_DM_VAR_SPECIFIC +1]
}
MCP_NEWVARIABLE_DATA_EX;
Members
dwFlags

MCP_NVAR_FLAG_MODIFY 2 Change tag (not to be used in runtime)
MCP_NVAR_FLAG_TEST 3 Checks for existence of a tag.
szProjectFile

open project.
szConnection
szVarName
szGroupName
connection.
Common
MCP_VARIABLE_COMMON_EX (Page 1610) Structure with the description of the tag.
Protocol
The MCP_VARIABLE_PROTOCOL_EX (Page 1619) structure with the description of how limit
Limits
MCP_VARIABLE_LIMITS_EX (Page 1616) Structure with the limits of the tag.
szSpecific
WinCC.
Comments
The MCP_NEWVARIABLE_DATA (Page 1598) structure has a similar use.
Required files
dmclient.h

API functions

(Page 1783)
See also
MCP_NEWVARIABLE_DATA (Page 1598)
MCP_VARIABLE_COMMON_EX (Page 1610)
MCP_VARIABLE_LIMITS_EX (Page 1616)
MCP_VARIABLE_PROTOCOL_EX (Page 1619)
3.2.2.27 MCP_NEWVARIABLE_DATA_EX4 (RT Professional)
Declaration
typedef struct {
DWORD dwFlags;
char szConnection[
MCP_VARIABLE_COMMON_EX Common;
MCP_VARIABLE_PROTOCOL_EX Protocol;
MCP_VARIABLE_LIMITS_EX Limits;
char szSpecific[MAX_DM_VAR_SPECIFIC +1]
}
MCP_NEWVARIABLE_DATA_EX4;
Members
dwFlags

MCP_NVAR_FLAG_MODIFY 2 Change tag (not to be used in
RT)
MCP_NVAR_FLAG_TEST 3 Checks for existence of a tag.
szProjectFile

open project.
szConnection
szVarName
szGroupName
connection.
Common
MCP_VARIABLE_COMMON_EX (Page 1610) Structure with the description of the tag.
Protocol
The MCP_VARIABLE_PROTOCOL_EX (Page 1619) structure with the description of how limit
Limits
MCP_VARIABLE_LIMITS_EX (Page 1616) Structure with the limits of the tag.
szSpecific
WinCC.
Scaling
Comments
The MCP_NEWVARIABLE_DATA_4 (Page 1600) structure has a similar use.

Required files
dmclient.h
API functions
DM_ENUM_TYPEMEMBERS_PROC_EX4 List tags in a structured tag (callback)

(Page 1786)
See also
MCP_NEWVARIABLE_DATA_4 (Page 1600)
3.2.2.28 MCP_VARIABLE_COMMON (RT Professional)
Declaration
typedef struct {
DWORD dwVarType;
DWORD dwVarLength;
DWORD dwFormat;
}
MCP_VARIABLE_COMMON;
Members
dwVarType
The type of tag is specified in dwVarType:



dwVarLength
The specification of the tag length us only relevant for text tags DM_VARTYPE_TEXT_8 and
DM_VARTYPE_TEXT_16.
The text length is specified in characters here (1 to 255).
dwVarProperty
DM_INTERNAL_VAR Internal tag

DM_EXTERNAL_VAR External tag
dwFormat
Comments
MCP_VARIABLE_COMMON is part of the MCP_NEWVARIABLE_DATA (Page 1598) and
MCP_NEWVARIABLE_DATA_4 (Page 1600) structures.
The MCP_VARIABLE_COMMON_EX (Page 1610) structure has a similar use for extended
functionality.
Required files
dmclient.h
See also

3.2.2.29 MCP_VARIABLE_COMMON_EX (RT Professional)
Declaration
typedef struct {
DWORD dwVarType;
DWORD dwCreatorID
DWORD dwVarLength;
DWORD dwFormat;
DWORD dwOSOffset;
DWORD dwASOffset;
char szStructTypeName
}
MCP_VARIABLE_COMMON_EX;
Members
dwVarType
The type of tag is specified in dwVarType:

dwCreatorID
dwVarLength
The specification of the tag length us only relevant for text tags DM_VARTYPE_TEXT_8 and
DM_VARTYPE_TEXT_16. The text length is specified in characters here (1 to 255).

dwVarProperty
DM_INTERNAL_VAR Internal tag

DM_EXTERNAL_VAR External tag
dwFormat
dwOSOffset
dwASOffset
Offset in the buffer of the PLC
The bit-oriented ASOffset is handled internally in BYTE.
szStructTypeName
Name of the structure type
Comments
MCP_VARIABLE_COMMON_EX is part of the MCP_NEWVARIABLE_DATA_EX (Page 1604)
structure.
The MCP_VARIABLE_COMMON (Page 1608) structure has a similar use.
Required files
dmclient.h

See also
3.2.2.30 MCP_VARIABLE_LIMITS (RT Professional)
Declaration
typedef struct {
double dTopLimit;
double dBottomLimit;
double dStartValue;
double dSubstituteValue;
BOOL bTopLimit;
BOOL bBottomLimit;
BOOL bStartValue;
BOOL bConnectionErr;
BOOL bTopLimitValid;
BOOL bBottomLimitValid;
BOOL bStartValueValid;
BOOL bSubstValueValid;
}
MCP_VARIABLE_LIMITS;
Members
dTopLimit
Value of high limit of the tag
dBottomLimit
Value of low limit of the tag
dStartValue
Start value of the tag
dSubstituteValue
Substitute value of tag
bTopLimit
If this parameter is set, the substitute value should be used if the value of the tag exceeds the
value specified in dTopLimit.

bBottomLimit
If this parameter is set, the substitute value should be used if the value of the tag falls below
the value specified in dBottomLimit.
bStartValue
If this parameter is set, the substitute value should be used as a start value.
bConnectionErr
If this parameter is set, the substitute value should be used when when a connection error
occurs.
bTopLimitValid
If this parameter is set, the value specified in dTopLimit applies the high limit.
bBottomLimitValid
If this parameter is set, the value specified in dBottomLimit applies the low limit.
bStartValueValid
If this parameter is set, the value specified in dStartValue applies the start value.
bSubstValueValid
If this parameter is set, the value specified in dSubstitudeValue applies the substitute value.
Comments
MCP_VARIABLE_Limits is part of the MCP_NEWVARIABLE_DATA (Page 1598) and
The MCP_VARIABLE_LIMITS_EX (Page 1616) structure has a similar use for extended
functionality.
Required files
dmclient.h
See also

3.2.2.31 MCP_VARIABLE_LIMITS5 (RT Professional)
Declaration
typedef struct {
VARIANT varTopLimit;
VARIANT varBottomLimit;
VARIANT varStartValue;
VARIANT varSubstituteValue;
BOOL bTopLimit;
BOOL bBottomLimit;
BOOL bStartValue;
BOOL bConnectionErr;
BOOL bTopLimitValid;
BOOL bBottomLimitValid;
BOOL bStartValueValid;
BOOL bSubstValueValid;
}
MCP_VARIABLE_LIMITS5;
Members
varTopLimit
varBottomLimit
varStartValue
varSubstituteValue
bTopLimit
If this parameter is set, the substitute value should be used if the value of the tag exceeds the
value specified in dTopLimit.
bBottomLimit
If this parameter is set, the substitute value should be used if the value of the tag falls below
the value specified in dBottomLimit.
bStartValue
If this parameter is set, the substitute value should be used as a start value.

bConnectionErr
If this parameter is set, the substitute value should be used when when a connection error
occurs.
bTopLimitValid
If this parameter is set, the value specified in dTopLimit applies the high limit.
bBottomLimitValid
If this parameter is set, the value specified in dBottomLimit applies the low limit.
bStartValueValid
If this parameter is set, the value specified in dStartValue applies the start value.
bSubstValueValid
If this parameter is set, the value specified in dSubstitudeValue applies the substitute value.
Comments
MCP_VARIABLE_LIMITS5 is part of the MCP_NEWVARIABLE_DATA_5 (Page 1602)
structure and is needed specify text tags with start and substitute values using the
GAPICreateNewVariable5 (Page 1774) function.
Required files
dmclient.h
See also

3.2.2.32 MCP_VARIABLE_LIMITS_EX (RT Professional)
Declaration
typedef struct {
double dTopLimit
double dBottomLimit;
double dStartValue;
double dSubstituteValue;
DWORD dwLimitFlags
DWORD dwTextBibStartText;
char szTextStartText[255];
DWORD dwTextBibSubstitude;
char szTextSubstitude[255]
}
MCP_VARIABLE_LIMITS_EX;
Members
dTopLimit
dBottomLimit
dStartValue
dSubstituteValue
LimitFlags
The LimitFlags parameter specifies the validity of the default values and limits of a tag:
MCP_VARLIM_HAS_MIN_LIMIT Tag has a fixed low limit

MCP_VARLIM_HAS_MAX_LIMIT Tag has a fixed high limit
MCP_VARLIM_HAS_DEFAULT_VALUE Tag has a substitute value
MCP_VARLIM_HAS_STARTUP_VALUE Tag has start value
MCP_VARLIM_USE_DEFAULT_ON_STARTUP The substitute value should be used at system startup.
MCP_VARLIM_USE_DEFAULT_ON_MAX The substitute value should be used when the high limit is
violated.
MCP_VARLIM_USE_DEFAULT_ON_MIN The substitute value should be used when the low limit is
violated.
MCP_VARLIM_USE_DEFAULT_ON_COMM_ERROR The substitute value should be used when a connection error
occurs.

dwTextBibStartText
The parameter is only relevant for text tags. It the text to be used as the start value should be
read from the project text, enter the ID of the corresponding text here.
szTextStartText
The parameter is only relevant for text tags. Specify the text to be used as the start value
directly under szTextStartText.
dwTextBibSubstitude
The parameter is only relevant for text tags. It the text to be used as the substitute value should
be read from the project text, enter the ID of the corresponding text here.
szTextSubstitude
The parameter is only relevant for text tags. Specify the text to be used as the substitute value
directly under szTextSubstitude.
Comments
MCP_VARIABLE_LIMITS_EX is part of the MCP_NEWVARIABLE_DATA_EX (Page 1604)
structure.
The MCP_VARIABLE_LIMITS (Page 1612) structure has a similar use.
Required files
dmclient.h
See also
3.2.2.33 MCP_VARIABLE_PROTOCOL (RT Professional)
Declaration
typedef struct {
BOOL bTopLimitErr;
BOOL bBottomLimitErr;
BOOL bTransformationErr;
BOOL bWriteErr;
BOOL bWriteErrApplication;
BOOL bWriteErrProzess;
}
MCP_VARIABLE_PROTOCOL;

Members
bTopLimitErr
A report entry is generated when the value of the tag exceeds the high limit.
bBottomLimitErr
A report entry is generated when the value of the tag falls below the low limit.
bTransformationErr
A report entry is generated when a conversion error occurs.
bWriteErr
A report entry is generated with each unauthorized write access.
bWriteErrApplication
A report entry is generated with each unauthorized write access by the application.
bWriteErrProzess
A report entry is generated with each unauthorized write access by the process.
Comments
MCP_VARIABLE_PROTOCOL is part of the MCP_NEWVARIABLE_DATA (Page 1598) and
The MCP_VARIABLE_PROTOCOL_EX (Page 1619) structure has a similar use for extended
functionality.
Required files
dmclient.h
See also

3.2.2.34 MCP_VARIABLE_PROTOCOL_EX (RT Professional)
Declaration
typedef struct {
DWORD dwProtocolFlags
}
MCP_VARIABLE_PROTOCOL_EX;
Members
dwProtocolFlags
You can use the dwProtocolFlags parameter to determine which events generate a report
entry:
MCP_VARPROT_TOPLIMITERR A report entry is generated when the value of the

tag exceeds the high limit.
MCP_VARPROT_BOTTEMLIMITERR A report entry is generated when the value of the
tag falls below the low limit.
MCP_VARPROT_TRANSFORMATIONERR A report entry is generated when a conversion er‐
ror occurs.
MCP_VARPROT_WRITEERR A report entry is generated with each unauthorized
write access.
MCP_VARPROT_WRITEERRAPPLICATION A report entry is generated with each unauthorized
write access by the application.
MCP_VARPROT_WRITEERRPROCESS A report entry is generated with each unauthorized
write access by the process.
A logical combination of these constants is possible.
Comments
MCP_VARIABLE_PROTOCOL_EX is part of the MCP_NEWVARIABLE_DATA_EX
(Page 1604) structure.
The MCP_VARIABLE_PROTOCOL (Page 1617) structure has a similar use.
Required files
dmclient.h
See also

3.2.2.35 MCP_VARIABLE_SCALES (RT Professional)
Declaration
typedef struct {
DWORD dwVarScaleFlags;
double doMinProc;
double doMaxProc;
double doMinVar;
double doMaxVar;
}
MCP_VARIABLE_SCALES;
Members
dwVarScaleFlags
DM_VARSCALE_NOSCALE: No scaling
DM_VARSCALE_LINEAR: Linear scaling
doMinProc
Lowest value of the tag in the process
doMaxProc
Highest value of the tag in the process
doMinVar
Lowest value of the tag in WinCC
doMaxVar
Highest value of the tag in WinCC
Comments
MCP_VARIABLE_SCALES is part of the MCP_NEWVARIABLE_DATA_4 (Page 1600)
structure.
Required files
dmclient.h
See also


3.2.3 General functions (RT Professional)
3.2.3.1 DMActivateRTProject (RT Professional)
Use
This function enabled the project open in WinCC.
Declaration
BOOL DMActivateRTProject (
LPCMN_ERROR lpdmError);
Parameters
lpdmError
Pointer to the data of the extended error message in the CMN_ERROR structure. When an
error occurs, the system writes error information into this structure.
Return value
TRUE
Project enabled.
FALSE
Error.
Comment
This function is processed internally asynchronously. If the instruction is correctly forwarded
internally, it always returns TRUE. If, for example, the name of the server computer in the
project is specified incorrectly, no error is reported.
A successful start is checked with DMGetRTProject(..) .
If a check for a correct computer name is required, use the DMGetMachineTable(..) and
GetComputername(..) functions.

Required files
dmclient.h
dmclient.lib
dmclient.dll
See also
3.2.3.2 DMAddNotify (RT Professional)
Declaration
BOOL DMAddNotify (
DM_NOTIFY_PROC lpfnNotify,
LPVOID lpvUser,
LPDWORD lpdwNotifyCookie,
Description
Connect a further notify function call to DMClient. The notify functionality corresponds with the
functionality you can specify for DMConnect.
Parameters
lpfnNotify
Pointer to further notify functions.
lpvUser
Pointer to application-specific data. The function does not evaluate this pointer, but makes it
available again within the notify function.
lpdwNotifyCookie
Pointer to a DWORD, in which a cookie to the notify is returned.
The cookie is later required again in the DMRemoveNotify function to remove notify editing
again.
lpdmError
Pointer to the data of the extended error message within the CMN_ERROR structure. When
an error occurs, the system writes error information into this structure.

Return value
TRUE
Additional notify function connected.
FALSE
Error
Comments
The function is required in case a DMConnect has been performed within the process already
but no access is possible to the notify function specified there. This way, an additional notify
can be included to also evaluate the notify functions involved.
If, e.g., you use a DLL with DMClient functionality you created yourself within a global script
function, it is no longer possible to perform a DMConnect there. A DMConnect has been
performed already using the script and notification is no longer possible.
On rare occasions, the notify may be returned even before the function call has returned.
The notify functions included here in addition must be removed again using DMRemoveNotify
before DMDisconnect. Also, the notify function must not be a member function of a class object
which can be destroyed or deleted prematurely. Eventually, a notify call is pendant following
a DMRemoveNotify.
Error messages
DM_E_NOT_CONNECTED No DMConnect performed yet. The internal admin‐

istration has not been initialized yet.
DM_E_ALREADY_EXIST A NotifyProc with the same address exists already
in this process.
DM_E_MAX_LIMIT Maximum number of additional notify functions
has been reached (16).
DM_E_PARAM Parameter error
Required files
dmclient_exstr.h
dmclient.lib
dmclient.dll
Related functions
DMFireNotifyData Sends data to the additional notify function using

the cookie or to all functions
DMRemoveNotify Removes the additional notify function using the
cookie from the notify list

Examples
Button AddNotify:
#include "apdefap.h"
void OnClick(char* lpszPictureName,
char* lpszObjectName,
char* lpszPropertyName)
{
AddNotify();
}
Project function AddNotify:
extern BOOL DM_NotifyProcA(DWORD dwNotifyClass,
DWORD dwNotifyCode,
LPBYTE lpbyData,
DWORD dwItems,
LPVOID lpvUser);
void AddNotify()
{
BOOL bRet = FALSE;
DWORD dwNotifyCookie = 0L;
LPVOID lpvUser = NULL;
CMN_ERRORA err;
memset(&err, 0, sizeof(CMN_ERRORA));
dwNotifyCookie = GetTagDWord("DMdwNotifyCookie");
if (dwNotifyCookie)
{
printf("\r\nremove first previous Notify Cookie=%08lx",
dwNotifyCookie);
bRet = DMRemoveNotifyA(dwNotifyCookie, &err);
if (FALSE == bRet)
{
printf("\r\nERROR: DMRemoveNotifyA [%s],%ld,%ld,%ld,
%ld,%ld",
err.szErrorText,
err.dwError1,
err.dwError2,
err.dwError3,
err.dwError4,
err.dwError5);
}
dwNotifyCookie = 0L;
SetTagDWord("DMdwNotifyCookie",dwNotifyCookie);
}
lpvUser = (LPVOID)dwNotifyCookie; //set only for show in notify

bRet = DMAddNotifyA(DM_NotifyProcA,
lpvUser,
&dwNotifyCookie,
&err);
if (bRet)
{
printf("\r\nNotify added, Cookie=%08lx!", dwNotifyCookie);
}
else
{
printf("\r\nERROR: DMAddNotifyA [%s],%ld,%ld,%ld,%ld,%ld",
err.szErrorText,
err.dwError1,
err.dwError2,
err.dwError3,
err.dwError4,
err.dwError5);
}
}
Project function DM_NotifyProcA:
extern void RemoveNotify();
BOOL DM_NotifyProcA(DWORD dwNotifyClass,

DWORD dwNotifyCode,
LPBYTE lpbyData,
DWORD dwItems,
LPVOID lpvUser)
{
BOOL bShowParams = FALSE;
BOOL bSpecialActionRemoveNotify = FALSE;
printf("\r\n\r\n#### extra added DMNotifyProc [%08lx] entry: ####",

(DWORD)lpvUser);
switch (dwNotifyClass)
{
case DM_NOTIFY_CLASS_ERROR:
switch (dwNotifyCode)
{
case DM_NOTIFY_SHUTDOWN:
printf("\r\nDM_NOTIFY_CLASS_ERROR: DM_NOTIFY_SHUTDOWN");
bShowParams = TRUE;
bSpecialActionRemoveNotify = TRUE;
break;
case DM_NOTIFY_PROCESSNET_ERROR:
printf("\r\nDM_NOTIFY_CLASS_ERROR:
DM_NOTIFY_PROCESSNET_ERROR");
bShowParams = TRUE;
break;
case DM_NOTIFY_SYSNET_ERROR:
printf("\r\nDM_NOTIFY_CLASS_ERROR:
DM_NOTIFY_SYSNET_ERROR");

bShowParams = TRUE;
break;
default:
printf("\r\nunknown DM_NOTIFY_CLASS_ERROR:
dwNotifyCode[%08lx]", dwNotifyCode);
bShowParams = TRUE;
}
break;
case DM_NOTIFY_CLASS_WARNING:
{
case DM_NOTIFY_QUEUE_50_PERCENT:
printf("\r\nDM_NOTIFY_CLASS_WARNING:
DM_NOTIFY_QUEUE_50_PERCENT");
break;
break;
break;
break;
break;
case DM_NOTIFY_QUEUE_OVERFLOW:
DM_NOTIFY_QUEUE_OVERFLOW");
break;
case DM_NOTIFY_CYCLES_CHANGED:
DM_NOTIFY_CYCLES_CHANGED");
bShowParams = TRUE;
break;
case DM_NOTIFY_MACHINES_CHANGED:
DM_NOTIFY_MACHINES_CHANGED");
bShowParams = TRUE;
break;
case DM_NOTIFY_PROJECT_OPENED:
DM_NOTIFY_PROJECT_OPENED [%s]",
(LPSTR)lpbyData);
break;
case DM_NOTIFY_PROJECT_CLOSED:

DM_NOTIFY_PROJECT_CLOSE");
break;
case DM_NOTIFY_SYSTEM_LOCALE:
DM_NOTIFY_SYSTEM_LOCALE [%ld]",
*(DWORD*)lpbyData);
break;
case DM_NOTIFY_DATA_LOCALE:
DM_NOTIFY_DATA_LOCALE [%ld]",
*(DWORD*)lpbyData);
break;
case DM_NOTIFY_PROJECT_RUNTIME:
DM_NOTIFY_ROJECT_RUNTIME [%s]",
(LPSTR)lpbyData);
break;
case DM_NOTIFY_PROJECT_EDIT:
DM_NOTIFY_PROJECT_EDIT [%s]",
(LPSTR)lpbyData);
break;
case DM_NOTIFY_HOTKEY_CHANGE:
DM_NOTIFY_HOTKEY_CHANGE");
bShowParams = TRUE;
break;
case DM_NOTIFY_URSEL:
printf("\r\nDM_NOTIFY_CLASS_WARNING: DM_NOTIFY_URSEL");
bShowParams = TRUE;
break;
case DM_NOTIFY_BODO:
printf("\r\nDM_NOTIFY_CLASS_WARNING: DM_NOTIFY_BODO");
bShowParams = TRUE;
break;
case DM_NOTIFY_BEGIN_PROJECT_EDIT:
DM_NOTIFY_BEGIN_PROJECT_EDIT [%s]",
(LPSTR)lpbyData);
bShowParams = TRUE;
break;
default:
printf("\r\nunknown DM_NOTIFY_CLASS_WARNING:
bShowParams = TRUE;
}
break;
case DM_NOTIFY_CLASS_DATA:

{
case DM_NOTIFY_APPLICATION_DATA:
printf("\r\nDM_NOTIFY_CLASS_DATA:
DM_NOTIFY_APPLICATION_DATA:");
bShowParams = TRUE;
break;
case DM_NOTIFY_VARIABLE_DATA:
printf("\r\nDM_NOTIFY_CLASS_DATA:
DM_NOTIFY_VARIABLE_DATA:");
bShowParams = TRUE;
break;
case DM_NOTIFY_FIRE_DATA:
// the data sended with DMFireNotifyData is char text
printf("\r\nDM_NOTIFY_CLASS_DATA: DM_NOTIFY_FIRE_DATA:
(data as text: [%s])",
(char*)lpbyData);
bShowParams = TRUE;
break;
default:
printf("\r\nunknown DM_NOTIFY_CLASS_DATA:
bShowParams = TRUE;
}
break;
default:
printf("\r\nunknown dwNotifyClass[%08lx],
dwNotifyCode[%08lx]",
dwNotifyClass,
dwNotifyCode);
bShowParams = TRUE;
}
if (bShowParams)
{
printf("\r\ndwNotifyClass=%08lx, dwNotifyCode=%08lx,
dwItems=%ld, lpbyData=%08lx, lpvUser=%08lx",
dwNotifyClass,
dwNotifyCode,
dwItems,
lpbyData,
(DWORD)lpvUser);
}
if (bSpecialActionRemoveNotify)
{
printf("\r\nHave to remove notify if RT exits:");
RemoveNotify();
}
printf("\r\n#### extra added Notify [%08lx] exit ####\r\n",

(DWORD)lpvUser);

return TRUE;
}
3.2.3.3 DMChangeDataLocale (RT Professional)
Use
Provides notification of switching of the runtime language to all applications connected with
DMConnect.
Declaration
BOOL DMChangeDataLocale (
LPCTSTR lpszProjectFile,
DWORD dwLocaleID,
LPCMN_ERROR lpdmError );
Parameters
lpszProjectFile
Pointer to the name of the project file, including path and extension.
The name of the project file is determined with DMEnumOpenedProjects or with
DMGetRuntimeProject in RT.
dwLocaleID
Pointer to the code of the newly selected language. Possible values are the codes of all
languages configured in the text library.
lpdmError
Return value
TRUE
Notify applications when language is switched.
FALSE
Error.

Comment
The application is notified via the callback function DM_NOTIFY_PROC (Page 1633) with the
following parameters:
dwNotifyClass DM_NOTIFY_CLASS_WARNING
dwNotifyCode DM_NOTIFY_DATA_LOCALE
lpbyData Pointer to the code of the newly configured lan‐
guage.
Error messages
DM_E_NOT_CONNECTED No connection to data manager

DM_E_NOT_SUPPORTED Requested service unavailable
Required files
dmclient.h
dmclient.lib
dmclient.dll
Related functions
AUTOHOTSPOT Make connection to the data manager
See also
DM_NOTIFY_PROC (Page 1633)
DMGetRuntimeProject (Page 1662)
3.2.3.4 DMConnect (RT Professional)
Use
Establishment of a connection by application to the data manager. Only one DMConnect can
be performed in an application (process). Additional calls return the error
DM_E_ALREADY_CONNECTED.

Declaration
BOOL DMConnect (
LPTSTR lpszAppName,
DM_NOTIFY_PROC lpfnNotify,
LPVOID lpvUser,
Parameters
lpszAppName
Pointer to the name of the calling application. Any name can be selected since the parameter
is used for internal identification.
The length of application name is limited to MAX_DM_APP_NAME (32 characters). Longer
names lead to errors in the embedded OHIOIPC.DLL and to termination with the error
DM_E_NOT_CONNECTED.
lpfnNotify
Pointer to the notification function for administrative messages from the data manager to the
application.
When a program reports a notify routine, it must empty its message queue at regular intervals.
Unread messages could block WinCC notifications or finally block WinCC altogether.
In rare cases, the Notify may already be delivered before the function call has returned.
The Notify routine should still be available after DMDisConnect, since the late calls may arrive.
lpvUser
Pointer to application-specific data. This pointer is not evaluated by the function, but is made
available again in the callback function.
lpdmError
Return value
TRUE
Set up connection to data manager.
FALSE
Error.

Comment
In the WinCC variants that are implemented on the operating system platforms with multi-
threading support, the calls for the notification function are executed asynchronous to the
calling process.
You need to configure appropriate synchronization within the application.
If data manager functions are distributed to multiple threads in a program, run DMConnect in
each of these threads and a DMDisconnet at the end.
First, use DMGetConnectionState to check if another thread has already established a
connection. If a connection already exists, you may not perform DMConnect or DMDisConnect.
To avoid this conflict, combine the function calls to the data manager in a single thread and
execute the calls only from there.
If data manager functions are swapped out to a DLL that is embedded in an application with
the data manager functions, check if the connection can be established and terminated via the
DLL. In this case, the application must always secure its own data manager function calls with
DMGetConnectionState. However, this offers no protection against disconnection when the
thread is encapsulated in the DLL.
Therefore, define your own connection establishment in a flag, so that DMDisConnect is only
carried out in the desired situation.
An unchecked DMConnect call with Notify that returns the DM_E_ALREADY_CONNECTED
error message may cancel the Notify of a previous call and lead to undesirable results.
Pointers to data ranges passed to the callback function are only valid within the function, in
other words, the data manager may release allocated memory areas after the return of the
callback. If the application requires access to the data beyond the time of the call, it must copy
it accordingly.
In addition, pointers to memory areas on the platforms that only support this only have read
access, so that a write access to relevant data cause a protection fault!
The return value of the callback is currently not evaluated and will only be of significance in
future versions. The application should return TRUE by default here.
API DLLs must not be directly used in (ISS) services because the internal resources required
there are not available.
If you use data manager functions, such as a wrapper, in a managed environment (C#), ensure
that multiple ApplicationDomains in an application run in the same process. Therefore, only
one DMConnect is permitted in all ApplicationDomains.
Error messages
DM_E_ALREADY_CONNECTED Connection to the data manager already establish‐

ed.
DM_E_NOT_CONNECTED Connection to the data manager could not be es‐
tablished (for example, application name too long,
etc.).
DM_E_ACCESS_FAULT No right to establish connection to data manager
(Invalid user context, for example ISS services,
etc.).

Required files
dmclient.h
dmclient.lib
dmclient.dll
Related functions
DMDisconnect (Page 1636) Terminate connection to the data manager

DMGetConnectionState (Page 1648) Check connection to the data manager
DM_NOTIFY_PROC (Page 1633) Notification function
Examples
Connection to DM (Page 1825) "DM01.cpp"
See also
DM_NOTIFY_PROC (Page 1633)
DMDisconnect (Page 1636)
DMGetConnectionState (Page 1648)
Connection to DM (Page 1825)
APConnect (Page 1951)
3.2.3.5 DM_NOTIFY_PROC (RT Professional)
Description
In order for your application to provide notification of language switching, for example, you
need to provide a DM_NOTIFY_PROC type callback function.
Declaration
BOOL ( * DM_NOTIFY_PROC) (
DWORD dwNotifyClass,
DWORD dwNotifyCode,
LPBYTE lpbyData,
DWORD dwItems,
LPVOID lpvUser);

Parameters
dwNotifyClass
identifies the notification class:
DM_NOTIFY_CLASS_ERROR (0x00000001)
DM_NOTIFY_CLASS_WARNING (0x00000002)
DM_NOTIFY_CLASS_DATA (0x00000003)
dwNotifyCode
Notification code
for DM_NOTIFY_CLASS_ERROR:
DM_NOTIFY_SHUTDOWN (0x00000001) Data manager is closed
DM_NOTIFY_PROCESSNET_ERROR (0x00000002) Error on the process bus
DM_NOTIFY_SYSNET_ERROR (0x00000003) Error on the system bus
for DM_NOTIFY_CLASS_WARNING:
DM_NOTIFY_QUEUE_50_PERCENT (0x00000001) Fill level of application queue
50%
60%
70%
80%
90%
DM_NOTIFY_QUEUE_OVERFLOW (0x00000006) Overflow of the application
queue
DM_NOTIFY_CYCLES_CHANGED (0x00000010) Rescan update cycles
DM_NOTIFY_MACHINES_CHANGED (0x00000011) Rescan computer list
DM_NOTIFY_PROJECT_OPENED (0x00000012) Load project
DM_NOTIFY_PROJECT_CLOSE (0x00000013) Close project
DM_NOTIFY_SYSTEM_LOCALE (0x00000014) Switch configuration language
DM_NOTIFY_DATA_LOCALE (0x00000015) Switch GUI language
DM_NOTIFY_PROJECT_RUNTIME (0x00000016) Enable project
DM_NOTIFY_PROJECT_EDIT (0x00000017) Disable project
DM_NOTIFY_HOTKEY_CHANGE (0x00000018) A hot key was changed
for DM_NOTIFY_CLASS_DATA:
DM_NOTIFY_APPLICATION_DATA (0x00000001) Application data
DM_NOTIFY_VARIABLE_DATA (0x00000002) Tag data
You can find more information in the notification codes in the description of the constants.
lpbyData
Pointer to the data provided within the DM_NOTIFY_CLASS_DATA class.

dwItems
Number of entries in lpbyData.
lpvUser
Pointer to application-specific data. This pointer is made available again in the callback
function.
Return value
The return values depend on your implementation.
Note
Only data should be copied here if possible. The following types of function calls within the
callback can lead to deadlocks or a stack overflow:
● Functions in which a message loop is accessed, for example: GetMessage
● API functions from the same DLL
● Enumerations that call other enumerations
In rare cases, the Notify may already be delivered before the DMConnect function call has
returned.
Required files
dmclient.h
Related functions
DMConnect (Page 1630) Make connection to the data manager
Examples
AUTOHOTSPOT "DM01.cpp"
See also
DMConnect (Page 1630)
3.2.3.6 DMDeactivateRTProject (RT Professional)
Use
The project in the runtime mode is disabled.

Declaration
BOOL DMDeactivateRTProject (
Parameters
lpdmError
Return value
TRUE
Project disabled.
FALSE
Error.
Error messages
DM_E_NO_RT_PRJ No project in runtime mode
Required files
dmclient.h
dmclient.lib
dmclient.dll
Examples
OnTestDeactivateRuntimeProject (Page 1837) "TESTCDoc.cpp"
See also
OnTestDeactivateRuntimeProject (Page 1837)
3.2.3.7 DMDisconnect (RT Professional)
Use
This function is used by an application to terminate an existing connection to the data manager.

Declaration
BOOL DMDisConnect (
Parameters
lpdmError
Return value
TRUE
Connection terminated.
FALSE
Error.
Comments
If no connection to the data manager has been established with the DMConnect function, the
return value is FALSE. The lpdmError->dwError error code contains the
DM_E_NOT_CONNECTED, value, no connection to the data manager.
Note
The call must not be used in the destructor of an application (EXE, DLL, OCX, etc.). Due to
Microsoft-specific mechanisms, this can cause the call to freeze and thereby crash the
program.
Error messages
Required files
dmclient.h
dmclient.lib
dmclient.dll

Related functions
Examples
Connection to DM (Page 1825) "DM01.cpp"
See also
3.2.3.8 DMEnumNumberFormats (RT Professional)
Use
The function lists all format conversions available within FORMAT.DLL .
Declaration
BOOL DMEnumNumberFormats (
LPDWORD lpdwItems,
DM_ENUM_FORMATS_PROC lpfnFormat,
LPVOID lpvUser,
Parameters
lpdwItems
Pointer to a double word of the application, which contains the number of enumerated format
data after the call.
lpfnFormat
Pointer to your callback function that is called for every available number format.
lpvUser
Pointer to application-specific data. This pointer is not evaluated by the function but provided
again in the callback function.
lpdmError

Return value
TRUE
Format conversions listed.
FALSE
Error.
Comments
Pointers passed to the callback are only valid within this, since the system releases all allocated
memory areas once the function returns. If an application requires access to the data beyond
this, it must copy it accordingly.
Error messages
Required files
dmclient.h
dmclient.lib
dmclient.dll
Related functions
See also
DM_ENUM_FORMATS_PROC (Page 1639)
3.2.3.9 DM_ENUM_FORMATS_PROC (RT Professional)
Description
In order to evaluate the format conversions listed by the system, you must provide a
DM_ENUM_FORMATS_PROC type callback function.

Declaration
BOOL ( * DM_ENUM_FORMATS_PROC) (
LPDM_FORMAT_INFO lpdmFormat,
DWORD dwItem,
LPVOID lpvUser );
Parameters
lpdmFormat
Pointer to a DM_FORMAT_INFO (Page 1573) type structure with the data of a format
conversion.
dwItem
Continuous call counter. If the enumeration is not canceled prematurely, dwItem will contain
the number of available format conversions.
lpvUser
function.
Return value
TRUE
The enumeration is continued.
FALSE
The enumeration is cancelled.
Note
Required files
dmclient.h
Related functions
DMEnumNumberFormats (Page 1638) List format conversions

See also
DMEnumNumberFormats (Page 1638)
DM_FORMAT_INFO (Page 1573)
3.2.3.10 DMEnumUpdateCycles (RT Professional)
Use
The function lists all update cycles defined in the system. The function passes an information
structure for the cycle each time the callback function is called.
Declaration
BOOL DMEnumUpdateCycles (
LPCSTR lpszProjectFile,
LPDWORD lpdwItems,
DM_ENUM_CYCLES_PROC lpfnCycle,
LPVOID lpvUser,
Parameters
lpszProjectFile
lpdwItem
Pointer to a double word of the application, which contains the number of enumerated cycle
data after the call.
lpfnCycle
Pointer to your callback function that is called for every available update cycle.
lpvUser
lpdmError

Return value
TRUE
Update cycles listed
FALSE
Error
Comments
Pointers passed to the callback function are only valid within the function, since the system
releases all allocated memory areas once the function returns.
Error messages
Required files
dmclient.h
dmclient.lib
dmclient.dll
Related functions
Examples
OnTestUpdateCycles (Page 1845) "TESTCDoc.cpp"
See also
DM_ENUM_CYCLES_PROC (Page 1642)
OnTestUpdateCycles (Page 1845)
3.2.3.11 DM_ENUM_CYCLES_PROC (RT Professional)
Description
In order to evaluate the update cycles listed by the system, you must provide a
DM_ENUM_CYCLES_PROC type callback function.

Declaration
BOOL ( * DM_ENUM_CYCLES_PROC) (
LPDM_CYCLE_INFO lpdmCycle,
DWORD dwItem,
LPVOID lpvUser);
Parameters
lpdmCycle
Pointer to a DM_CYCLE_INFO (Page 1569) type structure with the data of an update cycle.
dwItem
Continuous call counter. If the enumeration is not canceled prematurely, dwItem will contain
the number of available update cycles.
lpvUser
function.
Return value
TRUE
FALSE
Note
Required files
dmclient.h
Related functions
DMEnumUpdateCycles (Page 1641) List update cycles

See also
DMEnumUpdateCycles (Page 1641)
DM_CYCLE_INFO (Page 1569)
3.2.3.12 DMExitWinCC (RT Professional)
Use
You can use this function to close WinCC.
Declaration
BOOL DMExitWinCC (
VOID);
Parameters
None
Comments
You can also use the DMExitWinCCEx to specify how the operating system should react to
the closing of WinCC.
Required files
dmclient.h
dmclient.lib
dmclient.dll
Related functions
DMExitWinCCEx (Page 1645) Close WinCC with defaults
Examples
OnTestWinCCShutdown (Page 1862) "TESTCDoc.cpp"
See also
OnTestWinCCShutdown (Page 1862)
DMExitWinCCEx (Page 1645)

3.2.3.13 DMExitWinCCEx (RT Professional)
Use
You can use this function to close WinCC. You can also specify how the operating system
reacts after WinCC is closed.
Declaration
BOOL DMExitWinCCEx (
DWORD dwMode );
Parameters
dwMode
You can use dwMode to specify various ways the operating system should react after WinCC
is closed.
DM_SDMODE_WINCC WinCC is closed

DM_SDMODE_LOGOFF When WinCC is closed, the user is also logged off
of the OS.
DM_SDMODE_SYSTEM When WinCC is closed, the operating system is
shut down.
DM_SDMODE_REBOOT When WinCC is closed, the operating system is
restarted.
Comments
With the DM_SDMODE_WINCC parameter, the function has the same effect as
DMExitWinCC.
Required files
dmclient.h
dmclient.lib
dmclient.dll
Related functions
DMExitWinCC (Page 1644) Close WinCC
See also
DMExitWinCC (Page 1644)

3.2.3.14 DMFireNotifyData (RT Professional)
Declaration
BOOL DMFireNotifyData (
DWORD dwNotifyCookie,
DWORD dwByteCount,
LPBYTE lpbyData,
Description
Sends an additional notify to a connected notify using the specified cookie identifier.
Parameters
dwNotifyCookie
Cookie for an additional notify function which was connected using DMAddNotify.
If "0" is specified the notify data is sent to all active notifies (broadcast).
dwByteCount
Size of the data buffer to be sent in BYTE.
lpbyData
Pointer to a byte buffer that contains the notify data to be sent.
The size of the buffer is specified by dwByteCount.
lpdmError
Return value
TRUE
Notify data sent.
FALSE
Error

Comments
The sent notify is edited in the said notify routine under
dwNotifyClass=DM_NOTIFY_CLASS_DATA and dwNotifyCode=DM_NOTIFY_FIRE_DATA.
If a DMDisconnect is performed without previously removing the additional notify functions, a
final DM_NOTIFY_SHUTDOWN is issued again to all these notify functions which are then
removed internally using administration. You can then discard the connection and the cookies
as they are no longer valid.
Error messages
DM_E_NOT_CONNECTED No DMConnect performed yet or DMDisconnect

performed already
DM_E_DONT_EXIST No notify exists for the specified cookie
Required files
dmclient_exstr.h
dmclient.lib
dmclient.dll
Related functions
DMAddNotify Links an additional Notify function to "DMClient"

DMFireNotify Removes the additional notify function using the
cookie from the notify list
Examples
Button DMFireNotifyData:
{
DWORD dwNotifyCookie;
CHAR* pszNotifyText;
CMN_ERROR err;
BOOL bRet;
pszNotifyText = GetTagChar("DMNotifySendText");
memset(&err, 0, sizeof(err));
bRet = FALSE;
bRet = DMFireNotifyData(dwNotifyCookie,
strlen(pszNotifyText)*sizeof(CHAR)+1,

(LPBYTE)pszNotifyText, &err);
if (FALSE == bRet)
{
printf("\r\nERROR: DMFireNotifyData [%s],%ld,%ld,%ld,%ld,%ld",
err.szErrorText,
err.dwError1,
err.dwError2,
err.dwError3,
err.dwError4,
err.dwError5);
}
3.2.3.15 DMGetConnectionState (RT Professional)
Use
You can use this function to query for a connection to the data manager, for example, to check
whether the DMConnect function call has been correctly executed.
Declaration
BOOL DMGetConnectionState (
Parameters
lpdmError
Return value
TRUE
Connection established.
FALSE
Error or no connection.
Error messages

Required files
dmclient.h
dmclient.lib
dmclient.dll
Related functions
Examples
AUTOHOTSPOT "DM01.cpp"
See also
3.2.3.16 DMGetDataLocale (RT Professional)
Use
The function returns the ID of the currently selected runtime language.
Declaration
BOOL DMGetDataLocale (
LPDWORD lpdwLocaleID,
Parameters
lpdwLocaleID
Pointer to the code of the currently configured language. Return values are the codes of all
languages configured in the text library.
lpdmError

Return value
TRUE
Get language ID.
FALSE
Error.
Error messages
Required files
dmclient.h
dmclient.lib
dmclient.dll
3.2.3.17 DMGetHotkey (RT Professional)
Use
This function determines the action associated with a hotkey.
Declaration
BOOL DMGetHotKey (
DWORD dwHotKeyAction,
LPDWORD lpdwHotKey,
Parameters
dwHotKeyAction
Action
lpdwHotKey
Pointer to the memory location where the hotkey is stored.
lpdmError

Return value
TRUE
Get hotkey ID.
FALSE
Error.
Required files
dmclient.h
dmclient.lib
dmclient.dll
3.2.3.18 DMGetMachineInfo (RT Professional)
Use
This function is used by an application to determine the startup parameters of the specific
computer. For this to occur, the application must have the relevant entries for the computer
properties made with the project management functions beforehand.
Declaration
BOOL DMGetMachineInfo (
LPCSTR lpszLogicalName,
LPVOID lpvData,
LPDWORD lpdwSize,
Parameters
lpszLogicalName
Pointer to the logical name of the Explorer DLL whose startup parameters are queried.
lpvData
Pointer to a data range through which the data of the startup parameters are passed to the
application.
lpdwSize
If lpvData = 0, the size of the data range is specified in lpdwSize.

lpdmError
Return value
TRUE
Get information about the local PC.
FALSE
Error.
Error messages

DM_E_MACHINE_NOT_FOUND Cannot find PC
DM_E_NO_INFO_FOUND Cannot find startup information
Required files
dmclient.h
dmclient.lib
dmclient.dll
3.2.3.19 DMGetMachineTable (RT Professional)
Use
You can use this function to determine information on individual PCs in addition to the number
of PCs involved in the project.
Declaration
BOOL DMGetMachineTable (
LPDM_MACHINE_TABLE lpdmMachineTable,
Parameters
lpdwProjectFile


lpdmMachineTable
Pointer to the DM_MACHINE_TABLE (Page 1574) structure in which the data from the
computer list is stored.
lpdmError
Return value
TRUE
Data for computer list determined.
FALSE
Error.
Required files
dmclient.h
dmclient.lib
dmclient.dll
Examples
OnTestMachines (Page 1840) "TESTCDoc.cpp"
See also
DM_MACHINE_TABLE (Page 1574)
OnTestMachines (Page 1840)
DMActivateRTProject (Page 1621)
3.2.3.20 DMRemoveNotify (RT Professional)
Declaration
BOOL DMRemoveNotify (
DWORD dwNotifyCookie,

Description
Removes an additionally connected notify function using its cookie identifier from the additional
notify list.
This function is only available in WinCC Version V7.2 or higher.
Parameters
dwNotifyCookie
Cookie for an additional notify function which was connected using DMAddNotify.
lpdmError
Return value
TRUE
Additional notify function removed.
FALSE
Error
Comments
If a DMDisconnect is performed without previously removing the additional notify functions, a
final DM_NOTIFY_SHUTDOWN is issued again to all these notify functions which are then
removed internally using administration. You can then discard the connection and the cookies
as they are no longer valid.
Error messages
DM_E_NOT_CONNECTED No DMConnect performed yet or DMDisconnect

performed already
DM_E_DONT_EXIST No notify exists for the specified cookie
Required files
dmclient_exstr.h
dmclient.lib
dmclient.dll

Related functions
DMFireNotifyData Sends data to the additional notify function using

the cookie or to all functions
DMAddNotify Links an additional Notify function to "DMClient"
Examples
Button RemoveNotify:
{
RemoveNotify ();
}
Project function RemoveNotify:
void RemoveNotify()
{
DWORD dwNotifyCookie = 0L;
CMN_ERRORA err;
BOOL bRet = FALSE;
if (dwNotifyCookie)
{
bRet = DMRemoveNotify(dwNotifyCookie, &err);
if (bRet)
{
printf("\r\nNotify [%08lx] removed", dwNotifyCookie);
dwNotifyCookie = 0L;
}
else
{
printf("\r\nERROR: DMRemoveNotifyA [%s],%ld,%ld,%ld,
%ld,%ld, Cookie=%08lx",
err.szErrorText,
err.dwError1,
err.dwError2,
err.dwError3,
err.dwError4,
err.dwError5,
dwNotifyCookie);
}
}
else
{
printf("\r\nNo Notify present to remove!");

}
}
3.2.4 Functions for project management (RT Professional)
3.2.4.1 DMEnumOpenedProjects (RT Professional)
Use
Calls the passed callback function for each project open in WinCC.
Declaration
BOOL DMEnumOpenedProjects (
LPDWORD lpdwItems,
DM_ENUM_OPENED_PROJECTS_PROC lpfnEnum,
LPVOID lpvUser,
Parameters
lpdwItems
Pointer to a double word, which contains the number of open projects when the enumeration
is completed.
lpfnEnum
Pointer to your callback function, which receives the project data.
lpvUser
lpdmError
Return value
TRUE
Projects listed.

FALSE
Error.
Comments
Currently, only one project can be open in WinCC. You therefore only get the information for
this one project.
Error messages
DM_E_FILE Error with file operation
Required files
dmclient.h
dmclient.lib
dmclient.dll
Related functions
DM_ENUM_OPENED_PROJECTS_PROC List open projects (callback)

(Page 1657)
Examples
Enum open projects (Page 1830) "DM01.cpp"
OnTestOpenProjects (Page 1844) "TESTCDoc.cpp"
See also
DM_PROJECT_INFO (Page 1575)
Enum open projects (Page 1830)
OnTestOpenProjects (Page 1844)
DMChangeDataLocale (Page 1629)
3.2.4.2 DM_ENUM_OPENED_PROJECTS_PROC (RT Professional)
Description
In order to be able to evaluate the projects listed by the system, you must provide a callback
function of the DM_ENUM_OPENED_PROJECTS_PROC type.

Declaration
BOOL ( * DM_ENUM_OPENED_PROJECTS_PROC) (
LPDM_PROJECT_INFO lpInfo,
LPVOID lpvUser);
Parameters
lpInfo
Pointer to a DM_PROJECT_INFO (Page 1575) type structure with information about an open
project.
lpvUser
function.
Return value
TRUE
FALSE
Comments
Currently, only one project can be open in WinCC. You therefore only get the information for
this one project.
Note
Required files
dmclient.h
Related functions
DMEnumOpenedProjects (Page 1656) List projects (open)

Examples
Enum open projects "DM01.cpp"
See also
Enum open projects (Page 1830)
3.2.4.3 DMGetProjectDirectory (RT Professional)
Use
Returns the path to the configuration data for the given project that is valid for the application.
Declaration
BOOL DMGetProjectDirectory (
LPCSTR lpszAppName,
LPDM_DIRECTORY_INFO lpdmDirInfo,
Parameters
lpszAppName
Pointer to the name of the application for which the path is to be determined.
lpszProjectFile
The name of the project file can be determined with DMEnumOpenedProjects.
lpdmDirInfo
Pointer to the DM_DIRECTORY_INFO (Page 1571) structure in which the path of the
configuration data is stored.
lpdmError

Return value
TRUE
Get path information.
FALSE
Error.
Error messages
Required files
dmclient.h
dmclient.lib
dmclient.dll
Examples
OnTestProjectPaths (Page 1842) "TESTCDoc.cpp"
See also
DM_DIRECTORY_INFO (Page 1571)
OnTestProjectPaths (Page 1842)
3.2.4.4 DMGetProjectInformation (RT Professional)
Use
Determines relevant information about the given project, such as paths, data source name,
computer configuration, etc.
Declaration
BOOL DMGetProjectInformation (
LPDM_PROJECT_INFO lpProjectInfo,

Parameters
lpszProjectFile
The name of the project file can be determined with DMEnumOpenedProjects or in RT with
DMGetRuntimeProject.
lpProjectInfo
Pointer to the DM_PROJECT_INFO (Page 1575) structure in which the project information is
stored.
lpdmError
Return value
TRUE
Get project information
FALSE
Error
Error messages
Required files
dmclient.h
dmclient.lib
dmclient.dll
Examples
Inquire project informations (Page 1836) "DM01.cpp"
OnTestProjectInfo (Page 1841) "TESTCDoc.cpp"
See also
Inquire project informations (Page 1836)
OnTestProjectInfo (Page 1841)

3.2.4.5 DMGetRuntimeProject (RT Professional)
Use
Returns the file name of the project that is in online mode. To determine all other project data
after successful execution, the calling application remembers the name of the project file
entered in lpszProjectFile.
Declaration
BOOL DMGetRuntimeProject (
LPSTR lpszProjectFile,
DWORD dwBufSize,
Parameters
lpszProjectFile
Buffer for storing the name of the project file, including path and extension. The buffer must
be at least _MAX_PATH characters in size.
dwBufSize
Size of the given buffer in characters.
lpdmError
Return value
TRUE
Name of the enabled project determined.
FALSE
Error.
Comments
The call is successfully executed even when runtime has started but not all components are
enabled.

Error messages

Required files
dmclient.h
dmclient.lib
dmclient.dll
Examples
Read tag (Page 1864) "DM02.cpp"
Write tag (Page 1869) "DM02.cpp"
OnTestRuntimeProject (Page 1844) "TESTCDoc.cpp"
See also
Read tag (Page 1864)
Write tag (Page 1869)
OnTestRuntimeProject (Page 1844)
DMChangeDataLocale (Page 1629)
3.2.4.6 DMOpenProjectDocPlus (RT Professional)
Use
Opens the project specified in lpszProjectFile.
Declaration
BOOL DMOpenProjectDocPlus (
Parameters
lpszProjectFile
Pointer to the name of the project file to be opened, including path and extension.

The release name (e.g. WinCC 50_Project_Odk) implicitly generated by WinCC cannot be
used as a path because it exists only as long as this project is open.
lpdmError
Return value
TRUE
Project opened.
FALSE
Error.
Required files
dmclient.h
dmclient.lib
dmclient.dll
3.2.4.7 DMOpenProjectPlus (RT Professional)
Use
Selection of a project file via the standard selection dialog of the system. If the project is not
yet open in WinCC, the information required for the project is loaded.
When the execution is successful, the calling application should remember the name of the
project file entered in lpszProjectFile, since it can be used to determine all other information
about the project.
The name of the project file can later be determined with DMEnumOpenedProjects.
Declaration
BOOL DMOpenProjectPlus (
HWND hwndParent,
DWORD dwBufSize,

Parameters
hwndParent
Handle to the window that is used as the parent window for the dialog.
lpszProjectFile
Pointer to the buffer for storing the name of the project file, including path and extension. The
buffer should be at least _MAX_PATH characters in size.
lpszProjectFile must be an empty string or a valid path of an existing project when the function
is called.
If lpszProjectFile is an empty string, the default selection dialog of the system (see above) is
called.
If lpszProjectFile is not empty, WinCC interprets the string contained in lpszProjectFile as the
project path and attempts to open it without opening the selection dialog.
The release name (e.g. WinCC 50_Project_Odk) implicitly generated by WinCC cannot be
used as a project path because it exists only as long as this project is open.
dwBufSize
Size of the given buffer in characters.
lpdmError
Return value
TRUE
Close the dialog with "OK".
FALSE
Error or close dialog with "CANCEL"
Comments
The process of opening a project may take several minutes.
Error messages
DM_E_CANCEL User has selected "Cancel" in a dialog

DM_E_UPDATE Updating project
Required files
dmclient.h

dmclient.lib
dmclient.dll
Examples
Open project by means of dialog (Page 1863) "DM01.cpp"
OnTestOpenProject (Page 1843) "TESTCDoc.cpp"
See also
Open project by means of dialog (Page 1863)
OnTestOpenProject (Page 1843)
3.2.5 Data transport channels (RT Professional)
3.2.5.1 DMClearBlockQueue (RT Professional)
Use
Deletes all entries in the notification queue of the application.
Declaration
BOOL DMClearBlockQueue (
Parameters
lpdmError
Return value
TRUE
Notification queue is deleted.
FALSE
Error.

Error messages
Required files
dmclient.h
dmclient.lib
dmclient.dll
3.2.5.2 DMEnumDataServices (RT Professional)
Use
DMEnumDataServices calls the passed callback function for each service already installed,
as long as the callback function returns TRUE.
Declaration
BOOL DMEnumDataServices (
LPDWORD lpdwItems,
DM_ENUM_DATA_SERVICE_PROC lpfnEnum,
LPVOID lpvUser,
Parameters
lpdwItems
Pointer to a double word of the application, which contains the number of listed services after
the call.
lpfnEnum
Pointer to your callback function that is called for every installed service.
lpvUser
lpdmError

Return value
TRUE
Services listed.
FALSE
Error.
Comment
Pointers passed to the callback are only valid within this, since the system releases all allocated
memory areas once the function returns. If an application requires access to the data beyond
this, it must copy it accordingly.
Error messages
Required files
dmclient.h
dmclient.lib
dmclient.dll
Related functions
DM_ENUM_DATA_SERVICE_PROC List data transport channels (callback)

(Page 1668)
DMInstallDataService (Page 1672) Install data transport channel
See also
DM_ENUM_DATA_SERVICE_PROC (Page 1668)
DMInstallDataService (Page 1672)
3.2.5.3 DM_ENUM_DATA_SERVICE_PROC (RT Professional)
Description
In order to evaluate the installed data transport channels listed by the system, you must provide
a DM_ENUM_DATA_SERVICE_PROC type callback function.

Declaration
BOOL ( * DM_ENUM_DATA_SERVICE_PROC) (
LPCSTR pszService,
DM_DATA_SERVICE_PROC pfnService,
LPVOID lpvUser );
Parameters
pszService
Pointer to the logical name of the data transport channel.
pfnService
Pointer to your DM_DATA_SERVICE_PROC (Page 1670) type callback function, through
which the additional data of a service are made available.
lpvUser
function.
Return value
TRUE
FALSE
Note
Required files
dmclient.h
Related functions
DMEnumDataServices (Page 1667) List data transport channels

See also
DMEnumDataServices (Page 1667)
3.2.5.4 DM_DATA_SERVICE_PROC (RT Professional)
Description
To enable your application to receive data, you must have a data transport channel installed
via DMInstallDataService and provide a DM_DATA_SERVICE_PROC type callback function.
You also need a callback function of this type if you want to evaluate the transport channels
(services) listed by the system.
Declaration
BOOL ( * DM_DATA_SERVICE_PROC) (
LPDM_DATA_SERVICE lpds,
LPVOID lpvUser);
Parameters
lpds
Pointer to a DM_DATA_SERVICE (Page 1570) type structure with the information on an
installed data transport channels (service).
lpvUser
function.
Return value
TRUE
Depending on the use of the callback function.

FALSE
Error
Note
If a program declares a Notify routine, it must empty its message queue regularly. Unread
messages could block WinCC notifications or finally block WinCC altogether.
Required files
dmclient.h
Related functions
DMInstallDataService (Page 1672) Install data transport channel

DM_ENUM_DATA_SERVICE_PROC List data transport channels (callback)
(Page 1668)
See also
DM_ENUM_DATA_SERVICE_PROC (Page 1668)
DM_DATA_SERVICE (Page 1570)
DMInstallDataService (Page 1672)
3.2.5.5 DMGetNumPendingBlocks (RT Professional)
Use
This function is used by an application to determine the entries in its queue.
Declaration
BOOL DMGetNumPendingBlocks (
LONG *plEntries,

Parameters
plEntries
After successful execution, the function contains the number of data packets in the queue of
the application.
lpdmError
Return value
TRUE
Number of entries in queue determined.
FALSE
Error.
Required files
dmclient.h
dmclient.lib
dmclient.dll
3.2.5.6 DMInstallDataService (RT Professional)
Use
Installs a transport channel (service) for data transfer between applications. The function
signals the readiness of the application to receive data sent by any other applications under
the specified service name. If a service is already installed under the given name, the callback
function installed for this is replaced by whatever is passed. If lpfnService == NULL , the service
installed lpszService is removed.
Declaration
BOOL DMInstallDataService (
LPCSTR lpszService,
DM_DATA_SERVICE_PROC lpfnService,
LPVOID lpvUser,

Parameters
lpszService
Pointer to the name of the service. The transport channel is identified by this name, which have
have freely assigned.
lpfnService
Pointer to a callback function that is called when data is sent to the application through this
service.
lpvUser
lpdmError
Return value
TRUE
Data transport channel installed.
FALSE
Error.
Error messages
Required files
dmclient.h
dmclient.lib
dmclient.dll
Related functions
DM_DATA_SERVICE_PROC (Page 1670) List data transport channels (callback), install data
transport channel (callback)

See also
DMEnumDataServices (Page 1667)
3.2.5.7 DMSendApplicationData (RT Professional)
Use
The data passed in lpdmSendData are sent to all applications that meet the conditions
specified in the DM_SEND_DATA_STRUCT structure and have installed the service described
under szService using DMInstallDataService.
Declaration
BOOL DMSendApplicationData (
LPDM_SEND_DATA_STRUCT lpdmSendData,
Parameters
lpdmSendData
Pointer to the DM_SEND_DATA_STRUCT (Page 1576) structure.
lpdmError
Return value
TRUE
Data sent to application.
FALSE
Error.
Comment
The function is only implemented locally.
The members in the DM_SEND_DATA_STRUCT structure for remote access to the
"TargetMachine" are reserved for future development.
The dwTargetMachineFlags can only be specified with DM_SD_LOCAL , any other
specification leads to errors and dwTargetMachines must be 0L.

Required files
dmclient.h
dmclient.lib
dmclient.dll
See also
3.2.5.8 DMSetBlockQueueSize (RT Professional)
Use
This function specifies the maximum number of messages that can be held in the notification
queue of the application.
Declaration
BOOL DMSetBlockQueueSize (
LONG nCount,
Parameters
nCount
Maximum number of messages.
lpdmError
Return value
TRUE
Size of the queue set.
FALSE
Error.
Comment
The default value for 32-bit platforms is 1000 entries, which is usually sufficient.

Each message occupies address space of the application. Think carefully before increasing
the number of messages as this will slow processing by the application.
Error messages
Required files
dmclient.h
dmclient.lib
dmclient.dll
3.2.6 Functions for processing tags (RT Professional)
3.2.6.1 DMEnumVarData (RT Professional)
Use
The function is used to determine information about objects that are associated with a tag, for
example, associated tag group, channel unit, etc.
Declaration
BOOL DMEnumVarData (
LPDM_VARKEY lpdmVarKey,
DWORD dwItems,
DM_ENUM_VARIABLE_PROC lpfnEnum,
LPVOID lpvUser,
Parameters
lpszProjectFile

lpdmVarKey
Pointer to the beginning of a field for DM_VARKEY (Page 1594) type structures, through which
the tags to be listed are specified. As of V5.0 SP2, if no array is specified and supplied with
NULL, all tags are enumerated.
If an incorrect name or a false ID is given for DM_VARKEY , no errors are displayed because
some can be valid and some incorrect in a list. In order for the user to identify an incorrect
DM_VARKEY , a DM_VARIABLE_DATA (Page 1590) type structure is passed for this in the
callback, which is filled with 0.
dwItems
Number of tags whose data are listed (= number of tag specifications in lpdmVarKey). If the
number is set to 0, all tags are enumerated.
lpfnEnum
Pointer to your callback, which receives the information about a tag.
lpvUser
lpdmError
Return value
TRUE
Information on the tag listed.
FALSE
Error
Comment
There is an advanced function, DMEnumVarData4.
Note
Existing implementations of a multi-stage enumeration of DMEnumVariables with the call of
DMEnumVarDataX in the callback for each individual element should be replaced by a single
call of DMEnumVarData4. Any necessary filtering should be performed here in the callback
itself. The change considerably improves performance.

Error messages

DM_E_INVALID_KEY Tag not found
Required files
dmclient.h
dmclient.lib
dmclient.dll
Related functions
See also
3.2.6.2 DM_ENUM_VARIABLE_PROC (RT Professional)
Description
In order to evaluate information about a tag listed by the system, you must provide a
DM_ENUM_VARIABLE_PROC type callback function.
Declaration
BOOL ( * DM_ENUM_VARIABLE_PROC) (
LPDM_VARIABLE_DATA lpdmVarData,
LPVOID lpvUser
Parameters
lpdmVarKey
Pointer to a DM_VARKEY (Page 1594) type structure for specification of the tag to be listed.
lpdmVarData
Pointer to a DM_VARIABLE_DATA (Page 1590) type structure with information about a tag.

When the structure completely filled with 0, an incorrect name or incorrect ID was given in
DM_VARKEY. Can be queried via lpdmVarData->dmTypeRef->dwType, for example.
lpvUser
function.
Return value
TRUE
FALSE
The enumeration is cancelled
Note
Required files
dmclient.h
Related functions
DMEnumVarData (Page 1676) List information about a tag
See also
3.2.6.3 DMEnumVarData4 (RT Professional)
Use
The function is used to determine information about objects that are associated with a tag, for
example, associated tag group, channel unit, etc.
If differs from DMEnumVarData due to the additional specification of scaling information.

Declaration
BOOL DMEnumVarData4 (
DWORD dwItems,
DM_ENUM_VARIABLE_PROC4 lpfnEnum,
LPVOID lpvUser,
Parameters
lpszProjectFile
lpdmVarKey
Pointer to the beginning of a field for DM_VARKEY (Page 1594) type structures, through which
the tags to be listed are specified. If the parameter is set to NULL, all tags are enumerated.
If an incorrect name or a false ID is given for DM_VARKEY , no errors are displayed because
some can be valid and some incorrect in a list. In order for the user to identify an incorrect
DM_VARKEY, a DM_VARIABLE_DATA4 (Page 1592) type structure is passed for this in the
callback, which is filled with 0.
dwItems
Number of tags whose data should be listed (= number of tag specifications in lpdmVarKey).
If the number is set to 0, all tags are enumerated.
lpfnEnum
Pointer to your callback, which receives the information about a tag.
lpvUser
lpdmError
Return value
TRUE
Information on the tag listed.

FALSE
Error.
Comment
Note
Error messages

Required files
dmclient.h
dmclient.lib
dmclient.dll
Related functions
DM_ENUM_VARIABLE_PROC4 (Page 1682) List information about a tag (callback)
Examples
Enum Data of Tags (Page 1828) "DM01.cpp"
See also
Enum Data of Tags (Page 1828)

3.2.6.4 DM_ENUM_VARIABLE_PROC4 (RT Professional)
Description
In order to evaluate information about a tag listed by the system, you must provide a
DM_ENUM_VARIABLE_PROC4 type callback function. This callback function differs from
DM_ENUM_VARIABLE_PROC due to the additional specification of scaling information.
Declaration
BOOL ( * DM_ENUM_VARIABLE_PROC4) (
LPDM_VARIABLE_DATA4 lpdmVarData,
LPVOID lpvUser
Parameters
lpdmVarKey
Pointer to a DM_VARKEY (Page 1594) type structure for specification of the tag to be listed.
lpdmVarData
Pointer to a DM_VARIABLE_DATA4 (Page 1592) type structure with information about a tag.
When the structure completely filled with 0, an incorrect name or incorrect ID was given in
DM_VARKEY. Can be queried via lpdmVarData->dmTypeRef->dwType, for example.
lpvUser
function.
Return value
TRUE
FALSE
Note

Required files
dmclient.h
Related functions
DMEnumVarData4 (Page 1679) List information about a tag
Examples
Enum Data of Tags (Page 1828) "DM01.cpp"
See also
Enum Data of Tags (Page 1828)
3.2.6.5 DMEnumVarGrpData (RT Professional)
Use
The function returns information about the tag groups via the DM_ENUM_VARGRP_PROC
callback function, for example, name, creator ID and number of tags in the group.
Declaration
BOOL DMEnumVarGrpData (
LPDM_VARGRPKEY lpdmVarGrpKey,
DWORD dwItems,
DM_ENUM_VARGRP_PROC lpfnEnum,
LPVOID lpvUser,
Parameters
lpszProjectFile

lpdmVarGrpKey
Pointer to the first of the DM_VARGRPKEY (Page 1589) type structures, through which the
tag group is specified.
dwItems
The number of tags whose data are listed.
lpfnEnum
Pointer to your callback, which receives the information about a tag group.
lpvUser
lpdmError
Return value
TRUE
Information on the tag group listed.
FALSE
Error.
Error messages

Required files
dmclient.h
dmclient.lib
dmclient.dll
Related functions
DM_ENUM_VARGRP_PROC List information about a tag group (callback)

(Page 1687)
Examples
OnTestEnumGroupsAll (Page 1837) "TESTCDoc.cpp"

See also
DM_VARGRPKEY (Page 1589)
DM_ENUM_VARGRP_PROC (Page 1687)
OnTestEnumGroupsAll (Page 1837)
3.2.6.6 DMEnumVarGrpDataExStr (RT Professional)
Declaration
BOOL DMEnumVarGrpDataExStr (
LPTSTR lpszProjectFile,
DWORD dwFlags,
LPVARIANT lpvdmVarGrpKey,
LPDWORD lpdwVarGrpCount,
DM_ENUM_VARGRP_PROC_EXSTR lpfnEnum,
LPVOID lpvUser,
Description
This function returns tag group information by means of the
DM_ENUM_VARGRP_PROC_EXSTR callback function, for example, name, ID and number
of tags in the group.
Parameters
lpszProjectFile
The name of the project file can be retrieved with DMEnumOpenedProjects, or with
DMGetRuntimeProject in Runtime.
dwFlags
Reserved for future use. Is to be filled with 0L.
lpvdmVarGrpKey
Pointer to the first structure of the "DM_VARGRPKEY" type specifying the tag groups.
Pointer to a VARIANT for this tag group list. You must create the list as VT_ARRAY |
VT_VARIANT as different data types such as VT_I4, VT_BSTR and under certain conditions
also VT_LPSTR can be different for each tag. Alternatively, you create a single VARIANT if
only one key is specified.
VT_EMPTY or NULL pointers are used to enumerate all groups.

lpdwVarGrpCount
Pointer to DWORD returning the number of tag groups.
lpfnCallback = NULL is used to initially determine how much memory is required for the tag
groups.
lpfnEnum
Pointer to your callback function which receives the tag group information.
lpvUser
available again within the callback function.
lpdmError
Return value
TRUE
Tag group information enumerated
FALSE
Error
Error messages

Required files
dmclient_exstr.h
dmclient.lib
dmclient.dll
Related functions
DM_ENUM_VARGRP_PROC_EXSTR Enumerate tag group information (callback)

3.2.6.7 DM_ENUM_VARGRP_PROC (RT Professional)
Description
In order to evaluate information about a tag group listed by the system, you must provide a
DM_ENUM_VARGRP_PROC type callback function.
Declaration
BOOL ( * DM_ENUM_VARGRP_PROC) (
LPDM_VARGRP_DATA lpdmVarGrpData,
LPVOID lpvUser );
Parameters
lpdmVarGrpData
Pointer to a DM_VARGRP_DATA (Page 1588) type structure with information about the tag
group.
lpvUser
function.
Return value
TRUE
FALSE
Note
Required files
dmclient.h

Related functions
DMEnumVarGrpData (Page 1683) List information about a tag group
See also
DM_VARGRP_DATA (Page 1588)
3.2.6.8 DMEnumVariables (RT Professional)
Use
The function lists the names of all tags that match a certain selection criterion. The selection
criterion is determined by the DM_VARFILTER structure.
Declaration
BOOL DMEnumVariables (
LPDM_VARFILTER lpdmVarFilter,
DM_ENUM_VAR_PROC lpfnEnum,
LPVOID lpvUser,
Parameters
lpszProjectFile
lpdmVarFilter
Pointer to the DM_VARFILTER (Page 1586) structure in which the selection criterion is
specified.
lpfnEnum
Pointer to your callback function, which receives the tag names.
lpvUser

lpdmError
Return value
TRUE
Tag names listed.
FALSE
Error.
Comment
Note
Required files
dmclient.h
dmclient.lib
dmclient.dll
Related functions
DM_ENUM_VAR_PROC (Page 1690) List tag names (callback)
Examples
OnTestEnumVariables (Page 1838) "TESTCDoc.cpp"
See also
DM_VARFILTER (Page 1586)
DM_ENUM_VAR_PROC (Page 1690)
OnTestEnumVariables (Page 1838)

3.2.6.9 DM_ENUM_VAR_PROC (RT Professional)
Description
In order to evaluate the names of tags listed by the system, you must provide a
DM_ENUM_VAR_PROC type callback function.
Declaration
BOOL ( * DM_ENUM_VAR_PROC) (
LPVOID lpvUser
Parameters
lpdmVarKey
Pointer to a DM_VARKEY (Page 1594) type structure with the name of a tag.
lpvUser
function.
Return value
TRUE
Additional callback calls are desirable.
FALSE
The callback series should be cancelled.
Comment
NOTICE
You may not call any other DMClient function in this callback. A blockade may otherwise
occur.
Note

Required files
dmclient.h
Related functions
DMEnumVariables (Page 1688) List tag names
See also
3.2.6.10 DMGetValue (RT Professional)
Use
Reads the value of one or more tags from the process image of the data manager. The value
that is read out is the one existing at the time of the most recent update.
The more advanced DMGetValueEx function, additionally returns the quality code in the
DM_VAR_UPDATE_STRUCTEX structure.
Declaration
BOOL DMGetValue (
DWORD dwItems,
LPDM_VAR_UPDATE_STRUCT lpdmvus,
Parameters
lpdmVarKey
Pointer to the DM_VARKEY (Page 1594) structure that identifies the tag values to be read.
dwItems
Number of passed structures (corresponds to the number of tag values to be read).
lpdmvus
Pointer to the first DM_VAR_UPDATE_STRUCT (Page 1581) structure that contains the tag
values once the function returns.

lpdmError
Pointer to the first of dwItems error structure with the CMN_ERROR type. When an error occurs
during the writing of a tag, the system writes the error information into the appropriate structure.
Therefore, remember to reserve space for these structures.
Return value
TRUE
Values determined.
FALSE
Error.
Comment
To provide an application the possibility of separate cycle management, a ZERO pointer is
specified as the callback function for DMStartVarUpdate. Then, the data manager updates the
tags according to the required cycle. However, the application remains responsible for the
timing of the readout obtained from the process image.
Since update requests for a tag can be present from several applications in different cycles,
the data manager always updates its process image based on the shortest requested cycle.
Error messages

DM_E_PARAM Invalid parameter
DM_E_OOM Out of memory
Required files
dmclient.h
dmclient.lib
dmclient.dll
Related functions

Examples
Read tag (Page 1864) "DM02.cpp"
OnTestVariablenGetvalue (Page 1848) "TESTCDoc.cpp"

See also
Read tag (Page 1864)
OnTestVariablenGetvalue (Page 1848)
3.2.6.11 DMGetValueEx (RT Professional)
Use
In contrast to DMGetValue, the quality code is also returned in the
DM_VAR_UPDATE_STRUCTEX structure.
Declaration
BOOL DMGetValueEx (
DWORD dwItems,
LPDM_VAR_UPDATE_STRUCTEX lpdmvus,
Parameters
lpdmVarKey
dwItems
lpdmvus
Pointer to the first DM_VAR_UPDATE_STRUCTEX (Page 1583) structure that contains the
tag values once the function returns.
lpdmError

Return value
TRUE
Values determined.
FALSE
Error.
Comment
To provide an application the possibility of separate cycle management, a NULL pointer can
be specified as the callback function for DMStartVarUpdate. Then, the data manager updates
the tags according to the required cycle. However, the application remains responsible for the
timing of the readout obtained from the process image.
Since update requests for a tag can be present from several applications in different cycles,
the data manager always updates its process image based on the shortest requested cycle.
Error messages

Required files
dmclient.h
dmclient.lib
dmclient.dll
Related functions

See also

3.2.6.12 DMGetValueExStr (RT Professional)
Declaration
BOOL DMGetValueExStr (
DWORD dwFlags,
LPVARIANT lpdmVarKey,
LPDM_VAR_UPDATE_STRUCT_EXSTR lpdmvus,
DWORD dwdmvusCount,
Description
In contrast to DMGetValueEx, the DM_VARKEY structure is no longer used; as a result no
length constraint applies with tag names.
Parameters
dmFlags
If the tag name needs to be returned in the VT_LPSTR format in the VARIANT of the
DM_VAR_UPDATE_STRUCT_EXSTR structure of
DM_NOTIFY_VARIABLE_PROC_EXSTR, the
DM_FLAG_RETURN_PROPVARIANT_VT_LPSTR flag can be specified here.
lpvdmVarKey
Pointer to a VARIANT for the tag list. You must create the list as VT_ARRAY | VT_VARIANT,
as various data types such as VT_I4, VT_BSTR and, in some cases, also VT_LPSTR can be
present. This applies also to a single key.
lpdmvus
Pointer to the first of the DM_VAR_UPDATE_STRUCT_EXSTR structures which contains the
values of the tags after the return of the function.
dwdmvusCount
Number of DM_VAR_UPDATE_STRUCT_EXSTR structures passed (identical with the
number of tag values to be read). The number must conform with the size of the variant array
in lpvdmVarKey.
lpdmError
Pointer to the first "dwdmvusCount" error structure of the CMN_ERROR type. If a tag writing
error occurs, the system writes the error information into the corresponding structure.

Return value
TRUE
Values have been determined
FALSE
Error
Comment
In order to e.g. enable an application to manage its own cycle administration, a NULL pointer
can be specified for DMStartVarUpdate as a callback function. Then, the data manager
updates the tags according to the required cycle. However, the application remains responsible
for the timing of the readout obtained from the process image.
As update requests for a tag can be made by multiple applications operating with different
cycles, the data manager always updates its process image based on the shortest cycle time.
Error messages

These errors are only returned in the first error structure.
Required files
dmclient_exstr.h
dmclient.lib
dmclient.dll
Related functions
DMGetValueWaitExStr Get tag values with update

DMSetValueExStr Change tag values
Examples
Script sample "Button DMGetValueExStr/DMSetValueExStr|DMGetValueWaitExStr/
DMSetValueWaitExStr":
void OnClick(char* lpszPictureName, char* lpszObjectName, char*
lpszPropertyName)
{
#pragma code ("kernel32.dll")
#define CP_ACP 0

int MultiByteToWideChar(UINT CodePage, DWORD dwFlags, LPCSTR

lpMultiByteStr, int cbMultiByte, LPWSTR lpWideCharStr, int
cchWideChar);
int WideCharToMultiByte(UINT CodePage, DWORD dwFlags, LPCWSTR
lpWideCharStr, int cchWideChar, LPSTR lpMultiByteStr, int
cbMultiByte, LPCSTR lpDefaultChar, LPBOOL lpUsedDefaultChar);
#pragma code()
#pragma code ("OleAut32.dll")

//#include "OleAuto.h"
SAFEARRAY * SafeArrayCreateVector(VARTYPE vt, long lLbound, unsigned
int cElements );
HRESULT SafeArrayPtrOfIndex(SAFEARRAY FAR* psa, long FAR* rgIndices,
void HUGEP* FAR* ppvData );
HRESULT SafeArrayLock(SAFEARRAY FAR* psa);
HRESULT SafeArrayUnlock(SAFEARRAY FAR* psa);
HRESULT VariantChangeType( VARIANTARG FAR* pvargDest, VARIANTARG
FAR* pvarSrc, unsigned short wFlags, VARTYPE vt);
typedef WCHAR OLECHAR;
BSTR SysAllocString(OLECHAR FAR* sz);
HRESULT SysFreeString(BSTR bstr);
#pragma code()
extern BOOL DM_NotifyVariableProcExStr_GetValueWait(DWORD dwTAID,

LPDM_VAR_UPDATE_STRUCT_EXSTR lpdmvus, DWORD dwItems, LPVOID lpvUser);
extern BOOL DM_CompletitionProc(DWORD dwTAID, LPDWORD lpdmVarState,
DWORD dwItems, LPVOID lpvUser);
VARIANT vVarKey;
VARIANT* pvElem;
VARIANT vdmValue;
SAFEARRAY* parrayKeys;
SAFEARRAY* parrayValues;
DWORD dwVal[4];
DWORD dwState[4];
DWORD dwMerk;
CMN_ERROR err;
CMN_ERROR errArray[4];
DM_VAR_UPDATE_STRUCT_EXSTR dmvus[4];
HRESULT hr;
long lInx;
BOOL bRet;
DWORD dwFlags;
DWORD* pdwVarState;
DWORD dwTAID;
memset(dmvus, 0, sizeof(dmvus));
dwVal[0] = 1;
dwVal[1] = 2;
dwVal[2] = 3;
dwVal[3] = 4;

dwMerk = 0L;
memset(dwState, 0, sizeof(dwState));
pvElem = NULL;
parrayKeys = NULL;
parrayValues = NULL;
hr = 0L; //S_OK
lInx = 0L;
bRet = FALSE;
dwFlags = DM_FLAG_RETURN_PROPVARIANT_VT_LPSTR;
pdwVarState = dwState;
dwTAID = 0L;
printf("\r\n\r\n########## enter Test with DMGetValue(Wait)ExStr/

DMSetValue(Wait)ExStr ##########");
VariantInit(&vVarKey);
parrayKeys = SafeArrayCreateVector(VT_VARIANT, 0L, 4);
vVarKey.vt = VT_ARRAY | VT_VARIANT;
vVarKey.u.parray = parrayKeys;
SafeArrayLock(parrayKeys);
lInx = 0L;
hr = SafeArrayPtrOfIndex(parrayKeys, &lInx, &pvElem);
pvElem->vt = VT_LPSTR;
pvElem->u.pbVal = "dwVal_1";
lInx = 1L;
lInx = 2L;
lInx = 3L;
SafeArrayUnlock(parrayKeys);
printf("\r\ncall DMGetValueExStr:");
bRet = DMGetValueExStr(dwFlags, &vVarKey, dmvus, 4L, &err);
if (bRet == FALSE)
{
printf("\r\n error DMGetValueExStr, err=%ld,%ld,%ld,%ld,%ld,
[%s]",
err.dwError1, err.dwError2, err.dwError3, err.dwError4,
err.dwError5, err.szErrorText);
}
else
{
int i = 0;

for (i = 0; i < 4; i++)

{
hr = VariantChangeType((VARIANTARG*)&(dmvus[i].vdmValue),
(VARIANTARG*)&(dmvus[i].vdmValue), 0, VT_I4);
if (hr)
{
printf("\r\n error VariantChangeType[%d] hr=%08lx",
i, hr);
}
else
{
if (dmvus[i].vdmValue.vt == VT_I4)
{
dwVal[i] = dmvus[i].vdmValue.u.lVal;
printf("\r\n Var[%d]:[%s] = %ld",
i, dmvus[i].vdmVarKey.u.pbVal,
dmvus[i].vdmValue.u.lVal);
}
else
{
printf("\r\n wrong datatype %ld, VT_I4 expected after
VariantChange",
dmvus[i].vdmValue.vt == VT_I4);
}
}
}
//clear the internal alloced Data, that no memoryleaks

//the vdmValues no need to clear here, while no PROPVARIANT here
given (double used)
//only the dmVarkey of dmvus have to free here
for (i = 0; i < 4; i++)
{
free(dmvus[i].vdmVarKey.u.pbVal);
dmvus[i].vdmVarKey.u.pbVal = NULL;
dmvus[i].vdmVarKey.vt = VT_EMPTY;
}
}
// change the values before set again

dwMerk = dwVal[0];
dwVal[0] = dwVal[3];
dwVal[3] = dwMerk;
dwMerk = dwVal[1];
dwVal[1] = dwVal[2];
dwVal[2] = dwMerk;
VariantInit(&vdmValue);
parrayValues = SafeArrayCreateVector(VT_VARIANT, 0L, 4);
vdmValue.vt = VT_ARRAY | VT_VARIANT;
vdmValue.u.parray = parrayValues;

SafeArrayLock(parrayValues);
lInx = 0L;
hr = SafeArrayPtrOfIndex(parrayValues, &lInx, &pvElem);
pvElem->vt = VT_I4;
pvElem->u.pbVal = dwVal[0];
lInx = 1L;
pvElem->vt = VT_I4;
lInx = 2L;
pvElem->vt = VT_I4;
lInx = 3L;
pvElem->vt = VT_I4;
SafeArrayUnlock(parrayValues);
printf("\r\ncall DMSetValueExStr:");
bRet = DMSetValueExStr(&vVarKey, &vdmValue, pdwVarState, &err);
if (bRet == FALSE)
{
printf("\r\n error DMSetValueExStr, err=%ld,%ld,%ld,%ld,%ld,
[%s]",
}
else
{
int i = 0;
for (i = 0; i < 4; i++)
{
printf("\r\n dwVarState[%d] = %ld", i, dwState[i]);
}
}
// clear the values before read back again with DMGetValueWait

(timeout 2sec.)
dwVal[0] = 0;
dwVal[1] = 0;
dwVal[2] = 0;
dwVal[3] = 0;
printf("\r\ncall DMGetValueWaitExStr:");
bRet = DMGetValueWaitExStr(&dwTAID, dwFlags, &vVarKey, TRUE, 2000,
DM_NotifyVariableProcExStr_GetValueWait, dwVal, &err);
if (bRet == FALSE)
{

printf("\r\n error DMGetValueWaitExStr, err=%ld,%ld,%ld,%ld,%ld,

[%s]",
}
else
{
int i = 0;
for (i = 0; i < 4; i++)
{
printf("\r\n dwValue[%d] = %ld", i, dwVal[i]);
}
}
//increment values for identify execute of following DMSetValueWait

dwVal[0] = dwVal[0] + 1;
if (dwVal[0] >= 100)
{
dwVal[0] = dwVal[0] - 100;
}
if (dwVal[1] >= 100)
{
dwVal[1] = dwVal[1] - 100;
}
if (dwVal[2] >= 100)
{
dwVal[2] = dwVal[2] - 100;
}
if (dwVal[3] >= 100)
{
dwVal[3] = dwVal[3] - 100;
}
VariantClear(&vdmValue);
parrayValues = SafeArrayCreateVector(VT_VARIANT, 0L, 4);
vdmValue.vt = VT_ARRAY | VT_VARIANT;
vdmValue.u.parray = parrayValues;
SafeArrayLock(parrayValues);
lInx = 0L;
pvElem->vt = VT_I4;
lInx = 1L;
pvElem->vt = VT_I4;
lInx = 2L;
pvElem->vt = VT_I4;

lInx = 3L;
pvElem->vt = VT_I4;
SafeArrayUnlock(parrayValues);
printf("\r\ncall DMSetValueWaitExStr:");
memset(errArray, 0, sizeof(errArray));
bRet = DMSetValueWaitExStr(&dwTAID, &vVarKey, 4, &vdmValue,
pdwVarState, 2000, DM_CompletitionProc, NULL, errArray);
if (bRet == FALSE)
{
int i = 0;
for(i=0; i < 4; i++)
{
printf("\r\n error DMSetValueWaitExStr, errArray[%d]=%ld,
%ld,%ld,%ld,%ld,[%s]",
i, errArray[i].dwError1, errArray[i].dwError2,
errArray[i].dwError3,
errArray[i].dwError4, errArray[i].dwError5,
errArray[i].szErrorText);
}
}
else
{
}
printf("\r\n########## exit Test with DMGetValue(Wait)ExStr/

DMSetValue(Wait)ExStr ##########\r\n");
Script example "Projekt-Funktion DM_NotifyVariableProcExStr_GetValueWait":

#pragma code()
BOOL DM_NotifyVariableProcExStr_GetValueWait(DWORD dwTAID,

LPDM_VAR_UPDATE_STRUCT_EXSTR lpdmvus, DWORD dwItems, LPVOID lpvUser)
{
BOOL bRet = FALSE;
int i = 0;
DWORD* pdwVal = NULL;
pdwVal = (DWORD*)lpvUser;
// the DMGetValueWait used PROPVARIANT and the lpvUser is ptr to
OutDataArray (DWORDS)
printf("\r\n*** DM_NotifyVariableProcExStr_GetValueWait entry ***");
for (i = 0; i < dwItems; i++)

{
VariantChangeType((VARIANTARG*)&(lpdmvus[i].vdmValue),
(VARIANTARG*)&(lpdmvus[i].vdmValue), 0, VT_I4);
if (0 == strcmp((LPCSTR)lpdmvus[i].vdmVarKey.u.pbVal, "dwVal_1"))
{
pdwVal[0] = lpdmvus[i].vdmValue.u.lVal;
printf("\r\n set dwVal_1=%ld to dwVal[0]", pdwVal[0]);
bRet = TRUE;
}
{
bRet = TRUE;
}
{
bRet = TRUE;
}
{
bRet = TRUE;
}
}
printf("\r\n*** DM_NotifyVariableProcExStr_GetValueWait exit ***");

return bRet;
}
Project-Function DM_CompletitionProc:
BOOL DM_CompletitionProc(DWORD dwTAID, LPDWORD lpdmVarState, DWORD

dwItems, LPVOID lpvUser)
{
BOOL bRet = FALSE;
int i = 0;
printf("\r\n*** DM_CompletitionProc entry ***");

{
printf("\r\n VarState[%d] = %ld", i, lpdmVarState[i]);
}
printf("\r\n*** DM_CompletitionProc exit ***");
return bRet;
}

3.2.6.13 DMGetValueWait (RT Professional)
Use
In contrast to DMGetValue, this function forces a value-based update of the tag values.
The more advanced DMGetValueWaitEx function additionally returns the quality code in the
DM_NOTIFY_VARIABLEEX_PROC callback in the DM_VAR_UPDATE_STRUCTEX
structure.
Declaration
BOOL DMGetValueWait (
LPDWORD pdwTAID,
DWORD dwItems,
BOOL fWaitForCompletition,
DWORD dwTimeOut,
DM_NOTIFY_VARIABLE_PROC lpfnVariable,
LPVOID lpvUser,
Parameters
pdwTAID
Pointer to a tag that contains the transaction ID assigned by the data manager after a
successful call of the function.
lpdmVarKey
dwItems
fWaitForCompletition
If the fWaitForCompletition flag is set, the passed callback function is called only called when
either all the requested tags are updated or the specified timeout period is exceeded.
If fWaitForCompletition is not set, the passed callback function is called immediately. The time
characteristics correspond to the function DMGetValue.
dwTimeout
Maximum waiting time of the application in ms. If not all tag values have been updated when
the waiting time expires, the callback function with corresponding error codes is called.
If the fWaitForCompletition == FALSE flag is set, the passed value is not evaluated.

lpfnVariable
Pointer to your DM_NOTIFY_VARIABLE_PROC callback function, which is called either after
the update of all requested tags or after the waiting period.
If fWaitForCompletition == FALSE, the callback function is called immediately with the values
currently set in the process image of the data manager.
lpvUser
lpdmError
Return value
TRUE
Values determined.
FALSE
Error.
Required files
dmclient.h
dmclient.lib
dmclient.dll
Related functions
DM_NOTIFY_VARIABLE_PROC (Page 1808) Get tag values with update (callback)

DMGetValueWaitEx (Page 1706) Get tag values with update
AUTOHOTSPOT Change tag values with notification
Examples
OnTestVariablenGetvaluewait (Page 1851) "TESTCDoc.cpp"

See also
OnTestVariablenGetvaluewait (Page 1851)
3.2.6.14 DMGetValueWaitEx (RT Professional)
Use
In contrast to DMGetValueEx, this function forces a value-based update of the tag values.
Declaration
BOOL DMGetValueWaitEx (
LPDWORD pdwTAID,
DWORD dwItems,
DWORD dwTimeOut,
DM_NOTIFY_VARIABLEEX_PROC lpfnVariable,
LPVOID lpvUser,
Parameters
pdwTAID
lpdmVarKey
dwItems

If the fWaitForCompletition flag is set, the passed callback function is called only called when
either all the requested tags are updated or the specified timeout period is exceeded.
If fWaitForCompletition is not set, the passed callback function is called immediately. The time
characteristics correspond to the function DMGetValue.
dwTimeout
If the fWaitForCompletition == FALSE flag is set, the passed value is not evaluated.
lpfnVariable
Pointer to your DM_NOTIFY_VARIABLEEX_PROC callback function, which is called either
after the update of all requested tags or after the waiting period.
If fWaitForCompletition == FALSE, the callback function is called immediately with the values
currently set in the process image of the data manager.
lpvUser
lpdmError
Return value
TRUE
Values determined.
FALSE
Error.
Related functions
DM_NOTIFY_VARIABLEEX_PROC (Page 1819) Get tag values with notification (callback)

DMGetValueEx (Page 1693) Get tag values

See also
3.2.6.15 DMGetValueWaitExStr (RT Professional)
Declaration
BOOL DMGetValueWaitExStr (
LPDWORD pdwTAID,
DWORD dwFlags
LPVARIANT lpvdmVarKey,
LPVARIANT lpvCookie,
DWORD dwTimeOut,
DM_NOTIFY_VARIABLE_PROC_EXSTR lpfnVariable,
LPVOID lpvUser,
Description
In contrast to DMGetValueExStr, this function can be used to enforce a value-based update
of the tag values.
In contrast to DMGetValueEx, the DM_VARKEY structure is no longer used; as a result no
length constraint applies with tag names.
Parameters
pdwTAID
Pointer to a tag containing the transaction ID allocated by the data manager after the function
has been called successfully.
dwFlags

lpvdmVarKey
Pointer to a VARIANT for the tag list. You must create the list as VT_ARRAY | VT_VARIANT,
as various data types such as VT_I4, VT_BSTR and, in some cases, also VT_LPSTR can be
present.
lpvCookie
Pointer to a VARIANT for an additional list of user-dependent data for each tag.
This is intended as substitute for lpvUserData of the previous DM_VARKEY and is also
returned in the DM_VAR_UPDATE_STRUCT_EXSTR structure for each tag.
If the fWaitForCompletion flag has been set, the callback function passed is not called before
all tags requested have been updated or the timeout time specified has been exceeded.
If the fWaitForCompletition flag has not been set, the callback function is called immediately.
The timing is identical with that of the DMGetValueExStr function.
dwTimeout
If the fWaitForCompletition flag = FALSE, the value passed is not evaluated.
lpfnVariable
Pointer to your DM_NOTIFY_VARIABLEEX_PROC_EXSTR callback function which is called
either after all requested tags have been updated or after the waiting time has expired.
If fWaitForCompletition = FALSE, the callback function is called immediately with the values
currently stored in the process image of the data manager.
If a program requests a notify routine, it has to clear its message queue at regular intervals.
On rare occasions, the notify may be returned before the function call has returned.
lpvUser
lpdmError
Return value
TRUE
Values have been determined
FALSE
Error

Required files
dmclient_exstr.h
dmclient.lib
dmclient.dll
Related functions
DMGetValueExStr Get tag values

DMSetValueWaitExStr Change tag values with notification
Examples
You can find samples on the DMGetValueExStr page.
3.2.6.16 DMGetVarInfo (RT Professional)
Use
DMGetVarInfo determines the full tag key of a tag. This command can be used to obtain a tag
name associated with a tag ID and vice versa.
Declaration
BOOL DMGetVarInfo (
DWORD dwItems,
Parameters
lpszProjectFile
lpdmVarKey
Pointer to the DM_VARKEY (Page 1594) structure to be completed with the tag keys.
dwItems
Number of completed structures.

lpdmError
Return value
TRUE
Get tag key.
FALSE
Error.
Comment
Do not use the call alternating with calls for creating tags. If DMGetVarInfo is used after creating
a tag the first time, search lists are resorted, which costs an additional execution time.
Error messages
Required files
dmclient.h
dmclient.lib
dmclient.dll
Examples
OnTestVariablenGetVarInfo (Page 1855) "TESTCDoc.cpp"
See also
OnTestVariablenGetVarInfo (Page 1855)

3.2.6.17 DMGetVarInfoExStr (RT Professional)
Declaration
BOOL DMGetVarInfoExStr (
DWORD dwFlags,
LPVARIANT lpvdmVarKeyIn,
LPVARIANT lpvdmVarKeyOut,
Description
Determines the complete tag key of a tag. This command enables you to obtain the tag name
to a tag ID and vice versa.
In contrast to DMGetVarInfo, the tag list is passed on as pointer to VARIANT with VT_ARRAY
| VT_VARIANT. It is returned in a second VARIANT. As a result, no length limit applies to tag
names.
Parameters
lpszProjectFile
dwFlags
If the tag name needs to be returned in the VT_LPSTR format in the VARIANT
lpvdmVarKeyOut, DM_FLAG_RETURN_PROPVARIANT_VT_LPSTR can be specified here.
lpvdmVarKeyIn
Pointer to VARIANT with VT_ARRAY | VT_VARIANT to pass the tag list or single VARIANT
when only one tag is specified.
A TagID is entered in the relevant list element with the type VT_I4 and the tag name with
VT_BSTR. In addition, VT_LPSTR (PROPVARIANT) can be entered for passing on as
allocated ASCII string in order, for example, to pass on constant names from the script.
VT_LPSTR is then converted internally into the required VT_BSTR type.
lpvdmVarKeyOut
Pointer to VARIANT used to return the corresponding values for lpvdmVarKeyIn.
Then, the tag ID for a given tag name in lpvdmVarKeyIn is returned or vice versa.
If the VARIANT is initialized with VT_EMPTY, a corresponding array is created and filled with
VT_ARRAY | VT_VARIANT of the same size as in lpvdmVarKeyIn.

If the VARIANT is not empty, a VariantClear is called first before a new one is created. A
VARIANT which is not initialized can result in an exception.
If the tag does not exist or cannot be accessed, the type of the corresponding entry remains
VT_EMPTY.
lpdmError
Return value
TRUE
Tag keys have been determined
FALSE
Error
Comment
This call should not be used alternately with calls for creating tags. Whenever the
DMGetVarInfo or DMGetVarInfoExStr function is used for the first time after creating a tag
search lists must be sorted again. This requires additional runtime.
Error messages
Required files
dmclient_exstr.h
dmclient.lib
dmclient.dll
Examples
Script sample Button DMGetVarInfoExStr:
lpszPropertyName)
{
#pragma code ("kernel32.dll")
#define CP_ACP 0
int MultiByteToWideChar(UINT CodePage,
DWORD dwFlags,
LPCSTR lpMultiByteStr,
int cbMultiByte,

LPWSTR lpWideCharStr,
int cchWideChar);
int WideCharToMultiByte(UINT CodePage,
DWORD dwFlags,
LPCWSTR lpWideCharStr,
int cchWideChar,
LPSTR lpMultiByteStr,
int cbMultiByte,
LPCSTR lpDefaultChar,
LPBOOL lpUsedDefaultChar);
#pragma code()

int cElements );
HRESULT SafeArrayPutElement(SAFEARRAY FAR* psa, long FAR* rgIndices,
void FAR* pv );
HRESULT SafeArrayGetElement(SAFEARRAY FAR* psa, long FAR* rgIndices,
void FAR* pv );
typedef WCHAR OLECHAR;
BSTR SysAllocString(OLECHAR FAR* sz);
HRESULT SysFreeString(BSTR bstr);
#pragma code()
VARIANT vVarkeyIn;
VARIANT vVarkeyOut;
VARIANT vElem;
VARIANT* pvElem;
HRESULT hr;
CHAR szProjectName[256];
CMN_ERROR err;
DWORD dwFlags;
BOOL bRet;
DWORD dwVarID1, dwVarID2, dwVarID3, dwVarID4;
CHAR szVarNam1[256], szVarNam2[256], szVarNam3[256], szVarNam4[265];
SAFEARRAY* parrayIN;
SAFEARRAY* parrayOUT;
long lInx;
WCHAR wszBuffer[256];
int nRet;
bRet = FALSE;
szProjectName[0] = 0;
dwFlags = 0;
VariantInit(&vVarkeyIn);
VariantInit(&vVarkeyOut);
VariantInit(&vElem);
parrayIN = NULL;

parrayOUT = NULL;
//hr = E_FAIL;
nRet = 0;
printf("\r\n\r\n########## enter Test with DMGetVarInfoExStr
##########");
bRet = DMGetRuntimeProject(szProjectName, 256, &err);

if (!bRet)
{
printf("\r\n error DMGetRuntimeProject =>[%s], err=%ld,%ld,%ld,
%ld,%ld,[%s]", szProjectName,
}
dwVarID1 = GetTagDWord("dwVarKeyID_1");
strncpy(szVarNam1, GetTagChar("szVarKeyName_1"), 256);
printf("\r\n set vVarkeyIn:");
printf("\r\n dwVarID1=%ld, szVarNam1=[%s] (use name as VT_BSTR)",
dwVarID1, szVarNam1);
printf("\r\n dwVarID2=%ld, szVarNam2=[%s] (use name as VT_LPSTR)",
printf("\r\n dwVarID3=%ld, szVarNam3=[%s] (use ID)", dwVarID3,
szVarNam3);
printf("\r\n dwVarID4=%ld, szVarNam4=[%s] (useID)", dwVarID4,
szVarNam4);
//preseting input Variant: name1, name2, id3, id4
// will deliver on output Variant: id1, id2, name3, name4
parrayIN = SafeArrayCreateVector(VT_VARIANT, 0L, 4);
vVarkeyIn.vt = (VT_ARRAY | VT_VARIANT);
vVarkeyIn.u.parray = parrayIN;
// name1 as VT_BSTR
vElem.vt = VT_BSTR;
nRet = MultiByteToWideChar(CP_ACP, 0, szVarNam1, -1, wszBuffer,
256);
vElem.u.bstrVal = SysAllocString(wszBuffer);
lInx = 0;
hr = SafeArrayPutElement(parrayIN, &lInx, &vElem);
VariantClear(&vElem);
// name2 als VT_LPSTR
SafeArrayLock(parrayIN);
lInx = 1;
hr = SafeArrayPtrOfIndex(parrayIN, &lInx, &pvElem);
pvElem->u.pbVal = szVarNam2;
SafeArrayUnlock(parrayIN);
if (hr)

{
printf("\r\nerror SafeArrayPutElement: hr = %08lx", hr);
}
vElem.vt = VT_I4;
vElem.u.lVal = dwVarID3;
lInx = 2;
vElem.vt = VT_I4;
vElem.u.lVal = dwVarID4;
lInx = 3;
bRet = DMGetVarInfoExStr(szProjectName, dwFlags, &vVarkeyIn,
&vVarkeyOut, &err);
if (!bRet)
{
printf("\r\n error DMGetVarInfoExStr[%s], err=%ld,%ld,%ld,%ld,
%ld,[%s]", szProjectName,
if (err.dwError1 == DM_E_DONT_EXIST)
{
//reset error, elements will be checked each for error in
type (VT_EMPTY == not exist)
bRet = TRUE;
}
}
else
{
printf("\r\n DMGetVarInfoExStr return OK");
}
if (bRet)
{
if (vVarkeyOut.vt == VT_EMPTY)
{
printf("\r\n vVarkeyOut is VT_EMPTY");
}
else
{
parrayOUT = vVarkeyOut.u.parray;
lInx = 0;
SafeArrayGetElement(parrayOUT, &lInx, &vElem);
if (vElem.vt != VT_I4)
{
printf("\r\n vVarKeyOut[%ld].vt = [%ld] != VT_I4", lInx,
vElem.vt);
dwVarID1 = 0L;
}
else
{

dwVarID1 = vElem.u.lVal;
}
SetTagDWord("dwVarKeyID_1",dwVarID1);
lInx = 1;
{
vElem.vt);
dwVarID2 = 0L;
}
else
{
}
lInx = 2;
if (vElem.vt != VT_BSTR)
{
printf("\r\n vVarKeyOut[%ld].vt = [%ld] != VT_BSTR",
lInx, vElem.vt);
strcpy(szVarNam3, "error!!!");
}
else
{
nRet = WideCharToMultiByte(CP_ACP, 0L,
(WCHAR*)vElem.u.bstrVal, -1,
szVarNam3, 256, NULL, NULL);
}
SetTagChar("szVarKeyName_3",szVarNam3);
lInx = 3;
if (vElem.vt != VT_BSTR)
{
printf("\r\n vVarKeyOut[%ld].vt = [%ld] != VT_BSTR",
lInx, vElem.vt);
}
else
{
nRet = WideCharToMultiByte(CP_ACP, 0L,
(WCHAR*)vElem.u.bstrVal, -1,
szVarNam4, 256, NULL, NULL);
}
printf("\r\n get vVarkeyOut:");
printf("\r\n dwVarID1=%ld, szVarNam1=[%s] (delivered ID)",

printf("\r\n dwVarID3=%ld, szVarNam3=[%s] (delivered name

VT_BSTR)", dwVarID3, szVarNam3);
VT_BSTR)", dwVarID4, szVarNam4);
}
}
printf("\r\n set flag DM_FLAG_RETURN_PROPVARIANT_VT_LPSTR and
repeat DMGetVarInfoExStr");
hr = VariantClear(&vVarkeyOut);
if (hr)
{
printf("\r\nerror VariantClear(vVarKeyOut: hr = %08lx", hr);
}
&vVarkeyOut, &err);
if (!bRet)
{
{
bRet = TRUE;
}
}
else
{
}
if (bRet)
{
{
}
else
{
parrayOUT = vVarkeyOut.u.parray;
lInx = 0;
{
vElem.vt);
dwVarID1 = 0L;
}
else

{
}
lInx = 1;
{
vElem.vt);
dwVarID2 = 0L;
}
else
{
}
SafeArrayLock(parrayOUT);
lInx = 2;
SafeArrayPtrOfIndex(parrayOUT, &lInx, &pvElem);
if (pvElem->vt != VT_LPSTR)
{
printf("\r\n vVarKeyOut[%ld].vt = [%ld] != VT_LPSTR",
lInx, pvElem->vt);
}
else
{
strncpy(szVarNam3, (LPSTR)pvElem->u.pbVal, 255);
szVarNam3[255] = 0;
}
lInx = 3;
SafeArrayPtrOfIndex(parrayOUT, &lInx, &pvElem);
if (pvElem->vt != VT_LPSTR)
{
printf("\r\n vVarKeyOut[%ld].vt = [%ld] != VT_LPSTR",
lInx, pvElem->vt);
}
else
{
strncpy(szVarNam4, (LPSTR)pvElem->u.pbVal, 255);
szVarNam4[255] = 0;
}
SafeArrayUnlock(parrayOUT);
printf("\r\n get vVarkeyOut:");



VT_LPSTR)", dwVarID3, szVarNam3);
VT_LPSTR)", dwVarID4, szVarNam4);
}
}
printf("\r\n only 1 Input (ID = VT_I4 and dwVarID1) without

VT_ARRAY, set flag DM_FLAG_RETURN_PROPVARIANT_VT_LPSTR and repeat
DMGetVarInfoExStr");
hr = VariantClear(&vVarkeyIn);
if (hr)
{
printf("\r\n error VariantClear(vVarKeyIn): hr = %08lx", hr);
// know that error, have to free the PROPVARIANT in Array manualy
//this can be set to VT_EMPTY direct, while no alloc of string
was used
parrayIN = vVarkeyIn.u.parray;
SafeArrayLock(parrayIN);
lInx = 1;
hr = SafeArrayPtrOfIndex(parrayIN, &lInx, &pvElem);
pvElem->vt = VT_EMPTY;
pvElem->u.pbVal = NULL;
SafeArrayUnlock(parrayIN);
hr = VariantClear(&vVarkeyIn);
if (hr)
{
printf("\r\n error VariantClear(vVarkeyIn) again after
manualy reset the PROPVARIANT in 2. elem: hr = %08lx", hr);
}
else
{
printf("\r\n VariantClear(vVarkeyIn) OK after manualy reset
the PROPVARIANT in 2. elem");
}
}
hr = VariantClear(&vVarkeyOut);
if (hr)
{
printf("\r\n error VariantClear(vVarkeyOut): hr = %08lx", hr);
}
vVarkeyIn.vt = VT_I4;
vVarkeyIn.u.lVal = dwVarID1;
&vVarkeyOut, &err);
if (!bRet)
{


{
bRet = TRUE;
}
}
else
{
}
if (bRet)
{
{
}
else
{
if (vVarkeyOut.vt != VT_LPSTR)
{
printf("\r\n vVarKeyOut.vt = [%ld] != VT_LPSTR",
vVarkeyOut.vt);
}
else
{
strncpy(szVarNam1, (LPSTR)vVarkeyOut.u.pbVal, 255);
szVarNam1[255] = 0;
}
}
}
printf("\r\n########## exit Test with DMGetVarInfoExStr ##########\r

\n");
3.2.6.18 DMGetVarLimits (RT Professional)
Use
DMGetVarLimits determines the limits for the specified tag, within which write operations are
possible with DMSetValue functions.

Declaration
BOOL DMGetVarLimits (
DWORD dwItems,
LPDM_VARLIMIT lpdmVarLimit,
Parameters
lpszProjectFile
lpdmVarKey
Pointer to a DM_VARKEY (Page 1594) type structure for specification of the tags.
dwItems
lpdmVarLimit
Pointer to the DM_VARLIMIT (Page 1597) type structure in which the limits are is stored.
lpdmError
Return value
TRUE
Limits determined.
FALSE
Error.
Comment
In addition to the high and low limits of a tag defined in the configuration, a further limit to the
allowed number range is set by any format specifications made.
The following example shows the relationships for a DM_VARTYPE_BYTE type tag that is
stored in an automation system as a byte in BCD format.

Error messages
DM_E_MAX_RANGE High limit of format conversion violated

DM_E_MIN_RANGE Low limit of format conversion violated
DM_E_MAX_LIMIT High limit of tag violated
DM_E_MIN_LIMIT Low limit of tag violated
DM_E_INVALID_TYPE Invalid tag type
Required files
dmclient.h
dmclient.lib
dmclient.dll
Examples
OnTestVariablenGetvarlimits (Page 1856) "TESTCDoc.cpp"
See also
OnTestVariablenGetvarlimits (Page 1856)
3.2.6.19 DMGetVarLimitsExStr (RT Professional)
Declaration
BOOL DMGetVarLimitsExStr (
LPDM_VARLIMIT lpdmVarLimit,
Description
For the tags specified, DMGetVarLimitsExStr determines the limits within which it is possible
to execute write operations using the DMSetValueExStr functions.
In contrast to DMGetVarLimits, the tag list is passed as pointer to VARIANT with VT_ARRAY
| VT_VARIANT. As a result, no length limit applies to tag names.

Parameters
lpszProjectFile
lpvdmVarKey
Pointer to VARIANT with VT_ARRAY | VT_VARIANT to pass the tag list or single VARIANT
when only one tag is specified.
lpdmVarLimit
Pointer to structures of the DM_VARLIMIT type to store the limit values.
lpdmError
Return value
TRUE
Limit values have been determined
FALSE
Error
Comment
In addition to the configured high and low limits of a tag, a stored format instruction leads to a
further restriction of the valid numerical value range.
The following sample explains this situation for a tag of the DM_VARTYPE_BYTE type stored
in the AS in the BCD byte format.
Error messages



DM_E_INVALID_TYPE Invalid tag type
Required files
dmclient_exstr.h
dmclient.lib
dmclient.dll
Examples
Script sample Button DMGetVarLimitsExStr:
lpszPropertyName)
{
int cElements );
#pragma code()
VARIANT vdmVarkey;
VARIANT* pvElem;
VARIANT vElem;
HRESULT hr;
CMN_ERROR err;
BOOL bRet;
SAFEARRAY* parray;
long lInx;
int nRet;
DM_VARLIMIT dmLimits[4];
int i;
bRet = FALSE;
VariantInit(&vElem);
VariantInit(&vdmVarkey);
parray = NULL;
nRet = 0;
i = 0;

printf("\r\n\r\n########## enter Test with DMGetVarLimitsExStr

##########");

if (!bRet)
{
}

printf("\r\n set the vdmVarkey with names in VT_LPSTR:");
parray = SafeArrayCreateVector(VT_VARIANT, 0L, 4);
vdmVarkey.vt = (VT_ARRAY | VT_VARIANT);
vdmVarkey.u.parray = parray;
SafeArrayLock(parray);
lInx = 0;
hr = SafeArrayPtrOfIndex(parray, &lInx, &pvElem);
lInx = 1;
lInx = 2;
lInx = 3;
SafeArrayUnlock(parray);
memset(dmLimits, 0, sizeof(DM_VARLIMIT)*4);
bRet = DMGetVarLimitsExStr(szProjectName, &vdmVarkey, dmLimits,
&err);
if (!bRet)
{
printf("\r\n error DMGetVarLimitsExStr[%s], err=%ld,%ld,%ld,%ld,
bRet = TRUE; //clear error flag, the defect data is set to VT_EMPTY
}
else

{
printf("\r\n DMGetVarLimitsExStr return OK");
}
if (bRet)
{
for (i = 0; i < 4; i++)
{
printf("\r\n dmLimits[%d]:{",i);
hr = VariantChangeType((VARIANTARG*)&vElem,
(VARIANTARG*)&dmLimits[i].dmMaxRange, 0, VT_R8);
if ((0L == hr) && (VT_R8 == vElem.vt) && (VT_EMPTY !=
dmLimits[i].dmMaxRange.vt))
{
printf("dmMaxRange=[%g], ", vElem.u.dblVal);
}
else
{
printf("dmMaxRange{VariantChangeType error hr = 0x%08lx,
vt=0x%04x}",
hr, dmLimits[i].dmMaxRange.vt);
}
(VARIANTARG*)&dmLimits[i].dmMinRange, 0, VT_R8);
dmLimits[i].dmMinRange.vt))
{
printf("dmMinRange=[%g], ", vElem.u.dblVal);
}
else
{
printf("dmMinRange{VariantChangeType error hr = 0x%08lx,
vt=0x%04x}",
hr, dmLimits[i].dmMinRange.vt);
}
(VARIANTARG*)&dmLimits[i].dmMaxLimit, 0, VT_R8);
dmLimits[i].dmMaxLimit.vt))
{
printf("dmMaxLimit=[%g], ", vElem.u.dblVal);
}
else
{
printf("dmMaxLimitVariantChangeType error hr = 0x%08lx,
vt=0x%04x}",
hr, dmLimits[i].dmMaxLimit.vt);
}

(VARIANTARG*)&dmLimits[i].dmMinLimit, 0, VT_R8);
dmLimits[i].dmMinLimit.vt))
{
printf("dmMinLimit=[%g]", vElem.u.dblVal);
}
else
{
printf("dmMinLimitVariantChangeType error hr = 0x%08lx,
vt=0x%04x}",
hr, dmLimits[i].dmMinLimit.vt);
}
printf("}");
}
}
printf("\r\n########## exit Test with DMGetVarLimitsExStr ##########

\r\n");
3.2.6.20 DMGetVarType (RT Professional)
Use
DMGetVarType determines the type reference for the passed tags.
Declaration
BOOL DMGetVarType (
DWORD dwItems,
LPDM_TYPEREF lpdmTypeRef,
Parameters
lpszProjectFile

lpdmVarKey
Pointer to the DM_VARKEY (Page 1594) structure with which the tag keys determined for the
type.
dwItems
lpdmTypeRef
Pointer to the list of DM_TYPEREF (Page 1579) structures for returning the details about the
tag type.
lpdmError
Return value
TRUE
Data type determined.
FALSE
Error.
Comment
The configuration functions for creating tags pass the completed DM_VARREF and
DM_TYPEREF structures to the calling application with details of the data type of the tag.
To save memory space within the application, it does not necessarily have to remember the
type reference to each tag itself; it can query this information with DMGetVarType at any time
from the data manager.
Do not use the call alternating with calls for creating tags. If DMGetVarType is used after
creating a tag the first time, search lists are resorted, which costs an additional execution time.
Error messages

Required files
dmclient.h
dmclient.lib
dmclient.dll

Examples
OnTestVariablenGetvartype (Page 1857) "TESTCDoc.cpp"
See also
OnTestVariablenGetvartype (Page 1857)
3.2.6.21 DMGetVarTypeExStr (RT Professional)
Declaration
BOOL DMGetVarTypeExStr (
LPDM_TYPEREF_EXSTR lpdmTypeRef,
Description
Determines the type reference for the tags passed.
In contrast to DMGetVarType, the tag list is passed as pointer to VARIANT with VT_ARRAY
| VT_ VARIANT. As a result, no length limit applies to tag names. This applies also for the type
names in the DM_TYPEREF_EXSTR structures.
Parameters
lpszProjectFile
lpvdmVarKey
Pointer to VARIANT with VT_ARRAY | VT_VARIANT for passing the tag list.
lpdmTypeRef
Pointer to the list of DM_TYPEREF_EXSTR structures that return tag type information.

The list must have at least the size of the variant array in lpvdmVarKey. The pointers
lpszTypeName and dwBufferCount must be initialized and point to a separate string array.
If lpszTypeName is NULL check the return. Allocated pointer has to enable it again.
lpdmError
Return value
TRUE
Data type has been determined
FALSE
Error
Comment
In order to economize the memory management within the application, the application is not
forced to store the type reference for each tag. Instead, it can obtain this information from the
data manager anytime by means of DMGetVarType.
This call should not be used alternately with calls for creating tags. Whenever the
"DMGetVarType" or "DMGetVarTypeExStr" function is used for the first time after creating a
tag, search lists must be sorted again. This requires additional runtime.
Error messages

Required files
dmclient_exstr.h
dmclient.lib
dmclient.dll
Examples
Script sample Button DMGetVarTypeExStr:
lpszPropertyName)
{


int cElements );
#pragma code()
VARIANT vdmVarkey;
VARIANT* pvElem;
HRESULT hr;
CMN_ERROR err;
BOOL bRet;
SAFEARRAY* parray;
long lInx;
int nRet;
DM_TYPEREF_EXSTR dmTypeRef[4];
CHAR szTypeName[4][256];
int i;
memset(dmTypeRef, 0, sizeof(DM_TYPEREF_EXSTR)*4);
szTypeName[0][0] = 0;
bRet = FALSE;
VariantInit(&vdmVarkey);
parray = NULL;
nRet = 0;
i = 0;
printf("\r\n\r\n########## enter Test with DMGetVarTypeExStr

##########");

if (!bRet)
{
}

printf("\r\n set the vdmVarkey with names in VT_LPSTR:");

parray = SafeArrayCreateVector(VT_VARIANT, 0L, 4);

vdmVarkey.vt = (VT_ARRAY | VT_VARIANT);
vdmVarkey.u.parray = parray;
SafeArrayLock(parray);
lInx = 0;
lInx = 1;
lInx = 2;
lInx = 3;
SafeArrayUnlock(parray);
printf("\r\n call DMGetVarTypeExStr with NULL for names");

bRet = DMGetVarTypeExStr(szProjectName, &vdmVarkey, dmTypeRef, &err);
if (!bRet)
{
printf("\r\n error DMGetVarTypeExStr[%s], err=%ld,%ld,%ld,%ld,
}
else
{
printf("\r\n DMGetVarTypeExStr return OK");
}
if (bRet)
{
for (i = 0; i < 4; i++)
{
printf("\r\n dmTypeRef[%d]:{",i);
printf("dwType=[%ld]", dmTypeRef[i].dwType);
printf(", dwSize=[%ld]", dmTypeRef[i].dwSize);
if (dmTypeRef[i].lpszTypeName)
{
printf(", lpszTypeName=[%s]", dmTypeRef[i].lpszTypeName);
printf(", dwNameCharCount=[%ld]",
dmTypeRef[i].dwNameCharCount);
//clear the delivered strings that no memoryleak
free(dmTypeRef[i].lpszTypeName);
dmTypeRef[i].lpszTypeName = NULL;
dmTypeRef[i].dwNameCharCount = 0L;

//set name store for next read (no need to free after
call)
dmTypeRef[i].lpszTypeName = szTypeName[i];
dmTypeRef[i].dwNameCharCount = 255;
}
printf("}");
}
}
printf("\r\n call DMGetVarTypeExStr with pointers and size for name
storage");
bRet = DMGetVarTypeExStr(szProjectName, &vdmVarkey, dmTypeRef, &err);
if (!bRet)
{
printf("\r\n error DMGetVarTypeExStr[%s], err=%ld,%ld,%ld,%ld,
}
else
{
printf("\r\n DMGetVarTypeExStr return OK");
}
if (bRet)
{
for (i = 0; i < 4; i++)
{
printf("\r\n dmTypeRef[%d]:{",i);
printf("dwType=[%ld]", dmTypeRef[i].dwType);
printf(", dwSize=[%ld]", dmTypeRef[i].dwSize);
printf(", lpszTypeName=[%s]", dmTypeRef[i].lpszTypeName);
dmTypeRef[i].dwNameCharCount);
printf("}");
}
}
printf("\r\n########## exit Test with DMGetVarTypeExStr ##########\r
\n");
3.2.6.22 DMSetValue (RT Professional)
Use
The function changes the values of the tags described by lpdmVarKey to the values specified
in lpdmValue.
Changes are made to the tags asynchronously, according to the motto "fire and forget".

Declaration
BOOL DMSetValue (
DWORD dwItems,
LPVARIANT lpdmValue,
LPDWORD lpdmVarState,
Parameters
lpdmVarKey
Pointer to the first DM_VARKEY (Page 1594) structure that identifies the tag values to be
changed.
dwItems
Number of passed structures (corresponds to the number of tag values to be changed).
lpdmValue
Pointer to the first of the new values for the tags to be changed.
lpdmVarState
Pointer to the first memory location where information is stored indicating whether the tag value
could be changed successfully or whether errors have occurred.
The value 0 (OK) means that the transmission/modification has been completed successfully
and that at least one of the specified tags exists. An error with the
DM_VARSTATE_INVALID_KEY status only occurs if none of the specified tags exist.
DMSetValueWait must be used to check if the value has been applied.
DM_VARSTATE_NOT_ESTABLISHED (0x0001) Connection to partner not established

DM_VARSTATE_CONVERSION_ER‐ (0x0080) Display conversion error (in conjunc‐
ROR tion with DM_VARSTATE_..._RANGE)
DM_VARSTATE_ADDRESS_ERROR (0x0400) Addressing error in channel

lpdmError
Return value
TRUE
Tags changed.
FALSE
Error.
Comment
Specification of an access rule for lpdmValue is not necessary, since the data manager can
map each type based on the passed tag key.
Write access is performed in the process for external tags. For WinCC client PCs, the request
is forwarded to the respective server.
Normally, write requests of the applications are executed asynchronously. All write requests
are listed in the queue of the data manager on the server and passed sequentially to the
appropriate channel DLL.
If the channel DLL positively confirms the write request, the new value becomes valid in the
process image of the server responsible for the request. The update is then performed within
the WinCC stations which are interconnected by means of the system bus.
As a result, a tag can temporarily have different values on different stations.
Error messages

DM_E_ACCESS_FAULT Prohibited write access to a tag
Required files
dmclient.h
dmclient.lib
dmclient.dll

Related functions

put
Examples
Write tag (Page 1869) "DM02.cpp"
OnTestVariablenSetvalue (Page 1859) "TESTCDoc.cpp"
See also
Write tag (Page 1869)
OnTestVariablenSetvalue (Page 1859)
3.2.6.23 DMSetValueExStr (RT Professional)
Declaration
BOOL DMSetValueExStr (
LPVARIANT lpvdmValue,
Description
This function changes the values of the tags described by lpvdmVarKey to obtain the values
specified in lpvdmValue.
Tag modifications are transmitted in asynchronous mode according to the principle "fire and
forget".

In contrast to DMSetValue, the tag list is passed on as pointer to VARIANT with VT_ARRAY
| VT_VARIANT. As a result, no length limit applies to tag names.
Parameters
lpvdmVarKey
Pointer to VARIANT with VT_ARRAY | VT_VARIANT for passing on the tag list or single
VARIANT if only one tag is specified.
For a multi-client project in WinCC Version 5.0 or higher, it may be required here to add a
server prefix to each name (refer to "Project types and versions" ).
lpvdmValue
lpdmVarState
Pointer to a memory location which stores the information whether the value of the tag could
be changed successfully or if errors occurred.
The value "0" (OK) means that the transmission/modification has been completed successfully
and that at least one of the specified tags is existing. The DM_VARSTATE_INVALID_KEY
error status is only returned if none of the specified tags exists.
In order to check if the value has been applied by the PLC also, DMSetValueWaitExStr must
be used.

DM_VARSTATE_CONVERSION_ER‐ (0x0080) Conversion error display (in connec‐

lpdmError
Return value
TRUE
Tags changed.
FALSE
Error
Comment
It is not necessary to specify an access instruction for lpdmValue because the tag keys passed
enable the data manager to allocate the information appropriately.
For external tags, write access to the process is obtained while the job is passed on to the
appropriate server by WinCC client computers.
The write jobs of the application are normally executed in asynchronous mode, i.e. all write
jobs are lined up in the queue which the data manager keeps on the server, and then passed
on to the appropriate channel DLL sequentially.
If the channel DLL confirms the write job affirmatively, the new value becomes valid in the
process image of the server responsible for the job. The update is then performed within the
WinCC stations which are interconnected by means of the system bus.
As a result, a tag can temporarily have different values on different stations.
Error messages

DM_E_ACCESS_FAULT Prohibited write access to a tag
Required files
dmclient_exstr.h
dmclient.lib
dmclient.dll

Related functions
DMGetValueExStr Get tag values

DMSetValueMessageExStr Change tag values with alarm output
DMSetValueWaitMessageExStr Change tag values with notification and alarm out‐
put
Examples
3.2.6.24 DMSetValueMessage (RT Professional)
Use
The function changes the value of the tag described by lpdmVarKey to the value specified in
lpdmValue.
Only one tag is changed, in contrast to the DMSetValue function. After successful update of
the tag value, a freely definable alarm text is generated.
Declaration
BOOL DMSetValueMessage (
DWORD fFlags,
LPSTR lpszMessage,
Parameters
lpdmVarKey
Pointer to the DM_VARKEY (Page 1594) structure that identifies the tag to be changed.
A server prefix (see project types and versions) may also specified in lpdmVarKey->szName
for multiclient projects as of WinCC Version 5.0.
lpdmValue
Pointer to the new value of the tag to be changed.

fFlags
fFlags determines how the alarm text is processed:
DMSVM_OPERATIONREPORT The alarm is stored in the operator input log.

DMSVM_OPERATIONMESSAGE The alarm is output as an operator input alarm.
lpszMessage
Text of the alarm to be transmitted.
lpdmError
Return value
TRUE
Tag changed.
FALSE
Error.
Comment
You can find more information about changing tag values at the DMSetValue function.
Error messages

Required files
dmclient.h
dmclient.lib
dmclient.dll
Related functions

put

See also
3.2.6.25 DMSetValueMessageExStr (RT Professional)
Declaration
BOOL DMSetValueMessageExStr (
DWORD fFlags,
LPTSTR lpszMessage,
Description
This function changes the value of the tag described by lpvdmVarKey to obtain the value
specified in lpdmValue.
In contrast to the DMSetValueExStr function, only one tag can be changed at a time. If the tag
value has been changed successfully, a alarm text of your choice is transmitted.
Parameters
lpvdmVarKey
Pointer to VARIANT for passing on the tag name or TagID or single VARIANT, if only one tag
is specified that identifies the tags to be changed.
If you specify an array using VT_ARRAY | VT_VARIANT, only the first element is evaluated.
For a multi-client project in WinCC Version 5.0 or higher, it may be required in this case to add
a server prefix to each name (refer to "Project types and versions" ).
lpvdmValue

fFlags
fFlags specifies how to process the alarm text:

lpszMessage
lpdmError
Return value
TRUE
Tags have been changed
FALSE
Error
Comment
For more information on changing the values of tags refer to the DMSetValueExStr function.
Error messages

Required files
dmclient_exstr.h
dmclient.lib
dmclient.dll
Related functions

put

3.2.6.26 DMSetValueWait (RT Professional)
Use
The function changes the values of the tags described by lpdmVarKey to the values specified
in lpdmValue.
In contrast to DMSetValue, DMSetValueWait allows the application to be notified when the
update is successfully completed on the local machine.
Declaration
BOOL DMSetValueWait (
LPDWORD pdwTAID,
DWORD dwItems,
DWORD dwTimeOut,
DM_COMPLETITION_PROC lpfnCompletition,
LPVOID lpvUser,
Parameters
pdwTAID
lpdmVarKey
Pointer to the first DM_VARKEY (Page 1594) structure that identifies the tag values to be
changed.
dwItems
Number of passed structures (corresponds to the number of tag values to be changed).
lpdmValue
dwTimeout
Maximum waiting time of the application in ms. If, after expiration of the waiting period, not all
tags have been written, the callback function is called with appropriate error code.
lpfnCompletition
Pointer to your callback function, which is called either after the update of all requested tags
or after the waiting period.

lpvUser
lpdmError
Return value
TRUE
Tags changed.
FALSE
The error which occurred can be identified by means of the error structures.
Comment
Error messages

Required files
dmclient.h
dmclient.lib
dmclient.dll
Related functions

put
DM_COMPLETITION_PROC (Page 1754) Change tag values (callback)

Examples
OnTestVariablenSetvaluewait (Page 1860) "TESTCDoc.cpp"
See also
DM_COMPLETITION_PROC (Page 1754)
OnTestVariablenSetvaluewait (Page 1860)
3.2.6.27 DMSetValueWaitExStr (RT Professional)
Declaration (
BOOL DMSetValueWaitExStr (
LPDWORD pdwTAID,
DWORD dwItems,
LPDWORD lpdwState,
DWORD dwTimeOut,
LPVOID lpvUser,
Description
This function changes the values of the tags described by lpvdmVarKey to obtain the values
specified in lpvdmValue.
In contrast to the DMSetValueExStr function, DMSetValueWaitExStr enables your application
to display a notify message on the local computer if the update has been executed.
In contrast to DMSetValueWait, the tag list is passed on as pointer to VARIANT with
VT_ARRAY | VT_VARIANT. As a result, no length limit applies to tag names.

Parameters
pdwTAID
lpvdmVarKey
Pointer to VARIANT with VT_ARRAY | VT_VARIANT for passing on the tag list or single
VARIANT if only one tag is specified.
For multi-client projects in WinCC Version 5.0 or higher, it may be required here to add a server
prefix (refer to "Project types and versions" ).
dwItems
Number of values passed in lpvdmValue and error structures in IpdmError. The number must
be at least as large as the input array in lpvdmVarKey.
If the number is larger than the input array, the excess values are ignored and DM_E_PARAM
is assigned to the affected error structures, as no allocation is possible.
If the number is less than the input array, the error DM_E_PARAM is returned only in the first
error structure and no values are written.
lpvdmValue
lpdwState
Pointer to a memory location which stores the information whether the value of the tag could
be changed successfully or if errors occurred.
The value 0 (OK) means that the transmission/modification has been completed successfully
and that at least one of the specified tags exists. The DM_VARSTATE_INVALID_KEY error
status is only returned if none of the specified tags exists.

DM_VARSTATE_CONVERSION_ER‐ (0x0080) Conversion error display (in connec‐


dwTimeout
lpfnCompletition
Pointer to the callback function which is called either after all requested tags have been updated
or after the waiting time has expired.
lpvUser
lpdmError
Pointer to the first dwItems error structure of the CMN_ERROR type. If a tag writing error
occurs, the system writes the error information into the corresponding structure. Therefore,
you should not forget to reserve space for these structures.
Return value
TRUE
FALSE
The error which occurred can be identified by means of the error structures.
Comment
Error messages

Required files
dmclient_exstr.h

dmclient.lib
dmclient.dll
Related functions

put
DM_COMPLETITION_PROC Change tag values (callback)
Examples
3.2.6.28 DMSetValueWaitMessage (RT Professional)
Use
The function combines the functions of DMSetValueMessage and DMSetValueWait. Only one
tag can be changed, in contrast to the DMSetValueWait function.
The value of the tag described by lpdmVarKey is changed to the value specified in lpdmValue.
Once the tag is successfully changed, a freely definable alarm text is output and the application
can be be notified that the update has been successfully performed on the local machine.
Declaration
BOOL DMSetValueWaitMessage (
LPDWORD pdwTAID,
DWORD dwTimeOut,
DWORD fFlags,
LPSTR lpszMessage,
LPVOID lpvUser,
Parameters
pdwTAID

lpdmVarKey
Pointer to the DM_VARKEY (Page 1594) structure that identifies the tag to be changed.
lpdmValue
dwTimeOut
Maximum waiting time of the application in ms. If, after expiration of the waiting period, not all
tags have been written, the callback function is called with appropriate error code.
lpfnCompletition
Pointer to your callback function, which is called either after the update of all requested tags
or after the waiting period.
fFlags
fFlags determines how the alarm text is processed:

lpszMessage
Alarm text that is output.
lpvUser
lpdmError
Return value
TRUE
Tags changed.
FALSE
Error.
Comment

Error messages

Required files
dmclient.h
dmclient.lib
dmclient.dll
Related functions
DM_COMPLETITION_PROC (Page 1754) Change tag values (callback)

See also
OnTestVariablenSetvaluewait (Page 1860)
DM_COMPLETITION_PROC (Page 1754)
3.2.6.29 DMSetValueWaitMessageExStr (RT Professional)
Declaration
BOOL DMSetValueWaitMessageExStr (
LPDWORD pdwTAID,
DWORD dwTimeOut,
DWORD fFlags,
LPTSTR lpszMessage,
LPVOID lpvUser,

Description
This function combines the functionalities of DMSetValueMessageExStr and
DMSetValueWaitExStr.
In contrast to the DMSetValueWaitExStr function, only one tag can be changed at a time.
The value of the tag described by lpvdmVarKey is changed to obtain the value specified in
lpvdmValue. If the tag value has been changed successfully, a alarm text of your choice is
transmitted. The application also has the option to display a notify message on the local
computer if the update has been executed.
In contrast to DMSetValueWaitMessage, the tag list is passed on as pointer to VARIANT. As
a result, no limitation applies to the length of the tag names.
Parameters
pdwTAID
lpvdmVarKey
Pointer to VARIANT for passing on the tag name, TagID or single VARIANT, if only one tag is
specified that identifies the tags to be changed.
lpvdmValue
dwTimeOut
lpfnCompletition
Pointer to the callback function which is called either after all requested tags have been updated
or after the waiting time has expired.

fFlags
fFlags specifies how to process the alarm text:

lpszMessage
lpvUser
lpdmError
Pointer to the first dwItems error structure of the CMN_ERROR type. If a tag writing error
occurs, the system writes the error information into the corresponding structure. Therefore,
remember to reserve space for these structures.
Return value
TRUE
FALSE
Error
Comment
Error messages

Required files
dmclient_exstr.h
dmclient.lib
dmclient.dll

Related functions
DM_COMPLETITION_PROC Change tag values (callback)

3.2.6.30 DM_COMPLETITION_PROC (RT Professional)
Description
You need to provide a DM_COMPLETITION_PROC type callback function in order for your
application to notified that tag values have been successfully changed.
Declaration
BOOL ( * DM_COMPLETITION_PROC) (
DWORD dwTAID,
DWORD dwItems,
LPVOID lpvUser);
Parameters
dwTAID
Transaction ID that was assigned by the data manager for the function to change the tag values.
lpdmVarState
Pointer to the first memory location where information is stored indicating whether the tag
values could be changed successfully or whether errors have occurred.
A 0 (OK) means successfully sent/changed and at least one of the specified tag exists. An
error with the DM_VARSTATE_INVALID_KEY status only occurs if none of the specified tags
exist.

DM_VARSTATE_CONVERSION_ERROR (0x0080) Display conversion error (in conjunc‐
tion with DM_VARSTATE_..._RANGE)


dwItems
Number of tag changes, the status of which is passed in lpdmVarState.
lpvUser
function.
Return value
The return values depend on your implementation
Note
Required files
dmclient.h
Related functions

put
See also

3.2.6.31 DMShowVarPropertiesExStr (RT Professional)
Declaration
BOOL DMShowVarPropertiesExStr (
HWND hwndParent,
LPCTSTR lpszVariableName,
DWORD dwVariableID,
Description
This function opens the dialog box for editing the properties of tags.
Parameters
lpszProjectFile
hwndParent
lpszVariableName
Pointer to the name of the tag whose properties are displayed.
If lpszVariableName is "NULL" you must specify a valid dwVariableID. If not, the
DM_E_PARAM error is returned.
dwVariableID
ID of the tag. Is not used if a name is specified in lpszVariableName.
lpdmError
Return value
TRUE

FALSE
Error or close dialog with "Cancel"
Error messages

DM_E_PARAM At least one parameter is passed on with errors
Required files
dmclient_exstr.h
dmclient.lib
dmclient.dll
Examples
Script sample Button DMShowVarDatabaseExStr:
lpszPropertyName)
{
BOOL bRet = FALSE;
CHAR szVariableName[256];
DWORD dwVariableID;
CMN_ERROR err;
HWND hwndParent;
szVariableName[0] = 0;
dwVariableID = 0L;
hwndParent = NULL;
printf("\r\n\r\n########## enter Test with DMShowVarDatabaseExStr

##########");

if (!bRet)
{
}

dwVariableID = GetTagDWord("dwVarKeyID_1");
printf("\r\n call DMShowVarPropertiesExStr with ID");
bRet = DMShowVarPropertiesExStr(szProjectName, hwndParent, NULL,
dwVariableID, &err);
if (!bRet)
{
printf("\r\n error DMShowVarPropertiesExStr: err=%ld,%ld,%ld,
%ld,%ld,[%s]",
}
else
{
printf("\r\n DMShowVarPropertiesExStr OK!");
}
strncpy(szVariableName, GetTagChar("szVarKeyName_1"), 255);

printf("\r\n call DMShowVarPropertiesExStr with VarName");

bRet = DMShowVarPropertiesExStr(szProjectName, hwndParent,
szVariableName, 0L, &err);
if (!bRet)
{
printf("\r\n error DMShowVarPropertiesExStr: err=%ld,%ld,%ld,
%ld,%ld,[%s]",
}
else
{
printf("\r\n DMShowVarPropertiesExStr OK!");
}
printf("\r\n########## exit Test with DMShowVarProperitesExStr

##########\r\n");
}
3.2.6.32 DMShowVarDatabase (RT Professional)
Use
This function opens the tag selection dialog for the project specified. Only one tag is selected,
in contrast to the ShowVarDatabaseMulti function.

Declaration
BOOL DMShowVarDatabase (
HWND hwndParent,
LPDM_DLGOPTIONS lpdmOptions,
LPDM_VARFILTER lpdmFilter,
Parameters
lpszProjectFile
hwndParent
lpdmOptions
Pointer to the DM_DLGOPTIONS (Page 1572) structure with specifications on how the dialog
should react. When the pointer is NULL, the standard dialog is selected.
lpdmFilter
Pointer to the DM_VARFILTER (Page 1586) filter structure. When the pointer is NULL , all tags
are displayed.
Only filtering by tag name and tag type is supported. Tag group and tag connection filtering is
not implemented.
lpdmVarKey
Pointer to the DM_VARKEY (Page 1594) structure. If the properties of a tag to be displayed,
lpdmVarKey contains the key to this tag after the dialog closed.
lpdmError
Return value
TRUE
FALSE
Error or close dialog with "Cancel".

Error messages

DM_E_INV_PRJ Specified project not found / loaded
Required files
dmclient.h
dmclient.lib
dmclient.dll
Related functions
See also
DM_DLGOPTIONS (Page 1572)
3.2.6.33 DMShowVarDatabaseExStr (RT Professional)
Declaration
BOOL DMShowVarDatabaseExStr (
HWND hwndParent,
LPTSTR* lppszVariableName,
LPDWORD lpdwVarNameCharCount,
LPDWORD lpdwVariableID,
Description
This function opens the tag selection dialog for the project specified. In contrast to
ShowVarDatabaseMultiExStr, only one tag can be selected.

Parameters
lpszProjectFile
hwndParent
lpdmOptions
Pointer to the DM_DLGOPTIONS structure containing instructions for the dialog; if NULL =>
standard dialog.
lpdmFilter
Pointer to the DM_VARFILTER filter structure. If NULL, all tags are displayed.
Only tag name and tag type filtering are supported. Tag group and tag connection filtering is
not implemented.
lpszVariableName
Pointer to pointer of the return buffer for the tag name.
If NULL, a valid pointer to lpdwVariableID must be present. Then, only the ID and no name is
returned. "dwVarNameCharCount" is not considered. If both pointers are NULL,
DM_E_PARAM is returned.
If the internal pointer is NULL, the buffer is allocated and returned. The size is returned in
lpdwVarNameCharCount.
lpdwVarNameCharCount
Pointer to a DWORD which stores the size of the return buffer. The size must be selected big
enough to store the tag name with zero termination.
If the buffer is too small, the truncated name is stored and the DM_E_OOM error returned.
lpdwVariableID
Pointer to a DWORD which stores the tag ID.
If NULL, a valid pointer to lpdwVariableName and a valid size in dwVarNameCharCount must
be present. Then, only the tag name will be returned.
Return of the tag ID cannot always be guaranteed, e.g. PackageTag, specific S7 tags etc. In
these cases, 0 is returned.
Under certain conditions, the information can be complemented by a subsequent call of
DMGetVarInfoExStr.
lpdmError

Return value
TRUE
FALSE
Error messages

DM_E_PARAM Parameter not consistent
DM_E_OOM Memory error: the buffer lpszVariableName is
specified too small in dwVarNameCharCount and
the name was truncated
Required files
dmclient_exstr.h
dmclient.lib
dmclient.dll
Related functions
DMShowVarDatabaseMultiExStr Open tag selection dialog
Examples
Script sample Button DMShowVarDatabaseExStr:
lpszPropertyName)
{
BOOL bRet = FALSE;
CMN_ERROR err;
HWND hwndParent;
CHAR szVariableName[256];
LPSTR pszVariableName;
DWORD dwVarNamCharCount = 256;
DWORD dwVarID = 0L;
hwndParent = NULL;
pszVariableName= szVariableName;

printf("\r\n\r\n########## enter Test with DMShowVarDatabaseExStr

##########");

if (!bRet)
{
}
bRet = DMShowVarDatabaseExStr(szProjectName, hwndParent, NULL, NULL,

&pszVariableName, &dwVarNamCharCount,
&dwVarID, &err);
if (!bRet)
{
printf("\r\n error DMShowVarDatabaseExStr: err=%ld,%ld,%ld,%ld,
%ld,[%s]",
}
else
{
printf("\r\n DMShowVarDatabaseEsStr OK! (set to first line)");
printf("\r\n szVarName=[%s], dwVarID=[%ld]", szVariableName,
dwVarID);
SetTagChar("szVarKeyName_1",szVariableName);
SetTagDWord("dwVarKeyID_1",dwVarID);
}
3.2.6.34 DMShowVarDatabaseMulti (RT Professional)
Use
This function opens the tag selection dialog for the project specified. Several tags can be
selected, in contrast to ShowVarDatabase.

Declaration
BOOL DMShowVarDatabaseMulti (
HWND hwndParent,
LPDWORD lpdwItems,
DM_NOTIFY_SELECT_VAR_PROC lpfnVariables,
LPVOID lpvUser,
Parameters
lpszProjectFile
hwndParent
lpdmOptions
Pointer to the DM_DLGOPTIONS (Page 1572) structure with specifications on how the dialog
should react. The standard dialog is used with NULL.
lpdmFilter
Pointer to the DM_VARFILTER (Page 1586) filter structure. All tags are displayed with NULL,.
Only filtering by tag name and tag type is supported. Tag group and tag connection filtering is
not implemented.
lpdwItems
Pointer to a DWORD buffer that receives the number of selected tags.
lpfnVariables
Pointer to your callback function that is called for every selected tag.
lpvUser
lpdmError

Return value
TRUE
FALSE
Error messages

Required files
dmclient.h
dmclient.lib
dmclient.dll
Related functions

DM_NOTIFY_SELECT_VAR_PROC (Page 1769) Open tag selection dialog (callback)
See also
DM_DLGOPTIONS (Page 1572)
DM_NOTIFY_SELECT_VAR_PROC (Page 1769)

3.2.6.35 DMShowVarDatabaseMultiExStr (RT Professional)
Declaration
BOOL DMShowVarDatabaseMultiExStr (
HWND hwndParent,
LPDWORD lpdwItems,
DM_NOTIFY_SELECT_VAR_PROC_EXSTR lpfnVariables,
LPVOID lpvUser,
Description
This function opens the tag selection dialog for the project specified. In contrast to
ShowVarDatabaseExStr, multiple tags can be selected.
Parameters
lpszProjectFile
hwndParent
lpdmOptions
Pointer to the DM_DLGOPTIONS structure containing instructions for the dialog; if NULL =>
standard dialog.
lpdmFilter
Pointer to the DM_VARFILTER filter structure. If NULL, all tags are displayed.
Only tag name and tag type filtering are supported. Tag group and tag connection filtering is
not implemented.
lpdwItems
Pointer to a DWORD buffer to store the number of tags selected in total.
lpfnVariables
Pointer to the callback function which is called for each selected tag.

lpvUser
lpdmError
Return value
TRUE
FALSE
Error messages

Required files
dmclient_exstr.h
dmclient.lib
dmclient.dll
Related functions
DMShowVarDatabaseExStr Open tag selection dialog

DM_NOTIFY_SELECT_VAR_PROC_EXSTR Open tag selection dialog (callback)
Examples
Script sample Button DMShowVarDatabaseMultiExStr:
lpszPropertyName)
{
extern BOOL DM_NotifySelectVarProcA(LPCSTR lpszVariableName, DWORD
dwVariableID, LPVOID lpvUser);
BOOL bRet = FALSE;

CMN_ERROR err;

HWND hwndParent;
DWORD dwItems;
DWORD dwInxDecr;
hwndParent = NULL;
dwItems = 0;
dwInxDecr = 4; /*for decrement index to save in DM tags from callback
set to lpvUser*/
printf("\r\n\r\n########## enter Test with

DMShowVarDatabaseMultiExStr ##########");

if (!bRet)
{
}
bRet = DMShowVarDatabaseMultiExStr(szProjectName, hwndParent, NULL,

NULL,
&dwItems, DM_NotifySelectVarProcA,
&dwInxDecr, &err);
if (!bRet)
{
printf("\r\n error DMShowVarDatabaseMultiExStr: err=%ld,%ld,%ld,
%ld,%ld,[%s]",
}
else
{
printf("\r\n DMShowVarDatabaseExStrMulti OK!");
printf("\r\n [%ld] Var's selected", dwItems);
}
printf("\r\n########## exit Test with DMShowVarDatabaseMultiExStr

##########\r\n");
}
Script sample Project-Function DM_NotifySelectVarProcA:
BOOL DM_NotifySelectVarProcA(LPCSTR lpszVariableName, DWORD

dwVariableID, LPVOID lpvUser)
{
BOOL bRet = TRUE;
DWORD* pdwInxDecr = NULL;

pdwInxDecr = (DWORD*)lpvUser;
printf("\r\n\r\n#### DM_NotifySelectVarProc entry: ####");

printf("\r\n VarName=[%s], VarID=[%ld], lpvUser=[0x%08lx]",
lpszVariableName, dwVariableID, lpvUser);
if (pdwInxDecr)
{
// handle max 4 outputs, ignore all others
if(4 == *pdwInxDecr )
{
SetTagChar("szVarKeyName_4",lpszVariableName);
SetTagDWord("dwVarKeyID_4",dwVariableID);
printf("\r\n save in szVarKeyName_4 and dwVarKeyID_4");
}
{
}
{
}
{
}
}
if (pdwInxDecr && (0L < *pdwInxDecr))
{
*pdwInxDecr = *pdwInxDecr - 1L;
printf("\r\n Inx=%ld", *pdwInxDecr);
}
printf("\r\n#### DM_NotifySelectVarProc exit ####\r\n");
return bRet;
}
3.2.6.36 DM_NOTIFY_SELECT_VAR_PROC (RT Professional)
Description
In order to evaluate the tags selected by the DMShowVarDatabaseMulti function, you must
provide a DM_NOTIFY_SELECT_VAR_PROC type callback function.

Declaration
BOOL ( * DM_NOTIFY_SELECT_VAR_PROC) (
DWORD dwItem,
LPVOID lpvUser );
Parameters
lpdmVarKey
Pointer to first DM_VARKEY (Page 1594) type structure with the name and ID of a tag.
dwItem
Number of structures passed in lpdmVarKey.
lpvUser
function.
Return value
TRUE
FALSE
Note
Required files
dmclient.h
Related functions

See also
3.2.6.37 GAPICreateNewVariable (RT Professional)
Use
Creates a new tag or check whether a tag exists. This function can only be used for temporary
$ tags.
Declaration
BOOL GAPICreateNewVariable (
LPMCP_NEWVARIABLE_DATA pData,
Parameters
pData
Pointer to the MCP_NEWVARIABLE_DATA (Page 1598) structure with the data of the tag.
lpdmError
Return value
TRUE
Tag created.
When checked: Tag does not yet exist.
FALSE
Error.
When checked with Errorcode1 = DM_E_ALREADY_EXIST: Tag exists

Comment
There are more advanced functions.
GAPICreateNewVariable4
GAPICreateNewVariableEx4
Error messages
DM_E_NOT_CONNECTED No connection to the Data Manager

DM_E_ALREADY_EXIST Object to be created already exists
Required files
dmclient.h
dmclient.lib
dmclient.dll
Related functions

See also
3.2.6.38 GAPICreateNewVariable4 (RT Professional)
Use
$ tags.
This function differs from GAPICreateNewVariable due to the additional specification of scaling
information.

Declaration
BOOL GAPICreateNewVariable4 (
LPMCP_NEWVARIABLE_DATA_4 pData,
Parameters
pData
Pointer to the MCP_NEWVARIABLE_DATA_4 (Page 1600) structure with the data of the tag.
lpdmError
Return value
TRUE
Tag created.
FALSE
Error.
When checked with Errorcode1 = DM_E_ALREADY_EXIST: Tag exists.
Comment
There are more advanced functions.
GAPICreateNewVariableEx4 Create tag with Creator ID

GAPICreateNewVariable5 Create tag with Creator ID
Error messages

Required files
dmclient.h
dmclient.lib
dmclient.dll

Related functions

See also
3.2.6.39 GAPICreateNewVariable5 (RT Professional)
Use
$ tags.
This function differs from GAPICreateNewVariable4 due to the specification of the creator ID
and the start and substitute values that can also be specified for text tags.
Declaration
BOOL GAPICreateNewVariable5 (
DWORD dwCreatorID,
Parameters
dwCreatorID
pData
lpdmError

Return value
TRUE
Tag created.
FALSE
Error.
Error messages

Required files
dmclient.h
dmclient.lib
dmclient.dll
Related functions

See also
MCP_VARIABLE_LIMITS5 (Page 1614)
3.2.6.40 GAPICreateNewVariableEx4 (RT Professional)
Use
$ tags.
This function differs from GAPICreateNewVariable4 due to the specification of the creator ID.

Declaration
BOOL GAPICreateNewVariableEx4 (
DWORD dwCreatorID,
Parameters
dwCreatorID
pData
lpdmError
Return value
TRUE
Tag created.
FALSE
Error.
Comment
There is an advanced function.
Error messages
DM_E_NOT_CONNECTED No connection to the Data Manager

Required files
dmclient.h

dmclient.lib
dmclient.dll
Related functions

See also
3.2.7 Functions for processing structured tags (RT Professional)
3.2.7.1 GAPIEnumTypeMembers (RT Professional)
Use
The function returns the names of the tags belonging to a structured tag.
Declaration
BOOL GAPIEnumTypeMembers (
LPCSTR lpszTypeName,
DM_ENUM_TYPEMEMBERS_PROC lpfnCallback,
LPVOID lpvUser,
Parameters
lpszProjectFile
DMGetRuntimeProject in runtime.


open project.
lpszTypeName
Name of a type of structured tag whose tags are to be listed.
lpfnCallback
Pointer to your callback function that is called for every tag.
lpvUser
lpdmError
Return value
TRUE
List tags in a structured tag.
FALSE
Error.
Required files
dmclient.h
dmclient.lib
dmclient.dll
Related functions
DM_ENUM_TYPEMEMBERS_PROC List tags in a structured tag

(Page 1779) (callback)
GAPIEnumTypeMembersEx List tags in a structured tag
(Page 1780)
GAPIEnumTypeMembersEx4 List tags in a structured tag
(Page 1785)

See also
DM_ENUM_TYPEMEMBERS_PROC (Page 1779)
GAPIEnumTypeMembersEx (Page 1780)
GAPIEnumTypeMembersEx4 (Page 1785)
3.2.7.2 DM_ENUM_TYPEMEMBERS_PROC (RT Professional)
Description
In order to evaluate the names of tags listed by the system, you must provide a
DM_ENUM_TYPEMEMBERS_PROC type callback function.
Declaration
BOOL ( * DM_ENUM_TYPEMEMBERS_PROC) (
LPCSTR lpszMemberName,
LPVOID lpvUser );
Parameters
lpszStructTypeName
Pointer to the name of the tags associated with a structured tag.
lpvUser
function.
Return value
TRUE
FALSE
Note
● ODK functions from the same DLL

Required files
dmclient.h
dmclient.lib
dmclient.dll
Related functions
GAPIEnumTypeMembers (Page 1777) List tags in a structured tag
See also
GAPIEnumTypeMembers (Page 1777)
3.2.7.3 GAPIEnumTypeMembersEx (RT Professional)
Use
The function returns a description, including all the predefined values of tags belonging to a
structured tag but without scaling data.
If you want to read the scaling data, you need the GAPIEnumTypeMembersEx4 function.
Declaration
BOOL GAPIEnumTypeMembersEx (
DM_ENUM_TYPEMEMBERS_PROC_EX lpfnCallback,
LPVOID lpvUser,
Parameters
lpszProjectFile
open project.

lpszTypeName
Only local tags can be enumerated on clients.
lpfnCallback
lpvUser
lpdmError
Return value
TRUE
Tags of a structured tag listed.
FALSE
Error.
Comment
There is an advanced function, GAPIEnumTypeMembersEx4..
Required files
dmclient.h
dmclient.lib
dmclient.dll
Related functions

(Page 1783)
GAPIEnumTypeMembersEx4 (Page 1785) List tags in a structured tag

See also
3.2.7.4 GAPIEnumTypeMembersExStr (RT Professional)
Declaration
BOOL GAPIEnumTypeMembersExStr (
LPCTSTR lpszTypeName,
DM_ENUM_TYPEMEMBERS_PROC_EXSTR lpfnCallback,
LPVOID lpvUser,
Description
This function returns a description, including all defaults of the tags belonging to a structured
tag; however no scaling data are returned.
Parameters
lpszProjectFile
In WinCC version V5.0 SP2 or higher, entering a blank string will cause an internal
DMEnumOpenedProjects to be executed for a currently open project.
In Runtime, only the currently open project may be entered. Other entries are rejected with
error DM_E_NOT_CONNECTED in WinCC V5.0 SP2 or higher.
lpszTypeName
Name of the type of a structured tag whose tags you want to have enumerated.
Only local tag types can be enumerated on multi-clients (V5) or clients (V6).
lpfnCallback
Pointer to the callback function which is called for each tag.

lpvUser
lpdmError
Return value
TRUE
Tags of a structured tag have been enumerated
FALSE
Error
Required files
dmclient_exstr.h
dmclient.lib
dmclient.dll
Related functions
DM_ENUM_TYPEMEM‐ List tags in a structured tag (callback)

BERS_PROC_EXSTR
3.2.7.5 DM_ENUM_TYPEMEMBERS_PROC_EX (RT Professional)
Description
In order to evaluate the descriptions of tags listed by the system, you must provide a
DM_ENUM_TYPEMEMBERS_PROC_EX type callback function.
Declaration
BOOL ( * DM_ENUM_TYPEMEMBERS_PROC_EX) (
LPMCP_NEWVARIABLE_DATA_EX lpdmVarDataEx,
LPVOID lpvUser );

Parameters
lpdmVarKey
Pointer to the first of the AUTOHOTSPOT type structures with the keys (ID and name) of a tag
lpdmVarDataEx
Pointer to a MCP_NEWVARIABLE_DATA_EX (Page 1604) type structure with the description
of a tag.
lpvUser
function.
Return value
TRUE
FALSE
Note
Required files
dmclient.h
Related functions
GAPIEnumTypeMembersEx List tags in a structured tag

(Page 1780)
See also

3.2.7.6 GAPIEnumTypeMembersEx4 (RT Professional)
Use
The function returns a complete description, including all the predefined values of tags
belonging to a structured tag.
Declaration
BOOL GAPIEnumTypeMembersEx4 (
DM_ENUM_TYPEMEMBERS_PROC_EX4 lpfnCallback,
LPVOID lpvUser,
Parameters
lpszProjectFile
open project.
(DM_E_NOT_CONNECTED).
lpszTypeName
Only local tags can be enumerated on clients.
lpfnCallback
lpvUser
lpdmError

Return value
TRUE
Tags of a structured tag listed.
FALSE
Error.
Required files
dmclient.h
dmclient.lib
dmclient.dll
Related functions
DM_ENUM_TYPEMEMBERS_PROC_EX4 List tags in a structured tag (callback)

(Page 1786)
See also
3.2.7.7 DM_ENUM_TYPEMEMBERS_PROC_EX4 (RT Professional)
Description
In order to evaluate the descriptions of tags listed by the system, you must provide a
DM_ENUM_TYPEMEMBERS_PROC_EX4 type callback function. It differs from
DM_ENUM_TYPEMEMBERS_PROC_EX due to the additional specification of scaling
information.
Declaration
BOOL ( * DM_ENUM_TYPEMEMBERS_PROC_EX4) (
LPMCP_NEWVARIABLE_DATA_EX4 lpdmVarDataEx,
LPVOID lpvUser );

Parameters
lpdmVarKey
Pointer to the first of the DM_VARKEY (Page 1594) type structures with the keys (ID and name)
of a tag
lpdmVarDataEx
Pointer to a MCP_NEWVARIABLE_DATA_EX4 (Page 1606) type structure with the description
of a tag.
lpvUser
function.
Return value
TRUE
FALSE
Note
Required files
dmclient.h
Related functions

(Page 1785)
See also

3.2.7.8 GAPIEnumTypes (RT Professional)
Use
This function lists the names and ID numbers of the configured structured tag types.
Declaration
BOOL GAPIEnumTypes (
DM_ENUM_TYPES_PROC lpfnCallback,
LPVOID lpvUser,
Parameters
lpszProjectFile
open project.
lpfnCallback
Pointer to your callback function, which receives the data of the tag types.
lpvUser
lpdmError
Return value
TRUE
Types of structured tags listed.
FALSE
Error.

Required files
dmclient.h
dmclient.lib
dmclient.dll
Related functions
DM_ENUM_TYPES_PROC List types of structured tags (callback)

(Page 1789)
Examples
Enumerate all structured types (Page 1832) "DM01.cpp"
See also
DM_ENUM_TYPES_PROC (Page 1789)
Enumerate all structured types (Page 1832)
3.2.7.9 DM_ENUM_TYPES_PROC (RT Professional)
Description
In order to evaluate the tag types listed by the system, you must provide a
DM_ENUM_TYPES_PROC type callback function.
Declaration
BOOL ( * DM_ENUM_TYPES_PROC) (
DWORD dwTypeID,
DWORD dwCreatorID,
LPVOID lpvUser );
Parameters
lpszTypeName
Pointer on the name of the tag type.
dwTypeID
dwTypeID corresponds to the ID as assigned by GAPICreateType for the tag type.

dwCreatorID
lpvUser
function.
Return value
TRUE
FALSE
Note
Required files
dmclient.h
Related functions
GAPIEnumTypes (Page 1788) List types of structured tags
Examples
Enumerate all structured types (Page 1832) "DM01.cpp"
See also
GAPIEnumTypes (Page 1788)
Enumerate all structured types (Page 1832)

3.2.8 Functions for processing connections (RT Professional)
3.2.8.1 DMEnumConnectionData (RT Professional)
Use
The function determines the information about a configured logical connection.
Declaration
BOOL DMEnumConnectionData (
LPDM_CONNKEY lpdmConnKey,
DWORD dwItems,
DM_ENUM_CONNECTION_PROC lpfnCallback,
LPVOID lpvUser,
Parameters
lpszProjectFile
lpdmConnKey
Pointer to the first DM_CONNKEY (Page 1568) type structure. These structures are used to
specify the logical connections, the data of which are to enumerated.
dwItems
The number of logical connections, the data of which is to listed.
A value of 0 triggers the listing of all connections.
lpfnCallback
Pointer to your callback function, which receives the data of the logical connection.
lpvUser
lpdmError

Return value
TRUE
Data listed.
FALSE
Error.
Error messages
Required files
dmclient.h
dmclient.lib
dmclient.dll
Related functions
DM_ENUM_CONNECTION_PROC (Page 1794) List connection data (callback)
Examples
Enumerate all connections (Page 1834) "DM01.cpp"
OnTestEnumConnectionDataAll (Page 1839) "TESTCDoc.cpp"
See also
DM_CONNKEY (Page 1568)
Enumerate all connections (Page 1834)
OnTestEnumConnectionDataAll (Page 1839)

3.2.8.2 DMEnumConnectionDataExStr (RT Professional)
Declaration
BOOL DMEnumConnectionDataExStr (
DM_ENUM_CONNECTION_PROC_EXSTR lpfnCallback,
LPVOID lpvUser,
LPDWORD lpdwConnectionCount,
Description
This function is used to determine all configured logical connections.
Parameters
lpszProjectFile
lpfnCallback
Pointer to your callback function which receives the data of the logical connection.
lpvUser
lpdwConnectionCount
Pointer to a "DWORD", in which the number of existing connections is returned.
Thus, "lpfnCallback = NULL" first determines how much memory is required for the
connections.
lpdmError
Return value
TRUE
Data have been enumerated

FALSE
Error
Error messages
Required files
dmclient_exstr.h
dmclient.lib
dmclient.dll
Related functions
DM_ENUM_CONNECTION_PROC_EXSTR List connection data (callback)
3.2.8.3 DM_ENUM_CONNECTION_PROC (RT Professional)
Description
In order to evaluate information about a logical connection listed by the system, you must
provide a DM_ENUM_CONNECTION_PROC type callback function.
Declaration
BOOL ( * DM_ENUM_CONNECTION_PROC) (
LPDM_CONNECTION_DATA lpdmConData,
LPVOID lpvUser);
Parameters
lpdmConData
Pointer to a DM_CONNECTION_DATA (Page 1567) type structure in which the data of a logical
connection are stored.
lpvUser
function.

Return value
TRUE
FALSE
Note
Required files
dmclient.h
Related functions
DMEnumConnectionData (Page 1791) List connection data
Examples
Enumerate all connections (Page 1834) "DM01.cpp"
See also
DM_CONNECTION_DATA (Page 1567)
Enumerate all connections (Page 1834)
3.2.9 Functions for the work platform (RT Professional)
3.2.9.1 DMGetOSVersion (RT Professional)
Use
Determines the operating system used on the PC.

Declaration
DWORD DMGetOSVersion (
VOID);
Parameters
None.
Return value
The return value indicates the operating system:
DM_OS_UNKNOWN 0 Unknown operating system

DM_OS_NT 1 Windows NT
DM_OS_32S 2 Windows 3.x with Win 32s
DM_OS_CHICAGO 3 Windows 95
DM_OS_2000 4 Windows 2000
DM_OS_XP 5 Windows XP
DM_OS_2003 6 Windows 2003
DM_OS_VISTA_32 0x0600 Windows Vista 32-bit
1
DM_OS_VISTA_SP1_32 0x0601 Windows Vista 32-bit Service Pack 1
1
1
DM_OS_VISTA_64 0x9600 Windows Vista 64-bit
1
1
1
DM_OS_S2008_32 0x0600 Windows Server 2008 32-bit
3
DM_OS_S2008_SP1_32 0x0601 Windows Server 2008 32-bit Service Pack 1
3
3
3
3
3
DM_OS_W7_32 0x0610 Windows 7 32-bit
1

DM_OS_W7_SP1_32 0x0611 Windows 7 32-bit Service Pack 1

1
DM_OS_W7_64 0x9610 Windows 7 64-bit
1
DM_OS_W7_SP1_64 0x9611 Windows 7 64-bit Service Pack 1
1
DM_OS_S2008R2_32 0x0610 Windows Server 2008 R2 (32-bit)
3
DM_OS_S2008R2_SP1_32 0x0611 Windows Server 2008 R2 32-bit Service Pack 1
3
3
DM_OS_S2008R2_SP1_64 0x9611 Windows Server 2008 R2 64-bit Service Pack 1
3
DM_OS_W8_32 0x0620 Windows 8 (32-bit)
1
1
3
3
DM_OS_W81_32 0x0630 Windows 8.1 (32-bit)
1
DM_OS_W81_64 0x9630 Windows 8.1 (64-bit)
1
3
3
1
3
Required files
dmclient.h
dmclient.lib
dmclient.dll
3.2.9.2 DMGetSystemLocale (RT Professional)
Use
Gets the code of the currently used configuration language.

Declaration
BOOL DMGetSystemLocale (
LPDWORD lpdwLocaleID,
Parameters
lpdwLocaleID
Pointer to the code of the currently configured language.
Possible return values are the language codes for:
German 0x0407
English 0x0409
French 0x040C
lpdmError
Return value
TRUE
Currently used configuration language determined.
FALSE
Error
Error messages
Required files
dmclient.h
dmclient.lib
dmclient.dll
Examples
OnTestSystemLocale (Page 1845) "TESTCDoc.cpp"

See also
OnTestSystemLocale (Page 1845)
3.2.9.3 DMSetLanguage (RT Professional)
Use
Switches the configuration language.
Declaration
BOOL DMSetLanguage (
DWORD dwLocaleID,
Parameters
dwLocaleID
Pointer to the code of the language to be set. Possible values are the language codes for:
German 0x0407
English 0x0409
French 0x040C
lpdmError
Return value
TRUE
Language switched.
FALSE
Error.
Error messages
DM_E_NOT_SUPPORTED Requested service unavailable
Required files
dmclient.h

dmclient.lib
dmclient.dll
3.2.9.4 DMShowLanguageDialog (RT Professional)
Use
The function opens a dialog box for selecting the language.
Declaration
BOOL DMShowLanguageDialog (
HWND hwndParent,
DWORD dwFlags,
DWORD dwSetLocaleIDs[],
UINT uSetIDArraySize,
LPDWORD lpdwGetLocaleID,
Parameters
hwndParent
dwFlags
dwFlags indicates the languages that appear in the dialog and can be selected:
DM_LANGDLG_REMOVE Set All languages that can be registered with dwSetLocaleIDs are
displayed, except for the languages in the EnumSystemLocales
(LCID_SUPPORTED) array.
Not set All languages in the dwSetLocaleIDs array are displayed.
DM_LANGDLG_ONLY_PRIMARY Set Only the main languages (PRIMARY_LANGUAGE) are displayed.
Not set Sublanguages are also displayed.
DM_LANGDLG_NO_NOTIFY Applications are not notified when the dialog is closed with "OK"
dwSetLocaleIDs
Array with the IDs of the languages to be displayed in the dialog.
uSetIDArraySize
Size of the dwSetLocaleIDs array.
lpdwGetLocaleID
Pointer to a DWORD, in which the selected language ID should be stored.

lpdmError
Return value
TRUE
FALSE
Error messages
Required files
dmclient.h
dmclient.lib
dmclient.dll
3.2.10 Functions for updating tags (RT Professional)
3.2.10.1 DMBeginStartVarUpdate (RT Professional)
Use
Trigger an update request. A transaction ID for identifying transaction is assigned with this
function.
Declaration
BOOL DMBeginStartVarUpdate (
LPDWORD pdwTAID
LPCMN_ERROR lpdmError )

Parameters
pdwTAID
lpdmError
Return value
TRUE
Transaction ID assigned.
FALSE
Error.
Error messages
Required files
dmclient.h
dmclient.lib
dmclient.dll
Examples
OnTestVariablenBeginstartvarupdate (Page 1846) "TESTCDoc.cpp"
See also
OnTestVariablenBeginstartvarupdate (Page 1846)
DMEndStartVarUpdate (Page 1803)
DMResumeVarUpdate (Page 1804)
DMStopVarUpdate (Page 1821)
DMSuspendVarUpdate (Page 1823)

3.2.10.2 DMEndStartVarUpdate (RT Professional)
Use
After the function is successfully called, data manager updates the tags and forwards the new
values to your application as required.
Declaration
BOOL DMEndStartVarUpdate (
DWORD dwTAID,
Parameters
dwTAID
dwTAID contains the transaction ID assigned with the call of the DMBeginStartVarUpdate
function.
lpdmError
Return value
TRUE
Update started.
FALSE
Error.
Error messages

DM_E_INVALID_TAID Invalid transaction ID
Required files
dmclient.h

Related functions
DMBeginStartVarUpdate (Page 1801) Trigger an update request

Examples
OnTestVariablenEndstartvarupdate (Page 1847) "TESTCDoc.cpp"
See also
OnTestVariablenEndstartvarupdate (Page 1847)
DMBeginStartVarUpdate (Page 1801)
3.2.10.3 DMResumeVarUpdate (RT Professional)
Use
Starts the updating of all tags defined by the transaction, when the transaction reaches the
value 0 after calling the reference counter.
The function is the counterpart to DMSuspendVarUpdate and should always be called together
with it in pairs.
Declaration
BOOL DMResumeVarUpdate (
DWORD dwTAID,
Parameters
dwTAID
function.
lpdmError

Return value
TRUE
Continue update.
FALSE
Error.
Comment
Transactions have a reference counter that is incremented each time the
DMSuspendVarUpdate function is called. If the update of the tags should be continued,
DMResumeVarUpdate must be called repeatedly until the reference counter returns to the 0
position.
Error messages

Required files
dmclient.h
dmclient.lib
dmclient.dll
Related functions

DMSuspendVarUpdate (Page 1823) Stop updating of tags
Examples
OnTestVariablenResumevarupdate (Page 1858) "TESTCDoc.cpp"
See also
OnTestVariablenResumevarupdate (Page 1858)

3.2.10.4 DMStartVarUpdate (RT Professional)
Use
This function is used to specify the tags to be updated by the data manager. The data manager
passes the new tag values to your application in the callback function when an update is
performed.
DMStartVarUpdateEx is a more advanced function, which additionally returns the quality code
in the DM_NOTIFY_VARIABLEEX_PROC callback in the DM_VAR_UPDATE_STRUCTEX
structure.
Declaration
BOOL DMStartVarUpdate (
DWORD dwTAID,
DWORD dwItems,
DWORD dwCycle,
DM_NOTIFY_VARIABLE_PROC lpfnVariable,
LPVOID lpvUser,
Parameters
dwTAID
function.
lpdmVarKey
Pointer to the first of the DM_VARKEY (Page 1594) type structures, through which the tags to
be updated are specified.
dwItems
Number of tags to be updated in the passed DM_VARKEY structures.
dwCycle
The update cycle defined in dwCycle applies to all tags specified by lpdmVarKey. The upgrade
cycle is defined by the index of the entries in the list of update cycles.
"On change" Acyclic Index: 0

"250 ms" 250 Index: 1
"500 ms" 500 Index: 2
"1 s" 1000 Index: 3
"2 s" 2000 Index: 4
"5 s" 5000 Index: 5
"10 s" 10000 Index: 6

"1 min" 60000 Index: 7

"5 min" 300000 Index: 8
"10 min" 600000 Index: 9
"1 h" 3600000 Index: 10
"User cycle 1" (e.g. 2000) Index: 11
lpfnVariable
Pointer to the DM_NOTIFY_VARIABLE_PROC callback function for data transfer by the data
manager.
With lpfnVariable == NULL, the update in the process image of the data manager is performed
at least in the required cycle, to the extent physically possible based on the current system
load, computer performance, coupling medium etc. The determination of the current value
needs to be performed independently by the application by calling the DMGetValue function.
In rare cases, the notification may already be delivered before the function call returns.
lpvUser
lpdmError
Return value
TRUE
Update tags specified.
FALSE
Error.
Required files
dmclient.h
dmclient.lib
dmclient.dll

Related functions

DM_NOTIFY_VARIABLE_PROC (Page 1808) Specify update tags (callback)
See also
3.2.10.5 DM_NOTIFY_VARIABLE_PROC (RT Professional)
Description
In order to evaluate the data determined by the system, you must provide a
DM_NOTIFY_VARIABLE_PROC type callback function.
Declaration
BOOL ( * DM_NOTIFY_VARIABLE_PROC) (
DWORD dwTAID,
DWORD dwItems,
LPVOID lpvUser);
Parameters
dwTAID
Transaction ID that was assigned by the data manager for the calling function.
lpdmvus
Pointer to the first DM_VAR_UPDATE_STRUCT (Page 1581) type structure that contains the
values of the tags requested.
dwItems
Number of structures passed in lpdmvus (corresponding to the number of returned tag values).
lpvUser
function.

Return value
Comment
Note
Required files
dmclient.h
Related functions

See also
3.2.10.6 DMStartVarUpdateEx (RT Professional)
Use
This function is used to specify the tags to be updated by the data manager. Within the callback
function, the data manager passes on the new tag values to the application when an update
is executed.
In contrast to DMStartVarUpdate, the quality code is also provided in the
DM_VAR_UPDATE_STRUCTEX structure, which is returned in the
DM_NOTIFY_VARIABLEEX_PROC callback.

Declaration
BOOL DMStartVarUpdateEx (
DWORD dwTAID,
DWORD dwItems,
DWORD dwCycle,
DM_NOTIFY_VARIABLEEX_PROC lpfnVariable,
LPVOID lpvUser,
Parameters
dwTAID
function.
lpdmVarKey
Pointer to the first of the DM_VARKEY (Page 1594) type structures, through which the tags to
be updated are specified.
dwItems
Number of tags to be updated in the passed DM_VARKEY structures.
dwCycle
The update cycle defined here applies to all tags specified by lpdmVarKey . The upgrade cycle
is defined by the index of the entries in the list of update cycles.

"250 ms" 250 Index: 1
"500 ms" 500 Index: 2
"1 s" 1000 Index: 3
"2 s" 2000 Index: 4
"5 s" 5000 Index: 5
"10 s" 10000 Index: 6
"1 min" 60000 Index: 7
"5 min" 300000 Index: 8
"10 min" 600000 Index: 9
"1 h" 3600000 Index: 10

lpfnVariable
Pointer to the DM_NOTIFY_VARIABLEEX_PROC callback function for data transfer by the
data manager.
With lpfnVariable == NULL, the update in the process image of the data manager is performed
at least in the required cycle, to the extent physically possible based on the current system
load, computer performance, coupling medium etc. The determination of the current value
needs to be performed independently by the application by calling the DMGetValue function.
lpvUser
lpdmError
Return value
TRUE
Update tags specified.
FALSE
Error.
Required files
dmclient.h
dmclient.lib
dmclient.dll
Related functions

DM_NOTIFY_VARIABLEEX_PROC (Page 1819) Specify update tags (callback)
See also

3.2.10.7 DMStartVarUpdateExStr (RT Professional)
Declaration
BOOL DMStartVarUpdateExStr (
DWORD dwTAID,
DWORD dwFlags,
LPVARIANT lpvCookie,
DWORD dwCycle,
DM_NOTIFY_VARIABLE_PROC_EXSTR lpfnVariable,
LPVOID lpvUser,
Description
This function is used to specify the tags to be updated by the data manager. Within the callback
function, the data manager passes on the new tag values to the application when an update
is executed.
Parameters
dwTAID
dwTAID contains the transaction ID allocated when the DMBeginStartVarUpdate function was
called.
dwFlags
lpvdmVarKey
Pointer to VARIANT with VT_ARRAY | VT_VARIANT for passing on the tag list that identifies
the tags to be changed.
lpvCookie
Pointer to a VARIANT for an additional list of user-dependent data for each tag.

This is intended as substitute for lpvUserData of the previous DM_VARKEY and is also
returned in the DM_VAR_UPDATE_STRUCT_EXSTR structure for each tag.
dwCycle
The update cycle defined here is applied to all tags specified by means of lpvdmVarKey. The
upgrade cycle is defined by the index of the entries in the list of update cycles.

"250 ms" 250 Index: 1
"500 ms" 500 Index: 2
"1 s" 1000 Index: 3
"2 s" 2000 Index: 4
"5 s" 5000 Index: 5
"10 s" 10000 Index: 6
"1 min" 60000 Index: 7
"5 min" 300000 Index: 8
"10 min" 600000 Index: 9
"1 h" 3600000 Index: 10
lpfnVariable
Pointer to the DM_NOTIFY_VARIABLEEX_PROC callback function for data transfer through
the data manager.
If "lpfnVariable" = "NULL", the update in the process image of the data manager is performed
at least in the required cycle, to the extent that this is physically possible based on the current
system load, computer performance, coupling medium etc.; however, each value must be
determined individually by calling the DMGetValue function through the application.
lpvUser
lpdmError
Return value
TRUE
Update tags have been specified

FALSE
Error
Required files
dmclient_exstr.h
dmclient.lib
dmclient.dll
Related functions
DMBeginStartVarUpdate Trigger an update request
Examples
Script sample "Button DMStartVarUpdateExStr":
lpszPropertyName)
{
int cElements );
#pragma code()
extern BOOL DM_NOTIFY_VARIABLE_PROC_EXSTR

DM_NotifyVariableProcExStr_VarUpdate(
DWORD dwTAID,
LPDM_VAR_UPDATE_STRUCT_EXSTRA lpdmvus,
DWORD dwItems,
LPVOID lpvUser);
VARIANT vVarKey;
VARIANT* pvElem;
SAFEARRAY* parrayKeys;
HRESULT hr;
CMN_ERROR err;
BOOL bRet;
long lInx;
DWORD dwTAID;
DWORD dwFlags;
DWORD dwCycle;

bRet = FALSE;
parrayKeys = NULL;
lInx = 0L;
//dwCycle = 3; /* 1sec*/
dwCycle = 0; /* on change*/
printf("\r\n\r\n########## enter Test with DMStartVarUpdateExStr

##########");
dwTAID = GetTagDWord("dwUpdTAID");
if (dwTAID)
{
printf("\r\nStartVarUpdate always running. Stop it before start
again!");
printf("\r\n########## exit Test with DMStartVarUpdateExStr
(nothing done) ##########\r\n");
return;
}
VariantInit(&vVarKey);
parrayKeys = SafeArrayCreateVector(VT_VARIANT, 0L, 4);
vVarKey.vt = VT_ARRAY | VT_VARIANT;
vVarKey.u.parray = parrayKeys;
SafeArrayLock(parrayKeys);
lInx = 0L;
lInx = 1L;
lInx = 2L;
lInx = 3L;
SafeArrayUnlock(parrayKeys);
bRet = DMBeginStartVarUpdate(&dwTAID, &err);

if (FALSE == bRet)
{
printf("\r\n error DMBeginStartVarUpdate, err=%ld,%ld,%ld,%ld,
%ld,[%s]",

err.dwError1, err.dwError2, err.dwError3,

err.dwError4, err.dwError5, err.szErrorText);
}
else
{
printf("\r\n DMBeginStartVarUpdate (dwTAID=%ld) OK.", dwTAID);
}
if (dwTAID)
{
SetTagDWord("dwUpdTAID",dwTAID);
bRet = DMStartVarUpdateExStr(dwTAID, dwFlags, &vVarKey, dwCycle,
DM_NotifyVariableProcExStr_VarUpdate,
NULL, &err);
if (FALSE == bRet)
{
printf("\r\n error DMStartVarUpdateExStr (dwTAID=%ld): err=
%ld,%ld,%ld,%ld,%ld,[%s]",
dwTAID, err.dwError1, err.dwError2, err.dwError3,
}
else
{
printf("\r\n DMStartVarUpdateExStr (dwTAID=%ld) OK.",
dwTAID);
}
bRet = DMEndStartVarUpdate(dwTAID, &err);
if (FALSE == bRet)
{
printf("\r\n error DMEndStartVarUpdate (dwTAID=%ld): err=
%ld,%ld,%ld,%ld,%ld,[%s]",
}
else
{
printf("\r\n DMEndStartVarUpdate (dwTAID=%ld) OK.", dwTAID);
}
}
else
{
printf("\r\n dwTAID == 0L ???");
}
printf("\r\n########## exit Test with DMStartVarUpdateExStr (dwTAID=

%ld) ##########\r\n", dwTAID);

Script sample "Project-Function DM_NotifyVariableProcExStr_VarUpdate":

#pragma code()
BOOL DM_NotifyVariableProcExStr_VarUpdate(
DWORD dwTAID,
LPDM_VAR_UPDATE_STRUCT_EXSTRA lpdmvus,
DWORD dwItems,
LPVOID lpvUser)
{
BOOL bRet = FALSE;
int i = 0;
HRESULT hr = 0L;
printf("\r\n*** DM_NotifyVariableProcExStr_VarUpdate entry (dwTAID=

%ld) ***", dwTAID);

{
hr = VariantChangeType((VARIANTARG*)&(lpdmvus[i].vdmValue),
(VARIANTARG*)&(lpdmvus[i].vdmValue), 0,
VT_R8);
if (VT_LPSTR == lpdmvus[i].vdmVarKey.vt)
{
printf("\r\n [%d]:{VarKey=[%s]", i,
(LPCSTR)lpdmvus[i].vdmVarKey.u.pbVal);
}
else if (VT_I4 == lpdmvus[i].vdmVarKey.vt)
{
printf("\r\n [%d]:{VarKey=[%ld]", i,
lpdmvus[i].vdmVarKey.u.lVal);
}
else
{
printf("\r\n [%d]:{unexpected VarKey.vt=[%d]",
lpdmvus[i].vdmVarKey.vt);
}
printf(", dmValue=[%g]", lpdmvus[i].vdmValue.u.dblVal);
printf(", dwState=[%ld]", lpdmvus[i].dwState);
printf(", dwType=[%ld]", lpdmvus[i].dmTypeRef.dwType);
printf(", dwSize=[%ld]", lpdmvus[i].dmTypeRef.dwSize);
if (lpdmvus[i].dmTypeRef.lpszTypeName)
{
printf(", lpszTypeName=[%s]",
lpdmvus[i].dmTypeRef.lpszTypeName);
lpdmvus[i].dmTypeRef.dwNameCharCount);

}
else
{
printf(", lpszTypeName=[NULL]");
}
printf("}");
}
printf("\r\n*** DM_NotifyVariableProcExStr_VarUpdate exit (dwTAID=

%ld)***", dwTAID);
return bRet;
}
Script sample "Button DMStopVarUpdate":
lpszPropertyName)
{
DWORD dwTAID;
CMN_ERROR err;
BOOL bRet;
dwTAID = GetTagDWord("dwUpdTAID");
bRet = FALSE;
if (dwTAID)
{
bRet = DMStopVarUpdate(dwTAID, &err);
if (FALSE == bRet)
{
printf("\r\n!!! error DMStopVarUpdate (dwTAID=%ld): err=%ld,
%ld,%ld,%ld,%ld,[%s] !!!\r\n",
bRet = DMStopAllUpdates(&err);
if (FALSE == bRet)
{
printf("\r\n!!! error DMStopAllUpdates (dwTAID=%ld):
err=%ld,%ld,%ld,%ld,%ld,[%s] !!!\r\n",
}
else
{
printf("\r\n DMStopAllUpdates OK.");
}
}
else
{

printf("\r\n DMStopVarUpdate (dwTAID=%ld) OK.", dwTAID);

}
}
dwTAID = 0L;
SetTagDWord("dwUpdTAID",dwTAID);
}
3.2.10.8 DM_NOTIFY_VARIABLEEX_PROC (RT Professional)
Description
In order to evaluate the data determined by the system, you must provide a
DM_NOTIFY_VARIABLEEX_PROC type callback function.
Declaration
BOOL ( * DM_NOTIFY_VARIABLEEX_PROC) (
DWORD dwTAID,
LPDM_VAR_UPDATE_STRUCTEX lpdmvus,
DWORD dwItems,
LPVOID lpvUser);
Parameters
dwTAID
Transaction ID that was assigned by the data manager for the calling function.
lpdmvus
Pointer to the first DM_VAR_UPDATE_STRUCTEX (Page 1583) type structure that contains
the values of the tags requested.
dwItems
Number of structures passed in lpdmvus (corresponding to the number of returned tag values).
lpvUser
function.
Return value

Comment
Note
Required files
dmclient.h
Related functions
DMGetValueWaitEx (Page 1706) Get tag values with update

DMStartVarUpdateEx (Page 1809) Define update tags
See also
3.2.10.9 DMStopAllUpdates (RT Professional)
Use
Stops all tag updates requested by the application. This function should be preferably called
after closing the corresponding module.
Declaration
BOOL DMStopAllUpdates (

Parameters
lpdmError
Return value
TRUE
Updating of tags stopped.
FALSE
Error.
Error messages
Required files
dmclient.h
dmclient.lib
dmclient.dll
Examples
OnTestVariablenStopallupdates (Page 1861) "TESTCDoc.cpp"
See also
OnTestVariablenStopallupdates (Page 1861)
3.2.10.10 DMStopVarUpdate (RT Professional)
Use
Stops the updating of tags for a specific transaction.
Declaration
BOOL DMStopVarUpdate (
DWORD dwTAID,

Parameters
dwTAID
function.
lpdmError
Return value
TRUE
Updating of tags stopped.
FALSE
Error.
Error messages

Required files
dmclient.h
dmclient.lib
dmclient.dll
Related functions
Examples
OnTestVariablenStopvarupdate (Page 1861) "TESTCDoc.cpp"
See also
OnTestVariablenStopvarupdate (Page 1861)

3.2.10.11 DMSuspendVarUpdate (RT Professional)
Use
Interrupts the updating of all tags defined by the transaction.
Tags continue to be updated within the process image of the data manager. However, the
values are no longer transferred to the application.
Declaration
BOOL DMSuspendVarUpdate (
DWORD dwTAID,
Parameters
dwTAID
function.
lpdmError
Return value
TRUE
Updating suspended.
FALSE
Error.
Comment
Transactions have a reference counter, therefore the DMSuspendVarUpdate function can be
called multiple times for a transaction. If the transaction is already in the "SUSPENDED" state,
only the reference counter is incremented.
To continue updating, DMResumeVarUpdate must be called repeatedly until the reference
counter returns to the 0 position.

Error messages

Required files
dmclient.h
dmclient.lib
dmclient.dll
Related functions

DMResumeVarUpdate (Page 1804) Continue updating of tags
Examples
OnTestVariablenSuspendvarupdate (Page 1862) "TESTCDoc.cpp"
See also
OnTestVariablenSuspendvarupdate (Page 1862)

3.2.11 Examples (RT Professional)
3.2.11.1 Connection to DM (RT Professional)
Example
// =====================================================================
// =====================================================================
// Desc. : Modul with examples for Data-Manager
// *********************************************************************
#include "stdafx.h" // if MFC classes
// #include "odkapi.h" // if console application
#include <time.h>
TCHAR g_szProjectFile[255] = {0};
TCHAR g_szDSNName[255] = {0};
#include "DM01.h"
//{{ODK_EXAMPLE}Connection to DM (MCP)}
//{{FUNCTION}DMGetConnectionState (MCP)}
//{{FUNCTION}DMConnect (MCP)}
//{{FUNCTION}DM_NOTIFY_PROC (MCP)}
//{{FUNCTION}DMDisConnect (MCP)}
//{{FUNCTION}(END)}
// =====================================================================
// Function: MyDMConnect(void) ODK DM CS
// =====================================================================
BOOL MyDMConnect(void)
{
CMN_ERROR Error;
BOOL ret = FALSE;
TCHAR szText[255];
TCHAR szAppName[255];
VOID* pvUser = AfxGetApp();
_tcsncpy_s(szAppName, _countof(szAppName), _T("MyODKApp_23"), _TRUNCATE);
memset(&Error, 0,sizeof(CMN_ERROR));
ret = DMGetConnectionState(&Error);
if(FALSE == ret) // not connected
{
ret = DMConnect(szAppName, MyDMNotifyCallback, pvUser, &Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in DMConnect: E1=
0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
}
else
{
_sntprintf_s(szText,_countof(szText), _TRUNCATE, _T("DMConnect"));
}
ODKTrace(szText);
}

else // already connected

{
_sntprintf_s(szText,_countof(szText), _TRUNCATE, _T("DMGetConnectionState: OK"));
}
{
ODKTrace(szText);
}
return(ret);
}
// IMPLEMENTATION
// =====================================================================
// Function: MyDMGetConnectionState(void) ODK DM CS
// =====================================================================
BOOL MyDMGetConnectionState(void)
{
CMN_ERROR Error;
BOOL ret = FALSE;
TCHAR szText[255];
TCHAR szAppName[255];
_tcsncpy_s(szAppName, _countof(szAppName), _T("MyODKApp_23"), _TRUNCATE);
ret = DMGetConnectionState(&Error);
if(FALSE == ret) // not connected
{
ret = DMConnect(szAppName, MyDMNotifyCallback, pvUser, &Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in DMConnect: E1=
0x%08lx ; E2= 0x%08lx ; %s"),
}
else
{
_sntprintf_s(szText,_countof(szText), _TRUNCATE, _T("DMConnect"));
}
ODKTrace(szText);
//printf("%s\r\n",szText);
}
{
ODKTrace(szText);
}
return(ret);
}
// =====================================================================
// Function: MyDMDisConnect(void) ODK DM CS
// =====================================================================
BOOL MyDMDisConnect(void)
{

CMN_ERROR Error;
BOOL ret = FALSE;
TCHAR szText[255];
memset(&Error, 0, sizeof(CMN_ERROR));
ret = DMDisConnect(&Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in DMConnect: E1= 0x
%08lx ; E2= 0x%08lx ; %s"),
}
else
{
_sntprintf_s(szText,_countof(szText), _TRUNCATE, _T("DMDisconnect"));
}
ODKTrace(szText);
return(ret);
}
// =====================================================================
// Function: MyDMNotifyCallback
// =====================================================================
BOOL MyDMNotifyCallback(DWORD dwNotifyClass, DWORD dwNotifyCode, LPBYTE lpbyData,
DWORD dwItems, LPVOID lpvUser)
{
lpvUser;
lpbyData;
TCHAR szText[255];
_sntprintf_s(szText ,_countof(szText), _TRUNCATE, _T("**DMNotifyCallback**"));
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" NotifyClass = 0x
%08X"),dwNotifyClass);
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" NotifyCode = 0x%08X"),
dwNotifyCode);
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" Items = %d"), dwItems);
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("********************"));
ODKTrace(szText);
return(TRUE);
}
//{{ODK_EXAMPLE}(END)}
See also
DMDisconnect (Page 1636)
DMGetConnectionState (Page 1648)

3.2.11.2 Enum Data of Tags (RT Professional)
Example
//{{ODK_EXAMPLE}Enum Data of Tags (MCP)}

//{{FUNCTION}DMEnumVarData4 (MCP)}
//{{FUNCTION}DM_ENUM_VARIABLE_PROC4 (MCP)}
//{{FUNCTION}(END)}
// =====================================================================
// Function: MyDMEnumVarData4(void) ODK DM CS
// =====================================================================
// Desc. :
//--------------------------------------------------------------------------------
BOOL MyDMEnumVariable4Callback(LPDM_VARKEY lpdmVarKey, LPDM_VARIABLE_DATA4 lpdmVarData,
LPVOID lpvUser)
{
lpvUser;
TCHAR szText[255];
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("DMEnumVariableCallback"));
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("...szName=%s dwVarProperty=0x
%04X"),lpdmVarKey->szName, lpdmVarData->dwVarProperty);
ODKTrace(szText);
return TRUE;
}
void MyDMEnumVarData4()
{
// #define PROJ_PATH "C:\\siemens\\odk\\samples\\projects\\demo\\odk.mcp"
BOOL ret = FALSE;
DM_VARKEY dmVarKey[2];
TCHAR szText[255];
CMN_ERROR Error;
VOID* pUser = NULL;
memset(&Error,0,sizeof(CMN_ERROR));
memset(&dmVarKey, 0,2 * sizeof(DM_VARKEY));
dmVarKey[0].dwKeyType = DM_VARKEY_NAME;
_tcsncpy_s(dmVarKey[0].szName, _countof(dmVarKey[0].szName), _T("INT_TEST_VAR"),
_TRUNCATE);
dmVarKey[1].dwKeyType = DM_VARKEY_NAME;
_tcsncpy_s(dmVarKey[1].szName, _countof(dmVarKey[1].szName), _T("EXT_TEST_VAR"),
_TRUNCATE);
MyDMEnumOpenedProjects(); // open the DM and set the g_szProjectFile
ret = DMEnumVarData4 (/*PROJ_PATH*/g_szProjectFile,
&dmVarKey[0],
2,
MyDMEnumVariable4Callback,
pUser,
&Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in DMEnumVarData4: E1=
0x%08lx ; E2= 0x%08lx ; %s"),
ODKTrace(szText);

}
}
See also

3.2.11.3 Enum open projects (RT Professional)
Example
//{{ODK_EXAMPLE}Enum open projects (MCP)}

//{{FUNCTION}DMEnumOpenedProjects (MCP)}
//{{FUNCTION}DM_ENUM_OPENED_PROJECTS_PROC (MCP)}
//{{FUNCTION}(END)}
// =====================================================================
// Function: MyDMEnumOpenedProjects(void) ODK DM CS
// =====================================================================
// Desc. : Inquire project informations
// =====================================================================
BOOL MyDMEnumOpenProjectsCallback( LPDM_PROJECT_INFO lpInfo, LPVOID lpvUser )
{
lpvUser;
// this callback is only called once by every call of DMEnumOpenedProjects
// because, there can only opened one project at the same time
TCHAR szText[255];
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("**DMEnumOpenProjects**"));
ODKTrace(szText);
// copy the project file name to g_szProjectFile for global use
// many API-functions need this name to select the project database
_tcsncpy_s(g_szProjectFile, _countof(g_szProjectFile), lpInfo->szProjectFile,
_TRUNCATE);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" ProjectFile = %s"),lpInfo-
>szProjectFile);
ODKTrace(szText);
_tcsncpy_s(g_szDSNName, _countof(g_szDSNName), lpInfo->szDSNName, _TRUNCATE);

_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" DSNName = %s"),lpInfo-
>szDSNName);
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" DataLocale = 0x%08X"),lpInfo-
>dwDataLocale);
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("**********************"));
ODKTrace(szText);
return( TRUE ); // only 1. element
}
BOOL MyDMEnumOpenedProjects(void)
{
CMN_ERROR Error;
BOOL ret= FALSE;
DWORD dwItems;
TCHAR szText[255];
ret = MyDMConnect();
if(TRUE == ret)
{
ret = DMEnumOpenedProjects(&dwItems, MyDMEnumOpenProjectsCallback, pvUser, &Error);
if(FALSE == ret)

{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in
DMEnumOpenedProjects: E1= 0x%08lx ; E2= 0x%08lx ; %s"), %s",
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("DMEnumOpenedProjects"));
}
ODKTrace(szText);
}
return(ret);
}
See also

3.2.11.4 Enumerate all structured types (RT Professional)
Example
//{{ODK_EXAMPLE}Enumerate all structured types (MCP)}

//{{FUNCTION}GAPIEnumTypes (MCP)}
//{{FUNCTION}DM_ENUM_TYPES_PROC (MCP)}
//{{FUNCTION}(END)}
// =====================================================================
// Function: MyGAPIEnumTypes(void) ODK DM CS
// =====================================================================
// Desc. :
//--------------------------------------------------------------------------------
BOOL MyDMEnumTypeCallback(LPCSTR lpszTypeName,DWORD dwTypeID,
DWORD dwCreatorID, LPVOID lpvUser )
{
lpvUser;
TCHAR szText[255];
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("**DMEnumTypeCallback**"));
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("TypeName = %s TypeID = 0x%08x
CreatorID = %d"),
lpszTypeName,dwTypeID,dwCreatorID);
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("**********************"));
ODKTrace(szText);
return TRUE;
}
void MyGAPIEnumTypes()
{
CMN_ERROR Error;
BOOL ret = FALSE;
TCHAR szText[255];
TCHAR szProjectFile[255];
VOID* pvUser = NULL;
ret = FALSE;
ret = MyDMGetConnectionState(); //check the connection state to DM
if(FALSE != ret)
{
_tcsncpy_s(szProjectFile, _countof(szProjectFile), /*PROJ_PATH*/g_szProjectFile,
_TRUNCATE);
ret = GAPIEnumTypes(szProjectFile,
MyDMEnumTypeCallback,
pvUser,
&Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in DMEnumTypes: E1=
0x%08lx ; E2= 0x%08lx ; %s"),


}
else
{
_sntprintf_s(szText,_countof(szText), _TRUNCATE, _T("DMEnumTypes"));
}
ODKTrace(szText);
}
}
See also
GAPIEnumTypes (Page 1788)
DM_ENUM_TYPES_PROC (Page 1789)

3.2.11.5 Enumerate all connections (RT Professional)
Example
//{{ODK_EXAMPLE}Enumerate all connections (MCP)}

//{{FUNCTION}DMEnumConnectionData (MCP)}
//{{FUNCTION}DM_ENUM_CONNECTION_PROC (MCP)}
//{{FUNCTION}(END)}
// =====================================================================
// Function: MyDMEnumConnectionData(void) ODK DM CS
// =====================================================================
// Desc. :
//--------------------------------------------------------------------------------
BOOL MyDMEnumConnectionCallback(LPDM_CONNECTION_DATA lpdmConData, LPVOID lpvUser)
{
lpvUser;
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("DMEnumConnectionCallback"));
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("...Connection = %s"),lpdmConData-
>szConnection);
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("...UnitName = %s"),lpdmConData-
>szUnitName);
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("...Common=%s"),lpdmConData-
>szCommon);
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("...Specific=%s"),lpdmConData-
>szSpecific);
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("...VarNum=%d"),lpdmConData-
>dwVarNum);
ODKTrace(szText);
return TRUE;
}
void MyDMEnumConnectionData()
{
BOOL ret = FALSE;
CMN_ERROR Error;
TCHAR szText[255];
DWORD dwItems = 0;
TCHAR szProjectFile[255];
DM_CONNKEY ConnKey;
memset(&ConnKey,0,sizeof(ConnKey));
memset(&Error,0,sizeof(Error));
ret = MyDMGetConnectionState();
if(FALSE != ret)
{
_TRUNCATE);
ret = DMEnumConnectionData(szProjectFile,

&ConnKey,
dwItems,
MyDMEnumConnectionCallback,
NULL,
&Error);
if(FALSE == ret)
{
DMEnumConnectionData: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("DMEnumConnectionData"));
}
ODKTrace(szText);
}
}
See also

3.2.11.6 Inquire project informations (RT Professional)
Example
//{{ODK_EXAMPLE}Inquire project informations (MCP)}

//{{FUNCTION}DMGetProjectInformation (MCP)}
//{{FUNCTION}(END)}
// =====================================================================
// Function: DMGetProjectInformation(void) ODK DM CS
// =====================================================================
// Desc. : Inquire project informations
// =====================================================================
void MyDMGetProjectInformation(void)
{
CMN_ERROR Error;
BOOL ret = FALSE;
TCHAR szText[255];
TCHAR szProjectFile[_MAX_PATH +1];
DM_PROJECT_INFO Info;
memset(&Info, 0, sizeof(DM_PROJECT_INFO));
ret = MyDMGetConnectionState(); //check the connection state
if(FALSE != ret)
{
_TRUNCATE);
ret = DMGetProjectInformation(szProjectFile, &Info, &Error);
if(FALSE == ret)
{
DMGetProjectInformation: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
ODKTrace(szText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("**DMGetProjectInformation:
%d**"), ret);
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" ProjectFile=
%s"),Info.szProjectFile);
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" DSNName=
%s"),Info.szDSNName);
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" DataLocale=0x
%08X"),Info.dwDataLocale);
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE,
_T("******************************"), ret);
ODKTrace(szText);

}
}
}
See also
3.2.11.7 OnTestDeactivateRuntimeProject (RT Professional)
Example
//{{ODK_EXAMPLE}OnTestDeactivateRuntimeProject (MCP)}
//{{FUNCTION}DMDeactivateRTProject (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestDeactivateRuntimeProject()
{
CCmnError cmnError;
if(!::DMDeactivateRTProject(cmnError))
{
cmnError.Show(__T("DMDeactivateRTProject failed\n"));
}
}
3.2.11.8 OnTestEnumGroupsAll (RT Professional)
Example
//{{ODK_EXAMPLE}OnTestEnumGroupsAll (MCP)}
//{{FUNCTION}DMEnumVarGrpData (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestEnumGroupsAll()
{
CCmnError cmnError;
if(!::DMEnumVarGrpData((LPSTR)(LPCTSTR) m_strProject, NULL, 0, EnumVarGrpProc, this,
cmnError))
{
cmnError.Show(__T("DMEnumVarGrpData failed\n"));
}
}

See also
3.2.11.9 OnTestEnumVariables (RT Professional)
Example
//{{ODK_EXAMPLE}OnTestEnumVariables (MCP)}
//{{FUNCTION}DMEnumVariables (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestEnumVariables()
{
DM_VARFILTER dmVarFilter;
memset( &dmVarFilter, 0, sizeof(DM_VARFILTER) );
//--------------------------------------------------
// Initialisierung des Filters //
//--------------------------------------------------
// //
dmVarFilter.dwFlags = DM_VARFILTER_TYPE;
dmVarFilter.dwNumTypes = 3;
DWORD dwFilterTypes[3];
dwFilterTypes[0] = DM_VARTYPE_BIT;
dwFilterTypes[1] = DM_VARTYPE_DWORD;
dwFilterTypes[2] = DM_VARTYPE_DOUBLE;
dmVarFilter.pdwTypes = dwFilterTypes;
dmVarFilter.lpszName = __T("VAR_1_BIT");
dmVarFilter.lpszGroup = __T("VARGROUP_1");
dmVarFilter.lpszConn = __T("TF_CONN_1");
// //
//--------------------------------------------------
CCmnError Error;
memset(&Error,0,sizeof(CCmnError));
if(!DMEnumVariables((LPSTR)(LPCTSTR) m_strProject, NULL/*&dmVarFilter*/,
EnumVariablesProc, this, &Error))
{
Error.Show(__T("DMEnumVariables failed\n"));
}
}
See also

3.2.11.10 OnTestEnumConnectionDataAll (RT Professional)
Example
//{{ODK_EXAMPLE}OnTestEnumConnectionDataAll (MCP)}
//{{FUNCTION}DMEnumConnectionData (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestEnumConnectionDataAll()
{
CCmnError Error;
if( !::DMEnumConnectionData( m_strProject, NULL, 0, EnumConnectionDataProc, this,
&Error))
{
Error.Show(__T("DMEnumConnectionData failed\n"));
}
}
See also

3.2.11.11 OnTestMachines (RT Professional)
Example
//{{ODK_EXAMPLE}OnTestMachines (MCP)}
//{{FUNCTION}DMGetMachineTable (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestMachines()
{
CMN_ERROR Error;
DM_MACHINE_TABLE dmMachineTable;
memset(&dmMachineTable, 0, sizeof(dmMachineTable));
if(!DMGetMachineTable(m_strProject, &dmMachineTable, &Error))
{
// Error.Show(__TEXT("DMGetMachineTable failed\n"));
// AfxMessageBox( strError );
}
else
{
for( int i = 0; i < dmmachinetable.nNumMachines; i++ )
{
CString strData;
strData.Format( _T( "Rechner : %s, Typ : %s, Standort : %s" ),
dmMachineTable.tm[i].szMachineName,
dmMachineTable.tm[i].fServer ? _T( "Server" ) : _T( "Client oder ES" ),
dmMachineTable.tm[i].fLocal ? _T( "local" ) : _T( "remote" ));
PutStr( strData);
}
}
}
See also

3.2.11.12 OnTestProjectInfo (RT Professional)
Example
//{{ODK_EXAMPLE}OnTestProjectInfo (MCP)}
//{{FUNCTION}DMGetProjectInformation (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestProjectInfo()
{
CCmnError cmnError;
DM_PROJECT_INFO ProjectInfo;
memset(&ProjectInfo, 0, sizeof(DM_PROJECT_INFO));
if(!DMGetProjectInformation(m_strProject, &ProjectInfo, cmnError))
{
cmnError.Show(__TEXT("DMGetProjectInformation failed\n"));
}
else
{
CString strData;
strData.Format(_T("Projekt : %s, Data Source : %s, DataLocale : %08X"),
ProjectInfo.szProjectFile,
ProjectInfo.szDSNName,
ProjectInfo.dwDataLocale );
PutStr(strData);
}
}
See also

3.2.11.13 OnTestProjectPaths (RT Professional)
Example
//{{ODK_EXAMPLE}OnTestProjectPaths (MCP)}
//{{FUNCTION}DMGetProjectDirectory (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestProjectPaths()
{
DM_DIRECTORY_INFO dmDirInfo;
CCmnError Error;
memset(&dmDirInfo, 0, sizeof(DM_DIRECTORY_INFO));
if(!DMGetProjectDirectory(m_strAppName, m_strProject,
&dmDirInfo, &Error))
{
Error.Show(__TEXT("DMGetProjectDirectory failed\n"));
}
else
{
CString strData;
strData.Format(_T("szProjectDir = %s"), dmDirInfo.szProjectDir);
PutStr(strData);
strData.Format(_T("szProjectAppDir = %s"), dmDirInfo.szProjectAppDir);
PutStr(strData);
strData.Format(_T("szProjectGlobalLibDir = %s"), dmDirInfo.szGlobalLibDir);
PutStr(strData);
strData.Format(_T("szProjectLibDir = %s"), dmDirInfo.szProjectLibDir);
PutStr(strData);
strData.Format(_T("szLokalProjectAppDir = %s"), dmDirInfo.szLokalProjectAppDir);
PutStr(strData);
}
}
See also
DMGetProjectDirectory (Page 1659)

3.2.11.14 OnTestOpenProject (RT Professional)
Example
//{{ODK_EXAMPLE}OnTestOpenProject (MCP)}
//{{FUNCTION}DMOpenProject (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestOpenProject()
{
#define PROJ_PATH "C:\\siemens\\odk\\samples\\projects\\demo\\odk.mcp"
TCHAR szProject[_MAX_PATH + 1];
CCmnError Error;
CTestCliView* pView = GetFirstView();
memset(szProject,0, sizeof(szProject)); // Delete projectname to call dialog
// Or set fixed projectname
strcpy( szProject, _T(PROJ_PATH) );
if(!DMOpenProject(pView->GetSafeHwnd(),
szProject, NELEM(szProject), &Error))
{
Error.Show(__TEXT("DMOpenProject failed.\n"));
}
else
{
AfxMessageBox(szProject);
m_strProject = szProject;
}
}
See also
DMOpenProjectPlus (Page 1664)

3.2.11.15 OnTestOpenProjects (RT Professional)
Example
//{{ODK_EXAMPLE}OnTestOpenProjects (MCP)}
//{{FUNCTION}DMEnumOpenedProjects (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestOpenProjects()
{
CCmnError Error;
if(!DMEnumOpenedProjects(NULL, OpenProjectsProc, this, &Error))
{
Error.Show(__TEXT("DMEnumOpenedProjects failed\n"));
}
}
See also
3.2.11.16 OnTestRuntimeProject (RT Professional)
Example
//{{ODK_EXAMPLE}OnTestRuntimeProject (MCP)}
//{{FUNCTION}DMGetRuntimeProject (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestRuntimeProject()
{
CCmnError Error;
TCHAR szBuffer[_MAX_PATH + 1];
if(!DMGetRuntimeProject(szBuffer, NELEM(szBuffer), &Error))
{
Error.Show(__TEXT("DMGetRuntimeProject failed\n"));
}
else
{
PutStr(szBuffer);
}
}
See also

3.2.11.17 OnTestSystemLocale (RT Professional)
Example
//{{ODK_EXAMPLE}OnTestSystemLocale (MCP)}
//{{FUNCTION}DMGetSystemLocale (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestSystemLocale()
{
CCmnError Error;
DWORD dwLocaleID = 0;
if(!DMGetSystemLocale(&dwLocaleID, &Error))
{
Error.Show(__TEXT("DMGetSystemLocale failed\n"));
}
else
{
CString strData;
strData.Format(_T("Systemlocale : %08X"), dwLocaleID);
PutStr(strData);
}
}
See also
DMGetSystemLocale (Page 1797)
3.2.11.18 OnTestUpdateCycles (RT Professional)
Example
//{{ODK_EXAMPLE}OnTestUpdateCycles (MCP)}
//{{FUNCTION}DMEnumUpdateCycles (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestUpdateCycles()
{
DWORD dwNumCalls = 0;
CCmnError Error;
if( !DMEnumUpdateCycles(m_strProject, &dwNumCalls,
EnumCyclesProc, this, &Error))
{
Error.Show(__TEXT("DMEnumUpdateCycles failed\n"));
}
}

See also
DMEnumUpdateCycles (Page 1641)
3.2.11.19 OnTestVariablenBeginstartvarupdate (RT Professional)
Example
//{{ODK_EXAMPLE}OnTestVariblenBeginstartvarupdate (MCP)}
//{{FUNCTION}DMBeginStartVarUpdate (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestVariablenBeginstartvarupdate()
{
CCmnError Error;
if(!DMBeginStartVarUpdate(&m_dwTAID, &Error))
{
Error.Show(_T("DMBeginStartVarUpdate failed\n"));
}
else
{
CString strData;
strData.Format(_T("DMBeginStartVarUpdate: TAID:%lu."), m_dwTAID);
}
}
See also

3.2.11.20 OnTestVariablenEndstartvarupdate (RT Professional)
Example
//{{ODK_EXAMPLE}OnTestVariablenEndstartvarupdate (MCP)}
//{{FUNCTION}DMEndStartVarUpdate (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestVariablenEndstartvarupdate()
{
CCmnError Error;
if( !DMEndStartVarUpdate(m_dwTAID, &Error))
{
Error.Show(_T("DMEndStartVarUpdate failed\n"));
}
else
{
CString strData;
strData.Format(_T("DMEndStartVarUpdate: TAID:%lu."), m_dwTAID);
}
}
See also

3.2.11.21 OnTestVariablenGetvalue (RT Professional)
Example
//{{ODK_EXAMPLE}OnTestVariablenGetvalue (MCP)}
//{{FUNCTION}DMGetValue (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestVariablenGetvalue()
{
int nNum = GetVarCount();
LPDM_VARKEY lpdmVarKey = GetVarKeys();
LPDM_VAR_UPDATE_STRUCT lpdmvus = new DM_VAR_UPDATE_STRUCT[nNum];

memset(lpdmvus, 0, sizeof(DM_VAR_UPDATE_STRUCT) * nNum);
// the included VARIANT's in the DM_VAR_UPDATE_STRUCT's then initialized to VT_EMPTY
with the memset,
// don't do this later again, because VT_BSTR's can be present after DMGetValue(...)!
CCmnError Error;
memset(&Error, 0, sizeof(CCmnError));
if( !DMGetValue(lpdmVarKey, nNum, lpdmvus, &Error))

{
Error.Show(_T("DMGetValue failed\n"));
}
else
{
CString strData;
for( int i=0; i < nmum; i++)
{
LPDM_VAR_UPDATE_STRUCT lpdmvus2 = &lpdmvus[i];
switch( lpdmvus2->dmTypeRef.dwType )
{
case DM_VARTYPE_BIT:
if (lpdmvus2->dmValue.boolVal)
{
strData.Format(_T("GetValue: Variable: %s\t( ID = %d ):\tWert = TRUE"),
lpdmvus2->dmVarKey.szName,
lpdmvus2->dmVarKey.dwID);
}
else
{
strData.Format(_T("GetValue: Variable: %s\t( ID = %d ):\tWert = FALSE"),
lpdmvus2->dmVarKey.dwID);
}
break;
case DM_VARTYPE_BYTE:
strData.Format(_T("GetValue: Variable: %s\t( ID = %d ):\tWert = %u"),
lpdmvus2->dmVarKey.dwID,
lpdmvus2->dmValue.bVal);
break;
case DM_VARTYPE_SBYTE:

strData.Format(_T("GetValue: Variable: %s\t( ID = %d ):\tWert = %d"),

lpdmvus2->dmValue.bVal);
break;
case DM_VARTYPE_WORD:
lpdmvus2->dmValue.iVal);
break;
case DM_VARTYPE_SWORD:
lpdmvus2->dmValue.iVal);
break;
case DM_VARTYPE_DWORD:
lpdmvus2->dmValue.lVal);
break;
case DM_VARTYPE_SDWORD:
lpdmvus2->dmValue.lVal);
break;
case DM_VARTYPE_FLOAT:
strData.Format(_T("GetValue: Variable: %s\t( ID = %d ):\tWert = %f"),
lpdmvus2->dmValue.fltVal);
break;
case DM_VARTYPE_DOUBLE:
strData.Format(_T("GetValue: Variable: %s\t( ID = %d ):\tWert = %f"),
lpdmvus2->dmValue.dblVal);
break;
case DM_VARTYPE_TEXT_8:
strData.Format(_T("GetValue: Variable: %s\t( ID = %d ):\tWert = %s"),
lpdmvus2->dmValue.bstrVal);
break;
/*
strData.Format(_T("GetValue: Variable: %s\t( ID = %d ):\tWert = %s"),
lpdmvus2->dmValue.bstrVal);
break;
*/
default:

strData.Format(_T("Unbekannter Variablentyp !"));

}
PutStr(strData);
// clear the given VARIANT's in every array element, because a VT_BSTR's can be
present
// do not only delete the array later without clearing the Variants here because
of memory leak's
VariantClear(&(lpdmvus2->dmValue));
}
}
delete []lpdmVarKey;
delete []lpdmvus;
}
See also

3.2.11.22 OnTestVariablenGetvaluewait (RT Professional)
Example
//{{ODK_EXAMPLE}OnTestVariablenGetvaluewait (MCP)}
//{{FUNCTION}DMGetValueWait (MCP)}
//{{FUNCTION}(END)}
//-----< Notification-Callback für GetValueWait >-----------------------------
BOOL GetValueWaitNotify(DWORD dwTAID,
DWORD dwItems,
LPVOID lpvUser)
{
dwTAID;
CTestCliDoc* pDoc = (CTestCliDoc*)lpvUser;
for(DWORD i=0; i <dwitems; i++)
{
LPDM_VAR_UPDATE_STRUCT lpdmvus2 = &lpdmvus[i];
CString strData;
switch(lpdmvus2->dmTypeRef.dwType)
{
case DM_VARTYPE_BIT:
if (lpdmvus2->dmValue.boolVal)
{
strData.Format(_T("GetValueWait: Variable: %s\t( ID = %d ):\tWert = TRUE,
Status=%04x"),
lpdmvus2->dwState);
}
else
{
strData.Format(_T("GetValueWait: Variable: %s\t( ID = %d ):\tWert = FALSE,
Status=%04x"),
lpdmvus2->dwState);
}
break;
case DM_VARTYPE_BYTE:
strData.Format(_T("GetValueWait: Variable: %s\t( ID = %d ):\tWert = %u, Status=
%04x"),
lpdmvus2->dmValue.bVal,
lpdmvus2->dwState);
break;
case DM_VARTYPE_SBYTE:
strData.Format(_T("GetValueWait: Variable: %s\t( ID = %d ):\tWert = %d, Status=
%04x"),
lpdmvus2->dmValue.bVal,
lpdmvus2->dwState);

break;
case DM_VARTYPE_WORD:
%04x"),
lpdmvus2->dmValue.iVal,
lpdmvus2->dwState);
break;
case DM_VARTYPE_SWORD:
%04x"),
lpdmvus2->dmValue.iVal,
lpdmvus2->dwState);
break;
case DM_VARTYPE_DWORD:
%04x"),
lpdmvus2->dmValue.lVal,
lpdmvus2->dwState);
break;
case DM_VARTYPE_SDWORD:
%04x"),
lpdmvus2->dmValue.lVal,
lpdmvus2->dwState);
break;
case DM_VARTYPE_FLOAT:
strData.Format(_T("GetValueWait: Variable: %s\t( ID = %d ):\tWert = %f, Status=
%04x"),
lpdmvus2->dmValue.fltVal,
lpdmvus2->dwState);
break;
case DM_VARTYPE_DOUBLE:
strData.Format(_T("GetValueWait: Variable: %s\t( ID = %d ):\tWert = %f, Status=
%04x"),
lpdmvus2->dmValue.dblVal,
lpdmvus2->dwState);
break;
strData.Format(_T("GetValueWait: Variable: %s\t( ID = %d ):\tWert = %s, Status=
%04x"),
lpdmvus2->dmValue.bstrVal,
lpdmvus2->dwState);

break;
case DM_VARTYPE_RAW:
{
LPBYTE pArray;
HRESULT hr;
hr = SafeArrayAccessData(lpdmvus2->dmValue.parray, (VOID **) &pArray);
if (! FAILED(hr))
{
strData.Format(_T("Var:%s: Type:Rohdatum\nValues:%02x %02x %02x %02x\n"),
pArray[0],
pArray[1],
pArray[2],
pArray[3]);
SafeArrayUnaccessData(lpdmvus2->dmValue.parray);
}
else
{
strData.Format(_T("SafeArrayAccessData fehlgeschlagen\n"));
}
break;
}
default:
strData.Format(_T("GetValueWait: Unbekannter Variablentyp !"));
}
pDoc->PutStr(strData);
}
return(TRUE);
}
//-----< OnTestVariablenGetvaluewait >------------------------------------------

void CTestCliDoc::OnTestVariablenGetvaluewait()
{
DWORD dwTAID = 5;
DWORD dwTimeOut = 5000;
CCmnError Error;
if(!DMGetValueWait(&dwTAID,
lpdmVarKey,
nNum,
FALSE,
dwTimeOut,
GetValueWaitNotify,
this,
&Error))
{
Error.Show(_T("DMGetValueWait (FALSE) failed\n"));
}
delete []lpdmvus;
}

//-----< OnTestVariablenGetvaluewait >------------------------------------------

void CTestCliDoc::OnTestVariablenGetvaluewaitTrue()
{
DWORD dwTAID = 5;
DWORD dwTimeOut = 5000;
CCmnError Error;
if( !DMGetValueWait(&dwTAID,
lpdmVarKey,
nNum,
TRUE,
dwTimeOut,
GetValueWaitNotify,
this,
&Error))
{
Error.Show(_T("DMGetValueWait (TRUE) failed\n"));
}
delete []lpdmvus;
}
See also

3.2.11.23 OnTestVariablenGetVarInfo (RT Professional)
Example
//{{ODK_EXAMPLE}OnTestVariblenGetVarInfo (MCP)}
//{{FUNCTION}DMGetVarInfo (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestVariablenGetVarInfo()
{
CCmnError Error;
if(!::DMGetVarInfo(m_strProject, lpdmVarKey, nNum, &Error))
{
Error.Show(_T("DMGetVarInfo failed\n"));
}
else
{
CString strData;
for(int i=0; i<nnum; i++)
{
strData.Format(_T("DMGetVarInfo: Variablenname: %s, VarID:%lu."),
lpdmVarKey[i].szName,
lpdmVarKey[i].dwID);
PutStr(strData);
}
}
}
See also
DMGetVarInfo (Page 1710)

3.2.11.24 OnTestVariablenGetvarlimits (RT Professional)
Example
//{{ODK_EXAMPLE}OnTestVariblenGetvarlimits (MCP)}
//{{FUNCTION}DMGetVarLimits (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestVariablenGetvarlimits()
{
LPDM_VARLIMIT lpdmVarLimit = new DM_VARLIMIT[nNum];
memset(lpdmVarLimit, 0, sizeof(DM_VARLIMIT) * nNum);
CCmnError Error;
if(!::DMGetVarLimits(m_strProject, lpdmVarKey, nNum,
lpdmVarLimit, &Error))
{
Error.Show(__T("DMGetVarLimits failed\n"));
}
else
{
CString strData;
{
strData.Format(_T("DMGetVarLimits: Var:%s, MaxRange:%lf, MinRange:%lf, MinLimit:
%lf, MaxLimit:%lf."),
lpdmVarLimit[i].dmMaxRange.dblVal,
lpdmVarLimit[i].dmMinRange.dblVal,
lpdmVarLimit[i].dmMaxLimit.dblVal,
lpdmVarLimit[i].dmMinLimit.dblVal);
PutStr(strData);
}
}
delete []lpdmVarLimit;
}
See also

3.2.11.25 OnTestVariablenGetvartype (RT Professional)
Example
//{{ODK_EXAMPLE}OnTestVariblenGetvartype (MCP)}
//{{FUNCTION}DMGetVarType (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestVariablenGetvartype()
{
LPDM_TYPEREF lpdmTypeRef = new DM_TYPEREF[nNum];
memset(lpdmTypeRef, 0, sizeof(DM_TYPEREF) * nNum);
CCmnError Error;
if(!::DMGetVarType(m_strProject, lpdmVarKey, nNum,
lpdmTypeRef, &Error))
{
Error.Show(_T("DMGetVarType failed\n"));
}
else
{
CString strData;
{
strData.Format(_T("DMGetVarType: Var:%s, Size:%lu, Name:%s."),
lpdmVarKey[i].dwID);
PutStr(strData);
}
}
}
See also

3.2.11.26 OnTestVariablenResumevarupdate (RT Professional)
Example
//{{ODK_EXAMPLE}OnTestVariblenResumevarupdate (MCP)}
//{{FUNCTION}DMResumeVarUpdate (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestVariablenResumevarupdate()
{
CCmnError Error;
if(!DMResumeVarUpdate(m_dwTAID, &Error))
{
Error.Show(_T("DMResumeVarUpdate failed.\n"));
}
else
{
CString strData;
strData.Format(_T("DMResumeVarUpdate ok."));
}
}
See also

3.2.11.27 OnTestVariablenSetvalue (RT Professional)
Example
//{{ODK_EXAMPLE}OnTestVariablenSetvalue (MCP)}
//{{FUNCTION}DMSetValue (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestVariablenSetvalue()
{
LPDWORD lpdmVarState = new DWORD[nNum];
INT i;
CString strData;
CCmnError cmnError;
for (i = 0; i < 1; i++)</p>
{
DWORD dwStart = GetTickCount();
DWORD dwEnd;
if (! DMSetValue(lpdmVarKey, nNum, m_varValues, lpdmVarState, cmnError))
{
break;
}
dwEnd = GetTickCount();
strData.Format("DMSetValue OK, Dauer %d ms", dwEnd - dwStart);
PutStr(strData);
}
delete []lpdmVarState;
}
See also

3.2.11.28 OnTestVariablenSetvaluewait (RT Professional)
Example
//{{ODK_EXAMPLE}OnTestVariablenSetvaluewait (MCP)}
//{{FUNCTION}DMSetValueWait (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestVariablenSetvaluewait()
{
LPDWORD lpdmVarState = new DWORD[nNum];
DWORD dwTimeOut = 1000L;
CCmnError cmnError;
if(!::DMSetValueWait(&m_dwTAID, lpdmVarKey,nNum, m_varValues,dwTimeOut,
CompletionProc, this, cmnError))
{
cmnError.Show(_T("DMSetValueWait failed\n"));
}
else
{
CString strData;
strData.Format(_T("DMSetValueWait ok."));
}
delete []lpdmVarState;
}
See also

3.2.11.29 OnTestVariablenStopallupdates (RT Professional)
Example
//{{ODK_EXAMPLE}OnTestVariablenStopallupdates (MCP)}
//{{FUNCTION}DMStopAllUpdates (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestVariablenStopallupdates()
{
CCmnError Error;
if(!DMStopAllUpdates(&Error))
{
Error.Show(_T("DMStopAllUpdates failed\n"));
}
else
{
CString strData;
strData.Format(_T("DMStopAllUpdates ok."));
}
}
See also
DMStopAllUpdates (Page 1820)
3.2.11.30 OnTestVariablenStopvarupdate (RT Professional)
Example
//{{ODK_EXAMPLE}OnTestVariablenStopvarupdate (MCP)}
//{{FUNCTION}DMStopVarUpdate (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestVariablenStopvarupdate()
{
CCmnError Error;
if( !DMStopVarUpdate(m_dwTAID, &Error))
{
Error.Show(_T("DMStopVarUpdate failed\n"));
}
else
{
CString strData;
strData.Format(_T("DMStopVarUpdate: TAID:%lu."), m_dwTAID);
}
}

See also
DMStopVarUpdate (Page 1821)
3.2.11.31 OnTestVariablenSuspendvarupdate (RT Professional)
Example
//{{ODK_EXAMPLE}OnTestVariablenSuspendvarupdate (MCP)}
//{{FUNCTION}DMSuspendVarUpdate (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestVariablenSuspendvarupdate()
{
CCmnError Error;
if(!DMSuspendVarUpdate(m_dwTAID, &Error))
{
Error.Show(_T("DMSuspendVarUpdate failed\n"));
}
else
{
CString strData;
strData.Format(_T("DMSuspendVarUpdate ok."));
}
}
See also
3.2.11.32 OnTestWinCCShutdown (RT Professional)
Example
//{{ODK_EXAMPLE}OnTestWinCCShutdown (MCP)}
//{{FUNCTION}DMExitWinCC (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestWinCCShutdown()
{
DMExitWinCC();
}
See also
DMExitWinCC (Page 1644)

3.2.11.33 Open project by means of dialog (RT Professional)
Example
//{{ODK_EXAMPLE}Open projectby means of dialog (MCP)}

//{{FUNCTION}DMOpenProject (MCP)}
//{{FUNCTION}(END)}
// =====================================================================
// Function: MyDMOpenProject(void) ODK DM CS
// =====================================================================
// Desc. : open project, give name through WinCC-Dialog-Box
// =====================================================================
void MyDMOpenProject(void)
{
CMN_ERROR Error;
BOOL ret = FALSE;
DWORD dwSize = 255;
HWND handle = NULL;
TCHAR szProjFile[255];
TCHAR szText[255];
_tcsncpy_s(szProjFile, _countof(szProjFile), _T("C:\\Siemens\\ODK\\Samples\\Projects\
\Demo\\odk.mcp"), _TRUNCATE);
memset(&Error, 0,sizeof( CMN_ERROR ));
ret = MyDMConnect(); // check connection to DataManager
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in MyDMConnect"));
ODKTrace(szText);
}
else
{
memset(&Error, 0,sizeof( CMN_ERROR ));
ret = DMOpenProject(handle, szProjFile, dwSize, &Error);
if(ret == FALSE)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in DMOpenProject:
E1= 0x%08lx ; E2= 0x%08lx ; %s"),
}
else
{
_sntprintf_s(szText,_countof(szText), _TRUNCATE, _T("DMOpenProject (%s)"),
szProjFile);
}
ODKTrace(szText);
}
}
See also
DMOpenProjectPlus (Page 1664)

3.2.11.34 Read tag (RT Professional)
Example
// =====================================================================
// =====================================================================
// short : Modul with examples to DataManager-API
// RUNTIME
// SC: PO = Projekt opened PG= Projekt closed
// *********************************************************************
//#include "odkapi.h" // if console application
#include <time.h>
#include "dm02.h"
// =====================================================================
// 2.1 Interface IMPORT
// =====================================================================
//extern void ODKTrace(LPCTSTR);
extern BOOL MyDMConnect (void); // Connect
extern BOOL MyDMGetConnectionState(void);
// =====================================================================
// 2.2 Interface EXPORT
// =====================================================================
// =====================================================================
// 2.3 Interface LOCAL
// =====================================================================
// =====================================================================
// 3. Definitions
// =====================================================================
//{{ODK_EXAMPLE}Read tag (MCP)}

//{{FUNCTION}DMGetValue (MCP)}
//{{FUNCTION}(END)}
// =====================================================================
// Function: MyDMGetValue(void) ODK DM CS
// =====================================================================
// short : Read tag
// =====================================================================
void MyDMGetValue(void)
{
CMN_ERROR Error;
BOOL ret = FALSE;
DWORD dwSize = _MAX_PATH;
TCHAR szText[255];
TCHAR szProjFile[_MAX_PATH +1];
TCHAR BstrValue[255]; //
const short int nNum = 11; // tagcount
const short int nTextMax = 20; // textlenght
TCHAR TagNames[nNum][nTextMax]=
{
"VAR_1_BOOL", // boolVal; // VT_BOOL.

"VAR_2_BYTE", // bVal; // VT_UI1

"VAR_3_SBYTE", // iVal; // VT_I2
"VAR_4_WORD", // lVal // VT_I4
"VAR_5_SWORD", // iVal // VT_I2
"VAR_6_DWORD", // dblVal // VT_R8
"VAR_7_SDWORD", // lVal // VT_I4
"VAR_8_FLOAT", // fltVal // VT_R4
"VAR_9_DOUBLE", // dblVal // VT_R8
"VAR_A_TEXT8", // bstrVal // VT_BSTR
"VAR_B_TEXT16" // bstrVal // VT_BSTR
};
DM_VARKEY VarKey[nNum];
DM_VAR_UPDATE_STRUCT VarUp[nNum];
memset(&VarUp, 0, sizeof(DM_VAR_UPDATE_STRUCT) * nNum);
// the included VARIANT's in the DM_VAR_UPDATE_STRUCT's then initialized to VT_EMPTY
with the memset,
// don't do this later again, because VT_BSTR's can be present after DMGetValue(...)!
memset(&VarKey,0, sizeof(DM_VARKEY) * nNum);

if(FALSE != ret)
{
// RunTime project
ret = DMGetRuntimeProject(szProjFile, dwSize, &Error);
if(FALSE != ret)
{
// fill out DM_VARKEY
for(int iRead = 0; iRead <nNum; iRead++)
{
VarKey[iRead].dwKeyType = DM_VARKEY_NAME;
VarKey[iRead].dwID = 0;
strcpy( VarKey[iRead].szName, &TagNames[iRead][0]);
VarKey[iRead].lpvUserData = (VOID *) iRead;
}
ret = DMGetValue(VarKey, nNum, VarUp, &Error);
if(FALSE != ret)
{
for(int iOut=0; iOut <nNum; iOut++)
{
switch(VarUp[iOut].dmTypeRef.dwType)
{
case DM_VARTYPE_BIT: //vt = 3 VT_I4 = 3
{
sprintf(szText, "Index=%d Name=%s ID=%d Value=%d",
iOut, VarUp[iOut].dmVarKey.szName,
VarUp[iOut].dmVarKey.dwID,
VarUp[iOut].dmValue.boolVal);
break;
}
case DM_VARTYPE_BYTE: //vt = 17 VT_UI1 = 17
{

VarUp[iOut].dmValue.bVal);
break;
}
case DM_VARTYPE_SBYTE: //vt = 2 VT_I2 = 2
{
VarUp[iOut].dmValue.iVal);
break;
}
case DM_VARTYPE_WORD: //vt = 3 VT_I4 = 3
{
VarUp[iOut].dmValue.lVal);
break;
}
case DM_VARTYPE_SWORD: //vt = 2 VT_I2 = 2
{
VarUp[iOut].dmValue.iVal);
break;
}
case DM_VARTYPE_DWORD: //vt = 5 VT_R8 = 5
{
VarUp[iOut].dmValue.dblVal);
break;
}
case DM_VARTYPE_SDWORD: //vt = 3 VT_I4 = 3
{
VarUp[iOut].dmValue.lVal);
break;
}
case DM_VARTYPE_FLOAT: //vt = 4 VT_R4 = 4
{
sprintf(szText, "Index=%d Name=%s ID=%d Value=%f",
VarUp[iOut].dmValue.fltVal);
break;
}
case DM_VARTYPE_DOUBLE: //vt = 5 VT_R8 = 5
{
sprintf(szText, "Index=%d Name=%s ID=%d Value=%f",

VarUp[iOut].dmValue.dblVal);
break;
}
case DM_VARTYPE_TEXT_8: //vt = 8 VT_BSTR = 8
{
ret = WideCharToMultiByte( CP_ACP,
(DWORD)0,VarUp[iOut].dmValue.bstrVal,
-1,(LPSTR)&BstrValue[0],128,NULL,NULL);
sprintf(szText, "Index=%d Name=%s ID=%d StrValue=%s",
VarUp[iOut].dmVarKey.dwID,BstrValue);
break;
}
case DM_VARTYPE_TEXT_16: // vt = 8 VT_BSTR = 8
{
ret = WideCharToMultiByte( CP_ACP,
(DWORD)0,VarUp[iOut].dmValue.bstrVal,
-1,(LPSTR)&BstrValue[0],128,NULL,NULL);
sprintf(szText, "Index=%d Name=%s ID=%d StrValue=%s",
VarUp[iOut].dmVarKey.dwID,BstrValue);
break;
}
default:
break;
}// end switch case
ODKTrace(szText);
VariantClear( &VarUp[iOut].dmValue );
}//end for
}
else
{
sprintf(szText, "Error in DMGetValue: E1= 0x%08lx ; E2= 0x%08lx ; %s",
ODKTrace(szText);
}
}
else
{
sprintf(szText, "Error in DMGetRuntimeProject: E1= 0x%08lx ; E2= 0x%08lx ; %s",
ODKTrace(szText);
}
}
else
{
sprintf(szText, "Error in MyDMGetConnectionState: E1= 0x%08lx ; E2= 0x%08lx ; %s",
ODKTrace(szText);

}
}
See also

3.2.11.35 Write tag (RT Professional)
Example
//{{ODK_EXAMPLE}Write tag (MCP)}

//{{FUNCTION}DMSetValue (MCP)}
//{{FUNCTION}(END)}
// =====================================================================
// Function: MyDMSetValue(void) ODK DM CS
// =====================================================================
// short : Write tag
// =====================================================================
void MyDMSetValue(void)
{
CMN_ERROR Error;
BOOL ret = FALSE;
DWORD dwSize = _MAX_PATH;
TCHAR szText[255];
TCHAR szProjFile[_MAX_PATH +1];
TCHAR szTextValue[255]; // for TEXT8 Values
const short int nNum = 11; // tagcount
const short int nTextMax = 20; // textlenght
TCHAR TagNames[nNum][nTextMax]=
{
"VAR_1_BOOL", // boolVal; // VT_BOOL.
"VAR_2_BYTE", // bVal; // VT_UI1
"VAR_3_SBYTE", // iVal; // VT_I2
"VAR_4_WORD", // lVal // VT_I4
"VAR_5_SWORD", // iVal // VT_I2
"VAR_6_DWORD", // dblVal // VT_R8
"VAR_7_SDWORD", // lVal // VT_I4
"VAR_8_FLOAT", // fltVal // VT_R4
"VAR_9_DOUBLE", // dblVal // VT_R8
"VAR_A_TEXT8", // bstrVal // VT_BSTR
"VAR_B_TEXT16" // bstrVal // VT_BSTR
};
DM_VARKEY VarKey[nNum];
DM_VAR_UPDATE_STRUCT VarUp[nNum];
VARIANT VarVal[nNum];
DWORD VarSta[nNum];
static short int Tmp[20];
BSTR bstrText1, bstrText2;
memset(&VarUp, 0, sizeof(DM_VAR_UPDATE_STRUCT) * nNum);
memset(&VarKey,0, sizeof(DM_VARKEY) * nNum);
if(FALSE != ret)
{
// RunTime project
ret = DMGetRuntimeProject(szProjFile, dwSize, &Error);
if(FALSE != ret)
{
// read tag

for(int i = 0; i < nNum; i++)

{
VarKey[i].dwKeyType = DM_VARKEY_NAME;
VarKey[i].dwID = 0;
_tcsncpy_s(VarKey[i].szName, _countof(VarKey[i].szName), &TagNames[i][0],
_TRUNCATE);
VarKey[i].lpvUserData = (VOID *) i;
}
// init tag
//"VAR_1_BOOL",
VarVal[0].vt = VT_BOOL;
VarVal[0].boolVal = TRUE;
//"VAR_2_BYTE"
VarVal[1].vt = VT_UI1;
VarVal[1].bVal = 23;
//"VAR_3_SBYTE",
VarVal[2].vt = VT_I2;
VarVal[2].iVal = -23;
//"VAR_4_WORD",
VarVal[3].lVal = 89;
//"VAR_5_SWORD",
VarVal[4].iVal = -89;
//"VAR_6_DWORD",
VarVal[5].vt = VT_R8;
VarVal[5].dblVal = 1200;
//"VAR_7_SDWORD",
VarVal[6].lVal = -1200;
//"VAR_8_FLOAT",
VarVal[7].fltVal = (float)3.789;
//"VAR_9_DOUBLE",
VarVal[8].dblVal = (double)34.789;
//"VAR_A_TEXT8",
_tcsncpy_s(szTextValue, _countof(szTextValue), _T("VAR_A_TEXT8 Value"),
_TRUNCATE);
ret = MultiByteToWideChar(CP_ACP,(DWORD)0, (LPCSTR) &szTextValue,-1,
(LPWSTR)&Tmp[0],30);
// SysFreeString(pBSTR);
bstrText1 = SysAllocString((OLECHAR FAR*)&Tmp[0]);
VarVal[9].vt = VT_BSTR;
VarVal[9].bstrVal = bstrText1;
//"VAR_B_TEXT16"
_tcsncpy_s(szTextValue, _countof(szTextValue), _T("VAR_B_TEXT16 Value"),
_TRUNCATE);
ret = MultiByteToWideChar(CP_ACP,(DWORD)0, (LPCSTR)&szTextValue,-1,
(LPWSTR)&Tmp[0],30);
// SysFreeString(pB2);
bstrText2 = SysAllocString((OLECHAR FAR*)&Tmp[0]);
VarVal[10].vt = VT_BSTR;
VarVal[10].bstrVal = bstrText2;
// set tag

3.3 Functions of the graphic system (RT Professional)
ret = DMSetValue(&VarKey[0], nNum, &VarVal[0], &VarSta[0], &Error);

if (FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in DMSetValue:
E1= 0x%08lx ; E2= 0x%08lx ; %s"),
ODKTrace(szText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("write Value to WinCC"));
ODKTrace(szText);
}
SysFreeString(bstrText1);
SysFreeString(bstrText2);
}
}
}
See also
Overview
PDLRTShowApp (Page 1914) Display graphic system

PDLRT_CALLBACK Callback function of the runtime functions
(Page 1915)
PDLRTClosePicture Close screen
(Page 1902)
PDLRTDisableClosePicture Disable close screen function
(Page 1904)
PDLRTEnableClosePicture Enable close screen function
(Page 1906)
PDLRTGetCursorKeys Query cursor control keys
(Page 1917)

PDLRTGetDefPropEx Query default values of object properties

(Page 1925)
PDLRTGetPropEx (Page 1927) Query default values of object properties
PDLRTGetFocus (Page 1919) Query input focus
PDLRTGetLink (Page 1935) Query link between object property and tag
PDLRTGotoPicture (Page 1907) Query screen memory
PDLRTInquireFreeArea Determine free area of a window
(Page 1909)
PDLRTOpenPicture Root screen switch in Runtime
(Page 1910)
PDLRTPictureNavigation Enable and disable screen navigation
(Page 1913)
PDLRTSetCursorKeys Define cursor control keys
(Page 1921)
PDLRTSetFocus (Page 1923) Define input focus
PDLRTSetLink (Page 1937) Define link between object property and tag
PDLRTSetMultiLink (Page 1939) Define link between object property and tag (multiple tags)
PDLRTSetPropEx (Page 1930) Define object property
Overview
FOCUSINFO (Page 1902) Input focus data

LINKINFO (Page 1898) Linking of object properties and tags
MULTILINK (Page 1900) Linking of object properties and tags
MULTILINKINFO Linking of object properties and tags
(Page 1901)
Overview
structure:
Configuration
PDLCS_ELIASES_NO_ERROR 0 No error occurred.

PDLCS_ERROR_NO_DISPATCH 5 Ole Automation cannot be run
PDLCS_ERROR_NO_PROJECT 10 Project does not exist
PDLCS_ERROR_NO_PICTURE 15 Screen does not exist
PDLCS_ERROR_NO_OBJECT 20 Object does not exist
PDLCS_ERROR_NO_PROPERTY 25 Property does not exit

PDLCS_ERROR_NO_OBJTYPE 30 Object type not present.

PDLCS_ERROR_NO_DYNAMIC 32 No dynamics available
PDLCS_ERROR_ALREADY_OPEN 35 Specified screen is already open
PDLCS_ERROR_WRITE_PROTECTED 40 Specified screen is read-only
PDLCS_ERROR_PICTURE_SAVE 45 Specified screen could not be saved
PDLCS_ERROR_PICTURE_SAVE_AS 50 Specified screen could not be saved
PDLCS_ERROR_PICTURE_CLOSE 55 Specified screen could not be closed
PDLCS_ERROR_PICTURE_CLOSE_ALL 60 Screens could not be closed
PDLCS_ERROR_PICTURE_IMPORT 65 Screens could not be imported
PDLCS_ERROR_PICTURE_CREATE 70 General error when creating the screen
PDLCS_ERROR_PICTURE_EXISTS 75 Screen already exists
PDLCS_ERROR_NEW_OBJECT_NAME 80 Object name already exists
PDLCS_ERROR_NEW_OBJECT 85 Object could not be created
PDLCS_ERROR_DELETE_OBJECT 90 Object could not be deleted
PDLCS_ERROR_SET_PROPERTY 95 Property could not be set
PDLCS_ERROR_GET_PROPERTY 96 Property could not be read
PDLCS_ERROR_ENUM_OBJECTTYPE 100 Error while enumerating object types
PDLCS_ERROR_ENUM_PROPERTY 105 Error while enumerating object properties
PDLCS_ERROR_CREATE_PROPERTY 110 Property could not be defined
PDLCS_ERROR_SET_LINK 115 Connection could not be established
PDLCS_ERROR_REMOVE_LINK 120 Connection could not be deleted
PDLCS_ERROR_SET_ACTION 125 Action could not be stored
PDLCS_ERROR_GET_ACTION 126 Action could not be fetched
PDLCS_ERROR_ENUM_DYNAMICS 127 Dynamics could not be enumerated
PDLCS_ERROR_SET_DIRECTCONNECT 128 Direct connection could not be stored
PDLCS_ERROR_AUTOMATION 130 Error during transfer
PDLCS_ERROR_MEMORY 200 No memory
Runtime
PDLRT_OK 0 No error occurred.

PDLRT_APP_NOT_RUNNING 1 PDL application not started
PDLRT_NO_TRANSFER 2 PDL application cannot be accessed
PDLRT_NO_PIC 3 Screen not selected
PDLRT_NO_OBJ 4 Cannot find object
PDLRT_NO_PROP 5 Cannot find property
PDLRT_NO_MET 6 Cannot find method for object
PDLRT_LINK_NOT_SET 7 Property could not be connected
PDLRT_WNAME_NOT_UNIQUE 8 Instance name of new window not unique
PDLRT_WCREATION_FAILED 9 Window could not be created
PDLRT_PICTURE_NOT_LOADED 10 Screen file could not be loaded
PDLRT_ILLEGAL_USERLEVEL 11 Insufficient operator authorization level
PDLRT_NO_POSITION 12 Rectangle cannot be placed

PDLRT_POSITION_WITH_MODY 13 Rectangle was modified

PDLRT_E_ALREADY_CONNECTED 14 Another connection to the PDLRT already exists
PDLRT_PICTURE_ALREADY_OPEN 15 Screen is already open
PDLRT_BAD_OLE_CONVERSION 16 Error during conversion via OLE Automation
PDLRT_NO_LINK 17 Property has no dynamics
PDLRT_IND_LINK_READ_ERR 18 Error while reading the indirect tag
PDLRT_NO_IND_LINK 19 Property has no indirect dynamics
PDLRT_FAILURE_PARAM 20 Wrong parameter
Addressing mode
PDLRT_AM_DEFAULT 0 The addressing of screen and object is relative

PDLRT_AM_PICTABS 1 The addressing of the screen is absolute
PDLRT_AM_OBJABS 2 The addressing of the object is absolute
The PDLRT_AM_PICTABS and PDLRT_AM_OBJABS values can be ORed.
PDLRTInquireFreeArea
PDLRT_IQ_ONLY 0x01 Only inquiry with result: ''fits/does not fit''

PDLRT_IQ_MODY_POSX 0x02 The x-position of the rectangle may be
modified so that it can be placed
PDLRT_IQ_MODY_POSY 0x04 The y-position of the rectangle may be
modified so that it can be placed
PDLRT_IQ_MODY_HEIGHT 0x08 The height of the rectangle may be modi‐
fied so that it can be placed
PDLRT_IQ_MODY_WIDTH 0x10 The width of the rectangle may be modi‐
fied so that it can be placed
PDLRTOpenPicture
PDLRT_WS_STYLE_FROM_PIC 0 The display attributes are taken from the
screen data
PDLRT_WS_BORDER WS_BORDER Window with frame
PDLRT_WS_CAPTION WS_CAPTION Window with title and frame
PDLRT_WS_THICKFRAME WS_THICKFRAME Window with thick frame. Size can be
changed via mouse operation.
PDLRT_WS_HSCROLL WS_HSCROLL Window with horizontal slider
PDLRT_WS_VSCROLL WS_VSCROLL Window with vertical slider
Update cycles
Name Index
"On change" 0

"250 ms" 1
"500 ms" 2
"1 s" 3
"2 s" 4
"5 s" 5
"10 s" 6
"1 min" 7
"5 min" 8
"10 min" 9
"1 h" 10
"User cycle 1" 11
"User cycle 2" 12
"User cycle 3" 13
"User cycle 4" 14
"User cycle 5" 15
"Window cycle" 235
"Screen cycle" 255
3.3.1.5 List of object properties (A-K) (Graphics Designer) (RT Professional)
Overview
Note
For many API functions of the Graphics Designer, you must initialize the lpszPropName
parameter. The English name of an object property must be specified for this.
Properties of type VT_USERDEFINED must not be processed with the Get/Set Property
functions.
VT_DISPATCH and other references must not be used; only the standard types and at most
one VT_VARIANT for an array property of simple types may be used.
OLE Automation Data type Property name Attribute name Object association
name
"ActualPointLeft" VT_I4 Current Value Current Value X Polygon
X
"ActualPointTop" VT_I4 Current Value Current Value Y Polygon
Y
"AdaptBorder" VT_BOO Adapt Border Adapt Border Button, static text, I/O
L field, text list, check
box, radio box
"AdaptPicture" VT_BOO Adapt Picture Adapt Picture Screen window
L

"AdaptSize" VT_BOO Adapt Size Adapt Size Screen window

L
"AdaptWidth"
"AlarmHigh" VT_R8 Limit AH Limit AH Bar
"AlarmLow" VT_R8 Limit AL Limit AL Bar
"Alignment" VT_BOO Alignment Alignment Bar
L
"AlignmentLeft" VT_I4 X Alignment X Alignment Button, static text, I/O
field, group display,
text list, check box, ra‐
dio box
"AlignmentTop" VT_I4 Y Alignment Y Alignment Button, static text, I/O
dio box
"Analog" VT_BOO OCX Analog Analog DAClockCtrl
L
"AngleAlpha" VT_I4 BPC Alpha Alpha 3D bar
"AngleBeta" VT_I4 BPC Beta Beta 3D bar
"AngleMax" VT_R8 OCX AngleMax AngleMax XGaugeCtrl
"AngleMin" VT_R8 OCX AngleMin AngleMin XGaugeCtrl
"Application" VT_BST WindowCon‐ WindowContent Print job/Script diag‐
R tent nostics
"ApplicationData‐
Path"
"Assignments" VT_BST Assignments Assignments Text list
R
"AssumeOnExit" VT_BOO Apply on Exit Apply on Exit I/O field, text list
L
"AssumeOnFull" VT_BOO Apply on Full Apply on Full In‐ I/O field
L put
"Autoscroll" VT_BOO OCX AutoScroll AutoScroll CCAlgWinCtrl
L
"AutoSize" VT_I4 OCX AutoSize AutoSize PButtonCtrl
"Average" VT_BOO Average Value Average Value Bar
L
"Axe" VT_I4
"AxisSection" VT_R8 Axis Section Axis Section Bar
"BackBorderWidth" VT_I4 3D Border 3D Border Button, group display,
Weight Weight round button, slider ob‐
ject

"BackColor" VT_I4 Background Background Col‐ Button, ellipse, ellipse

Color or segment, circle, circle
segment, polygon, rec‐
tangle, rounded rectan‐
gle, static text, 3D bar,
I/O field, bar, graphic
object, group display,
dio box, round button,
slider object
"BackColor" VT_UI4 BackColor BackColor DAClockCtrl, XGau‐
geCtrl, PButtonCtrl, Sli‐
derCtrl
"BackColor2" VT_I4 Bar Color Bar Color Bar
"BackColor3" VT_I4 Bar Back‐ Bar Background Bar
ground Color Color
"BackColorBottom" VT_I4 Low Limit Low Limit Back‐ Slider object
Background ground Color
Color
"BackColorTop" VT_I4 High Limit High Limit Back‐ Slider object
Background ground Color
Color
"BackFlashColorOff" VT_I4 Flashing Back‐ Flashing Back‐ Button, ellipse, ellipse
ground Color ground Color Off segment, circle, circle
Off segment, polygon, rec‐
gle, static text, I/O field,
bar, graphic object,
slider object
"BackFlashColorOn" VT_I4 Flashing Back‐ Flashing Back‐ Button, ellipse, ellipse
ground Color ground Color On segment, circle, circle
On segment, polygon, rec‐
slider object
"Background" VT_BOO Background Background 3D bar
L
"BackgroundPicture" VT_USE Background‐ BackgroundPic‐ XGaugeCtrl
RDE‐ Picture ture
FINED
"BarBackColor" VT_UI4 BarBackColor BarBackColor SliderCtrl
"BarFillColor" VT_UI4 BarFillColor BarFillColor SliderCtrl
"BarDepth" VT_I4 Bar Depth Bar Depth 3D bar
"BarHeight" VT_I4 Bar Height Bar Height 3D bar
"BarWidth" VT_I4 Bar Width Bar Width 3D bar
"BasePicRefer‐ VT_BOO Basic Picture Basic Picture Status display
enced" L Referenced Referenced

"BasePicTransColor" VT_I4 Basic Picture Basic Picture Status display

Transparent Transparent Col‐
Color or
"BasePicture" VT_BST Basic Picture Basic Picture Status display
R
"BasePicUseTrans‐ VT_BOO Basic Picture Basic Picture Status display
Color" L Transparent Transparent Col‐
Color On or On
"BaseX" VT_I4 Base X Base X 3D bar
"BaseY" VT_I4 Base Y Base Y 3D bar
"Beveler" VT_I4 Beveler Beveler SliderCtrl
"BevelColorDown" VT_UI4 BevelColor‐ BevelColorDown SliderCtrl
Down
"BevelColorUp" VT_UI4 BevelColorUp BevelColorUp SliderCtrl
"BevelOuter" VT_I4 BevelOuter BevelOuter XGaugeCtrl
"BevelWidth" VT_I4 BevelWidth BevelWidth XGaugeCtrl
"BitNumber" VT_I4 Bit number Status display
"BorderBackColor" VT_I4 Border Back‐ Border Back‐ Button, ellipse, ellipti‐
ground Color, ground Color, cal arc, ellipse seg‐
Line Back‐ Line Background ment, circle, circular
ground Color Color arc, circle segment,
line, polygon, polyline,
rectangle, rounded rec‐
tangle, static text, I/O
field, bar, graphic ob‐
ject, text list, check
box, radio box, round
button, slider object
"BorderColor" VT_I4 Border Color, Border Color, Button, ellipse, ellipti‐
Line Back‐ Line Background cal arc, ellipse seg‐
ground Color Color ment, circle, circular
arc, circle segment,
tangle, static text, 3-D
bar, I/O field, bar,
graphic object, text list,
status display, check
"BorderColorBottom" VT_I4 3D Shadow 3D Shadow Color Button, round button
Color
"BorderColorTop" VT_I4 3D Border Col‐ 3D Border Color Button, round button
or
"BorderEndStyle" VT_UI4 Line End Style Line End Style Line, polyline

"BorderFlashColor‐ VT_I4 Flashing Bor‐ Flashing Border Button, ellipse, ellipti‐

Off" der Color Off, Color Off, Flash‐ cal arc, ellipse seg‐
Flashing Line ing Line Color Off ment, circle, circular
Color Off arc, circle segment,
box, radio box, slider
object
"BorderFlashColor‐ VT_I4 Flashing Bor‐ Flashing Border Button, ellipse, ellipti‐
On" der Color On, Color On, Flash‐ cal arc, ellipse seg‐
Flashing Line ing Line Color On ment, circle, circular
Color On arc, circle segment,
"BorderStyle" VT_UI4 Line Style Line Style Button, ellipse, ellipti‐
cal arc, ellipse seg‐
ment, circle, circular
bar, I/O field, graphic
object, text list, status
display, check box, ra‐
slider object
"BorderWidth" VT_I4 Line Weight Line Weight Button, ellipse, ellipti‐
graphic object, text list,
status display, check
"BorderWidth" VT_I4 OCX BorderWidth BorderWidth XGaugeCtrl
"BoxAlignment" VT_BOO Box Alignment Box Alignment Check box, radio box
L
"BoxCount" VT_I4 Number of Number of Boxes Check box, radio box
Boxes
"BoxType" VT_I4 Field Type Field Type I/O field, text list
"Button1Width" VT_I4 Button 1 Width Button 1 Width Group display


(Error: But‐
ton 1 Width 2)
(Error: But‐
ton 1 Width 3)
"ButtonColor" VT_I4 Button Color Button Color Slider object
"ButtonCommand" VT_I4 OCX ButtonCom‐ ButtonCommand CCAlgWinCtrl
mand
"Caption" VT_BOO Title Title Print job/Script diag‐
L nostics, screen window
"Caption" VT_BST OCX Caption Caption XGaugeCtrl, PBut‐
R tonCtrl, SliderCtrl
"CaptionColor" VT_UI4 OCX CaptionColor CaptionColor XGaugeCtrl
"CaptionFont" VT_USE OCX CaptionFont CaptionFont XGaugeCtrl
RDE‐
FINED
"CaptionOffset" VT_R8 OCX CaptionOffset CaptionOffset XGaugeCtrl
"CellCut" VT_BOO OCX CellCut CellCut CCAlgWinCtrl
L
"CenterColor" VT_UI4 OCX CenterColor CenterColor XGaugeCtrl
"CenterScale" VT_R4 OCX CenterScale CenterScale XGaugeCtrl
"CheckAlarmHigh" VT_BOO Monitoring AH Monitoring AH Bar
L
"CheckAlarmLow" VT_BOO Monitoring AL Monitoring AL Bar
L
"CheckLimitHigh4" VT_BOO Monitoring Monitoring RH4 Bar
L RH4
"CheckLimitHigh5" VT_BOO Monitoring Monitoring RH5 Bar
L RH5
"CheckLimitLow4" VT_BOO Monitoring RL4 Monitoring RL4 Bar
L
"CheckLimitLow5" VT_BOO Monitoring RL5 Monitoring RL5 Bar
L
"CheckTolerance‐ VT_BOO Monitoring TH Monitoring TH Bar
High" L
"CheckTolerance‐ VT_BOO Monitoring TL Monitoring TL Bar
Low" L
"CheckWarningHigh" VT_BOO Monitoring WH Monitoring WH Bar
L
"CheckWarningLow" VT_BOO Monitoring WL Monitoring WL Bar
L
"ClearOnError" VT_BOO Clear on Inva‐ Clear on Invalid I/O field
L lid Input Input
"ClearOnNew" VT_BOO Clear on New Clear on New In‐ I/O field
L Input put
"CloseButton" VT_BOO Can be Closed Can be Closed Print job/Script diag‐
L nostics, screen window

"CollectValue" VT_UI4 Group Value Group Value Group display

"ColMove" VT_BOO OCX ColMove ColMove CCAlgWinCtrl
L
"ColorAlarmHigh" VT_I4 Bar Color AH Bar Color AH Bar
"ColorAlarmLow" VT_I4 Bar Color AL Bar Color AL Bar
"ColorBottom" VT_I4 Low Limit Color Low Limit Color Slider object
"ColorChangeType" VT_BOO Change Color Change Color Bar
L
"ColorLimitHigh4" VT_I4 Bar Color RH4 Bar Color RH4 Bar
"ColorLimitHigh5" VT_I4 Bar Color RH5 Bar Color RH5 Bar
"ColorLimitLow4" VT_I4 Bar Color RL4 Bar Color RL4 Bar
"ColorLimitLow5" VT_I4 Bar Color RL5 Bar Color RL5 Bar
"ColorTolerance‐ VT_I4 Bar Color TH Bar Color TH Bar
High"
"ColorTolerance‐ VT_I4 Bar Color TL Bar Color TL Bar
Low"
"ColorTop" VT_I4 High Limit Col‐ High Limit Color Slider object
or
"ColorWarningHigh" VT_I4 Bar Color WH Bar Color WH Bar
"ColorWarningLow" VT_I4 Bar Color WL Bar Color WL Bar
"ColTitle" VT_BOO OCX ColTitle ColTitle CCAlgWinCtrl
L
"ColWidth" VT_BOO OCX ColWidth ColWidth CCAlgWinCtrl
L
"CursorControl" VT_BOO Cursor Control Cursor Control I/O field, text list
L
"CursorMode" VT_BOO
L
"Danger" VT_R4 OCX Danger Danger XGaugeCtrl
"DangerColor" VT_UI4 OCX DangerColor DangerColor XGaugeCtrl
"DataFormat" VT_I4 Data Format Data Format I/O field
"DataLanguage" VT_I4 Configured Configured Lan‐ Button, static text,
Languages guages check box, radio box
"Delta" VT_R4 Delta Delta XGaugeCtrl
"DesignMode"
"DigitNumber"
"Direction" VT_I4 Bar Alignment Bar Alignment 3D bar, slider object,
bar
"EditAtOnce" VT_BOO Immediate In‐ Immediate Input I/O field, text list
L put
"EnableTime"
"EnableWriting"
"EndAngle" VT_I4 End Angle End Angle Elliptical arc, ellipse
segment, circular arc,
circle segment
"Exponent" VT_BOO Exponent Dis‐ Exponent Dis‐ Bar
L play play

"ExtendedOperation" VT_BOO Extended Op‐ Extended Opera‐ Slider object

L eration tion
"FillBackColor"
"FillColor" VT_I4 Fill Pattern Col‐ Fill Pattern Color Button, ellipse, ellipse
or segment, circle, circle
slider object
"Filling" VT_BOO Dynamic Filling Dynamic Filling Button, ellipse, ellipse
L segment, circle, circle
gle, static text, graphic
object, check box, ra‐
dio box, round button
"FillingIndex" VT_I4 Fill Level Fill Level Button, ellipse, ellipse
segment, circle, circle
gle, static text, graphic
object, check box, ra‐
slider object
"FillStyle" VT_UI4 Fill Pattern Fill Pattern Button, ellipse, ellipse
segment, circle, circle
slider object
"FillStyle2" VT_UI4 Bar Pattern Bar Pattern Bar
"FlashBackColor" VT_BOO Flashing Back‐ Flashing Back‐ Button, ellipse, ellipse
L ground Active ground Active segment, circle, circle
slider object

"FlashBorderColor" VT_BOO Flashing Line Flashing Line Ac‐ Button, ellipse, ellipti‐
L Active tive cal arc, ellipse seg‐
"FlashBorderColor‐
Ex"
"FlashFlashPicture" VT_BOO Flashing Flash Flashing Flash Status display
L Picture Active Picture Active
"FlashForeColor" VT_BOO Flashing Text Flashing Text Ac‐ Button, static text, I/O
L Active tive field, text list, check
box, radio box
"FlashPicRefer‐ VT_BOO Flash Picture Flash Picture Status display
enced" L Referenced Referenced
"FlashPicTransCol‐ VT_I4 Basic Picture Basic Picture Status display
or" Transparent Transparent Col‐
Color or
"FlashPicture" VT_BST Flash Picture Flash Picture Status display
R
"FlashPicUseTrans‐ Flash Picture Flash Picture Status display
Color" Transparent Transparent Col‐
Color On or On
"FlashRate" VT_I4 Flash Frequen‐ Flash Frequency Group display
cy
"FlashRateBackCol‐ VT_I4 Background Background Button, ellipse, ellipse
or" Flash Frequen‐ Flash Frequency segment, circle, circle
cy segment, polygon, rec‐
slider object
"FlashRateBorder‐ VT_I4 Line Flash Fre‐ Background Button, ellipse, ellipti‐
Color" quency Flash Frequency cal arc, ellipse seg‐
"FlashRateFlashPic" VT_I4 Flash Picture Flash Picture Status display
Flash Frequen‐ Flash Frequency
cy

"FlashRateForeCol‐ VT_I4 Text Flash Fre‐ Text Flash Fre‐ Button, static text, I/O
or" quency quency field, text list, check
box, radio box
"Font" VT_USE OCX Font Font DAClockCtrl, PBut‐
RDE‐ tonCtrl, SliderCtrl
FINED
"FontBold" VT_BOO Bold Bold Button, static text, I/O
L field, bar, group dis‐
play, text list, check
box, radio box
"FontBold" VT_BOO OCX FontBold FontBold PButtonCtrl
L
"FontItalic" VT_BOO Italic Italic Button, static text, I/O
L field, group display,
dio box
"FontItalic" VT_BOO FontItalic FontItalic PButtonCtrl
L
"FontName" VT_BST Font Font Button, static text, I/O
R field, group display,
dio box
"FontName" VT_BST OCX FontName FontName PButtonCtrl
R
"FontPosition" VT_USE OCX FontPosition FontPosition SliderCtrl
RDE‐
FINED
"FontSize" VT_I4 Font Size Font Size Button, static text, I/O
dio box
"FontSize" VT_BST OCX FontSize Font Size PButtonCtrl
R
"FontStrikeThru" VT_BOO OCX FontStrikeThru FontStrikeThru PButtonCtrl
L
"FontUnderline" VT_BOO Underline Underline Button, static text, I/O
L field, group display,
dio box
"FontUnderline" VT_BOO OCX FontUnderline FontUnderline PButtonCtrl
L
"ForceInput"
"ForeColor" VT_I4 Font Color Font Color Button, static text, I/O
dio box
"ForeColor" VT_UI4 OCX ForeColor ForeColor DAClockCtrl, PBut‐
tonCtrl, SliderCtrl
"ForeFlashColorOff" VT_I4 Flashing Text Flashing Text Button, static text, I/O
Color Off Color Off field, group display,
dio box

"ForeFlashColorOn" VT_I4 Flashing Text Flashing Text Button, static text, I/O
Color On Color On field, group display,
dio box
"FrameColor" VT_UI4
"FrameColorDown" VT_UI4 OCX FrameColor‐ FrameColor‐ PButtonCtrl
Down Down
"FrameColorUp" VT_UI4 OCX FrameColorUp FrameColorUp PButtonCtrl
"FramePicture" VT_USE OCX FramePicture FramePicture XGaugeCtrl
RDE‐
FINED
"FrameScale" VT_R4 OCX FrameScale FrameScale XGaugeCtrl
"FrameSize" OCX FrameSize FrameSize PButtonCtrl
"FrameWidth" VT_I4 OCX FrameWidth FrameWidth PButtonCtrl
"Freeze" VT_BOO Freeze Freeze WTVctrlCtrl
L
"Grid" VT_BOO
L
"GridColor" VT_I4
"GridHeight" VT_I4
"GridLineHorz" VT_BOO OCX GridLineHorz GridLineHorz CCAlgWinCtrl
L
"GridLineVert" VT_BOO OCX GridLineVert GridLineVert CCAlgWinCtrl
L
"GridWidth" VT_I4
"Height" VT_I4 Height Height Button, ellipse, ellipti‐
graphic object, group
display, text list, status
display, check box, ra‐
slider object, DA‐
ClockCtrl, XGau‐
geCtrl, CCAlgWinCtrl,
PButtonCtrl, SliderCtrl,
WTVctrlCtrl
"Height" VT_I4 Window Height Window Height Print job/Script diag‐
nostics, screen window
"HiddenInput" VT_BOO Hidden Input Hidden Input I/O field
L
"Hotkey" VT_UI4 Hot Key Hot Key Button
"HourNeedleHeight" VT_I4 HourNeedle‐ HourNeedle‐ DAClockCtrl
Height Height
"HourNeedleWidth" VT_I4 HourNeedle‐ HourNeedle‐ DAClockCtrl
Width Width

"Hysteresis" VT_BOO Hysteresis Hysteresis Bar

L
"HysteresisRange" VT_R8 Hysteresis Hysteresis Bar
Range Range
"Index" VT_I4 Index Index Polygon, polyline, sta‐
tus display, check box,
radio box
"InnerBevelOffset" VT_I4 OCX InnerBevelOff‐ InnerBevelOffset SliderCtrl
set
"InnerBevelStyle" VT_I4 OCX InnerBevel‐ InnerBevelStyle SliderCtrl
Style
"InnerBevelWidth" VT_I4 OCX InnerBevel‐ InnerBevelWidth SliderCtrl
Width
"ItemBorderBack‐ VT_I4 Dividing Back‐ Dividing Back‐ Text list
Color" ground Color ground Color
"ItemBorderColor" VT_I4 Dividing Line Dividing Line Col‐ Text list
Color or
"ItemBorderStyle" VT_UI4 Dividing Line Dividing Line Text list
Style Style
3.3.1.6 List of object properties (L-Z) (Graphics Designer) (RT Professional)
Overview
Note
For many API functions of the Graphics Designer, you must initialize the lpszPropName
parameter. The English name of an object property must be specified for this.
Properties of type VT_USERDEFINED must not be processed with the Get/Set Property
functions.
VT_DISPATCH and other references must not be used; only the standard types and at most
one VT_VARIANT for an array property of simple types may be used.
OLE Automation Data type Property name Attribute name Object association
name
"LanguageS‐ VT_BOOL Language Language Text list
witch" Switch switching
"LastChange" VT_BSTR

"Layer" VT_I4 Layer Layer Button, ellipse, elliptical

arc, ellipse segment, cir‐
cle, circular arc, circle seg‐
ment, line, polygon, poly‐
line, rectangle, rounded
rectangle, static text, 3-D
bar, print job/script diag‐
nostics, screen window, I/
O field, bar, graphic object,
group display, text list, sta‐
tus display, check box, ra‐
dio box, round button, slid‐
er object, XGaugeCtrl,
CCAlgWinCtrl, PBut‐
tonCtrl, SliderCtrl,
WTVctrlCtrl
"Lay‐ VT_BOOL BPC Monitoring 0 Monitoring 0 3D bar
er00Checked"
er01Checked"
er02Checked"
er03Checked"
er04Checked"
er05Checked"
er06Checked"
er07Checked"
er08Checked"
er09Checked"
er10Checked"
"Layer00Color" VT_I4 BPC Bar Color 0 Bar Color 0 3D bar
"Layer00Value" VT_R8 BPC Limit 0 Limit 0 3D bar


"Left" VT_I4 X position X position Button, ellipse, elliptical
er object, XGaugeCtrl,
WTVctrlCtrl
"LeftComma" VT_I4 Digits to the Digits to the Bar
Left of the Dec‐ Left of the Dec‐
imal Point imal Point
"LightEffect" VT_BOOL Light Effect Light Effect 3D bar
"LimitHigh4" VT_R8 Limit RH4 Limit RH4 Bar
"LimitHigh5" VT_R8 Limit RH5 Limit RH5 Bar
"LimitLow4" VT_R8 Limit RL4 Limit RL4 Bar
"LimitLow5" VT_R8 Limit RL5 Limit RL5 Bar
"LimitMax" VT_R8
"LimitMin" VT_R8
"LineFont" VT_BOOL OCX LineFont LineFont CCAlgWinCtrl
"LineHeight" VT_BOOL OCX LineHeight LineHeight CCAlgWinCtrl
"LineTitle" VT_BOOL OCX LineTitle LineTitle CCAlgWinCtrl
"ListType" VT_I4 List Type List Type Text list
"Locale"
"LockBackColor" VT_I4 Lock Back‐ Lock Back‐ Group display
ground Color ground Color
"LockStatus" VT_BOOL Lock Display Lock Display Group display
"LockText" VT_BOOL Lock Display Lock Display Group display
Text Text
"LockTextColor" VT_I4 Lock Font Col‐ Lock Font Col‐ Group display
or or

"LongStrokes‐ VT_BOOL Long Axis Sec‐ Long Axis Sec‐ Bar

Bold" tion tion
"LongStrokesOn‐ VT_BOOL Only Long Axis Only Long Axis Bar
ly" Section Section
"LongStrokes‐ VT_UI4 Length of Axis Length of Axis Bar
Size" Section Section
"LongStrokes‐ VT_UI4 Label Each Label Each Bar
TextEach"
"Marker" VT_BOOL Limit Marker Limit Marker Bar
"Max" VT_R8 Maximum Val‐ Maximum Val‐ 3D bar, slider object, bar
ue ue
"MaximizeBut‐ VT_BOOL Can be Maxi‐ Can be Maxi‐ Print job/Script diagnos‐
ton" mized mized tics, screen window
"MCGUBackCo‐ VT_I4 Went Out Un‐ Outgoing Un‐ Group display
lorOff" acknowledge- acknowl‐
Background edged- Back‐
Color Off ground Color
Off
"MCGUBackCo‐ VT_I4 Went Out Un‐ Outgoing Un‐ Group display
lorOn" acknowledge- acknowl‐
Background edged- Back‐
Color On ground Color
On
"MCGUBack‐ VT_BOOL Went Out Un‐ Outgoing Un‐ Group display
Flash" acknowledge - acknowledged
Background - Background
Flashing Flashing
"MCGUTextCo‐ VT_I4 Went Out Un‐ Incoming - Group display
lorOff" acknowledge- Background
Text Color Off Color Off
"MCGUTextCo‐ VT_I4 Went Out Un‐ Incoming - Group display
lorOn" acknowledge- Background
Text Color On Color On
"MCGUText‐ VT_BOOL Went Out Un‐ Outgoing Un‐ Group display
Flash" acknowledge - acknowledged
Text Flashing - Background
Flashing
"MCKOBackCo‐ VT_I4 Came In - Incoming - Group display
lorOff" Background Background
Color Off Color Off
"MCKOBackCo‐ VT_I4 Came In - Incoming - Group display
lorOn" Background Background
Color On Color On
"MCKOBack‐ VT_BOOL Came In - Incoming - Group display
Flash" Background Background
Flashing Flashing
"MCKOTextCo‐ VT_I4 Came In - Text Incoming - Group display
lorOff" Color Off Text Color Off
"MCKOTextCo‐ VT_I4 Came In - Text Incoming - Group display
lorOn" Color On Text Color On

"MCKOText‐ VT_BOOL Came In - Text Incoming - Group display

Flash" Flashing Text Flashing
"MCKQBackCo‐ VT_I4 Came In Ac‐ Incoming Ac‐ Group display
lorOff" knowledge - knowledge -
Background Background
Color Off Color Off
"MCKQBackCo‐ VT_I4 Came In Ac‐ Incoming Ac‐ Group display
lorOn" knowledge - knowledge -
Color On Color On
"MCKQBack‐ VT_BOOL Came In Ac‐ Incoming Ac‐ Group display
Flash" knowledge - knowledge -
Flashing Flashing
"MCKQTextCo‐ VT_I4 Came In Ac‐ Incoming Ac‐ Group display
lorOff" knowledge - knowledge -
Text Color Off Text Color Off
"MCKQTextCo‐ VT_I4 Came In Ac‐ Incoming Ac‐ Group display
lorOn" knowledge - knowledge -
Text Color On Text Color On
"MCKQText‐ VT_BOOL Came In Ac‐ Incoming Ac‐ Group display
Flash" knowledge - knowledge -
Text Flashing Text Flashing
"MCText" VT_BOOL Display Text Display Text Group display
"MessageClass" VT_I4 Message Type Message Type Group display
"Min" VT_R8 Minimum Val‐ Minimum Val‐ Group display
ue ue
"MinuteNeedle‐ VT_I4 OCX MinuteNeedle‐ MinuteNeedle‐ Group display
Height" Height Height
"MinuteNeedle‐ VT_I4 OCX MinuteNeedle‐ MinuteNeedle‐ Group display
Width" Width Width
"MsgFilter" VT_BSTR OCX MsgFilter
"MsgFilter2" VT_BSTR OCX MsgFilter2
"Moveable" VT_BOOL Moveable Moveable Print job/Script diagnos‐
tics, screen window
"NeedleColor" VT_UI4 OCX NeedleColor NeedleColor XGaugeCtrl
"NormalColor" VT_UI4 OCX NormalColor NormalColor XGaugeCtrl
"NumberLines" VT_I4 Number of visi‐ Number of visi‐ Text list, check box, radio
ble Lines ble Lines box,

"ObjectName" VT_BSTR Object Name Object name Button, ellipse, elliptical

nostics, I/O field, bar,
graphic object, group dis‐
play, text list, status dis‐
play, check box, radio box,
round button, slider object,
DAClockCtrl, XGaugeCtrl,
WTVctrlCtrl
"OffsetLeft" VT_I4 Picture Offset Picture Offset Screen window
X X
"OffsetTop" VT_I4 Picture Offset Picture Offset Screen window
Y Y
"OnTop" VT_BOOL Foreground Foreground Print job/Script diagnos‐
tics, screen window
"Operation" VT_BOOL Operator-Con‐ Operator-Con‐ Button, ellipse, elliptical
trol Enable trol Enable arc, ellipse segment, cir‐
bar, I/O field, bar, graphic
object, group display, text
list, status display, check
box, radio box, round but‐
ton, slider object, DA‐
ClockCtrl, XGaugeCtrl,
WTVctrlCtrl
"OperationMes‐ VT_BOOL Operator Input Operator Input I/O field, text list, check
sage" Message Message box, radio box, slider object
"OperationRe‐ VT_BOOL Operator Ac‐ Operator Ac‐ I/O field, text list, slider ob‐
port" tions Report tions Report ject
"OperationSteps" Operation Operation Slider object
Steps Steps
"Orientation" VT_BOOL Text Orienta‐ Text Orienta‐ Static text, I/O field, text
tion tion list, check box, radio box
"OuterBevelOff‐ VT_I4 OCX OuterBevelOff‐ OuterBevelOff‐ SliderCtrl
set" set set
"OuterBevel‐ VT_I4 OCX OuterBevel‐ OuterBevel‐ SliderCtrl
Style" Style Style
"OuterBevel‐ VT_I4 OCX OuterBevel‐ OuterBevel‐ SliderCtrl
Width" Width Width
"Outline" VT_BOOL OCX Outline Outline PButtonCtrl
"OutputFormat" VT_BSTR Output Format Output Format I/O field

"OutputValue" VT_R8 Output Value Output Value I/O field, text list
"PasswordLevel" VT_UI4 User Level Password Button, ellipse, elliptical
ton, slider object
"PicDeactRefer‐ VT_BOOL Picture Deact. Picture Deact. Round button
enced" Referenced Referenced
"PicDeactTrans‐ VT_I4 Picture Deact. Picture Deact. Round button
parent" Transparent Transparent
Color Color
"PicDeactUse‐ VT_BOOL Picture Deact. Picture Deact. Round button
TransColor" Transparent Transparent
Color On Color On
"PicDownRefer‐ VT_BOOL Picture On Ref‐ Picture On Ref‐ Round button
enced" erenced erenced
"PicDownTrans‐ VT_I4 Picture On Picture On Round button
parent" Transparent Transparent
Color Color
"PicDownUse‐ VT_BOOL Picture On Picture On Round button
Color On Color On
"PicReferenced" VT_BOOL Picture Refer‐ Picture Refer‐ Graphic object
enced enced
"PicTransColor" VT_I4 Picture Trans‐ Picture Trans‐ Graphic object
parent Color parent Color
"Picture" VT_USER OCX Picture Picture DAClockCtrl
DEFINED
"PictureBack" VT_USER OCX PictureBack PictureBack SliderCtrl
DEFINED
"PictureDeacti‐ VT_BSTR Picture Status Picture Status Round button
vated" Deactivated Deactivated
"PictureDown" VT_BSTR Picture Status Picture Status Button, round button
On On
"PictureName" VT_BSTR Picture Name Screen name Screen window, graphic
object
"PictureSelec‐ VT_USER OCX PictureSelec‐ PictureSelec‐ PButtonCtrl
ted" DEFINED ted ted
"PictureUnselec‐ VT_USER OCX Picture Unse‐ Picture Unse‐ PButtonCtrl
ted" DEFINED lected lected
"PictureObject‐
Path"
"PictureThumb" VT_USER PictureThumb PictureThumb SliderCtrl
DEFINED

"PictureUp" VT_BSTR Picture Status Picture Status Button, round button

Off Off
"PicUpRefer‐ VT_BOOL Picture Off Ref‐ Picture Off Ref‐ Round button
enced" erenced erenced
"PicUpTranspar‐ VT_I4 Picture Off Picture Off Round button
ent" Transparent Transparent
Color Color
"PicUpUse‐ VT_BOOL Picture Off Picture Off Round button
Color On Color On
"PicUseTrans‐ VT_BOOL Picture Trans‐ Transparent Graphic object
Color" parent Color Color On
On
"PointCount" VT_I4 Number of Cor‐ Number of Cor‐ Polygon, polyline
ners ners
"Position" VT_I4 OCX Positions Positions SliderCtrl
"PredefinedAn‐ VT_I4 BPC Angle Settings Angle Settings 3D bar
gles"
"Pressed" VT_BOOL Pressed Pressed Round button
"Process" VT_R8 Process Driver Process Driver 3D bar, slider object, bar
Connection Connection
"Process" VT_R8 Selected Box‐ Selected Box‐ Check box, radio box
es es
"ProfileName"
"ProjectName"
"ProjectPath" VT_BSTR OCX ProjectPath ProjectPath CCAlgWinCtrl
"Radius" VT_I4 Radius Radius Circle, circular arc, circle
segment, round button
"RadiusHeight" VT_I4 Y radius Y radius Ellipse, Elliptical arc, el‐
lipse segment
"RadiusWidth" VT_I4 X radius X radius Ellipse, Elliptical arc, el‐
lipse segment
"RangeMax" VT_I4 OCX RangeMax RangeMax SliderCtrl
"RangeMin" VT_I4 OCX RangeMin RangeMin SliderCtrl
"ReferenceMo‐
veLeft"
"ReferenceMo‐
veTop"
"ReferenceRota‐ VT_I4 Rotation Refer‐ Rotation Refer‐ Line, polygon, polyline
tionLeft" ence X ence X
"ReferenceRota‐ VT_I4 Rotation Refer‐ Rotation Refer‐ Line, polygon, polyline
tionTop" ence Y ence Y
"RefreshTimer‐ VT_I4 OCX RefreshTimer‐ RefreshTimer‐ WTVctrlCtrl
Period" Period Period
"Relevant" VT_BOOL Group Rele‐ Group Rele‐ Group display
vant vant
"RightComma" VT_I4 Digits to the Digits to the Bar
Right of the Right of the
Decimal Point Decimal Point

"RotationAngle" VT_I4 Rotation Angle Rotation Angle Line, polygon, polyline

"RoundCorner‐ VT_I4 Corner Radius Corner Radius Rounded rectangle
Height" Y Y
"RoundCorner‐ VT_I4 Corner Radius Corner Radius Rounded rectangle
Width" X X
"SameSize" VT_BOOL Same Size Same Size Group display
"ScaleColor" VT_I4 Scale Color Scale Color Bar
"ScaleTicks" VT_I4 Scale Marks Scale Marks Bar
"Scaling" VT_BOOL Scale Scale Bar
"ScalingType" VT_I4 Bar Scaling Bar Scaling Bar
"ScrollBars" VT_BOOL Scroll Bar Scroll Bar Screen window
"SecondNeedle‐ VT_I4 OCX SecondNee‐ SecondNee‐ DAClockCtrl
Height" dleHeight dleHeight
"SecondNeedle‐ VT_I4 OCX SecondNee‐ SecondNee‐ DAClockCtrl
Width" dleWidth dleWidth
"SelBGColor" VT_I4 Selection Selection Text list
Color Color
"SelectionMode" VT_I2 OCX SelectionMode SelectionMode CCAlgWinCtrl
"SelTextColor" VT_I4 Selection Font Selection Font Text list
Color Color
"ServerName" VT_BSTR Server Name Server Name DAClockCtrl, XGaugeCtrl,
WTVctrlCtrl
"Sign"
"Significant‐ VT_UI4 Bit Pattern Bit Pattern Group display
Mask" Group Display Group Display
"Sizeable" VT_BOOL Sizeable Sizeable Print job/Script diagnos‐
tics, screen window
"ShowBar" VT_BOOL OCX ShowBar ShowBar SliderCtrl
"ShowDanger" VT_BOOL OCX ShowDanger ShowDanger XGaugeCtrl
"ShowDecimal‐ VT_BOOL OCX ShowDecimal‐ ShowDecimal‐ XGaugeCtrl
Point" Point Point
"ShowNormal" VT_BOOL OCX ShowNormal ShowNormal XGaugeCtrl
"ShowPeak" VT_BOOL OCX ShowPeak ShowPeak XGaugeCtrl
"ShowPosition" VT_BOOL OCX ShowPosition ShowPosition SliderCtrl
"ShowThumb" VT_BOOL OCX ShowThumb ShowThumb SliderCtrl
"SmallWarning" VT_I4 SmallWarning Slider object
"StartAngle" VT_I4 Start Angle Start Angle Elliptical arc, ellipse seg‐
ment, circular arc, circle
segment
"TabOrderAlpha"
"TabOrderS‐
witch"
"Template" VT_BSTR Template Template Print job/Script diagnostics
"TemplateName" VT_BSTR OCX Template‐ Template‐ CCAlgWinCtrl
Name Name

"Text" VT_BSTR Text Text Button, static text, check

box, radio box
"ThumbBackCol‐ VT_UI4 OCX ThumbBack‐ ThumbBack‐ SliderCtrl
or" Color Color
"TicColor" VT_UI4 OCX TicColor TicColor XGaugeCtrl
"TicFont" VT_USER OCX TicFont TicFont XGaugeCtrl
DEFINED
"Ticks" VT_BOOL OCX Ticks Ticks DAClockCtrl
"TicksColor" VT_UI4 OCX TicksColor TicksColor DAClockCtrl
"TickStyle" VT_I4 OCX TickStyle TickStyle SliderCtrl
"TicOffset" VT_R8 OCX TicOffset TicOffset XGaugeCtrl
"TicTextColor" VT_UI4 OCX TicTextColor TicTextColor XGaugeCtrl
"TicTextOffset" VT_R8 OCX TicTextOffset TicTextOffset XGaugeCtrl
"TicWidth" VT_R8 OCX TicWidth TicWidth XGaugeCtrl
"TitleCut" VT_BOOL OCX TitleCut TitleCut CCAlgWinCtrl
"Toggle" VT_BOOL Latch Down Latch Down Round button
"ToleranceHigh" VT_R8 Limit TH Limit TH Bar
"ToleranceLow" VT_R8 Limit TL Limit TL Bar
"ToolTipText" VT_BSTR Tooltip Text Tooltip Text Button, ellipse, elliptical
ton, slider object, DA‐
ClockCtrl, XGaugeCtrl,
WTVctrlCtrl
"Top" VT_I4 Y position Y position Button, ellipse, elliptical
er object, DAClockCtrl,
XGaugeCtrl, CCAlg‐
WinCtrl, PButtonCtrl, Sli‐
derCtrl, WTVctrlCtrl
"Trend" VT_BOOL Trend Trend Bar
"TrendColor" VT_I4 Trend Color Trend Color Bar

"TypeAlarmHigh" VT_BOOL Type AH Type AH Bar

"TypeAlarmLow" VT_BOOL Type AL Type AL Bar
"TypeLimitHigh4" VT_BOOL Type RH4 Type RH4 Bar
"TypeLimitHigh5" VT_BOOL Type RH5 Type RH5 Bar
"TypeLimitLow4" VT_BOOL Type RL4 Type RL4 Bar
"TypeLimitLow5" VT_BOOL Type RL5 Type RL5 Bar
"TypeTolerance‐ VT_BOOL Type TH Type TH Bar
High"
"TypeTolerance‐ VT_BOOL Type TL Type TL Bar
Low"
"TypeWarning‐ VT_BOOL Type WH Type WH Bar
High"
"TypeWarnin‐ VT_UI4 Type WL Type WL Bar
gLow"
"UnitColor" VT_USER OCX UnitColor UnitColor XGaugeCtrl
DEFINED
"UnitFont" VT_BSTR OCX UnitFont UnitFont XGaugeCtrl
"UnitText" VT_BSTR OCX UnitText UnitText XGaugeCtrl
"UnitOffset" VT_R8 OCX UnitOffset UnitOffset XGaugeCtrl
"UnselBGColor" VT_I4 List Back‐ List Back‐ Text list
ground Color ground Color
"UnselTextColor" VT_I4 List Font Color List Font Color Text list
"UpdateCycle" VT_I4 Update Cycle Update Cycle Screen window
"UseRefreshTim‐ VT_BOOL OCX UseRefresh‐ UseRefresh‐ WTVctrlCtrl
er" Timer Timer
"UserValue1" VT_UI4 User Value 1 User Value 1 Group display
"Value" VT_R4 OCX Value Value XGaugeCtrl
"ValueMax" VT_R4 OCX ValueMax ValueMax XGaugeCtrl
"ValueMin" VT_R4 OCX ValueMin ValueMin XGaugeCtrl
"VideoEnabled" VT_BOOL OCX VideoEnabled VideoEnabled WTVctrlCtrl
"VideoSource" VT_I2 OCX VideoSource VideoSource WTVctrlCtrl

"Visible" VT_BOOL Display Display Button, ellipse, elliptical

"Warning" VT_R4 OCX Warning Warning XGaugeCtrl
"WarningColor" VT_UI4 OCX WarningColor WarningColor XGaugeCtrl
"WarningHigh" VT_R8 Limit WH Limit WH Bar
"WarningLow" VT_R8 Limit WL Limit WL Bar
"Width" VT_I4 Width Width Button, ellipse, elliptical
"WindowBorder" VT_BOOL Border Border Print job/Script diagnos‐
tics, screen window
"WindowsStyle" VT_BOOL Windows Style Windows Style Button, Slider object
"WindowType" VT_I2 OCX WindowType WindowType CCAlgWinCtrl
"WinTVInforma‐ VT_BSTR OCX WinTVInforma‐ WTVctrlCtrl
tion" tion
"WithAxes" VT_BOOL OCX WithAxes WithAxes SliderCtrl
"WithLabels" VT_BOOL OCX WithLabels WithLabels SliderCtrl
"ZeroLeading"
"ZeroPoint" VT_UI4 Zero Point Zero Point Bar
"ZeroPointValue" VT_R8 Zero Point Val‐ Zero Point Val‐ 3-D bar, bar
ue ue
Zoom VT_I4 Scaling Factor Scaling Factor Screen window

3.3.1.7 API calls to OCXs (RT Professional)
Overview
API was developed for uses in separate applications. However, problems may arise – including
possible deadlocks – when API calls are made to OCXs that are integrated into graphics
screens.
If use of an OCX in a graphics screen is absolutely necessary, always check to see if the task
could be also be handled with IndustrialX. This option is designed for purposes like this.
If it is determined that API must be used for the task, note the following:
The Runtime API functions of alarm logging and tag logging are especially affected by this.
One reason is that API requests data from WinCC programs during runtime via Window
Message and awaits the reply. If the OCX runs in the context of just such a WinCC program,
it cannot process the request because it hangs in the API call.
Solution:
When this happens, it is often sufficient to place the API call in a different thread.
However, this solution should only be used when a problem actually exists. For example, some
other calls experience problems when they are not run in the main thread.
3.3.2.1 LINKINFO (RT Professional)
Declaration
typedef struct {
LINKTYPE LinkType;
DWORD dwCycle;
TCHAR szLinkName[256];
}
LINKINFO;
Members
LinkType
Values for enum LinkType defined in the "trigger.h" file should be used for the LINKTYPE type.
enum LinkType Currently defined value Link

BUBRT_LT_NOLINK 0 (defined start value) No link
BUBRT_LT_VARIABLE_DIRECT 1 (sequence) Direct tag
BUBRT_LT_VARIABLE_INDIRECT 2 (sequence) Indirect tag

enum LinkType Currently defined value Link

BUBRT_LT_ACTION 3 (sequence) C action
BUBRT_LT_ACTION_WIZARD 4 (sequence) Dynamic dialog
BUBRT_LT_DIRECT_CONNECTION 5 (sequence) Direct connection
BUBRT_LT_ACTION_WIZARD_INPROC 6 (sequence) Dynamic dialog
When PDLRTSetLink is used, only BUBRT_LT_VARIABLE_DIRECT and

BUBRT_LT_VARIABLE_INDIRECT may be used. All types of links can be used for
PDLRTGetLink.
Note
For subsequent extensions of the enum LinkType definition in trigger.h, new constants must
always be added at the end, otherwise the above listed values will be changed. Therefore, you
should always use the definition for enumerations and not the value.
dwCycle
Cycle time for updating. dwCycle identifies the order within the list of update cycles.

"250ms" Index: 1
: :
"Window cycle" Index: 235
"Screen cycle" Index: 255
szLinkName
Name of the tag connection
Required files
pdlrtapi.h
trigger.h
API functions
PDLRTGetLink (Page 1935) Query link between object property and tag
See also
PDLRTGetLink (Page 1935)
PDLRTSetLink (Page 1937)

3.3.2.2 MULTILINK (RT Professional)
Declaration
typedef struct {
DWORD wArraySize;
LPMULTILINKINFO pLinkArray;
}
MULTILINK;
Members
wArraySize
Number of links (number of structures of the MULTILINKINFO type).
pLinkArray
Pointer to the first wArraySize structure of the MULTILINKINFO (Page 1901) type with
information about the link between an object property and a tag.
Required files
pdlrtapi.h
API functions
See also
PDLRTSetMultiLink (Page 1939)
MULTILINKINFO (Page 1901)

3.3.2.3 MULTILINKINFO (RT Professional)
Declaration
typedef struct {
char* pszObjectName,
char* pszPropertyName,
LINKTYPE LinkType;
DWORD dwCycle;
char* pszLinkName;
}
MULTILINKINFO;
Members
IpszObjectName
Pointer to the name of the object.
IpszPropertyName
Pointer to the name of the object property to be linked.
LinkType
Identifies the type of connection.
LT_VARIABLE_DIRECT Connect object property and tag directly

LT_VARIABLE_INDIRECT Connect object property and tag indirectly
dwCycle
Cycle time for updating. dwCycle identifies the order within the list of update cycles.

"250ms" Index: 1
: :
pszLinkName
Pointer to name of the connection
Comments
The MULTILINKINFO structure is part of the MULTILINK (Page 1900) structure.
Required files
pdlrtapi.h

See also
MULTILINK (Page 1900)
3.3.2.4 FOCUSINFO (RT Professional)
Description
The screen object that has the runtime cursor is stored in the structure.
Declaration
typedef struct {
WCHAR szPicture[256];
WCHAR szObject[256];
}
FOCUSINFO;
Members
szPicture
Screen name
szObject
Object name
API functions
See also
PDLRTGetFocus (Page 1919)
3.3.3.1 PDLRTClosePicture (RT Professional)
Use
Closes a screen in runtime mode.

Declaration
BOOL PDLRTClosePicture(
ADRMODE adrMode,
LPCSTR lpszPictureName,
LPCSTR lpszWName,
PDLRT_CALLBACK pfn,
LPVOID pvUser,
PCMN_ERROR pError );
Parameters
adrMode
lpszPictureName
Pointer to the configured name of the screen, without path or extension.
The entry is case-sensitive.
lpszWName
Name of the window object to be closed.
pfn
Pointer to your callback function. This is called to notify you about the success or failure of the
request.
If pfn = NULL is passed, the call is synchronous. The calling application is set as waiting until
PDLRT reports failure or success. This type of call should be preferentially used for mutually
dependent call sequences.
If subsequent API calls require this function to be completed and this function is used
asynchronously with callback, the API calls should be synchronized with semaphores.
It makes sense to use a separate callback for each API function.
pvUser
Pointer to application-specific data that is passed to the callback function. This pointer is not
evaluated by the function but provided again in the callback function.
pError
Return value
TRUE
Screen closed.

FALSE
Error.
Required files
pdlrtapi.h
pdlrt_s.lib
pdlrtapi.dll
Related functions
PDLRT_CALLBACK (Page 1915) Callback function of the runtime functions
See also
PDLRT_CALLBACK (Page 1915)
3.3.3.2 PDLRTDisableClosePicture (RT Professional)
Use
Blocks a screen from being closed in runtime mode. The function can be called multiple times.
The screen can only be closed again when the same number of calls to the
PDLRTEnableClosePicture function have been made.
Declaration
BOOL PDLRTDisableClosePicture(
ADRMODE adrMode,
PDLRT_CALLBACK pfn,
LPVOID pvUser,
Parameters
adrMode
lpszPictureName

pfn
request.
pvUser
pError
Pointer to the data of the extended error message in the CMN_ERROR.structure. If an error
occurs, the system writes error information into this structure.
Return value
TRUE
Function successfully completed.
FALSE
Error.
Required files
pdlrtapi.h
pdlrt_s.lib
pdlrtapi.dll
Related functions
See also

3.3.3.3 PDLRTEnableClosePicture (RT Professional)
Use
Enables a screen to be closed in runtime mode.
The screen can only be closed, however, when the PDLRTEnableClosePicture function has
been called the same number of times as the PDLRTDisableClosePicture function.
Any PDLRTClosePicture made prior to this is noted and then performed later after the last
PDLRTEnableClosePicture.
Declaration
BOOL PDLRTEnableClosePicture(
ADRMODE adrMode,
PDLRT_CALLBACK pfn,
LPVOID pvUser,
Parameters
adrMode
lpszPictureName
pfn
request.
pvUser

pError
Return value
TRUE
FALSE
Error.
Required files
pdlrtapi.h
pdlrt_s.lib
pdlrtapi.dll
Related functions
See also
3.3.3.4 PDLRTGotoPicture (RT Professional)
Use
Loads the specified screen.
Declaration
BOOL PDLRTGotoPicture (
PDLRTGotoPict nextPict,

Parameters
nextPict
The function of this method is controlled with this parameter. The following values are possible:
PDLRTPictureHome Loads the start screen.

PDLRTPictureNext Loads the next screen in screen memory.
PDLRTPicturePrev Loads the previous screen in screen memory.
PDLRTPictureStored Loads the stored screen in screen memory.
PDLRTStorePicture Stores the current screen in screen memory.
pError
Return value
TRUE
Screen loaded.
FALSE
Error.
Error messages
PDLRT_NO_PIC Screen not selected
Required files
pdlrtapi.h
pdlrt_s.lib
pdlrtapi.dll
Related functions
PDLRTPictureNavigation Enable and disable screen navigation

(Page 1913)
See also
PDLRTPictureNavigation (Page 1913)

3.3.3.5 PDLRTInquireFreeArea (RT Professional)
Use
Determines whether a given rectangle can be placed on the screen without covering a
''protected area''. "Protected areas", for example, are other screens that are in the foreground.
Declaration
BOOL PDLRTInquireFreeArea(
LPRECT lpScreenRect,
DWORD dwModus,
PDLRT_CALLBACK pfn,
LPVOID pvUser,
Parameters
IpScreenRect
Pointer to a Windows-specific RECT type structure.
dwModus
Inquire mode: Several inquiry options are provided that can be ORed as desired:
PDLRT_IQ_ONLY (value: 0x01) Upon demand only with the result "matches / does
not match"
PDLRT_IQ_MODY_POSX (value: 0x02) If the given rectangle cannot be placed, the X position
of the rectangle can be modified so that it can be
placed.
PDLRT_IQ_MODY_POSY (value: 0x04) If the given rectangle cannot be placed, the Y position
of the rectangle can be modified so that it can be
placed.
PDLRT_IQ_MODY_HEIGHT (value: 0x08) If the given rectangle cannot be placed, the height of
the rectangle can be modified so that it can be placed.
PDLRT_IQ_MODY_WIDTH (value: 0x10) If the given rectangle cannot be placed, the width of
the rectangle can be modified so that it can be placed.
pfn
request.

pvUser
pError
Return value
TRUE
Window area is free.
FALSE
Error.
Required files
pdlrtapi.h
pdlrt_s.lib
pdlrtapi.dll
Related functions
See also
3.3.3.6 PDLRTOpenPicture (RT Professional)
Use
The function performs a start screen change in the runtime.

Declaration
BOOL PDLRTOpenPicture(
ADRMODE adrMode,
LPCSTR lpszWName,
LPCSTR lpszPictureFileName,
DWORD dwWinStyle,
LONG lxPos,
LONG lyPos,
LONG lWitdh,
LONG lHeight,
PDLRT_CALLBACK pfn,
LPVOID pvUser,
Parameters
adrMode
lpszWName
This parameter must be currently supplied with the screen name.
lpszPictureFileName
This parameter must be currently supplied with the screen name.
dwWinStyle
lxPos
lyPos
lWidth
lHeigth
pfn
request.

pvUser
pError
Return value
TRUE
Start screen change performed.
FALSE
Error.
Error messages
PDLRT_PICTURE_ALREADY_OPEN Screen is already open

PDLRT_BAD_OLE_CONVERSION Error in conversion through OLE automation
Required files
pdlrtapi.h
pdlrt_s.lib
pdlrtapi.dll
Related functions
See also

3.3.3.7 PDLRTPictureNavigation (RT Professional)
Use
Switches the screen navigation on and off. When switched off, no more screens are added to
the stack with a screen change; the old state is frozen.
Declaration
BOOL PDLRTPictureNavigation (
PDLRT_PNFLAGS flags,
Parameters
flags
The function is controlled with this parameter. The following values are possible:
PDLRT_PNF_ENABLE Switches the screen navigation on.

PDLRT_PNF_DISABLE Switches the screen navigation off.
PDLRT_PNF_ENABLE_LOAD_LAST_PICTURE Switches the screen navigation on and loads the
last screen in the screen memory.
pError
Return value
TRUE
FALSE
Error.
Cause: Screen navigation was already switched on or off.
Required files
pdlrtapi.h
pdlrt_s.lib
pdlrtapi.dll

Related functions
PDLRTGotoPicture (Page 1907) Load specified screen
See also
PDLRTGotoPicture (Page 1907)
3.3.3.8 PDLRTShowApp (RT Professional)
Use
This function brings a runtime window that may be in the background to the foreground of the
desktop.
Declaration
BOOL PDLRTShowApp (
PDLRT_CALLBACK pfn,
LPVOID pvUser,
Parameters
pfn
request.
pvUser
pError

Return value
TRUE
Runtime window in foreground.
FALSE
Error.
Required files
pdlrtapi.h
pdlrt_s.lib
pdlrtapi.dll
Related functions
PDLRT_CALLBACK (Page 1915) Callback function
See also
3.3.3.9 PDLRT_CALLBACK (RT Professional)
Description
If your application is to be informed asynchronously about the execution of API functions in
runtime, you must provide callback functions of the PDLRT_CALLBACK type.
This function is used by all of the PDLRT functions as a callback function.
Declaration
void ( * PDLRT_CALLBACK ) (
LPVOID pvUser,
Parameters
pvUser
Pointer to application-specific data. This pointer is made available as a parameter of the API
function and returned again here unchanged.

pError
Return value
This callback has no return value.
Comments
If the API function is called without callback, i.e. with pfn = NULL, the call is synchronous. The
calling application is set as waiting until PDLRT reports failure or success. This type of call
should be preferentially used for mutually dependent call sequences.
asynchronously with callback, the API calls should be synchronized with semaphores. Without
synchronization, there is also the risk that the asynchronous function will continue to write data
via that data pointer that is no longer valid, when the calling process has already finished or
left the range of validity, which will lead to exception handling.
Note
In rare cases, the callback may already be delivered before the function call has returned.
Required files
pdlrtapi.h
See also
PDLRTClosePicture (Page 1902)
PDLRTDisableClosePicture (Page 1904)
PDLRTEnableClosePicture (Page 1906)
PDLRTInquireFreeArea (Page 1909)
PDLRTOpenPicture (Page 1910)
PDLRTShowApp (Page 1914)


PDLRTSetPropEx (Page 1930)
PDLRTGetPropEx (Page 1927)
PDLRTGetDefPropEx (Page 1925)
PDLRTSetFocus (Page 1923)
PDLRTSetCursorKeys (Page 1921)
PDLRTGetCursorKeys (Page 1917)
3.3.4 Functions for affecting the runtime cursor (RT Professional)
3.3.4.1 PDLRTGetCursorKeys (RT Professional)
Use
This function queries the keys for cursor control that have been set with PDLRTSetCursorKeys.
Declaration
BOOL PDLRTGetCursorKeys (
long* pKeyUp,
long* pKeyDown,
long* pKeyLeft,
long* pKeyRight,
long* pKeyState,
long* pTabMode,
PDLRT_CALLBACK pfn,
LPVOID pvUser,
Parameters
KeyUp
This pointer provides the virtual key code (VK_...) of the key that moves the cursor down.
pKeyDown
This pointer provides the virtual key code (VK_...) of the key that moves the cursor up.
pKeyLeft
This pointer provides the virtual key code (VK_...) of the key that moves the cursor to the left.

pKeyRight
This pointer provides the virtual key code (VK_...) of the key that moves the cursor to the right.
pKeyState
This pointer provides the keyboard status:
HOTKEYF_SHIFT (value: 0x01) "SHIFT" key pressed

HOTKEYF_CONTROL (value: 0x02) "CTRL" key pressed
HOTKEYF_ALT (value: 0x04) "ALT" key pressed
The values can be ORed as desired.
pTabMode
This pointer provides the TabMode, the object that gets the focus with the next activation of a
cursor control key:
O: xxScreenxx
1: xxScreenxx
10: xxScreenxx
xxScreenxx
pfn
request.
pvUser
pError
Return value
TRUE
Cursor control keys determined.
FALSE
Error.

Required files
pdlrtapi.h
pdlrt_s.lib
pdlrtapi.dll
Related functions
PDLRTSetCursorKeys (Page 1921) Set cursor control keys

See also
PDLRTSetCursorKeys (Page 1921)
3.3.4.2 PDLRTGetFocus (RT Professional)
Use
The function returns the screen and the object name of the object that has the input focus.
Declaration
BOOL PDLRTGetFocus(
ADRMODE adrMode,
LPFOCUSINFO pFocusInfo,
PDLRT_CALLBACK pfn,
LPVOID pvUser,
Parameters
adrMode
The adrMode parameter is used to set the addressing mode of the screen to be edited.
PDLRT_AM_DEFAULT o The addressing of screen and object is relative

The PDLRT_AM_PICTABS and PDLRT_AM_OBJABS value can be ORed.

pFocusInfo
Pointer to the FOCUSINFO (Page 1902) structure in which the results are stored.
pfn
request.
pvUser
pError
Return value
TRUE
Input focus determined.
FALSE
Error.
Required files
pdlrtapi.h
pdlrt_s.lib
pdlrtapi.dll
Related functions
PDLRTSetFocus (Page 1923) Set input focus

See also
FOCUSINFO (Page 1902)
PDLRTSetFocus (Page 1923)


3.3.4.3 PDLRTSetCursorKeys (RT Professional)
Use
This function keys sets for the keys for cursor control.
Declaration
BOOL PDLRTSetCursorKeys (
long KeyUp,
long KeyDown,
long KeyLeft,
long KeyRight,
long KeyState,
long TabMode,
PDLRT_CALLBACK pfn,
LPVOID pvUser,
Parameters
KeyUp
Virtual key code (VK_...) of the key that moves the cursor down.
KeyDown
Virtual key code (VK_...) of the key that moves the cursor up.
KeyLeft
Virtual key code (VK_...) of the key that moves the cursor to the left.
KeyRight
Virtual key code (VK_...) of the key that moves the cursor to the right.
KeyState
KeyState provides the keyboard status:
HOTKEYF_SHIFT (value: 0x01) "SHIFT" key pressed

HOTKEYF_CONTROL (value: 0x02) "CTRL" key pressed
HOTKEYF_ALT (value: 0x04) "ALT" key pressed
The values can be ORed as desired.

TabMode
TabMode specifies the object that gets the focus with the next activation of a cursor control
key:
0: xxScreenxx
1: xxScreenxx
10: xxScreenxx
xxScreenxx
pfn
request.
pvUser
pError
Return value
TRUE
Cursor control keys defined.
FALSE
Error.
Required files
pdlrtapi.h
pdlrt_s.lib
pdlrtapi.dll

Related functions
PDLRTGetCursorKeys (Page 1917) Query cursor control keys

See also
PDLRTGetCursorKeys (Page 1917)
3.3.4.4 PDLRTSetFocus (RT Professional)
Use
The function is used to set the input focus. The object is determined by lpszPictureName and
lpszObjectName.
Declaration
BOOL PDLRTSetFocus (
ADRMODE adrMode,
LPCSTR lpszObjectName,
PDLRT_CALLBACK pfn,
LPVOID pvUser,
Parameters
adrMode

IpszPictureName
Pointer to the configured name of the screen according to addressing mode defined by
adrMode without extension. The entry is case-sensitive.
lpszObjectName
Pointer to the configured object name according to addressing mode defined by adrMode.

pfn
request.
pvUser
pError
Return value
TRUE
Input focus set
FALSE
Error
Error messages

PDLRT_NO_OBJ Cannot find object
Required files
pdlrtapi.h
pdlrt_s.lib
pdlrtapi.dll
Related functions


See also
3.3.5 Functions for processing object properties (RT Professional)
3.3.5.1 PDLRTGetDefPropEx (RT Professional)
Use
Request a default property value. If the requested data type does not match the data type of
the property, the value is changed during the transfer into the pvProp user buffer in accordance
with the requested format, if this is possible.
Declaration
BOOL PDLRTGetDefPropEx(
ADRMODE adrMode,
LPCSTR lpszPropName,
VARTYPE vt,
LPVOID pvProp,
PDLRT_CALLBACK pfn,
LPVOID pvUser,
DWORD dwFlags,
LPVOID pData,
Parameters
adrMode

lpszPictureName
adrMode. The entry is case-sensitive.

lpszObjectName
Pointer to the configured object name according to addressing mode defined by via adrMode .
lpszPropName
Pointer on the configured name of the object property.
vt
Data type of a value passed under pvProp. The allowed types are defined in the include oaidl.h"
and "wtypes.h" files of the compiler. You can use the WinCC include file, APLIB\Defines.h ,
for scripts.
pvProp
Pointer to a tag in which the property value is stored. The data type of the value is determined
by vt:
vt pvProp
VT_BSTR BSTR*
VT_LPSTR LPSTR*
VT_LPWSTR LPWSTR*
VT_UI4 LONG*
VT_xxxx pvProp must point to a buffer
For types with a buffer (for example, BSTR), the buffer is allocated by the function and must
be released again by the calling application.
pfn
request.
pvUser
dwFlags
pData

pError
Return value
TRUE
Default values of the object property determined.
FALSE
Error.
Comments
To release allocated memory areas, use the VT_BSTR Windows API function for
SysFreeString(...) and the VT_LPSTR Windows API function for VT_LPWSTR , LocalFree(...).
Error messages
PDLRT_NO_PROP Cannot find property

Required files
pdlrtapi.h
pdlrt_s.lib
pdlrtapi.dll
Related functions
See also
3.3.5.2 PDLRTGetPropEx (RT Professional)
Use
Request a current property value. The source is determined by lpszPictureName,
lpszObjectName and lpszPropName.

If the requested data type does not match the data type of the property, the value is changed
during the transfer into the pvProp user buffer in accordance with the requested format, if this
is possible.
Declaration
BOOL PDLRTGetPropEx(
ADRMODE adrMode,
VARTYPE vt,
LPVOID pvProp,
PDLRT_CALLBACK pfn,
LPVOID pvUser,
DWORD dwFlags,
LPVOID pData,
Parameters
adrMode

lpszPictureName
lpszObjectName
Pointer to the configured name of the object according to addressing mode defined by adrMode.
lpszPropName
vt
for scripts.

pvProp
Pointer to a tag in which the property value is stored. The data type of the value is determined
by vt:
vt pvProp
VT_BSTR BSTR*
VT_LPSTR LPSTR*
VT_LPWSTR LPWSTR*
VT_UI4 LONG*
For types with a buffer (for example, BSTR), the buffer is allocated by the function and must
be released again by the calling application.
pfn
request.
pvUser
dwFlags
pData
pError
Return value
TRUE
Object properties determined.
FALSE
Error.

Comments
To release allocated memory areas, use the, use the SysFreeString(...) Windows API function
for VT_BSTR and the LocalFree(...) Windows API function for VT_LPSTR, VT_LPWSTR .
No VT_DISPATCH or other reference may be used; only the normal types and a VT_VARIANT
at the most for an array property of a simple type.
Error messages

Required files
pdlrtapi.h
pdlrt_s.lib
pdlrtapi.dll
Related functions
PDLRTSetPropEx (Page 1930) Set property

See also
PDLRTSetPropEx (Page 1930)
3.3.5.3 PDLRTSetPropEx (RT Professional)
Use
Set a property. The target is determined by lpszPictureName, lpszObjectName and
lpszPropName. When the passed data type does not match the data type of the property, the
value is changed during the transfer to the property, if this is possible.
Only those properties that can also be made dynamic can be set.

Declaration
BOOL PDLRTSetPropEx(
ADRMODE adrMode,
VARTYPE vt,
LPVOID pvProp,
PDLRT_CALLBACK pfn,
LPVOID pvUser,
DWORD dwFlags,
LPVOID pData,
Parameters
adrMode

lpszPictureName
lpszObjectName
lpszPropName
vt
for scripts.
pvProp
Pointer to a buffer in which the property value is stored. The data type of the value is determined
by vt:
vt pvProp
VT_BSTR BSTR*
VT_LPSTR LPSTR*

VT_LPWSTR LPWSTR*
VT_UI4 LONG*
pfn
request.
pvUser
evaluated by the function, but is made available again in the callback function.
dwFlags
pData
The parameter is reserved for future development and must be preset to ZERO.
pError
Return value
TRUE
Object properties set.
FALSE
Error.
Comments
No VT_DISPATCH or other reference may be used; only the normal types and a VT_VARIANT
at the most for an array property of a simple type.
Error messages

PDLRT_PICTURE_NOT_LOADED Cannot load screen file

PDLRT_FAILURE_PARAM Wrong parameter

Required files
pdlrtapi.h
pdlrt_s.lib
pdlrtapi.dll
Related functions
PDLRTGetPropEx (Page 1927) Query property


Example
#pragma code("pdlrtapi.dll")
#define CP_ACP 0
#define MB_PRECOMPOSED 1
void ButtonRT(char* text)

{
DM_DIRECTORY_INFO dirInfo;
CMN_ERROR error;
BOOL bRet;
char szProjectFile[222] = "";
WCHAR wstring[99];
BSTR bstrval;
WORD *pw = NULL;
int i;
printf("Function ButtonRT() with text '%s'\r\n", text);
bRet = DMGetRuntimeProject
(&szProjectFile[0],sizeof(szProjectFile),&error);
printf("DMGetRuntimeProject: %s\r\n", szProjectFile);
bRet = PDLRTOpenPicture(0,"Start.PDL",NULL,NULL,0,0,0,0,0,NULL,NULL,
&error);
printf("PDLRTOpenPicture: %s,%ld, %s\r\n", bRet?"TRUE":"FALSE",
error.dwError1,error.szErrorText);
bRet = PDLRTSetPropEx(0,"Start.PDL", "Button4", "Text",VT_LPSTR,

&text,NULL,NULL,0, NULL, &error);
printf("PDLRTSetPropEx: %s,%ld, %s\r\n", bRet?"TRUE":"FALSE",
error.dwError1,error.szErrorText);
SysFreeString( bstrval );
printf("SysFreeString done\r\n");
}
See also
PDLRTGetPropEx (Page 1927)

3.3.6 Functions for processing dynamics (RT Professional)
3.3.6.1 PDLRTGetLink (RT Professional)
Use
Query a link from a property. If the property has an indirect tag connection, this is returned. If
the current active direct connection is desired for an indirect tag connection, this can be
requested by specifying
LinkType = BUBRT_LT_VARIABLE_DIRECT in the LINKINFO structure.
Declaration
BOOL PDLRTGetLink (
ADRMODE adrMode,
LPLINKINFO pLink,
PDLRT_CALLBACK pfn,
LPVOID pvUser,
Parameters
adrMode

lpszPictureName
lpszObjectName
lpszPropName
Pointer on the name of the object property.
pLink
Pointer to the LINKINFO (Page 1898) structure in which the link information is stored.

pfn
request.
pvUser
pError
Return value
TRUE
Link determined.
FALSE
Error.
Error messages
PDLRT_NO_LINK Property has no dynamics
Required files
pdlrtapi.h
pdlrt_s.lib
pdlrtapi.dll
Related functions

See also
LINKINFO (Page 1898)
3.3.6.2 PDLRTSetLink (RT Professional)
Use
Set a link between a property and a tag.
Declaration
BOOL PDLRTSetLink (
ADRMODE adrMode,
LPLINKINFO pLink,
PDLRT_CALLBACK pfn,
LPVOID pvUser,
Parameters
adrMode

lpszPictureName
lpszObjectName
lpszPropName
Pointer on the name of the object property.

pLink
Pointer to the LINKINFO (Page 1898) structure in which the link information is stored.
Only BUBRT_LT_VARIABLE_DIRECT and BUBRT_LT_VARIABLE_INDIRECT can be used
in LinkType, since only a link with tags is allowed here.
pfn
request.
pvUser
pError
Return value
TRUE
Link set
FALSE
Error
Error messages

PDLRT_LINK_NOT_SET Cannot link property
Required files
pdlrtapi.h
pdlrt_s.lib
pdlrtapi.dll

Related functions
PDLRTGetLink (Page 1935) Determine link between object property and tag
See also
LINKINFO (Page 1898)
3.3.6.3 PDLRTSetMultiLink (RT Professional)
Use
Set multiple links between a property and a tag.
Declaration
BOOL PDLRTSetMultiLink (
ADRMODE adrMode,
LPMULTILINK pMultiLink,
PDLRT_CALLBACK pfn,
LPVOID pvUser,
Parameters
adrMode

lpszPictureName

pMultiLink
Pointer to the MULTILINK (Page 1900) structure in which a field with link information is stored.
pfn
request.
pvUser
Return value
TRUE
The TRUE return value is only returned if all links were successfully set. Even if only one link
could not be set, FALSE is returned.
FALSE
Error.
Error messages

PDLRT_LINK_NOT_SET Cannot link property
Required files
pdlrtapi.h
pdlrt_s.lib
pdlrtapi.dll
Related functions

3.4 Scripting functions (RT Professional)
See also
MULTILINK (Page 1900)
Overview
AP_RT_PROC (Page 1956) Notification of runtime functions

APActive (Page 1968) Activate action
APCompile (Page 1959) Compile source code
APCompileEx (Page 1961) Compile source code
APConnect (Page 1951) Logon application
APDisconnect (Page 1953) Logoff application
APEndAct (Page 1970) Logon action in the application control
APFreeResultStruct (Page 1971) Free action result memory
APInactive (Page 1972) Deactivate actions
APSetLanguage (Page 1955) Set language for error texts
APStart (Page 1974) Start action
APTransact (Page 1977) Logon actions for processing
GSCGenCompile (Page 1964) Compile action
GSCGenCompileUserFunctions Compile user functions
(Page 1965)
GSCGenGetActionStream Determine action stream
(Page 1967)
Overview
AP_ACT_KEY (Page 1946) Action identification

AP_ACT_RESULT_STRUCT (Page 1948) Action result

CREATE_USER_HEADER_FILE (Page 1949) Create header file of user functions

GENERATE_COMPILE (Page 1950) Generate action
GET_ACTION_STREAM (Page 1950) Determine action stream
Overview
structure:
General error messages
AP_ALREADY_CONNECTED 2 Application is already connected to the action con‐

trol
AP_NO_CONNECTION 3 Application cannot establish a connection to the
action control.
AP_ERROR_IPC_SEND 4 Error in communication with the action control. The
job could not be sent.
AP_FAILURE_UNKNOWN 5 Error not described in detail
AP_FAILURE_PARAM 6 Incorrect parameter assignment
AP_NO_ACT_PROGRAM 7 Action control could not be started
AP_TIMEOUT 8 Timeout, not yet implemented at present.
AP_ACT_QUIT 9 Action control has ended
AP_INSTALL_SERV_ERROR 10 Service channel could not be installed
AP_ENDACT_UNKNOWN_ORDER 11 An unknown job number was used for EndAct
AP_ACTION_FAILED 12 An action could not be executed without error. The
return results are invalid.
AP_FAILURE_IN_SERVER 13 Server is signaling an error.
AP_TO_MANY_CLIENTS 14 The maximum number of connections is reached.
No new connections possible.
AP_TRANSACTID_UNKNOWN 15 Invalid transaction ID. Error occurs when calling
AP_EndAct if an attempt is made to end a transac‐
tion that was not logged on beforehand.
AP_NO_MEMORY 16 There is no longer enough memory available for
this operation
AP_TRANSACT_ERROR 17 An error occurred within the transaction; action-re‐
lated error in dwerror of AP_ACT_KEY
AP_RESULT_TRANS_ERROR 18 Error occurred in the results.
AP_RESULT_START_ERROR 19 Error occurred in the results.
AP_NO_UPDATE_WRONG_FORMAT 50 Update option not available for the data format. Ac‐
tion contains no interpreter code.
AP_ERR_WRONG_FORMAT 202 Data format of action is incorrect.
AP_NO_VALID_FUNCTION_VALUE 203 Function return value cannot be converted to VAR‐
IANT data type.

Errors
Errors that may occur when performing an action
AP_CISS_ERR_EXIT_OVERFLOW 1001 A stack overflow occurred in the action interpreter

during execution. Further execution of action is
cancelled.
AP_CISS_ERR_EXIT_DIVIDE0 1002 Division by 0 occurred while executing an action.
Canceling action.
AP_CISS_ERR_EXIT_UNRESOLVED 1003 While executing the action, a symbol was refer‐
enced that does not exist.
AP_CISS_ERR_EXIT_GPF 1004 While executing the action, memory was accessed
that is not defined.
AP_CISS_ERR_EXIT_BREAKPOINT 1005 The action interpreter stopped due to a breakpoint.
AP_CISS_ERR_EXIT_STEP 1006 The action interpreter was resumed in the next pro‐
cessing step.
Alarms
Alarms of the action interpreter
AP_CISS_ERR_CREATE_PCH_FROM_PCH 8001 A precompiled header file cannot be

generated from a precompiled head‐
er file.
AP_CISS_ERR_MODULE_IN_USE 8002 The action cannot be accessed.
Module is currently in use.
AP_CISS_ERR_INVALID_PROGRAM 8003 The program is invalid.
AP_CISS_ERR_INVALID_MODULE 8004 The action is invalid.
AP_CISS_ERR_CANNOT_CREATE_FILE 8005 File could not be created by the ac‐
tion control.
AP_CISS_ERR_CANNOT_NO_MEMORY 8006 The action interpreter no longer has
enough memory.
AP_CISS_ERR_INVALID_FILE_FORMAT 8007 File format is invalid for the action
control.
AP_CISS_ERR_CANNOT_OPEN_FILE 8008 File could not be opened by the ac‐
tion control.
AP_CISS_ERR_PROGRAM_IS_LOCKED 8009 Program is locked by the action con‐
trol at present.
AP_CISS_ERR_MODULE_ALREADY_INSERTED 8010 Action was already provided to the
action control for processing.
AP_CISS_ERR_CONFLICT_WITH_OTHER 8011 During the action, a conflict occurred
with another action.
AP_CISS_ERR_MODULE_NOT_FOUND 8013 Action was not found by the action
control.
AP_CISS_ERR_FUNCTION_NOT_FOUND 8014 Function was not found by the action
control.
AP_CISS_ERR_INVALID_LINE 8015 Specified line information is invalid.
AP_CISS_ERR_INVALID_SCOPE 8016 Specified symbol is outside the valid
range.

AP_CISS_ERR_BUFFER_TOO_SMALL 8017 Transferred memory is too small for

the action interpreter.
AP_CISS_ERR_INVALID_TYPE 8018 The specified type is unknown to the
action interpreter.
AP_CISS_ERR_SYMBOL_NOT_FOUND 8019 The specified symbol was not found.
Notify codes
AP_NOTIFY_ERROR 0 An error occurred while performing the function.

AP_NOTIFY_DATA 1 No error occurred while performing the function.
AP_NOTIFY_CODE_TRANSACT 1 Confirmation of an AP_TransAct call
AP_NOTIFY_CODE_START 2 Confirmation of an AP_Start call
AP_NOTIFY_CODE_RESULT 3 Result of an action
AP_NOTIFY_CODE_DISCONNECT 6 Confirmation of an APDisconnect call
AP_NOTIFY_CODE_ENDACT 7 Confirmation of an AP_EndAct call
AP_NOTIFY_CODE_ACTIVE 8 Confirmation of an AP_Active call
AP_NOTIFY_CODE_INACTIVE 9 Confirmation of an AP_Inactive call
AP_NOTIFY_ERROR_SERVER_QUITT 10 Notification that the action control has been closed.
AP_NOTIFY_CODE_TRANSRESULT 11 Notification of an erroneous result. Call of an AP‐
TransAct
AP_NOTIFY_CODE_STARTRESULT 12 Notification of an erroneous result. Call of an AP‐
Start.
AP_NOTIFY_CODE_RESULT_RT 13 Notification of cyclic results of an optimized call
Function/Action IDs
GSC_AP_SFCT 0x00000011 Standard function

GSC_AP_PFCT 0x00000012 Project function
GSC_AP_GSC 0x00000014 GSC action
Limit values
AP_MAX_TRIG_NAME 21 Maximum length of the name of a trigger
Header types
CMHF_APDEFAP 0x00000001 Header of a project definition

CMHF_AP_PBIB 0x00000002 Header of a project function
CMHF_AP_GLOB 0x00000004 Header of a standard function
CMHF_AP_ICF 0x00000008 Header of an internal function

CMHF_AP_ALL CMHF_APDEFAP |
CMHF_AP_PBIB |
CMHF_AP_GLOB |
CMHF_AP_ICF
CMHF_AP_USER 0x00000010 Header of a user function
Trigger types
AP_TRIG_UNDEFINED 0 Trigger is not yet initialized.

AP_TRIG_VAR 1 Trigger is a tag.
AP_TRIG_TIMER 2 Trigger is a timer.
AP_TRIG_UNKNOWN 3 Trigger is unknown.
AP_TRIG_TRANSACT 4 Trigger is specified via a TransAct call.
Cycle types
AP_TRIG_CYCLE 1 Cyclic
AP_TRIG_NCYCLE 2 Acyclic
Cycle times
AP_TRIG_CYCLE_01 1 Reflects cycle time of 250 ms in the Control Center

AP_TRIG_CYCLE_02 2 Reflects cycle time of 500 ms in the Control Center
AP_TRIG_CYCLE_03 3 Reflects cycle time of 1 s in the Control Center
AP_TRIG_CYCLE_05 5 Reflects cycle time of s in the Control Center
AP_TRIG_CYCLE_07 7 Reflects cycle time of 1 min in the Control Center
AP_TRIG_CYCLE_10 10 Reflects cycle time of 1 h in the Control Center
AP_TRIG_CYCLE_11 11 Reflects cycle time of "User defined 1" in the Control Center

3.4.2.1 AP_ACT_KEY (RT Professional)
Declaration
typedef struct {
DWORD dwKeyType;
DWORD dwID;
CHAR szActionName[AP_MAX_ACTION_NAME + 1];
DWORD dwCycle;
VARIANT *pVariant;
DWORD dwVariantItem;
DWORD dwerror;
LPVOID lpvUser;
} AP_ACT_KEY ;
Members
dwKeyType
The key type determines whether the action is addressed by a name (szActionName) or by
an ID (dwID).
AP_ID_TYPE 0 Identification of the action by its ID

AP_NAME_TYPE 1 Identification of the action by its name
Project and standard functions which already exist in in the WinCC project are identified by
the name. User-defined functions that are first logged on with the APTransAct function are
identified by the ID.
dwID
In connection with dwKeyType = AP_ID_TYPE the action is started with dwID.
The ID of the action is assigned on calling the APTransAct function. On calling the APTransAct
function, dwID must be defaulted with 0.
szActionName
In connection with dwKeyType = AP_NAME_TYPE the action is started by szActionName.
Can be used when starting an action with APStart.
dwCycle
Cyclic starting of the action when addressing is by name. The upgrade cycle is defined by the
index of the entries in the list of update cycles.

pVariant
Pointer to field of VARIANT data type which describes the parameters of the action. The
following data types are supported as VARTYPES:
unsigned char VT_UI1

unsigned integer 2 Bytes VT_UI2 (WORD)
unsigned integer 4 Bytes VT_UI4 (DWORD)
short VT_I2
long VT_I4
float VT_R4
double VT_R8
VARIANT_BOOL VT_BOOL
SCODE VT_ERROR
CY VT_CY
DATE VT_DATE
BSTR VT_BSTR
BLOB VT_BLOB
The parameter descriptions of the actions and the return result are only possible in the form
of the VARIANT data type.
Transfer as a reference is not permitted.
dwVariantItem
Number of VARIANT data types which the action receives as parameters.
dwerror
Error number which can occur in the APTransAct.
lpvUser
Description
The AP_ACT_KEY structure clearly identifies the action. This key is assigned as an ID with
the API call APTransAct. The action is started with this key.
Required files
ap_def.h
API functions



See also
APActive (Page 1968)
APInactive (Page 1972)
APStart (Page 1974)
APTransact (Page 1977)
3.4.2.2 AP_ACT_RESULT_STRUCT (RT Professional)
Declaration
typedef struct {
VARIANT *ap_result;
AP_ACT_KEY apActKey;
CMN_ERROR error;
DWORD dwreserved;
} AP_ACT_RESULT_STRUCT ;
Members
*ap_result
Return result of the action in the form of a VARIANT data type.
apActKey
Key of the action for identification. The AP_ACT_KEY corresponds to the key with which the
action was started.
error
dwreserved
Required files
ap_def.h

API functions
APFreeResultStruct (Page 1971) Free action result memory

See also
APFreeResultStruct (Page 1971)
APStart (Page 1974)
3.4.2.3 CREATE_USER_HEADER_FILE (RT Professional)
Declaration
typedef struct {
char* pszStartDir;
char* pszHeaderFileName;
BOOL bShowDlg;
char* pszWindowText;
} CREATE_USER_HEADER_FILE ;
Members
pszStartDir
Pointer to the start directory at which the search for user functions begins with terminating "\"
pszHeaderFileName
Pointer to the name of the header file
bShowDlg
Show dialog with progress display
pszWindowText
Pointer to the dialog label.Default:BROWSER
Required files
capigsc.h
API functions
GSCGenCompileUserFunctions (Page 1965) Compile user functions

See also
GSCGenCompileUserFunctions (Page 1965)
3.4.2.4 GENERATE_COMPILE (RT Professional)
Declaration
typedef struct {
char* pszProjectName;
LPACTION pAction;
} GENERATE_COMPILE ;
Members
pszProjectName
Pointer to the project name
pAction
Pointer to valid action stream with source code
Required files
capigsc.h
Related functions
GSCGenCompile (Page 1964) Compile action
See also
GSCGenCompile (Page 1964)
3.4.2.5 GET_ACTION_STREAM (RT Professional)
Declaration
typedef struct {
char* pszPathName;
DWORD dwType;
} GET_ACTION_STREAM, *LPGET_ACTION_STREAM ;

Members
pszPathName
Full filename of the function or action
dwType
Permissible types:
GSC_AP_SFCT Default function

GSC_AP_PFCT Project function
GSC_AP_GSC Action
Required files
capigsc.h
API functions
GSCGenGetActionStream (Page 1967) Determine action stream
See also
GSCGenGetActionStream (Page 1967)
3.4.3.1 APConnect (RT Professional)
Description
The function logs on in an application in the action control. If a callback function is specified
in fpAppBack, the function is performed asynchronously, in fpAppBack == NULL action is
carried out synchronously.
Declaration
BOOL APConnect (
LPCSTR lpszAppName,
AP_RT_PROC fpAppBack,
PDWORD pdwOrderId,
LPCVOID lpvUser,
PCMN_ERROR pError )

Parameters
lpszAppName
Name of the application with which the application logged onto DMConnect. A DMConnect is
therefore necessary first. APConnect is only performed synchronously.
If functions of the script programming are called in actions, the "AktSteu" value (note exact
way of writing) must be specified for lpszAppName because the WinCC task has performed
the DMConnect with this name.
fpAppBack
Your callback function which receives messages. The message that the action control has
ended is reported by this function for example.
If a program logs on a Notify routine, it must empty a message queue regularly. Unread
pdwOrderId
Job number which is assigned when calling the APTransAct function. In synchronous calling
pdwOrderID is not important, in an asynchronous job the job number is supplied in the callback
function.
lpvUser
If lpvUser is not used, it must be assigned with NULL.
pError
Return value
TRUE
Application logged on
FALSE
Error
Error messages
AP_NO_ERROR No error occurred

AP_NO_CONNECTION Application cannot establish a connection with the action control.
AP_ERROR_IPC_SEND Error in communication with the action control. The job could not
be sent.
AP_TIMEOUT Time-out not implemented yet at present.
AP_ALREADY_CONNECTED Application is already connected with the action control

AP_FAILURE_PARAM Faulty parameter supply

AP_TO_MANY_CLIENTS The maximum number of connections is reached. No new con‐
nections possible.
AP_FAILURE_UNKNOWN Error not described in detail
AP_ACT_QUIT Action control has ended
Required files
ap_def.h
apcli_S.lib
apclient.dll
Related functions
DMConnect (Page 1630) Set up connection to the data manager

APDisconnect (Page 1953) Disconnect connection to action control
APTransact (Page 1977) Logon action for processing
AP_RT_PROC (Page 1956) Callback function
Examples
Establish connection to script programming (Page 1979) "AP01.cpp"
See also
AP_RT_PROC (Page 1956)
APDisconnect (Page 1953)
Establish connection to script programming (Page 1979)
3.4.3.2 APDisconnect (RT Professional)
Description
The function logs off an application in the action control.

Declaration
BOOL APDisconnect (
PDWORD pdwOrderId,
LPCVOID lpvUser,
PCMN_ERROR pError )
Parameters
fpAppBack
Your callback function which receives messages. The job is performed asynchronously when
using a callback function. With fpAppBack == NULL it takes place synchronously.
If a program logs on a Notify routine, it must empty a message queue regularly. Unread
pdwOrderId
function.
lpvUser
pError
Return value
TRUE
Application logged off
FALSE
Error
Comment
Note
The call must not be used in the destructor of an application (EXE, DLL, OCX, etc.). This may
lead to jamming of the call and thus the program due to Microsoft-specific mechanisms.

Error messages
AP_NO_ERROR No error occurred

AP_NO_CONNECTION Application cannot establish a connection with the action control.
AP_ERROR_IPC_SEND Error in communication with the action control. The job could not
be sent.
AP_TIMEOUT Time-out not implemented yet at present.
AP_ALREADY_CONNECTED Application is already connected with the action control
AP_FAILURE_PARAM Faulty parameter supply
AP_TO_MANY_CLIENTS The maximum number of connections is reached. No new con‐
nections possible.
AP_FAILURE_UNKNOWN Error not described in detail
AP_ACT_QUIT Action control has ended
Required files
ap_def.h
apcli_S.lib
apclient.dll
Related functions
APConnect (Page 1951) Set up connection to action control

Examples
See also
3.4.3.3 APSetLanguage (RT Professional)
Description
The language in which the error texts are to be output is set with this function.

Declaration
BOOL APSetLanguage (
const DWORD dwLanguageID )
Parameters
dwLanguageID
ID of the language according to the Windows language setting. The error texts are returned
according to the new set language. A default language is used if the language is not supported.
Return value
TRUE
Language of the error texts changed
FALSE
Error
Required files
ap_def.h
apcli_S.lib
apclient.dll
See also
3.4.3.4 AP_RT_PROC (RT Professional)
Description
If your application is to be informed asynchronously about the execution of API functions in
runtime, you must provide callback functions of the AP_RT_PROC type.
This function is used by all functions of the action programming as a callback function.

Declaration
BOOL ( * AP_RT_PROC) (
DWORD dwAP_Notify,
WORD dwAP_NotifyCode,
DWORD dwError,
LPVOID lpvData,
DWORD dwItems,
DWORD dwOrderId,
LPVOID lpvUser );
Parameters
dwAP_Notify
Describes the type of callback function. Possible values are AP_NOTIFY_ERROR and
AP_NOTIFY_DATA.
dwAP_NotifyCode
If dwAP_Notify == AP_NOTIFY_ERROR, lpvData points to a structure of the CMN_ERROR
type with the error description and dwAP_NotifyCode is NULL.
If dwAP_Notify == AP_NOTIFY_DATA, then dwAP_NotifyCode contains a more exact
specification of the callback function:
AP_NOTIFY_CODE_TRANSACT Confirmation of a call by APTransAct

AP_NOTIFY_CODE_START Confirmation of a call by APStart
AP_NOTIFY_CODE_RESULT Result of an action
dwError
Error number
lpvData
Pointer to provided data. The data structure depends on dwAP_Notify and dwAP_NotifyCode.
dwItems
Number of entries in lpvData.
dwOrderId
Job number which was assigned when calling the API function.

lpvUser
Return value
TRUE
Function successful
FALSE
Error
Comment
Note
In rare cases, the callback may already be delivered before the function call has returned.
Required files
ap_def.h
Related functions

APConnect (Page 1951) Logon application
APDisconnect (Page 1953) Logoff application
APEndAct (Page 1970) Logon action in the application control
Examples

See also
APEndAct (Page 1970)
APStart (Page 1974)
3.4.4 Functions for processing Source Code (RT Professional)
3.4.4.1 APCompile (RT Professional)
Description
A source code saved in lpvScode is compiled and saved as a P-code in lpvPcode. The
application must provide the memory for the P-code.
Declaration
BOOL APCompile (
LPCSTR szProjectName,
PDWORD pdwOrderId,
LPCSTR lpvScode,
const DWORD dwScodeSize,
LPVOID *lpvPcode,
PDWORD dwPcodeSize,
const HWND hwndLog,
const DWORD dwDebugFlag,
PDWORD nErrors,
PDWORD nWarnings,
LPCVOID lpvUser,
PCMN_ERROR pError )
Parameters
szProjectName
Character string which contains a valid project path. The project path decides which Include
and Precompiled Header are used for compiling.

pdwOrderId
Job number which is assigned when calling the APTransAct function. The job number must
be provided by the caller.
lpvScode
Pointer to the source code to be compiled.
dwScodeSize
Size of the source code in bytes.
lpvPcode
Address of a pointer which contains the P-code in successful compiling. The memory is created
by the APCompile function and must be freed by the caller again with the APFreePCode
function.
dwPcodeSize
Contains the size of the P-code in bytes after compiling.
hwndLog
Window handle with which the error messages can be output. The window handle may also
be NULL. When using a window for the output, a message is sent by the Windows function
WM_COPYDATA.
dwDebugFlag
This flag determines whether the P-code should also supply debug information (bit1 = 1 ) or
whether no debug information is to be supplied (bit1 = 0 ). "0" should normally be selected
based on the performance.
Bit2 = 1: Use server settings for Includes
Bit2 = 0: Use local settings for Includes
nErrors
Number of errors occurred. No P-code is returned for nErrors > 0.
nWarnings
Number of warnings occurred. The P-code is also generated for nWarnings > 0.
lpvUser
again in the Callback-Funktion.
pError

Return value
TRUE
Source code compiled successfully
FALSE
Error
Required files
ap_def.h
apcli_S.lib
apclient.dll
Related functions
APCompileEx (Page 1961) Compile source code

APFreePCode Free source code memory
See also
APCompileEx (Page 1961)
3.4.4.2 APCompileEx (RT Professional)
Description
Unlike the APCompile function, the source code to be compiled is divided into subsections.
In the source code void function {instructions} is divided into
void function { Start of the instruction

Instructions Base
} End of the instruction
A source code saved in the subsections lpvScodeProlog, lpvScodeBase and lpvScodeEpilog

is compiled and saved as a P-code in lpvPcode. The application must provide the memory for
the P-code.

Declaration
BOOL APCompileEx (
LPCSTR szProjectName,
PDWORD pdwOrderId,
LPCSTR lpvScodeProlog,
const DWORD dwScodePrologSize,
LPCSTR lpvScodeBase,
const DWORD dwScodeBaseSize,
LPCSTR lpvScodeEpilog,
const DWORD dwScodeEpilogSize,
LPVOID *lpvPcode,
PDWORD dwPcodeSize,
const HWND hwndLog,
const DWORD dwDebugFlag,
PDWORD nErrors,
PDWORD nWarnings,
LPCVOID lpvUser,
PCMN_ERROR pError )
Parameters
szProjectName
pdwOrderId
szProjectName
pdwOrderId
lpvScodeProlog
Pointer to the prolog of the source code to be compiled.
dwScodePrologSize
Size of the prolog in bytes.
lpvScodeBase
Pointer to the base of the source code to be compiled.
dwScodeBaseSize
Size of the base in bytes.

lpvScodeEpilog
Pointer to the epilog of the source code to be compiled.
dwScodeEpilogSize
Size of the epilog in bytes.
lpvPcode
Address of a pointer which contains the P-code in successful compiling. The memory is created
by the APCompile function and must be freed by the caller again with the APFreePCode
function.
dwPcodeSize
Contains the size of the P-code in bytes after compiling.
hwndLog
Window handle with which the error messages can be output. The window handle may also
be NULL. When using a window for the output, a message is sent by the Windows function
WM_COPYDATA.
dwDebugFlag
This flag determines whether the P-code should also supply debug information (bit1 = 1 ) or
whether no debug information is to be supplied (bit1 = 0 ). "0" should normally be selected
based on the performance.
Bit2 = 1: Use server settings for Includes
Bit2 = 0: Use local settings for Includes
nErrors
Number of errors occurred. No P-code is returned for nErrors > 0.
nWarnings
Number of warnings occurred. The P-code is also generated for nWarnings > 0.
lpvUser
again in the Callback-Funktion.
pError
Return value
TRUE
Source code compiled successfully

FALSE
Error
Required files
ap_def.h
apcli_S.lib
apclient.dll
Related functions
APCompile (Page 1959) Compile source code

APFreePCode Free source code memory
See also
APCompile (Page 1959)
3.4.4.3 GSCGenCompile (RT Professional)
Description
The function compiles an action.
Declaration
LPACTION GSCGenCompile(
LPGENERATE_COMPILE lpGenCompile,
HWND hWndParent,
unsigned long* plErrors,
unsigned long* plWarnings,
AllocAppMem lpfnAllocAppMem,
LPCMN_ERROR lpdmError)
Parameters
lpGenCompile
Pointer to the GENERATE_COMPILE (Page 1950) structure.
hWndParent
Handle to the window in which the status outputs are to be made.

plErrors
Pointer to variable for return of number of errors
plWarnings
Pointer to variable for return of number of warnings
lpfnAllocAppMem
Pointer to a function with which memory is to be allocated in the calling application
lpdmError
Return value
Pointer to the compiled action stream. A new action stream is generated even if the compilation
is faulty. The success of the call must be checked based on the number of errors and warnings.
Comment
The compiled action is not available until the next time the runtime starts.
Required files
capigsc.h
gscgr_s.lib
gscgen.dll
See also
GENERATE_COMPILE (Page 1950)
3.4.4.4 GSCGenCompileUserFunctions (RT Professional)
Description
The function recompiles all special user functions.

Declaration
BOOL GSCGenCompileUserFunctions (
LPCREATE_USER_HEADER_FILE pGenCUHF,
HWND hWndParent,
Parameters
pGenCUHF
Pointer to the CREATE_USER_HEADER_FILE (Page 1949) structure.
hWndParent
Handle to the window in which the status outputs are to be made.
lpdmError
Return value
TRUE
User functions compiled
FALSE
Error
Comment
For internal reasons this function always returns FALSE without an error message although
the functions are generated.
The compiled user functions are not available until the next time the runtime is started.
Required files
capigsc.h
gscgr_s.lib
gscgen.dll
See also
CREATE_USER_HEADER_FILE (Page 1949)

3.4.5 Functions for processing actions (RT Professional)
3.4.5.1 GSCGenGetActionStream (RT Professional)
Description
The function determines the action stream for a project function, a standard function or an
action.
Declaration
LPACTION GSCGenGetActionStream(
LPGET_ACTION_STREAM pGenGAS,
AllocAppMem lpfnAllocAppMem,
Parameters
pGenGAS
Pointer to structure of the GET_ACTION_STREAM (Page 1950) type with which the function
or action is specified.
lpfnAllocAppMem
Pointer to a function with which memory is to be allocated in the calling application
lpdmError
Return value
Pointer to the action stream.
Required files
capigsc.h
gscgr_s.lib
gscgen.dll
See also
GET_ACTION_STREAM (Page 1950)

3.4.6 Functions of the action programming (RT Professional)
3.4.6.1 APActive (RT Professional)
Description
Actions which were deactivated with APInactive can only be reactivated with this function, i.e.
the appropriate triggers are monitored again or can be restarted with APStart.
Declaration
BOOL APActive (
PAP_ACT_KEY lpapActKey,
const DWORD dwItems,
PDWORD pdwOrderId,
LPCVOID lpvUser,
PCMN_ERROR pError )
Parameters
lpapActKey
Pointer to a data structure with the following structure:
$3B$&7B.(<
$3B$&7B.(<

$3B$&7B.(<Q
$FWLRQVWUHDP

$FWLRQVWUHDP
$FWLRQVWUHDPQ
The data structure must be provided by the calling application.

The actions must be logged on with APTransAct first. The ID in AP_ACT_KEY decides whether
the action is to be started by the ID or the name.
dwItems
Number of actions, i.e. structures AP_ACT_KEY (Page 1946).
fpAppBack
Your callback function for the asynchronous call. The call is performed synchronously when
using NULL.

pdwOrderId
function.
lpvUser
pError
Return value
TRUE
Action activated
FALSE
Error.
Required files
ap_def.h
apcli_S.lib
apclient.dll
Related functions

See also
AP_ACT_KEY (Page 1946)

3.4.6.2 APEndAct (RT Professional)
Description
The action logged on for processing is logged off in the action control.
Declaration
BOOL APEndAct (
PDWORD pdwOrderId,
const PDWORD pdwOrderEnd,
LPCVOID lpvUser,
PCMN_ERROR pError )
Parameters
fpAppBack
using NULL.
pdwOrderId
function.
pdwOrderEnd
Job number of the transaction which is to be ended.
lpvUser
pError
Return value
TRUE
Action logged off

FALSE
Error.
Required files
ap_def.h
apcli_S.lib
apclient.dll
Related functions

See also
3.4.6.3 APFreeResultStruct (RT Professional)
Description
In synchronous calling of the APStart function the action results are allocated in the form of
an array of structures of the AP_ACT_RESULT_STRUCT type. The memory allocated by
APStart must be freed again with the APFreeResultStruct function.
Declaration
BOOL APFreeResultStruct (
PAP_ACT_RESULT_STRUCT *lpapars,
const DWORD dwItems )
Parameters
lpvPcode
Pointer to the first dwItems structures of theAP_ACT_RESULT_STRUCT (Page 1948) type.
dwItems
Number of structures AP_ACT_RESULT_STRUCT.

Return value
TRUE
Free memory.
FALSE
Error.
Required files
ap_def.h
apcli_S.lib
apclient.dll
Related functions
APStart (Page 1974) Processing of action started
See also
APStart (Page 1974)
AP_ACT_RESULT_STRUCT (Page 1948)
3.4.6.4 APInactive (RT Professional)
Description
Actions which have been logged on with APTransAct can be deactivated with APInactive. The
appropriate triggers are no longer monitored and the actions cannot be started with APStart.
The actions can be reactivated with APActive.
Declaration
BOOL APInactive (
PAP_ACT_KEY lpActKey,
PDWORD pdwOrderId,
LPCVOID lpvUser,
PCMN_ERROR pError )

Parameters
lpapActKey
$3B$&7B.(<
$3B$&7B.(<

$3B$&7B.(<Q
$FWLRQVWUHDP

$FWLRQVWUHDP
$FWLRQVWUHDPQ

dwItems
fpAppBack
using NULL.
pdwOrderId
function.
lpvUser
pError
Return value
TRUE
Action deactivated

FALSE
Error.
Required files
ap_def.h
apcli_S.lib
apclient.dll
Related functions
APActive (Page 1968) Activate actions

See also
3.4.6.5 APStart (RT Professional)
Description
The actions are started for processing. Simultaneous processing of several actions is possible.
The actions are described in the AP_ACT_KEY structure.
Declaration
BOOL APStart (
AP_ACT_KEY lpapActKey,
AP_RT_PROC fpAppResult,
PDWORD pdwOrderId,
PAP_ACT_RESULT_STRUCT *lpapars,
LPCVOID lpUser,
PCMN_ERROR pError )

Parameters
lpapActKey
$3B$&7B.(<
$3B$&7B.(<

$3B$&7B.(<Q
$FWLRQVWUHDP

$FWLRQVWUHDP
$FWLRQVWUHDPQ

dwItems
fpAppBack
using NULL.
fAppResult
Your callback function for cyclic action results. The structures of the
AP_ACT_RESULT_STRUCT (Page 1948) type are supplied in the callback function. In
synchronous call lpapars is assigned with the result.
pdwOrderId
function.
lpapars
Pointer to the action result in synchronous call. An array of structures of the
AP_ACT_RESULT_STRUCT (Page 1948) type is returned according to the number of started
actions. The memory allocated by the function must be freed again with APFreeResultStruct.
In asynchronous use islpapars = NULL

lpvUser
pError
Return value
TRUE
Action started
FALSE
Error.
Comment
With APStart only actions which were not previously deactivated with APInactive can be
started.
Required files
ap_def.h
apcli_S.lib
apclient.dll
Related functions
APFreeResultStruct (Page 1971) Free memory

See also
APFreeResultStruct (Page 1971)
AP_ACT_RESULT_STRUCT (Page 1948)

3.4.6.6 APTransact (RT Professional)
Application
Declaration
Parameter
xxx
xxx
lpdmError
Pointer to the data of the extended error message in the CMN_ERROR structure. The system
writes error information into this structure in the case of an error.
Return value
TRUE
.
FALSE
Error
Comment
Required files
ap_def.h
apcli_S.lib
apclient.dll
Related functions

Examples
Auto-Hotspot "DM01.cpp"
See also
APEndAct (Page 1970)

3.4.7.1 Establish connection to script programming (RT Professional)
Overview

// =====================================================================
// Filename:.......... ap01.c
// =====================================================================
// : Modul with examples of AP_API
// *********************************************************************
// Copyright (C) 1995/96 SIEMENS AG, AUT 913 All rights reserved
// *********************************************************************
#include "stdafx.h"
#include "ap01.h" // if console application
//{{ODK_EXAMPLE}Establish connection to script programming (AP)}

//{{FUNCTION}APConnect (AP)}
//{{FUNCTION}APDisconnect (AP)}
//{{FUNCTION}AP_RT_PROC (AP)}
//{{FUNCTION}(END)}
// Establish connection to script programming (AP)
// =====================================================================
// Function: AprConnect(void) ODK AP CS
// =====================================================================
// short : Establish connection to script programming
// :
// =====================================================================
BOOL MyAPRTCallback(DWORD dwAP_Notify, DWORD dwAP_NotifyCode, DWORD dwError,
LPVOID lpvData, DWORD dwItems, DWORD dwOrderID, LPVOID lpvUser)
{
lpvUser;
dwOrderID;
lpvData;
TCHAR szText[255];
_sntprintf_s( szText,_countof(szText), _TRUNCATE, _T("AprNotCon:: AP= %d ;
dwAP_Notify, dwAP_NotifyCode, dwError, dwItems);
ODKTrace(szText);
return(TRUE );
}
void MyApConnect(void)
{
TCHAR szText[255];
CMN_ERROR Error;
BOOL ret= FALSE;
DWORD dwOrderID = 0;
TCHAR szApp[255];
VOID* pUser = NULL;
_tcsncpy_s(szApp, _countof(szApp), _T("MyODKApp_23"), _TRUNCATE); // must be the same
AppName as by DMConnect
ret = APConnect(szApp, MyAPRTCallback, &dwOrderID, pUser, &Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in APConnect: E1= 0x
%08lx ; E2= 0x%08lx ; %s"),
}
else
{

3.5 Functions of the user administration (RT Professional)
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("APConnect"));

}
ODKTrace(szText);
//printf("%s\r\n"szText);
void MyAPDisconnect()
VOID* pUser = NULL;
CMN_ERROR Error;
TCHAR szText[255];
BOOL ret = FALSE;
DWORD dwOrderID = 0;
ret = APDisconnect(NULL, &dwOrderID, pUser, &Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in APDisconnect: E1= 0x
%08lx ; E2= 0x%08lx ; %s"),
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("APDisconnect"));
}
ODKTrace(szText);
}
// --------------------------------------------------------------------
See also
Overview
PWGEN_ENUM_GROUPS_CALLBACK List user groups (callback)

(Page 2003)
PWGEN_ENUM_LEVELS_CALLBACK List authorization levels (callback)
(Page 2010)

PWGEN_ENUM_USERS_CALLBACK List users (callback)

(Page 1999)
PWGENAddGroup (Page 2000) Create user group
PWGENAddPermLevel (Page 2005) Create authorization level
PWGENAddUser (Page 1990) Create user
PWGENAddUserEx (Page 1991) Create user
PWGENChangePassword (Page 1993) Change password
PWGENCheckPermission (Page 2006) Verify user authorizations of a user
PWGENCheckUser (Page 1995) Check user
PWGENConnect (Page 1987) Establish connection to the database.
PWGENDeletePermLevel (Page 2007) Delete authorization level
PWGENDeleteUser (Page 1996) Delete user/delete user group
PWGENDisconnect (Page 1988) Terminate connection to the database
PWGENEnumGroups (Page 2002) List user groups
PWGENEnumPermLevels (Page 2009) List authorization levels
PWGENEnumUsers (Page 1997) List users
PWGENReadUserPerm (Page 2011) Determine user authorizations
PWRTCheckPermission (Page 2013) Check area authorization
PWRTCheckPermissionOnPicture (Page 2014) Check authorization level
PWRTGetCurrentUser (Page 2018) Determine login name
PWRTGetLoginPriority (Page 2019) GetLoginPriority
PWRTIsLoggedInByCard (Page 2020) Login via chip card
PWRTLogin (Page 2021) Login via dialog
PWRTLogout (Page 2023) Logout
PWRTLogoutEx (Page 2024) Logout
PWRTPermissionLevelDialog (Page 2015) Select authorization level
PWRTPermissionLevelDialogEx (Page 2016) Select authorization level
PWRTPermissionToString (Page 2017) Determine authorization level for text description
PWRTSilentLogin (Page 2025) Login
PWRTSilentLoginEx (Page 2026) Login
Overview
PWGEN_GROUPINFO (Page 1984) User group information

PWGEN_LEVELINFO (Page 1985) Authorization level information
PWGEN_USERINFO (Page 1986) User information

Overview
structure:
Error messages for RT:
PWRT_CAP_SHMERROR 1 Shared memory error

PWRT_CAP_NOLOGIN 2 No user is logged on
PWRT_CAP_NOPERM 3 User does not have authorization.
PWRT_CAP_NOAREA 4 The area could not be found.
PWRT_GPA_SHMERROR 1 Shared memory error
PWRT_GPA_NOLOGIN 2 No user is logged on
Error messages for CS V5.0 and higher:
PWGEN_API_ERR_SUPPLY 0x10000001L An unspecified error has occurred.

PWGEN_API_NO_MEMORY 0x10000001L Not enough memory.
PWGEN_API_NOT_SUPPORTED 0x10000003L This function is not supported
PWGEN_API_INVALID_PARAM 0x10000004L A function parameter is incorrect or missing.
PWGEN_API_NO_INTERFACE 0x10000005L No connection to the UserAdminASO-Inter‐
face.
PWGEN_API_I_ENUM 0x10000006L Error while enumerating
PWGEN_API_I_READ 0x10000007L Error while reading
PWGEN_API_I_CREATE 0x10000008L Error while creating new data
PWGEN_API_I_MODIFY 0x10000009L Error while modifying data
PWGEN_API_I_DELETE 0x1000000AL Error while deleting data
PWGEN_API_TERMINATED 0x1000000FL Processing was cancelled prematurely.
PWGEN_API_NO_CONNECTION 0x10000010L PWGENConnect not yet executed.
PWGEN_API_IS_CONNECTED 0x10000011L PWGENConnect has already been execu‐
ted.
PWGEN_API_NO_USER 0x10000020L User not found
PWGEN_API_MAX_USER 0x10000021L The maximum number of users has been
reached (~ 128).
PWGEN_API_EXIST_USER 0x10000022L The selected user already exists.
PWGEN_API_NO_GROUP 0x10000030L User group was not found.
PWGEN_API_MAX_GROUP 0x10000031L The maximum number of user groups has
been reached (~ 10).
PWGEN_API_EXIST_GROUP 0x10000032L The selected user group already exists.
PWGEN_API_NO_LEVEL 0x10000040L Authorization level not found.
PWGEN_API_MAX_LEVEL 0x10000041L The maximum number of authorization lev‐
els has been reached (~ 1000).

PWGEN_API_EXIST_LEVEL 0x10000042L The selected authorization level already ex‐

ists.
PWGEN_API_NO_PERM 0x10000050L No authorization assigned.
PWGEN_API_MAX_PERM 0x10000051L The maximum number of authorization lev‐
els has been reached.
PWGEN_API_EXIST_PERM 0x10000052L The authorization already exists.
PWGEN_API_NO_AREA 0x10000060L No range was assigned.
PWGEN_API_MAX_AREA 0x10000061L The maximum number of areas has been
reached (~ 32).
PWGEN_API_EXIST_AREA 0x10000062L The area already exists.
PWGEN_API_NO_PASSWORD 0x10000070L No or no valid password.
PWGEN_API_MAX_PASSWORD 0x10000071L The maximum number of passwords has
been reached.
PWGEN_API_EXIST_PASSWORD 0x10000072L The password is already assigned.
String and array sizes
MAX_LOGIN 25
MAX_PASS 25
MAX_LEVEL 70
3.5.2.1 PWGEN_GROUPINFO (RT Professional)
Declaration
typedef struct {
TCHAR name[MAX_LOGIN];
int expiration_time;
}
PWGEN_GROUPINFO;
Members
name
Name of the user group

expiration_time
automatic logout time in minutes
Required files
usegenap.h
API functions
PWGEN_ENUM_GROUPS_CALLBACK List user groups

(Page 2003)
See also
PWGEN_ENUM_GROUPS_CALLBACK (Page 2003)
3.5.2.2 PWGEN_LEVELINFO (RT Professional)
Declaration
typedef struct {
int levelNumber;
DWORD dwTextID;
}
PWGEN_LEVELINFO;
Members
levelNumber
Number of the authorization
dwTextID
ID which identifies the description of authorization.
Required files
usegenap.h
API functions
PWGEN_ENUM_LEVELS_CALLBACK List authorization levels

(Page 2010)

See also
PWGEN_ENUM_LEVELS_CALLBACK (Page 2010)
3.5.2.3 PWGEN_USERINFO (RT Professional)
Declaration
typedef struct {
TCHAR login[MAX_LOGIN];
TCHAR group[MAX_LOGIN];
int expiration_time;
}
PWGEN_USERINFO;
Members
login
Logon name of the user
group
Name of the group to which the user belongs
expiration_time
automatic logout time in minutes
Required files
usegenap.h
API functions
PWGEN_ENUM_USERS_CALLBACK List users

(Page 1999)
See also
PWGEN_ENUM_USERS_CALLBACK (Page 1999)

3.5.3.1 PWGENConnect (RT Professional)
Description
The function connects to the database of the currently open project.
Declaration
BOOL PWGENConnect (
LPCTSTR DSNName,
LPCMN_ERROR err)
Parameters
DSNName
DataSource name of the project. The DSNName parameter is not evaluated. An empty string
can be passed but not ZERO. The database of the currently open project is always used.
err
Return value
TRUE
Connection established
FALSE
Error
Comment
Each application can perform only one Connect. With a repeated Connect, the
PWGEN_API_IS_CONNECTED error message is returned.
Error messages
PWGEN_API_INVALID_PARAM A function parameter is incorrect or missing.

PWGEN_API_ERR_SUPPLY An unspecified error has occurred.
PWGEN_API_NO_INTERFACE No connection to the UserAdminASO interface.

PWGEN_API_NO_CONNECTION No PWGENConnect has been executed.

PWGEN_API_IS_CONNECTED PWGENConnect has already been executed.
Required files
usegenap.h
usegen.lib
usegen.dll
Related functions
PWGENDisconnect (Page 1988) Terminate connection to the database
See also
PWGENDisconnect (Page 1988)
3.5.3.2 PWGENDisconnect (RT Professional)
Description
The connection to the database of the currently open project is terminated.
Declaration
BOOL PWGENDisconnect (
LPCMN_ERROR err)
Parameters
err
Return value
TRUE
Connection terminated

FALSE
Error
Comment
A PWGENDisconnect before the application is closed, otherwise the internally used
UserAdminASO interfaces will no longer be enabled.
Note
The call may not be used in the destructor of an application (EXE, DLL, OCX, etc.). Due to
Microsoft-specific mechanisms, this may cause the call to freeze and thereby crash the
program.
Error messages

Required files
usegenap.h
usegen.lib
usegen.dll
Related functions
PWGENConnect (Page 1987) Make connection to the database.
See also
PWGENConnect (Page 1987)

3.5.4 Functions for processing users (RT Professional)
3.5.4.1 PWGENAddUser (RT Professional)
Description
The function creates a new user, including an empty user authorization matrix. You can use
the PWGENAddUserEx function to transfer the authorizations of the group to the users to be
created.
Declaration
BOOL PWGENAddUser (
LPCTSTR username,
LPCTSTR password,
LPCTSTR group,
int expiration_time,
LPCMN_ERROR error )
Parameters
username
password
Password of the user
group
Group to which the user should be added
expiration_time
Automatic logout time in minutes. If the selected expiration_time is outside the permitted range,
it is set to 0.
error
Return value
TRUE
Users created

FALSE
Error
Error messages

PWGEN_API_NO_MEMORY Not enough memory.
PWGEN_API_I_ENUM Error in enumeration.
PWGEN_API_EXIST_USER The selected user already exists.
PWGEN_API_MAX_USER The maximum number of users has been reached (~ 128).
PWGEN_API_NO_GROUP Cannot find user group.
PWGEN_API_I_CREATE Error creating new data.
Required files
usegenap.h
usegen.lib
usegen.dll
Related functions
PWGENAddUserEx (Page 1991) Creating users
See also
PWGENAddUserEx (Page 1991)
3.5.4.2 PWGENAddUserEx (RT Professional)
Description
The function creates a new user. Depending on the copy_group_protection parameter, you
can transfer the authorizations of the group to the users to be created.

Declaration
BOOL PWGENAddUserEx (
LPCTSTR username,
LPCTSTR password,
LPCTSTR group,
BOOL copy_group_permissions,
LPCMN_ERROR error )
Parameters
username
password
group
Group to which the user should be added
expiration_time
Automatic logout time in minutes. If the selected expiration_time is outside the permitted range,
it is set to 0.
copy_group_permissions
If copy_group_permission = TRUE, the user authorizations of the group to the newly created
user will be transferred.
error
Return value
TRUE
Users created
FALSE
Error
Error messages



PWGEN_API_MAX_USER The maximum number of users has been reached (~ 128).
Required files
usegenap.h
usegen.lib
usegen.dll
Related functions
PWGENAddUser (Page 1990) Creating users
See also
PWGENAddUser (Page 1990)
3.5.4.3 PWGENChangePassword (RT Professional)
Description
This function can be used to change the password of the user specified by the user name.
Declaration
BOOL PWGENChangePassword (
LPCTSTR username,
LPCTSTR oldpassword,
LPCTSTR newpassword,
LPCMN_ERROR error )
Parameters
username

oldpassword
Old password of the user
newpassword
New password of the user
error
Return value
TRUE
Password changed
FALSE
Error
Error messages

PWGEN_API_NO_PASSWORD No or no valid password.
PWGEN_API_NO_USER Cannot find user.
PWGEN_API_I_READ Error reading.
PWGEN_API_I_MODIFY Error changing data.
Required files
usegenap.h
usegen.lib
usegen.dll
See also

3.5.4.4 PWGENCheckUser (RT Professional)
Description
This checks whether the specified user exists in the current WinCC project and whether the
given password is correct.
Declaration
BOOL PWGENCheckUser (
LPCTSTR username,
LPCTSTR password,
LPCMN_ERROR error )
Parameters
username
Name of the user.
password
The password that belongs to the specified user.
error
Return value
TRUE
User exists and the password is correct.
FALSE
Error
Error messages

PWGEN_API_NO_PASSWORD No or no valid password.

Required files
usegenap.h
usegen.lib
usegen.dll
See also
3.5.4.5 PWGENDeleteUser (RT Professional)
Description
The specified user or user group is deleted, including the authorization data.
Declaration
BOOL PWGENDeleteUser (
LPCTSTR username,
BOOL is_user,
LPCMN_ERROR error )
Parameters
username
Number of the user to be
deleted.
is_user
The is_user parameter is used to distinguish whether a user or a user group is to be deleted.
TRUE A user should be deleted.

FALSE A user group should be deleted.
error
Return value
TRUE
User or user groups deleted

FALSE
Error
Comment
If you attempt to delete the administrator, the function returns the PWGEN_API_EXIST_USER
error.
Error messages

PWGEN_API_I_DELETE Error deleting data.
Required files
usegenap.h
usegen.lib
usegen.dll
See also
3.5.4.6 PWGENEnumUsers (RT Professional)
Description
The function reads the configured users, calls the callback function for each user and returns
the number of users in dwCount.

Declaration
BOOL PWGENEnumUsers (
LPDWORD dwCount,
PWGEN_ENUM_USERS_CALLBACK cfn,
PVOID userdata,
LPCMN_ERROR error )
Parameters
dwCount
Pointer to the location where the number of users should be stored.
cfn
Your callback function that receives the information. If cfn == NULL, only users are counted.
userdata
error
Return value
TRUE
Users listed
FALSE
Error
Error messages

Required files
usegenap.h

usegen.lib
usegen.dll
Related functions
PWGEN_ENUM_USERS_CALLBACK List users (callback)

(Page 1999)
See also
PWGEN_ENUM_USERS_CALLBACK (Page 1999)
3.5.4.7 PWGEN_ENUM_USERS_CALLBACK (RT Professional)
Description
In order to evaluate the user information listed by the system, you must provide a
PWGEN_ENUM_USERS_CALLBACK type callback function.
Declaration
BOOL ( * PWGEN_ENUM_USERS_CALLBACK) (
LPWGEN_USERINFO lpUserInfo,
PVOID lpUser);
Parameters
lpUserInfo
Pointer to a PWGEN_USERINFO (Page 1986) type structure with the data of a user.
lpUser
function.
Return value
TRUE
Users listed

FALSE
Error
Note
Required files
usegenap.h
Related functions
PWGENEnumUsers (Page 1997) List users
See also
PWGENEnumUsers (Page 1997)
PWGEN_USERINFO (Page 1986)
3.5.5 Functions for processing user groups (RT Professional)
3.5.5.1 PWGENAddGroup (RT Professional)
Description
The function creates a new user group, including an empty user authorization matrix.
Declaration
BOOL PWGENAddGroup (
LPCTSTR username,
LPCMN_ERROR error )

Parameters
username
Name of the group to be created
expiration_time
Automatic logout time. If the selected expiration_time is outside the permitted range, it is set
to 0.
error
Return value
TRUE
User group created
FALSE
User group already exists
Comment
Use the PWGENDeleteUser function to delete an existing user group.
Error messages

PWGEN_API_EXIST_GROUP The selected user group already exists.
PWGEN_API_MAX_GROUP The maximum number of user groups has been reached (~ 10).
Required files
usegenap.h
usegen.lib
usegen.dll

Related functions
PWGENDeleteUser (Page 1996) Creating users
See also
PWGENDeleteUser (Page 1996)
3.5.5.2 PWGENEnumGroups (RT Professional)
Description
The function reads the configured user groups, calls the callback function for each group and
returns the number of groups in dwCount.
Declaration
BOOL PWGENEnumGroups (
LPDWORD dwCount,
PWGEN_ENUM_GROUPS_CALLBACK cfn,
PVOID userdata,
LPCMN_ERROR error )
Parameters
dwCount
Pointer to the location where the number of user groups should be stored.
cfn
Your callback function that receives the information. If cfn == NULL, only user groups are
counted.
userdata
error

Return value
TRUE
User groups listed
FALSE
Error
Error messages

Required files
usegenap.h
usegen.lib
usegen.dll
Related functions
PWGEN_ENUM_GROUPS_CALLBACK List user groups (callback)

(Page 2003)
See also
PWGEN_ENUM_GROUPS_CALLBACK (Page 2003)
3.5.5.3 PWGEN_ENUM_GROUPS_CALLBACK (RT Professional)
Description
In order to evaluate the information of user groups listed by the system, you must provide a
PWGEN_ENUM_GROUPS_CALLBACK type callback function.

Declaration
BOOL ( * PWGEN_ENUM_GROUPS_CALLBACK) (
LPWGEN_GROUPINFO lpGroupInfo,
PVOID lpUser);
Parameters
lpUserInfo
Pointer to a PWGEN_GROUPINFO (Page 1984) type structure with the data of a user group.
lpUser
function.
Return value
TRUE
User groups listed
FALSE
Error
Note
Required files
usegenap.h
Related functions
PWGENEnumGroups (Page 2002) List user groups

See also
PWGENEnumGroups (Page 2002)
PWGEN_GROUPINFO (Page 1984)
3.5.6 Functions for processing authorizations (RT Professional)
3.5.6.1 PWGENAddPermLevel (RT Professional)
Description
Creates a new authorization for all users.
Declaration
BOOL PWGENAddPermLevel (
DWORD txtID,
int number,
LPCMN_ERROR error )
Parameters
txtID
Text ID of the text for the authorization.
number
Number of the authorization to be created
error
Return value
TRUE
Authorization level created
FALSE
Error

Error messages

PWGEN_API_MAX_LEVEL The maximum number of authorization levels has been
reached (1000).
PWGEN_API_EXIST_LEVEL The selected authorization level already exists.
Required files
usegenap.h
usegen.lib
usegen.dll
See also
3.5.6.2 PWGENCheckPermission (RT Professional)
Description
The function checks whether the user has the operator authorizations for the specified
authorization level.
Declaration
BOOL PWGENCheckPermission(
LPCTSTR username,
DWORD permlevel,
LPCMN_ERROR error)
Parameters
username
Name of the user

permlevel
Number of the authorization to be checked
error
Return value
TRUE
The operator authorization for the authorization level of the user is available.
FALSE
Error
Error messages

PWGEN_API_NO_LEVEL Cannot find authorization level.
PWGEN_API_I_READ Error reading.
PWGEN_API_NO_PERM No authorization granted.
Required files
usegenap.h
usegen.lib
usegen.dll
See also
3.5.6.3 PWGENDeletePermLevel (RT Professional)
Description
Deletes the authorization level specified by levelNumber from the user authorization matrix.

Declaration
BOOL PWGENDeletePermLevel (
int levelNumber,
LPCMN_ERROR error )
Parameters
levelNumber
Number of the authorization to be deleted
error
Return value
TRUE
Authorization level deleted
FALSE
Error
Error messages

PWGEN_API_NO_LEVEL Cannot find authorization level.
PWGEN_API_I_DELETE Error deleting data.
Required files
usegenap.h
usegen.lib
usegen.dll
See also

3.5.6.4 PWGENEnumPermLevels (RT Professional)
Description
The function reads the configured authorization levels, calls the callback function for each level
and returns the number of authorization levels in dwCount.
Declaration
BOOL PWGENEnumPermLevels (
LPDWORD dwCount,
PWGEN_ENUM_LEVELS_CALLBACK cfn,
PVOID userdata,
LPCMN_ERROR error )
Parameters
dwCount
Pointer to the location where the number of authorization levels should be stored.
cfn
Your callback function that receives the information. If cfn == NULL, only authorizations are
counted.
userdata
error
Return value
TRUE
Authorization levels listed
FALSE
Error
Error messages



Required files
usegenap.h
usegen.lib
usegen.dll
Related functions
PWGEN_ENUM_LEVELS_CALLBACK List authorizations (callback)

(Page 2010)
See also
PWGEN_ENUM_LEVELS_CALLBACK (Page 2010)
3.5.6.5 PWGEN_ENUM_LEVELS_CALLBACK (RT Professional)
Description
In order to evaluate the authorization levels listed by the system, you must provide a
PWGEN_ENUM_LEVELS_CALLBACK type callback function.
Declaration
BOOL ( * PWGEN_ENUM_LEVELS_CALLBACK) (
LPWGEN_LEVELINFO lpLevelInfo,
PVOID lpUser);
Parameters
lpLevelInfo
Pointer to a PWGEN_LEVELINFO (Page 1985) type structure with the data of the authorization
level.
lpUser
function.

Return value
TRUE
Authorization levels listed
FALSE
Error
Note
Required files
usegenap.h
Related functions
PWGENEnumPermLevels (Page 2009) List authorization levels
See also
PWGENEnumPermLevels (Page 2009)
PWGEN_LEVELINFO (Page 1985)
3.5.6.6 PWGENReadUserPerm (RT Professional)
Description
You can use this function to determine the area for which a user has operator authorizations
on a certain authorization level.

Declaration
BOOL PWGENReadUserPerm(
LPCTSTR username,
BOOL is_user,
int levelnumber,
LPBYTE freigabe,
LPDWORD areaperms )
Parameters
username
Name of the user or user group
is_user
is_user indicates whether username refers to a user or a user group.
TRUE User
FALSE User group
levelnumber
Number of the authorization to be read
freigabe
If freigabe = 1, the user has operator authorization for all areas on this authorization level.
areaperms
The areas are characterized with the 32 bits of areaperm. If a user has authorization for an
area, the corresponding bit is set. The least significant bit corresponds to to the first area.
Return value
TRUE
Operator authorizations determined
FALSE
Error
Required files
usegenap.h
usegen.lib
usegen.dll

See also
3.5.6.7 PWRTCheckPermission (RT Professional)
Description
Checks whether the logged-on user has operator authorization for the given authorization.
Declaration
BOOL PWRTCheckPermission (
DWORD permlevel,
DWORD suppress_messagebox )
Parameters
permlevel
Number of the authorization level to be checked
suppress_messagebox
No dialog is displayed with suppress_messagebox != 0.
Return value
TRUE
Authorization granted
FALSE
Authorization not granted
Required files
pwrt_api.h
pass_s.lib
useadmin.dll
Examples
PWRT check permission (Page 2028) "PWRTBunch.cpp"

See also
PWRT check permission (Page 2028)
3.5.6.8 PWRTCheckPermissionOnPicture (RT Professional)
Description
Checks whether the logged-on user has operator authorization for the given authorization.
Declaration
BOOL PWRTCheckPermissionOnPicture (
DWORD permlevel,
LPCTSTR picture_name,
DWORD suppress_messagebox,
LPCMN_ERROR lperr )
Parameters
permlevel
Number of the authorization to be checked.
picture_name
Name of the screen that contains the object to be tested.
suppress_messagebox
No dialog is displayed with suppress_messagebox != 0.
lperr
Return value
TRUE
Authorization granted
FALSE
Authorization not granted

Required files
pwrt_api.h
pass_s.lib
useadmin.dll
Examples
Checks admission of a certain level for a screen (Page 2029) "PWRTBunch.cpp"
See also
Checks admission of a certain level for a screen (Page 2029)
3.5.6.9 PWRTPermissionLevelDialog (RT Professional)
Description
You should open the dialog for selecting authorizations using the
PWRTPermisssionLevelDialogEx function, because then a redraw is performed when you
move the dialog window.
Declaration
LONG PWRTPermissionLevelDialog (
)
Parameters
None
Related functions
PWRTPermissionLevelDialogEx (Page 2016) Select authorization for via dialog
Examples
Authorization level query through a dialog with specifying a possible error (Page 2031)
"PWRTBunch.cpp"

See also
PWRTPermissionLevelDialogEx (Page 2016)
PWRTPermissionToString (Page 2017)
3.5.6.10 PWRTPermissionLevelDialogEx (RT Professional)
Description
Protecting the usability of objects made in WinCC through dialogue to select a rating.
PWRTPermissionLevelDialogEx displays a corresponding dialog that offers the available
authorizations for selection.
Declaration
LONG PWRTPermissionLevelDialogEx (
HWND hParentWnd,
CMN_ERROR *lpErr)
Parameters
hParentWnd
Handle to the parent of the dialog box.
lpErr
Return value
0-999 Authorization level
-1: Dialog closed with Cancel.
Required files
pwrt_api.h
pass_s.lib
useadmin.dll

Example
"PWRTBunch.cpp"
See also
PWRTPermissionLevelDialog (Page 2015)
3.5.6.11 PWRTPermissionToString (RT Professional)
Description
Determines the description associated with an authorization level.
Declaration
BOOL PWRTPermissionToString (
LONG perm,
LPTSTR string,
int bufsize)
Parameters
perm
Authorization level whose description is to be determined.
string
Pointer to the buffer for recording the description.
bufsize
Size of the buffer
Return value
TRUE
Description successfully transferred.
FALSE
Description could not be determined.

Required files
pwrt_api.h
pass_s.lib
useadmin.dll
Related functions
PWRTPermissionLevelDialog (Page 2015) Select authorization level
Examples
Gets a string associated with the permission number (Page 2030). "PWRTBunch.cpp"
See also
Gets a string associated with the permission number (Page 2030)
3.5.7 Functions for logon, logoff (RT Professional)
3.5.7.1 PWRTGetCurrentUser (RT Professional)
Description
Determines the user name of the current logged-on user.
Declaration
BOOL PWRTGetCurrentUser (
LPTSTR dest,
int bufsize )
Parameters
dest
Data buffer for receiving the user name
bufsize
Size of the data buffer in bytes

Return value
TRUE
User name successfully transferred
FALSE
No user is logged on
Required files
pwrt_api.h
pass_s.lib
useadmin.dll
Examples
Return the name of the current user (Page 2032) "PWRTBunch.cpp"
See also
Return the name of the current user (Page 2032)
3.5.7.2 PWRTGetLoginPriority (RT Professional)
Description
Logon check without dialog.
Declaration
LONG PWRTGetLoginPriority (
)
Parameters
None

Return value
Priority level:
LOGIN_STANDARD (value: 0)
LOGIN_CARD (value: 1)
LOGIN_KEYSWITCH (value: 2)
Required files
pwrt_api.h
pass_s.lib
useadmin.dll
Examples
Queries the current logon priority (Page 2033) "PWRTBunch.cpp"
See also
Queries the current logon priority (Page 2033)
3.5.7.3 PWRTIsLoggedInByCard (RT Professional)
Description
Determines whether the user is logged on via smart card.
Declaration
BOOL PWRTIsLoggedInByCard (
)
Parameters
None
Return value
TRUE
User logged on with smart card

FALSE
Users not logged on with smart card or not logged on
Required files
pwrt_api.h
pass_s.lib
useadmin.dll
Examples
Checks if the user has been logged on by card (Page 2033) "PWRTBunch.cpp"
See also
Checks if the user has been logged on by card (Page 2033)
3.5.7.4 PWRTLogin (RT Professional)
Description
Displays the logon dialog and loads the user data into the shared memory when logon is
successful.
Declaration
BOOL PWRTLogin (
TCHAR monitor )

Parameters
monitor
Monitor on which the dialog is shown. The value is not numeric; it is specified in TCHAR format,
i.e. '1' for Monitor 1.
Return value
TRUE
Dialog open. The function does not wait for the dialog to close.
FALSE
Dialog not open
Comment
In addition to manually entering the logon data, you can also log on with a smart card. The
card reader is connected directly to the OS. If no valid card is connected when the function is
executed, the logon dialog automatically disappears.
Required files
pwrt_api.h
pass_s.lib
useadmin.dll
Related functions
PWRTSilentLogin (Page 2025) Logon
Examples
PWRT login - dialog provided by WinCC itself (Page 2035) "PWRTBunch.cpp"
See also
PWRTSilentLogin (Page 2025)
PWRT login - dialog provided by WinCC itself (Page 2035)
PWRTSilentLoginEx (Page 2026)

3.5.7.5 PWRTLogout (RT Professional)
Description
The function causes a flag to be set at logoff in the shared memory.
Declaration
BOOL PWRTLogout (
)
Parameters
None
Return value
TRUE
Logoff successfully passed to PassDBRT.
FALSE
Logoff rejected (for example, PassDBRT not available, ServiceMode, etc.).
Required files
pwrt_api.h
pass_s.lib
useadmin.dll
Related functions
PWRTLogoutEx (Page 2024) Log off user with priority level
Examples
PWRT logoff (Page 2036) "PWRTBunch.cpp"
See also
PWRT logoff (Page 2036)
PWRTLogoutEx (Page 2024)

3.5.7.6 PWRTLogoutEx (RT Professional)
Description
The function causes a flag to be set at logoff in the shared memory, unless the specified priority
level is too low.
Declaration
BOOL PWRTLogoutEx (
int nLevel
)
Parameters
nLevel
Priority level of the user.
Return value
TRUE
Logoff successfully passed to PassDBRT.
FALSE
Logoff rejected (for example, PassDBRT not available, ServiceMode, etc.).
Required files
pwrt_api.h
pass_s.lib
useadmin.dll
Related functions
PWRTLogout (Page 2023) User logoff
Examples
Silent logoff with priority level (Page 2037) "PWRTBunch.cpp"

See also
Silent logoff with priority level (Page 2037)
PWRTLogout (Page 2023)
3.5.7.7 PWRTSilentLogin (RT Professional)
Description
In contrast to PWRTLogin, logon is not performed in a dialog. The data for the user, user name
and password are passed directly to the function.
Declaration
BOOL PWRTSilentLogin (
LPCTSTR login,
LPCTSTR password )
Parameters
login
Name of the user.
password
Return value
TRUE
Logon successful
FALSE
Logon rejected
Comment
If no valid smart card is connected when the function is executed, the logon is rejected.
Required files
pwrt_api.h
pass_s.lib

useadmin.dll
Related functions
PWRTLogin (Page 2021) Logon via dialog

PWRTSilentLoginEx (Page 2026) Logon with priority level
Examples
Logon without using a dialog (Page 2038) "PWRTBunch.cpp"
See also
PWRTLogin (Page 2021)
Logon without using a dialog (Page 2038)
3.5.7.8 PWRTSilentLoginEx (RT Professional)
Description
In contrast to PWRTLogin, logon is not performed in a dialog. The data for the user (user name,
password and priority level) are passed directly to the function.
Declaration
BOOL PWRTSilentLoginEx (
LPCTSTR login,
LPCTSTR password,
int nLevel)
Parameters
login
Name of the user.
password
nLevel
Priority level of the user

Return value
TRUE
Logon successful
FALSE
Logon rejected
Comment
If no valid smart card is connected when the function is executed, the logon is rejected.
Required files
pwrt_api.h
pass_s.lib
useadmin.dll
Related functions
PWRTLogin (Page 2021) Logon via dialog

PWRTSilentLogin (Page 2025) Logon without dialog
Examples
Silent logon with priority level (Page 2039) "PWRTBunch.cpp"
See also
Silent logon with priority level (Page 2039)

3.5.8.1 PWRT check permission (RT Professional)
Example
//{{ODK_EXAMPLE}PWRT check permission. (USE)}

//{{FUNCTION}PWRTCheckPermission (USE)}
//{{FUNCTION}(END)}
void CPWRTBunch::Pwrtcheckpermission()
{
BOOL bRet;
CString csOut;
CString csPermLevName;
CGetText l_PermissionLevel("Insert the permission level number:");
if(l_PermissionLevel.DoModal()==IDOK)
{
///////////////////////////////////////////////////////////////////////////////////
//////
bRet = PWRTCheckPermission( l_PermissionLevel.m_lNumber, 0L ); // 0 = show the
message box
///////////////////////////////////////////////////////////////////////////////////
//////
///////////////////////////////////////////////////////////////////////////////////
//////
bRet &= PWRTPermissionToString(l_PermissionLevel.m_lNumber,
csPermLevName.GetBuffer(1024), 1024);
///////////////////////////////////////////////////////////////////////////////////
//////
if(!bRet)
{
m_pView->Print("ERROR: ", FSIZE_FUNCMARK);
m_pView->Print("PWRTCheckPermission.\n", FSIZE_PARAMMARK, FALSE, TRUE);
csOut.Format("Level = %ld (\"%s\") - Access denied.\n",
l_PermissionLevel.m_lNumber,
csPermLevName);
m_pView->Print(csOut, FSIZE_SUBMARK);
m_pView->Print("\n");
return;
}
else
{
csOut.Format("Level = %ld (\"%s\")\n",
l_PermissionLevel.m_lNumber,
csPermLevName);
m_pView->Print("PWRTCheckPermission\n", FSIZE_FUNCMARK, TRUE);
m_pView->Print("Access approved:\n", FSIZE_PARAMMARK, FALSE, TRUE);
}
}
}

See also
PWRTCheckPermission (Page 2013)
3.5.8.2 Checks admission of a certain level for a screen (RT Professional)
Example
//{{ODK_EXAMPLE}Checks admission of a certain level for a picture. (USE)}

//{{FUNCTION}PWRTCheckPermissionOnPicture (USE)}
//{{FUNCTION}(END)}
void CPWRTBunch::Pwrtcheckpermissiononpicture()
{
BOOL bRet;
CMN_ERROR err;
CString csOut;
CGetText l_PermissionLevel("Enter the permission level:");
CGetText l_PictureName("Enter the picture name:", FALSE);
if(l_PermissionLevel.DoModal()==IDCANCEL)
{
return;
}
if(l_PictureName.DoModal()==IDCANCEL)
{
return;
}
///////////////////////////////////////////////////////////////////////////////////////
//
bRet=PWRTCheckPermissionOnPicture(l_PermissionLevel.m_lNumber, l_PictureName.m_csText,
0, &err);
///////////////////////////////////////////////////////////////////////////////////////
//
if(bRet)
{
csOut.Format("Picture: \"%s\"\nLevel = %ld\n",
l_PictureName.m_csText,
l_PermissionLevel.m_lNumber);
m_pView->Print("PWRTCheckPermissionOnPicture\n", FSIZE_FUNCMARK, TRUE);
}
else
{
m_pView->PrintError(&err, "PWRTCheckPermissionOnPicture");
m_pView->PrintError("Access denied", "PWRTCheckPermissionOnPicture");
}
}

See also
PWRTCheckPermissionOnPicture (Page 2014)
3.5.8.3 Gets a string associated with the permission number (RT Professional)
Overview
//{{ODK_EXAMPLE}Gets a string associated with the permission number. (USE)}

//{{FUNCTION}PWRTPermissionToString (USE)}
//{{FUNCTION}(END)}
void CPWRTBunch::Pwrtpermissiontostring()
{
BOOL bRet;
CString csOut;
CString csPermLevName;
CGetText l_PermissionLevel("Insert the permission level number:");
if(l_PermissionLevel.DoModal()==IDOK)
{
///////////////////////////////////////////////////////////////////////////////////
//////
bRet=PWRTPermissionToString(l_PermissionLevel.m_lNumber,
csPermLevName.GetBuffer(1024), 1024);
///////////////////////////////////////////////////////////////////////////////////
//////
if(!bRet)
{
m_pView->Print("ERROR: ", FSIZE_FUNCMARK);
m_pView->Print("PWRTPermissionToString.\n", FSIZE_PARAMMARK, FALSE, TRUE);
return;
}
csOut.Format("PWRTPermissionToString( %ld, buffer )\n",
l_PermissionLevel.m_lNumber);
m_pView->Print(csOut, FSIZE_FUNCMARK, TRUE);
m_pView->Print("Permission level name:\n", FSIZE_PARAMMARK, FALSE, TRUE);
csOut.Format("buffer = \"%s\"\n", csPermLevName);
}
}
See also
PWRTPermissionToString (Page 2017)

3.5.8.4 Authorization level query through a dialog with specifying a possible error (RT
Professional)
Example
//{{ODK_EXAMPLE}Permission level query through a dialog with specifying a possible error.

(USE)}
//{{FUNCTION}PWRTPermissionLevelDialogEx (USE)}
//{{FUNCTION}(END)}
void CPWRTBunch::PWRTxPermissionLevelDialogEx()
{
long lLevel;
CMN_ERROR err;
CString csOut;
///////////////////////////////////////////////////////////////////////////////////////
//
lLevel=PWRTPermissionLevelDialogEx(*m_pView, &err);
///////////////////////////////////////////////////////////////////////////////////////
//
if(m_pView->PrintError(&err, "PWRTPermissionLevelDialogEx"))
{
m_pView->Print("lLevel = PWRTPermissionLevelDialogEx(...)\n", FSIZE_FUNCMARK, TRUE);
m_pView->Print("Permission level number chosen:\n", FSIZE_PARAMMARK, FALSE, TRUE);
csOut.Format("lLevel = %ld\n", lLevel);
}
}
See also
PWRTPermissionLevelDialogEx (Page 2016)

3.5.8.5 Return the name of the current user (RT Professional)
Example
//{{ODK_EXAMPLE}Return the name of the current user. (USE)}

//{{FUNCTION}PWRTGetCurrentUser (USE)}
//{{FUNCTION}(END)}
void CPWRTBunch::Pwrtgetcurrentuser()
{
BOOL bRet;
CString csUsername;
CString csOut;
///////////////////////////////////////////////////////////////////////////////////////
//
bRet=PWRTGetCurrentUser(csUsername.GetBuffer(1024), 1023);
///////////////////////////////////////////////////////////////////////////////////////
//
if(!bRet)
{
m_pView->Print("ERROR: ", FSIZE_FUNCMARK, TRUE);
m_pView->Print("PWRTGetCurrentUser.\n", FSIZE_PARAMMARK, FALSE, TRUE);
m_pView->Print("Failed to get current user's name.\n", FSIZE_SUBMARK);
return;
}
m_pView->Print("PWRTGetCurrentUser\n", FSIZE_FUNCMARK, TRUE);
m_pView->Print("Current user's name:\n", FSIZE_PARAMMARK, FALSE, TRUE);
csOut.Format("Name = \"%s\"\n", csUsername);
}
See also
PWRTGetCurrentUser (Page 2018)

3.5.8.6 Queries the current logon priority (RT Professional)
Example
//{{ODK_EXAMPLE}Queries the current login priority. (USE)}

//{{FUNCTION}PWRTGetLoginPriority (USE)}
//{{FUNCTION}(END)}
void CPWRTBunch::Pwrtgetloginpriority()
{
long lPriority;
CString csOut;
CMap<long, LONG, CString, CString> l_map(3);
l_map[LOGIN_STANDARD]=CString("LOGIN_STANDARD");
l_map[LOGIN_CARD]=CString("LOGIN_CARD");
l_map[LOGIN_KEYSWITCH]=CString("LOGIN_KEYSWITCH");
///////////////////////////////////////////////////////////////////////////////////////
//
lPriority=PWRTGetLoginPriority();
///////////////////////////////////////////////////////////////////////////////////////
//
if(lPriority!=-1)
{
m_pView->Print("PWRTGetLoginPriority\n", FSIZE_FUNCMARK, TRUE);
m_pView->Print("Priority returned:\n", FSIZE_PARAMMARK, FALSE, TRUE);
csOut.Format("Priority level = %s\n", l_map[lPriority]);
}
}
See also
PWRTGetLoginPriority (Page 2019)
3.5.8.7 Checks if the user has been logged on by card (RT Professional)
Overview

//{{ODK_EXAMPLE}Checks for the user has been logged on by card. (USE)}

//{{FUNCTION}PWRTIsLoggedInByCard (USE)}
//{{FUNCTION}(END)}
void CPWRTBunch::Pwrtisloggedinbycard()
{
BOOL bRet;
CString csOut;
///////////////////////////////////////////////////////////////////////////////////////
//
bRet=PWRTIsLoggedInByCard();
///////////////////////////////////////////////////////////////////////////////////////
//
if(bRet)
{
m_pView->Print("PWRTIsLoggedInByCard\n", FSIZE_FUNCMARK, TRUE);
m_pView->Print("An user show-up logged in by card.\n", FSIZE_PARAMMARK, FALSE, TRUE);
}
else
{
m_pView->PrintError(_T("Either no user logged-on-by-card or no user logged on at
all."),
_T("PWRTIsLoggedInByCard()"));
}
}
See also
PWRTIsLoggedInByCard (Page 2020)

3.5.8.8 PWRT login - dialog provided by WinCC itself (RT Professional)
Example
//{{ODK_EXAMPLE} PWRT login - dialog provided by WinCC intself. (USE)}

//{{FUNCTION}PWRTLogin (USE)}
//{{FUNCTION}(END)}
void CPWRTBunch::PWRTxLogin()
{
BOOL bRet;
///////////////////////////////////////////////////////////////////////////////////////
//
bRet=PWRTLogin(_T('1')); // it always appears on the first screen
///////////////////////////////////////////////////////////////////////////////////////
//
if(!bRet)
{
m_pView->Print("PWRTLogin.\n", FSIZE_PARAMMARK, FALSE, TRUE);
m_pView->Print("General function failure.\n", FSIZE_SUBMARK);
return;
}
m_pView->Print("PWRTLogin\n", FSIZE_FUNCMARK, TRUE);
m_pView->Print("Logging on...\n", FSIZE_PARAMMARK, FALSE, TRUE);
}
See also

3.5.8.9 PWRT logoff (RT Professional)
Example
//{{ODK_EXAMPLE}PWRT logout. (USE)}

//{{FUNCTION}PWRTLogout (USE)}
//{{FUNCTION}(END)}
void CPWRTBunch::Pwrtlogout()
{
BOOL bRet;
///////////////////////////////////////////////////////////////////////////////////////
//
bRet=PWRTLogout(); // it appears on the first screen
///////////////////////////////////////////////////////////////////////////////////////
//
if(!bRet)
{
m_pView->Print("PWRTLogout.\n", FSIZE_PARAMMARK, FALSE, TRUE);
m_pView->Print("General function failure.\n", FSIZE_SUBMARK);
return;
}
m_pView->Print("PWRTLogout\n", FSIZE_FUNCMARK, TRUE);
m_pView->Print("Logging out...\n", FSIZE_PARAMMARK, FALSE, TRUE);
}
See also
PWRTLogout (Page 2023)

3.5.8.10 Silent logoff with priority level (RT Professional)
Example
//{{ODK_EXAMPLE}Silent logout with priority level. (USE)}

//{{FUNCTION}PWRTLogoutEx (USE)}
//{{FUNCTION}(END)}
void CPWRTBunch::PWRTxLogoutEx()
{
BOOL bRet;
CString csOut;
CGetText l_PriorityLevel("The priority level:");
if(l_PriorityLevel.DoModal()==IDCANCEL)
{
return;
}
///////////////////////////////////////////////////////////////////////////////////////
//
bRet=PWRTLogoutEx( l_PriorityLevel.m_lNumber);
///////////////////////////////////////////////////////////////////////////////////////
//
if(!bRet)
{
m_pView->PrintError( _T("Cannot logout."),
_T("PWRTLogoutEx"));
}
else
{
m_pView->Print("PWRTLogoutEx\n", FSIZE_FUNCMARK, TRUE);
m_pView->Print("Logging out...\n", FSIZE_PARAMMARK, FALSE, TRUE);
csOut.Format("Priority level = %ld\n", l_PriorityLevel.m_lNumber);
}
}
See also
PWRTLogoutEx (Page 2024)

3.5.8.11 Logon without using a dialog (RT Professional)
Example
//{{ODK_EXAMPLE}Logs on without using a dialog. (USE)}

//{{FUNCTION}PWRTSilentLogin (USE)}
//{{FUNCTION}(END)}
void CPWRTBunch::Pwrtsilentlogin()
{
BOOL bRet;
CPassdlg l_Password("Enter name and password:");
if(l_Password.DoModal() == IDCANCEL)
{
return;
}
///////////////////////////////////////////////////////////////////////////////////////
//
bRet=PWRTSilentLogin(l_Password.m_csUsername,
l_Password.m_csPassword);
///////////////////////////////////////////////////////////////////////////////////////
//
if(!bRet)
{
m_pView->PrintError( _T("Access denied or no Runtime project open."),
_T("PWRTSilentLogin"));
}
else
{
m_pView->Print("PWRTSilentLogin\n", FSIZE_FUNCMARK, TRUE);
}
}
See also

3.5.8.12 Silent logon with priority level (RT Professional)
Example
//{{ODK_EXAMPLE}Silent login with priority level. (USE)}

//{{FUNCTION}PWRTSilentLoginEx (USE)}
//{{FUNCTION}(END)}
void CPWRTBunch::Pwrtsilentloginex()
{
BOOL bRet;
CString csOut;
CPassdlg l_Password("Enter name and password:");
CGetText l_PriorityLevel("Enter priority level:");
if(l_Password.DoModal()==IDCANCEL)
{
return;
}
if(l_PriorityLevel.DoModal()==IDCANCEL)
{
return;
}
///////////////////////////////////////////////////////////////////////////////////////
//
bRet=PWRTSilentLoginEx(l_Password.m_csUsername, l_Password.m_csPassword,
l_PriorityLevel.m_lNumber);
///////////////////////////////////////////////////////////////////////////////////////
//
if(!bRet)
{
m_pView->PrintError( _T("Access denied or no Runtime project open."),
_T("PWRTSilentLogin"));
}
else
{
m_pView->Print("PWRTSilentLogin\n", FSIZE_FUNCMARK, TRUE);
csOut.Format("Priority level = %ld\n", l_PriorityLevel.m_lNumber);
}
}
See also

3.6 Functions of the text system (RT Professional)
Declaration
TXT_ENUM_INFOTEXTS_PROC (Page 2052) List info texts (callback)

TXT_ENUM_LANGUAGES_PROC (Page 2059) List configured languages (callback)
TXTCloseProject (Page 2043) Close text library
TXTEnumInfoText (Page 2050) List info texts
TXTEnumLanguages (Page 2058) List configured languages
TXTGetFont (Page 2061) Determine character set of a language
TXTGetMaxTextID (Page 2045) Determine text ID (maximum)
TXTOpenProject (Page 2046) Open text library
TXTRTConnect (Page 2047) Keep connection to text server
TXTRTDisconnect (Page 2048) Connection to the text server released
TXTRTGetInfoText (Page 2054) Read info texts
TXTRTGetInfoTextMC (Page 2056) Read info texts from text server
TXTRTGetLanguageID (Page 2064) Determine activated language
TXTRTSetLanguage (Page 2065) Language switch for error message texts
TXTShowLanguagesDialog (Page 2062) Display languages (installed)
TXTUpdateRuntime (Page 2053) Update info texts in runtime
Overview
structure:
TXT_SYS_ERROR (value: 0x10000000) If this bit is set in dwError1 of er‐

ror structure CMN_ERROR,
then dwError2 contains the sys‐
tem error code.
TXT_OK (value: 0x00000000) No error occurred.
TXT_NO_CONNECT (value: 0x00000001) The database is not yet open.
TXT_CONNECT (value: 0x00000002) Error while connecting to the da‐
tabase.
TXT_UPDATE (value: 0x00000003) Error while writing to the data‐
base.

TXT_CREATE_KEY (value: 0x00000004) The TextID could not be created.

TXT_KEY_NOT_FOUND (value: 0x00000005) The specified TextID could not
be found.
TXT_LAN‐ (value: 0x00000006) The specified language could
GUAGE_NOT_FOUND not be found.
TXT_NO_NEW_RECORD (value: 0x00000007) A new record could not be cre‐
ated (AddRecord generated an
error)
TXT_FONT_NOT_FOUND (value: 0x00000008) Font not found
TXT_TABLE_NOT_FOUND (value: 0x00000009) A database table was not found.
The dwError2 field contains
more detailed information:
TXTVERSIONINFO (value: 0x00000001) Version info table was not found.
TXTLANGUAGES (value: 0x00000002) Language table was not found.
TXTTABLE (value: 0x00000003) Text table was not found.
TXT_WRONG_PROJECT (value: 0x00000010) Wrong project name
TXT_OPEN (value: 0x00000011) Database could not be loaded.
TXT_PARAM (value: 0x00000012) Invalid parameter
TXT_DISCONNECT (value: 0x00000013) Error logging off of the database
TXT_CALLBACK (value: 0x00000014) Callback returned FALSE
TXT_ALREADY_FOUND (value: 0x00000015) Text already exists
TXT_CREATE (value: 0x00000016) Database tables could not be
created.
TXT_UPDATE_RUNTIME (value: 0x00000017) Runtime not found, or SendMes‐
sage returned NULL.
TXT_ALREADY_EXIST (value: 0x00000018) Language already exists
TXT_NO_LANGUAGE (value: 0x00000019) Invalid language specified
TXT_TEXT_LIBRARY_RUN‐ (value: 0x00000020) TEXTBIB.EXE already running;
NING opening not allowed
TXT_TABLES_ALREADY_EX‐ (value: 0x00000021) Database tables already exist.
IST Creating no longer allowed.
Text Library RT
TXT_RT_OK (value: 0x00000000) No error

TXT_RT_OPEN_MMF (value: 0x00000001) Error while opening the memory
mapped file
TXT_RT_CREATE_SERV‐ (value: 0x00000002) Error while creating the service
ICE_WINDOW window
TXT_RT_KEY_NOT_FOUND (value: 0x00000003) TextID not found
TXT_RT_NO_READ_ACCESS (value: 0x00000004) Read access to the memory
mapped file denied
TXT_RT_NO_LAN‐ (value: 0x00000005) No language found
GUAGE_FOUND
TXT_RT_LAN‐ (value: 0x00000006) Language not found
GUAGE_NOT_FOUND
TXT_RT_INTERNAL_ERROR (value: 0x00000007) Internal fault

TXT_RT_INVALIDPARAM (value: 0x00000008) Parameter error

TXT_RT_NODEFAULTSERVER (value: 0x00000011) No default server is configured.
TXT_RT_NOLOCALSERVER (value: 0x00000012) No local server is available.
TXT_RT_NOSERVER (value: 0x00000013) No default server is configured,
and no local server is available.
TXT_RT_NOMC (value: 0x00000014) This is not a multiclient project
(not used here)
TXT_RT_NOMCDEFAULT‐ (value: 0x00000015) This is not a multiclient project,
SERVER but "@default" was given as a
server prefix.
3.6.1.3 Language codes (RT Professional)
Language codes of the text system

Only the SUBLANG_DEFAULT languages of Windows are supported in WinCC. As a result,
the the following values can be assigned to the dwLocaleID parameter:
LANG_ARABIC 0x0401
LANG_BASQUE 0x042D
LANG_BELARUSIAN 0x0423
LANG_CATALAN 0x0403
LANG_CHINESE 0x0804
LANG_CZECH 0x0405
LANG_DANISH 0x0406
LANG_DUTCH 0x0413
LANG_ENGLISH 0x0409
LANG_FARSI 0x0429
LANG_FINNISH 0x040B
LANG_FRENCH 0x040C
LANG_GERMAN 0x0407
LANG_GREEK 0x0408
LANG_HEBREW 0x040D
LANG_HUNGARIAN 0x040E
LANG_ICELANDIC 0x040F
LANG_ITALIAN 0x0410
LANG_KOREAN 0x0412

LANG_LATVIAN 0x0426
LANG_NORWEGIAN 0x0414
LANG_POLISH 0x0415
LANG_PORTUGUESE 0x0416
LANG_RUSSIAN 0x0419
LANG_SLOVAK 0x041B
LANG_SPANISH 0x040A
LANG_SWEDISH 0x041D
LANG_THAI 0x041E
LANG_TURKISH 0x041F
Here, the upper 4 bytes (0x04..) designate the language as SUBLANG_DEFAULT language
3.6.2.1 TXTCloseProject (RT Professional)
Description
Closes the project database upon successful execution.
Declaration
BOOL TXTCloseProject (
Parameters
lpszProjectFile
Pointer to the name of the project file including path and extension.
lpdmError

Return value
TRUE
Text library closed.
FALSE
Error
Comment
The TXTOpenProject function increments an internal reference counter with each call. This
counter is decremented with call of TXTCloseProject. The text library is closed only when the
reference counter returns to 0.
Therefore, the same number of TXTCloseProject must always be called, otherwise an
exception error will occur when the application closes.
Note
program.
Error messages
TXT_DISCONNECT Error logging off of the database
Required files
text_cs.h
text_cs.lib
text_cs.dll
Related functions
TXTOpenProject (Page 2046) Opens the text library
Examples
Get infotext (Page 2067) "TX01.cpp"
Enumerate infotexts (Page 2069) "TX01.cpp"

See also
TXTOpenProject (Page 2046)
Get infotext (Page 2067)
Enumerate infotexts (Page 2069)
3.6.2.2 TXTGetMaxTextID (RT Professional)
Description
Records the highest text ID that is kept in the DLL.
Declaration
BOOL TXTGetMaxTextID (
LPLONG lplMaxTextID,
Parameters
lplMaxTextID
Pointer to the buffer in which the text ID should be stored.
lpdmError
Return value
TRUE
Maximum text ID determined
FALSE
Error
Required files
text_cs.h
text_cs.lib
text_cs.dll

See also
3.6.2.3 TXTOpenProject (RT Professional)
Description
Opens the database upon successful execution.
Declaration
BOOL TXTOpenProject (
LPCTSTR lpszDSNName,
BOOL fExclusive,
Parameters
lpszProjectFile
lpszDSNName
Pointer on the name of the data source.
fExclusive
If TRUE, TEXTBIB.EXE cannot be started, because another program is accessing the text
library, for example. If TEXTBIB.EXE has already started, the call is rejected.
lpdmError
Return value
TRUE
Database open
FALSE
Error
Comment
If no text library tables are available, they are generated new.

Each time the function called a reference counter is incremented. The same number as
TXTCloseProject must be present to close. Otherwise, an exception error can occur when the
application closes.
Error messages
TXT_CONNECT Error connecting to the database.

TXT_TABLE_NOT_FOUND A database table was not found. The dwError2 field contains
more detailed information:
TXT_TEXT_LIBRARY_RUNNING TEXTBIB.EXE has already started
TXT_WRONG_PROJECT Wrong project name
Required files
text_cs.h
text_cs.lib
text_cs.dll
Related functions
TXTCloseProject (Page 2043) Closes the text library
Examples
See also
TXTCloseProject (Page 2043)
3.6.2.4 TXTRTConnect (RT Professional)
Description
Establishes a connection to the text server. This function accelerates the execution of TXTRT
functions. The connection to the text server is then not made for each call and closed again
at the end.

Declaration
BOOL TXTRTConnect ( );
Parameters
None
Return value
TRUE
Connects to the text server established
FALSE
Error
Comment
Before closing the application, the connection must always be closed with TXTRTDisconnect
to avoid subsequent malfunction in the system.
Required files
text_rt.h
text_rt.lib
text_rt.dll
Related functions
TXTRTDisconnect (Page 2048) Connection to the text server released
See also
TXTRTDisconnect (Page 2048)
3.6.2.5 TXTRTDisconnect (RT Professional)
Description
Closes a connection to the text server that was made with TXTRTConnect.

Declaration
BOOL TXTRTDisconnect ( );
Parameters
None
Return value
TRUE
Connects to the text server established
Comment
This function stops the acceleration provided by the TXTRT functions and always returns
TRUE.
Subsequently called TXTRT functions then establish a new connection to the text server for
each call and then close it.
If TXTRTConnect is used and no TXTRTDisconnect is executed before closing the application,
a malfunction may subsequently occur in the system.
Note
program.
Required files
text_rt.h
text_rt.lib
text_rt.dll
Related functions
TXTRTConnect (Page 2047) Keep connection to text server
See also
TXTRTConnect (Page 2047)

3.6.3 Functions for processing infotext (RT Professional)
3.6.3.1 TXTEnumInfoText (RT Professional)
Description
Lists all infotext that meets the filter criterion in lpszFilter.
Declaration
BOOL TXTEnumInfoText (
DWORD dwLocale,
LPDWORD lpdwItems,
LPCTSTR lpszFilter,
TXT_ENUM_INFOTEXTS_PROC lpfnEnum,
LPVOID lpvUser,
Parameters
lpszProjectFile
dwLocale
Language code of the language, the infotext of which should be enumerated.
lpdwItems
Pointer to a double word of the application, which contains the number of enumerated infotexts
after the call.
lpszFilter
Pointer to the condition of an SQL statement for the LIKE operator.
lpfnEnum
Your callback function that receives the infotext.
lpvUser
lpdmError

Return value
TRUE
Infotext listed
FALSE
Error
Comment
If lpszFilter == NULL or an empty string is passed, all infotexts of the language are enumerated.
Empty, unassigned info texts can also be enumerated and included using lpdwItems.
Error messages
TXT_CALLBACK Callback returns FALSE

TXT_LANGUAGE_NOT_FOUND The specified language could not be found.
TXT_NO_CONNECT The database is not yet open.
TXT_NO_LANGUAGE Invalid language specified
Required files
text_cs.h
text_cs.lib
text_cs.dll
Related functions
TXT_ENUM_INFOTEXTS_PROC (Page 2052) List infotext (callback)
Examples
See also
TXT_ENUM_INFOTEXTS_PROC (Page 2052)

3.6.3.2 TXT_ENUM_INFOTEXTS_PROC (RT Professional)
Description
In order to evaluate the listed tool tips, you must provide a TXT_ENUM_INFOTEXTS_PROC
type callback function.
Declaration
BOOL ( * TXT_ENUM_INFOTEXTS_PROC) (
DWORD dwTextID,
LPCTSTR lpszInfoText,
LPVOID lpvUser );
Parameters
dwTextID
ID of the text to which lpszInfotext refers.
lpszInfoText
Pointer to the tool tip that was transferred by the calling function.
lpvUser
function.
Return value
TRUE
The enumeration is continued
FALSE
The enumeration is cancelled
Comment
Note

Required files
text_cs.h
text_cs.lib
text_cs.dll
Related functions
TXTEnumInfoText (Page 2050) List infotext
Examples
See also
TXTEnumInfoText (Page 2050)
3.6.3.3 TXTUpdateRuntime (RT Professional)
Description
The text from the text library are reloaded in runtime.
Declaration
BOOL TXTUpdateRuntime (
HWND hwndParent,
Parameters
lpszProjectFile
hwndParent
Handle to the parent window

lpdmError
Return value
TRUE
Infotext updated
Comment
No update is performed for text reference tags. The function always returns TRUE.
Required files
text_cs.h
text_cs.lib
text_cs.dll
See also
3.6.3.4 TXTRTGetInfoText (RT Professional)
Description
Upon successful execution, this function fills the buffer passed to lpszBuffer with the text
described by dwTextID. If the passed buffer is smaller than the text length (buffer length in
characters in pdwSize), the text is accordingly truncated. The return value is still TRUE. If NULL
is passed in lpszBuffer, the function determines the required buffer size and stores it in pdwSize.
Declaration
BOOL TXTRTGetInfoText (
DWORD dwTextID,
LPTSTR lpszBuffer,
LPDWORD pdwSize,

Parameters
dwTextID
ID of the text to be read
lpszBuffer
Pointer to a buffer in which the infotext should be stored.
pdwSize
Pointer to the DWORD, which contains the buffer size
lpdmError
Return value
TRUE
Infotext determined
FALSE
Error
Comment
Error messages
TXT_RT_OPEN_MMF Error while opening the memory mapped file

TXT_RT_CREATE_SERVICE_WINDOW Error while creating the service window
TXT_KEY_NOT_FOUND The specified TextID could not be found.
TXT_RT_NO_READ_ACCESS Read access to the memory mapped file denied
Required files
text_rt.h
text_rt.lib
text_rt.dll
Related functions
AUTOHOTSPOT Read tool tips from the text server

Examples
See also
3.6.3.5 TXTRTGetInfoTextMC (RT Professional)
Description
Fetches a text, for example, a tooltip from the specified text server or from the C text list. Upon
successful execution, this function fills the buffer passed to lpszBuffer with the text described
by dwTextID. If the passed buffer is smaller than the text length (buffer length in characters in
pdwSize), the text is accordingly truncated. The return value is still TRUE. If NULL is passed
in lpszBuffer, the function determines the required buffer size and stores it in pdwSize.
Declaration
BOOL TXTRTGetInfoTextMC (
DWORD dwTextID,
LPTSTR lpszBuffer,
LPDWORD pdwSize,
LPTSTR lpszServer,
Parameters
dwTextID
ID of the text to be read
lpszBuffer
Pointer to a buffer in which the infotext should be stored.
pdwSize
Pointer to the DWORD, which contains the buffer size
lpszServer
Pointer to the symbolic name of the text server (without server delimiter :: )
lpdmError

Return value
TRUE
Infotext determined
FALSE
Error
Comment
This function only works with multiclient projects
Error messages

TXT_KEY_NOT_FOUND The specified TextID could not be found.
TXT_RT_NO_READ_ACCESS Read access to the memory mapped file denied
TXT_RT_NODEFAULTSERVER No default server is configured.
TXT_RT_NOLOCALSERVER No local server is available.
TXT_RT_NOSERVER No default server is configured and no local server is
available.
TXT_RT_NOMCDEFAULTSERVER This is not a multiclient project, but "@default" was given
as a server prefix.
Required files
text_rt.h
text_rt.lib
text_rt.dll
Related functions
AUTOHOTSPOT Read tool tips
See also

3.6.4 Functions for processing languages (RT Professional)
3.6.4.1 TXTEnumLanguages (RT Professional)
Description
Calls the passed callback function for all configured languages.
Declaration
BOOL TXTEnumLanguages (
LPDWORD lpdwItems,
TXT_ENUM_LANGUAGES_PROC lpfnEnum,
LPVOID lpvUser,
Parameters
lpszProjectFile
lpdwItems
Pointer to a double word of the application, which contains the number of enumerated
languages after the call.
lpfnEnum
Your callback function that receives the configured languages.
lpvUser
lpdmError
Return value
TRUE
Configured languages listed
FALSE
Error

Error messages

Required files
text_cs.h
text_cs.lib
text_cs.dll
Related functions
TXT_ENUM_LANGUAGES_PROC (Page 2059) List configured languages (callback)
Examples
See also
TXT_ENUM_LANGUAGES_PROC (Page 2059)
3.6.4.2 TXT_ENUM_LANGUAGES_PROC (RT Professional)
Description
In order to evaluate the listed languages, you must provide a
TXT_ENUM_LANGUAGES_PROC type callback function.
Declaration
BOOL ( * TXT_ENUM_LANGUAGES_PROC) (
DWORD dwLocaleID,
LPCTSTR lpszName,
LPVOID lpvUser );

Parameters
dwLocaleID
Language code
lpszName
Pointer to the name of the language.
lpvUser
function.
Return value
TRUE
FALSE
Comment
Note
Required files
text_cs.h
Related functions
TXTEnumLanguages (Page 2058) List configured languages
Examples

See also
TXTEnumLanguages (Page 2058)
3.6.4.3 TXTGetFont (RT Professional)
Description
Upon successful execution, fills the LOGFONT structure passed in lplf with the font set for the
desired language.
Declaration
BOOL TXTGetFont (
DWORD dwLocale,
LPLOGFONT lplf,
Parameters
lpszProjectFile
dwLocale
Language code of the language, the font of which should be fetched
lplf
Pointer to a Windows-specific LOGFONT type structure with information about a character set.
lpdmError
Return value
TRUE
Character set determined
FALSE
Error

Error messages

TXT_NO_LANGUAGE Invalid language specified
TXT_LANGUAGE_NOT_FOUND The specified language could not be found.
Required files
text_cs.h
text_cs.lib
text_cs.dll
See also
3.6.4.4 TXTShowLanguagesDialog (RT Professional)
Description
Opens a dialog with the available languages. If the dialog is closed with "OK", the selected
language is stored in lpdwLocale. In addition, the corresponding font is passed in the
LOGFONT structure.

Declaration
BOOL TXTShowLanguagesDialog (
HWND hwndParent,
LPDWORD lpdwLocale,
LPLOGFONT lplf,
Parameters
lpszProjectFile
hwndParent
Handle to the parent window of the dialog box. The parameter is set to NULL by default.
dwLocale
Pointer to the code of the language to be installed.
lplf
Pointer to a Windows-specific LOGFONT type structure with information about a character set.
lpdmError
Return value
TRUE
Language selected
FALSE
Error or close dialog with "Cancel"
Comment
In order to offer the installed languages in the dialog box, the languages in the database are
enumerated by the function. If an error occurs, the TXT_CALLBACK error message is stored
in the error structure.

Error messages

Required files
text_cs.h
text_cs.lib
text_cs.dll
See also
3.6.4.5 TXTRTGetLanguageID (RT Professional)
Description
Upon successful executions, fills the buffer passed in lpchLanguageID with the primary
language ID loaded in the memory mapped file.
Declaration
BOOL TXTRTGetLanguageID (
LPBYTE lpchLanguageID,
Parameters
lpchLanguageID
Pointer to a buffer, in which the primary language ID should be stored.
lpdmError
Return value
TRUE
Activated language determined

FALSE
Error
Error messages

TXT_RT_NO_LANGUAGE_FOUND No language found
Required files
text_rt.h
text_rt.lib
text_rt.dll
See also
3.6.4.6 TXTRTSetLanguage (RT Professional)
Description
Sets the language for error messages. If the language is not available, the default language
(German) is set and FALSE is returned.
This function is no longer supported and always returns the value, TRUE.
Declaration
BOOL TXTRTSetLanguage (
DWORD dwLocaleID,
Parameters
dwLocaleID
Language code of the language to be set.
lpdmError

Return value
TRUE
Language of error messages switched
Required files
text_rt.h
text_rt.lib
text_rt.dll
See also

3.6.5.1 Get infotext (RT Professional)
Example
//{{ODK_EXAMPLE}Insert new Infotext (TXT)}

//{{FUNCTION}TXTOpenProject (TXT)}
//{{FUNCTION}TXTNewInfoText (TXT)}
//{{FUNCTION}TXTSetInfoText (TXT)}
//{{FUNCTION}TXTCloseProject (TXT)}
//{{FUNCTION}(END)}
// =====================================================================
// Function: MyTxtSetInfotext(void) ODK DM CS
// =====================================================================
// Abst. : Insert New Text
// =====================================================================
void MyTxtNewInfotext(void)
{
TCHAR szText[255];
CMN_ERROR Error;
BOOL ret = FALSE;
DWORD dwLocale = 0x0407; // german
TCHAR szFilter[]="S%"; // all texts with 'S'
DWORD dwSize =254;
DWORD dwTextID = 0;
ret = MyDMEnumOpenedProjects(); // open the DM and set the g_szProjectFile and
g_szDSNName
if(TRUE == ret)
{
ret = TXTOpenProject(g_szProjectFile, g_szDSNName, FALSE, &Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in TXTOpenProject:
E1= 0x%08lx ; E2= 0x%08lx ; %s"),
ODKTrace(szText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("TXTOpenProject"));
ODKTrace(szText);
dwTextID = 380;
dwLocale = 0x0407; // german
_tcsncpy_s(szText, _countof(szText), _T("NewInfoText_ODK"), _TRUNCATE);
ret = TXTGetInfoText(g_szProjectFile, dwTextID, dwLocale, szText, &dwSize,
&Error);
if(FALSE == ret)
{
TXTNewInfoText: E1= 0x%08lx ; E2= 0x%08lx ; %s"),


}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("TXTNewInfoText"));
}
ODKTrace(szText);
dwLocale=0x0409; // english
//dwTextID = 380; // use ID from TXTNewInfoText
_tcsncpy_s(szText, _countof(szText), _T("InfoText_ODK"), _TRUNCATE);
ret = TXTSetInfoText(g_szProjectFile, NULL, dwTextID, dwLocale, szText, &Error);
if(FALSE == ret)
{
TXTSetInfoText: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("TXTSetInfoText"));
}
ODKTrace(szText);
ret = TXTCloseProject(g_szProjectFile, &Error);
if(FALSE == ret)
{
TXTCloseProject: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("TXTCloseProject"));
ODKTrace(szText);
}
}
}
}
See also
TXTRTGetInfoText (Page 2054)

3.6.5.2 Enumerate infotexts (RT Professional)
Example
//{{ODK_EXAMPLE}Enumerate texts (TXT)}

//{{FUNCTION}TXTOpenProject (TXT)}
//{{FUNCTION}TXTCloseProject (TXT)}
//{{FUNCTION}TXTEnumLanguages (TXT)}
//{{FUNCTION}TXT_ENUM_LANGUAGES_PROC (TXT)}
//{{FUNCTION}TXTEnumInfoText (TXT)}
//{{FUNCTION}TXT_ENUM_INFOTEXTS_PROC (TXT)}
//{{FUNCTION}(END)}
// =====================================================================
// Function: MyTxtEnums(void) ODK DM CS
// =====================================================================
// Abst. : Enumerate Texts
// =====================================================================
BOOL MyTXTEnumLanguagesCallback (DWORD dwLocID, LPCTSTR lpszName, LPVOID lpvUser)

{
lpvUser;
TCHAR szText[255];
BOOL ret = TRUE;
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" InfoLang: ID=%x ;
ODKTrace(szText);
return(ret);
}
BOOL MyTXTEnumInfotextsCallback(DWORD dwTextID, LPCTSTR lpszInfoText, LPVOID lpvUser)

{
lpvUser;
TCHAR szText[255];
BOOL ret = TRUE;
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" InfoText: ID=%.4d ; Tx=%s "),
dwTextID, lpszInfoText);
ODKTrace(szText);
return(ret);
}
void MyTxtEnums(void)
{
TCHAR szText[255];
CMN_ERROR Error;
BOOL ret = FALSE;
DWORD dwLocale = 0x0407; // german
DWORD dwItems = 0;
DWORD dwUser = 0;
TCHAR szFilter[]="S%"; // all texts with 'S'
//DWORD dwSize =254;
ret = MyDMEnumOpenedProjects(); // open the DM and set the g_szProjectFile and
g_szDSNName
if(TRUE == ret)
{

ret = TXTOpenProject(g_szProjectFile, g_szDSNName, FALSE, &Error);

if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in TXTOpenProject:
E1= 0x%08lx ; E2= 0x%08lx ; %s"),
ODKTrace(szText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("TXTOpenProject"));
ODKTrace(szText);
dwItems = 0;
ret = TXTEnumLanguages(g_szProjectFile, &dwItems, MyTXTEnumLanguagesCallback,
&dwUser, &Error);
if(FALSE == ret)
{
TXTOpenProject: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
ODKTrace(szText);
}
dwItems = 0;
ret = TXTEnumInfoText(g_szProjectFile, dwLocale, &dwItems, szFilter,
MyTXTEnumInfotextsCallback, &dwUser, &Error);
if(FALSE == ret)
{
TXTEnumInfoText: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
ODKTrace(szText);
}
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("TXTEnumInfoText: NItems=
%d ; LANG=%x ; Filter=%s "),
dwItems, dwLocale, szFilter);
ODKTrace(szText);
ret = TXTCloseProject(g_szProjectFile, &Error);
if(FALSE == ret)
{
TXTCloseProject: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
ODKTrace(szText);
}
}
}
}

3.7 Report system functions (RT Professional)
See also
TXTEnumInfoText (Page 2050)
TXT_ENUM_INFOTEXTS_PROC (Page 2052)
TXT_ENUM_LANGUAGES_PROC (Page 2059)
TXTEnumLanguages (Page 2058)
Overview
RPJAttach (Page 2083) Establish connection

RPJCallJobMethod (Page 2106) Call print job method
RPJCreateJob (Page 2093) Create a print job
RPJCreatePropertyHandle (Page 2096) Create handle of a print job property
RPJDeleteJob (Page 2094) Delete print job
RPJDeletePropertyHandle (Page 2097) Delete handle of a print job property
RPJDetach (Page 2084) Disconnect connection
RPJGetJobMethodAt (Page 2107) Determine name of print job method
RPJGetJobNameAt (Page 2099) Determine name of print job
RPJGetJobPropertyAt (Page 2109) Determine name of print job properties
RPJGetJobProps (Page 2111) Determine print job properties
RPJGetNumJobMethods (Page 2108) Determine number of print job methods
RPJGetNumJobProperties (Page 2112) Determine number of print job properties
RPJGetNumJobs (Page 2100) Determine number of print jobs
RPJGetNumProjectProperties (Page 2086) Determine number of properties in the project
RPJGetProjectPropertyAt (Page 2087) Determine property name and type in the project
using an index
RPJGetProjectProperty (Page 2088) Determine value of the property in the project
RPJGetProperty (Page 2113) Determine print job property
RPJJobLock (Page 2101) Lock print job against other accesses
RPJJobUnlockAll (Page 2104) Remove all print job locks
RPJJobUnlock (Page 2103) Remove a print job lock
RPJMemFree (Page 2085) Free memory

RPJProjectLock (Page 2089) Lock access to the print job list in the project
RPJProjectUnlockAll (Page 2092) Remove all print job list locks in the project
RPJProjectUnlock (Page 2091) Remove a print job list lock in the project
RPJPropertyClear (Page 2116) Delete handle of a print job property
RPJSetProperty (Page 2117) Specify print job properties
Properties for layouts (CS)

Root
● ObjectName
● Context
Geometry
● Left
● Top
● Width
● Height
● RoundCornerWidth
● RoundCornerHeight
● StartAngle
● EndAngle
● Radius
● RadiusWidth
● RadiusHeight
● Columns
● Index
● PointCount
● ActualPointLeft
● ActualPointTop
● PaperSize
● Orientation
● DynMarginLeft
● DynMarginRight
● DynMarginTop
● DynMarginBottom
● PrintMarginLeft

● PrintMarginRight
● PrintMarginTop
● PrintMarginBottom
Styles
● BorderStyle
● BorderWidth
● FillStyle
Colors
● BorderBackColor
● BorderColor
● BackColor
● FillColor
● ForeColor
Characters
● FontName
● FontSize
● FontBold
● FontItalic
● FontUnderline
● Text
● AlignmentLeft
● AlignmentTop
● WordWrap
Miscellaneous
● FirstPage
● LastPage
● MetaFileName
● LayoutFileName
● Format
● List
● Tag
● DataType
● OutFormat
● Calculation
● PageBreak

Properties for print jobs
AbsoluteSelectionFrom
AbsoluteSelectionTo
CycleSpan
DestinationFile
EnableCycle
EnableStart
EndPage This information enables you to end the printout
of the report at a particular page.
JobName The name of the print job must be unique within
a project and conform to the Windows conventions.
LayoutName You can assign the print job a layout using the
layout name.
PrinterName 1 Here, you specify the printer to which the printout
is initially sent.
PrinterName 2 Here, you specify the printer to be used if the first
printer is not available.
PrinterName 3 Here, you specify the printer to be used if the first
two printers are not available.
RelativeSelectionCount
RelativeSelectionRange
StartPage This information enables you to start the printout
of the report at a particular page.
StartTime
UseRelative
UseOutputFile
UseOutputPrinter
Overview
structure:
Error messages of CS
ERR_NOERROR 0 No error
ERR_ILLEGALPROJECT 1 Invalid project name/project path
ERR_NOMEMORY 2 Memory error
ERR_UNKNOWNERROR 3 Unknown error
ERR_THREADNOTINITIALIZED 4 The utilized thread is not initialized.
ERR_OLEEXCEPTION 5 Error in conjunction with the MFC and OLE
ERR_NOOLESERVERAVAIL 6 No OLE-Server available

Error messages of RT
ERR_NOERROR 0 No error
ERR_ILLEGALPROJECT 1 Invalid project name/project path
ERR_NOMEMORY 2 Memory error
ERR_UNKNOWNERROR 3 Unknown error
ERR_NULLHANDLE 4 Handle could not be created.
ERR_ILLEGALPOINTER 5 Pointer is incorrect or invalid
ERR_ILLEGALJOBINDEX 6 Print job index is incorrect
ERR_UNKNOWNPROPERTY 7 Print job property is unknown
ERR_UNKNOWNMETHOD 8 Print job method is unknown
3.7.1.4 List of object properties (RT Professional)
Properties for all objects
Note
The property names along with a basic description can also be obtained via the context-
sensitive help. To access this, right-click inside the properties box for the relevant object in the
Report Designer.
Property name Data type

"Width" VT_I4
"Height" VT_I4
"ObjectName" VT_BSTR
"PageBreak" VT_I4
"BorderStyle" VT_I4
"BorderWidth" VT_I4
"BorderBackColor" VT_I4
"BorderColor" VT_I4
"Left" VT_I4
"Top" VT_I4
Properties for all "2-dimensional objects":
"FillStyle" VT_I4
"BackColor" VT_I4
"FillColor" VT_I4

Properties for "dynamic objects":
"DataLink" VT_BSTR
The following properties are object-specific!
Properties for all "system" objects:
Property name Data type

"FontName" VT_BSTR
"FontSize" VT_I4
"FontBold" VT_I4
"FontItalic" VT_I4
"FontUnderline" VT_I4
"Format" VT_BSTR
"AlignmentLeft" VT_I4
"AlignmentTop" VT_I4
"WordWrap" VT_I4
Properties for "dynamic tables":
"FontName" VT_BSTR
"FontSize" VT_I4
"FontBold" VT_I4
"FontItalic" VT_I4
"Orientation" VT_I4
"Columns" VT_BSTR
"ForeColor" VT_I4
"List" VT_I4
Properties for "dynamic texts":
"FontName" VT_BSTR
"FontSize" VT_I4
"FontBold" VT_I4
"FontItalic" VT_I4
"Orientation" VT_I4

"WordWrap" VT_I4
"ForeColor" VT_I4
Properties for "dynamic picture":
"DynHeight" VT_I4
Properties for "circular arc":
"Radius" VT_I4
"StartAngle" VT_I4
"EndAngle" VT_I4
Properties for "elliptical arc":
"StartAngle" VT_I4
"EndAngle" VT_I4
"RadiusWidth" VT_I4
"RadiusHeight" VT_I4
Properties for "circles":
"Radius" VT_I4
Properties for "ellipses":
"RadiusWidth" VT_I4
Properties for "polygons":
"Polyline" VT_BSTR
"PointCount" VT_I4
"Index" VT_I4
"ActualPointLeft" VT_I4
"ActualPointTop" VT_I4

Properties for "circle segments":
"Radius" VT_I4
"StartAngle" VT_I4
"EndAngle" VT_I4
Properties for "ellipse segments":
"StartAngle" VT_I4
"EndAngle" VT_I4
"RadiusWidth" VT_I4
Properties for "polyline":
"Polyline" VT_BSTR
"PointCount" VT_I4
"Index" VT_I4
"ActualPointLeft" VT_I4
"ActualPointTop" VT_I4
Properties for "rounded rectangle":
"RoundCornerWidth" VT_I4
"RoundCornerHeight" VT_I4
Properties for "text objects":
"FontName" VT_BSTR
"FontSize" VT_I4
"FontBold" VT_I4
"FontItalic" VT_I4
"Orientation" VT_I4
"Text" VT_BSTR
"WordWrap" VT_I4
"ForeColor" VT_I4

Properties for "inserted layouts":
"LayoutFileName" VT_BSTR
Properties for "layouts":
"PrintMarginLeft" VT_I4
"PrintMarginRight" VT_I4
"PrintMarginTop" VT_I4
"PrintMarginBottom" VT_I4
"PaperSize" VT_BSTR
"FirstPage" VT_I4
"LastPage" VT_I4
"Orientation" VT_I4
"Printer1" VT_BSTR
"Printer2" VT_BSTR
"Printer3" VT_BSTR
"BackColor" VT_I4
"BorderColor" VT_I4
"FillColor" VT_I4
"DynMarginLeft" VT_I4
"DynMarginRight" VT_I4
"DynMarginTop" VT_I4
"DynMarginBottom" VT_I4
"Context" VT_BSTR
Properties for "MetaFiles":
"MetaFileName" VT_BSTR
Properties for "tag" objects:
"Tag" VT_BSTR
"FontSize" VT_I4
"FontName" VT_BSTR
"FontBold" VT_I4
"FontItalic" VT_I4
"WordWrap" VT_I4
"ForeColor" VT_I4
"OutFormat" VT_BSTR

"DataType" VT_I4
"Calculation" VT_VARIANT
3.7.1.5 General procedure for processing print job properties (Report Designer) (RT
Professional)
Establishing and initializing connection to RPJAPI.DLL

RPJAttach.
Creating a handle for print job properties

To process the properties of a print job, a print job handle must be created. This handle is used
to identify a memory area through which the print job properties can be addressed.
Function: RPJCreatePropertyHandle.
Reading print job properties

The properties of the print jobs are stored in the project database. To edit the properties, they
must be loaded from the database to the area specified by the handle.
Function: RPJGetJobProps.
Determining print job properties

A certain print job property is referenced using its name. To determine the value of a property,
it must be read.
Function: RPJGetProperty.
Specifying print job properties

A certain print job property is referenced using its name. To set the property, the
RPJSetProperty function is called.
Storing print job properties

The modified print job properties are stored in the project database. The name of the print job
to be stored must be specified.
Function: RPJSetJobProps.
Reinitializing a print job property

The memory area referenced by the handle is reinitialized without freeing the handle.
Function: RPJPropertyClear.

Specifying print job properties

A certain print job property is referenced using its name. The property is set by calling a function.
Function: RPJSetProperty.
Storing print job properties

The modified print job properties are stored in the project database. The name of the print job
to be stored must be specified.
Function: RPJSetJobProps.
Deleting a handle
A print job property handle is deleted. Delete each handle created with
RPJCreatePropertyHandle when it is no longer needed.
Function: RPJDeletePropertyHandle.
Terminating connection to RPJAPI.DLL

RPJDetach.
Example: Starting a print job in Print Preview
General
To process the properties of a print job, a print job handle must be provided. This handle is
used to identify a memory area through which the print job properties can be addressed.
Establishing and initializing connection to RPJAPI.DLL

RPJAttach.
Creating a handle: Function

RPJCreatePropertyHandle.
Reading in properties of the print job

The properties of the print job: "Control Center Redocumentation" are loaded from the
database to the area specified by the hProp.
Function: RPJGetJobProps.
Initiating print job method

The print job is initiated by specifying the PREVIEW method. The print job itself is specified
by the hProp.
Function: RPJCallJobMethod.
Deleting a handle
A print job property handle is deleted. Each handle created with RPJCreatePropertyHandle
should be deleted when it is no longer needed.

Function: RPJDeletePropertyHandle.
Terminating connection to RPJAPI.DLL

RPJDetach.
Example
void PrintJob(void)
{
CMN_ERROR err; //error structure
BOOL ret;
HPROPERTIES hProp;
char jobname[200];
char method[200];
LPCSTR szProjectName = "c:\\rest\\test.mcp"; //name of project
strcpy(method, "PREVIEW");
strcpy(jobname, "Backdokumentation Control Center");
ret = RPJAttach(&err);
if (TRUE == ret)
{
hProp = RPJCreatePropertyHandle(szProjectName. &err);
if (NULL == hProp)
{
ErrMsg("Error RPJCreatePropertyHandle", &err);
}
else
{
ret = RPJGetJobProps(hProp, jobname, &err);
if (FALSE == ret)
{
ErrMsg("Error RPJGetJobProbs", &err);
}
else
{
ret = RPJCallJobMethod(hProp, method, &err);
if (FALSE == ret)
{
ErrMsg("Error executing RPJCallJobMethod", &err);
}
else
{
Msg("Print job started.");
}
}
RPJDeletePropertyHandle(hProp, &err);
}
RPJDetach(&err);
}
else
{
Msg("No connection to report designer DLL");
}
}

3.7.2 Functions for establishing connections (RT Professional)
3.7.2.1 RPJAttach (RT Professional)
Description
This function is used to established and initialized a connection to RPJAPI.DLL.
Declaration
BOOL RPJAttach (
CMN_ERROR* pcmnerror );
Parameters
pcmnerror
Return value
TRUE
Connection established.
FALSE
Error
Required files
rpjapi.h
rpjapi.lib
rpjapi.dll
Related functions
RPJDetach (Page 2084) Terminate connection
See also
RPJDetach (Page 2084)

3.7.2.2 RPJDetach (RT Professional)
Description
This function is used to close an established connection to RPJAPI.DLL.
Declaration
BOOL RPJDetach (
Parameters
pcmnerror
Return value
TRUE
Connection is closed again.
FALSE
Error
Comment
Note
Microsoft-specific mechanisms, this may cause the call to freeze and the program to crash.
Required files
rpjapi.h
rpjapi.lib
rpjapi.dll
Related functions
RPJAttach (Page 2083) Establish connection

See also
RPJAttach (Page 2083)
3.7.2.3 RPJMemFree (RT Professional)
Description
This function is used to close an established connection to RPJAPI.DLL and release the
allocated memory.
Declaration
BOOL RPJMemFree (
const PVOID pvMemBlock,
Parameters
pvMemBlock
Pointer to a released memory area that was previously allocated by a RPJ function.
If pvMemBlock = NULL, nothing happens.
pcmnerror
Return value
TRUE
The memory was released.
FALSE
Error
Required files
rpjapi.h
rpjapi.lib
rpjapi.dll

See also
3.7.3 Functions for processing project properties (RT Professional)
3.7.3.1 RPJGetNumProjectProperties (RT Professional)
Description
The function determines the number of properties for the project.
Declaration
BOOL RPJGetNumProjectProperties (
LPCSTR pszReserved,
DWORD* pdwNumProperties
Parameters
pszReserved
pdwNumProperties
Pointer to a DWORD tag, in which the number of properties is returned.
pcmnerror
Return value
TRUE
The number of properties was determined.
FALSE
Error
Required files
rpjapi.h

rpjapi.lib
rpjapi.dll
See also
3.7.3.2 RPJGetProjectPropertyAt (RT Professional)
Description
The function determines the name and type of a property based on the index in the project.
Declaration
BOOL RPJGetProjectPropertyAt (
LPCSTR pszReserved,
DWORD dwPropIndex,
LPSTR pszBuffer,
DWORD dwCharMax,
DWORD* pdwPrpType,
Parameters
pszReserved
The parameter is reserved for future expansions.
dwPropIndex
Index of the property in the project, from which the information is to be returned.
pszBuffer
Pointer to a buffer in which the name of the property should be returned. The size of the buffer
is specified with dwCharMax.
dwCharMax
Maximum size of the buffer specified with pszBuffer.
pdwPropType
Pointer to a DWORD tag, in which the type of the property in the project is returned.
pcmnerror

Return value
TRUE
The name and type of property in the project was determined.
FALSE
Error
Required files
rpjapi.h
rpjapi.lib
rpjapi.dll
See also
3.7.3.3 RPJGetProjectProperty (RT Professional)
Description
The function determines the value of a property. The project name and the property name
must be passed.
Declaration
BOOL RPJGetProjectProperty (
LPCSTR pszProjectName,
LPCSTR pszPropName,
PVOID pvPropValue,
VARTYPE vtPropType,
DWORD dwBufferSize,
Parameters
pszProjectName
Pointer to the name of the project, consisting of the path, project name, and extension.
pszPropName
Name of the property in the project.

pvPropValue
Pointer to a buffer in which the value of the property should be returned. The size of the buffer
in pvPropValue is specified with dwBufferSize.
vtPropType
Type in which the value of the property in the pvPropValue buffer is expected.
VT_I4 Integer or Boolean

VT_LPSTR Text in ANSI format
VT_LPWSTR Text in UNICODE format
VT_DATE Date/time
dwBufferSize
Size of the buffer in pvPropValue to which the value of the property should be returned. The
size may only be specified in BYTE and not in CHAR.
pcmnerror
Return value
TRUE
The value of property was determined.
FALSE
Error
Required files
rpjapi.h
rpjapi.lib
rpjapi.dll
See also
3.7.3.4 RPJProjectLock (RT Professional)
Description
Access to the print job list in the project is locked to others. The name of the locking party must
be specified in pszLockerNameNew. If an access conflict occurs, the name of the locking party
is returned via ppszLockerNameCur.

Declaration
BOOL RPJProjectLock (
BOOL fWriteLock,
BOOL fDoNotWait,
LPCSTR pszLockerNameNew,
LPSTR* ppszLockerNameCur,
Parameters
pszProjectName
fWriteLock
Specifies the type of locking.
TRUE Locks writing and reading.

FALSE Locks reading only.
fDoNotWait
TRUE An error is immediately reported if a lock exists.

FALSE If a lock exists, it is checked cyclically at first. After a few seconds, the
check stops with a timeout error.
pszLockerNameNew
Contains the name of the locking party. If an access conflict occurs, the name is returned via
ppszLockerNameCur.
ppszLockerNameCur
If an access conflict occurs, the name of the current locking party is returned in
ppszLockerNameCur.
pcmnerror
Return value
TRUE
Print job list is locked.
FALSE
An access conflict has occurred. The print job list of the project is already locked. The name
of the locking party is returned via ppszLockerNameCur.

Required files
rpjapi.h
rpjapi.lib
rpjapi.dll
Related functions
RPJProjectUnlock (Page 2091) Removing a lock

RPJProjectUnlockAll (Page 2092) Removing all locks
See also
RPJProjectUnlock (Page 2091)
RPJProjectUnlockAll (Page 2092)
3.7.3.5 RPJProjectUnlock (RT Professional)
Description
The lock of a print job list is removed.
Declaration
BOOL RPJProjectUnlock (
Parameters
pszProjectName
Pointer to the name of the project file consisting of the path, project name and extension.
pcmnerror
Return value
TRUE
The lock of the print job list was removed.

FALSE
An access conflict has occurred.
Required files
rpjapi.h
rpjapi.lib
rpjapi.dll
Related functions
RPJProjectLock (Page 2089) Creating a lock

RPJProjectUnlockAll (Page 2092) Removing all locks
See also
RPJProjectLock (Page 2089)
RPJProjectUnlockAll (Page 2092)
3.7.3.6 RPJProjectUnlockAll (RT Professional)
Description
All locks of a print job list are removed.
Declaration
BOOL RPJProjectUnlockAll (
Parameters
pszProjectName
pcmnerror

Return value
TRUE
All locks of the print job list were removed.
FALSE
Required files
rpjapi.h
rpjapi.lib
rpjapi.dll
Related functions
RPJProjectLock (Page 2089) Creating a lock

RPJProjectUnlock (Page 2091) Removing a lock
See also
RPJProjectLock (Page 2089)
RPJProjectUnlock (Page 2091)
3.7.4 Functions for processing print jobs (RT Professional)
3.7.4.1 RPJCreateJob (RT Professional)
Description
Creates a new print job.
Declaration
BOOL RPJCreateJob (
LPCSTR pszJobName,

Parameters
pszProjectName
pszJobName
Pointer to the name of the print job to be created.
pcmnerror
Return value
TRUE
Print job created.
FALSE
Error
Required files
rpjapi.h
rpjapi.lib
rpjapi.dll
Related functions
RPJDeleteJob (Page 2094) Delete print job
See also
RPJDeleteJob (Page 2094)
3.7.4.2 RPJDeleteJob (RT Professional)
Description
A print job specified by pszJobName is deleted.

Declaration
BOOL RPJDeleteJob (
LPCSTR pszJobName,
Parameters
pszProjectName
pszJobName
Pointer to the name of the print job to be deleted.
pcmnerror
Return value
TRUE
Print job deleted.
FALSE
Error
Required files
rpjapi.h
rpjapi.lib
rpjapi.dll
Related functions
RPJCreateJob (Page 2093) Create a print job
See also
RPJCreateJob (Page 2093)

3.7.4.3 RPJCreatePropertyHandle (RT Professional)
Description
To edit the properties of a print job, you first have configure a handle on the job using this
function. You get the handle in the return value.
Declaration
HPROPERTIES RPJCreatePropertyHandle (
Parameters
pszProjectName
pcmnerror
Return value
Handle on the print job property.
If an error occurs, the return value is ZERO.
Comment
The handle provided here is required by the RPJGetJobProps, RPJGetProperty and
RPJSetProperty functions, for example.
Required files
rpjapi.h
rpjapi.lib
rpjapi.dll
Related functions
RPJDeletePropertyHandle (Page 2097) Delete handle

RPJPropertyClear (Page 2116) Initialize memory area


Examples
Show print job preview (Page 2135) "RD02.cpp"
Modify print job properties (Page 2130) "RD02.cpp"
Get print job names (Page 2124) "RD02.cpp"
Get print job method name (Page 2121) "RD02.cpp"
Get print job properties (Page 2127) "RD02.cpp"
See also
Get print job method name (Page 2121)
Get print job names (Page 2124)
Get print job properties (Page 2127)
Modify print job properties (Page 2130)
Show print job preview (Page 2135)
RPJDeletePropertyHandle (Page 2097)
RPJGetProperty (Page 2113)
RPJGetJobProps (Page 2111)
RPJSetProperty (Page 2117)
RPJPropertyClear (Page 2116)
3.7.4.4 RPJDeletePropertyHandle (RT Professional)
Description
Each handle created with RPJCreatePropertyHandle, is deleted with this function when it is
no longer needed.
Declaration
BOOL RPJDeletePropertyHandle (
HPROPERTIES hproperties,

Parameters
hproperties
The handle of the print job property is created by the RPJCreatePropertyHandle function.
pcmnerror
Return value
TRUE
Handle deleted
FALSE
Error
Required files
rpjapi.h
rpjapi.lib
rpjapi.dll
Related functions
RPJCreatePropertyHandle (Page 2096) Create handle
Examples
See also
RPJCreatePropertyHandle (Page 2096)


3.7.4.5 RPJGetJobNameAt (RT Professional)
Description
Determines the name of a print job specified by dwJobIndex.
Declaration
BOOL RPJGetJobNameAt (
DWORD dwJobIndex,
LPSTR pszBuffer,
DWORD dwCharMax,
Parameters
PszProjectName
dwJobIndex
Index of the print job, the name of which should be determined.
pszBuffer
Pointer to a receive buffer in which the name of the print job should be returned.
dwCharMax
Size of the receive buffer in number of characters including the zero termination. This value
must be greater than 1.
pcmnerror
Return value
TRUE
Name of the print job determined.
FALSE
Error

Comment
An index error indicated by RPJGetJobNameAt may be due to the fact that the number of jobs
changed after the RPJGetNumJobs was called.
Required files
rpjapi.h
rpjapi.lib
rpjapi.dll
Examples
See also
3.7.4.6 RPJGetNumJobs (RT Professional)
Description
Determines the number of currently pending print jobs. After the function is called, the number
may change due to deletion or addition of print jobs.
Declaration
BOOL RPJGetNumJobs (
DWORD* pdwNumJobs,
Parameters
pszProjectName
pdwNumJobs
Pointer to the location where the number of print jobs should be stored.

pcmnerror
Return value
TRUE
Number of print jobs determined.
FALSE
Error
Required files
rpjapi.h
rpjapi.lib
rpjapi.dll
Examples
See also
3.7.4.7 RPJJobLock (RT Professional)
Description
Access to the specified print job is locked to others. The name of the locking party must be
specified in pszLockerNameNew. If an access conflict occurs, the name of the locking party
is returned via ppszLockerNameCur.

Declaration
BOOL RPJJobLock (
LPCSTR pszJobName,
BOOL fWriteLock,
BOOL fDoNotWait,
LPCSTR pszLockerNameNew,
LPSTR* ppszLockerNameCur,
Parameters
pszProjectName
pszJobName
Pointer to the name of the print job to be locked.
fWriteLock
Specifies the type of locking.
TRUE Locks writing and reading.

FALSE Locks reading only.
fDoNotWait
TRUE An error is immediately reported if a lock exists.

FALSE If a lock exists, it is checked cyclically at first. After a few seconds, the check
stops with a timeout error.
pszLockerNameNew
Contains the name of the locking party. If an access conflict occurs, the name is returned via
ppszLockerNameCur.
ppszLockerNameCur
If an access conflict occurs, the name of the current locking party is returned in
ppszLockerNameCur.
pcmnerror
Return value
TRUE
Print job is locked.

FALSE
An access conflict has occurred. The print job list of the project is already locked. The name
of the locking party is returned via ppszLockerNameCur.
Required files
rpjapi.h
rpjapi.lib
rpjapi.dll
Related functions
RPJJobUnlock (Page 2103) Removing a lock

RPJJobUnlockAll (Page 2104) Removing all locks
See also
RPJJobUnlockAll (Page 2104)
RPJJobUnlock (Page 2103)
3.7.4.8 RPJJobUnlock (RT Professional)
Description
The lock of a print job is removed.
Declaration
BOOL RPJJobUnlock (
LPCSTR pszJobName,
Parameters
pszProjectName
pszJobName
Pointer to the name of the print job.

pcmnerror
Return value
TRUE
The lock of the print job was removed.
FALSE
Required files
rpjapi.h
rpjapi.lib
rpjapi.dll
Related functions
RPJJobLock (Page 2101) Creating a lock

RPJJobUnlockAll (Page 2104) Removing all locks
See also
RPJJobUnlockAll (Page 2104)
RPJJobLock (Page 2101)
3.7.4.9 RPJJobUnlockAll (RT Professional)
Description
All locks of a print job are removed.
Declaration
BOOL RPJJobUnlockAll (
LPCSTR pszJobName,

Parameters
pszProjectName
pszJobName
pcmnerror
Return value
TRUE
All locks of the specified print job are removed.
FALSE
An access conflict has occurred
Required files
rpjapi.h
rpjapi.lib
rpjapi.dll
Related functions
RPJJobLock (Page 2101) Creating a lock

RPJJobUnlock (Page 2103) Removing a lock
See also
RPJJobUnlock (Page 2103)
RPJJobLock (Page 2101)

3.7.5 Functions for processing print job methods (RT Professional)
3.7.5.1 RPJCallJobMethod (RT Professional)
Description
This function allows you to specify a specific job method. Currently, there are two methods:
PrintJob and PreviewJob.
Declaration
RPJCallJobMethod (
LPCSTR pszMethodName
Parameters
hproperties
pszMethodName
Pointer to the name of the job method to be used.
pcmnerror
Return value
TRUE
Print job method specified
FALSE
Error
Comment
In order to specify a print job method with RPJCallJobMethod, you first need to execute the
RPJGetJobProps function.
Required files
rpjapi.h

rpjapi.lib
rpjapi.dll
Examples
See also
3.7.5.2 RPJGetJobMethodAt (RT Professional)
Description
The function determines the name of the printing method specified in dwMethodIndex.
Declaration
BOOL RPJGetJobMethodAt (
DWORD dwMethodIndex,
LPSTR pszBuffer,
DWORD dwCharMax,
Parameters
dwMethodIndex
Index of the printing method whose name is determined.
pszBuffer
Pointer to a buffer in which the name of the printing method should be returned.
dwCharMax
Size of the buffer for receiving the name in number of characters including the zero termination.
This value must be greater than 1.
pcmnerror

Return value
TRUE
Name of the print job method determined
FALSE
Error
Required files
rpjapi.h
rpjapi.lib
rpjapi.dll
Examples
See also
3.7.5.3 RPJGetNumJobMethods (RT Professional)
Description
The function determines how many print job methods are currently available.
Declaration
BOOL RPJGetNumJobMethods (
DWORD* pdwNumMethods,
Parameters
pdwNumMethods
Pointer to the location where the number of print job methods should be stored.
pcmnerror

Return value
TRUE
Number of print job methods determined
FALSE
Error
Required files
rpjapi.h
rpjapi.lib
rpjapi.dll
Examples
See also
3.7.6 Functions for processing print job methods (RT Professional)
3.7.6.1 RPJGetJobPropertyAt (RT Professional)
Description
Determines the name and type of job property specified in dwPropindex.
Declaration
BOOL RPJGetJobPropertyAt (
DWORD dwPropIndex,
LPSTR pszBuffer,
DWORD dwCharMax,
DWORD* pdwPropType,

Parameters
dwPropIndex
Index of the print job property, the name of which should be determined.
pszBuffer
Pointer to a buffer that receives the name of the job property.
dwCharMax
Size of the receive buffer in number of characters including the zero termination. This value
must be greater than 1.
pdwPropType
Pointer to the location where the type of job property should be stored.
pcmnerror
Return value
TRUE
Name of the print job property determined
FALSE
Error
Required files
rpjapi.h
rpjapi.lib
rpjapi.dll
Examples
See also

3.7.6.2 RPJGetJobProps (RT Professional)
Description
The function determines the properties of a print job and stores it in the internal hProps buffer.
Declaration
BOOL RPJGetJobProps (
LPCSTR pszJobName,
Parameters
hproperties
pszJobName
pcmnerror
Comment
This function is a prerequisite for functions such as RPJGetProperty and RPJSetProperty.
Return value
TRUE
Print job properties determined
FALSE
Error
Required files
rpjapi.h
rpjapi.lib
rpjapi.dll

Related functions

Examples
See also
3.7.6.3 RPJGetNumJobProperties (RT Professional)
Description
Determines the number of available print job properties.
Declaration
BOOL RPJGetNumJobProperties (
DWORD* pdwNumProperties,
Parameters
pdwNumProperties
Pointer to the location where the number of print job properties should be stored.
pcmnerror

Return value
TRUE
Number of print job properties determined
FALSE
Error
Required files
rpjapi.h
rpjapi.lib
rpjapi.dll
Examples
See also
3.7.6.4 RPJGetProperty (RT Professional)
Description
Before you can use RPJGetProperty to determine the value of the print job property specified
by pszPropName, you first need to use RPJGetJobProps to store the job properties in the
internal hProp buffer.
Declaration
BOOL RPJGetProperty (
LPCSTR pszPropName,
PVOID pvPropValue,
VARTYPE vtPropType,
DWORD dwBufferSize,

Parameters
hproperties
pszPropName
Pointer to the name of the print job property:
AbsoluteSelectionTo
CycleSpan
DestinationFile
EnableCycle
EnableStart
EndPage This information enables you can to stop the printout of the report at
a particular page.
JobName The name of the print job must be unique within a project and conform
to the Windows conventions.
LayoutName You can assign the print job a layout using the layout name.
PrinterName 1 Here, you specify the printer to which the printout is initially sent.
PrinterName 2 This specifies the printer to be used if the first printer is not available.
PrinterName 3 This specifies the printer to be used if the first two printers are not
available.
StartPage This information enables you can to start the printout of the report at
a particular page.
StartTime
UseRelative
UseOutputFile
UseOutputPrinter
pvPropValue
Pointer to a buffer that should receive the name.
vtPropType
The type of the object property depends on pszPropName:
AbsoluteSelectionFrom VT_DATE
AbsoluteSelectionTo VT_DATE
CycleSpan VT_I4
DestinationFile VT_LPSTR
EnableCycle VT_I4
EnableStart VT_I4
EndPage VT_I4
JobName VT_LPSTR / VT_LPWSTR

LayoutName VT_LPSTR / VT_LPWSTR

PrinterName VT_LPSTR / VT_LPWSTR
PrinterName2 VT_LPSTR / VT_LPWSTR
RelativeSelectionCount VT_I4
RelativeSelectionRange VT_I4
StartPage VT_I4
StartTime VT_DATE
UseRelative VT_I4
UseOutputFile VT_I4
UseOutputPrinter VT_I4
If you want to change a string and your application is compiled in Unicode, you must use vtProp
VT_LPWSTR as the data type. Otherwise, vtProp has a VT_LPTSTR data type.
If vtProp has a VT_DATE data type, the prop parameter must refer to a SYSTEMTIME structure.
dwBufferSize
Size of the buffer to which prop refers in number of bytes.
pcmnerror
Return value
TRUE
Print job property determined
FALSE
Error
Comment
If the buffer for receiving the job property is configured too small, which can happen with job
name and layout name, for example, the buffer is filled but the function returns the
ERR_UNKNOWNERROR error message.
Error messages
ERR_UNKNOWNERROR Unknown error
Required files
rpjapi.h
rpjapi.lib

rpjapi.dll
Related functions

Examples
See also
3.7.6.5 RPJPropertyClear (RT Professional)
Description
This function is useful if you want to initialize a memory area referenced by a handle without
deleting the handle.
Declaration
BOOL RPJPropertyClear (
Parameters
hproperties
pcmnerror

Return value
TRUE
Memory initialized.
FALSE
Error
Required files
rpjapi.h
rpjapi.lib
rpjapi.dll
Related functions
See also
3.7.6.6 RPJSetProperty (RT Professional)
Description
This function allows you to temporarily change individual print job properties.
Before you can use RPJSetProperty to reset the value of the print job property specified by
pszPropName, you first need to use RPJGetJobProps to store the job properties in the internal
hProp buffer.
Declaration
BOOL RPJSetProperty (
LPCSTR pszPropName,
PVOID pvPropValue,
VARTYPE vtPropType,
DWORD dwReserved,

Parameters
hproperties
Handle of the print job properties. The handle is created by the RPJCreatePropertyHandle
function.
pszPropName
Pointer to the name of the print job property:
AbsoluteSelectionTo
CycleSpan
DestinationFile
EnableCycle
EnableStart
EndPage This information enables you can to stop the printout of the report at
a particular page.
JobName The name of the print job must be unique within a project and conform
to the Windows conventions.
LayoutName You can assign the print job a layout using the layout name.
PrinterName 1 Here, you specify the printer to which the printout is initially sent.
PrinterName 2 This specifies the printer to be used if the first printer is not available.
PrinterName 3 This specifies the printer to be used if the first two printers are not
available.
StartPage This information enables you can to start the printout of the report at
a particular page.
StartTime
UseRelative
UseOutputFile
UseOutputPrinter
pvPropValue
Pointer on the value of the object property.
vtPropType
The type of the object property depends on pszPropName:
AbsoluteSelectionFrom VT_DATE
AbsoluteSelectionTo VT_DATE
CycleSpan VT_I4
DestinationFile VT_LPSTR
EnableCycle VT_I4
EnableStart VT_I4
EndPage VT_I4

JobName VT_LPSTR / VT_LPWSTR

LayoutName VT_LPSTR / VT_LPWSTR
PrinterName VT_LPSTR / VT_LPWSTR
RelativeSelectionCount VT_I4
RelativeSelectionRange VT_I4
StartPage VT_I4
StartTime VT_DATE
UseRelative VT_I4
UseOutputFile VT_I4
UseOutputPrinter VT_I4
If you want to change a string and your application is compiled in Unicode, you must use vtProp
VT_LPWSTR as the data type. Otherwise, vtProp has a VT_LPTSTR data type.
If vtProp has a VT_DATE data type, the prop parameter must refer to a SYSTEMTIME structure.
dwReserved
pcmnerror
Return value
TRUE
Print job property temporarily changed
FALSE
Error
Comment
All available print job properties can be determined with the RPJGetNumJobProperties and
RPJGetJobPropertyAt functions.
Required files
rpjapi.h
rpjapi.lib
rpjapi.dll

Related functions

Examples
See also

3.7.7.1 Get print job method name (RT Professional)
Example
//{{ODK_EXAMPLE}Get print job methodname (RPT)}

//{{FUNCTION}RPJCreatePropertyHandle (RPT)}
//{{FUNCTION}RPJDeletePropertyHandle (RPT)}
//{{FUNCTION}RPJGetNumJobMethods (RPT)}
//{{FUNCTION}RPJGetJobMethodAt (RPT)}
//{{FUNCTION}(END)}
// =====================================================================
// Function: MyPrintJobPropertyInquire( void ) ODK RD RT
// =====================================================================
// : Get print job methodname (Enum) !
// =====================================================================
void MyRPJGetJobMethodAt(void)
{
BOOL ret = FALSE;
CMN_ERROR Error;
HPROPERTIES hProp = NULL;
TCHAR jobname[255];
TCHAR szText[255];
DWORD d = 0L;
DWORD i = 0L;
char buf[500+1];
DWORD dwBufsize = 500L;
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("--------------------"));
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("MyRPJGetJobMethodAt:"));
ODKTrace(szText);
ret = RPJAttach(&Error);
if (FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in RPJAttach: E1= 0x
%08lx ; E2= 0x%08lx ; %s"),
ODKTrace(szText);
return;
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("RPJAttach"));
ODKTrace(szText);
}
_tcsncpy_s(jobname, _countof(jobname), _T("ODK_PRINTJOB"), _TRUNCATE); // print job
hProp = RPJCreatePropertyHandle (/*PROJ_PATH*/g_szProjectFile, &Error);
if(NULL == hProp)

{
RPJCreatePropertyHandle: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
ODKTrace(szText);
ret = RPJDetach(&Error);
if (FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in RPJDetach: E1=
0x%08lx ; E2= 0x%08lx ; %s"),
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("RPJDetach"));
}
ODKTrace(szText);
return;
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("RPJCreatePropertyHandle = 0x
%08lx"), hProp);
ODKTrace(szText);
}
ret = RPJGetNumJobMethods(&d, &Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in RPJGetNumJobMethods:
E1= 0x%08lx ; E2= 0x%08lx ; %s"),
ODKTrace(szText);
}
else
{
for (i = 0; i < d; i++)
{
ret = RPJGetJobMethodAt(i, buf, dwBufsize, &Error);
if (ret == FALSE)
{
RPJDeletePropertyHandle: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" %d PrintJobMethod=
%s"),i+1,buf);
}
ODKTrace(szText);
}
}
ret = RPJDeletePropertyHandle(hProp, &Error);

if (FALSE == ret)
{
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("RPJDeletePropertyHandle"));
}
ODKTrace(szText);
if (FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in RPJDetach: E1= 0x
%08lx ; E2= 0x%08lx ; %s"),
}
else
{
}
ODKTrace(szText);
}
See also
RPJGetJobMethodAt (Page 2107)
RPJGetNumJobMethods (Page 2108)

3.7.7.2 Get print job names (RT Professional)
Example
//{{ODK_EXAMPLE}Get print job names (RPT)}

//{{FUNCTION}RPJGetNumJobs (RPT)}
//{{FUNCTION}RPJGetJobNameAt (RPT)}
//{{FUNCTION}(END)}
// =====================================================================
// Function: MyRPJGetJobNameAt( void ) ODK RD RT
// =====================================================================
// : Get all print job names (Enum) !
// =====================================================================
void MyRPJGetJobNameAt(void)
{
BOOL ret = FALSE;
CMN_ERROR Error;
TCHAR jobname[255];
TCHAR szText[255];
DWORD d = 0L;
DWORD i = 0L;
char buf[500+1];
DWORD dwBufsize = 500;
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("MyRPJGetJobNameAt:"));
ODKTrace(szText);
if (FALSE == ret)
{
%08lx ; E2= 0x%08lx ; %s"),
ODKTrace(szText);
return;
}
else
{
ODKTrace(szText);
}
if(NULL == hProp)
{


ODKTrace(szText);
if (FALSE == ret)
{
0x%08lx ; E2= 0x%08lx ; %s"),
}
else
{
}
ODKTrace(szText);
return;
}
else
{
%08lx"), hProp);
ODKTrace(szText);
}
ret = RPJGetNumJobs(/*PROJ_PATH*/g_szProjectFile, &d, &Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in RPJGetNumJobs: E1=
0x%08lx ; E2= 0x%08lx ; %s"),
ODKTrace(szText);
}
else
{
for (i = 0; i < d; i++)
{
ret = FALSE;
ret = RPJGetJobNameAt(/*PROJ_PATH*/g_szProjectFile, i, buf, dwBufsize, &Error);
if (ret == FALSE)
{
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" %d PrintJobName=
%s"),i+1, buf);
}
ODKTrace(szText);
}
}
ret = FALSE;
if (ret == FALSE)

{
}
else
{
}
ODKTrace(szText);
if (FALSE == ret)
{
%08lx ; E2= 0x%08lx ; %s"),
}
else
{
}
ODKTrace(szText);
}
See also
RPJGetJobNameAt (Page 2099)
RPJGetNumJobs (Page 2100)

3.7.7.3 Get print job properties (RT Professional)
Example
//{{ODK_EXAMPLE}Get print job properties (RPT)}

//{{FUNCTION}RPJGetNumJobProperties (RPT)}
//{{FUNCTION}RPJGetJobPropertyAt (RPT)}
//{{FUNCTION}(END)}
// =====================================================================
// Function: MyRPJGetJobPropertyAt( void ) ODK RD RT
// =====================================================================
// : Inquire print job properties (Enum) !
// =====================================================================
void MyRPJGetJobPropertyAt(void)
{
BOOL ret = FALSE;
CMN_ERROR Error;
TCHAR jobname[255];
TCHAR szText[255];
DWORD d = 0L;
DWORD f = 0L;
DWORD i = 0L;
char buf[500+1];
DWORD dwBufsize = 500L;
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("MyRPJGetJobPropertyAt:"));
ODKTrace(szText);
if (FALSE == ret)
{
%08lx ; E2= 0x%08lx ; %s"),
ODKTrace(szText);
return;
}
else
{
ODKTrace(szText);
}
if(NULL == hProp)
{


ODKTrace(szText);
if (FALSE == ret)
{
0x%08lx ; E2= 0x%08lx ; %s"),
}
else
{
}
ODKTrace(szText);
return;
}
else
{
%08lx"), hProp);
ODKTrace(szText);
}
ret = RPJGetNumJobProperties(&d, &Error);
if(FALSE == ret)
{
RPJGetNumJobProperties: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
ODKTrace(szText);
}
else
{
for (i = 0; i < d; i++)
{
ret = RPJGetJobPropertyAt(i, buf, dwBufsize, &f, &Error);
if (FALSE == ret)
{
RPJGetJobPropertyAt: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" %d PrintJobProperty=
%s"),i+1, buf);
}
ODKTrace(szText);
}
}
if (FALSE == ret)

{
}
else
{
}
ODKTrace(szText);
if (FALSE == ret)
{
%08lx ; E2= 0x%08lx ; %s"),
}
else
{
}
ODKTrace(szText);
}
See also
RPJGetJobPropertyAt (Page 2109)
RPJGetNumJobProperties (Page 2112)

3.7.7.4 Modify print job properties (RT Professional)
Example
//{{ODK_EXAMPLE}Modify print job properties (RPT)}

//{{FUNCTION}RPJGetJobProps (RPT)}
//{{FUNCTION}RPJGetProperty (RPT)}
//{{FUNCTION}RPJSetJobProps (RPT)}
//{{FUNCTION}RPJSetProperty (RPT)}
//{{FUNCTION}(END)}
// =====================================================================
// Function: MyModifyPrintJob( void ) ODK RD RT
// =====================================================================
// : Modify print job properties (change starttime) !
// =====================================================================
void MyModifyPrintJob(void)
{
BOOL ret = FALSE;
CMN_ERROR Error;
TCHAR szText[255];
SYSTEMTIME st;
LPVOID ptr;
DWORD typ;
TCHAR jobname[200];
TCHAR propname[200];
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("MyModifyPrintJob:"));
ODKTrace(szText);
if (FALSE == ret)
{
%08lx ; E2= 0x%08lx ; %s"),
ODKTrace(szText);
return;
}
else
{
ODKTrace(szText);
}
// read properties
if(NULL == hProp)
{


ODKTrace(szText);
if (FALSE == ret)
{
0x%08lx ; E2= 0x%08lx ; %s"),
}
else
{
}
ODKTrace(szText);
return;
}
else
{
%08lx"), hProp);
ODKTrace(szText);
}
_tcsncpy_s(jobname, _countof(jobname), _T("ODK_PRINTJOB"), _TRUNCATE);
ret = RPJGetJobProps (hProp, jobname, &Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in RPJGetJobProps: E1=
0x%08lx ; E2= 0x%08lx ; %s"),
ODKTrace(szText);
ret = RPJDeletePropertyHandle (hProp, &Error);
if(ret == FALSE)
{
}
else
{
}
ODKTrace(szText);
if (FALSE == ret)
{
0x%08lx ; E2= 0x%08lx ; %s"),
}
else
{
}

ODKTrace(szText);
return;
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" RPJGetJobProps"));
ODKTrace(szText);
}
typ = VT_DATE;
_tcsncpy_s(jobname, _countof(jobname), _T("ODK_PRINTJOB"), _TRUNCATE);
_tcsncpy_s(propname, _countof(propname), _T("STARTTIME"), _TRUNCATE);
memset(&st, 0, sizeof(SYSTEMTIME));
ptr = (LPVOID)&st;
ret = RPJGetProperty (hProp, propname, ptr, (VARTYPE)typ, 16, &Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in RPJGetProperty: E1=
0x%08lx ; E2= 0x%08lx ; %s"),
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" RPJGetProperty"));
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" Jobname=%s Propname=
%s"),jobname,propname);
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" %02d.%02d.%04d %02d:
%02d:%02d"),
(WORD)st.wDay,
(WORD)st.wMonth,
(WORD)st.wYear,
(WORD)st.wHour,
(WORD)st.wMinute,
(WORD)st.wSecond);
}
ODKTrace(szText);
// write properties
st.wHour = 11;
st.wMinute = 12;
st.wSecond = 13;
ret = RPJSetProperty (hProp, propname, ptr, (VARTYPE) typ, 16, &Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in RPJSetProperty: E1=
0x%08lx ; E2= 0x%08lx ; %s"),
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" RPJSetProperty"));
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" Jobname=%s ;Propname=
%s"),jobname,propname);

ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" %02d.%02d.%04d %02d:
%02d:%02d"),
(WORD)st.wDay,
(WORD)st.wMonth,
(WORD)st.wYear,
(WORD)st.wHour,
(WORD)st.wMinute,
(WORD)st.wSecond);
}
ODKTrace(szText);
ret = RPJSetJobProps (hProp, jobname, &Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in RPJSetJobProps: E1=
0x%08lx ; E2= 0x%08lx ; %s"),
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" RPJSetJobProps"));
}
ODKTrace(szText);
if(FALSE == ret)
{
}
else
{
}
ODKTrace(szText);
if (FALSE == ret)
{
%08lx ; E2= 0x%08lx ; %s"),
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE,
_T("RPJDeletePropertyHandle")); }
ODKTrace(szText);
}

See also

3.7.7.5 Show print job preview (RT Professional)
Example
// =====================================================================
// =====================================================================
// : Modul with examples of Report Designer
// *********************************************************************
// Copyright (C) 1995-99 SIEMENS AG, A&D PT1 D2 All rights reserved
// *********************************************************************
#include "RD02.h"
#include "DM01.h"
//{{ODK_EXAMPLE}Show print job preview (RPT)}

//{{FUNCTION}RPJGetJobProps (RPT)}
//{{FUNCTION}RPJCallJobMethod (RPT)}
//{{FUNCTION}(END)}
// =====================================================================
// Function: MyShowPrintJobPreview( void ) ODK RD RT
// =====================================================================
// : Show print job preview
// =====================================================================
void MyShowPrintJobPreview(void)
{
BOOL ret = FALSE;
TCHAR szText[255];
CMN_ERROR Error;
TCHAR jobname[200];
TCHAR methode[200];
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("MyShowPrintJobPreview:"));
ODKTrace(szText);
if (FALSE == ret)
{
%08lx ; E2= 0x%08lx ; %s"),
ODKTrace(szText);
return;
}
else
{
ODKTrace(szText);

}
if(NULL == hProp)
{
ODKTrace(szText);
if(FALSE == ret)
{
0x%08lx ; E2= 0x%08lx ; %s"),
}
else
{
}
ODKTrace(szText);
return;
}
else
{
%08lx"), hProp);
ODKTrace(szText);
}
ret = RPJGetJobProps (hProp, jobname, &Error);
if(FALSE == ret)
{
0x%08lx ; E2= 0x%08lx ; %s"),
ODKTrace(szText);
if(FALSE == ret)
{
}
else
{
}
ODKTrace(szText);
if(FALSE == ret)
{
0x%08lx ; E2= 0x%08lx ; %s"),
}

else
{
}
ODKTrace(szText);
return;
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" RPJGetJobProps"));
ODKTrace(szText);
}
_tcsncpy_s(methode, _countof(methode), _T("PREVIEW"), _TRUNCATE); // preview
// _tcsncpy_s(methode, _countof(methode), _T("PRINTJOB"), _TRUNCATE); // print
// _tcsncpy_s(methode, _countof(methode), _T("SETSELECTIONALLPAGES"), _TRUNCATE);
ret = RPJCallJobMethod (hProp, methode, &Error);
if(FALSE == ret)
{
0x%08lx ; E2= 0x%08lx ; %s"),
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" RPJCallJobMethod"));
}
ODKTrace(szText);
if(FALSE == ret)
{
}
else
{
}
ODKTrace(szText);
if(FALSE == ret)
{
%08lx ; E2= 0x%08lx ; %s"),
}
else
{
}
ODKTrace(szText);
}

3.8 Tag and log functions (RT Professional)
See also
RPJCallJobMethod (Page 2106)
Overview
TLG_ENUM_ARCHIV_CALLBACK (Page 2212) List logs (callback)

TLG_ENUM_PROJECT_NAME_CALLBACK List projects (callback)
(Page 2203)
AUTOHOTSPOT List entries in trend templates (callback)
TLG_ENUM_TIME_NAME_CALLBACK List time objects (callback)
(Page 2249)
TLG_ENUM_VARIABLE_NAME_CALLBACK List tags (callback)
(Page 2205)
TLG_ENUMBACKUP_ENTRIES (Page 2256) List backups (callback)
TLG_ENUMTABLES (Page 2219) List logs (callback)
TLG_ENUMTIMES_CALLBACK (Page 2252) List time objects (callback)
TLG_ENUMVARIABLES (Page 2208) List tags (callback)
TLG_GETARCHIVDATA_CALLBACK Read out data of a log (callback)
(Page 2224)
TLGChangeLanguage (Page 2194) Language switching
TLGCloseProject (Page 2198) Close project
TLGCloseWindow (Page 2239) Close print job/script diagnostics
TLGConnect (Page 2195) Establish connection to Tag Logging RT
TLGCSConnectEx (Page 2192) Establish connection to Tag Logging CS
TLGCSConnect (Page 2190) Establish connection to Tag Logging CS
TLGDisconnect (Page 2197) Terminate connection to Tag Logging RT
TLGDrawCurvesInDC (Page 2240) Show trends
TLGEnumArchives (Page 2211) List logs
TLGEnumArchivsEx (Page 2216) List logs
TLGEnumArchivs (Page 2214) List logs
TLGEnumArchivsSel (Page 2217) List logs

TLGEnumBackupEntries (Page 2254) List backups

TLGEnumProject (Page 2202) List projects
TLGEnumTime (Page 2247) List time objects
TLGEnumTimes (Page 2250) List time objects
TLGEnumVariablesEx (Page 2206) List tags
TLGEnumVariables (Page 2204) List tags
TLGExport (Page 2257) Export log
TLGFreeMemory (Page 2221) Free memory
TLGGetArchivDataEx (Page 2226) Read out data of a log
TLGGetArchivData (Page 2222) Read out data of a log
TLGGetBackupSize (Page 2259) Determine size of an exported data record
TLGGetClosestTimeEx (Page 2230) Determine logging time
TLGGetClosestTime (Page 2228) Determine logging time
TLGInsertArchivData (Page 2232) Insert data in a log
TLGInsertTemplateItem (Page 2242) Write entries to trend window templates, write en‐
tries to table window templates
TLGLockArchiv (Page 2235) Enable log, lock log
TLGLockVariable (Page 2236) Enable tag, lock tag
TLGOpenProject (Page 2200) Open project
TLGPressToolbarButton (Page 2243) Activate buttons in the toolbar
TLGReadArchiv (Page 2238) Read log parameters
TLGReadTime (Page 2253) Determine time object parameters
TLGReadVariable (Page 2209) Determine tag parameters
TLGSetRulerWindowVisible (Page 2245) Also display reading line window
TLGShowWindow (Page 2246) Display print job/script diagnostics
Overview
TLG_ARCHIV_STR (Page 2151) Log parameters

TLG_ARCHIVDATARAW (Page 2154) Log data
TLG_BACKUP_TABLE_INFO (Page 2157) Information on export table
TLG_CURVESCALEX (Page 2159) Scaling of the x-axis
TLG_CURVESCALEY (Page 2164) Scaling of the y-axis
TLG_GETARCHIVDATA (Page 2168) Log data of process value logs, log data of com‐
pressed logs
TLG_IO_BACKUP_SELECT (Page 2169) Selection criteria for backup functions
TLG_PROT_CURVE_INFOS (Page 2170) Report structure of trends
TLG_TABLE_INFO (Page 2173) Report structure of tables
TLG_SCAL_STR (Page 2172) Tag limits
TLG_TABLESCALE (Page 2174) Table column (properties)
TLG_TEMPLATEITEM_INFO (Page 2177) Trend (properties) Table column (properties)

TLG_TIME_STR (Page 2179) Time object

TLG_TIMEDATA (Page 2180) Time object
TLG_TPLITEM_CURVE (Page 2181) Trend (properties)
TLG_TPLITEM_INFO (Page 2182) Trend (properties) Table column (properties)
TLG_TPLITEM_TABLE (Page 2183) Table column (properties)
TLG_VAR_STR (Page 2184) Tag (properties)
TLG_VARIABLE_INFO (Page 2189) Tag
Overview
structure:
TLG_API_ERROR 0x10000000 Unspecified error

TLG_API_NO_TIME_EXIST 0x10000001 No time object exists
TLG_API_TIME_NAME_EXIST 0x10000002 A time object with this name al‐
ready exists
TLG_API_TIME_NAME_NOT_EXIST 0x10000003 A time object with this name was
not found
TLG_API_NO_ARCHIV_EXIST 0x10000004 No log available
TLG_API_ARCHIV_NAME_EXIST 0x10000005 A log with this name already ex‐
ists
TLG_API_ARCHIV_NAME_NOT_EXIST 0x10000006 A log with this name was not
found
TLG_API_INVALID_ARCHIV_TYP 0x10000007 Invalid log type
TLG_API_NO_VARIABLE_EXIST 0x10000008 No tags exist
TLG_API_VARIABLE_NAME_EXIST 0x10000009 A tag with this name already ex‐
ists
TLG_API_VARIABLE_NAME_NOT_EXIST 0x1000000A A tag with this name was not
found
TLG_API_VARTYPE_MISMATCH 0x1000000B Incorrect tag type
TLG_API_SRC_NO_VARIABLE_EXIST 0x1000000C SRC: no tags exist
TLG_API_SRC_VARIABLE_NAME_NOT_EXIST 0x1000000D SRC: a tag with this name was
not found
TLG_API_SRC_ARCHIV_NOT_EXIST 0x1000000E SRC: log not found
TLG_API_NO_FIELD_EXIST 0x1000000F No fields are available
TLG_API_FIELD_NAME_EXIST 0x10000010 A field with this name already ex‐
ists
TLG_API_FIELD_NAME_NOT_EXIST 0x10000011 A field with this name was not
found
TLG_API_NO_PROJECT_EXIST 0x10000012 No project exists
TLG_API_PROJECT_NAME_NOT_EXIST 0x10000013 Project name was not found
TLG_API_PROJECT_IS_ACTIVE 0x20000014 Project is activated

TLG_API_NO_CONNECTION 0x10000015 No connection to an activated

project
TLG_API_RENAME_NAME_EXIST 0x10000016 Assigned name already exists
TLG_API_NAME_WRONG_CHAR 0x10000017 Name contains incorrect charac‐
ter
TLG_API_NAME_TOLONG 0x10000018 Name is too long
TLG_API_ERR_ARCHIVSTYLE 0x10000019 Error in log design
TLG_API_NO_TYP_CHANGE_ALLOWED 0x1000001A Type change is not allowed
TLG_API_ERR_SUPPLY 0x1000001B An error has occurred
TLG_API_INVALID_PARAM 0x1000001C Invalid/incorrect parameter as‐
signment
TLG_API_NOT_SUPPORTED 0x1000001D This function is not supported
TLG_API_NO_INTERFACE 0x1000001E Access to lower level COM inter‐
faces failed
TLG_API_NODEFAULTSERVER 0x10000021 No default server configured
TLG_API_NOLOCALSERVER 0x10000022 No local server available
TLG_API_NOSERVER 0x10000023 No default server configured and
no local server available
TLG_API_NOMC 0x10000024 No multiclient project (not used
here)
TLG_API_NOMCDEFAULTSERVER 0x10000025 No multiclient project, but "@de‐
fault::" specified as server prefix
(is not used here)
TLG_API_UNKNOWN_ERROR 0x10000030 Unknown callback error
(WinCC V6.2 and higher)
TLG_API_ASYNC_TIMEOUT 0x10000031 Asynchronous function canceled
with timeout
TLG_API_EXPORT_NO_WRITE 0x10000032 Export file was not written
TLG_API_CORRUPT_DATA 0x10000033 Data unusable/defective
IDS_API_ERROR_CREATING_CLIENT_WND 30001 Client window could not be gen‐
erated
IDS_API_ERROR_WINDOW_NOT_FOUND 30002 Button (window) could not be
found
Runtime window
TLG_CURVE_WINDOW 0x00000001 Trend window

TLG_TABLE_WINDOW 0x00000002 Table window
TLG_CTRL_WINDOW 0x00000004 TLGRT control window

Export functions
TLG_BACKUP_EXPORT 0x00000001 Export without deletion of source data.

TLG_BACKUP_EVACUATE 0x00000002 Export with deletion of source data.
TLG_BACKUP_DELETE 0x00000004 Deletion of data records without export.
TLG_BACKUP_RAW 0x00000008 Do not handle log on change separately.
Export/import formats
TLG_BAKFMT_CSV 0x00000001 CSV format (comma separated value)
Import functions
TLG_RESTORE_OVERWRITE 0x00000001 Import with overwriting.

TLG_RESTORE_MERGE 0x00000002 Import with check, error via callback.
TLG_RESTORE_BREAK 0x00000004 Import - canceled due to error
Log types
TLG_ARCTYP_USER 0x00000001 User log

(no longer supported in WinCC V5.0 and higher)
TLG_ARCTYP_PROCESS 0x00000002 Process value log
TLG_ARCTYP_COMPRESS 0x00000004 Compressed log
Log types
TLG_ARCTYP_ALL 0x00000000 Circular or sequential log

TLG_ARCTYP_CIRCULAR 0x00010000 Circular log
TLG_ARCTYP_FOLLOW 0x00020000 Sequential log
Log flags
TLG_API_FLG_FAST_INSERT 0x00000001 WinCC V6.0 SP1 and higher: Fast insertion of data
in SQL Server with TLGInsertArchivData
Window templates
TLG_TEMPLATE_ALL 0x00000000 All window templates

TLG_TEMPLATE_CURVE 0x00000001 Trend window template
TLG_TEMPLATE_TABLE 0x00000002 Table window template
TLG_TYP_TEMPLATE_CURVE 0x00800001 Trend window template
TLG_TYP_TEMPLATE_TABLE 0x00800002 Table window template

Templates
TLG_TEMPLATEITEM_ALL 0x00000000 All template items

TLG_TEMPLATEITEM_CURVE 0x00000001 Trend template items
TLG_TEMPLATEITEM_TABLE 0x00000002 Table template items
Modify templates items
TLG_TI_ACTION_COLOR 0x00000001 Change color

TLG_TI_ACTION_SCALE_X 0x00000002 Change X-scaling
TLG_TI_ACTION_SCALE_Y 0x00000004 Change Y-scaling
TLG_TI_ACTION_VISIBLE 0x00000005 Make visible/invisible
TLG_TI_ACTION_RANGE_X 0x00000006 Display range X-axis
TLG_TI_ACTION_RANGE_Y 0x00000007 Display range Y-axis
Limit values
TLG_MAX_SQL_SELECT 512 Maximum length of an SQL command

TLG_MAX_TEMPLATE_NAME 32 Maximum length of the name of a trend or table
window template
TLG_MAX_TEMPLATEITEM_NAME 32 Maximum length of the name of a trend or table
template
TLG_MAX_FUNCTION_NAME 32 Maximum length of the name of an action or
function
TLG_MAX_DLL_NAME 32 Maximum length of the name of a DLL
TLG_MAX_STD_TEXT_NAME 32 TLGSetTemplateData
TLG_SETDATA_DEFAULT 0x00000000 y=f(x)
TLG_SETDATA_RESET 0x00000001 The trend buffer is cleared.
TLG_SETDATA_TIME_RANGE_X 0x00000002 The x-values must be interpreted as a time
range: y=f(t).
TLG_SETDATA_TIME_RANGE_Y 0x00000004 The y-values must be interpreted as a time
range: x=f(t).
Trend shape
TLG_CURVEFORM_STEP 0x00000011 Representation of the tag values as a step

trend
TLG_CURVEFORM_POINTS 0x00000012 Representation of the tag values as single
points.
TLG_CURVEFORM_DIRECT 0x00000014 Linear interpolation of tag values
TLG_CURVEFORM_ DIRFILL 0x00000021
TLG_CURVEFORM_ STEPFILL 0x00000022

Data range types
TLG_DATATYP_TIMERANGE 0x00000001
TLG_DATATYP_USERARCHIV 0x00000002
TLG_DATATYP_BLOCKDATA 0x00000004
Time ranges
TLG_TR_MINUTE 1
TLG_TR_HOUR 2
TLG_TR_DAY 3
TLG_TR_WEEK 4
TLG_TR_MONTH 5
TLG_TR_YEAR 6
Axes
TLG_AXIS_X_TOP 0x00000001
TLG_AXIS_X_MIDDLE 0x00000002
TLG_AXIS_X_BOTTOM 0x00000004
TLG_AXIS_Y_LEFT 0x00000001
TLG_AXIS_Y_MIDDLE 0x00000002
TLG_AXIS_Y_RIGHT 0x00000004
Protocol connection
TLG_PROTFLG_TIME_RANGE 0x00000001
TLG_PROTFLG_DATA_RANGE 0x00000002
TLG_PROTFLG_DATA 0x00000001
TLG_PROTFLG_TITLE 0x00000002
TLG_PROTFLG_TIMEFIELD 0x00000004
TLG_PROTFLG_DATACOUNT 0x00000008
TLG_PROTFLG_DATEFIELD 0x00000010
TAG_PROT_CURVE_FORM_STEP 0x00000001
TAG_PROT_CURVE_FORM_POINTS 0x00000002
TAG_PROT_CURVE_FORM_DIRECT 0x00000003
TAG_PROT_CURVE_FORM_AREA 0x00000004
TLG_PROTFLG_FIRST_COL 0x00000000
TLG_PROTFLG_FIRST_COL_TIME 0x00000001
TLG_PROTFLG_FIRST_COL_DATA 0x00000002
TLG_PROTFLG_FIRST_COL_DATE 0x00000004

Read log data
TLG_DATA_FROM_POS 0x00000000
TLG_DATA_FROM_BEGIN 0x00000001
TLG_DATA_FROM_END 0x00000002
TLG_DATA_FROM_ACTUAL 0x00000004
TLG_DATA_FROM_LEFT_ABS 0x00000008
TLG_DATA_FROM_RIGHT_ABS 0x00000010
Buttons on the Runtime toolbar
Buttons for trends and tables
TLG_BASIC_BTN_HELP 0x00000001 Identification of the button for calling on‐

line help.
TLG_BASIC_BTN_DLG 0x00000002 Identification of the button for opening the
parameter assignment dialog for trend
and table window templates.
TLG_BASIC_BTN_FIRST 0x00000004 Identification of the button for displaying
the first data records of a log.
TLG_BASIC_BTN_PREV 0x00000008 Identification of the button for scrolling
back in the log.
TLG_BASIC_BTN_NEXT 0x00000010 Identification of the button for scrolling
ahead in the log.
TLG_BASIC_BTN_LAST 0x00000020 Identification of the button for displaying
the last data records of a log.
TLG_BASIC_BTN_STARTSTOP 0x00000040 Identification of the button for pausing or
resuming the updated trend or table dis‐
play.
TLG_BASIC_BTN_PREV_ITEM 0x00000800 Previous trend in the foreground or table
column first.
TLG_BASIC_BTN_NEXT_ITEM 0x00001000 Next trend in the foreground or table col‐
umn first.
TLG_BASIC_BTN_ARC_VAR_SELECT 0x00000100 Opens the log tag selection dialog.
TLG_BASIC_BTN_ITEM_SELECT 0x00000200 Opens the selection dialog for trends or
table columns.
TLG_BASIC_BTN_TIME_SELECT 0x00000400 Opens the selection dialog for the display
time range.
Buttons for trends
TLG_CURVE_BTN_ZOOMIN 0x01000000 Identification of the button for activating the zoom

function for the area to be zoomed. The size of
the zoom segment can only be defined using the
mouse!
TLG_CURVE_BTN_ZOOMOUT 0x02000000 Identification of the button for deactivating the
zoom function. This does not result in switching
back to the normal view.

TLG_CURVE_BTN_LINEAL 0x04000000 Identification of the button for activating and de‐

activating the ruler for determining the coordi‐
nates of a measuring point.
TLG_CURVE_BTN_1_TO_1 0x08000000 Identification of the button for switching to normal
trend view.
Buttons for tables
TLG_TABLE_BTN_EDIT 0x00040000 Identification of the button for activating and de‐

activating the editing function.
Field definitions for structures
PDE_DB_PRJ_PROJNAME_MAX_LENGHT 128
TLG_DB_PRJ_PROJNAME_MAX_LENGHT
PDE_DB_PRJ_COMMENT_MAX_LENGHT 200
TLG_DB_PRJ_COMMENT_MAX_LENGHT
PDE_DB_PRJ_USERDATE_MAX_LENGHT 12
TLG_DB_PRJ_USERDATE_MAX_LENGHT
PDE_DB_PRJ_USERNAME_MAX_LENGHT 30
TLG_DB_PRJ_USERNAME_MAX_LENGHT
PDE_DB_ARC_NAME_MAX_LENGHT 32
TLG_DB_ARC_NAME_MAX_LENGHT
PDE_DB_ARC_NAME_MAX_LENGHT 32
TLG_DB_ARC_NAME_MAX_LENGHT
TLG_DB_ARC_USER_NAME_MAX_LENGHT 8
PDE_DB_ARC_SERVERNAME_MAX_LENGHT 50
TLG_DB_ARC_SERVERNAME_MAX_LENGHT
PDE_DB_ARC_COMMENT_MAX_LENGHT 100
TLG_DB_ARC_COMMENT_MAX_LENGHT
PDE_DB_ARC_ACTIONNAME_MAX_LENGHT 30
TLG_DB_ARC_ACTIONNAME_MAX_LENGHT
PDE_DB_VAR_NAME_MAX_LENGHT 64
TLG_DB_VAR_NAME_MAX_LENGHT
TLG_DB6_VAR_NAME_MAX_LENGHT 128
TLG_DB_MCP_VAR_MAME_MAX_LENGTH 128
PDE_DB_VAR_COMMENT_MAX_LENGHT 100
TLG_DB_VAR_COMMENT_MAX_LENGHT
PDE_DB_VAR_WRITEBACK_MAX_LENGHT 64
TLG_DB_VAR_WRITEBACK_MAX_LENGHT
TLG_DB6_VAR_WRITEBACK_MAX_LENGHT 128
PDE_DB_VAR_CYCLENAME_MAX_LENGHT 30
TLG_DB_VAR_CYCLENAME_MAX_LENGHT
PDE_DB_VAR_SIGNALTEX_MAX_LENGHT 30
TLG_DB_VAR_SIGNALTEX_MAX_LENGHT

PDE_DB_VAR_DLLNAME_MAX_LENGHT 30
TLG_DB_VAR_DLLNAME_MAX_LENGHT
PDE_DB_VAR_FUNCNAME_MAX_LENGHT 30
TLG_DB_VAR_FUNCNAME_MAX_LENGHT
PDE_DB_VAR_UNITDIR_MAX_LENGHT 30
TLG_DB_VAR_UNITDIR_MAX_LENGHT
PDE_DB_VAR_UNITSTR_MAX_LENGHT 64
TLG_DB_VAR_UNITSTR_MAX_LENGHT
TLG_DB6_VAR_UNITSTR_MAX_LENGHT 128
PDE_DB_FUNCNAME_MAX_LENGHT 30
TLG_DB_FUNCNAME_MAX_LENGHT
PDE_DB_DLLNAME_MAX_LENGHT 30
TLG_DB_DLLNAME_MAX_LENGHT
PDE_DB_SCALE_MAX_LENGHT 30
TLG_DB_SCALE_MAX_LENGHT
PDE_DB_TIMENAME_MAX_LENGHT 30
TLG_DB_TIMENAME_MAX_LENGHT
PDE_DB_FIELDNAME_MAX_LENGHT 64
TLG_DB_FIELDNAME_MAX_LENGHT
PDE_DB_STRUCTNAME_MAX_LENGHT 30
TLG_DB_STRUCTNAME_MAX_LENGHT
Field definitions of VARIANT record for log tag

For TLGCSCreateTagMulti, TLGCSReadTagMulti, and TLGCSModifyTagMulti
see Include file pde_typ.h
These functions are available starting with WinCC V6.2.
Definition in Field index Associated type Type Comments/ limita‐

ENUM_TLG_TAG definition tions
_FIELDINDEX
ENUM_TLG_TAG 0 VT_TLG_TAG_EN VT_I4 Set internally (val‐
_ENUMTYPE UMTYPE ue >= 8), cannot
be changed
ENUM_TLG_TAG 1 VT_TLG_TAG_VE VT_I4 Set internally (val‐
_VERSION RSION ue >= 1), cannot
be changed
ENUM_TLG_TAG 2 VT_TLG_TAG_CR VT_I4
_CREATORID EATORID
ENUM_TLG_TAG 3 VT_TLG_TAG_NA VT_BSTR Required for Cre‐
_NAME ME ate
ENUM_TLG_TAG 4 VT_TLG_TAG_AR VT_BSTR Required for Cre‐
_ARCHIVNAME CHIVNAME ate
ENUM_TLG_TAG 5 VT_TLG_TAG_TY VT_I4 Required for Cre‐
_TYPE PE ate


_FIELDINDEX
ENUM_TLG_TAG 6 VT_TLG_TAG_W VT_BSTR
_WRITEBACK‐ RITEBACKNAME
NAME
ENUM_TLG_TAG 7 VT_TLG_TAG_CO VT_BSTR
_COMMENT MMENT
ENUM_TLG_TAG 8 VT_TLG_TAG_AR VT_I4
_ARCTYPE CTYPE
ENUM_TLG_TAG 9 VT_TLG_TAG_SU VT_I4
_SUPPLYTYPE PPLYTYPE
ENUM_TLG_TAG 10 VT_TLG_TAG_LO VT_I4
_LOCKED CKED
ENUM_TLG_TAG 11 VT_TLG_TAG_SC VT_BSTR Required for Cre‐
_SCANTIME ANTIME ate
NUM_TLG_TAG_ 12 VT_TLG_TAG_AR VT_BSTR Required for Cre‐
ARCTIME CTIME ate
ENUM_TLG_TAG 13 VT_TLG_TAG_AR VT_I4 Required for Cre‐
_ARCFACTOR CFACTOR ate
ENUM_TLG_TAG 14 VT_TLG_TAG_VA VT_I4
_VARCOUNT‐ RCOUNTFOR‐
FORWARD WARD
_VARCOUNT‐ RCOUNTBACK‐
BACKWARD WARD
ENUM_TLG_TAG 16 VT_TLG_TAG_SA VT_I4
_SAVEBYFAULT VEBYFAULT
ENUM_TLG_TAG 17 VT_TLG_TAG_AR VT_I4 Required for Cre‐
_ARCTRIGGER CTRIGGER ate
ENUM_TLG_TAG 18 VT_TLG_TAG_ST VT_BSTR
_STATETEX‐ ATETEXTHIGH
THIGH
ENUM_TLG_TAG 19 VT_TLG_TAG_ST VT_BSTR
_STATETEXT‐ ATETEXTLOW
LOW
_VARPRO RPRO
ENUM_TLG_TAG 21 VT_TLG_TAG_FU VT_BSTR
_FUNCVALPRO NCVALPRO
ENUM_TLG_TAG 22 VT_TLG_TAG_DL VT_BSTR
_DLLVARPRO LVARPRO
_FUNCSTARTE‐ NCSTARTEVENT
VENT
_DLLSTARTE‐ LSTARTEVENT
VENT
_FUNCSTOPE‐ NCSTOPEVENT
VENT


_FIELDINDEX
_DLLSTOPE‐ LSTOPEVENT
VENT
_FUNCDYNAMIC NCDYNAMIC
_DLLDYNAMIC LDYNAMIC
ENUM_TLG_TAG 29 VT_TLG_TAG_UN VT_BSTR
_UNITDIRECT ITDIRECT
ENUM_TLG_TAG 30 VT_TLG_TAG_NA VT_BSTR
_NAMEUNIT‐ MEUNITSTRUCT
STRUCT
ENUM_TLG_TAG 31 VT_TLG_TAG_UN VT_I4
_UNITINDEX ITINDEX
ENUM_TLG_TAG 32 VT_TLG_TAG_VA VT_R8
_VARUPPER RUPPER
ENUM_TLG_TAG 33 VT_TLG_TAG_VA VT_R8
_VARLOWER RLOWER
ENUM_TLG_TAG 34 VT_TLG_TAG_AR VT_R8
_ARCUPPER CUPPER
_ARCLOWER CLOWER
_NAMESCALE MESCALE
_NAMESOUR‐ MESOURCEARC
CEARC
_NAMESOURCE‐ MESOURCEVAR
VAR
_NAMERAWVAR MERAWVAR
ENUM_TLG_TAG 40 VT_TLG_TAG_CO VT_BSTR
_CONVDLL NVDLL
ENUM_TLG_TAG 41 VT_TLG_TAG_PR VT_BSTR Required for Cre‐
_PROCVARNAME OCVARNAME ate
ENUM_TLG_TAG 42 VT_TLG_TAG_TI VT_BSTR Set internally (new
_TIMEMODIFY MEMODIFY time stamp for Cre‐
ate and Modify),
cannot be
changed
ENUM_TLG_TAG 43 VT_TLG_TAG_AR VT_I4
_ARCON‐ CONCHANGE
CHANGE
_ARCONHYS‐ CONHYSTERESE
TERESE


_FIELDINDEX
ENUM_TLG_TAG 45 VT_TLG_TAG_FL VT_I4
_FLAGS AGS
ENUM_TLG_TAG 46 VT_TLG_TAG_ALI VT_BSTR
_ALIAS AS
ENUM_TLG_TAG 47 VT_TLG_TAG_VA VT_BSTR
_VARSTARTE‐ RSTARTEVENT
VENT
ENUM_TLG_TAG 48 VT_TLG_TAG_VA VT_BSTR
_VARSTOPE‐ RSTOPEVENT
VENT
ENUM_TLG_TAG 49 VT_TLG_TAG_PR VT_BSTR
_PRECISION ECISION
ENUM_TLG_TAG 50 VT_TLG_TAG_TA VT_I4 Set internally, can‐
_TAGID GID not be changed
Flags for log tags

see Include-Datei pde_typ.h ENUM_TLG_TAG_FLAGVALUES WinCC V6.2 and higher
ENUM_TLG_TAG_FLAGVALUE_NOFLAGS 0 Default
ENUM_TLG_TAG_FLAGVALUE_LONG‐ 1
TERM_DISABLE
ENUM_TLG_TAG_FLAGVALUE_ARCHIV‐ 2
ING_ON_SEGMENTCHANGE
Selection flags for TLGCSReadTagMulti and TLGCSModifyTagMulti

These functions are available starting with WinCC V6.2.
TLG_TAG_SELECTION_BY_NAME 1 Selection with log name and tag

name in each case.
--- --- ---
TLG_TAG_DEFAULT_SELECTION TLG_TAG_SELEC‐ Preferred selection type.
TION_BY_NAME
TLG_TAG_SELECTION_FLAGS_MASK 0x0000000FL Masking of the selection in the
flags.
TLG_TAG_SELECTION_FLAGS_OFFSET 0x0L Value offset of the selection after
masking in the flags.

3.8.2.1 TLG_ARCHIV_STR (RT Professional)
Declaration
typedef struct {
TCHAR szName[
PDE_DB_ARC_NAME_MAX_LENGHT+1];
TCHAR szComment[
PDE_DB_ARC_COMMENT_MAX_LENGHT+1];
TCHAR szServername[
PDE_DB_ARC_SERVERNAME_MAX_LENGHT +1];
DWORD dwTyp;
DWORD dwAccessRead;
DWORD dwAccessWrite;
TCHAR szArchivAction[
PDE_DB_ARC_ACTIONNAME_MAX_LENGHT+1];
BOOL fLocked;
DWORD dwRecordTyp;
DWORD dwFillMessage;
DWORD dwRecordSize;
DWORD dwStorage;
TCHAR szCircularAction[
TCHAR szCompressTime[
PDE_DB_TIMENAME_MAX_LENGHT+1];
DWORD dwSourceProcess;
TCHAR szRawDatVar[
PDE_DB_VAR_NAME_MAX_LENGHT+1];
TCHAR szSendAct[
TCHAR szRecAct[
DWORD dwRecItems;
}
TLG_ARCHIV_STR;
Members
szName
Gobal parameter for the name of the log
szComment
Global parameter for the comment on the project
szServername
Global parameter reserved for future upgrades

dwTyp
Global parameter which identifies the log type.
TLG_ARCHIV_TYP_PROCESS Process value log

TLG_ARCHIV_TYP_COMPRESS Compressed log
dwAccessRead
Global parameter which identifies the authorization stage for read access (0...999).
dwAccessWrite
Global parameter which identifies the authorization stage for write access (0...999).
szArchivAction
Global parameter with the name of the action for general log processing.
fLocked
Global parameters which identifies a log as freed or locked.
dwRecordTyp
Parameter for circular and sequential logs which identifies the log type.
TLG_RECORD_TYP_CIRCULAR Circular log

TLG_RECORD_TYP_FOLLOW Sequential log
dwFillMessage
Parameter for circular, sequential and compressed logs which identifies when a filling level
message is to be sent. Max. two filling level messages can be configured with a logic OR
operation.
e.g.: 100% || 50%-90%)
TLG_FILL_MESSAGE_NO No filling level message

TLG_FILL_MESSAGE_50 Filling level message at 50%
dwRecordSize
Parameter for circular logs which defines the size of the cyclic buffer in data records.
dwStorage
Parameter for circular logs which identifies the log location.
TLG_STORAGE_MEMORY Circular log in the main memory

TLG_STORAGE_HD Circular log on hard disk

szCircularAction
Parameter for circular logs, name of the action for exporting the data of a circular log.
szCompressTime
Parameter for compressed logs, name of the timer object which specifies the compression
time period.
dwSourceProcess
Parameter for compressed logs which identifies the processing type of the source log.
PDE_COMPSRC_CALC Calculate
PDE_COMPSRC_CALCCOPY Calculate and copy
PDE_COMPSRC_CALCDEL Calculate and delete
PDE_COMPSRC_CALCCOPYDEL Calculate, copy and delete
szRawDatVar
szSendAct
szRecAct
dwRecItems
Comment
The parameters of the TLG_ARCHIV_STR structure depend on the log type (process log or
compressed log) and the type of logging (circular or sequential log).
Required files
pde_def.h
API functions
See also
TLGReadArchiv (Page 2238)

3.8.2.2 TLG_ARCHIVDATARAW (RT Professional)
Declaration
typedef struct {
SYSTEMTIME stTime;
double doValue;
DWORD dwFlags;
}
TLG_ARCHIVDATARAW;
Members
stTime
stTime contains the logging time.
doValue
doValue contains the existing value at the time stTime.
dwFlags
The Tag Logging sets flags for every value which is written into the log which provides
information about the state of the tags.
The value must be converted to hexadecimal format for analysis of the flags. Whereby
● the left word (HighWord) contains flags from the data manager
● the left word (HighWord) quality codes, if PDE_RT_QUALITYCODE is set
● the right word (LowWord) status flags from the Tag Logging
Tag Logging status flags (LowWord):

PDE_RT_DAYLIGHT 0x0001 summer time, status can be determined with GetTimeZo‐
meInformation)
PDE_RT_SUBSTITUTION 0x0002 Substitute value
PDE_RT_TIME_BEVOR_JUMP 0x0004 Value prior to time jump
PDE_RT_TIME_BEHIND_JUMP 0x0008 Value after time jump
PDE_RT_TIME_OVERLAPPED 0x0010 Values during time overlap
PDE_RT_LOAD_SYSTEM 0x0020 For the first time after creating the log archived value
PDE_RT_RELOAD_SYSTEM 0x0040 First value after activating runtime
PDE_RT_CMPCOPY 0x0080 Compressed value
PDE_RT_TIME_CHANGED 0x0100 Time change took place
PDE_RT_HAND 0x0200 Manual tag supply
PDE_RT_ONCHANGEBACKUPVALUESTART 0x0400
PDE_RT_ONCHANGEBACKUPVALUESTOP 0x0800
PDE_RT_QUALITYCODE 0x1000

data manager status flags (HighWord)

DM_VARSTATE_HARDWARE_ERROR 0x0004 Network module faulty
DM_VARSTATE_MAX_RANGE 0x0020 High format limit violated
DM_VARSTATE_MIN_RANGE 0x0040 Low format limit violated
DM_VARSTATE_CONVERSION_ERROR 0x0080 Display conversion error in connection with MAX/
MIN_RANGE
DM_VARSTATE_STARTUP_VALUE 0x0100 Initialization value of tag
DM_VARSTATE_ADDRESS_ERROR 0x0400 Addressing error in the channel
DM_VARSTATE_INVALID_KEY 0x0800 Tag not found or does not exist
DM_VARSTATE_ACCESS_FAULT 0x1000 Access to tag not permitted
DM_VARSTATE_TIMEOUT 0x2000 Timeout no feedback from channel
DM_VARSTATE_SERVERDOWN 0x4000 Connection to server interrupted or server run down
WinCC tag status Quality code according to Profibus PA/OPC

DM_VARSTATE_SERVERDOWN Server is down Bad, out of service, 0x1C
(0x4000)
DM_VARSTATE_HARDWARE_ERROR Network module faulty Bad, device failure, 0x0C
(0x0004)
DM_VARSTATE_NOT_ESTABLISHED Connection to partner not es‐ Bad, not connected, 0x08
(0x0001) tablished
DM_VARSTATE_TIMEOUT Timeout no feedback from Uncertain, last usable value, 0x44
(0x2000) channel
DM_VARSTATE_HANDSHAKE_ERROR Protocol error Bad, no communication (no usable value),
(0x0002) 0x18
DM_VARSTATE_ADDRESS_ERROR Addressing error in the channel Bad, configuration error, value not accep‐
(0x0400) ted, 0x04
DM_VARSTATE_INVALID_KEY Tag not found or does not exist Bad, configuration error, value not accep‐
(0x0800) ted, 0x04
DM_VARSTATE_ACCESS_FAULT Access to tag not permitted Bad, configuration error, value not accep‐
(0x1000) ted, 0x04
DM_VARSTATE_MAX_RANGE High format limit violated Uncertain, engineering unit range violation,
(0x0020) high limit set, 0x56
DM_VARSTATE_MIN_RANGE Low format limit violated Uncertain, engineering unit range violation,
(0x0040) low limit set, 0x55
DM_VARSTATE_CONVERSION_ERROR Display conversion error Uncertain, engineering unit range violation,
(0x0080) set without limits, 0x54
DM_VARSTATE_MAX_LIMIT Configured high limit violated Oring simulation to the limit bit HIGH, 0x01
(0x0008) with the other tag status, e.g. gives "good
(cascade), ok" 0xC2

WinCC tag status Quality code according to Profibus PA/OPC

DM_VARSTATE_MIN_LIMIT Configured low limit violated Oring simulation to the limit bitLOW, 0x02
(0x0010) with the other tag status, e.g. gives "good
(cascade), ok" 0xC1
DM_VARSTATE_STARTUP_VALUE Initialization value of tag Uncertain, initial value, 0x4C
(0x0100)
DM_VARSTATE_DEFAULT_VALUE Substitute value of tag Uncertain, substitute-set, 0x48
(0x0200)
Comment
If the current timer for transferring a SYSTEMTIME parameter is required, the GetLocalTime
must be used and not GetSystemTime. There is generally a considerable time difference
between these two functions.
Set the PDE_RT_DAYLIGHT flag if the appropriate time falls in summer time. You can
determine the status of the flag with the GetTimeZoneInformation system function
(TIME_ZONE_ID_DAYLIGHT).
Required files
pdertdef.h
pdert.h
dmdefs.h
API functions
See also
TLGGetArchivDataEx (Page 2226)

3.8.2.3 TLG_BACKUP_TABLE_INFO (RT Professional)
Declaration
typedef struct {
TCHAR szArchivName[ _MAX_PATH + 1 ];
TCHAR szFileName[ _MAX_PATH + 1 ];
TCHAR szComment[ _MAX_PATH + 1 ];
DWORD dwFormatFlags;
DWORD dwJobFlags;
DWORD dwSize;
SYSTEMTIME sysFrom;
SYSTEMTIME sysTo;
DWORD dwUserData;
}
TLG_BACKUP_TABLE_INFO;
Members
szArchivName
Name of the log from which the data is to be exported.
szFileName
Name of the export file with path and extension
szComment
Text of comment for export
dwFormatFlags
Format specifier:
TLG_BAKFMT_CSV: CSV format (Comma Separated Value)
dwJobFlags
Job-specific identification, following are possible:
TLG_BACKUP_EXPORT: Simple backup without deleting the source data

TLG_BACKUP_EVACUATE: Export with deletion of the sources
dwSize
Size of the data to be exported
sysFrom
Start time from which the data is to be exported
sysTo
End time up to which the data is to be exported

dwUserData
Application-specific data
Required files
pdertdef.h
API functions
See also
TLG_ENUMBACKUP_ENTRIES (Page 2256)

3.8.2.4 TLG_CURVESCALEX (RT Professional)
Declaration
typedef struct {
DWORD dwDataTyp;
DWORD dwBufferSize;
DWORD dwRangeTyp;
DWORD dwAxisLocation;
BOOL fActualize;
BOOL fAutoRange;
BOOL fGridLinesBig;
BOOL fGridLinesFine;
BOOL fGridLinesBigVisible;
BOOL fGridLinesFineVisible;
BOOL fPercent;
BOOL fLimitRange;
BOOL fSubstitute;
SYSTEMTIME stFrom;
SYSTEMTIME stTo;
double doFrom;
double doTo;
double doGridBig;
double doGridFine;
double doShowDigits;
double doLimitUpper1;
double doLimitLower1;
double doDisplayRangeFrom;
double doDisplayRangeTo;
double doLimitRangeFrom;
double doLimitRangeTo;
COLORREF crColor;
COLORREF crColorTimeOverlapped;
COLORREF crColorTimeJump;
COLORREF crColorLimitUpper1;
COLORREF crColorLimitLower1;
TCHAR szSelectSQL[ TLG_MAX_SQL_SELECT ];
TCHAR szText[ TLG_MAX_STD_TEXT_NAME ];
TCHAR szFunction[ TLG_MAX_FUNCTION_NAME ];
TCHAR szDLL[ TLG_MAX_DLL_NAME ];
}
TLG_CURVESCALEX;

Members
dwDataTyp
dwDataTyp determines which data type the trend is based on:
TLG_DATATYP_TIME‐ 0x00000001 for time range:

RANGE The data originate from a time-controlled log (e.g.: process value log).
The values specified in stFrom and stTo are valid. The fAutoRange flag
then has no effect.
Otherwise it applies:
The data originate from a data-controlled log (e.g.: user log). The values
specified in doFrom and doTo are valid.
TLG_DATATYP_USER‐ 0x00000002 irrelevant for trends:
ARCHIV The data originate from a data-controlled user log. The values specified
in doFrom and doTo are valid.
TLG_DATATYP_BLOCKDA‐ 0x00000004 Data is set by TLGSetTemplateData:
TA The values in stFrom, stTo, doFrom and doTo are then irrelevant.
dwBufferSize
dwBufferSize corresponds to the number of measuring points of the trend and determines the
size of the trend data buffer.
dwRangeTyp
dwAxisLocation
fActualize
The trend is displayed dynamically when fActualize = TRUE. Otherwise it is static.
fAutoRange
Autoscaling is activated if fAutoRange = TRUE.
If a time-controlled log exists (dwDataTyp = TLG_DATATYP_TIMERANGE), fAutoRange has
no effect and the values specified in stFrom and stTo are valid.
fGridLinesBig
fGridLinesFine
fGridLinesBigVisible
fGridLinesFineVisible

fPercent
fLimitRange
fSubstitute
stFrom
Start time of the display range. The parameter is only evaluated if
dwDataTy = TLG_TIME_RANGE.
stTo
End time of the display range. The parameter is only evaluated if
dwDataTyp = TLG_TIME_RANGE.
doFrom
Start value of the display range. The parameter is only evaluated if
dwDataTyp = TLG_DATA_RANGE.
doTo
End value of the display range. The parameter is only evaluated if in
dwDataTyp = TLG_DATA_RANGE.
doGridBig
doGridFine
doShowDigits
Number of decimal places
doLimitUpper1
doLimitUpper2
doLimitUpper3

doLimitLower1
doLimitLower2
doLimitLower3
doDisplayRangeFrom
Indicates from which value a data-controlled display is to be made.
doDisplayRangeTo
Indicates up to which value a data-controlled display is to be made.
doLimitRangeFrom
doLimitRangeTo
crColor
The Windows-specific 32-bit value crColor determines the color in which the trend is to be
displayed.
crColorTimeOverlapped
crColorTimeJump
crColorLimitUpper1
crColorLimitUpper2
crColorLimitUpper3
crColorLimitLower1
crColorLimitLower2

crColorLimitLower3
szSelectSQL
szText;
Labeling of the x-axis
szFunction
szDLL
Comment
TLG_CURVESCALEX is used by the TLG_TPLITEM_CURVE (Page 2181) structure.
Required files
pdertdef.h
See also
TLG_TPLITEM_CURVE (Page 2181)

3.8.2.5 TLG_CURVESCALEY (RT Professional)
Declaration
typedef struct {
DWORD dwDataTyp;
DWORD dwRangeTyp;
DWORD dwAxisLocation;
DWORD dwCurveForm;
BOOL fAutoRange;
BOOL fGridLinesBig;
BOOL fGridLinesFine;
BOOL fGridLinesBigVisible;
BOOL fGridLinesFineVisible;
BOOL fPercent;
BOOL fLimitRange;
BOOL fSubstitute;
SYSTEMTIME stFrom;
SYSTEMTIME stTo;
double doFrom;
double doTo;
double doGridBig;
double doGridFine;
double doShowDigitsF;
double doShowDigitsB;
double doDisplayRangeFrom;
double doDisplayRangeTo;
double doLimitRangeFrom;
double doLimitRangeTo;
COLORREF crColor;
TCHAR szText[ TLG_MAX_STD_TEXT_NAME ];
}
TLG_CURVESCALEY;

Members
dwDataTyp
The data type (time/user/block data) has no significance here.
dwRangeTyp
dwAxisLocation
dwCurveForm
The appearance of the trend is defined by dwCurveForm
TLG_CURVEFORM_STEP View of the trend as a step trend

TLG_CURVEFORM_POINTS View of the trend as a single point
TLG_CURVEFORM_DIRECT Connect points of the trend linearly
fAutoRange
fAutoRange = TRUE adapts the display range automatically.
fGridLinesBig
fgridLinesBig = TRUE activates big grid lines.
fGridLinesFine
fgridLinesFine = TRUE activates fine grid lines.
fGridLinesBigVisible
If fgridLinesBigVisible = TRUE, the big grid lines are displayed.
fGridLinesFineVisible
If fgridLinesFineVisible = TRUE, the fine grid lines are displayed.
fPercent
fLimitRange
fSubstitute
stFrom
stTo

doFrom
Lower limit of the display range on the y-axis.
doTo
Upper limit of the display range on the y-axis.
doGridBig
Spacing of the big grid lines.
doGridFine
Spacing of the fine grid lines.
doShowDigitsF
Places in display of values (before decimal point)
doShowDigitsB
Determines the number of decimal places
doLimitUpper1
doLimitUpper2
doLimitUpper3
doLimitLower1
doLimitLower2
doLimitLower3
doDisplayRangeFrom
Determines the value from which the display range begins.
doDisplayRangeTo
Determines the value up to which the display range extends.
doLimitRangeFrom
doLimitRangeTo

crColor
The Windows-specific 32-bit value crColor determines the color in which the trend is to be
displayed.
crColorTimeJump
crColorLimitUpper1
crColorLimitUpper2
crColorLimitUpper3
crColorLimitLower1
crColorLimitLower2
crColorLimitLower3
szSelectSQL[ TLG_MAX_SQL_SELECT ];
The parameter is reserved for later upgrades and must be defaulted with ZERO.
szText[ TLG_MAX_STD_TEXT_NAME ];
Labeling of the y-axis
Comment
TLG_CURVESCALEY is used by the AUTOHOTSPOT structure.
Required files
pdertdef.h
See also

3.8.2.6 TLG_GETARCHIVDATA (RT Professional)
Declaration
typedef struct {
LPTSTR lpszArchivName;
LPTSTR lpszVarName;
SYSTEMTIME stTime;
double doValue;
DWORD dwFlags;
}
TLG_GETARCHIVDATA;
Members
lpszArchivName
Pointer to the log name from which the data was read out.
lpszVarName
Pointer to the tag name whose values were read out.
stTime
x-value of the log value
doValue
y-value of the log value
dwFlags
Required files
pdertdef.h
API functions

(Page 2224)
See also
TLG_GETARCHIVDATA_CALLBACK (Page 2224)

3.8.2.7 TLG_IO_BACKUP_SELECT (RT Professional)
Declaration
typedef struct {
SYSTEMTIME sysFrom;
SYSTEMTIME sysTo;
LPTSTR lpszSqlString;
}
TLG_IO_BACKUP_SELECT;
Members
sysFrom
System time of the first data record to be selected
sysTo
System time of the last data record to be selected
lpszSqlString
Required files
pdertdef.h
API functions
TLGGetBackupSize (Page 2259) Determine size of an exported data record

TLGExport (Page 2257) Export log data
See also
TLGGetBackupSize (Page 2259)
TLGExport (Page 2257)

3.8.2.8 TLG_PROT_CURVE_INFOS (RT Professional)
Declaration
typedef struct {
TCHAR szArchivName[ 128 + 1 ];
TCHAR szVariableName[ 128 + 1 ];
TCHAR szTextX[ 128 + 1 ];
TCHAR szTextY[ 128 + 1 ];
SYSTEMTIME stFrom;
SYSTEMTIME stTo;
double doFrom;
double doTo;
DWORD dwFlags;
DWORD dwCurveForm;
}
TLG_PROT_CURVE_INFOS;
Members
szArchivName
Name of the log from which the data to be logged originates.
szVariableName
Name of the logging tag whose values are to be logged.
szTextX
Labeling of the x-axis
szTextY
Labeling of the y-axis
stFrom
Start time from which logging starts The parameter is only evaluated if dwFlags has
TLG_PROTFLG_TIME_RANGE set.
stTo
End time up to which logging takes place. The parameter is only evaluated if dwFlags has
TLG_PROTFLG_TIME_RANGE set.
If a current timer for transferring a SYSTEMTIME parameter is required, the GetLocalTime
function must be used and not GetSystemTime. There is generally a considerable time
difference between these two functions.
doFrom
Start time from which logging is to take place. The parameter is only evaluated if dwFlags has
TLG_PROTFLG_DATA_RANGE set.

doTo
End time up to which logging is to take place. The parameter is only evaluated if dwFlags has
TLG_PROTFLG_DATA_RANGE set.
dwFlags
dwFlags determines which data type the trend is based on:
TLG_PROTFLG_TIME_RANGE The data originate from a time-controlled log (e.g.: process value
log). The values specified in stFrom and stTo are valid.
TLG_PROTFLG_DATA_RANGE The data originate from a data-controlled log (e.g.: user log). The
values specified in doFrom and doTo are valid.
dwCurveForm
The appearance of the trend is defined by dwCurveForm
TLG_CURVEFORM_STEP View of the trend as a step trend

TLG_CURVEFORM_POINTS View of the trend as a single point
TLG_CURVEFORM_DIRECT Connect points of the trend linearly
Comment
TLG_PROT_CURVE_INFOS is used by the structures TLG_TABLESCALE (Page 2174) and
TLG_TPLITEM_INFO (Page 2182).
Required files
pdertdef.h
API functions
TLGDrawCurvesInDC (Page 2240) Show trends
See also
TLGDrawCurvesInDC (Page 2240)
TLG_TABLESCALE (Page 2174)
TLG_TPLITEM_INFO (Page 2182)

3.8.2.9 TLG_SCAL_STR (RT Professional)
Declaration
typedef struct {
double doScalVarUpper;
double doScalVarLower;
double doScalArcUpper;
double doScalArcLower;
TCHAR szStructName[PDE_DB_SCALE_MAX_LENGHT];
}
TLG_SCAL_STR;
Members
doScalVarLower
Lower limit of the tag value
doScalVarUpper
Upper limit of the tag value
doScalArcLower
doScalArcUpper
szStructName
Name of the scaling structure for the tag limit values
Comment
The TLG_SCAL_STR structure is used within the TLG_VAR_STR (Page 2184) structure and
is provided for later upgrades.
Required files
pde_def.h
See also
TLG_VAR_STR (Page 2184)

3.8.2.10 TLG_TABLE_INFO (RT Professional)
Declaration
typedef struct {
DWORD dwArchivTyp;
TCHAR szArchivName[ _MAX_PATH + 1 ];
DWORD dwSaveTyp;
}
TLG_TABLE_INFO;
Members
dwArchivTyp
dwArchivTyp identifies the log type:
TLG_ARCTYP_USER User log

TLG_ARCTYP_PROCESS Process value log
TLG_ARCTYP_COMPRESS Compressed log
szArchivName
The form in which the name of the log is provided depends on the functions which use
TLG_TABLE_INFO.
The enumeration of the logs by TLGEnumArchivs and TLGEnumArchivsSel supplies the log
name as a table name, i.e. in the form "UA#ARCHIV#Archivname" for user logs and
"PDE#HD#Archivname#Variablenname" respectively because a table entry for every tag
exists here. Therefore every tag is enumerated.
The enumeration by TLGEnumArchivsEx supplies the "pure" log name.
dwSaveTyp
dwSaveTyp identifies the type of log:
TLG_ARCTYP_CIRCULAR Circular log

TLG_ARCTYP_FOLLOW Sequential log
Required files
pdertdef.h
API functions

See also
TLG_ENUMTABLES (Page 2219)
3.8.2.11 TLG_TABLESCALE (RT Professional)
Declaration
typedef struct {
BOOL fActualize;
BOOL fVisible;
BOOL fModify;
BOOL fCommon;
DWORD dwDataTyp;
SYSTEMTIME stFrom;
SYSTEMTIME stTo;
double doFrom;
double doTo;
double doShowDigits;
OLORREF crColor;
}
TLG_TABLESCALE;
Members
fActualize
TRUE The trend view is dynamic.

FALSE The trend view is static.
fVisible
TRUE The column is visible.

FALSE The column is invisible.

fModify
TRUE The entries in the column can be edited.

FALSE The entries in the column cannot be edited.
fCommon
TRUE All columns of the table have a common time column.

FALSE The columns of the table have no common time column.
dwDataTyp
stFrom
Start time of the display range.
stTo
End time of the display range.
If a current timer for transferring a SYSTEMTIME parameter is required, the GetLocalTime
doFrom
doTo
doShowDigits
Number of decimal places to be output.
doLimitUpper1
doLimitUpper2
dpoLimitUper3
doLimitLower1
doLimitLower2

doLimitLower3
crColor
The Windows-specific 32-bit value crColor defines the color used in the table column.
crColorTimeJump
crColorLimitUpper1
crColorLimitUpper2
crColorLimitUpper3
crColorLimitLower1
crColorLimitLower2
crColorLimitLower3
szSelectSQL
Comment
TLG_TABLESCALE is used by the TLG_TEMPLATEITEM_INFO (Page 2177) structure.
Required files
pdertdef.h
See also
TLG_PROT_CURVE_INFOS (Page 2170)

TLG_TEMPLATEITEM_INFO (Page 2177)

TLG_TPLITEM_TABLE (Page 2183)
3.8.2.12 TLG_TEMPLATEITEM_INFO (RT Professional)
Declaration
typedef struct {
TCHAR szTemplateItemName[
TLG_MAX_TEMPLATEITEM_NAME+1 ];
TCHAR szTemplateName[
TLG_MAX_TEMPLATE_NAME + 1 ];
TCHAR szArchivName[ 128 + 1 ];
TCHAR szVariableName[ 128 + 1 ];
TCHAR szDMVariableName[ 128 + 1 ];
DWORD dwReadAccessLevel;
DWORD dwWriteAccessLevel;
DWORD dwArchivTyp;
TCHAR szTimeNameRange[ 128 + 1 ];
DWORD dwTemplateItemTyp;
DWORD dwTemplateTyp;
BOOL fVisible;
TLG_TPLITEM_INFO tplInfo;
}
TLG_TEMPLATEITEM_INFO;
Members
szTemplateItemName
Name of the trend or column
szTemplateName
Name of the trend or table window template
szArchivName
Name of the log in which the log tag linked with the curve or column is logged.
szVariableName
Name of the log tag linked with the trend or column
szDMVariableName
Name of the data manager tag
dwReadAccessLevel
In the enumeration of trends or columns dwReadAccesLevel contains the user authorization
level for read access.

dwWriteAccessLevel
In the enumeration of trends or columns dwWriteAccesLevel contains the user authorization
level for write access.
dwArchivTyp

szTimeNameRange
Name of the time object which is to be used to determine a time range from a start time.
dwTemplateItemTyp
dwTemplateItemTyp must correspond to the value specified in dwTemplateTyp:
TLG_TEMPLATEITEM_ALL Trend and table templates

TLG_TEMPLATEITEM_CURVE Trend template
TLG_TEMPLATEITEM_TABLE Table template
dwTemplateTyp
dwTemplateTyp identifies the type of window template
TLG_TEMPLATE_CURVE Trend window template

TLG_TEMPLATE_TABLE Table window template
fVisible
TRUE The column or trend is visible.

FALSE The column or trend is invisible.
tplInfo
Structure of the TLG_TPLITEM_INFO (Page 2182) type with the properties of a trend or column
template.
Required files
pdertdef.h
API functions
TLG_TABLESCALE (Page 2174) Table column (properties) (structure)

See also
TLGInsertTemplateItem (Page 2242)
3.8.2.13 TLG_TIME_STR (RT Professional)
Declaration
typedef struct {
DWORD dwBasis;
DWORD dwFactor;
TCHAR szTimeName[
PDE_DB_TIMENAME_MAX_LENGHT + 1 ];
}
TLG_TIME_STR;
Members
dwBasis
Timebase The cycle time is given by multiplying the time factor and timebase.
TLG_TBASE_500MS 500ms
TLG_TBASE_SEC 1 second
TLG_TBASE_MIN 1 minute
TLG_TBASE_HOUR 1 hour
TLG_TBASE_DAY 1 day
dwFactor
Time factor The cycle time is given by multiplying the time factor and timebase.
szTimeName
Name of the time object
Comment
Times are to be understood as acquisition and logging cycles which can be freely assigned.
A time object can be used simultaneously as an acquisition cycle and a logging cycle.
Required files
pde_def.h

API functions
TLGReadTime (Page 2253) Determine time object parameter
See also
TLGReadTime (Page 2253)
3.8.2.14 TLG_TIMEDATA (RT Professional)
Declaration
typedef struct {
TCHAR szTimeName[ _MAX_PATH + 1 ];
DWORD dwTimeBase;
DWORD dwTimeValue;
}
TLG_TIMEDATA;
Members
szTimeName
Name of the time object
dwTimeBase
Timebase The cycle time is given by multiplying the time factor and timebase.
TLG_TBASE_500MS 500ms
TLG_TBASE_SEC 1 second
TLG_TBASE_MIN 1 minute
TLG_TBASE_HOUR 1 hour
TLG_TBASE_DAY 1 day
dwTimeValue
Time factor The cycle time is given by multiplying the time factor and timebase.
Required files
pdertdef.h
API functions

See also
TLG_ENUMTIMES_CALLBACK (Page 2252)
3.8.2.15 TLG_TPLITEM_CURVE (RT Professional)
Declaration
typedef struct {
TLG_CURVESCALEX csx;
TLG_CURVESCALEY csy;
}
TLG_TPLITEM_CURVE;
Members
csx
The TLG_CURVESCALEX (Page 2159) structure contains the data for scaling the X-axis of
a trend.
csy
The TLG_CURVESCALEY (Page 2164) structure contains the data for scaling the Y-axis of
a trend.
Description
TLG_TPLITEM_CURVE is used by the TLG_TPLITEM_INFO (Page 2182) structure.
Required files
pdertdef.h
See also
TLG_CURVESCALEX (Page 2159)
TLG_CURVESCALEY (Page 2164)

3.8.2.16 TLG_TPLITEM_INFO (RT Professional)
Declaration
typedef union {
TLG_TPLITEM_CURVE tplCurve;
TLG_TPLITEM_TABLE tplTable;
}
TLG_TPLITEM_INFO;
Members
tplCurve
The properties of a trend are read from the TLG_TPLITEM_CURVE (Page 2181) structure.
tplTable
The properties of a column are read from the TLG_TPLITEM_TABLE (Page 2183) structure.
Comment
TLG_TPLITEM_INFO is used by the TLG_TEMPLATEITEM_INFO (Page 2177) structure.
Since a tag can be displayed both in a trend and in a table, both structures
TLG_TPLITEM_CURVE and TLG_TPLITEM_TABLE can be assigned values.
Required files
pdertdef.h
See also
TLG_TPLITEM_TABLE (Page 2183)

3.8.2.17 TLG_TPLITEM_TABLE (RT Professional)
Declaration
typedef struct {
TLG_TABLESCALE ts;
}
TLG_TPLITEM_TABLE;
Members
ts
TLG_TABLESCALE (Page 2174) with the properties of a table column.
Description
TLG_TPLITEM_TABLE is used by the TLG_TPLITEM_INFO (Page 2182) structure.
For organizational reasons, TLG_TABLESCALE cannot be used directly in the
TLG_TPLITEM_INFO structure.
Required files
pdertdef.h
See also

3.8.2.18 TLG_VAR_STR (RT Professional)
Declaration
typedef struct {
TCHAR szVarName [PDE_DB_VAR_NAME_MAX_LENGHT + 1];
TCHAR szProcName [PDE_DB_VAR_NAME_MAX_LENGHT + 1];
DWORD dwVarType;
DWORD dwArchivStyle;
TCHAR szWriteBackTo [PDE_DB_VAR_WRITEBACK_MAX_LENGHT + 1];
DWORD dwSupply;
BOOL fLocked;
TCHAR szComment [PDE_DB_VAR_COMMENT_MAX_LENGHT + 1];
TCHAR szRecordCycle [PDE_DB_VAR_CYCLENAME_MAX_LENGHT + 1];
TCHAR szArchivCycle [PDE_DB_VAR_CYCLENAME_MAX_LENGHT + 1];
DWORD dwMultiple;
DWORD dwValueFlow;
DWORD dwValueFollow;
DWORD dwSaveByFault;
DWORD dwArchivTrigger;
TCHAR szTextHighSignal [PDE_DB_VAR_SIGNALTEX_MAX_LENGHT + 1];
TCHAR szTextLowSignal [PDE_DB_VAR_SIGNALTEX_MAX_LENGHT + 1];
DWORD dwValProcess;
TCHAR szFuncValProcess [PDE_DB_VAR_FUNCNAME_MAX_LENGHT + 1];
TCHAR szDLLValProcess [PDE_DB_VAR_DLLNAME_MAX_LENGHT + 1];
TCHAR szFuncStartEvent [PDE_DB_VAR_FUNCNAME_MAX_LENGHT + 1];
TCHAR szDLLStartEvent [PDE_DB_VAR_DLLNAME_MAX_LENGHT + 1];
TCHAR szFuncStopEvent [PDE_DB_VAR_FUNCNAME_MAX_LENGHT + 1];
TCHAR szDLLStopEvent [PDE_DB_VAR_DLLNAME_MAX_LENGHT + 1];
TCHAR szFuncDynamic [PDE_DB_VAR_FUNCNAME_MAX_LENGHT + 1];
TCHAR szDLLDynamic [PDE_DB_VAR_DLLNAME_MAX_LENGHT + 1];
TCHAR szUnitDirect [PDE_DB_VAR_UNITDIR_MAX_LENGHT + 1];
TCHAR szUnitStruct [PDE_DB_VAR_UNITSTR_MAX_LENGHT + 1];
DWORD dwRecItems;
TCHAR szSourceArchiv [PDE_DB_ARC_NAME_MAX_LENGHT + 1];
TCHAR szSourceVarName [PDE_DB_VAR_NAME_MAX_LENGHT + 1];
TCHAR szRawdataName [PDE_DB_VAR_NAME_MAX_LENGHT + 1];
TCHAR szRawConvDLLName [TLG_DB_DLLNAME_MAX_LENGHT + 1];
DWORD dwRawDataIndex;
DWORD dwRawDataFormat;
TLG_SCAL_STR ScaleStruct;
TLG_RECORD_STR RecordStruct;
} TLG_VAR_STR;
Comment
The assignment of the parameters of the TLG_VAR_STR structure depends on the logging
type (acyclic, cyclic-selective or cyclic-continuous) and the tag type (binary or analog).

Members
szVarName
Global parameter for the name of the log tag or the tag group
The characters : ? " ' \ * % and blank may not be used in log tag names, otherwise the error
TLG_API_NAME_WRONG_CHAR is output.
szProcName
Gobal parameter for the name of the process tag
dwVarType
Global parameter which identifies the log tag type.
TLG_VAR_TYP_ANALOG 0x00010001 analog tag:

dwArchivTrigger is set internally to 0L (irrelevant)
TLG_VAR_TYP_BIN 0x00010002 binary tag:
dwValProcess is set internally to 0L (irrelevant)
TLG_VAR_TYP_COMPRESS 0x00010004 Tag for compressed logs:
dwSuppy is set internally to TLG_SUPPLY_BY_SYSTEM,
dwSaveByFault is set internally to TLG_SAVE_LAST_VALUE
TLG_VAR_TYP_PROCESS 0x00010008 process-controlled tag
invalid value Error message: TLG_API_VARTYPE_MISMATCH
dwArchivStyle
Global parameter which identifies the logging type.
TLG_STY_ACYCLIC 0x00800001 Acyclic logging

TLG_STY_CYCLIC_CON 0x00800002 Cyclic-continuous logging
TLG_STY_ CYCLIC_SEL 0x00800004 Cyclic-selective logging
TLG_STY_ON_CHANGE 0x00800008 Detection for change
invalid value Error message TLG_API_ERR_ARCHIVSTYLE
szWriteBackTo
Global parameter into which the name of the log tag is to be written back.
dwSupply
Global parameter which identifies the tag supply type.
TLG_SUPPLY_BY_HAND 0L - FALSE Manual tag input

TLG_SUPPLY_BY_SYSTEM 1L - TRUE Supply from system (process coupling or internal tag)
invalid value Error message TLG_API_INVALID_PARAM
If dwVarType = TLG_VAR_TYP_COMPRESS, TLG_SUPPLY_BY_SYSTEM is always set

internally.

fLocked
Global parameter which identifies the handling of the logging at system start.
TRUE disabled
FALSE enabled
szComment
Global parameter for the comment on the log tag
szRecordCycle
Name of the time object (e.g.: "1 minute") which specifies the acquisition cycle.
The parameter is relevant for the cyclic-selective, cyclic-continuous acquisition of analog and
binary tags.
szArchivCycle
Name of the time object (e.g.: "1 minute") which specifies the logging cycle. The logging cycle
is given by multiplying dwMultiple by szArchivCycle.
The parameter is relevant for the cyclic-selective, cyclic-continuous logging of analog and
binary tags.
dwMultiple
Identifies the multiplication factor. The logging cycle is given by multiplying dwMultiple by
szArchivCycle.
binary tags.
dwValueFlow
Identifies the number of flow values
binary tags.
dwValueFollow
Identifies the number of return values.
binary tags.
dwSaveByFault
Identifies the memory behavior in case of a fault.
The parameter is relevant for analog and binary tags of all logging types.
TLG_SAVE_LAST_VALUE 1L Save last valid value

TLG_SAVE_SUBST_VALUE 2L Save substitute value
If dwVarType = TLG_VAR_TYP_COMPRESS, TLG_SAVE_LAST_VALUE is always set

internally.

dwArchivTrigger
Identifies the trigger behavior of the logging
The parameter is relevant for the cyclic-selective, cyclic-continuous logging of binary tags.
TLG_TRIG_CHANGE 1L Logging for every signal change

TLG_TRIG_CHANGE_01 2L Logging for signal change 0 -> 1
TLG_TRIG_CHANGE_10 3L Logging for signal change 1 -> 0
TLG_TRIG_ALLWAYS 4L The value is logged in every logging cycle even without a signal
change.
If dwVarType = TLG_VAR_TYP_ANALOG, 0L is always set internally (irrelevant).
szTextHighSignal
Text for signal state 1.
szTextLowSignal
Text for the signal state 0.
dwValProcess
Identifies the processing of the log value to be saved over the acquired values within the logging
cycle.
The parameter is relevant for the cyclic-selective, cyclic-continuous logging of analog tags.
TLG_VAL_ACTUAL 1L Actual value

TLG_VAL_AVERAGE 2L Average value
TLG_VAL_SUM 3L Sum
TLG_VAL_MIN 4L Minimum value
TLG_VAL_MAX 5L Maximum value
TLG_VAL_DLL 6L Function or DLL
If dwVarType = TLG_VAR_TYP_BIN , 0L is always set internally (irrelevant).
szFuncValProcess
Name of the action or the DLL function which specifies the processing of the log value to be
saved.
binary tags and only relevant ifdwValProcess = TLG_VAL_DLL.
szDLLValProcess
Name of the DLL
binary tags and only relevant if dwValProcess = TLG_VAL_DLL.

szFuncStartEvent
Name of the action or the DLL function which specifies the start event.
binary tags.
szDLLStartEvent
Name of the DLL.
binary tags.
szFuncStopEvent
Name of the action or the DLL function which specifies the stop event.
The parameter is relevant for the cyclic-selective logging of analog and binary tags.
szDLLStopEvent
Name of the DLL
The parameter is relevant for the cyclic-selective logging of analog and binary tags.
szFuncDynamic
Name of the action or the DLL function which specifies the dynamic switching of the detection
and/or logging cycle.
binary tags.
szDLLDynamic
Name of the DLL
binary tags.
szUnitDirect
Identifies the unit of the log tag.
The parameter is relevant for analog tags of all logging types.
szUnitStruct
Name of the structure that contains the unit of the log tag. NULL if the unit is configured directly
in szUnitDirect.
The parameter is relevant for analog tags of all logging types.
dwRecItems
szSourceArchiv
Name of the source archive.
The parameter is relevant for the cyclic-continuous logging.
szSourceVarName
Name of the log tag in the source log
The parameter is relevant for the cyclic-continuous logging.

szRawdataName
Name of the raw data tag
The parameter is relevant for process-controlled tags.
szRawConvDLLName
Name of the normalization DLL
dwRawDataIndex
The number of the raw data tag corresponds to the log ID of the PLC in connection with S7PMC.
The parameter is relevant for process-controlled variables.
dwRawDataFormat
Format of the raw data tag
ScaleStruct
TLG_SCAL_STR (Page 2172) Structure with the limits of the tag.
RecordStruct
Required files
pde_def.h
API functions
TLGReadVariable (Page 2209) Determine tag parameter
See also
TLGReadVariable (Page 2209)
TLG_SCAL_STR (Page 2172)
3.8.2.19 TLG_VARIABLE_INFO (RT Professional)
Declaration
typedef struct {
DWORD dwVariableTyp;
TCHAR szVariableName[ _MAX_PATH + 1 ];
}
TLG_VARIABLE_INFO;

Members
dwVariableTyp
dwVariableTyp identifies the type of tag. Possible values are:
TLG_VAR_TYP_ANALOG analog tag

TLG_VAR_TYP_BIN binary tag
TLG_VAR_TYP_COMPRESS tag for compressed logs
TLG_VAR_TYP_PROCESS process-controlled tag
szVariableName
Name of the tag
Required files
pdertdef.h
pde_typ.h
API functions
See also
TLG_ENUMVARIABLES (Page 2208)
3.8.3.1 TLGCSConnect (RT Professional)
Description
The function establishes a connection with the WinCC project database.
Declaration
BOOL TLGCSConnect (
HWND hwndParent,
LPCMN_ERROR lpError );

Parameters
hwndParent
Window handle of the parent window
lpError
Return value
TRUE
FALSE
Error
Required files
pdecscli.h
pdecscli.lib
pdecscli.dll
Related functions
TLGCSConnectEx (Page 2192) Set up connection to project database

TLGCSDisConnect (Page 2193) Set up connection to project database
Examples
Enum all acquisition and logging times (Page 2264) "TL01.cpp"
Read parameters of time object (Page 2278) "TL01.cpp"
Enum logs (Page 2267) "TL01.cpp"
Read log (Page 2274) "TL01.cpp"
See also
TLGCSConnectEx (Page 2192)
Enum logs (Page 2267)
TLGOpenProject (Page 2200)
Read parameters of time object (Page 2278)
Enum all acquisition and logging times (Page 2264)

Read log (Page 2274)

TLGCSDisConnect (Page 2193)
3.8.3.2 TLGCSConnectEx (RT Professional)
Description
The function establishes a connection with the WinCC project database.
Declaration
BOOL TLGCSConnectEx (
HWND hwndParent,
DWORD dwMode,
Parameters
hwndParent
dwMode
lpError
Return value
TRUE
FALSE
Error
Required files
pdecscli.h
pdecscli.lib
pdecscli.dll

Related functions
TLGCSConnect (Page 2190) Set up connection to project database
See also
TLGCSConnect (Page 2190)
3.8.3.3 TLGCSDisConnect (RT Professional)
Description
The function terminates an established connection to the WinCC project database. The call is
required so that the DLL can be cleanly unloaded again.
Note
The call may not be used in the destructor of an application (EXE, DLL, OCX etc.) because
this can lead to a frozen call and subsequent program crash due to specific Microsoft-based
mechanisms.
Declaration
BOOL TLGCSDisConnect (
Parameters
lpError
Return value
TRUE
FALSE
Error

Required files
pdecscli.h
pdecscli.lib
pdecscli.dll
Related functions
Examples
See also
3.8.3.4 TLGChangeLanguage (RT Professional)
Description
The currently used data language can be switched with this function.
Declaration
BOOL TLGChangeLanguage (
DWORD dwLanguage,
PCMN_ERROR lpError );
Parameters
dwLanguage
Code of the language to be used in future

lpError
Return value
TRUE
Data language switched
FALSE
Error
Error messages
TLG_API_INVALID_PARAM invalid/wrong parameter supply

TLG_API_NO_INTERFACE Access to lower level COM interfaces failed
TLG_API_NO_CONNECTION No connection established with an activated project
TLG_API_ERR_SUPPLY An error has occurred
Required files
pdertcli.h
pde_glob.h
pdertcli.lib
pdertcli.dll
3.8.3.5 TLGConnect (RT Professional)
Description
The function initializes the log system and establishes a connection with the Tag Logging
Runtime.
Declaration
BOOL TLGConnect (
HWND hwndParent,

Parameters
hwndParent
lpError
Return value
TRUE
FALSE
Error
Comment
The call generates an invisible window for the communication which is only deleted with the
TLGDisconnect function. This may be important when Windows functions are also used.
Error messages

Required files
pdertcli.h
pde_glob.h
pdertcli.lib
pdertcli.dll
Related functions
TLGDisconnect (Page 2197) Terminate connection
Examples
Enumerate logs (Page 2272) "TL02.cpp"

See also
Enumerate logs (Page 2272)
TLGDisconnect (Page 2197)
Edit curve template - Example 1 (Page 2261)
3.8.3.6 TLGDisconnect (RT Professional)
Description
An existing connection to the Tag Logging Runtime is disconnected with this function.
Declaration
BOOL TLGDisconnect (
Parameters
lpError
Return value
TRUE
Connection terminated
FALSE
Error
Comment
Note
The call may not be used in the destructor of an application (EXE, DLL, OCX...) because this
can lead to jamming of the call and thus the program due to specific Microsoft-based
mechanisms.

Error messages

Required files
pdertcli.h
pde_glob.h
pdertcli.lib
pdertcli.dll
Related functions
TLGConnect (Page 2195) Establish connection
Examples
See also
TLGConnect (Page 2195)
3.8.4 Project management functions (RT Professional)
3.8.4.1 TLGCloseProject (RT Professional)
Description
Closes the current project. All the data objects belonging to this project are closed.
The function is not longer significant and always supplies TRUE as a return value.

Declaration
BOOL TLGCloseProject(
HANDLE hProject,
LPCMN_ERROR lpoes );
Parameters
hProject
Handle of a project opened with TLGOpenProject.
lpoes
Return value
TRUE
Project closed
FALSE
Error
Required files
pdecscli.h
pdecscli.lib
pdecscli.dll
Examples
See also

3.8.4.2 TLGOpenProject (RT Professional)
Description
Establishes a connection with the WinCC project database.
Declaration
BOOL TLGOpenProject (
HANDLE* lphProject,
LPTSTR lpszProjectName,
HWND hwndParent,
Parameters
lphProject
Address of a memory area in which the handle is to be saved.
lpszProjectName
Name of the project to be opened.
The project path to be specified here can be determined with one of the following API functions:
● DMEnumOpenedProjects
● DMGetRuntimeProject
● TLGEnumProject
If a different project path than the currently open project is specified the
TLG_API_PROJECT_NAME_NOT_EXIST error is returned. The
TLG_API_NO_PROJECT_EXIST error is returned if no project is open.
hwndParent
Handle of the parent window
lpoes
Return value
TRUE
Project opened
FALSE
Error

Comment
If no connection was established with the WinCC project data base by TLGCSConnect first,
the connection error TLG_API_NO_CONNECTION is returned.
Error messages

TLG_API_NO_CONNECTION No connection established with an activated
project
TLG_API_NO_PROJECT_EXIST No project exists
TLG_API_PROJECT_NAME_NOT_EXIST Project name not found
Required files
pdecscli.h
pdecscli.lib
pdecscli.dll
Related functions

TLGCSConnectEx (Page 2192) Set up connection to project database
Examples
Enum tags of a log (Page 2270) "TL02.cpp"
See also
TLGEnumProject (Page 2202)
TLGCSConnectEx (Page 2192)


Enum tags of a log (Page 2270)
3.8.4.3 TLGEnumProject (RT Professional)
Description
The function determines the names of the open projects.
Declaration
BOOL TLGEnumProject (
TLG_ENUM_PROJECT_NAME_CALLBACK lpCallbackFunc,
PVOID lpUser,
Parameters
lpCallbackFunc
Pointer to your callback function which is called for every open project.
lpUser
lpoes
Return value
TRUE
Projects listed
FALSE
Error
Required files
pdecscli.h
pdecscli.lib
pdecscli.dll

Related functions
TLG_ENUM_PROJECT_NAME_CALLBACK List projects (callback)

(Page 2203)
See also
TLG_ENUM_PROJECT_NAME_CALLBACK (Page 2203)
3.8.4.4 TLG_ENUM_PROJECT_NAME_CALLBACK (RT Professional)
Description
In order to be able to evaluate the projects listed by the system, you must provide a callback
function of the TLG_ENUM_PROJECT_NAME_CALLBACK type.
Declaration
BOOL ( * TLG_ENUM_PROJECT_NAME_CALLBACK) (
LPTSTR lpszName,
PVOID lpUser );
Parameters
lpszName
The lpszName pointer refers to the name of the first project.
lpUser
function.
Return value
The return values depend on your implementation.
Note

Required files
pdecscli.h
Related functions
See also
TLGEnumProject (Page 2202)
3.8.5 Functions for processing tags (RT Professional)
3.8.5.1 TLGEnumVariables (RT Professional)
Description
The function determines all the tag names of a log.
Declaration
BOOL TLGEnumVariables (
HANDLE hProject,
LPTSTR lpszArchivName,
TLG_ENUM_VARIABLE_NAME_CALLBACK lpCallbackFunc,
PVOID lpUser,
Parameters
hProject
Handle of the project in which the log is located.
lpszArchivName
Pointer to the name of the log
lpCallbackFunc
Pointer to your callback function which is called for every tag entry in the log.
lpUser

lpoes
Return value
TRUE
Log tags listed
FALSE
Error
Required files
pdecscli.h
pdecscli.lib
pdecscli.dll
Related functions
TLG_ENUM_VARIABLE_NAME_CALLBACK List tags (callback)

(Page 2205)
See also
TLG_ENUM_VARIABLE_NAME_CALLBACK (Page 2205)
3.8.5.2 TLG_ENUM_VARIABLE_NAME_CALLBACK (RT Professional)
Description
In order to be able to evaluate the tags listed by the system, you must provide a callback
function of the TLG_ENUM_VARIABLE_NAME_CALLBACK type.
Declaration
BOOL ( * TLG_ENUM_VARIABLE_NAME_CALLBACK) (
LPTSTR lpszName,
PVOID lpUser );

Parameters
lpszName
The lpszName pointer refers to the name of the first tag.
lpUser
function.
Return value
TRUE
FALSE
Note
Required files
pdecscli.h
Related functions
See also
TLGEnumVariables (Page 2204)
3.8.5.3 TLGEnumVariablesEx (RT Professional)
Description
The function determines all the tag names of a log.

Declaration
BOOL TLGEnumVariablesEx (
LPCTSTR lpszArchiveName,
TLG_ENUMVARIABLES lpfnCallback,
LPVOID lpUser,
Parameters
lpszArchiveName
Pointer to the name of the log whose tags are to be listed.
lpfnCallback
Pointer to your callback function which is called for every tag of the log.
lpUser
lpError
Return value
TRUE
Tags listed
FALSE
Error
Error messages

Required files
pdecscli.h
pdecscli.lib
pdecscli.dll

pdertcli.h
pdertcli.lib
pdertcli.dll
Related functions
Examples
See also
3.8.5.4 TLG_ENUMVARIABLES (RT Professional)
Description
In order to be able to evaluate the data of a tag listed by the system, you must provide a callback
function of the TLG_ENUMVARIABLES type.
Declaration
BOOL ( * TLG_ENUMVARIABLES) (
PTLG_VARIABLE_INFO lpvi,
LPVOID lpUser );
Parameters
lpvi
Address of a structure of TLG_VARIABLE_INFO (Page 2189) type with the data of a tag.
lpUser
function.

Return value
TRUE
FALSE
Note
Required files
pdertcli.h
pde_glob.h
pdertdef.h
Related functions
TLGEnumVariablesEx (Page 2206) List tags
Examples
See also
TLGEnumVariablesEx (Page 2206)
TLG_VARIABLE_INFO (Page 2189)
TLGEnumArchivsEx (Page 2216)
3.8.5.5 TLGReadVariable (RT Professional)
Description
Read the parameters of a tag

Declaration
BOOL TLGReadVariable (
HANDLE hProject,
LPTSTR lpszVariableName,
PTLG_VAR_STR lpVariable,
Parameters
hProject
Handle of the project in which the tag to be processed is located.
lpszArchivName
lpszVariableName
Pointer to the name of a tag of the log
lpVariable
Address of the TLG_VAR_STR (Page 2184) structure from which the data of the tag are read
out.
lpoes
Return value
TRUE
Parameters read
FALSE
Error
Required files
pdecscli.h
pdecscli.lib
pdecscli.dll

Related functions

TLGReadVariable6 Determine tag parameter
Examples
See also
TLG_VAR_STR (Page 2184)
TLGEnumVariables (Page 2204)
3.8.6 Functions for processing logs (RT Professional)
3.8.6.1 TLGEnumArchives (RT Professional)
Description
The function determines the names of all logs in the project hproject. All types of logs can be
processed with this function.
Declaration
BOOL TLGEnumArchives (
HANDLE hProject,
TLG_ENUM_ARCHIV_CALLBACK lpCallbackFunc,
PVOID lpUser,
Parameters
hProject
Handle of the project in which the logs are located.
lpCallbackFunc
Pointer to your callback function which is called for every log.

lpUser
lpoes
Return value
TRUE
Logs listed
FALSE
Error
Required files
pdecscli.h
pdecscli.lib
pdecscli.dll
Related functions

TLG_ENUM_ARCHIV_CALLBACK (Page 2212) List logs (callback)
Examples
See also
TLG_ENUM_ARCHIV_CALLBACK (Page 2212)
3.8.6.2 TLG_ENUM_ARCHIV_CALLBACK (RT Professional)
Description
In order to be able to evaluate the logs listed by the system, you must provide a callback
function of the TLG_ENUM_ARCHIV_CALLBACK type.

Declaration
BOOL ( * TLG_ENUM_ARCHIV_CALLBACK) (
LPTSTR lpszName,
PVOID lpUser );
Parameters
lpszName
The lpszName pointer refers to the name of the log.
lpUser
function.
Return value
TRUE
FALSE
Comment
Note
Required files
pdecscli.h
Related functions

Examples
See also
TLGEnumArchives (Page 2211)
3.8.6.3 TLGEnumArchivs (RT Professional)
Description
Enumerates the existing logs Unlike TLGEnumArchivsSel the logs to be listed can only be
limited by the log type.
The information of a log is provided in structures of the TLG_TABLE_INFO type with the
callback function. The log name is transferred here as a table name, i.e. in the form
"UA#ARCHIV#ArchivName" or "PDE#HD#Archivname#Variablenname".
Declaration
BOOL TLGEnumArchivs (
DWORD dwArchivTyp,
TLG_ENUMTABLES lpfnCallback,
LPVOID lpUser,
Parameters
dwArchivTyp

NULL All logs are enumerated.
lpfnCallback
lpUser

lpError
Return value
TRUE
Logs listed
FALSE
Error
Error messages

Required files
pdertcli.h
pde_glob.h
pdertdef.h
pdertcli.lib
pdertcli.dll
Related functions
TLGEnumArchivsEx (Page 2216) List logs

Examples
See also
TLGEnumArchivsSel (Page 2217)


3.8.6.4 TLGEnumArchivsEx (RT Professional)
Description
Enumerates the existing logs. Unlike TLGEnumArchivsSel the logs to be listed can only be
limited by the log type (user, process value, compressed log).
callback function. Unlike TLGEnumArchivs not the table name of the log but the "pure" log
name is transferred.
Declaration
BOOL TLGEnumArchivsEx (
DWORD dwArchivTyp,
LPVOID lpUser,
Parameters
dwArchivTyp
TLG_ARCTYP_U_USER User log

lpfnCallback
lpUser
lpError

Return value
TRUE
Logs are listed
FALSE
Error
Error messages

project
Required files
pdertcli.h
pde_glob.h
pdertdef.h
pdertcli.lib
pdertcli.dll
Related functions

See also
TLGEnumArchivs (Page 2214)
3.8.6.5 TLGEnumArchivsSel (RT Professional)
Description
The function enumerates the existing log types. Unlike TLGEnumArchivs the logs to be listed
can be limited by the logging type (circular log, sequential log) in addition to by the log type.

callback function. The log name is transferred here as a table name, i.e. in the form
"UA#ARCHIV#ArchivName" or "PDE#HD#Archivname#Variablenname". All tags of the log
are enumerated. This form is required for example in TLGBackup.
Declaration
BOOL TLGEnumArchivsSel (
DWORD dwArchivTyp,
DWORD dwSaveTyp,
LPVOID lpUser,
Parameters
dwArchivTyp

dwSaveTyp
dwSaveTyp identifies the type of log:
TLG_ARCTYP_ALL Circular and sequential logs

TLG_ARCTYP_CIRCULAR Circular logs
TLG_ARCTYP_FOLLOW Sequential logs
lpfnCallback
lpUser
lpError

Return value
TRUE
The logs are listed.
FALSE
Error
Error messages

TLG_API_INVALID_PARAM invalid or wrong parameter supply
Required files
pdertcli.h
pde_glob.h
pdertdef.h
pdertcli.lib
pdertcli.dll
Related functions

AUTOHOTSPOT List logs
See also
TLG_TABLE_INFO (Page 2173)
3.8.6.6 TLG_ENUMTABLES (RT Professional)
Description
In order to be able to evaluate the logs listed by the system, you must provide a callback
function of the TLG_ENUMTABLES type.

Declaration
BOOL TLG_ENUMTABLES (
LPTSTR lpTableName,
PTLG_TABLE_INFO lpti,
PVOID lpUser );
Parameters
lpTableName
lpti
Information about the database table is contained in the TLG_TABLE_INFO (Page 2173)
structure.
lpUser
function.
Return value
TRUE
FALSE
Comment
Note
Required files
pdertcli.h
pde_glob.h
pdertdef.h

pdertcli.lib
pdertcli.dll
Related functions

Examples
Enumerate archives "TL02.cpp"
See also
TLG_TABLE_INFO (Page 2173)
3.8.6.7 TLGFreeMemory (RT Professional)
Description
A memory area allocated by TLGGetArchivDataEx is freed with this function.
Declaration
BOOL TLGFreeMemory (
LPVOID lpMemory );
Parameters
lpMemory
You get the pointer to the memory area to be freed when calling the TLGGetArchivDataEx
function in the ppTLGData parameter.
Note
The pointer must be initialized before calling TLGGetArchivDataEx() with NULL and checked
before calling TLGFreeMemory() for not equal to NULL.

Return value
TRUE
Memory is freed
FALSE
Error
Note
Required files
pdertcli.h
pdertcli.lib
pdertcli.dll
Related functions
See also
3.8.6.8 TLGGetArchivData (RT Professional)
Description
The function reads out the data from a log between two times. Unlike TLGGetArchivDataEx
the values of the log tags are provided by a callback function.
A maximum 10,000 data records can be read with one call. If there are more data records
between start time and end time, you only get the first 10,000.
You get the following data records by adding a millisecond to the time of the last data record
and using this as a start time in a new call for TLGGetArchivData.

Declaration
BOOL TLGGetArchivData (
LPTSTR lpszVarName,
SYSTEMTIME stStart,
SYSTEMTIME stStop,
TLG_GETARCHIVDATA_CALLBACK lpfnCallback,
PVOID lpUser,
DWORD dwFlags,
Parameters
lpszArchivName
Pointer to the name of the log from which data is to be read.
lpszVarName
Pointer to the name of the log tag whose values are to be read.
stStart
Start time from which data should be read.
stStop
End time up to which the data should be read
lpfnCallback
Pointer to your callback function which is called for every measuring point to be read out.
lpUser
dwFlags
lpError
Return value
TRUE
Log data determined

FALSE
Error
Error messages

TLG_API_NODEFAULTSERVER No standard server configured
TLG_API_NOSERVER No standard server configured and no local server available
Required files
pdertcli.h
pde_glob.h
pdertdef.h
pdertcli.lib
pdertcli.dll
Related functions

(Page 2224)
See also
TLG_GETARCHIVDATA_CALLBACK (Page 2224)
3.8.6.9 TLG_GETARCHIVDATA_CALLBACK (RT Professional)
Description
In order to evaluate the log data listed by the system, you must provide a callback function of
the TLG_GETARCHIVDATA_CALLBACK type.

Declaration
BOOL ( * TLG_GETARCHIVDATA_CALLBACK) (
PTLG_GETARCHIVDATA lpGAD,
PVOID lpUser );
Parameters
lpGAD
The system reserves temporary storage of the length of the TLG_GETARCHIVDATA structure
per log. The lpGAD pointer refers to the beginning of the first element.
lpUser
function.
Return value
TRUE
FALSE
Note
Only move data if possible. The following types of function calls within the callback can lead
to deadlocks or a stack overflow:
● Functions in which a message loop is accessed, e.g. GetMessage
● Runtime API functions from the same DLL
Required files
pdertcli.h
pde_glob.h
pdertdef.h
Related functions

TLG_GETARCHIVDATA Log data of process value logs (structure) Log data of com‐
(Page 2168) pressed logs (structure)

See also
TLGGetArchivData (Page 2222)
TLG_GETARCHIVDATA (Page 2168)
3.8.6.10 TLGGetArchivDataEx (RT Professional)
Description
Reads out the data from a log between two times. Unlike TLGGetArchivData the values of the
log tags are saved in the memory.
Note
The assigned memory in ppTlgData must be freed by TLGFreeMemory.
Declaration
BOOL TLGGetArchivDataEx (
LPCTSTR lpszArchivName,
LPCTSTR lpszVarName,
SYSTEMTIME* pstStart,
SYSTEMTIME* pstStop,
PTLG_ARCHIVDATARAW* ppTlgData,
DWORD* pdwNumberOfData,
DWORD* pdwFlags,
Parameters
lpszArchivName
Pointer to the log name from which the data are read out.
lpszVarName
Pointer to the name of the log tag whose values are read.
stStart
Start time from which data are read.
stStop
End time up to which the data are read
If a current timer for transferring a SYSTEMTIME parameter is required, use the GetLocalTime
function and not GetSystemTime. There is generally a considerable time difference between
these two functions.

ppTlgData
Address of a pointer in which the address of the data of the log tag is stored. The data field is
allocated by TLGGetArchivDataEx and gets structures of the TLG_ARCHIVDATARAW
(Page 2154) type.
Note
The assigned memory must be freed again by TLGFreeMemory.
pdwNumberOfData
Pointer to number of data records
● Before the call: Maximum number of data records to be read
● After the call: Number of read data records with the values of the log tags (of structures of
the TLG_ARCHIVDATARAW type).
Maximum 10,000 data records can be read with a call. If there are more data records between
start time and end time, you only get the first 10000. You get the next ones by adding a
millisecond to the time of the last data record and using this as a start time in a new call for
TLGGetArchivDataEx.
dwFlags
lpError
Return value
TRUE
Log data determined
FALSE
Error
Note
The memory assigned by TLGGetArchivDataEx in ppTlgData must be freed again by
TLGFreeMemory.

Error messages

project
TLG_API_NOSERVER No standard server configured and no local server
available
Required files
pdertcli.h
pde_glob.h
pdertdef.h
pdertcli.lib
pdertcli.dll
Related functions

TLGFreeMemory (Page 2221) Free memory
See also
TLGFreeMemory (Page 2221)
TLGGetArchivData (Page 2222)
TLG_ARCHIVDATARAW (Page 2154)
3.8.6.11 TLGGetClosestTime (RT Professional)
Description
The function determines the adjacent logging times at a given time.

Declaration
BOOL TLGGetClosestTime (
SYSTEMTIME* pstTime,
BOOL bPrevious,
Parameters
lpszArchivName
lpszVarName
Pointer to the name of the tag
pstTime
pstTime is used as an input and output parameter. When calling TLGGetClosestTime, pstTime
contains the system time for which the adjacent logging times are to be determined. After the
successful function call, pstTime contains the closest logging time.
bPrevious
bPrevious identifies whether a previous or next logging time is to be determined at the
transferred system time.
TRUE A previous logging time is determined.

FALSE A next logging time is determined.
lpError
Return value
TRUE
pstTime contains an adjacent logging time.
FALSE
Error or no adjacent logging time could be determined.
Comment
If bPrevious is specified as TRUE and pstTime contains an existing value, exactly this time
may be returned and not the previous time. If bPrevious is specified as FALSE, the next time
is always supplied.

Error messages

project
TLG_API_VARIABLE_NAME_NOT_EXIST No tag of this name found
TLG_API_TIME_NAME_NOT_EXIST No time object of this name found
TLG_API_NO_TIME_EXIST No time object exists
Required files
pdertcli.h
pde_glob.h
pdertcli.lib
pdertcli.dll
Related functions
TLGGetClosestTimeEx (Page 2230) Determine logging time
See also
TLGGetClosestTimeEx (Page 2230)
3.8.6.12 TLGGetClosestTimeEx (RT Professional)
Description
The function determines the adjacent logging times at a given time.
Declaration
BOOL TLGGetClosestTimeEx (
SYSTEMTIME* pstTime,
BOOL bPrevious,
BOOL bIgnoreInvalid,

Parameters
lpszArchivName
lpszVarName
pstTime
pstTime is used as an input and output parameter. When calling TLGGetClosestTime, pstTime
contains the system time for which the adjacent logging times are determined. After the
successful function call, pstTime contains the closest logging time.
bPrevious
bPrevious identifies whether a previous or next logging time is to be determined at the
transferred system time.
TRUE A previous logging time is determined.

FALSE A next logging time is determined.
bIgnoreInvalid
Indicates whether values with the connection fault flag are to be ignored in the time
determination.
TRUE The values with connection fault are ignored and skipped.
FALSE All values are used for the time determination so that the same function exists as in
TLGGetClosestTime().
lpError
Return value
TRUE
pstTime contains an adjacent logging time.
FALSE
Error or no adjacent logging time could be determined.
Comment
If bPrevious is specified as TRUE and pstTime contains an existing value, exactly this time
may be returned and not the previous time. If bPrevious is specified as FALSE, the next time
is always supplied.

Error messages

TLG_API_VARIABLE_NAME_NOT_EXIST No tag of this name found
TLG_API_TIME_NAME_NOT_EXIST No time object of this name found
TLG_API_NO_TIME_EXIST No time object exists
Required files
pdertcli.h
pde_glob.h
pdertcli.lib
pdertcli.dll
Related functions
TLGGetClosestTime (Page 2228) Determine logging time
See also
TLGGetClosestTime (Page 2228)
3.8.6.13 TLGInsertArchivData (RT Professional)
Description
The function offers the possibility of inserting any data in an existing log on the hard disk.
If you perform TlgInsertArchivData for values which were created during summer time, you
have to allow for the time shift. Set the PDE_RT_DAYLIGHT flag when calling these values.
Without this flag, reading calls, e.g. TLGGetArchivData or TLGGetClosestTime return the
default time.
Note
Since the correctness of the data to be inserted is not checked, there is a danger of the log
being destroyed.

Declaration
BOOL TLGInsertArchivData (
PTLG_ARCHIVDATARAW pTlgData,
DWORD dwNumberOfData,
DWORD dwFlags,
Parameters
lpszArchivName
lpszVarName
pTlgData
Pointer to the first of the structures of the TLG_ARCHIVDATARAW type with the tag values
to be inserted in the log.
dwNumberOfData
Number of tag values (of the TLG_ARCHIVDATARAW structures) to be inserted.
dwFlags
TLG_API_FLG_FAST_INSERT If this flag is set, the data are written much faster in optimized
mode. However, a prerequisite for using this performance op‐
timization is that the timestamps of the written data records
are sorted chronologically and are always more up to date than
the data records already in the log.
When inserting older data records between existing data re‐
cords, this flag may not be used. If values are inserted which
are older than existing ones or ones which are not sorted chro‐
nologically, the older values are rejected without error mes‐
sages.
TLG_API_FLG_REPLACE_INSERT If this flag is set, the data in the log is overwritten. The
"TLG_API_FLG_REPLACE_INSERT" flag cannot be used to‐
gether with the "TLG_API_FLG_FAST_INSERT" flag.
TLG_API_FLG_DETAILED_ER‐ If this flag is set, detailed error codes are output.
RORCODES
lpError

Return value
TRUE
Tag values inserted in log
FALSE
Error
Error codes
If a log which is located in the main memory is specified under lpszArchivName, an error
message TLG_API_ERR_SUPPLY is output.
Only logs on the hard disk can be addressed with this function. If write errors occurred for
individual values, a more exact error description is returned in CMN_ERROR . Due to the
limited length of the CMN_ERR.szErrorText the number of detail errors is limited to max. 57.
If a log which is located in the main memory is specified under lpszArchivName, an error
message TLG_API_ERR_SUPPLY is output.
dwError1 TLG_API_ERR_SUPPLY
dwError2 0
dwError3 Line number in the source code
dwError4 Number of errors (max. 57)
dwError5 Number of data to be written (dwNumberOfData)
szErrorText TLG-API: an error occurred, line xxx; Pos:0=0xXX,1=0xXX,2=0xXX, ... (,
56=0xXX)
When the TLG_API_FLG_DETAILED_ERRORCODES flag is set in dwFlags, the following

detailed error codes are output.
Error code Description Value (with Value (without

flag) flag)
OK No error 0x00 0x00
Error General error status 0x01 0x40
Record already exists The data record already exists and will 0x02 0x80
not be overwritten.
Not allowed Manual value input is disabled. 0x04 0x800
Limit violated Value outside the limits 0x08 0x1000
No server Problem with the server connection 0x10 0x10
Tag not found Logging tag not found 0x20 0x40
Invalid flag Prohibited combination of flags 0x40 0x40
TLG_API_FLG_REPLACE_INSERT
and TLG_API_FLG_FAST_INSERT
Time stamp is in the future Values with a time stamp in the future 0x80 0x40
are not allowed
Log is RAM-based Write operations to logs in the main 0x100 0x40
memory are not allowed

Error messages

Required files
pdertcli.h
pde_glob.h
pdertdef.h
pdertcli.lib
pdertcli.dll
3.8.6.14 TLGLockArchiv (RT Professional)
Description
Locks or frees a complete log. New data are not logged if a log is locked.
Declaration
BOOL TLGLockArchiv (
HWND hwnd,
BOOL fLocked,
Parameters
hwnd
Window handle of the PDE runtime window
lpszArchivName
fLocked
TRUE: Lock log

FALSE: Free log

lpError
Return value
TRUE
Log locked/freed
FALSE
Error
Error messages

TLG_API_NO_ARCHIV_EXIST No log available
Required files
pdertcli.h
pde_glob.h
pdertcli.lib
pdertcli.dll
3.8.6.15 TLGLockVariable (RT Professional)
Description
Locks or frees a tag. A locked tag is no longer updated and no longer logged.

Declaration
BOOL TLGLockVariable (
HWND hwnd,
LPTSTR lpszVarName,
BOOL fLocked,
Parameters
hwnd
Window handle of the PDE runtime window
lpszArchivName
To select a certain server the "ServerPrefix::" can be prefixed to the log name.
lpszVarName
fLocked
TRUE: Lock tag

FALSE: Free tag
lpError
Return value
TRUE
Tag freed / locked
FALSE
Error
Error messages

TLG_API_NO_ARCHIV_EXIST No log available


Required files
pdertcli.h
pde_glob.h
pdertcli.lib
pdertcli.dll
3.8.6.16 TLGReadArchiv (RT Professional)
Description
Read the parameters of an existing log in the hProject project. All types of logs can be
processed with this function.
Declaration
BOOL TLGReadArchiv (
HANDLE hProject,
PTLG_ARCHIV_STR lpArchiv,
Parameters
hProject
Handle of the project in which the log to be processed is located.
lpszArchivName
Name of the log to be processed.
lpArchiv
Address of the TLG_ARCHIV_STR (Page 2151) structure in which the paraneters of the log
are to be saved.
lpoes

Return value
TRUE
Log contents read
FALSE
Error
Required files
pdecscli.h
pdecscli.lib
pdecscli.dll
Related functions

TLGReadArchiv6 Read log parameters
Examples
Read log (Page 2274)"TL01.cpp"
See also
TLG_ARCHIV_STR (Page 2151)
3.8.7 Functions for trend and table views (RT Professional)
3.8.7.1 TLGCloseWindow (RT Professional)
Description
An application window is closed with the function.

Declaration
BOOL TLGCloseWindow (
HWND hwnd,
Parameters
hwnd
Handle to the parent window of the application to be closed.
lpError
Return value
TRUE
Application window closed
FALSE
Error
Error messages

Required files
pdertcli.h
pde_glob.h
pdertcli.lib
pdertcli.dll
3.8.7.2 TLGDrawCurvesInDC (RT Professional)
Description
Trends can be shown in an application window with this function.

Declaration
BOOL TLGDrawCurvesInDC (
HDC hDC,
PRECT lprect,
PTLG_PROT_CURVE_INFOS lpci,
DWORD dwNumberOfCurves,
Parameters
hDC
Handle to the parent window in which the trend is to be output
lprect
Pointer to the Windows-specific structure of the RECT type with the size data of the window.
lpci
Pointer to the first structure of the TLG_PROT_CURVE_INFOS (Page 2170) type with
information about how the trends are to be output.
dwNumberOfCurves
Number of the structures (number of trends to be shown) transferred in lpci.
lpError
Return value
TRUE
Trends shown
FALSE
Error
Error messages

TLG_API_NOT_SUPPORTED This function is not supported

Required files
pdertcli.h
pde_glob.h
pdertdef.h
pdertcli.lib
pdertcli.dll
See also
3.8.7.3 TLGInsertTemplateItem (RT Professional)
Description
The function inserts a new entry for an existing window template, either a trend template or a
table template.
Declaration
BOOL TLGInsertTemplateItem (
LPTSTR lpszTemplateName,
PTLG_TEMPLATEITEM_INFO lpptii,
Parameters
lpszTemplateName
Pointer to the name of the window template to which a trend or table template is to be added.
lpptii
Pointer to a structure of the TLG_TEMPLATEITEM_INFO (Page 2177) type with the data of
the trend or table template to be added.
lpError
Return value
TRUE
Window template extended

FALSE
Error
Error messages

project
Required files
pdertcli.h
pde_glob.h
pdertdef.h
pdertcli.lib
pdertcli.dll
Examples
Edit curve template - Example 1 (Page 2261) "TL02.cpp"
See also
3.8.7.4 TLGPressToolbarButton (RT Professional)
Description
You can trigger functions linked with the toolbar buttons with this function.
Declaration
BOOL TLGPressToolbarButton (
LPTSTR lpszTemplate,
DWORD dwButtonID,

Parameters
lpszTemplate
Name of the template
dwButtonID
Code number for the button to be triggered:
Constants for trends and tables

TLG_BASIC_BTN_HELP Open online help
TLG_BASIC_BTN_DLG Open parameter assignment dialog
TLG_BASIC_BTN_FIRST Show first data records of a log.
TLG_BASIC_BTN_PREV Scroll back in the log.
TLG_BASIC_BTN_NEXT Scroll forward in the log.
TLG_BASIC_BTN_LAST Show last data records of a log.
TLG_BASIC_BTN_STARTSTOP Activate or deactivate the updated view of a tred or table.
TLG_BASIC_BTN_PREV_ITEM Previous trend in the foreground or table column first.
TLG_BASIC_BTN_NEXT_ITEM Next trend in the foreground or table column first.
TLG_BASIC_BTN_ARC_VAR_SELECT Opens the log tag selection dialog.
TLG_BASIC_BTN_ITEM_SELECT Opens the selection dialog for trends or table columns.
TLG_BASIC_BTN_TIME_SELECT Opens the selection dialog for the display time range.
Constants for tables

TLG_TABLE_BTN_EDIT Activate or deactivate the edit function.
Constants for trends

TLG_CURVE_BTN_ZOOMIN Activate the zoom function for enlarging the section.
TLG_CURVE_BTN_ZOOMOUT Deactivate the zoom function.
TLG_CURVE_BTN_1_TO_1 Swsitch to normal trend view.
TLG_CURVE_BTN_LINEAL Activate or deactivate the ruler.
lpError
Error messages

IDS_API_ERROR_WINDOW_NOT_FOUND Button ( window ) could not be found
project
TLG_API_NO_TYP_CHANGE_ALLOWED Type change is not allowed

Required files
pdertcli.h
pde_glob.h
pdertdef.h
pdertcli.lib
pdertcli.dll
3.8.7.5 TLGSetRulerWindowVisible (RT Professional)
Description
The data window of the read line is shown or hidden with this function.
Declaration
BOOL TLGSetRulerWindowVisible (
LPTSTR lpszTemplateName,
BOOL bShowRulerWindow,
Parameters
lpszTemplateName
Pointer to the name of the window template
bShowRulerWindow
TRUE: The read line with data window is shown.

FALSE: The read line without data window is shown.
lpError
Return value
TRUE
The parameter for the visibility of the read line data window was re-entered.
FALSE
Error

Comment
The function is not effective in the f(x) trend view and table view until the appropriate image
with the object is displayed.
Error messages

IDS_API_ERROR_WINDOW_NOT_FOUND Button ( window ) could not be found
Required files
pdertcli.h
pde_glob.h
pdertdef.h
pdertcli.lib
pdertcli.dll
3.8.7.6 TLGShowWindow (RT Professional)
Description
The function influences the display form of the window.
Declaration
BOOL TLGShowWindow (
HWND hwnd,
DWORD dwFlags,
Parameters
hwnd
Window handle of the runtime window
dwFlags
The same flags apply here as in ::ShowWindow(HWND hwnd, int nCmdShow) as they are
defined in WinUser.h (SW_SHOW, SW_HIDE, ...).

lpError
Return value
TRUE
Application window shown
FALSE
Error
Error messages

Required files
pdertcli.h
pde_glob.h
pdertdef.h
pdertcli.lib
pdertcli.dll
WinUser.h
3.8.8 Functions for processing time systems (RT Professional)
3.8.8.1 TLGEnumTime (RT Professional)
Description
Enumerates the names of all detection and logging times of a project

Declaration
BOOL TLGEnumTime (
HANDLE hProject,
TLG_ENUM_TIME_NAME_CALLBACK lpCallbackFunc,
PVOID lpUser,
Parameters
hProject
Handle of the project in which the time objects to be listed are located.
lpCallbackFunc
Pointer to your callback function which is called for every existing time object.
lpUser
lpoes
Return value
TRUE
Time objects listed
FALSE
Error
Required files
pdecscli.h
pdecscli.lib
pdecscli.dll
Related functions
TLG_ENUM_TIME_NAME_CALLBACK List time objects (callback)

(Page 2249)

Examples
See also
TLG_ENUM_TIME_NAME_CALLBACK (Page 2249)
3.8.8.2 TLG_ENUM_TIME_NAME_CALLBACK (RT Professional)
Description
In order to be able to evaluate the time objects listed by the system, you must provide a callback
function of the TLG_ENUM_TIME_NAME_CALLBACK type.
Declaration
BOOL ( * TLG_ENUM_TIME_NAME_CALLBACK) (
LPTSTR lpszName,
PVOID lpUser );
Parameters
lpszName
The lpszName pointer refers to the name of the first time object.
lpUser
function.
Return value
TRUE

FALSE
Note
Required files
pdecscli.h
Related functions
TLGEnumTime (Page 2247) List time objects
Examples
See also
TLGEnumTime (Page 2247)
3.8.8.3 TLGEnumTimes (RT Professional)
Description
Enumerates all detection and logging times.
Declaration
BOOL TLGEnumTimes(
TLG_ENUMTIMES_CALLBACK lpfnCallback,
LPVOID lpUser,

Parameters
lpfnCallback
Pointer to your callback function
lpUser
lpError
Return value
TRUE
Time objects listed
FALSE
Error
Error messages

project
Required files
pdertcli.h
pde_glob.h
pdertdef.h
pdertcli.lib
pdertcli.dll
Related functions
See also
TLG_ENUMTIMES_CALLBACK (Page 2252)

3.8.8.4 TLG_ENUMTIMES_CALLBACK (RT Professional)
Description
In order to be able to evaluate the time objects listed by the system, you must provide a callback
function of the TLG_ENUMTIMES_CALLBACK type.
Declaration
BOOL ( * TLG_ENUMTIMES_CALLBACK) (
PTLG_TIMEDATA lpTime,
PVOID lpUser );
Parameters
lpTime
The system reserves temporary storage of the length of the TLG_TIMEDATA (Page 2180)
structure per time object. The lpTime pointer refers to the beginning of the first element.
lpUser
function.
Return value
TRUE
FALSE
Note
Required files
pdertcli.h
pde_glob.h

pdertdef.h
Related functions
TLGEnumTimes (Page 2250) List time objects
See also
TLGEnumTimes (Page 2250)
TLG_TIMEDATA (Page 2180)
3.8.8.5 TLGReadTime (RT Professional)
Description
Read the parameters of an already created time object
Declaration
BOOL TLGReadTime (
HANDLE hProject,
LPTSTR lpszTimeName,
PTLG_TIME_STR lpTime,
Parameters
hProject
Handle of the project in which the time object to be processed is located.
lpszTimeName
Pointer to the name of the time object
lpTime
Address of the TLG_TIME_STR (Page 2179) structure with the data of the time object.
lpoes

Return value
TRUE
Parameters of the time object read
FALSE
Error
Required files
pdecscli.h
pdecscli.lib
pdecscli.dll
Examples
See also
TLG_TIME_STR (Page 2179)
3.8.9 Functions for saving and restoring (RT Professional)
3.8.9.1 TLGEnumBackupEntries (RT Professional)
Description
This function is no longer supported and supplies FALSE and the error code
TLG_API_NOT_SUPPORTED as a return value.
Declaration
BOOL TLGEnumBackupEntries (
TLG_ENUMBACKUP_ENTRIES lpfnCallback,
LPVOID lpUser,

Parameters
lpszArchivName
lpfnCallback
Pointer to your callback function which is called for every existing backuo.
lpUser
lpError
Return value
TRUE
Backups listed
FALSE
Error
Error messages

Required files
pdertcli.h
pde_glob.h
pdertdef.h
pdertcli.lib
pdertcli.dll
Related functions

See also
TLG_ENUMBACKUP_ENTRIES (Page 2256)
3.8.9.2 TLG_ENUMBACKUP_ENTRIES (RT Professional)
Description
The TLGEnumBackupEntries function is no longer supported. In order to be able to evaluate
the backups listed by the system, you must provide a callback function of the
TLG_ENUMBACKUP_ENTRIES type.
Declaration
BOOL ( * TLG_ENUMBACKUP_ENTRIES) (
PTLG_BACKUP_TABLE_INFO lpbti,
PVOID lpUser );
Parameters
lpbti
The system reserves temporary storage of the length of the TLG_BACKUP_TABLE_INFO
(Page 2157) structure per backup. The lpbti pointer refers to the beginning of the first element.
lpUser
function.
Return value
TRUE
FALSE

Comment
Note
Required files
pdertcli.h
pde_glob.h
pdertdef.h
Related functions
TLGEnumBackupEntries (Page 2254) List backups
See also
TLGEnumBackupEntries (Page 2254)
TLG_BACKUP_TABLE_INFO (Page 2157)
3.8.9.3 TLGExport (RT Professional)
Description
Parts of a log can be exported with the function. The data records to be exported are selected
by the TLG_IO_BACKUP_SELECT structure.
Declaration
BOOL TLGExport (
LPTSTR lpszFileName,
PTLG_IO_BACKUP_SELECT lpibs,
DWORD dwJobFlags,
DWORD dwFormatFlags,

Parameters
lpszArchivName
Pointer to the name of the log The name must be specified made up in the form "log name\tag
name" zusammengesetzt anzugeben.
The parts of the name can be determined with TLGEnumArchivsEx and TLGEnumVariablesEx.
lpszFileName
Pointer to the name of the file into which the data are to be exported.
lpibs
Address of the transfer structure TLG_IO_BACKUP_SELECT (Page 2169) for the selection
parameters.
dwJobFlags
The parameter is provided for later upgrades and must be supplied with 0L.
dwFormatFlags
Format specifier:
TLG_BAKFMT_CSV: CSV format (Comma Separated Value)
lpError
Return value
TRUE
Log data exported
FALSE
Error
Comment
This function is only useful for sequential logs, circular logs and compressed logs.
Error messages


Required files
pdertcli.h
pde_glob.h
pdertdef.h
pdertcli.lib
pdertcli.dll
See also
TLG_IO_BACKUP_SELECT (Page 2169)
3.8.9.4 TLGGetBackupSize (RT Professional)
Description
The function is no longer supported and supplies FALSE and the error code
TLG_API_NOT_SUPPORTED as a return value.
Declaration
BOOL TLGGetBackupSize (
DWORD* lpdwSizeOfTable,
PTLG_IO_BACKUP_SELECT lpibs,
DWORD dwJobFlags,
DWORD dwFormatFlags,
Parameters
lpszArchivName
lpdwSizeOfTable
Address of a DWORD in which the size of the selected data in bytes is written.
lpibs
Address of the transfer structure TLG_IO_BACKUP_SELECT (Page 2169) for the selection
parameters.

dwJobFlags
Job-specific identification, following are possible:
TLG_BACKUP_EXPORT: Simple backup without deleting the source data

TLG_BACKUP_EVACUATE: Export with deletion of the sources
dwFormatFlags
Format specifier:
TLG_BAKFMT_CSV: CSV format (Comma Separated Value)-
lpError
Return value
TRUE
Size of data determined
FALSE
Error
Error messages

Required files
pdertcli.h
pde_glob.h
pdertdef.h
pdertcli.lib
pdertcli.dll
See also
TLG_IO_BACKUP_SELECT (Page 2169)

3.8.10.1 Edit curve template - Example 1 (RT Professional)
Example
// =====================================================================
// =====================================================================
// : Modul with examples to TagLogging-API
// *********************************************************************
// *********************************************************************
//#include "odkapi.h" // if console application
#include "TL02.h"
#include <string.h>
#include <stdlib.h>
#include <malloc.h>
#include <time.h>
// IMPLEMENTATION
//{{ODK_EXAMPLE}Edit curve template (example no. 1) (TLG)}
//{{FUNCTION}TLGConnect (TLG)}
//{{FUNCTION}TLGDisconnect (TLG)}
//{{FUNCTION}TLGInsertTemplateItem (TLG)}
//{{FUNCTION}(END)}
// =====================================================================
// Function: MyTLGInsertTemplateItem(void) ODK TL RT
// =====================================================================
// : Edit curve template
// : Defines a new curve with previous settings
// =====================================================================
void MyTLGInsertTemplateItem (void)
{
#define COLOR_RED 0x000000FF
// Farbe sym. Name Value (hexadezimal) Value (dezimal)

// schwarz CO_BLACK 0x00000000 0
// weiß CO_WHITE 0x00FFFFFF 16777215
// rot CO_RED 0x000000FF 255
// dunkelrot CO_DKRED 0x00000080 128
// grün CO_GREEN 0x0000FF00 65280
// dunkelgrün CO_DKGREEN 0x00008000 32768
// blau CO_BLUE 0x00FF0000 16711680
// dunkelblau CO_DKBLUE 0x00800000 8388608
// gelb CO_YELLOW 0x0000FFFF 65535
// dunkelgelb CO_DKYELLOW 0x00008080 32896
// zyan CO_CYAN 0x00FFFF00 1048320
// dunkelzyan CO_DKCYAN 0x00808000 8421376
// magenta CO_MAGENTA 0x00FF00FF 16711935
// dunkelmagenta CO_DKMAGENTA 0x00800080 8388736
// hellgrau CO_LTGRAY 0x00C0C0C0 12632256
// dunkelgrau CO_DKGRAY 0x00808080 8421504

// scripts
BOOL ret = FALSE;
CMN_ERROR Error;
TCHAR szText[255];
HWND hwndParent = NULL;
TLG_TEMPLATEITEM_INFO TemplateItem;
ret = TLGConnect(hwndParent, &Error);
if(FALSE == ret)
{
TLGInsertTemplateItem: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
ODKTrace(szText);
}
else
{
memset(&TemplateItem, 0, sizeof(TLG_TEMPLATEITEM_INFO));
_tcsncpy_s(TemplateItem.szArchivName, _countof(TemplateItem.szArchivName),
_T("PLSMWA"), _TRUNCATE); // archive name
_tcsncpy_s(TemplateItem.szTemplateName, _countof(TemplateItem.szTemplateName),
_T("KV_PID1"), _TRUNCATE); // template for curve window
_tcsncpy_s(TemplateItem.szVariableName, _countof(TemplateItem.szVariableName),
_T("VPID1_X"), _TRUNCATE); // DM variable name
_tcsncpy_s(TemplateItem.szDMVariableName, _countof(TemplateItem.szDMVariableName),
_T("VPID1_X"), _TRUNCATE);
_tcsncpy_s(TemplateItem.szTemplateItemName,
_countof(TemplateItem.szTemplateItemName), _T("KPID3_X"), _TRUNCATE); // curve name
TemplateItem.dwTemplateTyp = TLG_TEMPLATE_CURVE;
TemplateItem.dwTemplateItemTyp = TLG_TEMPLATEITEM_CURVE;
TemplateItem.dwReadAccessLevel = 1;
TemplateItem.dwWriteAccessLevel = 1;
TemplateItem.dwArchivTyp = TLG_ARCTYP_PROCESS; //_USER, _PROCESS, _COMPRESS
_tcsncpy_s(TemplateItem.szTimeNameRange, _countof(TemplateItem.szTimeNameRange),
_T("500 ms"), _TRUNCATE);
TemplateItem.fVisible = TRUE;
TemplateItem.tplInfo.tplCurve.csx.dwDataTyp = TLG_DATATYP_TIMERANGE;
TemplateItem.tplInfo.tplCurve.csx.fAutoRange = TRUE;
TemplateItem.tplInfo.tplCurve.csx.fActualize = TRUE;
TemplateItem.tplInfo.tplCurve.csx.dwBufferSize = 10;
TemplateItem.tplInfo.tplCurve.csy.dwDataTyp = TLG_DATATYP_BLOCKDATA;
TemplateItem.tplInfo.tplCurve.csy.fAutoRange = TRUE;
TemplateItem.tplInfo.tplCurve.csy.crColor = COLOR_RED;
ret = TLGInsertTemplateItem(TemplateItem.szTemplateName, &TemplateItem, &Error);
if(FALSE == ret)
{
TLGInsertTemplateItem: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
}
else
{
_sntprintf_s(szText,_countof(szText), _TRUNCATE, _T("InsertItem:
TemplateItemName= %s "), TemplateItem.szTemplateItemName);

}
ODKTrace(szText);
// Disconnect
ret = TLGDisconnect(&Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in TLGDisconnect:
E1= 0x%08lx ; E2= 0x%08lx ; %s"),
ODKTrace(szText);
}
}
}
See also
TLGInsertTemplateItem (Page 2242)

3.8.10.2 Enum all acquisition and logging times (RT Professional)
Example
/ =====================================================================
// =====================================================================
// : Modul with examples to TagLogging-API
// *********************************************************************
// *********************************************************************
#include "stdlib.h"
#include "TL01.h"
#include "dm01.h"
// IMPLEMENTATION
// =====================================================================
// 4. Callback
// =====================================================================
//{{ODK_EXAMPLE}Enum all acquisition and archiving times (TLG)}
//{{FUNCTION}TLGCSConnect (TLG)}
//{{FUNCTION}TLGCSDisConnect (TLG)}
//{{FUNCTION}TLGEnumTime (TLG)}
//{{FUNCTION}TLG_ENUM_TIME_NAME_CALLBACK (TLG)}
//{{FUNCTION}(END)}
// =====================================================================
// Function: TLGEnumTime(void) ODK TL CS
// =====================================================================
// : Enum all acquisition and archiving times
// :
// =====================================================================
BOOL MyTLGEnumTimeNameCallback (LPTSTR szTime, PVOID lpUser)
{
TCHAR szText[255];
sprintf(szText,"...Enum Time %s", szTime);
ODKTrace(szText);
return TRUE;
}
void MyTLGEnumTime(void)
{
BOOL ret = FALSE;
TCHAR szText[255];
HANDLE hProject;
CMN_ERROR Error;
PVOID pUser = NULL;
sprintf(szText, "TLGEnumTime");
ODKTrace(szText);
ret = TLGCSConnect(NULL, &Error);
if (FALSE == ret)

{
sprintf(szText, "Error in TLGCSConnect: E1= 0x%08lx ; E2= 0x%08lx ; %s",
ODKTrace(szText);
}
else
{
sprintf(szText, " TLGCSConnect");
ODKTrace(szText);
ret = TLGOpenProject(&hProject, /*PROJ_PATH*/g_szProjectFile, NULL, &Error);
if (FALSE == ret)
{
sprintf(szText, "Error in TLGOpenProject: E1= 0x%08lx ; E2= 0x%08lx ; %s",
ODKTrace(szText);
}
else //TLGOpenProject OK
{
sprintf(szText, " TLGOpenProject");
ODKTrace(szText);
// read projected archiving times
ret = TLGEnumTime(hProject, MyTLGEnumTimeNameCallback, pUser, &Error);
if (FALSE == ret)
{
sprintf(szText, "Error in TLGEnumTime: E1= 0x%08lx ; E2= 0x%08lx ; %s",
}
else
{
sprintf(szText, " TLGEnumTime");
}
ODKTrace(szText);
//TLGCloseProject();
ret = TLGCloseProject(hProject, &Error);
if(FALSE == ret)
{
sprintf(szText, "Error in TLGCloseProject: E1= 0x%08lx ; E2= 0x%08lx ; %s",
}
else
{
sprintf(szText, " TLGCloseProject");
}
ODKTrace(szText);
}
// Disconnect

ret = TLGCSDisConnect(&Error);
if (FALSE == ret)
{
sprintf(szText, "Error in TLGCSDisConnect: E1= 0x%08lx ; E2= 0x%08lx ; %s",
}
else
{
sprintf(szText, " TLGCSDisConnect");
}
ODKTrace(szText);
}
}
See also
TLG_ENUM_TIME_NAME_CALLBACK (Page 2249)
TLGEnumTime (Page 2247)

3.8.10.3 Enum logs (RT Professional)
Example
//{{ODK_EXAMPLE}Enum archives (TLG)}

//{{FUNCTION}TLGOpenProject (TLG)}
//{{FUNCTION}TLGCloseProject (TLG)}
//{{FUNCTION}TLGEnumArchives (TLG)}
//{{FUNCTION}TLG_ENUM_ARCHIV_CALLBACK (TLG)}
//{{FUNCTION}(END)}
// =====================================================================
// Function: TLGEnumArchives(void) ODK TL CS
// =====================================================================
// : Enum archives
// :
// =====================================================================
BOOL MyTLGEnumArchivCallback(LPTSTR szArchives, PVOID lpUser)
{
lpUser;
TCHAR szText[255];
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("...Enum Archive=%s "),szArchives);
ODKTrace(szText);
return TRUE;
}
void MyTLGEnumArchives(void)
{
BOOL ret = FALSE;
CMN_ERROR Error;
HANDLE hProject;
PVOID pUser = NULL;
TCHAR szText[255];
TCHAR szArchivName[255];
_tcsncpy_s(szArchivName, _countof(szArchivName), _T("PLSMWA"), _TRUNCATE);
//TLGConnect
if (FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in TLGCSConnect:
E1= 0x%08lx ; E2= 0x%08lx ; %s"),
ODKTrace(szText);
}
else
{
//TLGOpenProject
if (FALSE == ret)

{
TLGOpenProject: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
ODKTrace(szText);
}
else
{
// TLGEnumArchives
ret = TLGEnumArchives(hProject, MyTLGEnumArchivCallback, pUser, &Error);
if (FALSE == ret)
{
TLGEnumArchives: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" TLGEnumArchives"));
}
ODKTrace(szText);
}
//CloseProject
ret = TLGCloseProject(hProject,&Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in TLGCloseProject:
E1= 0x%08lx ; E2= 0x%08lx ; %s"),
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" TLGCloseProject"));
}
ODKTrace(szText);
}
// Disconnect
if (FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in TLGCSDisConnect: E1=
0x%08lx ; E2= 0x%08lx ; %s"),
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" TLGCSDisConnect"));
}
ODKTrace(szText);
}

See also
TLGCloseProject (Page 2198)
TLG_ENUM_ARCHIV_CALLBACK (Page 2212)

3.8.10.4 Enum tags of a log (RT Professional)
Example
//{{ODK_EXAMPLE}Enum variables of a archive (TLG)}

//{{FUNCTION}TLG_ENUM_PROJECT_NAME_CALLBACK (TLG)}
//{{FUNCTION}TLGEnumVariablesEx (TLG)}
//{{FUNCTION}TLG_ENUMVARIABLES (TLG)}
//{{FUNCTION}(END)}
// =====================================================================
// Function: MyTLGEnumVariablesEx(void) ODK TL CS
// =====================================================================
// : Edit archive variables
// :
// =====================================================================
BOOL MyTLGEnumVariablesExCallback(PTLG_VARIABLE_INFO lpvi, LPVOID lpUser)
{
lpUser;
TCHAR szText[255];
_sntprintf_s(szText,_countof(szText), _TRUNCATE, _T("Enum Variables %d %s "), lpvi-
>dwVariableTyp, lpvi->szVariableName);
ODKTrace(szText);
return TRUE;
}
void MyTLGEnumVariablesEx(void)
{
BOOL ret = FALSE;
TCHAR szText[255];
CMN_ERROR Error;
HANDLE hProject = NULL;
VOID* pUser = NULL;
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in TLGConnect: E1= 0x
%08lx ; E2= 0x%08lx ; %s"),
ODKTrace(szText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("TLGConnect"));
ODKTrace(szText);
// Info
ret = TLGEnumVariablesEx (szArchivName, MyTLGEnumVariablesExCallback,
pUser, &Error );

if (FALSE == ret)
{
TLGEnumVariablesEx: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("TLGEnumVariablesEx: OK"));
}
ODKTrace(szText);
if(FALSE == ret)
{
E1= 0x%08lx ; E2= 0x%08lx ; %s"),
ODKTrace(szText);
}
}
}
See also
TLGEnumVariablesEx (Page 2206)

3.8.10.5 Enumerate logs (RT Professional)
Example
//{{ODK_EXAMPLE}Enumerate archives (TLG)}

//{{FUNCTION}TLGConnect (TLG)}
//{{FUNCTION}TLGDisconnect (TLG)}
//{{FUNCTION}TLGEnumArchivs (TLG)}
//{{FUNCTION}TLG_ENUMTABLES (TLG)}
//{{FUNCTION}(END)}
// =====================================================================
// Function: MyTLGEnumArchivs(void) ODK TL RT
// =====================================================================
// : Enumerate archives
// =====================================================================
BOOL MyTLGEnumTablesCallback(LPTSTR lpTableName, PTLG_TABLE_INFO lpti, PVOID lpUser)
{
lpUser;
TCHAR szText[255];
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("TableName=%s"), lpTableName);
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" ...ArchivTyp=%d"), lpti-
>dwArchivTyp);
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" ...ArchivName=%s"),lpti-
>szArchivName);
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" ...dwSaveTyp=%d"), lpti-
>dwSaveTyp);
ODKTrace(szText);
return TRUE;
}
void MyTLGEnumArchivs(void)
{
BOOL ret = FALSE;
//DWORD StartTime = 0;
//DWORD StopTime = 0;
void* lpUser = NULL;
CMN_ERROR Error;
TCHAR szText[255];
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in TLGConnect: E1= 0x
%08lx ; E2= 0x%08lx ; %s"),
ODKTrace(szText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("TLGConnect"));

ODKTrace(szText);
ret = TLGEnumArchivs(TLG_ARCTYP_PROCESS, MyTLGEnumTablesCallback, lpUser, &Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in TLGEnumArchivs:
E1= 0x%08lx ; E2= 0x%08lx ; %s"),
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("TLGEnumArchivs: OK"));
}
ODKTrace(szText);
if(FALSE == ret)
{
E1= 0x%08lx ; E2= 0x%08lx ; %s"),
ODKTrace(szText);
}
}
}
See also

3.8.10.6 Read log (RT Professional)
Example
//{{ODK_EXAMPLE}Read archive (TLG)}

//{{FUNCTION}TLGReadArchiv (TLG)}
//{{FUNCTION}TLGReadVariable (TLG)}
//{{FUNCTION}(END)}
// =====================================================================
// Function: TLGReadArchiv(void) ODK TL CS
// =====================================================================
// : Read archive
// :
// =====================================================================
void MyTLGReadArchiv(void)
{
BOOL ret = FALSE;
CMN_ERROR Error;
HANDLE hProject;
//PVOID pUser = NULL;
TCHAR szText[255];
TCHAR szVarName[255];
TLG_ARCHIV_STR TLGArchivStruct;
TLG_VAR_STR TLGVarStruct;
_tcsncpy_s(szVarName, _countof(szVarName), _T("X"), _TRUNCATE);
if (FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in TLGCSConnect: E1= 0x
%08lx ; E2= 0x%08lx ; %s"),
ODKTrace(szText);
}
else
{
if (FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in TLGOpenProject:
E1= 0x%08lx ; E2= 0x%08lx ; %s"),
ODKTrace(szText);
}
else

{
// read
memset(&TLGArchivStruct,0,sizeof(TLG_ARCHIV_STR));
ret = TLGReadArchiv(hProject, szArchivName, &TLGArchivStruct, &Error);
if (FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in TLGReadArchiv:
E1= 0x%08lx ; E2= 0x%08lx ; %s"),
ODKTrace(szText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("TLGReadArchiv"));
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" ArcName=%s Comments=
%s dwTyp=0x%04x dwRecSize=%d"),
TLGArchivStruct.szName,
TLGArchivStruct.szComment,
TLGArchivStruct.dwTyp,
TLGArchivStruct.dwRecordSize);
ODKTrace(szText);
}
memset(&TLGVarStruct, 0, sizeof(TLG_VAR_STR));
ret = TLGReadVariable(hProject, szArchivName, szVarName, &TLGVarStruct, &Error);
if (FALSE == ret)
{
TLGReadVariable: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
ODKTrace(szText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("TLGReadVariable"));
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" szVarName=%s"),
TLGVarStruct.szVarName);
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" szProcName=%s"),
TLGVarStruct.szProcName);
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" dwVarType=0x%04X"),
TLGVarStruct.dwVarType);
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" dwArchivStyle=0x
%04X"), TLGVarStruct.dwArchivStyle);
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" szWriteBackTo=%s"),
TLGVarStruct.szWriteBackTo);
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" dwSupply=0x%04X"),
TLGVarStruct.dwSupply);
ODKTrace(szText);

_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" fLocked=%d"),

TLGVarStruct.fLocked);
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" szComment=%s"),
TLGVarStruct.szComment);
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" szRecordCycle=%s"),
TLGVarStruct.szRecordCycle);
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" szArchivCycle=%s"),
TLGVarStruct.szArchivCycle);
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" dwMultiple=0x%04X"),
TLGVarStruct.dwMultiple);
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" dwValueFlow=0x
%04X"), TLGVarStruct.dwValueFlow);
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" dwValueFollow=0x
%04X"), TLGVarStruct.dwValueFollow);
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" dwSaveByFault=0x
%04X"), TLGVarStruct.dwSaveByFault);
ODKTrace(szText);
}
}
//CloseProject
ret = TLGCloseProject(hProject,&Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in TLGCloseProject:
E1= 0x%08lx ; E2= 0x%08lx ; %s"),
}
else
{
}
ODKTrace(szText);
}
// Disconnect
if (FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in TLGCSDisConnect: E1=
0x%08lx ; E2= 0x%08lx ; %s"),
}
else
{
}
ODKTrace(szText);
}

See also

3.8.10.7 Read parameters of time object (RT Professional)
Example
//{{ODK_EXAMPLE}Read parameters of time object (TLG)}

//{{FUNCTION}TLGReadTime (TLG)}
//{{FUNCTION}(END)}
// =====================================================================
// Function: TLGReadTime(void) ODK TL CS
// =====================================================================
// : Reads the parameters of an already existing time object.
// :
// =====================================================================
void MyTLGReadTime(void)
{
BOOL ret = FALSE;
TCHAR szText[255];
HANDLE hProject;
CMN_ERROR Error;
TLG_TIME_STR TLGTimeStruct;
TCHAR szTime[255];
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("TLGReadTime"));
ODKTrace(szText);
if (FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in TLGCSConnect: E1= 0x
%08lx ; E2= 0x%08lx ; %s"),
ODKTrace(szText);
}
else
{
if (FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in TLGOpenProject:
E1= 0x%08lx ; E2= 0x%08lx ; %s"),
ODKTrace(szText);
}
else
{
// read properties of selected time
memset(&TLGTimeStruct, 0, sizeof(TLG_TIME_STR));

_tcsncpy_s(szTime, _countof(szTime), _T("500 ms"), _TRUNCATE);

ret = TLGReadTime(hProject, szTime, &TLGTimeStruct, &Error);
if (FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in TLGReadTime:
E1= 0x%08lx ; E2= 0x%08lx ; %s"),
ODKTrace(szText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("...szTimeName = %s
"),TLGTimeStruct.szTimeName);
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("...dwBasis = %10d
Millisec"), TLGTimeStruct.dwBasis);
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("...dwFactor = %10d
"), TLGTimeStruct.dwFactor);
ODKTrace(szText);
}
// save changes permanent
ret = TLGSaveProject(hProject , &Error);
if (FALSE == ret)
{
TLGSaveProject: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" TLGSaveProject"));
}
ODKTrace(szText);
//TLGCloseProject();
ret = TLGCloseProject(hProject, &Error);
if(FALSE == ret)
{
TLGCloseProject: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
}
else
{
}
ODKTrace(szText);
}
// Disconnect
if (FALSE == ret)
{

3.9 Recipe functions (RT Professional)
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in TLGCSDisConnect:

E1= 0x%08lx ; E2= 0x%08lx ; %s"),
}
else
{
}
ODKTrace(szText);
}
}
See also
TLGReadTime (Page 2253)
Overview
uaSetLocalEvents (Page 2295) Sets the local events.

uaArchiveClose (Page 2306) Close connection to current user archive
uaArchiveDelete (Page 2307) Delete data records in the user archive
uaArchiveExport (Page 2308) Export user archive
uaArchiveGetCount (Page 2319) Read the number of data records
uaArchiveGetFieldLength (Page 2328) Read the current field length
uaArchiveGetFieldName (Page 2329) Read the current field name
uaArchiveGetFields (Page 2330) Determine number of fields
uaArchiveGetFieldType (Page 2331) Read the current field type
uaArchiveGetFieldValueDate (Page 2332) Read date and time from current data field
uaArchiveGetFieldValueDouble (Page 2333) Read double value from current data field
uaArchiveGetFieldValueLong (Page 2335) Read long value from current data field

uaArchiveGetFieldValueString (Page 2336) Read string from current data field

uaArchiveGetFilter (Page 2321) Read filter setting
uaArchiveGetID (Page 2310) Read ID of the current data field
uaArchiveGetName (Page 2311) Read name of archive
uaArchiveGetSort (Page 2312) Read sorting of the current data field
uaArchiveImport (Page 2313) Import user archive
uaArchiveInsert (Page 2322) Insert data record into user archive
uaArchiveMoveFirst (Page 2323) Move to first data record
uaArchiveMoveLast (Page 2324) Move to last data record
uaArchiveMoveNext (Page 2325) Move to next data record
uaArchiveMovePrevious (Page 2326) Move to previous data record
uaArchiveOpen (Page 2314) Create connection to current user archive
uaArchiveReadTagValuesByName (Page 2349) Read tag values based on the name
uaArchiveReadTagValues (Page 2348) Read tag values
uaArchiveRequery (Page 2343) Reload to current user archive
uaArchiveSetFieldValueDate (Page 2337) Write date and time to current data field
uaArchiveSetFieldValueDouble (Page 2338) Write double value to current data field
uaArchiveSetFieldValueLong (Page 2339) Write long value to current data field
uaArchiveSetFieldValueString (Page 2341) Write string to current data field
uaArchiveSetFilter (Page 2344) Set filter
uaArchiveSetSort (Page 2346) Set up sorting criterion
uaArchiveUpdate (Page 2315) Update data record into user archive
uaArchiveWriteTagValuesByName (Page 2352) Write data record to tag based on the name
uaArchiveWriteTagValues (Page 2350) Write data record to tag
uaConnect (Page 2296) Establish connection to a user archive (runtime).
uaDisconnect (Page 2297) Close connection to user archive
uaGetArchive (Page 2316) Read archive configuration
uaGetField (Page 2342) Read field configuration
uaGetLastError (Page 2291) Query last error in user archive
AUTOHOTSPOT Query last COM function error that occurred
uaGetNumArchives (Page 2318) Find number of configured user archives
uaGetNumFields (Page 2327) Determine number of fields
uaIsActive (Page 2293) Query whether an archive is open in runtime
uaOpenArchives (Page 2318) Query how many user archives are open in runtime
uaOpenViews (Page 2347) Query how many user archive views are open in
runtime
uaQueryArchiveByName (Page 2300) Set up connection to user archive based on the
name (runtime)
uaQueryArchive (Page 2298) Set up connection to user archive (runtime)
UaQueryConfiguration (Page 2302) Query connection to the configuration
uaReleaseArchive (Page 2303) Close connection to user archive (runtime)
uaReleaseConfiguration (Page 2305) Close connection to the configuration

See also
uaUsers (Page 2294)
3.9.1.2 Structure of recipes (RT Professional)
Introduction
User archives are individual tables in the database that can be structured by the user in any
manner, except for the first column. The data types are limited to char, double, int, and
DateTime fields.
The GetField and SetField functions act on an internal hRecord data record that can be written
to the archive with Insert and Update.
If the user archive is modified directly via the database (ODBC/SQL), an online synchronization
is not performed.
Configuration of User Archives

The first step is to configure the user archives. This configuration can be carried out with the
User Archives editor, the User Archives script functions, or the User Archives API functions.
The script functions are identical to the API functions in this case.

Configuration with the User Archives API functions

The UAQueryConfiguration function supplies a handle (UAHCONFIG) for the configuration
functions. This handle can be used to call the configuration functions UASetArchive,
UAAddArchive, UASetField, UAAddField, etc. The "UAReleaseConfiguration" function
completes the configuration of User Archives.
These functions are not available in multiclient projects.
Establishing connection to User Archives

Next, standard function UAConnect must be called in order to establish a connection to the
User Archives component. UAConnect creates the UAHCONNECT handle, which enables
archives (but not views) to be opened and closed.
Information functions in runtime mode

The UAIsActive function indicates whether an archive is active and open in runtime. UAUsers
returns the number of logged on users, UAOpenArchives the number of open archives, and
UAOpenViews the number of open views.
Opening of runtime functions

A configured user archive is required for runtime mode. The UAQueryArchive and
UAQueryArchiveByName provide a handle for the runtime functions. Once the archive is
opened with the UAArchiveOpen function, the User Archives runtime functions can be used.
Functions for runtime mode

The UAArchiveMoveNext, UAArchiveMovePrevious, UAArchiveMoveFirst, and
UAArchiveMoveLast functions are used to move the cursor. The hArchive handle ensures a
unique assignment to a data record in the user archive. This assignment also allows indirect
addressing, as is required for screen masks, for example.
The UAArchiveUpdate function saves the temporary data record in the archive and in doing
so overwrites the data record on which the cursor is currently positioned. This data record must
be read beforehand using the UAArchiveMoveNext, UAArchiveMovePrevious,
UAArchiveMoveFirst, or UAArchiveMoveLast function.
Closing connection to User Archives

The UAArchiveClose function is used to close a user archive. The UAReleaseArchive function
closes the connection to the current archive and the UADisconnect function then terminates
the connection to the User Archives component.

3.9.1.3 Dependencies in call sequence of API functions (RT Professional)
Dependencies in call sequence of runtime functions

The User Archives function UAConnect creates the UAHCONNECT handle. This handle is
required for opening and closing archives (not views). Therefore, the UAConnect function must
be called first in order to obtain the UAHCONNECT handle. This handle can then be used to
call the API functions for opening and closing archives (not views), as listed below. The
UADisconnect function must be called to complete the configuration.
The UAQueryArchive and UAQueryArchiveByName functions create the UAHARCHIVE
handle. This handle is a requirement for the User Archives API function UAArchiveOpen, which
opens the archive for runtime mode.
Handles for runtime archive functions
UAConnect Handle UAHCONNECT

--->
Required by UAIsActive
UAUsers
UAOpenArchives
UAOpenViews
UAQueryArchive ---> Handle UA‐
HARCHIVE
UAQueryArchiveBy‐ Handle UA‐
Name ---> HARCHIVE
Required by:
UAArchiveOpen ---
>
Required for UAArchiveDelete
UAArchiveExport
UAArchiveGetCount
UAArchiveGetFieldLength
UAArchiveGetFields
UAArchiveGetFieldType
UAArchiveGetFieldValueDate
UAArchiveGetFieldValueDouble
UAArchiveGetFieldValueFloat
UAArchiveGetFieldValueLong
UAArchiveGetFieldValueString
UAArchiveGetFieldName
UAArchiveGetFilter
UAArchiveGetID
UAArchiveGetName
UAArchiveGetSort

UAArchiveImport
UAArchiveInsert
UAArchiveMoveFirst
UAArchiveMoveLast
UAArchiveMoveNext
UAArchiveMovePrevious
UAArchiveReadTagValues
UAArchiveReadTagValuesBy‐
Name
UAArchiveRequery
UAArchiveSetFieldValueDate
UAArchiveSetFieldValueDouble
UAArchiveSetFieldValueFloat
UAArchiveSetFieldValueLong
UAArchiveSetFieldValueString
UAArchiveSetFilter
UAArchiveSetSort
UAArchiveUpdate
UAArchiveWriteTagValues
UAArchiveWriteTagValuesByName
<--- UAArchiveClose
<---
UAReleaseArchive
<--- UADisconnect
Overview
The following error messages can be queried with API function UAGetLastError.
UA_ERROR_SUCCESS 0 No error, everything is OK.

UA_ERROR_GENERIC 1 Error in configuration function.
UA_ERROR_CONNECT_FAILED 100 No runtime connection established (not runtime).
UA_ERROR_OPEN_FAILED 101 The archive cannot be opened.
UA_ERROR_CLOSE_FAILED 102 The archive cannot be closed, or the handle is in‐
valid.
UA_ERROR_REQUERY_FAILED 103 The reloading to archive with, for example, a new
filter/new sorting could not be performed.
UA_ERROR_MOVE_FAILED 104 Movement to the first, last, next, or previous data
record could not be performed.
UA_ERROR_INSERT_FAILED 105 A data record could not be inserted at the specified
position (check position).

UA_ERROR_UPDATE_FAILED 106 The specified data record could not be updated

(locked, or no data record exists at this position).
UA_ERROR_DELETE_FAILED 107 The data record(s) could not be deleted.
UA_ERROR_IMPORT_FAILED 108 The import of an archive failed (check format, size).
UA_ERROR_EXPORT_FAILED 109 The export of the user archive was not successful
(check space).
UA_ERROR_READ_FAILED 110 Tags could not be read.
UA_ERROR_WRITE_FAILED 111 Tags could not be written
UA_ERROR_GET_FAILED 112 Archive/field description and/or data record values
could not be read.
UA_ERROR_SET_FAILED 113 Archive/field description and/or data record values
could not be written.
UA_ERROR_INVALID_NAME 200 Invalid name.
UA_ERROR_INVALID_TYPE 201 Incorrect type specified
UA_ERROR_INVALID_NUMRECS 202 Number of data records cannot be received
UA_ERROR_INVALID_COMMTYPE 203 Incorrect connection (None / Raw / Direct) selected
UA_ERROR_INVALID_LENGTH 204 The specified (string) length is not received
UA_ERROR_INVALID_PRECISION 205 The specified number of digits to the right of the
decimal point will not be received.
UA_ERROR_NULL_POINTER 1000 A NULL pointer was passed
UA_ERROR_INVALID_POINTER 1001 The specified pointer is invalid
UA_ERROR_INVALID_HANDLE 1002 The specified handle is invalid
UA_ERROR_INVALID_INDEX 1003 The specified index is invalid
UA_ERROR_SERVER_UNKNOWN 1004 The specified server in use is invalid.
Configuration constants:
Archive types
UA_ARCHIVETYPE_UNKNOWN 0 Unknown archive type

UA_ARCHIVETYPE_UNLIMITED 1 Circular archive
UA_ARCHIVETYPE_LIMITED 2 Archive with fixed number of data records
Archive flags
UA_ARCHIVEFLAG_ACCESS 0x00000001 An additional column showing the time of the last

access is also created
UA_ARCHIVEFLAG_USER 0x00000002 An additional column showing the user name is al‐
so created

Communication types
UA_COMMTYPE_NONE 1 No tag connection

UA_COMMTYPE_RAW 2 Communication via raw data tag
UA_COMMTYPE_DIRECT 3 Communication via DM tag
Field types
UA_FIELDTYPE_INTEGER 1 Field type INT

UA_FIELDTYPE_DOUBLE 2 Field type double
UA_FIELDTYPE_FLOAT 3 Field type float
UA_FIELDTYPE_STRING 6 Field type string/byte array null-terminated
UA_FIELDTYPE_DATETIME 8 Field type for date and time
Field flags
UA_FIELDFLAG_UNIQUE 0x00000001 Field must contain a unique value

UA_FIELDFLAG_NOTNULL 0x00000002 Field must contain a value
UA_FIELDFLAG_INDEX 0x00000010 Field should be supported by index
Maximum length
UA_MAXLEN_NAME 20 Maximum length of the archive/field name

UA_MAXLEN_ALIAS 50 Maximum length of the second supplemental name/comment
UA_MAXLEN_PLCID 8 Maximum length of the communication device name
UA_MAXLEN_DMVARNAME 128 Maximum length of the data manager tag name
UA_MAXLEN_VALUE 255 Maximum length for string tag
Parameter constants:
Actions
UA_ACTION_GENERIC 0 Configuration
UA_ACTION_INSERT 1 Insert
UA_ACTION_UPDATE 2 Synchronize/overwrite
UA_ACTION_DELETE 3 Delete
Move values
UA_MOVE_FIRST 0 Move to first data record

UA_MOVE_NEXT 1 Move to next data record
UA_MOVE_PREVIOUS -1 Move to previous data record
UA_MOVE_LAST 0x80000000 Move to last data record

Import/export file types
UA_FILETYPE_DEFAULT 0 CSV is the default file type

UA_FILETYPE_CSV 1 (comma separated value) file type
3.9.2.1 uaCONFIGARCHIVE (RT Professional)
Declaration
typedef struct {
LONG lArchiveId;
LONG lPosition;
CHAR szName[UA_MAXLEN_NAME+1];
CHAR szAlias[UA_MAXLEN_ALIAS+1];
LONG lType;
LONG lNumRecs;
LONG lCommType;
CHAR szPLCID[UA_MAXLEN_PLCID+1];
CHAR szDMVarName[UA_MAXLEN_DMVARNAME+1];
CHAR szIDVar[UA_MAXLEN_DMVARNAME+1];
CHAR szJobVar[UA_MAXLEN_DMVARNAME+1];
CHAR szFieldVar[UA_MAXLEN_DMVARNAME+1];
CHAR szValueVar[UA_MAXLEN_DMVARNAME+1];
DWORD dwReadRight;
DWORD dwWriteRight;
DWORD dwFlags;
} UACONFIGARCHIVE;
Members
lArchiveId
Unique ID of the user archive.
lPosition
Position of the user archive
szName
Archive name max. 20 characters
szAlias
Alias name max. 50 characters

lType
UA_ARCHIVETYPE_UNLIMITED "Unlimited" archive type

UA_ARCHIVETYPE_LIMITED "Limited" archive type
lNumRecs
Max. number of data records
lCommType
UA_COMMTYPE_NONE No communication
UA_COMMTYPE_RAW Communication with raw data
UA_COMMTYPE_DIRECT Communication with WinCC tags
szPLCID
PLCID of the raw data tag
szDMVarName
Name of the raw data tag
szIDVar
ID of the control tag
szJobVar
"Job" control tag
szFieldVar
"Field" control tag
szValueVar
"Value" control tag
dwReadRight
Read access rights
dwWriteRight
Write access rights
dwFlags
UA_ARCHIVEFLAG_ACCESS "Last access" flag

UA_ARCHIVEFLAG_USER "Last user" flag

3.9.2.2 uaCONFIGFIELD (RT Professional)
Structure "uaCONFIGFIELDA"
typedef struct {
LONG lArchiveId
LONG lFieldId;
LONG lPosition;
CHAR szName[UA_MAXLEN_NAME+1];
CHAR szAlias[UA_MAXLEN_ALIAS+1];
LONG lType;
LONG lLength;
LONG lPrecision;
CHAR szMinValue[UA_MAXLEN_VALUE+1];
CHAR szMaxValue[UA_MAXLEN_VALUE+1];
CHAR szStartValue[UA_MAXLEN_VALUE+1];
CHAR szDMVarName[UA_MAXLEN_DMVARNAME+1];
DWORD dwReadRight;
DWORD dwWriteRight;
DWORD dwFlags;
} UACONFIGARCHIVE;
Members
lArchiveId
Unique ID of the user archive.
lFieldID
Unique ID of the data field
lPosition
Position of the user archive
szName
Archive name max. 20 characters
szAlias
Alias name max. 50 characters
lType
UA_ARCHIVETYPE_UNLIMITED "Unlimited" archive type

UA_ARCHIVETYPE_LIMITED "Limited" archive type
lLength
Maximum number of characters if the data field is of the type STRING; otherwise, not used

lPrecision
Reserved for internal use
szMinValue
Minimum value. Not used for data fields of the type STRING or DATE.
szMaxValue
Maximum value. Not used for data fields of the type STRING or DATE.
szStartValue
Start value
szDMVarName
Name of the WinCC tag. Used for recipes with communication over WinCC tags.
dwReadRight
Read access rights
dwWriteRight
Write access rights
dwFlags
UA_ARCHIVEFLAG_ACCESS "Last access" flag

UA_ARCHIVEFLAG_USER "Last user" flag
3.9.3.1 uaGetLastError (RT Professional)
Description
Many functions return a Boolean value. TRUE indicates error-free function processing. If the
value FALSE is returned, the error can be read in the last function used by using the
uaGetLastError function.
uaGetLastError always takes you back to the last error. If you know precisely which function
contains an error, you must evaluate the return after each call of a function and call
uaGetLastError in the event of an error.

Example of functions with return values
if ( uaArchiveGetFieldValueLong ( hArchive, Index, &IntValue ) == TRUE )

printf( "Field Value = %u\n", IntValue );
else
printf("Error calling uaArchiveGetFieldValueLong: %d / %08lx\n", uaGetLastError(),
uaGetLastHResult());
Example of functions with no return values
uaArchiveGetFilter(hArchive, pszFilter, cMaxLen);

INT nUAError = uaGetLastError ( );
if ( UA_ERROR_SUCCESS != nUAError)
{
printf( "Filter = [%s]\n", pszFilter );
}
else
{
rintf("Error calling uaArchiveGetFilter: %d, hr=0x%08lX\n", nUAError,
uaGetLastHResult());
}
INT uaGetLastError()
Return value
Error status of the last function executed. Error constants and predefined items are determined
in CCUACAPI.H.
UA_ERROR_SUCCESS No error, everything is OK.

UA_ERROR_GENERIC Error in configuration function.
UA_ERROR_CONNECT_FAILED No Runtime connection established.
UA_ERROR_OPEN_FAILED The archive cannot be opened.
UA_ERROR_CLOSE_FAILED The archive cannot be closed, or the handle is invalid.
UA_ERROR_REQUERY_FAILED The archive reset relationship with for example, a new filter/
new sorting could not be established.
UA_ERROR_MOVE_FAILED The new First, Last, Next or Previous positioning could not
be performed.
UA_ERROR_INSERT_FAILED The record cannot be inserted at the given position. Check
the position.
UA_ERROR_UPDATE_FAILED The record stated cannot be updated. The record is locked
or no record is available in this position.
UA_ERROR_DELETE_FAILED The record(s) cannot (all) be deleted.
UA_ERROR_IMPORT_FAILED The import of an archive was not successful. Check the
archive format and size.
UA_ERROR_EXPORT_FAILED The user archive export was not successful. Check the
size of the memory cell.
UA_ERROR_READ_FAILED Tag reading was not performed.

UA_ERROR_WRITE_FAILED Writing to tags was not performed.

UA_ERROR_GET_FAILED Reading the archive / field description and/or record values
was not performed.
UA_ERROR_SET_FAILED Archive / field description and/or record value writing was
not performed.
UA_ERROR_INVALID_NAME Invalid name.
UA_ERROR_INVALID_TYPE Invalid type.
UA_ERROR_INVALID_NUMRECS Invalid record number.
UA_ERROR_INVALID_COMMTYPE Wrong link to None / Raw / Direct selected.
UA_ERROR_INVALID_LENGTH The specified (String) length is invalid.
UA_ERROR_INVALID_PRECISION The specified number of decimal points is invalid.
UA_ERROR_NULL_POINTER A zero pointer was specified.
UA_ERROR_INVALID_POINTER The specified pointer is invalid.
UA_ERROR_INVALID_HANDLE The specified handle is invalid.
UA_ERROR_INVALID_INDEX The specified index is invalid.
UA_ERROR_SERVER_UNKNOWN The server specified as used is unknown.
Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
3.9.3.2 uaIsActive (RT Professional)
Description
Check that no recipe is in use in an active Runtime.
Declaration
BOOL uaIsActive (
Parameters
hConnect
Handle on recipe in Runtime. This handle is generated using uaConnect.

Return value
TRUE
Recipe in use in active Runtime.
FALSE
Recipe not in use in active Runtime.
Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Related functions
uaConnect (Page 2296) Generate handle
See also
uaConnect (Page 2296)
3.9.3.3 uaUsers (RT Professional)
Description
Provides the number for all users, connected to a recipe by uaConnect. Here, consider calls
by users, e.g. through scripts that are also contained within WinCC.
Declaration
LONG uaUsers (
Parameters
hConnect
Return value
Number of active connections

Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Related functions
See also
3.9.3.4 uaSetLocalEvents (RT Professional)
Description
Sets local events.
Declaration
void uaSetLocalEvents (
UAHCONNECT hConnect
BOOL bLocalEvents )
Parameters
hConnect
bLocalEvents
Local Event
Return value
No return value
Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll

Related functions
See also
3.9.4 Functions for generating connections (RT Professional)
3.9.4.1 uaConnect (RT Professional)
Description
Generates a connection to a recipe in Runtime.
Declaration
BOOL uaConnect (
UAHCONNECT* phConnect )
Parameters
phConnect
Pointer to the recipe handle.
Return value
TRUE
Connection to recipe generated
FALSE
Error
Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll

Comments
The supplied handle is required for the functions uaDisconnect, uaIsActive, uaUsers,
uaOpenViews, uaOpenArchives, uaQueryArchive and uaQueryArchiveByName.
Related functions
uaDisconnect (Page 2297) Terminate connection
See also
uaIsActive (Page 2293)
uaUsers (Page 2294)
uaSetLocalEvents (Page 2295)
uaDisconnect (Page 2297)
uaQueryArchive (Page 2298)
uaQueryArchiveByName (Page 2300)
uaOpenArchives (Page 2318)
uaOpenViews (Page 2347)
3.9.4.2 uaDisconnect (RT Professional)
Description
When a connection is made to a recipe in Runtime, the connection is terminated.
Declaration
BOOL uaDisconnect (
Parameters
hConnect
Return value
TRUE

FALSE
Error
Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Related functions
See also
3.9.4.3 uaQueryArchive (RT Professional)
Description
Makes a connection to a recipe. uaQueryArchive generates the handle phArchive.
Declaration
BOOL uaQueryArchive (
LONG lArchive,
Parameters
hConnect
lArchive
ID of the archive to be connected.
phArchive
Pointer to the connected recipe handle.

Return value
TRUE
FALSE
Error
Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Comments
If only an archive index is available, the ID of the archive can be determined with the
configuration function uaGetArchive.
Related functions
See also
uaReleaseArchive (Page 2303)
uaArchiveClose (Page 2306)
uaArchiveDelete (Page 2307)
uaArchiveExport (Page 2308)
uaArchiveGetID (Page 2310)
uaArchiveGetName (Page 2311)
uaArchiveGetSort (Page 2312)
uaArchiveImport (Page 2313)
uaArchiveOpen (Page 2314)
uaArchiveUpdate (Page 2315)
uaArchiveGetCount (Page 2319)
uaArchiveGetFilter (Page 2321)
uaArchiveInsert (Page 2322)
uaArchiveMoveFirst (Page 2323)

uaArchiveMoveLast (Page 2324)

uaArchiveMoveNext (Page 2325)
uaArchiveMovePrevious (Page 2326)
uaArchiveGetFieldLength (Page 2328)
uaArchiveGetFields (Page 2330)
uaArchiveGetFieldType (Page 2331)
uaArchiveGetFieldName (Page 2329)
uaArchiveGetFieldValueDate (Page 2332)
uaArchiveGetFieldValueDouble (Page 2333)
uaArchiveGetFieldValueLong (Page 2335)
uaArchiveSetFieldValueDate (Page 2337)
uaArchiveSetFieldValueDouble (Page 2338)
uaArchiveSetFieldValueLong (Page 2339)
uaArchiveSetFieldValueString (Page 2341)
uaArchiveRequery (Page 2343)
uaArchiveSetFilter (Page 2344)
uaArchiveSetSort (Page 2346)
uaArchiveReadTagValues (Page 2348)
uaArchiveReadTagValuesByName (Page 2349)
uaArchiveWriteTagValues (Page 2350)
uaArchiveWriteTagValuesByName (Page 2352)
3.9.4.4 uaQueryArchiveByName (RT Professional)
Description
Makes a connection to a recipe by name. uaQueryArchiveByName generates the handle
phArchive.
Declaration
BOOL uaQueryArchiveByName (
LPCSTR pszName,

Parameters
hConnect
pszName
Recipe name.
phArchive
Pointer to the connected recipe handle.
Return value
TRUE
FALSE
Error
Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Comments
If only an archive index is available, the name of the archive can be determined with the
configuration function uaGetArchive.
Related functions
See also
uaReleaseArchive (Page 2303)
uaArchiveDelete (Page 2307)
uaArchiveGetID (Page 2310)
uaArchiveGetName (Page 2311)

uaArchiveGetSort (Page 2312)

uaArchiveUpdate (Page 2315)
uaArchiveGetCount (Page 2319)
uaArchiveGetFilter (Page 2321)
uaArchiveInsert (Page 2322)
uaArchiveMoveFirst (Page 2323)
uaArchiveMoveLast (Page 2324)
uaArchiveMoveNext (Page 2325)
uaArchiveMovePrevious (Page 2326)
uaArchiveGetFieldLength (Page 2328)
uaArchiveGetFields (Page 2330)
uaArchiveGetFieldType (Page 2331)
uaArchiveGetFieldName (Page 2329)
uaArchiveGetFieldValueDate (Page 2332)
uaArchiveGetFieldValueDouble (Page 2333)
uaArchiveGetFieldValueLong (Page 2335)
uaArchiveSetFieldValueDate (Page 2337)
uaArchiveSetFieldValueDouble (Page 2338)
uaArchiveSetFieldValueLong (Page 2339)
uaArchiveSetFieldValueString (Page 2341)
uaArchiveRequery (Page 2343)
uaArchiveSetFilter (Page 2344)
uaArchiveSetSort (Page 2346)
3.9.4.5 UaQueryConfiguration (RT Professional)
Description
Generates the connection to a recipe for the configuration.

Declaration
BOOL uaQueryConfiguration (
UAHCONFIG* phConfig )
Parameters
phConfig
Pointer to receptor handle.
Return value
TRUE
FALSE
Error
Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
See also
uaReleaseConfiguration (Page 2305)
uaGetArchive (Page 2316)
uaGetNumArchives (Page 2318)
uaGetNumFields (Page 2327)
uaGetField (Page 2342)
3.9.4.6 uaReleaseArchive (RT Professional)
Description
Breaks off the connection to the currently connected recipe.

Declaration
BOOL uaReleaseArchive (
Parameters
hArchive
Handle on recipe. This handle is generated using uaQueryArchive or uaQueryArchiveByName.
Return value
TRUE
FALSE
Error
Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Comment
To successfully terminate the connection you must set the hArchive handle to NULL . If you
use a handle that is no longer valid the error message UA_ERROR_INVALID_HANDLE is
generated. This avoids unnecessary memory overloading.
Related functions
uaQueryArchive (Page 2298) Generate handle

uaQueryArchiveByName (Page 2300) Generate handle
See also

3.9.4.7 uaReleaseConfiguration (RT Professional)
Description
Terminates a connection to a recipe after configuring it.
Declaration
BOOL uaReleaseConfiguration (
UAHCONFIG hConfig,
BOOL bSave )
Parameters
hConfig
Handle on recipe. This handle is generated using uaQueryConfiguration.
bSave
Establishes that changes to a configuration are saved before terminating the connection.
TRUE Save changes

FALSE Cancel changes
Note
bSave = TRUE should only be used, if a recipe is not used in an active WinCC Runtime! Check
if Runtime is active by using the uaIsActive function.
Return value
TRUE
FALSE
Error
Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll

Related functions
UaQueryConfiguration (Page 2302) Generate handle
See also
UaQueryConfiguration (Page 2302)
3.9.5 Functions for recipe processing (RT Professional)
3.9.5.1 uaArchiveClose (RT Professional)
Description
Closes an open recipe.
Declaration
BOOL uaArchiveClose (
Parameters
hArchive
Return value
TRUE
Recipe closed.
FALSE
Error
Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll

Related functions

uaArchiveOpen (Page 2314) Open recipe
See also
3.9.5.2 uaArchiveDelete (RT Professional)
Description
Deletes data from a recipe. The configured recipe remains selected.
Declaration
BOOL uaArchiveDelete (
LPCSTR pszWhere )
Parameters
hArchive
pszWhere
String with the SQL selection for the data entries to be deleted. This string corresponds to the
SQL instruction DELETE FROM <archive> WHERE pszWhere.
Note
If pszWhere is empty, the entire user archive will be deleted.
Return value
TRUE
Data deleted.

FALSE
Error
Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Related functions

See also
3.9.5.3 uaArchiveExport (RT Professional)
Description
Exports data from a recipe to CSV file.
Declaration
BOOL uaArchiveExport (
LPCSTR pszDestination,
LONG lType,
LONG lOptions )
Parameters
hArchive

pszDestination
Target file name. When calling the function on a client, the path specified refers to the server.
lType
Target file data format. Two formats are available:
UA_FILETYPE_DEFAULT = 0 The preset CSV file format

UA_FILETYPE_CSV = 1 CSV file format
lOptions
Return value
TRUE
Data exported.
FALSE
Error
Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Related functions

uaArchiveImport (Page 2313) Import data
See also

3.9.5.4 uaArchiveGetID (RT Professional)
Description
Reads the recipe ID
Return Value:
"ID" of the user archive
Declaration
LONG uaArchiveGetID (
Parameters
hArchive
Return value
ID of the recipe
Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Related functions

See also

3.9.5.5 uaArchiveGetName (RT Professional)
Description
Reads the recipe name.
Declaration
VOID uaArchiveGetName (
LPSTR pszName,
LONG cMaxLen )
Parameters
hArchive
pszName
Pointer to the recipe name buffer.
cMaxLen
Maximum Length
Return value
No return value
Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Related functions


Example
char tank [40];

uaArchiveGetName( hArchive, tank, 39 );
See also
3.9.5.6 uaArchiveGetSort (RT Professional)
Description
Reads the recipe sort parameters.
Declaration
VOID uaArchiveGetSort (
LPSTR pszSort,
LONG cMaxLen )
Parameters
hArchive
pszSort
Sort parameters as SQL statement.
cMaxLen
Maximum Length
Return value
No return value
Required files
ccuacapi.h

ccuacapi.lib
ccuacapi.dll
Related functions

See also
3.9.5.7 uaArchiveImport (RT Professional)
Description
Imports data from a CSV file to a recipe. The structure of the recipe must be identical to the
imported CSV archive.
Declaration
BOOL uaArchiveImport (
LPCSTR pszSource,
LONG lType,
LONG lOptions )
Parameters
hArchive
pszSource
File name using the data to be imported.
lType
Source file data format. Two formats are available:
UA_FILETYPE_DEFAULT = 0 The preset CSV file format

UA_FILETYPE_CSV = 1 CSV file format

lOptions
Return value
TRUE
Data imported.
FALSE
Error
Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Related functions

uaArchiveExport (Page 2308) Export files.
See also
3.9.5.8 uaArchiveOpen (RT Professional)
Description
Opens a recipe. Calling uaArchiveOpen is required to read or write in a recipe. Foe example
calling the functionsuaArchiveMoveNext, uaArchiveDelete or uaArchiveUpdate.
Declaration
BOOL uaArchiveOpen (

Parameters
hArchive
Return value
TRUE
Recipe open.
FALSE
Error
Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Related functions

uaArchiveClose (Page 2306) Close recipe
See also
3.9.5.9 uaArchiveUpdate (RT Professional)
Description
Updates an open recipe. All changed recipe data will be applied in the database. The recipe
structure remains unchanged.

Declaration
BOOL uaArchiveUpdate (
U AHARCHIVE hArchive )
Parameters
hArchive
Return value
TRUE
Recipe data updated.
FALSE
In the case of a consistency violation, the error message Update_failed = 106 is displayed.
This kind of consistency violation exists, for example, if a field has the "Field must contain a
value" property, but there is no value in the field.
Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Related functions

See also
3.9.5.10 uaGetArchive (RT Professional)
Description
Reads the recipe configuration.

Declaration
BOOL uaGetArchive (
UAHCONFIG hConfig,
Long lArchive,
UACONFIGARCHIVE* pArchive )
Parameters
hArchive
lArchive
Recipe index. Value: 0... uaGetNumArchives() -1
pArchive
Point on the configuration data buffer.
Return value
TRUE
Successful access.
FALSE
Error
Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Related functions
See also
uaCONFIGARCHIVE (Page 2288)

3.9.5.11 uaGetNumArchives (RT Professional)
Description
Reads the number of recipes currently configured.
Declaration
LONG uaGetNumArchives (
UAHCONFIG hConfig )
Parameters
hConfig
Return value
Number of recipes configured. If an error occurs -1 is output.
Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Related functions
See also
3.9.5.12 uaOpenArchives (RT Professional)
Description
Communicates the number of recipes in the open Runtime.

Declaration
LONG uaOpenArchives (
Parameters
hArchive
Handle on recipe. This handle is generated using uaConnect.
Return value
Number of recipes open.
Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Related functions
See also
3.9.6 Functions for recipe element processing (RT Professional)
3.9.6.1 uaArchiveGetCount (RT Professional)
Description
Reads the number of data records.
Return Value:
Number of data records. If "0" the archive is empty or an error has occurred. A query using
"uaGetLastError" is required.

Declaration
LONG uaArchiveGetCount(
LONG* plCount )
Parameters
hArchive
plCount
Pointer to a tag in which the number of records should be stored.
Return value
Number of data records. If 0 the archive is empty or an error has occurred. A query using
uaGetLastError is recommended.
FALSE
Error
Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Related functions

See also

3.9.6.2 uaArchiveGetFilter (RT Professional)
Description
Reads the selection criteria for the current data record.
Declaration
VOID uaArchiveGetFilter (
LPSTR pszFilter,
LONG cMaxLen )
Parameters
hArchive
pszFilter
Selection parameters as SQL statement.
cMaxLen
Maximum Length
Return value
No return value
Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Related functions


See also
3.9.6.3 uaArchiveInsert (RT Professional)
Description
Inserts the local data record buffer into the recipe. In order for meaningful records to be stated
in the new data file, before calling uaArchiveInsert the fields of the local data record buffers
must be written using the uaArchiveSetFieldValue...function.
The "ID" field must be written using uaArchiveSetFieldValueLong function if an archive has no
ID or if it is written as "0".
Declaration
BOOL uaArchiveInsert (
Parameters
hArchive
Return value
TRUE
Data record inserted.
FALSE
Error
Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll

Related functions

See also
3.9.6.4 uaArchiveMoveFirst (RT Professional)
Description
Goes to the first data record.
Declaration
BOOL uaArchiveMoveFirst (
Parameters
hArchive
Return value
TRUE
Successful jump.
FALSE
Error
Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll

Related functions

See also
3.9.6.5 uaArchiveMoveLast (RT Professional)
Description
Goes to the last data record.
Declaration
BOOL uaArchiveMoveLast (
Parameters
hArchive
Return value
TRUE
Successful jump.
FALSE
Error
Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll

Related functions

See also
3.9.6.6 uaArchiveMoveNext (RT Professional)
Description
Goes to the next data record.
Declaration
BOOL uaArchiveMoveNext (
Parameters
hArchive
Return value
TRUE
Successful jump.
FALSE
Error
Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll

Related functions

See also
3.9.6.7 uaArchiveMovePrevious (RT Professional)
Description
Goes to the previous data record.
Declaration
BOOL uaArchiveMovePrevious (
Parameters
hArchive
Return value
TRUE
Successful jump.
FALSE
Error
Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll

Related functions

See also
3.9.6.8 uaGetNumFields (RT Professional)
Description
Supplies the number of the configured fields. The "ID", "Last User" and "Last Access" fields
are not included. In the configuration calls the index is stated using"0 … uaGetNumFields()
-1".
Declaration
LONG uaGetNumFields (
UAHCONFIG honfig,
long lArchive )
Parameters
hConfig
lArchive
Return value
Number of the configured fields. If an error occurs -1 is output.
Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll

Related functions
See also
3.9.7 Functions for field processing (RT Professional)
3.9.7.1 uaArchiveGetFieldLength (RT Professional)
Description
Reads the length of a field in the current data record.
Declaration
LONG uaArchiveGetFieldLength(
LONG lField )
Parameters
hArchive
lField
The field number, where iField = 1 addresses the first configured field. lField = 0 addresses
the "ID" field.
Return value
Length of the current field.
Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll

Related functions

See also
3.9.7.2 uaArchiveGetFieldName (RT Professional)
Description
Reads the name of a field in the current data record.
Declaration
VOID uaArchiveGetFieldName (
LONG lField,
LPCSTR pszName,
LONG cMaxLen )
Parameters
hArchive
lField
the "ID" field.
pszName
Field Name
cMaxLen
Maximum Length

Return value
TRUE
Name read.
FALSE
Error
Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Related functions
AUTOHOTSPOT Generate handle

See also
3.9.7.3 uaArchiveGetFields (RT Professional)
Description
Reads the number of the configured data fields. The "ID", "Last User" and "Last Access" fields
are included. In Runtime calls the index of configured fields is indicated using 1 ... N. The "ID"
field has a "0" index. The "Last User" and "Last Access" fields are appended at the end of the
configured fields.
Declaration
LONG uaArchiveGetFields (

Parameters
hArchive
Return value
Number of the configured fields.
Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Related functions

See also
3.9.7.4 uaArchiveGetFieldType (RT Professional)
Description
Reads the type of a field in the current data record.
Declaration
LONG uaArchiveGetFieldType (
LONG lField )
Parameters
hArchive

lField
the "ID" field.
Return value
Type of the current field. The symbolic definitions of the field types are:
UA_FIELDTYPE_INTEGER
UA_FIELDTYPE_FLOAT
UA_FIELDTYPE_DOUBLE
UA_FIELDTYPE_STRING
UA_FIELDTYPE_DATETIME
Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Related functions

See also
3.9.7.5 uaArchiveGetFieldValueDate (RT Professional)
Description
Reads the date and time of a field in the current data record.
Declaration
BOOL uaArchiveGetFieldValueDate (
LONG lField,

Parameters
hArchive
lField
the "ID" field.
pstDateTime
Pointer to a tag of the SYSTEMTIME type.
Return value
TRUE
Change date and time.
FALSE
Error
Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Related functions

See also
3.9.7.6 uaArchiveGetFieldValueDouble (RT Professional)
Description
Reads a value of the Double data type from a field in the current data record.

Declaration
BOOL uaArchiveGetFieldValueDouble (
LONG lField,
double* pdValue )
Parameters
hArchive
lField
the "ID" field.
pdValue
Pointer to the tag for the field value.
Return value
TRUE
Value read.
FALSE
Error
Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Related functions

See also

3.9.7.7 uaArchiveGetFieldValueLong (RT Professional)
Description
Reads a value of the Long data type from a field in the current data record.
Declaration
BOOL uaArchiveGetFieldValueLong (
LONG lField,
LONG* pdValue )
Parameters
hArchive
lField
the "ID" field.
pdValue
Return value
TRUE
Value read.
FALSE
Error
Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Related functions


See also
3.9.7.8 uaArchiveGetFieldValueString (RT Professional)
Description
Reads a value of the String data type from a field in the current data record.
Declaration
BOOL uaArchiveGetFieldValueString (
LONG lField,
LPSTR pszString,
LONG cMaxLen )
Parameters
hArchive
lField
the "ID" field.
pszString
pdValue
Maximum length of the string.
Return value
TRUE
Value read.
FALSE
Error

Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Related functions

See also
3.9.7.9 uaArchiveSetFieldValueDate (RT Professional)
Description
Writes the date and time into a field of the current data record.
Declaration
BOOL uaArchiveSetFieldValueDate (
LONG lField,
Parameters
hArchive
lField
the "ID" field.
pstDateTime
Date and Time.

Return value
TRUE
Value written.
FALSE
Error
Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Related functions

See also
3.9.7.10 uaArchiveSetFieldValueDouble (RT Professional)
Description
Writes a value from the Double data type from a field in the current data record.
Declaration
BOOL uaArchiveSetFieldValueDouble (
LONG lField,
double dValue )
Parameters
hArchive

lField
the "ID" field.
dValue
Value to be written.
Return value
TRUE
Value written.
FALSE
Error
Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Related functions

See also
3.9.7.11 uaArchiveSetFieldValueLong (RT Professional)
Description
Writes a value from the Long data type from a field in the current data record.

Declaration
BOOL uaArchiveSetFieldValueLong (
LONG lField,
LONG dValue )
Parameters
hArchive
lField
the "ID" field.
dValue
Value to be written.
Return value
TRUE
Value written.
FALSE
Error
Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Related functions

See also

3.9.7.12 uaArchiveSetFieldValueString (RT Professional)
Description
Writes a value from the String data type from a field in the current data record.
Declaration
BOOL uaArchiveSetFieldValueString (
LONG lField,
LPCSTR pszString )
Parameters
hArchive
lField
the "ID" field.
pszString
String to be written.
Return value
TRUE
Value written.
FALSE
Error
Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Related functions


See also
3.9.7.13 uaGetField (RT Professional)
Description
Reads the field configuration.
Declaration
BOOL uaGetField (
UAHCONFIG hConfig,
Long lArchive,
Long lField,
UACONFIGFIELD* pField )
Parameters
hConfig
lArchive
lField
the "ID" field.
pField
Point on the configuration data buffer.
Return value
TRUE
Configuration read.
FALSE
Error

Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Related functions
See also
uaCONFIGFIELD (Page 2290)
3.9.8 Filter and sort functions. (RT Professional)
3.9.8.1 uaArchiveRequery (RT Professional)
Description
After calling for uaArchiveSetFilter and uaArchiveSetSort you must reload the recipe
usinguaArchiveRequery.
Note
You can use the uaArchiveSetSort and uaArchiveSetFilter functions, without opening the
recipe with uaArchiveOpen. In this case you must not make a call using uaArchiveRequery.
Declaration
BOOL uaArchiveRequery(
Parameters
hArchive

Return value
TRUE
Recipe reloaded.
FALSE
Error
Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Comment
You can also make a call using uaArchiveRequery, if you have inserted Runtime values in the
recipe view.
Related functions

See also
3.9.8.2 uaArchiveSetFilter (RT Professional)
Description
Sets the selection parameters for the recipe. You can also use the function, without opening
the recipe using uaArchiveOpen.
If you have opened a user archive using uaArchiveOpen, you must reload the recipe after
filtering using uaArchiveRequery.

Declaration
VOID uaArchiveSetFilter (
LPSTR pszFilter )
Parameters
hArchive
pszFilter
Selection parameters as SQL parameters.
Return value
TRUE
Selection parameters changed.
FALSE
Error
Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Related functions

See also

3.9.8.3 uaArchiveSetSort (RT Professional)
Description
Sets the sort for a recipe. You can also use the function, without opening the recipe using
uaArchiveOpen.
If you have opened a recipe using uaArchiveOpen, you must reload the recipe after sorting
using uaArchiveRequery.
Declaration
BOOL uaArchiveSetSort (
LPSTR pszSort )
Parameters
hArchive
pszSort
Sort parameters as SQL statement.
Return value
TRUE
Sort successful.
FALSE
Error
Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Related functions


See also
3.9.9 Functions for recipe view processing (RT Professional)
3.9.9.1 uaOpenViews (RT Professional)
Description
Gives the number of recipes in the open Runtime view.
Declaration
LONG uaOpenViews (
Parameters
hArchive
Handle on recipe. This handle is generated using uaConnect.
Return value
Number of currently open views.
Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Related functions

See also
3.9.10 Functions for variables processing (RT Professional)
3.9.10.1 uaArchiveReadTagValues (RT Professional)
Description
Reads the current value from the field tag.
Declaration
BOOL uaArchiveReadTagValues (
LONG* pnFields,
LONG cFields,
LONG lOptions )
Parameters
hArchive
pnFields
cFields
lOptions
Return value
TRUE
Data read.
FALSE
Error

Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Related functions
uaArchiveWriteTagValues (Page 2350) Writing values

See also
3.9.10.2 uaArchiveReadTagValuesByName (RT Professional)
Description
Reads the current values from the tags.
Declaration
BOOL uaArchiveReadTagValuesByName (
LPCSTR pszFields,
LONG lOptions )
Parameters
hArchive
pszFields
lOptions

Return value
TRUE
Data read.
FALSE
Error
Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Related functions
uaArchiveWriteTagValuesByName (Page 2352) Reading values

See also
3.9.10.3 uaArchiveWriteTagValues (RT Professional)
Description
Writes the values of the current data record to the tag.
Declaration
BOOL uaArchiveWriteTagValues (
LONG* pnFields,
LONG cFields,
LONG lOptions )

Parameters
hArchive
pnFields
cFields
lOptions
Return value
TRUE
Data written.
FALSE
Error
Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Related functions
uaArchiveReadTagValues (Page 2348) Reading values

See also

3.9.10.4 uaArchiveWriteTagValuesByName (RT Professional)
Description
Writes the values of the current data record to the tag.
Declaration
BOOL uaArchiveWriteTagValuesByName (
LPCSTR pszFields,
LONG lOptions )
Parameters
hArchive
pszFields
lOptions
Return value
TRUE
Data written.
FALSE
Error
Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Related functions
uaArchiveReadTagValuesByName (Page 2349) Reading values


3.10 Alarm functions (RT Professional)
See also
Overview
MSG_SERVICE_NOTIFY_PROC_PLUS Send and receive service (callback)

(Page 2403)
MSRTActivateMProtPlus (Page 2407) Pause or continue protocol service
MSRTCheckWinFilterPlus (Page 2444) Check the alarm filter conditions
MSRTCreateMsgInstancePlus (Page 2412) Create alarm
MSRTCreateMsgInstanceWithCommentPlus Create alarm
(Page 2410)
AUTOHOTSPOT Set comment text parameters
AUTOHOTSPOT Set alarm filter parameters
MSRTDialogMsgLockPlus (Page 2414) Set parameters for disabling alarms
MSRTEnumArchivDataPlus (Page 2395) List alarms of a log
MSRTEnumBackupListPlus (Page 2457) List export list entries
MSRTEnumGroupMsgPlus (Page 2438) List alarm group individual alarms
AUTOHOTSPOT List report data
MSRTExportPlus (Page 2458) Export alarms from sequential logs
MSRTGetClassInfoPlus (Page 2419) Query alarm class information
MSRTGetCommentInstancePlus (Page 2450) Query comment text
MSRTGetFilterDataPlus (Page 2443) Query alarm filter conditions
MSRTGetInfotextPlus (Page 2454) Query info text
MSRTGetLastMsgWithCommentPlus Query last log alarm
(Page 2423)
MSRTGetMsgActualPlus (Page 2425) Determine number of alarms
MSRTGetMsgCSDataPlus (Page 2426) Query alarm configuration data
MSRTGetMsgPriorityPlus (Page 2429) Query priority of the alarm
MSRTGetMsgQuitPlus (Page 2430) Query alarms that require acknowledgment
MSRTGetMsgTextPlus (Page 2432) Query alarm text block

MSRTGetSelectedMsgPlus (Page 2433) Determine alarm number

MSRTLoopInAlarmPlus (Page 2437) Loop-in-alarm
MSRTMsgWinCommandPlus (Page 2449) Perform control function in alarm window
MSRTPrintMProtPlus (Page 2408) Print alarm sequence report of pending alarms
MSRTQuitGroupPlus (Page 2441) Acknowledge alarm group
MSRTQuitHornPlus (Page 2402) Acknowledge audible signal device
MSRTResetMsgPlus (Page 2435) Acknowledge alarm
MSRTSetCommentInstancePlus (Page 2452) Specify comment text
MSRTSetInfotextPlus (Page 2455) Specify info text
MSRTSetMsgFilterPlus (Page 2446) Set alarm filter
MSRTSetMsgWinFilterPlus (Page 2447) Set alarm filter for an alarm window
MSRTStartMsgServicePlus (Page 2397) Start send and receive service (callback)
MSRTStopMsgServicePlus (Page 2400) Stop send and receive service
See also
MSRTEnumMsgRTDataPlus (Page 2418)
MSRTLockGroupPlus (Page 2440)
Overview
MSG_BACKUP_STRUCT_PLUS (Page 2390) Export list

MSG_CLASS_STRUCT_PLUS (Page 2381) Alarm class
MSG_COMMENT_INSTANCE_STRUCT_PLUS Comment
(Page 2388)
MSG_CSDATA_STRUCT_PLUS (Page 2383) Single alarm
MSG_FILTER_STRUCT_PLUS (Page 2374) Alarm filter
MSG_INFOTEXT_STRUCT_PLUS (Page 2389) Info text
MSG_RTCREATE_STRUCT_PLUS (Page 2368) Create an alarm in the runtime system
MSG_RTDATA_INSTANCECOM‐ Single alarm
MENT_STRUCT_PLUS (Page 2370)
MSG_RTDATA_INSTANCE_STRUCT_PLUS Single alarm
(Page 2378)
MSG_RTGROUPENUM_STRUCT_PLUS Single alarms of an alarm group
(Page 2386)
MSG_RTGROUPSET_STRUCT_PLUS Alarm group data
(Page 2387)
MSG_RTLOCK_STRUCT_PLUS (Page 2392) Alarm lock
MSG_TEXTVAL256_STRUCT_PLUS Associated text values
(Page 2393)

Overview
structure:
Alarm Logging CS
MSG_ERR_CS_CONNECT 0x00001001 No connection to the Alarm Logging CS or to

the project.
MSG_ERR_CS_PROJECT 0x00001002 Incorrect or invalid project
MSG_ERR_CS_PROJECTNAME 0x00001003 Incorrect or invalid project name
MSG_ERR_CS_PARAM 0x00001004 Incorrect parameter; dwError2 contains the
number of the incorrect parameter.
MSG_ERR_CS_NODATA 0x00001005 No data found
MSG_ERR_CS_STRUCTFIELD 0x00001006 Error in a structure field; dwError2 contains
the number of the structure field containing the
incorrect value.
MSG_ERR_CS_DBCONNECT 0x00001011 No DBConnect possible
MSG_ERR_CS_DBCDELETE 0x00001012 Error while deleting (no data?)
MSG_ERR_CS_DBOPEN 0x00001013 Table with single alarms could not be opened
MSG_ERR_CS_SOURCES 0x00001014 Out of memory?
MSG_ERR_CS_CREATOR_ID 0x00001015 CreatorID is WinCC-CreatorID!
MSG_ERR_CS_NOTSUPPORTED 0x00001016 This function is not supported
MSG_ERR_UNKNOWN_ERROR 0x00001020 An unspecified error has occurred (WinC V6.0
and higher)
MSG_ERR_API_TERMINATED 0x00001021 Processing was canceled prematurely
MSG_ERR_NO_MEMORY 0x00001022 Insufficient main memory (WinCC V6.0 and
higher)
MSG_ERR_DB_FAIL 0x00001023 Inconsistent database (WinCC V6.0 and high‐
er)
MSG_ERR_I_WRITE 0x00001024 Data could not be entered into the database.
dwError2 and dwError3 contain further infor‐
mation. (WinCC V6.0 and higher)
MSG_ERR_CS_EXIST 0x00001025 Element already exists (WinCC V6.0 and high‐
er)
MSG_ERR_CS_NO_EXIST 0x00001026 Element does not exist (WinCC V6.0 and high‐
er)
MSG_ERR_HANDLE 0x00000090 Handle invalid
Alarm Logging RT
MSG_ERR_RT_NOTCONNECTED 0x00000001 Connection to the Alarm Logging RT not

established
MSG_ERR_RT_NOINIT 0x00000002 Alarm Logging RT not initialized

MSG_ERR_RT_SERVICEMAX 0x00000003 Maximum number of services reached

MSG_ERR_MSG_NOEXIST 0x00000010 Alarm does not exist
MSG_ERR_MSG_NOTFOUND 0x00000011 Alarm not found
MSG_ERR_MSG_NOQUIT 0x00000012 Alarm does not require acknowledgment
MSG_ERR_MSG_ALREADYQUIT 0x00000013 Alarm already acknowledged
MSG_ERR_MSG_NOCLASS 0x00000014 Class information not available
MSG_ERR_MSG_STATE 0x00000015 Message status unknown
MSG_ERR_MSG_LOCKED 0x00000016 Alarm locked
MSG_ERR_MSG_DATETIME 0x00000017 Alarm has invalid date or invalid time
MSG_ERR_WIN_NAMENOTFOUND 0x00000020 Template name not found
MSG_ERR_WIN_CREATE 0x00000021 Error while creating the alarm window
MSG_ERR_WIN_DATA 0x00000022 Alarm window data invalid
MSG_ERR_VAR_BITEXCEEDS_ 0x00000030 Bit for tag invalid
MSG_ERR_VAR_NOCHANGE_ 0x00000031 No tag change
MSG_ERR_VAR_PROCESS_USED_ 0x00000032 Event tag is already assigned
MSG_ERR_VAR_QUIT_USED_ 0x00000033 Acknowledgment tag is already assigned
MSG_ERR_VAR_STATE_USED_ 0x00000034 Status tag is already assigned
MSG_ERR_VAR_VARIANTCONV_ 0x00000035 Error during variant conversion
MSG_ERR_VAR_USED_TYPDIFF_ 0x00000036 Event tag assigned, different types (Ack,
Create, ...)
MSG_ERR_HANDLE 0x00000090 Handle invalid
MSG_ERR_FILTER 0x00000091 Filter condition invalid
MSG_ERR_API_PARAM 0x00000095 Parameter invalid
MSG_ERR_API_SERVICE 0x00000099 dwServiceID invalid
MSG_ERR_API_EXCEPTION 0x0000009a An exception situation occurred in the
code
MSG_ERR_API_DATETIME 0x0000009b Date/time stamp invalid
MSG_ERR_API_SERVICEMAX 0x0000009c Maximum number of services reached
MSG_ERR_API_NODATA 0x0000009d No data
MSG_ERR_PROT_ID 0x00000111 Invalid protocol identifier
MSG_ERR_PROT_BLOCKS 0x00000110 No blocks in protocol
MSG_ERR_PROT_ACTIVE 0x00000112 Protocol service already active
MSG_ERR_NODEFAULTSERVER 0x00000401 No default server configured
MSG_ERR_NOLOCALSERVER 0x00000402 No local server available
MSG_ERR_NOSERVER 0x00000403 No default server configured and no local
server available
MSG_ERR_NOMC 0x00000404 No multiclient project (not used here)
MSG_ERR_NOMCDEFAULTSERVER 0x00000405 No multiclient project and "@default"
specified (not used here)

General specifications
MSG_MAX_CLASS (value: 18) Number of alarm classes

MSG_MAX_CLASSTYPE (value: 16) Number of alarm types in alarm
class
MSG_MAX_PVALUE (value: 10) Number of process values
MSG_MAX_TB (value: 10) Number of user texts
MSG_MAX_HITLIST (value: 7) Number of hit list element
MSG_MAX_TB_CONTENT (value: 255) Number of characters per user
text
MSG_MAX_TEXTLEN (value: 64) Number of characters for all texts
MSG_MAX_TEXTVALUE (value: 32) Number of characters in associ‐
ated text values
MSG_MAX_TEXTVALUE256 (value: 256) Number of characters in associ‐
ated text values
MSG_MAX_STATE (value: 4) Number of status texts
MSG_MAX_LOCKITEMS (value: 16) Number of alarms for a lock
MSG_MAX_LEVEL (value: 6) Number of nodes for group
alarms
MSG_MAX_MSG_COUNT (value: 150000) Maximum number of single
V6.2 and higher: (value: 50000) alarms in the project
MSG_MAX_GROUPITEMS (value: 1000) Number of alarms for a group
with Enum
MSG_MAX_USERNAME (value: 16) Maximum length of a user group
name
MSG_MAX_APPLNAME (value: 32) Maximum length of an applica‐
tion name
MSG_MAX_INSTANCE (value: 512) Instance name
MSG_MAX_ARCHIV_QUEUE (value: 1500) Max. number of bufferable log
entries
Alarm states
MSG_STATE_COME (value: 0x00000001) Incoming alarm

MSG_STATE_GO (value: 0x00000002) Outgoing alarm
MSG_STATE_QUIT (value: 0x00000003) Alarm acknowledged
MSG_STATE_LOCK (value: 0x00000004) Alarm locked
MSG_STATE_UNLOCK (value: 0x00000005) Alarm released
MSG_STATE_HIDE (value: 0x0000000A) Alarm hidden
MSG_STATE_UNHIDE (value: 0x0000000B) Alarm displayed
MSG_STATE_HIDE_MANUAL (value: 0x0000000C) Alarm hidden manually
MSG_STATE_UNHIDE_MAN‐ (value: 0x0000000D) Alarm displayed manually
UAL

MSG_STATE_QUIT_SYSTEM (value: 0x00000010) Alarm acknowledged by system

MSG_STATE_QUIT_EMER‐ (value: 0x00000011) Emergency acknowledgment
GENCY
MSG_STATE_QUIT_HORN (value: 0x00000012) Horn acknowledgment
MSG_STATE_COMEGO (value: 0x00000013) Incoming and outgoing alarm,
display in alarm list only
MSG_STATE_RESET (value: 0x00020000) Bit for alarm reset
MSG_STATE_SUMTIME (value: 0x00040000) Bit for daylight saving time active
MSG_STATE_INSTANCE (value: 0x00080000) Bit for instance alarm (n alarms
of a no.)
MSG_STATE_TIMEINVALID (value: 0x00100000) Bit for invalid date/time stamp
OR operation with
(MSG_STATE_COME,
MSG_STATE_GO, ....)
MSG_STATE_HIDDEN (value: 0x02000000) Bit for currently hidden alarm,
available in V6.2 and higher
Flags of an alarm in the database table
MSG_FLAG_SUMTIME (value: 0x00000001) Daylight saving time active

MSG_FLAG_COMMENT (value: 0x00000002) Alarm has comments
MSG_FLAG_ARCHIV (value: 0x00000004) Log
MSG_FLAG_PROTOCOL (value: 0x00000008) Report
MSG_FLAG_TEXTVALUES (value: 0x00000010) Alarm has associated text values
MSG_FLAG_TIMEINVALID (value: 0x00000020) Bit for invalid date/time stamp
MSG_FLAG_INSTANCE (value: 0x00000040) Marking of instance alarms
MSG_FLAG_HIDDEN (value: 0x00000080) Hidden alarm, available in V6.2
and higher
MSG_FLAG_TEXT10_EXT (value: 0x00000100) Extended channel diagnostics,
MSG_FLAG_INSTANCE10 (value: 0x08000000) Instance alarm with process val‐
ue 10, available in V5.0 SP2 and
higher
MSG_FLAG_TEXTREF1 (value: 0x10000000) Text reference 1, available in
V5.0 SP2 and higher
MSG_FLAG_TEXTREF2 (value: 0x20000000) Text reference 2, available in
V5.0 SP2 and higher
Flags of an alarm in the online table

Only defined in m_global.h starting in WinCC V6.0 SP4.
MSG_RT_FLAG_COME (value: 0x00000001) Incoming alarm

MSG_RT_FLAG_GO (value: 0x00000002) Outgoing alarm
MSG_RT_FLAG_QUIT_COME (value: 0x00000004) Incoming acknowledgment
MSG_RT_FLAG_QUIT_GO (value: 0x00000008) Outgoing acknowledgment
MSG_RT_FLAG_NOQUIT (value: 0x00000010) No acknowledgment

MSG_RT_FLAG_QUIT_NOGO (value: 0x00000020) TM II acknowledgment

MSG_RT_FLAG_FLASH (value: 0x00000040) Flashing
MSG_RT_FLAG_FIRSTFLASH (value: 0x00000080) Only first alarm is permitted to
flash
MSG_RT_FLAG_NOLIST (value: 0x00000100) Alarms are not received in the
message list
MSG_RT_FLAG_UNIQUE_USE (value: 0x00000200) Alarms with unique user name
R
MSG_RT_FLAG_ONL_COM_C (value: 0x00000400) Display only comments of in‐
OM coming alarm in alarm list
MSG_RT_FLAG_HIDDEN (value: 0x00000800) Alarm hidden
MSG_RT_FLAG_TEXT10_EXT (value: 0x00001000) Extended channel diagnostics,
MSG_RT_FLAG_DELETE (value: 0x00010000) Alarm can be deleted
MSG_RT_FLAG_SUMTIME (value: 0x00020000) Daylight saving time flag
MSG_RT_FLAG_SQUIT (value: 0x00040000) Alarm has group acknowledg‐
ment
MSG_RT_FLAG_QUITNR (value: 0x00080000) Alarm number - Ack
MSG_RT_FLAG_MSGLIST (value: 0x00100000) Alarm from alarm list
MSG_RT_FLAG_COMMENT (value: 0x00200000) Alarm has comments
MSG_RT_FLAG_ARCHIV (value: 0x00400000) Alarm is logged
MSG_RT_FLAG_PROTOCOL (value: 0x00800000) Alarm is logged
MSG_RT_FLAG_INSTANCE (value: 0x01000000) Flag for instance alarm
MSG_RT_FLAG_TIMEINVALID (value: 0x02000000) Flag for invalid date/time stamp
MSG_RT_FLAG_LOCKGROUP (value: 0x04000000) Flag for group lock
MSG_RT_FLAG_INSTANCE10 (value: 0x08000000) Bit for new instance alarm with
process value 10.
MSG_RT_FLAG_TEXTREF1 (value: 0x10000000) Bit for text reference 1
MSG_RT_FLAG_TEXTREF2 (value: 0x20000000) Bit for text reference 2
MSG_RT_FLAG_QUITCOUNT‐ (value: 0x40000000) Bit for acknowledgment via
ER counter
MSG_RT_FLAG_QUITGROUP (value: 0x80000000) Bit for acknowledgment via
counter
Flags for single alarms
MSG_PARAMS_SQUIT (value: 0x00000001) Alarm is subject to single ac‐

knowledgment.
MSG_PARAMS_HORN (value: 0x00000002) Alarm activates horn.
MSG_PARAMS_ARCHIV (value: 0x00000004) Alarm is to be logged.
MSG_PARAMS_PROTOCOL (value: 0x00000008) Alarm is to be reported.
MSG_PARAMS_VARFLANK (value: 0x00000010) Alarm is generated on falling
edge of tag.
MSG_PARAMS_LOCKED (value: 0x00000020) Alarm is locked during startup.
MSG_PARAMS_INFOTEXT (value: 0x00000040) Alarm has an info text.

MSG_PARAMS_LOOPINA‐ (value: 0x00000080) Alarm has loop-in-alarm.

LARM
MSG_PARAMS_APFUNC (value: 0x00000100) Alarm activates global AP func‐
tion.
MSG_PARAMS_NORMDLL (value: 0x00000200) Alarm has a normalization DLL.
MSG_PARAMS_TEXT10_EXT (value: 0x00000400) Extended channel diagnostics,
available in V7.0 and higher.
State machines
MSG_QUIT_QUIT_COME (value: 0x00000004) Incoming acknowledgment

MSG_QUIT_QUIT_GO (value: 0x00000008) Outgoing acknowledgment
MSG_QUIT_NOQUIT (value: 0x00000010) No acknowledgment
MSG_QUIT_QUIT_NOGO (value: 0x00000020) TM II acknowledgment (without
outgoing alarm)
MSG_QUIT_FLASH (value: 0x00000040) Flashing
MSG_QUIT_FIRSTFLASH (value: 0x00000080) Only first alarm is permitted to
flash
MSG_QUIT_NOLIST (value: 0x00000100) Alarms are not received in the
message list
MSG_QUIT_UNIQUE_USER (value: 0x00000200) Alarms with unique user name
MSG_QUIT_ONL_COM_COME (value: 0x00000400) Display only comments of in‐
coming alarm in alarm list
Group alarms
MSG_COLLECT_ALL (value: 0x00000001) All alarms

MSG_COLLECT_QUIT (value: 0x00000002) All unacknowledged alarms
MSG_COLLECT_CLASS (value: 0x00000003) All alarms of an alarm class
MSG_COLLECT_TYPE (value: 0x00000004) All alarms of an alarm type
MSG_COLLECT_USER (value: 0x00000005) User-defined group alarms
Single alarms
MSG_SINGLE_OPERATION (value: 0x00BEDBED) Operator input alarm
Alarm classes
MSG_CLASS_SYSTEM_QUIT (value: 0x00000011) System alarm class with ac‐

knowledgment
MSG_CLASS_SYSTEM (value: 0x00000012) System alarm class without ac‐
knowledgment

Alarm blocks
The main type of the alarm blocks is available in the HIWORD. The LOWORD includes the
subtypes of the alarm blocks.
MSG_BLOCK_SYSTEM (value: 0x00010000) System blocks

MSG_BLOCK_DATE (value: 0x00010001) Date
MSG_BLOCK_TIME (value: 0x00010002) Time of day
MSG_BLOCK_TIMEDIFF (value: 0x00010003) Alarm duration
MSG_BLOCK_SUMWIN (value: 0x00010004) Daylight-saving time/standard
time
MSG_BLOCK_STATE (value: 0x00010005) Alarm status
MSG_BLOCK_QUIT (value: 0x00010006) Acknowledgment status
MSG_BLOCK_NUMBER (value: 0x00010007) Alarm number
MSG_BLOCK_CLASS (value: 0x00010008) Alarm class
MSG_BLOCK_TYP (value: 0x00010009) Alarm type
MSG_BLOCK_AGCPU (value: 0x0001000A) Controller/CPU number
MSG_BLOCK_DMVAR (value: 0x0001000B) Alarm tag
MSG_BLOCK_LIMIT (value: 0x0001000C) Limit exceeded
MSG_BLOCK_ARCHIV (value: 0x0001000D) Log identifier
MSG_BLOCK_PROTOCOL (value: 0x0001000E) Report identifier
MSG_BLOCK_COMMENT (value: 0x0001000F) Comment
MSG_BLOCK_INFO (value: 0x00010010) Info text
MSG_BLOCK_LOOPINALARM (value: 0x00010011) Loop-in-alarm/AP function
MSG_BLOCK_COMPUTER‐ (value: 0x00010012) Computer name
NAME
MSG_BLOCK_USERNAME (value: 0x00010013) User name
MSG_BLOCK_PRIORITY (value: 0x00010014) Priority
MSG_BLOCK_TEXT (value: 0x00020000) The maximum amount of 16
user text blocks can be activated
using the MSG_BLOCK_TEXT1
to MSG_BLOCK_TEXT16 con‐
stants with values 0x00020001
to 0x00020010.
MSG_BLOCK_VALUE (value: 0x00030000) The maximum amount of 16
process value text blocks can be
activated using the
MSG_BLOCK_VALUE1 to
MSG_BLOCK_VALUE16 con‐
stants with values 0x00030001
to 0x00030010.
MSG_MAX_SYSBL Number of system alarm blocks
= MSG_BLOCK_LOOPINA‐
LARM -MSG_BLOCK_SYSTEM
MSG_MAX_SYSBL_V6 Number of system blocks in
V6.0 and higher =
MSG_BLOCK_PRIORITY -
MSG_BLOCK_SYSTEM

MSG_MAX_BLOCKS Total number of alarm blocks =

(MSG_MAX_TB +
MSG_MAX_PVALUE +
MSG_MAX_SYSBL)
MSG_MAX_BLOCKS_V6 Total number of alarm blocks in
V6.0 and higher =
(MSG_MAX_TB +
MSG_MAX_PVALUE +
MSG_MAX_SYSBL_V6)
Date format
DATE_FORMAT_YEAR_2 (value: 0x00000001) Two-digit year specification

DATE_FORMAT_YEAR_4 (value: 0x00000002) Four-digit year specification
DATE_FORMAT_DMY (value: 0x00000004) Order: Day, month, year
DATE_FORMAT_MDY (value: 0x00000008) Order: Month, day, year
DATE_FORMAT_YMD (value: 0x00000010) Order: Year, month, day
Time of day format
TIME_FORMAT_HOUR (value: 0x00000001) Hour

TIME_FORMAT_MIN (value: 0x00000002) Minute
TIME_FORMAT_SEC (value: 0x00000004) Second
TIME_FORMAT_MSEC (value: 0x00000008) Millisecond
TIME_FORMAT_24HOUR (value: 0x00000010) 24-hour format
TIME_FORMAT_DAY (value: 0x00000020) Hour display
Alarm number - format

The formatting rule (with leading zeros) is available in the HiWord; the LoWord contains the
number of digits.
MSGNR_FORMAT_NOLEAD‐ (value: 0x00000000)

ING
MSGNR_FORMAT_LEADING‐ (value: 0x00010000)
ZERO
MSG_BLOCK_FOR‐ (value: 0x00020000) Right-justified output
MAT_RIGHT
MSG_BLOCK_FORMAT_CEN‐ (value: 0x00040000) Centered output
TER
MSG_BLOCK_FOR‐ (value: 0x80000000) Alarm block flashing
MAT_FLASH

Elements of the status bar
MSG_SB_HELP (value: 0x00000001) Help line

MSG_SB_DATE (value: 0x00000002) Date
MSG_SB_TIME (value: 0x00000004) Time of day
MSG_SB_COUNTALL (value: 0x00000008) All alarms
MSG_SB_COUNTSEL (value: 0x00000010) Current alarms
MSG_SB_COUNTQUIT (value: 0x00000020) Acknowledged alarms
MSG_SB_SELECT (value: 0x00000040) Selection active
MSG_SB_LOCK (value: 0x00000080) Lock active
MSG_SB_HIDE (value: 0x00000100) Hiding of alarms active
MSG_SB_WARNING (value: 0x00000200) Hiding information
MSG_MAX_SBITEMS (value: 10) Maximum number of elements
in the status bar
Elements of the symbol bar
MSG_TB_MSGWIN (value: 0x00000001) Display "Alarm window" button.

MSG_TB_ARC_S (value: 0x00000002) Display "Circular log" button.
MSG_TB_ARC_L (value: 0x00000004) Display "Sequential log" button.
MSG_TB_QH (value: 0x00000008) Display "Horn acknowledgment"
button.
MSG_TB_QM (value: 0x00000010) Display "Single acknowledg‐
ment" button.
MSG_TB_QS (value: 0x00000020) Display "Group acknowledg‐
ment" button.
MSG_TB_SCROLL (value: 0x00000040) Display "Scroll function On/Off"
button.
MSG_TB_SELECT (value: 0x00000080) Display "Selection dialog" but‐
ton.
MSG_TB_LOCK (value: 0x00000100) Display "Lock dialog" button.
MSG_TB_PROTOCOL (value: 0x00000200) Display "Report dialog" button.
MSG_TB_CITYRUF (value: 0x00000400) Display "City call" button.
MSG_TB_RESET (value: 0x00000800) Display "Reset button" button.
MSG_TB_MSGFIRST (value: 0x00001000) Display "Start of list" button.
MSG_TB_MSGLAST (value: 0x00002000) Display "End of list" button.
MSG_TB_MSGNEXT (value: 0x00004000) Display "Next alarm" button.
MSG_TB_MSGPREV (value: 0x00008000) Display "Previous alarm" button.
MSG_TB_INFO (value: 0x00010000) Display "Info texts" button.
MSG_TB_COMMENT (value: 0x00020000) Display "Enter comment" button.
MSG_TB_LOOPINALARM (value: 0x00040000) Display "Loop-in-alarm" button.
MSG_TB_LANGUAGESET (value: 0x00080000) Display "Language switch" but‐
ton.
MSG_TB_PRINT (value: 0x00100000) Display "Print" button.
MSG_TB_LOCKWIN (value: 0x00200000) Display "Lock window" button.

MSG_TB_UNLOCKMSG (value: 0x00400000) Display "Release alarm" button.

MSG_TB_LOCK_UN‐ (value: 0x00400000) Display "Lock or release alarm"
LOCK_MSG button.
MSG_TB_SORTDLG (value: 0x00800000) Display "Sorting dialog" button.
MSG_TB_TIMEBASE (value: 0x01000000) Display "Dialog for timebase"
button.
MSG_TB_HITLIST (value: 0x02000000) Display "Hit list" button.
MSG_TB_HIDELIST (value: 0x04000000) Display "List of hidden messag‐
es" button
MSG_TB_UNHIDEMSG (value: 0x08000000) Display "Display alarm" button.
MSG_TB_HIDE_UNHIDE_MSG (value: 0x080000000) Display "Hide and display alarm"
button.
MSG_TB_HIDEDLG (value: 0x10000000) Display "Hide and display alarm
dialog" button.
MSG_MAX_TBITEMS (value: 24) Maximum number of operator
controls in the status bar.
MSG_MAX_TBITEMS_V6 (value: 25) Maximum number, available in
V6 and higher
MSG_MAX_TBITEMS_V6_1 (value: 26) Maximum number, available in
V6.1 and higher
MSG_MAX_TBITEMS_V6_2 (value: 30) Maximum number, available in
V6.2 and higher
MSG_ALIGN_TOP (value: 1) Top alignment
MSG_ALIGN_BOTTOM (value: 2) Bottom alignment
MSG_ALIGN_LEFT (value: 3) Left alignment
MSG_ALIGN_RIGHT (value: 4) Right alignment
Window options
MSG_MWWIN_SWITCHENA‐ (value: 0x00000001) Process value switching

BLE
MSG_MWWIN_PROCESS (value: 0x00000002) Process alarm window
MSG_MWWIN_ARCHIV_CIR‐ (value: 0x00000004) Circular log
CLE
MSG_MWWIN_ARCHIV_LONG (value: 0x00000008) Sequential log
MSG_MWWIN_GRIDLINE‐ (value: 0x00000010) Grid line horizontal
HORZ
MSG_MWWIN_GRIDLINEVERT (value: 0x00000020) Grid line vertical
MSG_MWWIN_LINETITLE (value: 0x00000040) Line label
MSG_MWWIN_LINEHEIGHT (value: 0x00000080) Line height adjustable
MSG_MWWIN_LINEHEIGHT‐ (value: 0x00000100) Adapt font to line height
FONT
MSG_MWWIN_COLUMNTITLE (value: 0x00000200) Column label
MSG_MWWIN_COLUMNTI‐ (value: 0x00000400) 2 title lines
TLE2
MSG_MWWIN_COLUMNTI‐ (value: 0x00000800) 3 title lines
TLE3

MSG_MWWIN_COLUM‐ (value: 0x00001000) Column width adjustable

NWIDTH
MSG_MWWIN_COLUMNMOVE (value: 0x00002000) Columns may be moved
MSG_MWWIN_CELLSELECT (value: 0x00004000) Selection cell only (default set‐
ting: line)
MSG_MWWIN_LINESELECT (value: 0x00008000) Line selection
MSG_MWWIN_AUTOSCROLL‐ (value: 0x00010000) Auto scroll Off (default setting:
OFF On)
MSG_MWWIN_TITLECUT (value: 0x00020000) Title will be truncated with peri‐
ods if necessary
MSG_MWWIN_CELLCUT (value: 0x00040000) Cell content truncated with peri‐
ods if necessary
MSG_MWWIN_TITLEBAR (value: 0x00080000) Display title line of window (+
frame)
MSG_MWWIN_SIZEABLE (value: 0x00100000) Size of window adjustable
MSG_MWWIN_TOOLTIP (value: 0x00200000) Tool tip display specially for
alarm texts
MSG_MWWIN_LOOP_IN_ALAR (value: 0x00400000) One click for "Loop-in-alarm"
M_DC
MSG_MWWIN_SELECTFO‐ (value: 0x00800000) Selection made with frame in‐
CUSRECT stead of inversion
MSG_MWWIN_OPMSG_HIDE (value: 0x01000000) Operator input alarm when hid‐
ing
MSG_MWWIN_OPMSGUN‐ (value: 0x02000000) Operating input alarm when dis‐
HIDE playing
MSG_MWWIN_IN‐ (value: 0x08000000) Instance-specific column width
STANCE_COLWIDTH
MSG_MWWIN_INSTANCE‐ (value: 0x10000000) Instance-specific alarm block
BLOCKINFO settings
MSG_MWWIN_OPMSG_LOCK (value: 0x20000000) Operator input alarm when lock‐
ing
MSG_MWWIN_OPMSG_UN‐ (value: 0x40000000) Operator input alarm when re‐
LOCK leasing
MSG_MWWIN_OPMSG_ACK (value: 0x80000000) Operator input alarm when ac‐
knowledging
Filter conditions
MSG_FILTER_DATE_FROM (value: 0x00000001) Date from

MSG_FILTER_DATE_TO (value: 0x00000002) Date to
MSG_FILTER_TIME_FROM (value: 0x00000004) Time from
MSG_FILTER_TIME_TO (value: 0x00000008) Time to
MSG_FILTER_NR_FROM (value: 0x00000010) Alarm number from
MSG_FILTER_NR_TO (value: 0x00000020) Alarm number to
MSG_FILTER_CLASS (value: 0x00000040) Alarm classes
MSG_FILTER_STATE (value: 0x00000080) Alarm status
MSG_FILTER_AG_FROM (value: 0x00000100) AG number from

MSG_FILTER_AG_TO (value: 0x00000200) AG number to

MSG_FILTER_AGSUB_FROM (value: 0x00000400) AG sub-number from
MSG_FILTER_AGSUB_TO (value: 0x00000800) AG sub-number to
MSG_FILTER_ARC (value: 0x00001000) Log/report identifier
MSG_FILTER_TEXT (value: 0x00002000) Alarm texts
MSG_FILTER_PVALUE (value: 0x00004000) Process values
MSG_FILTER_COUN‐ (value: 0x00008000) Internal alarm counter from
TER_FROM
MSG_FILTER_COUNTER_TO (value: 0x00010000) Internal alarm counter to
MSG_FILTER_PROCESSMSG (value: 0x00020000) Process alarms
MSG_FILTER_SYSMSG (value: 0x00040000) System events
MSG_FILTER_BEDMSG (value: 0x00080000) Operator input alarms
MSG_FILTER_QUICKSELECT (value: 0x00100000) Quick selection (current day,
etc.)
MSG_FILTER_TEXT_EQUAL (value: 0x00200000) Exact alarm texts
MSG_FILTER_PRIORI‐ (value: 0x00400000) Priority from
TY_FROM
MSG_FILTER_PRIORITY_TO (value: 0x00800000) Priority to
MSG_FILTER_VISIBLEONLY (value: 0x01000000) Show displayed alarms
MSG_FILTER_HIDDENONLY (value: 0x02000000) Show hidden alarms
MSG_FILTER_NODYNAMIC (value: 0x04000000) No selection of dynamic texts
MSG_FILTER_DATE Value: (MSG_FIL‐
TER_DATE_FROM | MSG_FIL‐
TER_DATE_TO)
MSG_FILTER_TIME Value: (MSG_FIL‐
TER_TIME_FROM | MSG_FIL‐
TER_TIME_TO)
MSG_FILTER_NR Value: (MSG_FIL‐
TER_NR_FROM | MSG_FIL‐
TER_NR_TO)
Quick selection
The end time of the quick selection refers to the current system time of the local computer.
The start time is back calculated n * (months, days, hours).
MSG_FILTER_QUICK_MONTH (value: 0x00000001) Last n months

MSG_FILTER_QUICK_DAYS (value: 0x00000002) Last n days
MSG_FILTER_QUICK_HOUR (value: 0x00000003) Last n hours
Log types
MSG_ARPRO_LONGARCH (value: 0x00000001) Sequential log

MSG_ARPRO_SHORTARCH (value: 0x00000002) Circular log
MSG_ARPRO_ARCHPROT (value: 0x00000003) Log report
MSG_ARPRO_MFPROT (value: 0x00000004) Alarm sequence report

Flags for logs
MSG_ARPRO_PAR‐ (value: 0x00000001) Short-term log in main memory

AM_HSPONLY
MSG_ARPRO_PARAM_CIR‐ (value: 0x00000002) Circular log
CLE
MSG_ARPRO_PARAM_EN‐ (value: 0x00000004) Endless log
DLES
MSG_ARPRO_PARAM_RE‐ (value: 0x00000008) Reload after power failure
LOAD
MSG_ARPRO_PARAM_LINE‐ (value: 0x00000010) Print linewise (alarm sequence
PRINT report only)
IDs for locking alarms
MSG_LOCK_UNKNOWN (value: 0) Lock is unknown

MSG_LOCK_CLASS (value: 1) Locks of alarm classes
MSG_LOCK_GROUP1 (value: 2) Locks of alarm group level 1
MSG_LOCK_GROUP2 (value: 3) Locks of alarm group level 2
IDs for logs
MSG_PROT_MSG (value: 1) Alarm sequence report

MSG_PROT_ARCHIV_CIRCLE (value: 2) Log report of circular log
MSG_PROT_ARCHIV_LONG (value: 3) Log report of sequential log
IDs for export of alarm logs
MSG_DB_FMT_CSV (value: 1) CSV file format

MSG_DB_FMT_DBASE3 (value: 2) DBASE3 file format
MSG_DB_FMT_WATCOM (value: 3) Watcom format
MSG_DB_FLAGS_OVER‐ (value: 1) Overwrite existing data records
WRITE
MSG_DB_FLAGS_ADD (value: 2) Add only
MSG_DB_FLAGS_DELETE (value: 4) Delete source data records
MSG_DB_FLAGS_NOEXPORT (value: 8) Do not export data records -->
Delete only (no longer available)
Flags for generic configuration

The flags can be logically combined.
MSG_GENERIC_APPEND (value: 0x00000001) Create new

MSG_GENERIC_OVERWRITE (value: 0x00000002) Overwrite
MSG_GENERIC_DELETE (value: 0x00000004) Delete

Mode for tags
MSG_CS_VAR_NOTSET (value: 0x0000) No tag set

MSG_CS_VARNAME_SET (value: 0x0001) Tag name is set
MSG_CS_VARID_SET (value: 0x0002) Tag ID is set
MSG_CS_VARALL_SET (value: 0x0003) Tag ID and name are set
Enumeration of the logs
MSG_ARCHIV_ENUM_DESC (value: 0x00000001) Sorted in descending order (de‐

fault setting: ascending)
3.10.2.1 MSG_RTCREATE_STRUCT_PLUS (RT Professional)
Declaration
typedef struct {
DWORD dwMsgState;
DWORD dwMsgNrLow;
DWORD dwMsgNrHigh;
DWORD dwFlags;
WORD wPValueUsed;
MSG_TEXTVAL256_STRUCT_PLUS mtTextValueW[MSG_MAX_PVALUE]
}
MSG_RTCREATE_STRUCT_PLUS;
Members
dwMsgState
Alarm status in compliance with the constants in the "m_global.h" file:
MSG_STATE_COME Incoming alarm

MSG_STATE_GO Outgoing alarm
MSG_STATE_QUIT Alarm acknowledged
MSG_STATE_LOCK Alarm locked
MSG_STATE_UNLOCK Alarm released
MSG_STATE_HIDE Alarm hidden

MSG_STATE_UNHIDE Alarm displayed

MSG_STATE_HIDE_MANUAL Alarm hidden manually
MSG_STATE_UNHIDE_MANUAL Alarm displayed manually
dwMsgNrLow
dwMsgNrLow Number of the first alarm
dwMsgNrHigh
dwMsgHigh Number of the last alarm
dwFlags
stMsgTime
Date and time for coming-in or going-out of an alarm. The system time of the PLC or the OS
will be used when acknowledging.
dPValue
Numeric process values.
wPValueUsed
Process values used in bit coded layout.
Each bit should only be set in one of the two members wPValueUsed or wTextValueUsed,
because only number or text is technically possible as an associated value. In the case of
erroneous double entry the dPValue has priority.
mtTextValue
Structure of the MSG_TEXTVAL256_STRUCT_PLUS (Page 2393) type with the associated
text values.
wTextValueUsed
Text process values used in bit coded layout.
Comment
Before you fill out the structure, you should initialize it with "0".
Required files
CCMSRTCLIPlus.h

API functions
AUTOHOTSPOT Create alarm
See also
MSG_TEXTVAL256_STRUCT_PLUS (Page 2393)
3.10.2.2 MSG_RTDATA_INSTANCECOMMENT_STRUCT_PLUS (RT Professional)
Declaration
typedef struct {
DWORD dwMsgState;
DWORD dwMsgNrLow;
DWORD dwMsgNrHigh;
DWORD dwTimeDiff;
DWORD dwCounter;
DWORD dwFlags;
WORD wPValueUsed;
MSG_TEXTVAL256_STRUCT_PLUS mtTextValue[MSG_MAX_PVALUE];
WCHAR szInstance[MSG_MAX_INSTANCE+1];
WCHAR szComment[MSG_MAX_TB_CONTENT+1];
WCHAR szUser[MSG_MAX_USERNAME+1];
WCHAR szComputerName[MAX_COMPUTERNAME_LENGTH+1];
WCHAR szApplicationName[MSG_MAX_APPLNAME+1];
WCHAR szServerPrefix[_MAX_PATH+1];
}
MSG_RTDATA_INSTANCECOMMENT_STRUCTPlus;
Members
dwMsgState
The statuses listed will only be used internally by the system and can only by set by the API
using MSRTCreateMsgInstanceWithCommentPlus.



MSG_STATE_UNHIDE_MANUAL Alarm displayed manually
dwMsgNrLow
dwMsgNrHigh
stMsgTime
Date and time for coming-in or going-out of an alarm.
dwTimeDiff
Duration coming in or going out, telegram time in seconds.
dwCounter
Internal alarm counter.
dwFlags
Flags in compliance with the constants in the "m_global.h" file:
Flags for alarms in the alarm view

MSG_RT_FLAG_COME 0x00000001 Incoming alarm
MSG_RT_FLAG_GO 0x00000002 Outgoing alarm
MSG_RT_FLAG_QUIT_COME 0x00000004 Incoming acknowledgment
MSG_RT_FLAG_QUIT_GO 0x00000008 Outgoing acknowledgment
MSG_RT_FLAG_NOQUIT 0x00000010 No acknowledgment
MSG_RT_FLAG_QUIT_NOGO 0x00000020 TM II acknowledgment
MSG_RT_FLAG_FLASH 0x00000040 Flashing
MSG_RT_FLAG_FIRSTFLASH 0x00000080 Only first alarm is permitted to flash
MSG_RT_FLAG_DELETE 0x00010000 Alarm can be deleted
MSG_RT_FLAG_SUMTIME 0x00020000 Daylight saving time flag
MSG_RT_FLAG_SQUIT 0x00040000 Alarm has group acknowledgment
MSG_RT_FLAG_QUITNR 0x00080000 Alarm number acknowledgment
MSG_RT_FLAG_MSGLIST 0x00100000 Alarm from the alarm list
MSG_RT_FLAG_COMMENT 0x00200000 Alarm has comments
MSG_RT_FLAG_ARCHIV 0x00400000 Alarm is logged
MSG_RT_FLAG_PROTOCOL 0x00800000 Alarm is reported
MSG_RT_FLAG_INSTANCE 0x01000000 Flag for instance alarm
MSG_RT_FLAG_TIMEINVALID 0x02000000 Flag for invalid date/time stamp
MSG_RT_FLAG_LOCKGROUP 0x04000000 Flag for group lock
MSG_RT_FLAG_INSTANCE10 0x08000000 Bit for new instance alarm with process val‐
ue 10.


MSG_RT_FLAG_TEXTREF1 0x10000000 Bit for text reference 1.
MSG_RT_FLAG_QUITCOUNTER 0x40000000 Bit for acknowledgment via counter
MSG_RT_FLAG_QUITGROUP 0x80000000 Bit for acknowledgment via counter
With the MSRTCreateMsgInstanceWithCommentPlus function, flags cannot be sent to the

alarm server. Flags are ignored.
wPValueUsed
wTextValueUsed
Text values used, bit-coded.
because only number or text is technically possible as an associated value.
In the case of erroneous double entry the dPValue has priority.
dPValue
Process values.
mtTextValue
text values.
szInstance
Instance name. If szInstance is not provided (empty string), a normal alarm is created
szComment
Comment name
szUser
User name.
szComputerName
Computer name.
szApplicationName
Application name.
szServerPrefix
Server prefix.

Comment
Before you fill out the structure, you should initialize it with "0".
Required files
CCMSRTCLIPlus.h
API functions

(Page 2410)
MSRTGetLastMsgWithCommentPlus Query last archived alarm
(Page 2423)
MSG_SERVICE_NOTIFY_PROC_PLUS Callback function
(Page 2403)
See also
MSRTCreateMsgInstanceWithCommentPlus (Page 2410)
MSRTGetLastMsgWithCommentPlus (Page 2423)
MSG_SERVICE_NOTIFY_PROC_PLUS (Page 2403)
MSRTGetSelectedMsgPlus (Page 2433)
MSRTCheckWinFilterPlus (Page 2444)

3.10.2.3 MSG_FILTER_STRUCT_PLUS (RT Professional)
Declaration
typedef struct {
WCHAR szFilterName[MSG_MAX_TEXTLEN+1];
DWORD dwFilter;
SYSTEMTIME st[2];
DWORD dwMsgNrLow[2];
DWORD dwMsgNrHigh[2];
VARIANT vMsgClasses;
DWORD dwMsgState;
WORD wAGNr[2];
WORD wAGSubNr[2];
DWORD dwArchivMode;
WCHAR szTB[MSG_MAX_TB][MSG_MAX_TB_CONTENT+1]
DWORD dwTB;
double dPValue[MSG_MAX_PVALUE][2];
DWORD dwPValue[2];
ULONGLONG ullMsgCounter[2]; /* in Script it has the union type
MSGULONGLONG, see CCMsrtCliPlus.h */
DWORD dwQuickSelect;
DWORD dwPriority[2];
}
MSG_FILTER_STRUCT_PLUS;
Members
szFilterName
Filter name
dwFilter
The filter conditions are defined by means of the following constants from the file "m_global.h":
MSG_FILTER_DATE_FROM Date from

MSG_FILTER_DATE_TO Date to
MSG_FILTER_TIME_FROM Time from
MSG_FILTER_TIME_TO Time to
MSG_FILTER_NR_FROM Alarm number from
MSG_FILTER_NR_TO Alarm number to
MSG_FILTER_CLASS Alarm classes
MSG_FILTER_STATE Alarm status
MSG_FILTER_AG_FROM AG number from
MSG_FILTER_AG_TO AG number to
MSG_FILTER_AGSUB_FROM AG sub-number from
MSG_FILTER_AGSUB_TO AG sub-number to

MSG_FILTER_TEXT Alarm texts

MSG_FILTER_PVALUE Process values
MSG_FILTER_COUNTER_FROM Internal alarm counter from
MSG_FILTER_COUNTER_TO Internal alarm counter to
MSG_FILTER_PROCESSMSG Process alarms (reserved)
MSG_FILTER_SYSMSG System alarms (reserved)
MSG_FILTER_BEDMSG Operator input alarms (reserved)
MSG_FILTER_VISIBLEONLY Display visible alarms (is not included in the filter
condition)
MSG_FILTER_HIDDENONLY Display hidden alarms (is not included in the filter
condition)
MSG_FILTER_NODYNAMIC No dynamic text selection (is not included in filter
condition)
MSG_FILTER_DATE Date from to
MSG_FILTER_TIME Time from to
MSG_FILTER_NR Alarm number from to
The individual filter conditions can be ORed.
st
st[0] Date and time of the start point, st[1] Date and time of the end point
You must assign st, if you use the filter criteria MSG_FILTER_DATE,
MSG_FILTER_DATE_FROM, MSG_FILTER_DATE_TO, MSG_FILTER_TIME,
MSG_FILTER_TIME_FROM, or MSG_FILTER_TIME_To.
dwMsgNrLow
dwMsgNrHigh
You must assign dwMsgNrLow and dwMsgNrHigh, if you use the MSG_FILTER_NR,
MSG_FILTER_NR_FROM, or MSG_FILTER_NR_TO filter criteria.
vMsgClasses
Alarm classes bit-coded.
0x0001 = class 1, 0x0002 = class 2, 0x0004 = class 3, ... 0x0040= class 7
0x0204 = classes 3 and 10
You must assign dwMsgClass and dwMsgType, if you use the filter criterion
MSG_FILTER_CLASS.
dwMsgState
Alarm status bit-coded.

Assign this field, if you use the filter criterion MSG_FILTER_STATE.

The following status values are checked using MSRTCheckWinFilter:

MSG_STATE_QUIT_SYSTEM Alarm acknowledged by system
MSG_STATE_QUIT_EMERGENCY Emergency acknowledgment
You must filter other status values yourself, e.g., MSG_STATE_HIDE or

MSG_STATE_UNHIDE, since these are not taken into consideration in the filter condition. To
filter these status values, use e.g. MSG_FILTER_HIDDENONLY.
wAGNr
wAGNr [0] First PLC number, wAGNr [1] last PLC number.
You must assign wAGNr, if you use the filter criteria MSG_FILTER_AG_FROM or
MSG_FILTER_AG_TO.
wAGSubNr
wAGSubNr [0] First PLC number, wAGSubNr [1] last PLC number.
You must assign wAGSubNr, if you use the filter criteria MSG_FILTER_AGSUB_FROM or
MSG_FILTER_AGSUB_TO.
dwArchivMode
ID for log or report. The parameter must be assigned 0.
szTB
Texts of the text blocks
You must assign szTB, if you use the filter criterion MSG_FILTER_TEXT.
dwTB
Active text blocks, bit coded
You must assign dwTB, if you use the filter criterion MSG_FILTER_TEXT
dPValue
Process values from - to
You must assign dPValue, if you use the filter criterion MSG_FILTER_PVALUE.
dwPValue
Process values, bit-coded
You must assign dwPValue, if you use the filter criterion MSG_FILTER_PVALUE.
ullMgCounter
Internal alarm counter

You must assign dwllMsgCounter, if you use the filter criterion MSG_FILTER_COUNTER_....
When used in the script, ullMsgCounter is not type ULONGLONG, but instead a union
MSGULONGLONG (see CCMsRtCliPlus.h).
dwQuickSelect
dwPriority
Priority of the alarm
szInstance
Instance name. If szInstance is not provided (empty string), a normal alarm is created.
Required files
CCMsRTCliPlus.h
API functions
MSRTCheckWinFilterPlus (Page 2444) Check alarm filter conditions

AUTOHOTSPOT List report data
MSRTGetFilterDataPlus (Page 2443) Query alarm filter conditions
MSRTSetMsgWinFilterPlus (Page 2447) Set alarm filter for an alarm window
MSRTGetLastMsgWithCommentPlus Query last archived alarm
(Page 2423)
MSRTStartMsgServicePlus (Page 2397) Start service
See also
MSRTGetLastMsgWithCommentPlus (Page 2423)
MSRTSetMsgWinFilterPlus (Page 2447)
MSRTStartMsgServicePlus (Page 2397)
MSRTSetMsgFilterPlus (Page 2446)
MSRTGetFilterDataPlus (Page 2443)

3.10.2.4 MSG_RTDATA_INSTANCE_STRUCT_PLUS (RT Professional)
Declaration
typedef struct {
DWORD dwMsgState;
DWORD dwMsgNrLow;
DWORD dwMsgNrHigh;
DWORD dwTimeDiff;
ULONGLONG ullCounter;
DWORD dwFlags;
WORD wPValueUsed;
MSG_TEXTVAL256_STRUCT_PLUS mtTextValue[MSG_MAX_PVALUE]
TCHAR szInstance[MSG_MAX_INSTANCE+1];
}
MSG_RTDATA_INSTANCE_STRUCT_PLUS;
Members
dwMsgState
The statuses listed will only be used internally by the system and can only by set by the API
using MSRTCreateMsgInstanceWithCommentPlus.

dwMsgNrLow
dwMsgNrHigh
stMsgTime
Date and time for coming-in or going-out of an alarm.

dwTimeDiff
Duration coming in or going out, telegram time in seconds.
ullCounter
Internal alarm counter.
dwFlags
Flags in compliance with the constants in the "m_global.h" file:

MSG_RT_FLAG_COME 0x00000001 Incoming alarm
MSG_RT_FLAG_GO 0x00000002 Outgoing alarm
MSG_RT_FLAG_QUIT_COME 0x00000004 Incoming acknowledgment
MSG_RT_FLAG_QUIT_GO 0x00000008 Outgoing acknowledgment
MSG_RT_FLAG_NOQUIT 0x00000010 No acknowledgment
MSG_RT_FLAG_QUIT_NOGO 0x00000020 TM II acknowledgment
MSG_RT_FLAG_FLASH 0x00000040 Flashing
MSG_RT_FLAG_FIRSTFLASH 0x00000080 Only first alarm is permitted to flash
MSG_RT_FLAG_DELETE 0x00010000 Alarm can be deleted
MSG_RT_FLAG_SUMTIME 0x00020000 Daylight saving time flag
MSG_RT_FLAG_SQUIT 0x00040000 Alarm has group acknowledgment
MSG_RT_FLAG_QUITNR 0x00080000 Alarm number acknowledgment
MSG_RT_FLAG_MSGLIST 0x00100000 Alarm from the alarm list
MSG_RT_FLAG_COMMENT 0x00200000 Alarm has comments
MSG_RT_FLAG_ARCHIV 0x00400000 Alarm is logged
MSG_RT_FLAG_PROTOCOL 0x00800000 Alarm is reported
MSG_RT_FLAG_INSTANCE 0x01000000 Flag for instance alarm
MSG_RT_FLAG_TIMEINVALID 0x02000000 Flag for invalid date/time stamp
MSG_RT_FLAG_LOCKGROUP 0x04000000 Flag for group lock
MSG_RT_FLAG_INSTANCE10 0x08000000 Bit for new instance alarm with process val‐
ue 10.
MSG_RT_FLAG_QUITCOUNTER 0x40000000 Bit for acknowledgment via counter
MSG_RT_FLAG_QUITGROUP 0x80000000 Bit for acknowledgment via counter
Flags for alarms in the log

MSG_FLAG_SUMTIME 0x00000001 Daylight saving time active
MSG_FLAG_COMMENT 0x00000002 Alarm has comments
MSG_FLAG_ARCHIV 0x00000004 Log
MSG_FLAG_PROTOCOL 0x00000008 Report
MSG_FLAG_TEXTVALUES 0x00000010 Alarm has associated text values
MSG_FLAG_TIMEINVALID 0x00000020 Bit for invalid date/time stamp
MSG_FLAG_INSTANCE 0x00000040 Identifier for instance alarms

Flags for alarms in the log

MSG_FLAG_INSTANCE10 0x08000000 Instance alarm with process value 10, avail‐
able from V5.0 SP2
MSG_FLAG_TEXTREF1 0x10000000 Text reference 1
MSG_FLAG_TEXTREF2 0x20000000 Text reference 2
With the MSRTCreateMsgInstanceWithCommentPlus function, flags cannot be sent to the

alarm server. Flags are ignored.
wPValueUsed
wTextValueUsed
Text values used, bit-coded.
because only number or text is technically possible as an associated value.
In the case of erroneous double entry the dPValue has priority.
dPValue
Process values.
mtTextValue
text values.
szInstance
Instance name. If szInstance is not provided (empty string), a normal alarm is created
Required files
CCMSRTCLIPlus.h
API functions

MSG_SERVICE_NOTIFY_PROC Send and receive service (callback)
See also
MSRTCreateMsgInstancePlus (Page 2412)


3.10.2.5 MSG_CLASS_STRUCT_PLUS (RT Professional)
Declaration
typedef struct {
WCHAR szName[MSG_MAX_TEXTLEN+1];
DWORD dwName;
DWORD dwClassID;
COLORREF crStateCome[2];
COLORREF crStateGo[2];
COLORREF crStateQuit[2];
WORD wQuitType;
WORD wHornQuit;
DWORD dwHornVar;
WCHAR szState[MSG_MAX_STATE][MSG_MAX_TEXTLEN+1];
DWORD dwState[MSG_MAX_STATE];
WCHAR szStateQuit[MSG_MAX_TEXTLEN+1];
DWORD dwStateQuit;
DWORD dwClassTyp;
DWORD dwCreatorID;
}
MSG_CLASS_STRUCT_PLUS;
Members
szName
The class name to be specified is dependent on the selected data language!
dwName
If the class name is included in the project texts, the ID can be specified here.
dwClassID
ID of the alarm class ( 1..18(MSG_MAX_CLASS) )
crStateCome
Color for the "incoming" status
crStateGo
Color for the "outgoing" status
crStateQuit
Color for the "acknowledged" status

wQuitType
The acknowledgment philosophy is defined by means of the following constants from the
"m_global.h" file:
MSG_QUIT_QUIT_COME Incoming acknowledgment

MSG_QUIT_QUIT_GO Outgoing acknowledgment
MSG_QUIT_NOQUIT No acknowledgment
MSG_QUIT_QUIT_NOGO Acknowledgment (without outgoing alarm)
MSG_QUIT_FLASH Flashing
MSG_QUIT_FIRSTFLASH Only first alarm is permitted to flash
MSG_QUIT_NOLIST Do not receive alarms in alarm list
You can logically combine the constants of the state machines bit-by-bit with "OR", provided
they are not mutually contradictory.
wHornQuit
Acknowledgment of central horn
dwHornVar
Tag of central horn
szState
Text for the "incoming", "outgoing", and "incoming and outgoing" statuses.
dwState
TextID
szStateQuit
Text for the "acknowledged" status.
dwStateQuit
TextID
dwClassTyp
dwCreatorID
CreatorID
Comment
In contrast to the MSG_CLASS_STRUCT_EX structure, MSG_CLASS_STRUCTPlus does not
have a creator identification.
Required files
CCMSRTCLIPlus.h

API functions
MSRTGetClassInfoPlus (Page 2419) Query alarm class information
See also
MSRTGetClassInfoPlus (Page 2419)
3.10.2.6 MSG_CSDATA_STRUCT_PLUS (RT Professional)
Declaration
typedef struct {
DWORD dwMsgNrLow;
DWORD dwMsgNrHigh;
DWORD dwStatus;
WORD wClass;
WORD wTyp;
DWORD dwTextID[MSG_MAX_TB];
DWORD dwQuitVar;
WORD wQuitBit;
DWORD dwStateVar;
WORD wStateBit;
DWORD dwMsgVar;
WORD wMsgBit;
WORD wAGNr;
WORD wAGSubNr;
DWORD dwGroupID;
DWORD dwPriority;
DWORD dwHidingMask;
}
MSG_CSDATA_STRUCT_PLUS;
Members
dwMsgNrLow
dwMsgNrHigh

dwStatus
The individual alarm parameters are defined by means of the following constants from the file
"m_global.h":
MSG_PARAMS_SQUIT Single acknowledgment

MSG_PARAMS_HORN Activates horn
MSG_PARAMS_ARCHIV Will be archived
MSG_PARAMS_PROTOCOL Will be logged
MSG_PARAMS_VARFLANK Will be created on negative edge
MSG_PARAMS_INFOTEXT Has Info text.
MSG_PARAMS_LOOPINALARM Has loop-in-alarm
MSG_PARAMS_NORMDLL Has normalization DLL
You can OR these constants, provided they do not contradict each other.
wClass
Alarm class
wTyp
Alarm type
dwTextID
Reference to the text blocks
dwQuitVar
Acknowledgment tag. Use dwID from DM_VARKEY (Page 1594).
wQuitBit
Bit of acknowledgment tag
dwStateVar
Alarm status as tag. Use dwID from DM_VARKEY (Page 1594)
wStateBit
wStateBit is used to specify which bits of dwStateVar define the alarm status.
If wStateBit = 1 and dwStateVar of data type "8 Bit unsigned", then Bit 1 of dwStateVar specifies
the incoming/outgoing status, and bit 5 specifies the need for acknowledgment.
If wStateBit = 2 and dwStateVar is a word tag, then Bit 2 of dwStateVar specifies the incoming/
outgoing status, and bit 10 specifies the need for acknowledgment.
dwMsgVar
Alarm tag. Use dwID from DM_VARKEY (Page 1594).
wMsgBit
Alarm tag bit

wAGNr
PLC number
wAGSubNr
PLC sub-number
dwGroupID
ID for the alarm group (internal)
dwPriority
Priority of the alarm
dwHidingMask
Display suppression mask
Comment
By means of this structure, your application can use API functions to determine the
configuration data of a single message.
Required files
CCMSRTCLIPlus.h
API functions
MSRTGetMsgCSDataPlus (Page 2426) Query alarm configuration data
See also
MSRTGetMsgCSDataPlus (Page 2426)

3.10.2.7 MSG_RTGROUPENUM_STRUCT_PLUS (RT Professional)
Declaration
typedef struct {
BOOL fIDUsed;
DWORD dwID;
TCHAR szName[MSG_MAX_TEXTLEN+1];
DWORD dwMsgCount;
DWORD dwMsg[MSG_MAX_GROUPITEMS];
}
MSG_RTGROUPENUM_STRUCT_PLUS;
Members
fIDUsed
Specifies whether the Group ID (fIDUsed = TRUE) or name (fIDUsed = FALSE) is used to
specify the alarm group.
dwID
Group ID
szName
Group name
dwMsgCount
Number of single alarms in dwMsg
dwMsg
Locked single alarms
Required files
CCMSRTCLIPlus.h
API functions
MSRTEnumGroupMsgPlus (Page 2438) List alarm group single alarms

(Page 2403)

See also
MSRTEnumGroupMsgPlus (Page 2438)
3.10.2.8 MSG_RTGROUPSET_STRUCT_PLUS (RT Professional)
Declaration
typedef struct {
BOOL fIDUsed;
DWORD dwID;
SYSTEMTIME stTime;
DWORD dwData;
}
MSG_RTGROUPSET_STRUCT_PLUS;
Members
fIDUsed
Specifies whether the Group ID (fIDUsed = TRUE) or name (fIDUsed = FALSE) is used to
specify the alarm group.
dwID
Group ID (for alarm classes, alarm types)
szName
Group name
stTime
Time of occurrence
dwData
If the structure is used within the scope of MSRTLockGroupPlus, dwData = 1 signifies locking
and dwData = 0 releasing
Required files
CCMSRTCLIPlus.h

API functions
MSRTLockGroupPlus (Page 2440) Lock alarm group

MSRTEnumGroupMsgPlus (Page 2438) List single alarms of an alarm group
MSRTQuitGroupPlus (Page 2441) Acknowledge alarm group
See also
MSRTQuitGroupPlus (Page 2441)
3.10.2.9 MSG_COMMENT_INSTANCE_STRUCT_PLUS (RT Professional)
Declaration
typedef struct {
SYSTEMTIME stTime;
DWORD dwMsgNrLow;
DWORD dwMsgNrHigh;
WCHAR szText[MSG_MAX_TB_CONTENT+1];
WCHAR szUser[MSG_MAX_USERNAME+1];
WCHAR szComputerName[MAX_COMPUTERNAME_LENGTH+1];
WCHAR szApplicationName[MSG_MAX_APPLNAME+1];
}
MSG_COMMENT_INSTANCE_STRUCT_PLUS;
Members
stTime
Date/time
dwMsgNrLow
dwMsgNrHigh
szText
Comment
szUser
User name

szComputerName
Computer name
szApplicationName
Application name
szInstance
Instance name
Comment
If a current time is needed for the passing of a SYSTEMTIME parameter, the GetLocalTime
Required files
CCMSRTCLIPlus.h
API functions
MSRTGetCommentInstancePlus (Page 2450) Query comment text

MSRTSetCommentInstancePlus (Page 2452) Specify comment text
See also
MSRTSetCommentInstancePlus (Page 2452)
MSRTGetCommentInstancePlus (Page 2450)
3.10.2.10 MSG_INFOTEXT_STRUCT_PLUS (RT Professional)
Declaration
typedef struct {
DWORD dwMsgNrLow;
DWORD dwMsgNrHigh;
WCHAR szText[MSG_MAX_TB_CONTENT+1];
}
MSG_INFOTEXT_STRUCT_PLUS;

Members
dwMsgNrLow
dwMsgNrHigh
szText
Info text
Required files
CCMSRTCLIPlus.h
API functions
MSRTGetInfotextPlus (Page 2454) Query info text

MSRTSetInfotextPlus (Page 2455) Specify info text
See also
MSRTGetInfotextPlus (Page 2454)
MSRTSetInfotextPlus (Page 2455)
3.10.2.11 MSG_BACKUP_STRUCT_PLUS (RT Professional)
Declaration
typedef struct {
SYSTEMTIME stFrom;
SYSTEMTIME stTo;
WCHAR szArchivFile[MAX_PATH+1];
WCHAR szArchivTextFile[MAX_PATH+1];
WCHAR szCommentFile[MAX_PATH+1];
WCHAR szInstanceFile[MAX_PATH+1];
WCHAR szComment[MAX_PATH+1];
DWORD dwFlags;
DWORD dwFormat;
}
MSG_BACKUP_STRUCTPlus;

Members
stFrom
Date from
stTo
Date to
szArchivFile
File name and path of the export file for log
szArchivTextFile
File name and path of the export file for log texts
szCommentFile
File name and path of the export file for comments
szInstanceFile
File name and path of the export file for instances
szComment
User-defined comments
dwFlags
MSG_DB_FLAGS_OVERWRITE 0x0001 Overwrite existing data records

MSG_DB_FLAGS_ADD 0x0002 Add only
MSG_DB_FLAGS_DELETE 0x0004 Delete source data records
dwFormat
You can use the following constants from the "m_global.h" file for formatting the export file:
MSG_DB_FMT_CSV CSV file format

MSG_DB_FMT_DBASE3 DBASE3 file format
MSG_DB_FMT_WATCOM Sybase format
Comment
Required files
CCMSRTCLIPlus.h

API functions
MSRTEnumBackupListPlus (Page 2457) List entries of an export file

MSRTGetBackupSize Determine size of export file
MSRTRestore Import alarms
See also
MSRTEnumBackupListPlus (Page 2457)
MSRTExportPlus (Page 2458)
3.10.2.12 MSG_RTLOCK_STRUCT_PLUS (RT Professional)
Declaration
typedef struct {
WCHAR szParent[MSG_MAX_TEXTLEN+1];
DWORD dwLockID;
BOOL fLock;
DWORD dwMsgNum;
DWORD dwMsgLock[MSG_MAX_LOCKITEMS];
}
MSG_RTLOCK_STRUCT_PLUS;
Members
szName
Lock name
szParent
Parent group
dwLockID
Lock ID
fLock
Lock and release
dwMsgNum
Number of locked alarms
dwMsgLock
Locked single alarms

Required files
CCMSRTCLIPlus.h
API functions

(Page 2403)
See also
3.10.2.13 MSG_TEXTVAL256_STRUCT_PLUS (RT Professional)
Declaration
typedef struct {
WCHAR szText[MSG_MAX_TEXTVAL256+1];
}
MSG_TEXTVAL256_STRUCT_PLUS;
Comment
The structure is used within the following structures:
Members
szText
Text
Required files
CCMSRTCLIPlus.h

API functions

(Page 2410)
MSRTGetLastMsgWithCommentPlus Query last pending alarm
(Page 2423)
MSG_SERVICE_NOTIFY_PROC_PLUS Send and receive service (callback)
(Page 2403)
See also
MSG_RTDATA_INSTANCE_STRUCT_PLUS (Page 2378)
MSG_RTDATA_INSTANCECOMMENT_STRUCT_PLUS (Page 2370)
MSG_RTCREATE_STRUCT_PLUS (Page 2368)
3.10.2.14 MSGULONGLONG (RT Professional)
Declaration
typedef union tagMSGULONGLONG {

#ifndef _CISS_
struct
{
DWORD dwLow;
DWORD dwHigh;
};
#endif
struct
{
DWORD dwLow;
DWORD dwHigh;
} dwdw;
#ifndef _CISS_
ULONGLONG ull;
Currency cy; //for COLEVariant transfers
#endif
}MSGULONGLONG;
Members
dwLow, dwHigh
The two parameters provide the 64-bit alarm number.

Required files
CCMSRTCLIPlus.h
API functions
MSRTGetMsgCSDataPlus (Page 2426) Query the configuration data for an alarm
See also
3.10.3.1 MSRTEnumArchivDataPlus (RT Professional)
Description
Enumerates all alarms in the specified log. Its callback function
MSG_SERVICE_NOTIFY_PROC_PLUS is called using the MSG_NOTIFY_ARCHIVENUM
notification type. lpbyData refers to data of the
MSG_RTDATA_INSTANCECOMMENT_STRUCT_PLUS structure.
Enumeration functions work asynchronously. As a result, you must synchronize the calls using
semaphores.
Declaration
BOOL MSRTEnumArchivDataPlus(
DWORD dwServiceID,
BOOL fArchiv,
DWORD dwMaxRecords
DWORD dwParams
LPDWORD lpdwTAID
Parameters
dwServiceID
Identification number of the send and receive service, as returned when
MSRTStartMsgServicePlus is called.

fArchiv
Designates the log type.
TRUE Sequential log
FALSE Circular log
dwMaxRecords
Maximum number of the data records to be listed. If the dwMaxRecords is exceeded numbering
will stop. If dwMaxRecords = 0xFFFFFFFF, all alarms will be listed.
dwParams
Parameters for the sort order:
MSG_ARCHIV_ENUM_DESC Sort in descending order
lpdwTAID
Pointer to TransactionID for asynchronous processing.
lpError
Pointer to the data of the extended error message in the CMN_ERRORW structure. When an
Return value
TRUE
Alarms listed.
FALSE
Error
Error messages
MSG_ERR_API_PARAM Parameter invalid
Required files
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll

Related functions

(Page 2403)
See also
3.10.3.2 MSRTStartMsgServicePlus (RT Professional)
Description
Starts a service for sending and receiving of notifications in the alarm system.
Declaration
BOOL MSRTStartMsgServicePlus (
LPDWORD lpdwServiceID,
LPCWSTR lpszServer,
DWORD dwFlags,
DWORD dwFilterCount
LPMSG_FILTER_STRUCT_PLUS* lppMsgFilterPlus,
DWORD dwNotifyMask,
MSG_SERVICE_NOTIFY_PROC_PLUS lpfnNotifyProcPlus
LPVOID lpvUserNotify,
MSG_TAID_COMPLETION_PROC_PLUS lpfnTAIDProcPlus
LPVOID lpvUserTAID
LPCMN_ERRORW lpError );
Parameters
lpdwServiceID
Contains the identification number of the send and receive service for a function, once it has
been successfully called; this service is required by many functions.
lpszServer
Server prefix without ::
If an empty string or NULL is input the default server set will be used.
dwFlags

dwFilterCount
Number of message filters in the pointer list lppMsgFilterPlus If 0 is specified here, no message
filter from lppMsgFilterPlus are applied.
lppMsgFilter
Pointer to your list of points to message filter structuresMSG_FILTER_STRUCT_PLUS
(Page 2374).
The list must contain at least as many entries as specified in dwFilterCount. If dwFilterCount
is equal to 0, lppMsgFilterPlus should be set to ZERO.
dwNotifyMask
Designates the kind of notification, in accordance with the definition of constants in the
"msrtapi.h" file:
MSG_NOTIFY_MASK_MSGLIST Notification regarding alarm

MSG_NOTIFY_MASK_LOCK Notification regarding locks
MSG_NOTIFY_MASK_ARCHIV Notification regarding logged alarms
MSG_NOTIFY_MASK_ALL All kinds of notifications
lpfnNotifyProcPlus
Pointer to MSG_SERVICE_NOTIFY_PROCPlus type callback function for passing the
notification by the service.
With lpfnNotifyProcPlus = NULL the service will not return any notifications.
Note
lpvUserNotify
lpfnTAIDProcPlus
Callback function for asynchronous processing of feedback.
lpvUserTAID
lpError

Return value
TRUE
Service started.
FALSE
Error
Comment
Your application can install a maximum of 16 services. In total up to 128 services can be
installed.
Error messages
MSG_ERR_RT_NOTCONNECTED Connection to the alarm system not made

MSG_ERR_RT_NOINIT Alarm system not initialized
MSG_ERR_RT_SERVICEMAX Maximum number of services reached
MSG_ERR_NOSERVER No default server specified and no local server
available
Required files
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
Related functions
MSRTStopMsgServicePlus (Page 2400) Stop services

(Page 2403)
See also
MSRTExportPlus (Page 2458)
MSRTGetInfotextPlus (Page 2454)
MSRTSetInfotextPlus (Page 2455)
MSRTGetClassInfoPlus (Page 2419)

MSG_FILTER_STRUCT_PLUS (Page 2374)

MSRTGetMsgPriorityPlus (Page 2429)
MSRTGetMsgQuitPlus (Page 2430)
MSRTGetMsgTextPlus (Page 2432)
MSRTGetSelectedMsgPlus (Page 2433)
MSRTResetMsgPlus (Page 2435)
MSRTLoopInAlarmPlus (Page 2437)
MSRTEnumArchivDataPlus (Page 2395)
MSRTStopMsgServicePlus (Page 2400)
MSRTQuitHornPlus (Page 2402)
MSRTGetCommentInstancePlus (Page 2450)
MSRTGetMsgActualPlus (Page 2425)
3.10.3.3 MSRTStopMsgServicePlus (RT Professional)
Description
Stops the service for sending and receiving messages
Declaration
BOOL MSRTStopMsgServicePlus (
DWORD dwServiceID,
Parameters
dwServiceID

lpError
Return value
TRUE
Service ended.
FALSE
Error
Comment
Note
The call should not be used in an application destructor (EXE, DLL, OCX, etc.), because a
Microsoft-specific mechanism can sometimes lead to a call hang and therefore a program hang
too.
Error messages
MSG_ERR_RT_NOTCONNECTED Connection to the alarm system not made

Required files
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
Related functions
See also

3.10.3.4 MSRTQuitHornPlus (RT Professional)
Description
Class-specific central horn acknowledgement.
Declaration
BOOL MSRTQuitHornPlus(
DWORD dwServiceID,
LPDWORD lpdwTAID,
Parameters
dwServiceID
lpdwTAID
Pointer to the TransactionID for asynchronous processing.
lpError
Return value
TRUE
Alarm acknowledged.
FALSE
Error
Error messages
Required files
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib

CCMSRTCLIPlus.dll
Related functions
See also
3.10.3.5 MSG_SERVICE_NOTIFY_PROC_PLUS (RT Professional)
Description
Your callback function for enumeration functions. The enumeration functions work
asynchronously. As a result, you must synchronize the calls using semaphores.
Declaration
BOOL ( * MSG_SERVICE_NOTIFY_PROC) (
DWORD dwNotify,
LPBYTE lpbyData,
DWORD dwItems,
LPVOID lpvUserNotify);
Parameters
dwNotify
The notification type is specified by the constants in the "MSRTAPI.h" file:
General notifications lpbyData points to structure

MSG_NOTIFY_CON‐ Connection established -
NECT
MSG_NOTIFY_DIS‐ Connection terminated -
CONNECT
MSG_NOTIFY_RE‐ New alarm system runtime data -
START
MSG_NOTIFY_SHUT‐ The alarm system will be stopped -
DOWN
MSG_NOTI‐ Enumeration of the alarm list MSG_RTDATA_INSTANCE_STRUCT_PLUS (in
FY_MSGENUM blocks)
MSG_NOTIFY_AR‐ Enumeration of log alarm(s) MSG_RTDATA_INSTANCE_STRUCT_PLUS (in
CHIVENUM blocks)

General notifications lpbyData points to structure

MSG_NOTIFY_AR‐ Enumeration of log alarm(s) with instances MSG_RTDATA_INSTANCE_STRUCT_PLUS (in
CHIVENUMINST blocks)
MSG_NOTIFY_LOCK‐ Enumeration of locks MSG_RTGROUPENUM_STRUCT_PLUS (in blocks)
ENUM
MSG_NOTIFY_WINE‐ Alarm windows enumeration MSG_WIN_STRUCT_PLUS (in blocks)
NUM
MSG_NOTIFY_BACK‐ Enumeration of export list MSG_BACKUP_STRUCT_PLUS (in blocks)
UPENUM
MSG_NOTIFY_ARC‐ Enumeration of day list MSG_ARCHIVDAY_STRUCT_PLUS
DAYENUM
MSG_NOTI‐ Enumeration was stopped at maximum -
FY_ENUMMAX amount
MSG_NOTIFY_LAN‐ Language switched -
GUAGESET
Single alarms lpbyData points to structure

MSG_NOTI‐ New alarm added MSG_RTDATA_INSTANCE_STRUCT_PLUS (in
FY_MSGADD blocks)
MSG_NOTI‐ Alarm deleted MSG_RTDATA_INSTANCE_STRUCT_PLUS (in
FY_MSGDELETE blocks)
MSG_NOTI‐ Alarm changed MSG_RTDATA_INSTANCE_STRUCT_PLUS (in
FY_MSGMODIFY blocks)
MSG_NOTI‐ Current number of alarms MSG_RTDATA_INSTANCE_STRUCT_PLUS (in
FY_MSGCOUNT blocks)
Alarm groups lpbyData points to structure

MSG_NOTI‐ Enumeration of single alarms in an alarm MSG_RTGROUPENUM_STRUCT_PLUS (in blocks)
FY_GROUPENUM group
Locks of alarms lpbyData points to structure

MSG_NOTIFY_LOCK‐ Locks set, changed, deleted MSG_RTGROUPENUM_STRUCT_PLUS (in blocks)
MODIFY
Log alarms lpbyData points to structure

MSG_NOTIFY_AR‐ Log alarm(s) added MSG_RTDATA_INSTANCE_STRUCT_PLUS (in
CHIVADD blocks)
MSG_NOTIFY_AR‐ Log alarm(s) deleted MSG_RTDATA_INSTANCE_STRUCT_PLUS (in
CHIVDELETE blocks)

lpbyData
lpbyData contains a pointer to data depending on the notification type.
General notifications No data

Single alarms Runtime data, stored in structures of type
● MSG_RTDATA_INSTANCE_STRUCT_PLUS (Page 2378)
Alarm groups Single alarm data in structures of type
● MSG_RTGROUPENUM_STRUCT_PLUS (Page 2386)
Locks Lock data in structures of type
● MSG_RTLOCK_STRUCT_PLUS (Page 2392)
Log alarms Log data in structures of type
● MSG_RTDATA_INSTANCE_STRUCT_PLUS (Page 2378)
dwItems
Contains the number of objects returned in lpbyData. If dwItems = 0, then lpbyData = NULL.
Notify will be ended and the semaphore will be released.
lpvUserNotify
function.
Return value
TRUE
Notification was recognized and processed.
FALSE
Error
Comment
Note
If a callback function is programmed as a project function in script, then the asynchronous call
also has the result that the function is not fully available in the script context, and in particular

the GetTag...- and SetTag-calls will not work. Where appropriate, processing must be
performed in other actions, that are only triggered by the callback.
Required files
CCMSRTCLIPlus.h
Related functions
See also
MSG_RTGROUPENUM_STRUCT_PLUS (Page 2386)
MSG_RTLOCK_STRUCT_PLUS (Page 2392)
3.10.3.6 MSRTWebClientPlus (RT Professional)
Description
Initializes the DLL for a WebClient
Declaration
VOID WINAPI MSRTWebClientPlus(

LPCWSTR pszProjectPath,
DWORD dwDataLocale);
Parameters
pszProjectPath
Path to the Web Project

dwDataLocale
Local ID of the language used
Return value
This function has no return value.
3.10.4 Functions for protocol processing (RT Professional)
3.10.4.1 MSRTActivateMProtPlus (RT Professional)
Description
Pause or continue report service for output of an alarm sequence report.
Declaration
BOOL MSRTActivateMProtPlus(
BOOL fActive,
Parameters
fActive
Establishes how the report service should be handled:
TRUE Continue report service

FALSE Pause report service
lpError
Return value
TRUE
FALSE
Error

Error messages
MSG_ERR_PROT_ACTIVE Report service already active
Required files
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
3.10.4.2 MSRTPrintMProtPlus (RT Professional)
Description
Prints currently pending alarms of the alarm sequence report, even when a page is not yet full.
Declaration
BOOL MSRTPrintMProtPlus(
DWORD* pdwLines,
Parameters
pdwLines
Pointer to the row number Here the number of rows printed is returned. Thus the parameter
should be preassigned with NULL before the call.
lpError
Return value
TRUE
Current pending alarms printed.
FALSE
Error

Error messages
MSG_ERR_NOPROT Alarm sequence report inactive
Required files
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
3.10.5 Functions for alarm processing (RT Professional)
3.10.5.1 MSRTEnumArchivInstancePlus (RT Professional)
Description
Enumerates all alarms in the specified log with instance name. The
MSG_RTDATA_INSTANCECOMMENT_STRUCT_PLUS structure is returned.
Declaration
BOOL WINAPI MSRTEnumArchivInstancePlus(

DWORD dwServiceID,
BOOL fArchiv,
DWORD dwMaxRecords,
DWORD dwParams,
LPDWORD lpdwTAID,
Parameters
dwServiceID
ID of the installed service
fArchiv
Circular or sequential log
dwMaxRecords
Maximum number of records for enumeration\n. Enumeration is aborted when the maximum
number is exceeded.
dwParams
Supplementary parameter, MSG_ENUM_ARCHIV_DESC = Sort in descending order

lpdwTAID
Pointer to the TransactionID for asynchronous processing feedback
lpError
Pointer to the extended error structure
Return value
TRUE
Function successful
FALSE
Error
3.10.5.2 MSRTCreateMsgInstanceWithCommentPlus (RT Professional)
Description
Generates an alarm with the specified alarm number with instance name and comment. In
contrast to most other Create calls, the text associated values may contain up to 256 characters
(255 + EndOfString). The alarm is included in the current alarm list with the specified data.
Declaration
BOOL WINAPI MSRTCreateMsgInstanceWithCommentPlus(

DWORD dwServiceID,
LPMSG_RTDATA_INSTANCECOMMENT_STRUCT_PLUS lpMsgCreatePlus,
LPDWORD lpdwTAID,
Parameters
dwServiceID
ID of the Service - service
lpMsgCreatePlus
Pointer to Createstruct to create the alarm
Use different time stamps for different messages.
lpdwTAID
Pointer to the TransactionID of asynchronous processing feedback
lpError
Pointer that includes the extended error message

Return value
TRUE
Function successful
FALSE
Error
Comment
The Create functions work asynchronously. As a result, you may have to synchronize the calls
using semaphores.
If the call is used to acknowledge an alarm, the specified time must be the incoming alarm
time stated to the closest millisecond.
WARNING
Your application can use this function to acknowledge alarms, without ensuring that the
equipment operator has been made aware of the alarms. This circumstance can result in
danger to life and limb or property!
Error messages
MSG_ERR_API_PARAM Invalid parameter

MSG_ERR_API_SERVICE dwServiceID invalid
Required files
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
Related functions
MSRTCreateMsgInstancePlus (Page 2412) Create instance alarm

See also


3.10.5.3 MSRTCreateMsgInstancePlus (RT Professional)
Description
Creates an alarm with the stated alarm number. The alarm is included in the current alarm list
with the specified data.
Declaration
BOOL WINAPI MSRTCreateMsgInstancePlus (

DWORD dwServiceID,
LPMSG_RTDATA_INSTANCE_STRUCT_PLUS lpMsgCreatePlus,
LPDWORD lpdwTAID,
Parameters
dwServiceID
lpMsgCreatePlus
lpdwTAID
lpError
Return value
TRUE
Function successful
FALSE
Error

Comment
using semaphores.
If the call is used to acknowledge an alarm, the specified time must be the incoming alarm
time stated to the closest millisecond.
WARNING
Error messages

Required files
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
Related functions
MSRTCreateMsgInstanceWithCommentPlus Create instance alarm with comments

(Page 2410)
See also

3.10.5.4 MSRTDialogMsgLockPlus (RT Professional)
Description
Dialog for locking and releasing alarms.
The following options are available:

● Locks on individual alarms
● Locks on alarm classes of alarm groups
● Locks on alarms using the alarm number
Note
Locked alarm:
Locked alarms are neither entered in the alarm lists, logged, nor reported!
Locked alarms send back their acknowledgement signal upon occurrence!
Locked alarms are automatically released when WinCC Runtime restarts. Only alarms that
are locked directly in the AS by means of data blocks will continue to be locked (locking at
source).
Locked alarm classes/alarm groups:
The locks on alarm classes and alarm groups is not affected by a restart of WinCC Runtime.
Declaration
BOOL MSRTDialogMsgLockPlus(
HWND hwndParent,

Parameters
hwndParent
Parent window, that contains the dialog.
lpError
Return value
TRUE
Dialog successfully closed.
FALSE
Error or the dialog was canceled.
Error messages
Required files
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
3.10.5.5 MSRTCreateMsgPlus (RT Professional)
Description
Creates an alarm with the stated alarm number. The alarm is included in the current alarm list
with the specified data.
Declaration
BOOL WINAPI MSRTCreateMsgPlus(

DWORD dwServiceID,
LPMSG_RTCREATE_STRUCT_PLUS lpMsgCreatePlus,
LPDWORD lpdwTAID,

Parameters
dwServiceID
lpMsgCreatePlus
IpdwTAID
Pointer to the TransactionID for asynchronous processing
lpError
Return value
TRUE
Function successful
FALSE
Error
Comment
using semaphores.
WARNING
Error messages

Required files
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib

CCMSRTCLIPlus.dll
Related functions
MSRTCreateMsgInstanceWithCommentPlus Create instance alarm

(Page 2410)
MSRTCreateMsgInstancePlus (Page 2412) Create instance alarm with comments
See also
3.10.5.6 MSRTEnumLockedMsgPlus (RT Professional)
Description
Enumerates all the locked alarms.
semaphores.
Declaration
BOOL WINAPI MSRTEnumLockedMsgPlus(

DWORD dwServiceID,
LPDWORD lpdwTAID,
LPCMN_ERRORW lpError);
Parameters
dwServiceID
lpdwTAID
Pointer to the TransactionID for asynchronous processing
lpError
Pointer to the data of the extended error message in the CMN_ERROR structure.

Return value
TRUE
Alarms enumerated
FALSE
Error.
3.10.5.7 MSRTEnumMsgRTDataPlus (RT Professional)
Description
Enumerates all alarms that are present in the current alarm list. Its callback function
MSG_SERVICE_NOTIFY_PROCPlus callback function is called with notification type
MSG_NOTIFY_MSGENUM, enumeration of alarms. lpbyData refers to data of the
MSG_RTDATA_STRUCTPlus structure.
semaphores.
Declaration
BOOL MSRTEnumMsgRTData(
DWORD dwServiceID,
LPDWORD pdwTAID
Parameters
dwServiceID
lpdwTAID
lpError
Return value
TRUE
Alarms enumerated

FALSE
Error.
Error messages

Required files
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
Related functions
See also
3.10.5.8 MSRTGetClassInfoPlus (RT Professional)
Description
Get information about an alarm class.
Declaration
BOOL WINAPI MSRTGetClassInfoPlus(

DWORD dwServiceID,
LPCWSTR lpszServer,
DWORD dwMsgNrLow,
DWORD dwMsgNrHigh,
LPMSG_CLASS_STRUCT_PLUS lpClassPlus,
Parameters
dwServiceID
ID of the Service - service whose server is to be connected

lpszServer
dwMsgNrLow
Alarm number of the lower DWORD
dwMsgNrHigh
Alarm number of the upper DWORD WinCC
lpClassPlus
Pointer that includes the information
lpError
Return value
TRUE
Function successful
FALSE
Error
Comment
The MSRTGetClassInfoPlus function can also be called up without
MSRTStartMsgServicePlus. These calls are however significantly slower. You can improve
performance by performing a MSRTStartMsgServicePlus beforehand and retaining it for all
calls. In this case only the first call of MSRTGetClassInfoPlus is slowed.
Error messages
MSG_ERR_RT_NOINIT Alarm Logging RT is not initialized

MSG_ERR_MSG_NOEXIST Alarm does not exist
Required files
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll

Related functions
See also
MSG_CLASS_STRUCT_PLUS (Page 2381)
3.10.5.9 MSRTGetMsgAttributesPlus (RT Professional)
Description
Retrieves the attributes of the last message from single messages, lock list, archive, hit list, or
hide list on the basis of the filter condition, instance name and NotifyMask.
Declaration
BOOL WINAPI MSRTGetMsgAttributesPlus(

LPCWSTR lpszServer,
LPCWSTR lpszInstance,
LPMSG_FILTER_STRUCT_PLUS* lppFilter,
DWORD dwFilterCount,
DWORD dwNotifyMask,
LPDWORD lpdwAttributeList,
DWORD dwAttributeListCount,
VARIANT* lpvAttributeValues,
Parameters
lpszServer
If an empty string or NULL is input, the set default server will be used.
lpszInstance
Instance name. An empty string or also NULL will be added for the filter condition.
lppFilter
Pointer to a pointer list of structures MSG_FILTER_STRUCT_PLUS for transferring filter
conditions.
Because this function always allows only one alarm to be queried, dwMsgNrLow and
dwMsgNrHigh must contain the number of the alarm to be queried.

dwFilterCount
Number of specified filter structures via lppFilter. At least one filter structure must be specified.
dwNotifyMask
The information as to which type of message the message belongs to is defined by means of
the following constants from the file "msrtapi.h" via "CCMsRtCliPlus.h":
MSG_NOTIFY_MASK_MSGLIST Single message notification

MSG_NOTIFY_MASK_LOCK Lock message
MSG_NOTIFY_MASK_ARCHIV Archive message
MSG_NOTIFY_MASK_HITLIST from hit list
MSG_NOTIFY_MASK_HIDE
MSG_TIMESTAMP_LOCAL Time specifications in filter and return are local
MSG_TIMESTAMP_UTC Time specifications in filter and return are UTC
Only a specification MSG_NOTIFY_MASK_xxx which can be linked with a

MSG_TIMESTAMP_xxx via an OR function can be used.
lpdwAttributeList
Pointer to a DWORD array of the variable dwAttributeListCount, in which the attributes of the
message to be queried must be specified. At least one attribute must be specified.
Possible attributes are specified using the constants MSG_ATTR_xxx in the "msrtapi.h" file
via "CCMsRtCliPlus.h".
dwAttributeListCount
Specifies how many attributes are specified in the list lpdwAttributeList. At least one attribute
must be specified.
lpvAttributeValues
Pointer to a VARIANT which must be initialized with VT_EMPTY. A one-dimensional
(VT_ARRAY|VT_VARIANT) for the requested attributes is returned here.
The first values are always assigned message numbers (index (0), time stamp (index 1), status
(index 2) and instance (index 3). The requested attributes are stored from index 4 in the array.
You can find more information in the offset definition STARTINDEX_MSG_ATTR in
"m_global.h".
If the VARIANT remains empty without the function reporting an error, no hits would be found
via the filter condition.
lpError
Return value
TRUE
Message data queried.

FALSE
Error.
Error messages

MSG_ERR_RT_NOTCONNECTED Connection not made
Required files
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
Related functions
MSRTGetLastMsgWithCommentPlus Query last alarm

(Page 2423)
See also
3.10.5.10 MSRTGetLastMsgWithCommentPlus (RT Professional)
Description
Retrieves the last alarm from a log based on filter conditions and an instance name.
Declaration
BOOL WINAPI MSRTGetLastMsgWithCommentPlus(

LPCWSTR lpszServer,
LPCWSTR lpszInstance,
LPMSG_FILTER_STRUCT_PLUS* lppFilter,
LPMSG_RTDATA_INSTANCECOMMENT_STRUCT_PLUS lpMsg,
Parameters
lpszServer
Server prefix without '::'. If an empty string or NULL is input the default server set will be used.

lpszInstance
Instance name. An empty string or also NULL will be added for the filter condition.
lppFilter
Pointer to a pointer list of structures MSG_FILTER_STRUCT_PLUS for transferring filter
conditions.
dwFilterCount
Number of specified filter structures via lppFilter. At least one filter structure must be specified.
lpMsg
Returns the message data.
lpError
Return value
TRUE
Alarm queried.
FALSE
Error.
Error messages

MSG_ERR_RT_NOTCONNECTED Connection not made
Required files
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
Related functions
MSRTGetMsgAttributesPlus (Page 2421) Querying the attributes of a message

See also
3.10.5.11 MSRTGetMsgActualPlus (RT Professional)
Description
The function states the number of currently pending alarms in the alarm list.
Declaration
BOOL MSRTGetMsgActualPlus (
LPDWORD lpdwCount,
Parameters
lpdwCount
Pointer to a buffer in which the number of currently pending alarms is stored.
lpError
Return value
TRUE
Number stated.
FALSE
Error
Comment
The MSRTGetMsgActualPlus function can also be called up without
calls. In this case only the first call of MSRTGetMsgActualPlus is slowed.

Error messages
Required files
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
Related functions
See also
3.10.5.12 MSRTGetMsgCSDataPlus (RT Professional)
Description
Query the configured data for an alarm.
Declaration
BOOL MSRTGetMsgCSDataPlus (
DWORD dwServiceNr,
LPCWSTR lpszServer,
DWORD dwMsgNrLow,
DWORD dwMsgNrHigh,
LPMSG_CSDATA_STRUCT_PLUS lpmCSDataPlus,
Parameters
dwServiceID
lpszServer

dwMsgNrLow
Number of the first alarm
dwMsgNrHigh
Number of the last alarm
lpmCSDataPlus
Pointer to the configuration data (alarm class, type of alarm, text block index, etc.) for this alarm
in the MSG_CSDATA_STRUCT_PLUS (Page 2383) structure.
lpError
Return value
TRUE
Configuration data queried.
FALSE
Error
Comment
The MSRTGetMsgCSDataPlus function can also be called up without
MSRTStartMsgServicePLus. These calls are however significantly slower. You can improve
calls. In this case only the first call of MSRTGetMsgCSDataPlus is slowed.
Error messages

Required files
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll

Example
The example shows the embedding of the function call in a C function.
#include "GlobalDefinitions.h"
void OnClick(char* screenName, char* objectName, char* propertyName)
{
//add your Code hiere
#pragma code("CCMSRTCLIPlus.dll")
#include "CCMSRTCLIPlus.dll"
#pragma code()
BOOL ret = FALSE;
CMN_ERRORW error;
// DWORD dwMsgNrU;
// DWORD dwMsgNrO;
int i;
WCHAR lpszMsgText[255];
DWORD lpdwCount = 255;
MSG_CSDATA_STRUCT_PLUS msgCSData;
MSGULONGLONG msgID;
msgID.dwdw.dwLow = 1;
msgID.dwdw.dwHigh = 0;
memset( &msgCSData, 0, sizeof( msgCSData ));
// dwMsgNrU = 1;
// dwMsgNrO = 0;
ret = MSRTGetMsgCSDataPlus(0L, NULL, msgID.dwdw.dwLow, msgID.dwdw.dwHigh,
&msgCSData, &Error );
if(TRUE==ret)
{
for (i = 0; i < (sizeof(msgCSData.dwTextID)/sizeof(DWORD)); i++){
printf("TextID[%d] = %d,\r\n",i, msgCSData.dwTextID[i]);
}
}
else
{
printf("Error = %ls\r\t", Error.szErrorText);
}
}
Related functions
See also
MSG_CSDATA_STRUCT_PLUS (Page 2383)
MSGULONGLONG (Page 2394)

3.10.5.13 MSRTGetMsgPriorityPlus (RT Professional)
Description
Query the priority of the given alarm.
Declaration
BOOL MSRTGetMsgPriorityPlus (
DWORD dwServiceID,
LPCWSTR lpszServer,
DWORD dwMsgNrLow,
DWORD dwMsgNrHigh,
long* plPriority,
Parameters
dwServiceID
MSRTStartMsgService is called.
lpszServer
dwMsgNrLow
dwMsgNrHigh
plPriority
Pointer to a tag of the long data type, in which the priority is stored.
This parameter must not be NULL!
lpError
Return value
TRUE
Priority queried.

FALSE
Error
Comment
The MSRTGetMsgPriorityPlus function can also be called up without
calls. In this case only the first call of MSRTGetMsgPriorityPlus is slowed.
Error messages

Required files
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
Related functions
See also
3.10.5.14 MSRTGetMsgQuitPlus (RT Professional)
Description
Query the number of alarms that require acknowledgement.
Declaration
BOOL MSRTGetMsgQuitPlus(
LPDWORD lpdwCount,

Parameters
lpdwCount
Pointer for the number of alarms that require acknowledgement
lpError
Return value
TRUE
Number stated.
FALSE
Error
Comment
Error messages
Required files
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
Related functions
See also

3.10.5.15 MSRTGetMsgTextPlus (RT Professional)
Description
Get the text for a text block
Declaration
BOOL WINAPI MSRTGetMsgTextPlus(

WORD wTextBlock,
DWORD dwTextNr,
LPWSTR lpszMsgText,
DWORD* lpdwCount,
Parameters
wTextBlock
Text block number
dwTextNr
Text block ID
lpszMsgText
Pointer to the text block string
IpdwCount
Pointer to the length of the text block string. The length is specified as the number of characters.
lpdwCount=0 Text size is queried.

lpdwCount>0 Text is limited, and current number of charac‐
AND buffer size of lpszMsgText > lpdwCount ters is returned.
lpdwCount>0 Text is limited and returned.
AND buffer size of lpszMsgText > lpdwCount
AND buffer initialized
lpError
Return value
TRUE
Function successful

FALSE
Error
Comment
The MSRTGetMsgPriorityPlus function can also be called without MSRTStartMsgServicePlus.
These calls are however significantly slower. You can improve performance by performing a
MSRTStartMsgServicePlus beforehand and retaining it for all calls. In this case only the first
call of MSRTGetMsgPriorityPlus is slowed.
Error messages
Required files
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
Related functions
See also
3.10.5.16 MSRTGetSelectedMsgPlus (RT Professional)
Description
The function determines the alarm number for an alarm selected in an alarm window or an
alarm view. The view is specified using lpszTemplate.
In individual or multiple user projects queries work on the template without restriction. Queries
in the display do not work for engineering data and only on the display of existing process
values.

Declaration
BOOL MSRTGetSelectedMsgPlus(
LPCWSTR lpszTemplate,
LPMSG_RTDATA_INSTANCECOMMENT_STRUCT_PLUS lpMsgRTPlus,
Parameters
lpszTemplate
Pointer to the name of the view in which an alarm is selected.
lpMsgRTPlus
Pointer to a structure of the MSG_RTDATA_INSTANCECOMMENT_STRUCT_PLUS
(Page 2370) type, in which the alarm number is returned.
lpError
Return value
TRUE
Data queried.
FALSE
Error
Comment
Note
According to which view is set in the display, the flags in dwFlags of the
MSG_RTDATA_INSTANCECOMMENT_STRUCTPlus structure will be assigned differently:
● for the online view: MSG_RT_FLAG_xxx flags,
● for the log view: MSG_FLAG_ flags, and
● for the hit list: no assignment is possible and flags will be ignored.

Error messages
Required files
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
Related functions
Examples
Get selected Msg "MS02.cpp"
See also
3.10.5.17 MSRTResetMsgPlus (RT Professional)
Description
The stated alarm will be acknowledged.
Declaration
BOOL MSRTResetMsgPlus(
DWORD dwServiceID,
DWORD dwMsgNrLow,
DWORD dwMsgNrHigh,
LPDWORD lpdwTAID
Parameters
dwServiceID
MSRTStartMsgService is called.

dwMsgNrLow
dwMsgNrHigh
You must assign dwMsgNrLow and dwMsgNrHigh, if you use the MSG_FILTER_NR,
MSG_FILTER_NR_FROM, or MSG_FILTER_NR_TO filter criteria.
lpdwTAID
lpError
error occurs, the system writes error information to this structure.
Return value
TRUE
Alarm acknowledged.
FALSE
Error
Comment
WARNING
Error messages

MSG_ERR_MSG_NOTFOUND Alarm not found
MSG_ERR_MSG_NOQUIT Alarm does not require acknowledgment
MSG_ERR_MSG_ALREADYQUIT Alarm already acknowledged
Required files
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib

CCMSRTCLIPlus.dll
Related functions
See also
3.10.5.18 MSRTLoopInAlarmPlus (RT Professional)
Description
API function for loop-in-alarm The alarm number is decisive.
Declaration
BOOL MSRTLoopInAlarmPlus(
DWORD dwServiceID,
LPCWSTR lpszServer,
DWORD dwMsgNrLow,
DWORD dwMsgNrHigh,
Parameters
dwServiceID
ID of the Service - service whose server is to be connected
lpszServer
dwMsgNrLow
Alarm number of the lower DWORD
dwMsgNrHigh
Alarm number of the upper DWORD WinCC
lpError

Return value
TRUE
Function successful
FALSE
Error
Error messages

Required files
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
Related functions
See also
3.10.6 Functions for alarm group processing (RT Professional)
3.10.6.1 MSRTEnumGroupMsgPlus (RT Professional)
Description
Enumerate all single alarms of the alarm group. MSG_MAX_GROUPITEMS gives the
maximum number of single alarms that can be enumerated. Its callback function
MSG_SERVICE_NOTIFY_PROCPlus is called using the MSG_NOTIFY_GROUPENUM
notification type. lpbyData refers to data of the MSG_RTGROUPENUM_STRUCTPlus
structure.
Enumeration functions of the alarm system run asynchronously. As a result, you must
synchronize the calls using semaphores.

Declaration
BOOL WINAPI MSRTEnumGroupMsgPlus(

DWORD dwServiceID,
LPMSG_RTGROUPSET_STRUCT_PLUS lpmGroupPlus,
LPDWORD lpdwTAID,
Parameters
dwServiceID
lpmGroupPlus
Pointer to the alarm group info
IpdwTAID
lpError
Return value
TRUE
Function successful
FALSE
Error
Required files
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
Related functions

(Page 2403)
MSG_RTGROUPENUM_STRUCT_PLUS Single alarms of an alarm group
(Page 2386)

See also
MSG_RTGROUPSET_STRUCT_PLUS (Page 2387)
MSG_RTGROUPENUM_STRUCT_PLUS (Page 2386)
3.10.6.2 MSRTLockGroupPlus (RT Professional)
Description
Lock a configured alarm group. All individual alarms in the alarm group and also individual
alarms in underlying groups will be locked.
Declaration
BOOL MSRTLockGroupPlus (
DWORD dwServiceID,
LPMSG_RTGROUPSET_STRUCTPlus lpmGroupPlus,
LPDWORD pdwTAID
Parameters
dwServiceID
ID of the service returned with the call of MSRTStartMsgServicePlus.
lpmGroupPlus
Pointer to the MSG_RTGROUPSET_STRUCT_PLUS (Page 2387) structure with information
on the alarm groups.
Lock: dwData != 0; enable: dwData = 0
pdwTAID
Pointer to the transaction ID for asynchronous processing feedback message
lpError
Return value
TRUE
Alarms in the alarm group locked.

FALSE
Error
Comment
Only configured alarm groups will be locked or released. Groups defined in runtime will not be
included and the function will have no effect.
Error messages

Required files
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
Related functions
See also
3.10.6.3 MSRTQuitGroupPlus (RT Professional)
Description
Acknowledgment of an alarm group. All single alarms of the alarm group as well as the alarms
of subordinate groups are acknowledged.

Declaration
BOOL MSRTQuitGroupPlus (
DWORD dwServiceID,
LPMSG_RTGROUPSET_STRUCTPlus lpmGroupPlus,
LPDWORD pdwTAID
Parameters
dwServiceID
lpmGroupPlus
Pointer to a structure of the MSG_RTGROUPSET_STRUCT_PLUS (Page 2387) type with
information of the alarm groups.
Lock: dwData != 0; enable: dwData = 0
pdwTAID
lpError
Return value
TRUE
Alarms in the alarm group are acknowledged.
FALSE
Error
Required files
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
See also

3.10.7 Functions for alarm filter processing (RT Professional)
3.10.7.1 MSRTGetFilterDataPlus (RT Professional)
Description
Reads the selection criteria of the alarm view and writes the result to the
MSG_FILTER_STRUCT_PLUS structure.
Declaration
BOOL WINAPI MSRTGetFilterDataPlus(

DWORD dwServiceID,
LPCWSTR lpszName,
LPMSG_FILTER_STRUCT_PLUS** lpppMsgFilter,
LPDWORD lpdwFilterCount,
Parameters
dwServiceID
lpszName
Alarm view name. You assign the name in the alarm view properties.
lppMsgFilterPlus
Pointer to array filter pointer to filter structures
lpdwFilterCount
lpError
Return value
TRUE
Function successful
FALSE
Error

Comment
Only configured alarm filters are determined. Alarm filters that are set using
MSRTStartMsgServicePlus or MSRTSetMsgFilterPlus are not included.
Error messages

MSG_ERR_API_NODATA No data
Required files
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
Related functions

See also
3.10.7.2 MSRTCheckWinFilterPlus (RT Professional)
Description
Tests if the stated alarm corresponds to a filter parameter.
Declaration
BOOL MSRTCheckWinFilterPlus (
DWORD dwServiceID,
LPCWSTR lpszServer,
LPMSG_RTDATA_INSTANCECOMMENT_STRUCT_PLUS lpMsgRTPlus,
LPMSG_FILTER_STRUCT_PLUS* lppMsgFilter,
LPWORD lpwReturn,

Parameters
dwServiceID
lpszServer
lpMsgRTPlus
Pointer to a structure of the MSG_RTDATA_INSTANCECOMMENT_STRUCT_PLUS
(Page 2370) type with the runtime data of an alarm.
lppMsgFilter
Pointer to filter pointer array on filter structures.
lpwReturn
Pointer to the function results
TRUE Alarm corresponds to the filter conditions.

FALSE Alarm does not correspond to the filter conditions.
lpError
Return value
TRUE
Testing will be performed.
FALSE
Error
Error messages
Required files
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll

Related functions
See also
3.10.7.3 MSRTSetMsgFilterPlus (RT Professional)
Description
Resets the filter for the specified service.
Declaration
BOOL WINAPI MSRTSetMsgFilterPlus(

DWORD dwServiceID,
LPMSG_FILTER_STRUCT_PLUS* lppMsgFilterPlus,
Parameters
dwServiceID
lppMsgFilterPlus
Pointer to ARRAY pointer for filter conditions
dwFilterCount
Number of filters in the ARRAY
lpError
Pointer to the data of the extended error message in the CMN_ERRORW structure. The system
writes error information into this structure in the case of an error.

Return value
TRUE
Function successful
FALSE
Error
Error messages

Required files
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
Related functions
MSRTStartMsgServicePlus Start service

(Page 2397)
MSRTGetFilterDataPlus Read selection criteria of the alarm view
(Page 2443)
See also
3.10.7.4 MSRTSetMsgWinFilterPlus (RT Professional)
Description
Defines new filter conditions for the alarm view. All current alarm views at preset with this name
will be updated.

Declaration
BOOL MSRTSetMsgWinFilterPlus (
LPMSG_FILTER_STRUCT_PLUS lppMsgFilterPlus,
Parameters
lppMsgFilterPlus
Pointer to a structure of the MSG_FILTER_STRUCT_PLUS (Page 2374) type with the alarm
filter data. The name of the filter structure is the same as the window name.
dwFilterCount
Number of filters
lpError
Return value
TRUE
Filter was set
FALSE
Error
Error messages

See also

3.10.8 Functions for processing alarm view (RT Professional)
3.10.8.1 MSRTMsgWinCommandPlus (RT Professional)
Description
Performs a control function in an alarm view. If you use this function, you only use an alarm
window template once within a screen. The commands are also passed on to controls with the
caption name identical to the template name. (When screens with alarm templates are
converted to screens with controls, the resulting controls have a caption name identical to the
template name.)
Declaration
BOOL MSRTMsgWinCommandPlus(
LPTSTR lpszTemplate,
DWORD dwCommandID,
Parameters
lpszTemplate
Pointer to the window name
dwCommandID
The ID of the control function is specified using the constants in the "m_global.h" file:
MSG_TB_MSGWIN Open process alarm window

MSG_TB_ARC_S Open circular log
MSG_TB_ARC_L Open sequential log
MSG_TB_QH Initiate horn acknowledgment
MSG_TB_QM Initiate single acknowledgment
MSG_TB_QS Initiate group acknowledgment
MSG_TB_SCROLL Switch scroll function on/off.
MSG_TB_SELECT Display selection dialog
MSG_TB_LOCK Display lock dialog
MSG_TB_PROTOCOL Display report dialog
MSG_TB_RESET Initiate emergency acknowledgment
MSG_TB_MSGFIRST Move to start of list
(autoscroll must not be activated)
MSG_TB_MSGLAST Move to end of list
MSG_TB_MSGNEXT Move to next alarm

MSG_TB_MSGPREV Move to previous alarm

MSG_TB_INFO Display info text dialog for currently selected alarm
MSG_TB_COMMENT Enter comment for currently selected alarm
MSG_TB_LOOPINALARM Initiate loop-in-alarm for currently selected alarm
MSG_TB_PRINT Start print
lpError
Return value
TRUE
Control function executed
FALSE
Error
Comment
All opened alarm views with the specified name execute the control function.
Error messages
Required files
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
3.10.9 Functions for processing comments (RT Professional)
3.10.9.1 MSRTGetCommentInstancePlus (RT Professional)
Description
Gets the comment text for a logged alarm.

Declaration
BOOL MSRTGetCommentInstancePlus (
DWORD dwServiceID,
LPMSG_COMMENT_INSTANCE_STRUCT_PLUS lpmCommentPlus,
Parameters
dwServiceID
lpmCommentPlus
Pointer to a MSG_COMMENT_INSTANCE_STRUCT_PLUS (Page 2388) type structure with
the data of a comment. The following values in the structure are necessary: Alarm number,
date and time, and instance name.
Note
Date and time must exactly match the time stamp of the message for which the comment text
is to be determined to the millisecond.
lpError
Pointer to the data of the extended error message in the CMN_ERROR W structure. When an
Return value
TRUE
Comment text determined.
If no comment exists, the call returns TRUE, but the szText element is empty.
FALSE
Error
Error messages


Required files
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
Related functions
See also
MSG_COMMENT_INSTANCE_STRUCT_PLUS (Page 2388)
3.10.9.2 MSRTSetCommentInstancePlus (RT Professional)
Description
Specifies the comment text for a logged alarm.
Declaration
Bool MSRTSetCommentInstancePlus (
DWORD dwServiceID,
LPMSG_COMMENT_INSTANCE_STRUCT_PLUS lpmCommentPlus,
DWORD* pdwTAID,
Parameters
dwServiceID
lpmCommentPlus
Pointer to a MSG_COMMENT_INSTANCE_STRUCT_PLUS (Page 2388) type structure with
the data of a comment. The following values in the structure are necessary: Alarm number,
instance name, date, time of day, text, and user name.
pdwTAID

lpError
Return value
TRUE
Successfully sent to server.
FALSE
Error
Comment
The data of the MSRTSetCommentPlus function are written asynchronously. As a result, not
all errors are returned to the user. Use MSRTGetCommentInstancePlus to check how data
are written.
If MSRTSetCommentInstancePlus is executed after MSRTCreateMsgPlus or
MSRTCreateMsgInstancePlus, the asynchronous writing along with the degree of utilization
of the system can cause data to be "overtaken" by other data. As a result, the comment is
specified before the alarm is created.
Instead of the call combination, use the MSRTCreateMsgInstanceWithCommentPlus function.
Error messages

Required files
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
Related functions

(Page 2410)

See also
MSG_COMMENT_INSTANCE_STRUCT_PLUS (Page 2388)
3.10.10 Functions for info text processing (RT Professional)
3.10.10.1 MSRTGetInfotextPlus (RT Professional)
Description
Gets the info text for an alarm. The following values have to be transferred to this purpose:
Alarm number
Declaration
BOOL WINAPI MSRTGetInfotextPlus (

DWORD dwServiceID,
LPMSG_INFOTEXT_STRUCT_PLUS lpmInfotext,
Parameters
dwServiceID
lpmInfotext
Pointer of the info text structure
lpError
Return value
TRUE
Function successful
FALSE
Error

Error messages

Required files
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
Related functions
See also
MSG_INFOTEXT_STRUCT_PLUS (Page 2389)
3.10.10.2 MSRTSetInfotextPlus (RT Professional)
Description
Sets the info text for an alarm.
Declaration
BOOL WINAPI MSRTSetInfotextPlus(

DWORD dwServiceID,
LPMSG_INFOTEXT_STRUCT_PLUS lpmInfotextPlus,
DWORD* lpdwTAID,
Parameters
dwServiceID
lpmInfotextPlus
Pointer of the info text structure

lpdwTAID
Pointer to the TransactionID with feedback for asynchronous processing.
lpError
Pointer that includes the extended error message.
Return value
TRUE
Function successful
FALSE
Error
Comment
The new info text will be effective from the next minute changeover after one. Until then the
previous info text will be used.
Error messages

Required files
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
Related functions
See also
MSG_INFOTEXT_STRUCT_PLUS (Page 2389)

3.10.11 Archiving functions (RT Professional)
3.10.11.1 MSRTEnumBackupListPlus (RT Professional)
Description
Lists the entries of the export file for the sequential archive.
Declaration
BOOL MSRTEnumBackupListPlus (
DWORD dwServiceID,
Parameters
dwServiceID
lpError
Return value
TRUE
Export list created.
FALSE
Error
Comment
The Enum functions work asynchronously. This has the result that any calls must be
synchronized by semaphore
The callback function MSG_SERVICE_NOTIFY_PROCPlus is called using the
MSG_NOTIFY_BACKUPENUM parameter. The lpbyData parameter points to the data in the
MSG_BACKUP_STRUCT_PLUS (Page 2390) structure.

Error messages

Required files
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
Related functions

MSG_SERVICE_NOTIFY_PROC_PLUS (Page 2403) Callback function
See also
MSG_BACKUP_STRUCT_PLUS (Page 2390)
3.10.11.2 MSRTExportPlus (RT Professional)
Description
Exports alarms from the circular log and the related log backup files.
Declaration
BOOL MSRTExportPlus (
DWORD dwServiceID,
LPMSG_BACKUP_STRUCT_PLUS lpMsgBackup,
Parameters
dwServiceID

lpMsgBackup
Pointer to a structure of the MSG_BACKUP_STRUCT_PLUS (Page 2390) type.
lpError
Return value
TRUE
Alarms exported.
FALSE
Error
Error messages

Required files
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
Related functions
See also
MSG_BACKUP_STRUCT_PLUS (Page 2390)

3.11 Functions for displaying the PLC code (RT Professional)
3.11.1 Display in STEP 7 (RT Professional)
3.11.1.1 Basics (RT Professional)
General information
You can use this function to switch from a screen in WinCC Runtime directly to the point of
use of a process tag in the program code of STEP 7. This provides the possibility of quick and
simple diagnostics of faults. To speed up the entry point functions, you can start the TIA Portal
and open a project. This is typically done at the startup of WinCC Runtime.
A check is first made to determine whether the TIA Portal is already open at the entry point. If
this is not the case, the TIA Portal is automatically started. The corresponding editor opens in
the TIA Portal and a search is performed for the point of use, assignment, call or step.
Header files
The declaration of the functions and structures explained here takes place in the header files:
kopapi.h API interface definition header file
Libraries
The DLL link for the functions explained here is provided in the kopapi.dll "lib" files
kopapi.lib Library
kopapi.dll
See also
OpenTIAPortalProject (Page 2461)
OpenTIAPortalIECPLByCall (Page 2462)
OpenTIAPortalIECPLByAssignment (Page 2465)
OpenTIAPortalS7GraphByBlock (Page 2467)
Example: Integration in a WinCC function (Page 2469)

3.11.1.2 OpenTIAPortalProject (RT Professional)
Description
You can use this function to start the TIA Portal and open a project. This will speed up the
individual jump functions. However, you should consider that a program open in the
background requires memory and computation time.
Declaration
BOOL OpenTIAPortalProject (
DWORD dwFlags,
LPCTSTR lpszTiaPortalProjectPath,
LPCTSTR lpszErrorTag,
Parameters
dwFlags
Bit array in which the individual values are ORed bit-by-bit. dwFlags should be 0 by default.
● KOPAPI_FLAG_TIAPORTAL_CHECK_PROJECT_STATE: If this bit is set, the status of
the project is checked. The project is not opened.
● The project is open.
Return value FALSE
error.dwError1 = KOPAPI_E_TIAPORTAL_PROJECT_NOT_OPEN
● The project is open and contains no changes.
Return value TRUE
error.dwError1 = 0
● The project is open and contains changes.
Return value FALSE
error.dwError1 = KOPAPI_E_TIAPORTAL_PROJECT_MODIFIED
● The project is opened read only.
Return value FALSE
error.dwError1 = KOPAPI_E_TIAPORTAL_PROJECT_READ_ONLY
KOPAPI_FLAG_TIAPORTAL_DONT_USE_MODIFIED_PROJECT: If this bit is set, the call is
canceled when the project is already open and contains changes.
KOPAPI_FLAG_TIAPORTAL_OPEN_READONLY: When this bit is set to TRUE, the project
is opened in write-protected mode in the engineering system of the TIA Portal.
lpszTiaPortalProjectPath
Name of the project file including specification of the absolute path, for example, "D:
\TIAProjects\Project1\Project1.ap14"
Please note that within a C script the backslash has to be written using an Escape sequence:
FunctionX(…, "D:\\TIAProjects\\Project1\\Project1.ap14", …);

lpszErrorTag
Name of an internal WinCC tag of the String data type. The error information is returned in
lpszErrorTag (Page 2483) when asynchronous functions that do not provide instant results
are called.
lpdmError
writes error information to this structure if an error occurs.
Return value
TRUE
FALSE
Required files
kopapi.h
kopapi.lib
kopapi.dll
See also
Basics (Page 2460)
3.11.1.3 OpenTIAPortalIECPLByCall (RT Professional)
Description
The function is used for the LAD and FBD languages and shows the preceding logic of a
network input of a standard block.
Declaration
BOOL OpenTIAPortalIECPLByCall (
DWORD dwFlags,
LPCTSTR lpszCpuName,
LPCTSTR lpszContainingBlock,
LPCTSTR lpszCalledBlock,
LPCTSTR lpszPin,

Parameters
dwFlags
● IECPLVIEWER_PIN_SUBSTRING_SEARCH=0x0001: When searching for the pin name,
a substring is searched for, which means the pin name starts with the string passed in
lpszPin. If this bit is not set, the complete pin name is compared to lpszPin.
● KOPAPI_FLAG_TIAPORTAL_SUPPRESS_PROGRAM_STATUS=0x0004: The TIA
Portal does not go into online mode after the block is opened. If this bit is not set, online
mode is started after opening the block.
● KOPAPI_FLAG_TIAPORTAL_DONT_USE_MODIFIED_PROJECT 0x0008L: If this bit is
set, the call is canceled when the project is already open and contains changes.
● KOPAPI_FLAG_TIAPORTAL_OPEN_READONLY: When this bit is set to TRUE, the
project is opened in write-protected mode in the engineering system of the TIA Portal.
lpszCpuName
Name of the S7 CPU. The name is identical to the station name displayed in the project tree
in the TIA Portal.
lpszContainingBlock
Name of the block to be opened and displayed or name of the instance of an FB.
The following can be used as the name:
● Name of a single instance DB. Its FB is then displayed. Example "Station1"
● Name of a multi-instance in an instance DB. Its FB is then displayed. When multiinstance
name paths are specified, these are data hierarchies such as those displayed in the DB
editor, and not those in the call structure. The first part of the name ("Line1") cannot be
enclosed in quotes, because this is a global icon, as can be recognized by the context.
Quotation marks are required for the individual name components when special characters
such as spaces, dots, etc., occur in them. Example: "Line1.Cell1.Station1"
● Name of an FC or OB
The use of the name of a FB is not allowed.
lpszCalledBlock
Name of the local or global instance that is called in the code block belonging to
lpszContainingBlock.
● For local instances, the hash sign # must be specified here, for example, "#feeder1".
● For global instances, the global name without hash sign # must be specified here, for
example, "feeder3".

The use of the name of an FC is not allowed.

If lpszCalledBlock is called several times within lpszContainingBlock or its FB, the entry point
is always the first call of lpszCalledBlock.
Only lpszContainingBlock is opened and displayed in the status with lpszCalledBlock=ZERO,
but there is no search for a specific block call or a specific network. lpszPin is ignored in this
case.
lpszPin
Name of the input pin of lpszCalledBlock. The parameter is used to make the specified pin
visible within the network in the editor.
Only lpszCalledBlock is shown as visible with lpszPin=ZERO.
lpszErrorTag
are called.
lpdmError
Return value
TRUE
FALSE
Required files
kopapi.h
kopapi.lib
kopapi.dll
See also
Basics (Page 2460)

3.11.1.4 OpenTIAPortalIECPLByAssignment (RT Professional)
Description
The function is used for the LAD and FBD languages and shows the assignment to an operand
and its preceding logic.
Declaration
BOOL OpenTIAPortalIECPLByAssignment (
DWORD dwFlags,
LPCTSTR lpszOperand,
Parameters
dwFlags
● KOPAPI_FLAG_TIAPORTAL_DONT_USE_MODIFIED_PROJECT 0x0008L: If this bit is
set, the call is canceled when the project is already open and contains changes.
lpszCpuName
in the TIA Portal.
lpszContainingBlock


lpszOperand
Name of a local or global operand to which an assignment is made.
● For local operands, the hash sign # must also be specified here.
● For global operands, the global name without hash sign # must be specified.
If lpszOperand is written several times within lpszContainingBlock or its FB, the entry point is
always the first write access of lpszOperand.
lpszErrorTag
are called.
lpdmError
Return value
TRUE
FALSE
Required files
kopapi.h
kopapi.lib
kopapi.dll

See also
Basics (Page 2460)
3.11.1.5 OpenTIAPortalS7GraphByBlock (RT Professional)
Description
The function is used for the S7 Graph languages and shows a step in a sequencer.
Declaration
BOOL OpenTIAPortalS7GraphByBlock (
DWORD dwFlags,
LPCTSTR lpszBlock,
DWORD dwStepNumber,
Parameters
dwFlags
● KOPAPI_FLAG_TIAPORTAL_DONT_USE_MODIFIED_PROJECT 0x00000008L: If this
bit is set, the call is canceled when the project is already open and contains changes.
lpszCpuName
in the TIA Portal.
lpszBlock
Instance name of the S7 Graph block to be displayed.

dwStepNumber
Number of the step to be displayed
dwStepNumber=0 automatically searches for the active step and enables "Track active step"
mode.
lpszErrorTag
are called.
lpdmError
Return value
TRUE
FALSE
Required files
kopapi.h
kopapi.lib
kopapi.dll
See also
Basics (Page 2460)

3.11.1.6 Example: Integration in a WinCC function (RT Professional)
Description
The example shows the embedding of the function calls in a user-defined function. For better
maintainability, the call should be made externally in a global script function, in which the path
to the TIA Portal and the name of the PLC station are then determined.
void OnClick(char* screenName, char* objectName, char* propertyName)

{
// Funktionen bekannt machen'
#pragma code("KOPAPI.dll")
#include "KOPAPI.h"
#pragma code()
BOOL useTiaPortal = TRUE; // use the TIA Portal or the viewer control?
char* pTiaPortalProject = "c:\\Projects\\myproject\\myproject.ap14";
char* pStationName = "OW063IZ1M01_PLC2_STD"; // TODO: read from internal
tag
char* pContainingBlock = "SG01_FG02_ST001+FX001_IDB"; // TODO: get from
current selection
char* pOperand = "#HOME_SEQ1.HOME_MISC[8]"; // TODO: get from current
selection
CMN_ERROR error;
BOOL result;
if(useTiaPortal)
{
result = OpenTIAPortalIECPLByAssignment(0, pTiaPortalProject,
pStationName, pContainingBlock, pOperand, &error);
}
else
{
char *pServerPrefix = NULL, *pTagPrefix = NULL, *pWindowPrefix =
NULL;
// determine ServerPrefix of the current environment
GetServerTagPrefix(&pServerPrefix, &pTagPrefix, &pWindowPrefix);
// make the screen which contains the viewer control visible
SetVisible("SYSTEM#Basic_Screen", "Screen_window_IECPLViewer",
TRUE);
result = OpenViewerIECPLByAssignment(0, pServerPrefix,
"SYSTEM#IECPLViewer", "IECPLViewerObject", pStationName, pContainingBlock,
pOperand, &error);
}
}
See also
Basics (Page 2460)

3.11.2 Display in the PLC code display (RT Professional)
3.11.2.1 Basics (RT Professional)
General information
You can use these functions to display the current program status of PLC programs in a PLC
code display.
The screen containing the PLC code display must have been opened via OpenPicture() or
SetPictureName(), for example.
Header files
The declaration of the functions and structures explained here takes place in the header files:
kopapi.h API interface definition header file
Libraries
The DLL link for the functions explained here is provided in the "lib" files: pdecscli.dll
kopapi.lib Library
kopapi.dll
Note on defining multi-instance names

When multi-instance name paths are specified, these are data hierarchies such as those
displayed in the DB editor and not call structures. The first part of the name ("Line1") does not
need to be enclosed in quotation marks as it is clear from the context that it is a global symbol.
Quotation marks are required for the individual name components where there are special
characters such as spaces, dots, etc. Example: "Line1.Cell1.Station1". Names that do not
contain special characters must not be put in quotation marks.
See also
OpenViewerIECPLByCall (Page 2473)
OpenViewerIECPLByAssignment (Page 2479)
OpenViewerS7GraphByBlock (Page 2470)
3.11.2.2 OpenViewerS7GraphByBlock (RT Professional)
Description
The function displays in the PLC language, S7 Graph, a step called from a sequencer in the
PLC code display.

Declaration
BOOL OpenViewerS7GraphByBlock (
DWORD dwFlags,
LPCTSTR lpszServerPrefix,
LPCTSTR lpszPictureName,
LPCTSTR lpszObjectName,
LPCTSTR lpszBlock,
DWORD dwStepNumber,
Parameter
dwFlags
lpszServerPrefix
The parameter is reserved for later upgrades.
lpszPictureName
Name of the screen with the PLC code viewer.
lpszObjectName
Name of the PLC code viewer.
lpszCpuName
in the TIA Portal.
lpszBlock
Instance name of the S7 Graph block to be displayed. If special characters such as spaces,
periods, etc. occur in the name, quotation marks need to be used.
dwStepNumber
Number of the step to be displayed.
dwStepNumber=0 automatically searches for the active step and enables "Track active step"
mode.
lpdmError

Return value
TRUE
FALSE
Required files
kopapi.h
kopapi.lib
kopapi.dll
Example
The example shows the embedding of the function call in a user-defined C function. For better
maintainability, the call should be swapped out to a global script function in which the name
of the PLC station is also determined.
BOOL OpenViewerS7GraphByBlock(char* screenName, char* objectName, char*

cpuName, char* instanceDBName)
{
#pragma code("kopapi.dll")
#include "kopapi.h"
#pragma code()
BOOL result;
CMN_ERROR error;
char* serverPrefix = "";
DWORD dwFlags = 0;
DWORD stepNumber = 0;
result = OpenViewerS7GraphByBlock(dwFlags, serverPrefix, screenName,
objectName,
cpuName, instanceDBName, stepNumber, &error);
if(!result)
{
// there are only few reasons why the call to OpenViewerS7GraphByBlock
will
// fail, in most cases the viewer control could not be found
// most of the errors have to be handled in the OnError event of the viewer
printf("OpenViewerS7GraphByBlock failed: err1=%ld, err2=%ld, err3=%ld,
err4=%ld, err5=%ld, text=\"%s\"\r\n", result, error.dwError1,
error.dwError2, error.dwError3, error.dwError4, error.dwError5,
error.szErrorText);
}
return result;
}

See also
Error-handling (Page 2483)
Basics (Page 2470)
3.11.2.3 OpenViewerIECPLByCall (RT Professional)
Description
The function is used for the LAD and FBD languages and shows the preceding logic of a
network input of a standard block in the PLC code view.
Note
If the input is occupied by a constant (TRUE, FALSE), this value is not displayed in the PLC
code viewer. To display the value in the PLC code viewer correctly, you should allocate a tag
to the input that has the appropriate value.
Declaration
BOOL OpenViewerIECPLByCall (
DWORD dwFlags,
LPCTSTR lpszServerPrefix,
LPCTSTR lpszPictureName,
LPCTSTR lpszObjectName,
LPCTSTR lpszCalledBlock,
LPCTSTR lpszPin,
Parameter
dwFlags
● IECPLVIEWER_PIN_SUBSTRING_SEARCH=0x0001: A substring is sought in the search
for the pin name, which means the pin name starts with the string transferred in lpszPin. If
this bit is not set, the complete pin name is compared to lpszPin.
lpszServerPrefix

lpszPictureName
Name of the screen with the PLC code viewer.
lpszObjectName
Name of the PLC code viewer.
lpszCpuName
in the TIA Portal.
lpszContainingBlock
lpszCalledBlock
● For local instances, the hash sign # must be specified here, for example, "#feeder1".
● For global instances, the global name without hash sign # must be specified here, for
example, "feeder3".
The use of the name of an FC is not allowed.
If lpszCalledBlock is called several times within lpszContainingBlock or its FB, the entry point
is always the first call of lpszCalledBlock.
lpszPin
Name of the input pin of lpszCalledBlock. The parameter is used to display the network
interconnected to the input pin in the PLC code viewer.
lpdmError

Return value
TRUE
FALSE
Required files
kopapi.h
kopapi.lib
kopapi.dll
Example
The example shows the embedding of the function call in a user-defined C function. For better
maintainability, the call should be swapped out to a global script function in which the name
of the PLC station is also determined.
BOOL OpenCodeViewerByCall(BOOL matchSubstringPin, char* screenName, char*

objectName, char* cpuName, char* containingBlock, char* calledBlock, char*
pinName)
{
#pragma code("kopapi.dll")
#include "kopapi.h"
#pragma code()
BOOL result;
CMN_ERROR error;
char* serverPrefix = "";
DWORD dwFlags = 0;
if(matchSubstringPin)
dwFlags |= KOPAPI_FLAG_TIAPORTAL_PIN_SUBSTRING_SEARCH;
result = OpenViewerIECPLByCall(dwFlags, serverPrefix, screenName,
objectName,
cpuName, containingBlock, calledBlock, pinName, &error);
if(!result)
{
// there are only few reasons why the call to OpenViewerIECPLByCall will
fail, in // most cases the viewer control could not be found
// most of the errors have to be handled in the OnError event of the viewer
printf("OpenViewerIECPLByCall failed: err1=%ld, err2=%ld, err3=%ld, err4=
%ld, err5=%ld, text=\"%s\"\r\n", result, error.dwError1,
error.dwError2,

WCC PReference en-US PDF

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

WCC PReference en-US PDF

Uploaded by

Copyright:

Available Formats

VB scripting 1

C scripting (RT Professional) 2

Online help printout

WinCC Engineering V15.1 - Programming reference

1.1.45 LogOff (Panels, Comfort Panels, RT Advanced)...................................................................73

WinCC Engineering V15.1 - Programming reference

1.2.2 ActivateScreenInScreenWindow (RT Professional).............................................................122

WinCC Engineering V15.1 - Programming reference

1.4.5.8 Input (Panels, Comfort Panels)............................................................................................174

WinCC Engineering V15.1 - Programming reference

1.5.5.3 Properties C (Panels, Comfort Panels, RT Advanced, RT Professional).............................590

WinCC Engineering V15.1 - Programming reference

2.1.16.13 GetTagValueWait functions (RT Professional)..................................................................1420

WinCC Engineering V15.1 - Programming reference

2.1.43.3 uaArchiveExport (RT Professional)....................................................................................1490

WinCC Engineering V15.1 - Programming reference

2.2.4 memory functions (RT Professional)..................................................................................1529

WinCC Engineering V15.1 - Programming reference

3.2.2.22 DM_VARLIMIT (RT Professional)......................................................................................1597

WinCC Engineering V15.1 - Programming reference

3.2.6 Functions for processing tags (RT Professional)...............................................................1676

WinCC Engineering V15.1 - Programming reference

3.2.8.1 DMEnumConnectionData (RT Professional).....................................................................1791

WinCC Engineering V15.1 - Programming reference

3.2.11.32 OnTestWinCCShutdown (RT Professional).......................................................................1862

WinCC Engineering V15.1 - Programming reference

3.4.2.4 GENERATE_COMPILE (RT Professional)........................................................................1950

WinCC Engineering V15.1 - Programming reference

3.5.6.4 PWGENEnumPermLevels (RT Professional)....................................................................2009

WinCC Engineering V15.1 - Programming reference

3.6.4.4 TXTShowLanguagesDialog (RT Professional)..................................................................2062

WinCC Engineering V15.1 - Programming reference

3.8 Tag and log functions (RT Professional)............................................................................2138

WinCC Engineering V15.1 - Programming reference

3.8.6.8 TLGGetArchivData (RT Professional)................................................................................2222

WinCC Engineering V15.1 - Programming reference

3.9.4.2 uaDisconnect (RT Professional)........................................................................................2297

WinCC Engineering V15.1 - Programming reference

3.9.10.4 uaArchiveWriteTagValuesByName (RT Professional).......................................................2352

WinCC Engineering V15.1 - Programming reference

3.10.6.1 MSRTEnumGroupMsgPlus (RT Professional)...................................................................2438

WinCC Engineering V15.1 - Programming reference

WinCC Engineering V15.1 - Programming reference

WinCC Engineering V15.1 - Programming reference

1.1.1 AcknowledgeAlarm (Panels, Comfort Panels, RT Advanced)

Use in the function list

Use in user-defined functions

1.1.2 ActivatePLCCodeViewer (Panels, Comfort Panels, RT Advanced)

WinCC Engineering V15.1 - Programming reference

Use in the function list

Use in user-defined functions

WinCC Engineering V15.1 - Programming reference

1.1.3 ActivatePreviousScreen (Panels, Comfort Panels, RT Advanced)

WinCC Engineering V15.1 - Programming reference

Use in the function list

Use in user-defined functions

1.1.4 ActivateScreen (Panels, Comfort Panels, RT Advanced)

Use in the function list

Use in user-defined functions

WinCC Engineering V15.1 - Programming reference

When "0" is specified:

1.1.5 ActivateScreenByNumber (Panels, Comfort Panels, RT Advanced)

Use in the function list