VB scripting 1

C scripting 2

Runtime API 3
SIMATIC HMI

WinCC (TIA Portal)

WinCC Engineering V18 –
Programming reference

System Manual

Online documentation

11/2022
Online documentation
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 documentation Copyright © Siemens AG 2022.

Digital Industries Ⓟ 11/2022 Subject to change All rights reserved
Postfach 48 48
90026 NÜRNBERG
GERMANY
Table of contents

1 VB scripting.......................................................................................................................................... 25
1.1 System functions ............................................................................................................... 25
1.1.1 AcknowledgeAlarm............................................................................................................ 25
1.1.2 ActivatePLCCodeViewer ..................................................................................................... 25
1.1.3 ActivatePreviousScreen ...................................................................................................... 27
1.1.4 ActivateScreen................................................................................................................... 28
1.1.5 ActivateScreenByNumber................................................................................................... 29
1.1.6 ActivateSystemDiagnosticsView ......................................................................................... 30
1.1.7 ArchiveLogFile ................................................................................................................... 31
1.1.8 Back up RAM file system ..................................................................................................... 32
1.1.9 CalibrateTouchScreen......................................................................................................... 33
1.1.10 ChangeConnection ............................................................................................................ 34
1.1.11 ChangeConnectionEIP........................................................................................................ 35
1.1.12 ClearAlarmBuffer................................................................................................................ 37
1.1.13 ClearAlarmBufferProtool ..................................................................................................... 38
1.1.14 ClearDataRecord ................................................................................................................ 39
1.1.15 ClearDataRecordMemory ................................................................................................... 40
1.1.16 ClearLog ............................................................................................................................ 41
1.1.17 CloseAllLogs ...................................................................................................................... 42
1.1.18 ControlSmartServer ........................................................................................................... 42
1.1.19 ControlWebServer.............................................................................................................. 43
1.1.20 CopyLog ............................................................................................................................ 44
1.1.21 DecreaseTag ...................................................................................................................... 45
1.1.22 EditAlarm .......................................................................................................................... 46
1.1.23 Encode .............................................................................................................................. 46
1.1.24 EncodeEx........................................................................................................................... 47
1.1.25 ExportDataRecords ............................................................................................................ 48
1.1.26 ExportDataRecordsWithChecksum...................................................................................... 51
1.1.27 ExportImportUserAdministration........................................................................................ 53
1.1.28 GetBrightness .................................................................................................................... 54
1.1.29 GetDataRecordFromPLC ..................................................................................................... 55
1.1.30 GetDataRecordName.......................................................................................................... 56
1.1.31 GetDataRecordTagsFromPLC............................................................................................... 58
1.1.32 GetGroupNumber .............................................................................................................. 59
1.1.33 GetPassword...................................................................................................................... 59
1.1.34 GetUserName .................................................................................................................... 60
1.1.35 GoToEnd ............................................................................................................................ 61
1.1.36 GoToHome......................................................................................................................... 61
1.1.37 ImportDataRecords ............................................................................................................ 62
1.1.38 ImportDataRecordsWithChecksum ..................................................................................... 64
1.1.39 IncreaseTag ....................................................................................................................... 65
1.1.40 InverseLinearScaling .......................................................................................................... 66
1.1.41 InvertBit............................................................................................................................. 68
1.1.42 InvertBitInTag..................................................................................................................... 69
1.1.43 LinearScaling ..................................................................................................................... 71
1.1.44 LoadDataRecord................................................................................................................. 73

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 3
Table of contents

1.1.45 LogOff ............................................................................................................................... 74

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

WinCC Engineering V18 – Programming reference

4 System Manual, 11/2022, Online documentation
 Table of contents

1.2.2 ActivateScreenInScreenWindow ....................................................................................... 124

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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 5
Table of contents

1.4.5.8 Input ............................................................................................................................... 176

1.4.5.9 InputB ............................................................................................................................. 177
1.4.5.10 InputFields....................................................................................................................... 178
1.4.5.11 Kill................................................................................................................................... 179
1.4.5.12 LineInputString ................................................................................................................ 179
1.4.5.13 LinePrint .......................................................................................................................... 180
1.4.5.14 MkDir .............................................................................................................................. 180
1.4.5.15 MoveFile.......................................................................................................................... 181
1.4.5.16 Open ............................................................................................................................... 182
1.4.5.17 Put .................................................................................................................................. 183
1.4.5.18 RmDir .............................................................................................................................. 184
1.4.5.19 SetAttr ............................................................................................................................. 184
1.4.5.20 WriteFields....................................................................................................................... 185
1.5 VBS object model............................................................................................................. 187
1.5.1 VBS object model............................................................................................................. 187
1.5.2 Objects ............................................................................................................................ 190
1.5.2.1 HMIRuntime .................................................................................................................... 190
1.5.2.2 Screen object (list) ........................................................................................................... 191
1.5.2.3 Screen ............................................................................................................................. 192
1.5.2.4 ScreenItem ...................................................................................................................... 193
1.5.2.5 ScreenItems..................................................................................................................... 195
1.5.2.6 SmartTags ....................................................................................................................... 196
1.5.2.7 SmartTag ......................................................................................................................... 198
1.5.3 Objects ............................................................................................................................ 200
1.5.3.1 Alarm .............................................................................................................................. 200
1.5.3.2 Alarms (list) ..................................................................................................................... 201
1.5.3.3 AlarmLogs (list) ............................................................................................................... 202
1.5.3.4 DataItem ......................................................................................................................... 203
1.5.3.5 DataLogs (list) ................................................................................................................. 205
1.5.3.6 DataSet (list).................................................................................................................... 206
1.5.3.7 HMIRuntime ................................................................................................................... 209
1.5.3.8 Item ................................................................................................................................ 210
1.5.3.9 Layer ............................................................................................................................... 211
1.5.3.10 Layers (list) ..................................................................................................................... 213
1.5.3.11 Logging ........................................................................................................................... 214
1.5.3.12 Project ............................................................................................................................. 215
1.5.3.13 Screen ............................................................................................................................. 216
1.5.3.14 ScreenItem ...................................................................................................................... 219
1.5.3.15 ScreenItems (list) ............................................................................................................. 221
1.5.3.16 Screen object (list) ........................................................................................................... 223
1.5.3.17 SmartTag ......................................................................................................................... 225
1.5.3.18 SmartTags ....................................................................................................................... 226
1.5.3.19 Tag .................................................................................................................................. 229
1.5.3.20 Tags (list)......................................................................................................................... 232
1.5.3.21 TagSet (list) ..................................................................................................................... 233
1.5.4 Object types .................................................................................................................... 234
1.5.4.1 Object types available in VBS............................................................................................ 234
1.5.4.2 Objects A-I ....................................................................................................................... 237
1.5.4.3 Objects K-Z ...................................................................................................................... 336
1.5.5 Properties ........................................................................................................................ 490
1.5.5.1 Properties A ..................................................................................................................... 490
1.5.5.2 Properties B ..................................................................................................................... 526

WinCC Engineering V18 – Programming reference

6 System Manual, 11/2022, Online documentation
 Table of contents

1.5.5.3 Properties C ..................................................................................................................... 587

1.5.5.4 Properties D ..................................................................................................................... 640
1.5.5.5 Properties E-F .................................................................................................................. 657
1.5.5.6 Properties G-H ................................................................................................................. 716
1.5.5.7 Properties I-J .................................................................................................................... 740
1.5.5.8 Properties K-L................................................................................................................... 758
1.5.5.9 Properties M-N................................................................................................................. 797
1.5.5.10 Properties O-P.................................................................................................................. 837
1.5.5.11 Properties Q-R.................................................................................................................. 875
1.5.5.12 Properties S ..................................................................................................................... 892
1.5.5.13 Properties T ..................................................................................................................... 984
1.5.5.14 Properties U-W............................................................................................................... 1142
1.5.5.15 Properties X-Z ................................................................................................................ 1225
1.5.6 Methods ........................................................................................................................ 1250
1.5.6.1 Methods A-G.................................................................................................................. 1250
1.5.6.2 Methods H-R .................................................................................................................. 1314
1.5.6.3 Methods S-Z .................................................................................................................. 1342
1.5.7 Error Messages from Database Area ............................................................................... 1369
2 C scripting ........................................................................................................................................ 1371
2.1 System functions ........................................................................................................... 1371
2.1.1 ActivateNextScreen........................................................................................................ 1371
2.1.2 ActivatePreviousScreen .................................................................................................. 1372
2.1.3 ActivateScreen............................................................................................................... 1373
2.1.4 ActivateScreenInScreenWindow ..................................................................................... 1374
2.1.5 ActivateStartScreen........................................................................................................ 1375
2.1.6 ActivateStoredScreen ..................................................................................................... 1376
2.1.7 DateToSystemTime ........................................................................................................ 1377
2.1.8 DecreaseTag .................................................................................................................. 1379
2.1.9 GetLink.......................................................................................................................... 1380
2.1.10 GetLinkedTag................................................................................................................. 1381
2.1.11 GetLocalScreen .............................................................................................................. 1383
2.1.12 GetLanguageByLocaleID................................................................................................. 1384
2.1.13 GetParentScreen ............................................................................................................ 1386
2.1.14 GetParentScreenWindow................................................................................................ 1387
2.1.15 GetProp ......................................................................................................................... 1389
2.1.15.1 GetPropBOOL ................................................................................................................ 1389
2.1.15.2 GetPropChar .................................................................................................................. 1390
2.1.15.3 GetPropDouble .............................................................................................................. 1392
2.1.15.4 GetPropLong.................................................................................................................. 1393
2.1.16 GetServerTagPrefix ......................................................................................................... 1394
2.1.17 GetTag........................................................................................................................... 1397
2.1.17.1 GetTag functions............................................................................................................ 1397
2.1.17.2 GetTagDateTime function............................................................................................... 1398
2.1.17.3 GetTagMultiStateQCWait functions................................................................................. 1399
2.1.17.4 GetTagMultiStateWait functions ..................................................................................... 1401
2.1.17.5 GetTagMultiWait functions ............................................................................................. 1402
2.1.17.6 GetTagState functions .................................................................................................... 1403
2.1.17.7 GetTagStateQC functions ............................................................................................... 1406
2.1.17.8 GetTagStateQCWait functions......................................................................................... 1408
2.1.17.9 GetTagStateWait functions ............................................................................................. 1411
2.1.17.10 GetTagValue functions ................................................................................................... 1413

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 7
Table of contents

2.1.17.11 GetTagValueStateQC functions ....................................................................................... 1415

2.1.17.12 GetTagValueStateQCWait functions ................................................................................ 1416
2.1.17.13 GetTagValueWait functions ............................................................................................ 1418
2.1.17.14 GetTagWait functions ..................................................................................................... 1419
2.1.18 IncreaseTag ................................................................................................................... 1421
2.1.19 InquireLanguage............................................................................................................ 1422
2.1.20 InverseLinearScaling ...................................................................................................... 1424
2.1.21 InvertBit......................................................................................................................... 1426
2.1.22 InvertBitInTag................................................................................................................. 1427
2.1.23 IsUserAuthorized ........................................................................................................... 1429
2.1.24 LinearScaling ................................................................................................................. 1431
2.1.25 ReportJob ...................................................................................................................... 1432
2.1.26 ResetBit ......................................................................................................................... 1433
2.1.27 ResetBitInTag ................................................................................................................. 1435
2.1.28 Set_Focus ...................................................................................................................... 1436
2.1.29 SetBit............................................................................................................................. 1437
2.1.30 SetBitInTag..................................................................................................................... 1438
2.1.31 SetLanguageByLocaleID ................................................................................................. 1440
2.1.32 SetLanguageByName ..................................................................................................... 1442
2.1.33 SetLink .......................................................................................................................... 1443
2.1.34 SetProp.......................................................................................................................... 1444
2.1.34.1 SetPropBOOL ................................................................................................................. 1444
2.1.34.2 SetPropChar................................................................................................................... 1445
2.1.34.3 SetPropDouble ............................................................................................................... 1447
2.1.34.4 SetPropLong .................................................................................................................. 1448
2.1.35 SetPropertyByConstant .................................................................................................. 1449
2.1.36 SetPropertyByProperty ................................................................................................... 1451
2.1.37 SetPropertyByTag........................................................................................................... 1453
2.1.38 SetPropertyByTagIndirect ............................................................................................... 1455
2.1.39 SetTag ........................................................................................................................... 1456
2.1.39.1 SetTag functions ............................................................................................................ 1456
2.1.39.2 SetTagDateTime............................................................................................................. 1459
2.1.39.3 SetTagMultiStateWait functions...................................................................................... 1460
2.1.39.4 SetTagMultiWait functions.............................................................................................. 1462
2.1.39.5 SetTagState functions .................................................................................................... 1464
2.1.39.6 SetTagStateWait functions.............................................................................................. 1466
2.1.39.7 SetTagValue functions.................................................................................................... 1469
2.1.39.8 SetTagValueWait functions ............................................................................................. 1471
2.1.39.9 SetTagWait functions ..................................................................................................... 1472
2.1.39.10 SetTag ........................................................................................................................... 1474
2.1.39.11 SetTagByProperty........................................................................................................... 1475
2.1.39.12 SetTagByTagIndirect ....................................................................................................... 1477
2.1.39.13 SetTagIndirect ............................................................................................................... 1478
2.1.39.14 SetTagIndirectByProperty ............................................................................................... 1479
2.1.39.15 SetTagIndirectByTagIndirect ........................................................................................... 1480
2.1.39.16 SetTagIndirectWithOperatorEvent................................................................................... 1481
2.1.39.17 SetTagWithOperatorEvent .............................................................................................. 1481
2.1.40 StartProgram ................................................................................................................. 1482
2.1.41 StopRuntime.................................................................................................................. 1483
2.1.42 StoreScreen .................................................................................................................. 1484
2.1.43 SystemTimeToDate ........................................................................................................ 1485
2.1.44 TriggerOperatorEvent..................................................................................................... 1487

WinCC Engineering V18 – Programming reference

8 System Manual, 11/2022, Online documentation
 Table of contents

2.1.45 UA (Recipe).................................................................................................................... 1488

2.1.45.1 uaArchiveClose .............................................................................................................. 1488
2.1.45.2 uaArchiveDelete............................................................................................................. 1489
2.1.45.3 uaArchiveExport ............................................................................................................ 1489
2.1.45.4 uaArchiveGetCount........................................................................................................ 1490
2.1.45.5 uaArchiveGetFieldLength ............................................................................................... 1491
2.1.45.6 uaArchiveGetFieldName................................................................................................. 1492
2.1.45.7 uaArchiveGetFields ........................................................................................................ 1492
2.1.45.8 uaArchiveGetFieldType .................................................................................................. 1493
2.1.45.9 uaArchiveGetFieldValueDate .......................................................................................... 1494
2.1.45.10 uaArchiveGetFieldValueDouble ...................................................................................... 1494
2.1.45.11 uaArchiveGetFieldValueFloat.......................................................................................... 1495
2.1.45.12 uaArchiveGetFieldValueLong.......................................................................................... 1496
2.1.45.13 uaArchiveGetFieldValueString ........................................................................................ 1497
2.1.45.14 uaArchiveGetFilter ......................................................................................................... 1498
2.1.45.15 uaArchiveGetID.............................................................................................................. 1498
2.1.45.16 uaArchiveGetName ........................................................................................................ 1499
2.1.45.17 uaArchiveGetSor ............................................................................................................ 1500
2.1.45.18 uaArchiveImport ............................................................................................................ 1500
2.1.45.19 uaArchiveInsert.............................................................................................................. 1501
2.1.45.20 uaArchiveMoveFirst ....................................................................................................... 1502
2.1.45.21 uaArchiveMoveLast ....................................................................................................... 1502
2.1.45.22 uaArchiveMoveNext....................................................................................................... 1503
2.1.45.23 uaArchiveMovePrevious ................................................................................................. 1504
2.1.45.24 uaArchiveOpen .............................................................................................................. 1504
2.1.45.25 uaArchiveReadTagValues................................................................................................ 1505
2.1.45.26 uaArchiveReadTagValuesByName ................................................................................... 1506
2.1.45.27 uaArchiveRequery.......................................................................................................... 1507
2.1.45.28 uaArchiveSetFieldValueDate........................................................................................... 1508
2.1.45.29 uaArchiveSetFieldValueDouble ....................................................................................... 1508
2.1.45.30 uaArchiveSetFieldValueFloat .......................................................................................... 1509
2.1.45.31 uaArchiveSetFieldValueLong .......................................................................................... 1510
2.1.45.32 uaArchiveSetFieldValueString ........................................................................................ 1511
2.1.45.33 uaArchiveSetFilter .......................................................................................................... 1512
2.1.45.34 uaArchiveSetSort ........................................................................................................... 1512
2.1.45.35 uaArchiveUpdate ........................................................................................................... 1513
2.1.45.36 uaArchiveWriteTagValues ............................................................................................... 1514
2.1.45.37 uaArchiveWriteTagValuesByName................................................................................... 1515
2.1.45.38 uaConnect ..................................................................................................................... 1515
2.1.45.39 uaDisconnect................................................................................................................. 1516
2.1.45.40 uaGetArchive ................................................................................................................. 1517
2.1.45.41 uaGetField ..................................................................................................................... 1517
2.1.45.42 uaGetLastError .............................................................................................................. 1518
2.1.45.43 uaGetLastHResult .......................................................................................................... 1520
2.1.45.44 uaGetNumArchives ........................................................................................................ 1521
2.1.45.45 uaGetNumFields ............................................................................................................ 1521
2.1.45.46 uaQueryArchive ............................................................................................................ 1522
2.1.45.47 uaQueryArchiveByName ............................................................................................... 1523
2.1.45.48 UaQueryConfiguration ................................................................................................... 1524
2.1.45.49 uaReleaseArchive........................................................................................................... 1524
2.1.45.50 uaReleaseConfiguration ................................................................................................ 1525
2.2 C-bib ............................................................................................................................. 1526

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 9
Table of contents

2.2.1 ctype functions .............................................................................................................. 1526

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

WinCC Engineering V18 – Programming reference

10 System Manual, 11/2022, Online documentation
 Table of contents

3.2.2.19 DM_VARIABLE_DATA ...................................................................................................... 1590

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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 11
Table of contents

3.2.5.6 DMInstallDataService ..................................................................................................... 1672

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

WinCC Engineering V18 – Programming reference

12 System Manual, 11/2022, Online documentation
 Table of contents

3.2.7.8 GAPIEnumTypes............................................................................................................. 1788

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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 13
Table of contents

3.2.11.29 OnTestVariablenStopallupdates ...................................................................................... 1861

3.2.11.30 OnTestVariablenStopvarupdate....................................................................................... 1861
3.2.11.31 OnTestVariablenSuspendvarupdate ................................................................................ 1862
3.2.11.32 OnTestWinCCShutdown ................................................................................................. 1862
3.2.11.33 Open project by means of dialog .................................................................................... 1863
3.2.11.34 Read tag ........................................................................................................................ 1864
3.2.11.35 Write tag........................................................................................................................ 1869
3.3 Functions of the graphic system ..................................................................................... 1871
3.3.1 Basics ............................................................................................................................ 1871
3.3.1.1 Overview of the functions .............................................................................................. 1871
3.3.1.2 Overview of structures ................................................................................................... 1872
3.3.1.3 Error messages .............................................................................................................. 1872
3.3.1.4 Constants ...................................................................................................................... 1874
3.3.1.5 List of object properties (A-K) (Graphics Designer) .......................................................... 1875
3.3.1.6 List of object properties (L-Z) (Graphics Designer) ........................................................... 1885
3.3.1.7 API calls to OCXs ............................................................................................................ 1894
3.3.2 Structures ...................................................................................................................... 1895
3.3.2.1 LINKINFO....................................................................................................................... 1895
3.3.2.2 MULTILINK ..................................................................................................................... 1897
3.3.2.3 MULTILINKINFO ............................................................................................................. 1898
3.3.2.4 FOCUSINFO ................................................................................................................... 1899
3.3.3 General functions .......................................................................................................... 1899
3.3.3.1 PDLRTClosePicture.......................................................................................................... 1899
3.3.3.2 PDLRTDisableClosePicture .............................................................................................. 1901
3.3.3.3 PDLRTEnableClosePicture ............................................................................................... 1903
3.3.3.4 PDLRTGotoPicture .......................................................................................................... 1904
3.3.3.5 PDLRTInquireFreeArea .................................................................................................... 1906
3.3.3.6 PDLRTOpenPicture ......................................................................................................... 1907
3.3.3.7 PDLRTPictureNavigation ................................................................................................. 1910
3.3.3.8 PDLRTShowApp ............................................................................................................. 1911
3.3.3.9 PDLRT_CALLBACK........................................................................................................... 1912
3.3.4 Functions for affecting the runtime cursor ...................................................................... 1914
3.3.4.1 PDLRTGetCursorKeys ...................................................................................................... 1914
3.3.4.2 PDLRTGetFocus .............................................................................................................. 1916
3.3.4.3 PDLRTSetCursorKeys ...................................................................................................... 1918
3.3.4.4 PDLRTSetFocus .............................................................................................................. 1920
3.3.5 Functions for processing object properties...................................................................... 1922
3.3.5.1 PDLRTGetDefPropEx ....................................................................................................... 1922
3.3.5.2 PDLRTGetPropEx ............................................................................................................ 1925
3.3.5.3 PDLRTSetPropEx............................................................................................................. 1928
3.3.6 Functions for processing dynamics ................................................................................. 1932
3.3.6.1 PDLRTGetLink................................................................................................................. 1932
3.3.6.2 PDLRTSetLink ................................................................................................................. 1934
3.3.6.3 PDLRTSetMultiLink ......................................................................................................... 1936
3.4 Scripting functions......................................................................................................... 1938
3.4.1 Basics ............................................................................................................................ 1938
3.4.1.1 Overview of the functions .............................................................................................. 1938
3.4.1.2 Overview of structures ................................................................................................... 1938
3.4.1.3 Error messages .............................................................................................................. 1939
3.4.1.4 Constants ...................................................................................................................... 1941
3.4.2 Structures ...................................................................................................................... 1943

WinCC Engineering V18 – Programming reference

14 System Manual, 11/2022, Online documentation
 Table of contents

3.4.2.1 AP_ACT_KEY .................................................................................................................. 1943

3.4.2.2 AP_ACT_RESULT_STRUCT................................................................................................ 1945
3.4.2.3 CREATE_USER_HEADER_FILE........................................................................................... 1946
3.4.2.4 GENERATE_COMPILE ...................................................................................................... 1947
3.4.2.5 GET_ACTION_STREAM.................................................................................................... 1947
3.4.3 General functions .......................................................................................................... 1948
3.4.3.1 APConnect..................................................................................................................... 1948
3.4.3.2 APDisconnect................................................................................................................. 1950
3.4.3.3 APSetLanguage.............................................................................................................. 1952
3.4.3.4 AP_RT_PROC .................................................................................................................. 1953
3.4.4 Functions for processing Source Code ............................................................................ 1956
3.4.4.1 APCompile ..................................................................................................................... 1956
3.4.4.2 APCompileEx ................................................................................................................. 1958
3.4.4.3 GSCGenCompile ............................................................................................................ 1961
3.4.4.4 GSCGenCompileUserFunctions ....................................................................................... 1962
3.4.5 Functions for processing actions..................................................................................... 1964
3.4.5.1 GSCGenGetActionStream ............................................................................................... 1964
3.4.6 Functions of the action programming............................................................................. 1965
3.4.6.1 APActive ........................................................................................................................ 1965
3.4.6.2 APEndAct....................................................................................................................... 1967
3.4.6.3 APFreeResultStruct......................................................................................................... 1968
3.4.6.4 APInactive...................................................................................................................... 1969
3.4.6.5 APStart .......................................................................................................................... 1971
3.4.6.6 APTransact..................................................................................................................... 1974
3.4.7 Examples ....................................................................................................................... 1976
3.4.7.1 Establish connection to script programming ................................................................... 1976
3.5 Functions of the user administration .............................................................................. 1978
3.5.1 Basics ............................................................................................................................ 1978
3.5.1.1 Overview of the functions .............................................................................................. 1978
3.5.1.2 Overview of structures ................................................................................................... 1979
3.5.1.3 Error messages .............................................................................................................. 1980
3.5.1.4 Constants ...................................................................................................................... 1981
3.5.2 Structures ...................................................................................................................... 1981
3.5.2.1 PWGEN_GROUPINFO ...................................................................................................... 1981
3.5.2.2 PWGEN_LEVELINFO........................................................................................................ 1982
3.5.2.3 PWGEN_USERINFO ......................................................................................................... 1983
3.5.3 General functions .......................................................................................................... 1983
3.5.3.1 PWGENConnect ............................................................................................................. 1983
3.5.3.2 PWGENDisconnect ......................................................................................................... 1985
3.5.4 Functions for processing users ....................................................................................... 1986
3.5.4.1 PWGENAddUser ............................................................................................................. 1986
3.5.4.2 PWGENAddUserEx.......................................................................................................... 1988
3.5.4.3 PWGENChangePassword ................................................................................................ 1990
3.5.4.4 PWGENCheckUser .......................................................................................................... 1991
3.5.4.5 PWGENDeleteUser.......................................................................................................... 1992
3.5.4.6 PWGENEnumUsers ......................................................................................................... 1994
3.5.4.7 PWGEN_ENUM_USERS_CALLBACK .................................................................................. 1995
3.5.5 Functions for processing user groups.............................................................................. 1997
3.5.5.1 PWGENAddGroup........................................................................................................... 1997
3.5.5.2 PWGENEnumGroups ...................................................................................................... 1998
3.5.5.3 PWGEN_ENUM_GROUPS_CALLBACK ............................................................................... 2000
3.5.6 Functions for processing authorizations.......................................................................... 2001

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 15
Table of contents

3.5.6.1 PWGENAddPermLevel .................................................................................................... 2001

3.5.6.2 PWGENCheckPermission................................................................................................. 2002
3.5.6.3 PWGENDeletePermLevel................................................................................................. 2004
3.5.6.4 PWGENEnumPermLevels ................................................................................................ 2005
3.5.6.5 PWGEN_ENUM_LEVELS_CALLBACK ................................................................................. 2006
3.5.6.6 PWGENReadUserPerm .................................................................................................... 2008
3.5.6.7 PWRTCheckPermission.................................................................................................... 2009
3.5.6.8 PWRTCheckPermissionOnPicture..................................................................................... 2010
3.5.6.9 PWRTPermissionLevelDialog ........................................................................................... 2011
3.5.6.10 PWRTPermissionLevelDialogEx........................................................................................ 2012
3.5.6.11 PWRTPermissionToString ................................................................................................ 2013
3.5.7 Functions for logon, logoff ............................................................................................. 2014
3.5.7.1 PWRTGetCurrentUser ..................................................................................................... 2014
3.5.7.2 PWRTGetLoginPriority..................................................................................................... 2015
3.5.7.3 PWRTIsLoggedInByCard.................................................................................................. 2016
3.5.7.4 PWRTLogin .................................................................................................................... 2017
3.5.7.5 PWRTLogout .................................................................................................................. 2019
3.5.7.6 PWRTLogoutEx............................................................................................................... 2020
3.5.7.7 PWRTSilentLogin ............................................................................................................ 2021
3.5.7.8 PWRTSilentLoginEx ........................................................................................................ 2022
3.5.8 Examples ....................................................................................................................... 2024
3.5.8.1 PWRT check permission .................................................................................................. 2024
3.5.8.2 Checks admission of a certain level for a screen .............................................................. 2025
3.5.8.3 Gets a string associated with the permission number...................................................... 2026
3.5.8.4 Authorization level query through a dialog with specifying a possible error ..................... 2027
3.5.8.5 Return the name of the current user............................................................................... 2028
3.5.8.6 Queries the current logon priority .................................................................................. 2029
3.5.8.7 Checks if the user has been logged on by card ................................................................ 2029
3.5.8.8 PWRT login - dialog provided by WinCC itself .................................................................. 2031
3.5.8.9 PWRT logoff ................................................................................................................... 2032
3.5.8.10 Silent logoff with priority level........................................................................................ 2033
3.5.8.11 Logon without using a dialog ......................................................................................... 2034
3.5.8.12 Silent logon with priority level........................................................................................ 2035
3.6 Functions of the text system .......................................................................................... 2036
3.6.1 Basics ............................................................................................................................ 2036
3.6.1.1 Overview of the functions .............................................................................................. 2036
3.6.1.2 Error messages .............................................................................................................. 2036
3.6.1.3 Language codes............................................................................................................. 2038
3.6.2 General functions .......................................................................................................... 2039
3.6.2.1 TXTCloseProject ............................................................................................................. 2039
3.6.2.2 TXTGetMaxTextID........................................................................................................... 2041
3.6.2.3 TXTOpenProject ............................................................................................................. 2042
3.6.2.4 TXTRTConnect ............................................................................................................... 2043
3.6.2.5 TXTRTDisconnect ........................................................................................................... 2044
3.6.3 Functions for processing infotext.................................................................................... 2046
3.6.3.1 TXTEnumInfoText........................................................................................................... 2046
3.6.3.2 TXT_ENUM_INFOTEXTS_PROC ........................................................................................ 2048
3.6.3.3 TXTUpdateRuntime ........................................................................................................ 2049
3.6.3.4 TXTRTGetInfoText........................................................................................................... 2050
3.6.3.5 TXTRTGetInfoTextMC...................................................................................................... 2052
3.6.4 Functions for processing languages................................................................................ 2054
3.6.4.1 TXTEnumLanguages ...................................................................................................... 2054

WinCC Engineering V18 – Programming reference

16 System Manual, 11/2022, Online documentation
 Table of contents

3.6.4.2 TXT_ENUM_LANGUAGES_PROC...................................................................................... 2055

3.6.4.3 TXTGetFont.................................................................................................................... 2057
3.6.4.4 TXTShowLanguagesDialog ............................................................................................. 2058
3.6.4.5 TXTRTGetLanguageID..................................................................................................... 2060
3.6.4.6 TXTRTSetLanguage ........................................................................................................ 2061
3.6.5 Examples ....................................................................................................................... 2063
3.6.5.1 Get infotext ................................................................................................................... 2063
3.6.5.2 Enumerate infotexts....................................................................................................... 2065
3.7 Report system functions................................................................................................. 2067
3.7.1 Basics ............................................................................................................................ 2067
3.7.1.1 Overview of the functions .............................................................................................. 2067
3.7.1.2 Constants ...................................................................................................................... 2068
3.7.1.3 Error messages .............................................................................................................. 2070
3.7.1.4 List of object properties.................................................................................................. 2071
3.7.1.5 General procedure for processing print job properties (Report Designer) ......................... 2076
3.7.2 Functions for establishing connections........................................................................... 2079
3.7.2.1 RPJAttach....................................................................................................................... 2079
3.7.2.2 RPJDetach ...................................................................................................................... 2080
3.7.2.3 RPJMemFree .................................................................................................................. 2081
3.7.3 Functions for processing project properties..................................................................... 2082
3.7.3.1 RPJGetNumProjectProperties .......................................................................................... 2082
3.7.3.2 RPJGetProjectPropertyAt................................................................................................. 2083
3.7.3.3 RPJGetProjectProperty .................................................................................................... 2084
3.7.3.4 RPJProjectLock ............................................................................................................... 2085
3.7.3.5 RPJProjectUnlock ............................................................................................................ 2087
3.7.3.6 RPJProjectUnlockAll ........................................................................................................ 2088
3.7.4 Functions for processing print jobs ................................................................................. 2089
3.7.4.1 RPJCreateJob.................................................................................................................. 2089
3.7.4.2 RPJDeleteJob.................................................................................................................. 2090
3.7.4.3 RPJCreatePropertyHandle ............................................................................................... 2092
3.7.4.4 RPJDeletePropertyHandle ............................................................................................... 2093
3.7.4.5 RPJGetJobNameAt .......................................................................................................... 2095
3.7.4.6 RPJGetNumJobs ............................................................................................................. 2096
3.7.4.7 RPJJobLock..................................................................................................................... 2097
3.7.4.8 RPJJobUnlock ................................................................................................................. 2099
3.7.4.9 RPJJobUnlockAll ............................................................................................................. 2100
3.7.5 Functions for processing print job methods .................................................................... 2102
3.7.5.1 RPJCallJobMethod .......................................................................................................... 2102
3.7.5.2 RPJGetJobMethodAt ....................................................................................................... 2103
3.7.5.3 RPJGetNumJobMethods ................................................................................................. 2104
3.7.6 Functions for processing print job methods .................................................................... 2105
3.7.6.1 RPJGetJobPropertyAt ...................................................................................................... 2105
3.7.6.2 RPJGetJobProps .............................................................................................................. 2107
3.7.6.3 RPJGetNumJobProperties ............................................................................................... 2108
3.7.6.4 RPJGetProperty .............................................................................................................. 2109
3.7.6.5 RPJPropertyClear ............................................................................................................ 2112
3.7.6.6 RPJSetProperty ............................................................................................................... 2113
3.7.7 Examples ....................................................................................................................... 2117
3.7.7.1 Get print job method name ............................................................................................ 2117
3.7.7.2 Get print job names ....................................................................................................... 2120
3.7.7.3 Get print job properties .................................................................................................. 2123
3.7.7.4 Modify print job properties............................................................................................. 2126

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 17
Table of contents

3.7.7.5 Show print job preview .................................................................................................. 2131

3.8 Tag and log functions..................................................................................................... 2134
3.8.1 Basics ............................................................................................................................ 2134
3.8.1.1 Overview of the functions .............................................................................................. 2134
3.8.1.2 Overview of structures ................................................................................................... 2135
3.8.1.3 Error messages .............................................................................................................. 2136
3.8.1.4 Constants ...................................................................................................................... 2137
3.8.2 Structures ...................................................................................................................... 2147
3.8.2.1 TLG_ARCHIV_STR ........................................................................................................... 2147
3.8.2.2 TLG_ARCHIVDATARAW.................................................................................................... 2150
3.8.2.3 TLG_BACKUP_TABLE_INFO.............................................................................................. 2153
3.8.2.4 TLG_CURVESCALEX ........................................................................................................ 2155
3.8.2.5 TLG_CURVESCALEY ........................................................................................................ 2160
3.8.2.6 TLG_GETARCHIVDATA ..................................................................................................... 2164
3.8.2.7 TLG_IO_BACKUP_SELECT ................................................................................................ 2165
3.8.2.8 TLG_PROT_CURVE_INFOS ............................................................................................... 2166
3.8.2.9 TLG_SCAL_STR ............................................................................................................... 2168
3.8.2.10 TLG_TABLE_INFO............................................................................................................ 2169
3.8.2.11 TLG_TABLESCALE ........................................................................................................... 2170
3.8.2.12 TLG_TEMPLATEITEM_INFO ............................................................................................. 2173
3.8.2.13 TLG_TIME_STR ............................................................................................................... 2175
3.8.2.14 TLG_TIMEDATA............................................................................................................... 2176
3.8.2.15 TLG_TPLITEM_CURVE ..................................................................................................... 2177
3.8.2.16 TLG_TPLITEM_INFO ........................................................................................................ 2178
3.8.2.17 TLG_TPLITEM_TABLE ...................................................................................................... 2179
3.8.2.18 TLG_VAR_STR................................................................................................................. 2180
3.8.2.19 TLG_VARIABLE_INFO ...................................................................................................... 2185
3.8.3 General functions .......................................................................................................... 2186
3.8.3.1 TLGCSConnect ............................................................................................................... 2186
3.8.3.2 TLGCSConnectEx............................................................................................................ 2188
3.8.3.3 TLGCSDisConnect........................................................................................................... 2189
3.8.3.4 TLGChangeLanguage ..................................................................................................... 2190
3.8.3.5 TLGConnect ................................................................................................................... 2191
3.8.3.6 TLGDisconnect............................................................................................................... 2193
3.8.4 Project management functions....................................................................................... 2194
3.8.4.1 TLGCloseProject ............................................................................................................. 2194
3.8.4.2 TLGOpenProject ............................................................................................................. 2195
3.8.4.3 TLGEnumProject ............................................................................................................ 2198
3.8.4.4 TLG_ENUM_PROJECT_NAME_CALLBACK ......................................................................... 2199
3.8.5 Functions for processing tags ......................................................................................... 2200
3.8.5.1 TLGEnumVariables ......................................................................................................... 2200
3.8.5.2 TLG_ENUM_VARIABLE_NAME_CALLBACK........................................................................ 2201
3.8.5.3 TLGEnumVariablesEx...................................................................................................... 2202
3.8.5.4 TLG_ENUMVARIABLES .................................................................................................... 2204
3.8.5.5 TLGReadVariable ............................................................................................................ 2205
3.8.6 Functions for processing logs ......................................................................................... 2207
3.8.6.1 TLGEnumArchives .......................................................................................................... 2207
3.8.6.2 TLG_ENUM_ARCHIV_CALLBACK ...................................................................................... 2208
3.8.6.3 TLGEnumArchivs............................................................................................................ 2210
3.8.6.4 TLGEnumArchivsEx ........................................................................................................ 2212
3.8.6.5 TLGEnumArchivsSel ....................................................................................................... 2213
3.8.6.6 TLG_ENUMTABLES.......................................................................................................... 2215

WinCC Engineering V18 – Programming reference

18 System Manual, 11/2022, Online documentation
 Table of contents

3.8.6.7 TLGFreeMemory ............................................................................................................ 2217

3.8.6.8 TLGGetArchivData.......................................................................................................... 2218
3.8.6.9 TLG_GETARCHIVDATA_CALLBACK.................................................................................... 2220
3.8.6.10 TLGGetArchivDataEx ...................................................................................................... 2222
3.8.6.11 TLGGetClosestTime ........................................................................................................ 2224
3.8.6.12 TLGGetClosestTimeEx .................................................................................................... 2226
3.8.6.13 TLGInsertArchivData ...................................................................................................... 2228
3.8.6.14 TLGLockArchiv ............................................................................................................... 2231
3.8.6.15 TLGLockVariable............................................................................................................. 2232
3.8.6.16 TLGReadArchiv............................................................................................................... 2234
3.8.7 Functions for trend and table views................................................................................ 2235
3.8.7.1 TLGCloseWindow ........................................................................................................... 2235
3.8.7.2 TLGDrawCurvesInDC ...................................................................................................... 2236
3.8.7.3 TLGInsertTemplateItem .................................................................................................. 2238
3.8.7.4 TLGPressToolbarButton................................................................................................... 2239
3.8.7.5 TLGSetRulerWindowVisible............................................................................................. 2241
3.8.7.6 TLGShowWindow........................................................................................................... 2242
3.8.8 Functions for processing time systems............................................................................ 2244
3.8.8.1 TLGEnumTime ............................................................................................................... 2244
3.8.8.2 TLG_ENUM_TIME_NAME_CALLBACK............................................................................... 2245
3.8.8.3 TLGEnumTimes.............................................................................................................. 2246
3.8.8.4 TLG_ENUMTIMES_CALLBACK.......................................................................................... 2248
3.8.8.5 TLGReadTime................................................................................................................. 2249
3.8.9 Functions for saving and restoring.................................................................................. 2250
3.8.9.1 TLGEnumBackupEntries ................................................................................................. 2250
3.8.9.2 TLG_ENUMBACKUP_ENTRIES .......................................................................................... 2252
3.8.9.3 TLGExport...................................................................................................................... 2253
3.8.9.4 TLGGetBackupSize ......................................................................................................... 2255
3.8.10 Examples ....................................................................................................................... 2257
3.8.10.1 Edit curve template - Example 1 ..................................................................................... 2257
3.8.10.2 Enum all acquisition and logging times .......................................................................... 2260
3.8.10.3 Enum logs ..................................................................................................................... 2263
3.8.10.4 Enum tags of a log ......................................................................................................... 2266
3.8.10.5 Enumerate logs.............................................................................................................. 2268
3.8.10.6 Read log ........................................................................................................................ 2270
3.8.10.7 Read parameters of time object...................................................................................... 2274
3.9 Recipe functions ............................................................................................................ 2276
3.9.1 Basics ............................................................................................................................ 2276
3.9.1.1 Overview of the functions .............................................................................................. 2276
3.9.1.2 Structure of recipes ........................................................................................................ 2278
3.9.1.3 Dependencies in call sequence of API functions .............................................................. 2280
3.9.1.4 Error messages .............................................................................................................. 2281
3.9.1.5 Constants ...................................................................................................................... 2282
3.9.2 Structures ...................................................................................................................... 2284
3.9.2.1 uaCONFIGARCHIVE......................................................................................................... 2284
3.9.2.2 uaCONFIGFIELD ............................................................................................................. 2286
3.9.3 General functions .......................................................................................................... 2287
3.9.3.1 uaGetLastError............................................................................................................... 2287
3.9.3.2 uaIsActive ...................................................................................................................... 2289
3.9.3.3 uaUsers ......................................................................................................................... 2290
3.9.3.4 uaSetLocalEvents ........................................................................................................... 2291
3.9.4 Functions for generating connections ............................................................................ 2292

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 19
Table of contents

3.9.4.1 uaConnect ..................................................................................................................... 2292

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

WinCC Engineering V18 – Programming reference

20 System Manual, 11/2022, Online documentation
 Table of contents

3.9.10.3 uaArchiveWriteTagValues ............................................................................................... 2346

3.9.10.4 uaArchiveWriteTagValuesByName................................................................................... 2348
3.10 Alarm functions ............................................................................................................. 2349
3.10.1 Basics ............................................................................................................................ 2349
3.10.1.1 Overview of the functions .............................................................................................. 2349
3.10.1.2 Overview of structures ................................................................................................... 2350
3.10.1.3 Error messages .............................................................................................................. 2350
3.10.1.4 Constants ...................................................................................................................... 2352
3.10.2 Structures ...................................................................................................................... 2364
3.10.2.1 MSG_BACKUP_STRUCT_PLUS .......................................................................................... 2364
3.10.2.2 MSG_CLASS_STRUCT_PLUS ............................................................................................ 2366
3.10.2.3 MSG_COMMENT_INSTANCE_STRUCT_PLUS..................................................................... 2368
3.10.2.4 MSG_CSDATA_STRUCT_PLUS .......................................................................................... 2370
3.10.2.5 MSG_CSDATA_EX_STRUCT_PLUS..................................................................................... 2372
3.10.2.6 MSG_FILTER_STRUCT_PLUS ............................................................................................ 2375
3.10.2.7 MSG_HELPTEXTS_STRUCT_PLUS ..................................................................................... 2379
3.10.2.8 MSG_INFOTEXT_STRUCT_PLUS ....................................................................................... 2382
3.10.2.9 MSG_RTCREATE_STRUCT_PLUS ....................................................................................... 2383
3.10.2.10 MSG_RTDATA_INSTANCE_STRUCT_PLUS.......................................................................... 2385
3.10.2.11 MSG_RTDATA_INSTANCECOMMENT_STRUCT_PLUS ......................................................... 2388
3.10.2.12 MSG_RTGROUPENUM_STRUCT_PLUS .............................................................................. 2392
3.10.2.13 MSG_RTGROUPSET_STRUCT_PLUS .................................................................................. 2393
3.10.2.14 MSG_RTLOCK_STRUCT_PLUS .......................................................................................... 2394
3.10.2.15 MSG_TEXTVAL256_STRUCT_PLUS .................................................................................. 2395
3.10.2.16 MSGULONGLONG .......................................................................................................... 2396
3.10.3 General functions .......................................................................................................... 2397
3.10.3.1 MSRTStartMsgServicePlus .............................................................................................. 2397
3.10.3.2 MSRTStopMsgServicePlus............................................................................................... 2400
3.10.3.3 MSRTQuitHornPlus......................................................................................................... 2402
3.10.3.4 MSG_SERVICE_NOTIFY_PROC_PLUS ................................................................................ 2403
3.10.3.5 MSG_TAID_COMPLETION_PROC_PLUS............................................................................. 2406
3.10.3.6 MSRTWebClientPlus ....................................................................................................... 2408
3.10.4 Functions for protocol processing .................................................................................. 2409
3.10.4.1 MSRTActivateMProtPlus.................................................................................................. 2409
3.10.4.2 MSRTPrintMProtPlus....................................................................................................... 2410
3.10.5 Functions for alarm processing....................................................................................... 2411
3.10.5.1 MSRTCreateMsgInstanceWithCommentPlus.................................................................... 2411
3.10.5.2 MSRTCreateMsgInstancePlus .......................................................................................... 2413
3.10.5.3 MSRTCreateMsgPlus....................................................................................................... 2415
3.10.5.4 MSRTDialogMsgLockPlus ................................................................................................ 2417
3.10.5.5 MSRTEnumArchivInstancePlus........................................................................................ 2418
3.10.5.6 MSRTEnumLockedMsgPlus ............................................................................................. 2419
3.10.5.7 MSRTEnumMsgRTDataPlus ............................................................................................. 2420
3.10.5.8 MSRTGetClassInfoPlus .................................................................................................... 2421
3.10.5.9 MSRTGetLastMsgWithCommentPlus ............................................................................... 2423
3.10.5.10 MSRTGetMsgAttributesPlus ............................................................................................ 2425
3.10.5.11 MSRTGetMsgActualPlus.................................................................................................. 2427
3.10.5.12 MSRTGetMsgCSDataPlus ................................................................................................ 2428
3.10.5.13 MSRTGetMsgCSDataExPlus............................................................................................. 2432
3.10.5.14 MSG_CSDATA_EX_CALLBACK_PROC_PLUS....................................................................... 2434
3.10.5.15 MSRTGetMsgHelptextsPlus ............................................................................................. 2436
3.10.5.16 MSRTGetMsgPriorityPlus................................................................................................. 2437

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 21
Table of contents

3.10.5.17 MSRTGetMsgQuitPlus..................................................................................................... 2439

3.10.5.18 MSRTGetSelectedMsgPlus .............................................................................................. 2440
3.10.5.19 MSRTLoopInAlarmPlus ................................................................................................... 2442
3.10.5.20 MSRTResetMsgPlus ........................................................................................................ 2444
3.10.6 Functions for alarm group processing ............................................................................. 2446
3.10.6.1 MSRTEnumGroupMsgPlus .............................................................................................. 2446
3.10.6.2 MSRTLockGroupPlus....................................................................................................... 2447
3.10.6.3 MSRTQuitGroupPlus ....................................................................................................... 2449
3.10.7 Functions for alarm filter processing ............................................................................... 2450
3.10.7.1 MSRTGetFilterDataPlus ................................................................................................... 2450
3.10.7.2 MSRTCheckWinFilterPlus ................................................................................................ 2451
3.10.7.3 MSRTSetMsgFilterPlus .................................................................................................... 2453
3.10.7.4 MSRTSetMsgWinFilterPlus .............................................................................................. 2455
3.10.8 Functions for processing alarm view............................................................................... 2456
3.10.8.1 MSRTMsgWinCommandPlus........................................................................................... 2456
3.10.9 Functions for processing comments ............................................................................... 2457
3.10.9.1 MSRTGetCommentInstancePlus...................................................................................... 2457
3.10.9.2 MSRTSetCommentInstancePlus ...................................................................................... 2459
3.10.10 Functions for info text processing................................................................................... 2461
3.10.10.1 MSRTGetInfotextPlus ...................................................................................................... 2461
3.10.10.2 MSRTSetInfotextPlus ...................................................................................................... 2462
3.10.11 Archiving functions ........................................................................................................ 2464
3.10.11.1 MSRTEnumBackupListPlus .............................................................................................. 2464
3.10.11.2 MSRTExportPlus ............................................................................................................. 2465
3.10.11.3 MSRTEnumArchivDataPlus ............................................................................................. 2466
3.11 Functions for displaying the PLC code ............................................................................. 2469
3.11.1 Display in STEP 7............................................................................................................ 2469
3.11.1.1 Basics ............................................................................................................................ 2469
3.11.1.2 OpenTIAPortalProject ..................................................................................................... 2470
3.11.1.3 OpenTIAPortalIECPLByCall .............................................................................................. 2471
3.11.1.4 OpenTIAPortalIECPLByAssignment.................................................................................. 2474
3.11.1.5 OpenTIAPortalS7GraphByBlock....................................................................................... 2476
3.11.1.6 Example: Integration in a WinCC function....................................................................... 2478
3.11.2 Display in the PLC code display ....................................................................................... 2479
3.11.2.1 Basics ............................................................................................................................ 2479
3.11.2.2 OpenViewerS7GraphByBlock.......................................................................................... 2479
3.11.2.3 OpenViewerIECPLByCall ................................................................................................. 2482
3.11.2.4 OpenViewerIECPLByFCCall ............................................................................................. 2485
3.11.2.5 OpenViewerIECPLByAssignment..................................................................................... 2488
3.11.2.6 IsJumpableProDiagAlarm................................................................................................ 2491
3.11.3 Error-handling ............................................................................................................... 2493
3.12 Functions for displaying the PLC code in an external application...................................... 2495
3.12.1 Basics ............................................................................................................................ 2495
3.12.2 Querying static information of networks ........................................................................ 2497
3.12.2.1 Initialize......................................................................................................................... 2497
3.12.2.2 InitializeEx ..................................................................................................................... 2497
3.12.2.3 SetLanguage.................................................................................................................. 2498
3.12.2.4 RequestByAssignment.................................................................................................... 2499
3.12.2.5 RequestByAssignmentEx ................................................................................................ 2500
3.12.2.6 RequestByCall ................................................................................................................ 2501
3.12.2.7 RequestByCallEx............................................................................................................. 2503

WinCC Engineering V18 – Programming reference

22 System Manual, 11/2022, Online documentation
 Table of contents

3.12.2.8 CancelRequest ............................................................................................................... 2504

3.12.2.9 Terminate ...................................................................................................................... 2504
3.12.2.10 Structure of the XML data .............................................................................................. 2505
3.12.3 Querying dynamic statistical information of networks .................................................... 2508
3.12.3.1 StartDynamicDataSubscription ....................................................................................... 2508
3.12.3.2 StartDynamicDataSubscriptionEx ................................................................................... 2509
3.12.3.3 StopDynamicDataSubscription ....................................................................................... 2510
3.12.3.4 StopDynamicDataSubscriptionEx .................................................................................... 2511
3.13 Troubleshooting............................................................................................................. 2511
3.13.1 CMN_ERROR .................................................................................................................. 2511
3.13.2 CCStorageError.h ........................................................................................................... 2513
Index ................................................................................................................................................ 2523

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 23
Table of contents

WinCC Engineering V18 – Programming reference

24 System Manual, 11/2022, Online documentation
VB scripting 1
1.1 System functions

1.1.1 AcknowledgeAlarm

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

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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 25
VB scripting
1.1 System functions

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.

Use in the function list

ActivatePLCCodeView(Screen name, Screen object)

Use in user-defined functions

ActivatePLCCodeView Screen_name, Object_name

WinCC Engineering V18 – Programming reference

26 System Manual, 11/2022, Online documentation
 VB scripting
1.1 System functions

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

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

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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 27
VB scripting
1.1 System functions

Use in the function list

ActivatePreviousScreen

Use in user-defined functions

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

Parameter
--

1.1.4 ActivateScreen

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.

Use in the function list

ActivateScreen (Screen name, Object number)

Use in user-defined functions

ActivateScreen Screen_name, Object_number
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

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.

WinCC Engineering V18 – Programming reference

28 System Manual, 11/2022, Online documentation
 VB scripting
1.1 System functions

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

Description
Performs a screen change to a screen depending on a tag value.
The screen is identified by its screen number.

Use in the function list

ActivateScreenByNumber (Screen number, Object number)

Use in user-defined functions

ActivateScreenByNumber Screen_number, Object_number
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 29
VB scripting
1.1 System functions

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 change. The number of the operator control element is to be determined using the
tabulator sequence during configuration.
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.

1.1.6 ActivateSystemDiagnosticsView

Description
Activates the system diagnostics view. The system diagnostics view shows the detail view of the
device concerned.

Use in the function list

ActivateSystemDiagnosticsView (Screen name, Screen object)

Use in user-defined functions

ActivateSystemDiagnosticsView Screen_name, Object_name
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

Parameters

Screen name
Name of the screen contained in the system diagnostics view.

Screen object
Object name of the system diagnostics view.

WinCC Engineering V18 – Programming reference

30 System Manual, 11/2022, Online documentation
 VB scripting
1.1 System functions

1.1.7 ArchiveLogFile

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.

Use in the function list

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

Use in user-defined functions

ArchiveLogFile Log_type, Log, Directory_name, Mode
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 31
VB scripting
1.1 System functions

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

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.

WinCC Engineering V18 – Programming reference

32 System Manual, 11/2022, Online documentation
 VB scripting
1.1 System functions

Use in the function list

BackupRAMFileSystem

Use in user-defined functions

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

Parameter
--

1.1.9 CalibrateTouchScreen

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.

Use in the function list

CalibrateTouchScreen

Use in user-defined functions

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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 33
VB scripting
1.1 System functions

Parameter
--

Note
The CalibrateTouchScreen system function cannot be simulated.

1.1.10 ChangeConnection

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

Use in the function list

ChangeConnection (Connection, Address, Slot, Rack)

Use in user-defined functions

ChangeConnection Connection, Address, Slot, Rack
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

WinCC Engineering V18 – Programming reference

34 System Manual, 11/2022, Online documentation
 VB scripting
1.1 System functions

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

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).

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 35
VB scripting
1.1 System functions

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

Use in the function list

ChangeConnectionEIP (Connection, Address, Communication path)

Use in user-defined functions

ChangeConnectionEIP Connection, Address, Communication_path
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

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.

WinCC Engineering V18 – Programming reference

36 System Manual, 11/2022, Online documentation
 VB scripting
1.1 System functions

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

Description
Deletes alarms from the alarm buffer on the HMI device.

Note
Alarms which have not yet been acknowledged are also deleted.

Use in the function list

ClearAlarmBuffer (Alarm class number)

Use in user-defined functions

ClearAlarmBuffer Alarm_class_number
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

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"

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 37
VB scripting
1.1 System functions

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

Description
The system function exists to ensure compatibility.
It has the same functionality as the "ClearAlarmBuffer" system function, but uses the old
ProTool numbering.

Use in the function list

ClearAlarmBufferProTool (Alarm class number)

Use in user-defined functions

ClearAlarmBufferProtoolLegacy Alarm_class_number
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

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.

WinCC Engineering V18 – Programming reference

38 System Manual, 11/2022, Online documentation
 VB scripting
1.1 System functions

1.1.14 ClearDataRecord

Description
Deletes a recipe data record.
Several data records can be deleted from one or more recipes.

Use in the function list

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

Use in user-defined functions

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

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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 39
VB scripting
1.1 System functions

12 = System function was not performed because an error has occurred.

You can only use an HMI tag for the parameter.

1.1.15 ClearDataRecordMemory

Description
Deletes all recipes data records from the specified storage medium.

Use in the function list

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

Use in user-defined functions

ClearDataRecordMemory Storage_location, Confirmation, Output_status_message,
Processing_status
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

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 2
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.

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.

WinCC Engineering V18 – Programming reference

40 System Manual, 11/2022, Online documentation
 VB scripting
1.1 System functions

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.
12 = System function was not performed because an error has occurred.
You can only use an HMI tag for the parameter.

1.1.16 ClearLog

Description
Deletes all data records in the given log.

Use in the function list

ClearLog (Log type, Log)

Use in user-defined functions

ClearLog Log_type, Log
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

Parameter

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 from which all entries are deleted.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 41
VB scripting
1.1 System functions

1.1.17 CloseAllLogs

Description
Disconnects the connection between WinCC and all logs.

Use in the function list

CloseAllLogs

Use in user-defined functions

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

Parameter
--

Application example
You are in runtime and want to change the data medium on which the process values are logged.
Notes on configuring
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.
Procedure on HMI device
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

Description
Starts or stops the Sm@rtServer.

WinCC Engineering V18 – Programming reference

42 System Manual, 11/2022, Online documentation
 VB scripting
1.1 System functions

Use in the function list

ControlSmartServer (Mode)

Use in user-defined functions

ControlSmartServer Mode
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

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

Description
Starts or stops the Web server.

Use in the function list

ControlWebServer (Mode)

Use in user-defined functions

ControlWebServer Mode
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

Parameter

Mode
Specifies whether the Web server is started or stopped.
-1 (hmiToggle) = Toggle: Toggles between the two modes
0 (hmiStop) = Stop: The Web server is stopped.
1 (hmiStart) = Start: The Web server is started.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 43
VB scripting
1.1 System functions

1.1.20 CopyLog

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.

Use in the function list

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

Use in user-defined functions

CopyLog Log_type, Destination log, Source_log, Mode, Delete_source_log
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

Parameter

Log type
Determines the type of log:
0 (hmiTagArchive) = Tag log
1 (hmiAlarmArchive) = Alarm log

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.

WinCC Engineering V18 – Programming reference

44 System Manual, 11/2022, Online documentation
 VB scripting
1.1 System functions

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

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.

Use in the function list

DecreaseTag (Tag, Value)

Use in user-defined functions

DecreaseTag Tag, Value
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

Parameter

Tag
The tag from which the given value is subtracted.

Value
The value which is subtracted.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 45
VB scripting
1.1 System functions

1.1.22 EditAlarm

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.
This system function can only be used for function keys.

Use in the function list

EditAlarm

Use in user-defined functions

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

Parameters
--

1.1.23 Encode

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.

Use in the function list

Encode (Byte array, String, Coding)

Use in user-defined functions

Encode Byte_array, String, Encoding
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

WinCC Engineering V18 – Programming reference

46 System Manual, 11/2022, Online documentation
 VB scripting
1.1 System functions

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

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.

Use in the function list

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

Use in user-defined functions

EncodeEx Byte_array, String, Encoding, Line_break
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 47
VB scripting
1.1 System functions

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

Description
Exports one or all data records of a recipe to a CSV file or a TXT file.
One file is created per recipe.

Use in the function list

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

Use in user-defined functions

ExportDataRecords Recipe_number/name, Data_record number/name, File_name, Overwrite,
Output_status_message, Processing_status
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

WinCC Engineering V18 – Programming reference

48 System Manual, 11/2022, Online documentation
 VB scripting
1.1 System functions

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.

Data record number/name

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.

Output status message

Determines whether a status message is output after the export:
0 (hmiOff) = Off: Status message is not output.
1 (hmiOn) = On: Status message is output.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 49
VB scripting
1.1 System functions

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.
12 = System function was not performed because an error has occurred.
You can only use an HMI tag for the parameter.

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.
Notes on configuring
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.
Procedure on HMI device
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 event is output.

WinCC Engineering V18 – Programming reference

50 System Manual, 11/2022, Online documentation
 VB scripting
1.1 System functions

1.1.26 ExportDataRecordsWithChecksum

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.

Use in the function list

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

Use in user-defined functions

ExportDataRecordsWithChecksum Recipe_number_or_name, Data_record number_or_name,
File_name, Overwrite, Output_status_message, Processing_status
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

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.

Data record number/name

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:

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 51
VB scripting
1.1 System functions

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.

Output status message

Determines whether a status message is output after the export:
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.
12 = System function was not performed because an error has occurred.
You can only use an HMI tag for the parameter.

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.
Notes on configuring
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

WinCC Engineering V18 – Programming reference

52 System Manual, 11/2022, Online documentation
 VB scripting
1.1 System functions

• 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.
Procedure on HMI device
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 and assigned
checksums. If the file already exists, it will be overwritten.
After exporting the data records, a system event is output.

1.1.27 ExportImportUserAdministration

Description
Exports all users of the user administration of the currently active project to the specified file or
imports the users from the specified file to the currently active project.
Users, their passwords and rights are saved in the user administration.
The export/import of the user administration configuration encompasses all the settings.
Existing objects (users, groups, logon settings, authorization levels) are overwritten during
the import.
The imported users are valid immediately.

Use in the function list

ExportImportUserAdministration (File name, Direction)

Use in user-defined functions

ExportImportUserAdministration File_name, Direction
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 53
VB scripting
1.1 System functions

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.1.28 GetBrightness

Description
Reads the value of the brightness.

Use in the function list

GetBrightness (Brightness)

Use in user-defined functions

GetBrightness Brightness
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

Parameter

Brightness
The tag to which the value is written.

WinCC Engineering V18 – Programming reference

54 System Manual, 11/2022, Online documentation
 VB scripting
1.1 System functions

1.1.29 GetDataRecordFromPLC

Description
Transfers the selected recipe data record from PLC to the storage medium of the HMI device.

Use in the function list

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

Use in user-defined functions

GetDataRecordFromPLC Recipe_number_or_name, Data_record_number_or_name, Overwrite,
Output_status_message, Processing_status
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

Parameters

Recipe number/name
Number or name of the recipe from which recipe data records are transferred.

Data record number/name

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.

Output status message

Determines whether a status message is output after the transfer:
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:

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 55
VB scripting
1.1 System functions

2 = System function is being performed.

4 = System function was successfully completed.
12 = System function was not performed because an error has occurred.
You can only use an HMI tag for the parameter.

Application example
You want to transfer a data record from the PLC to the data medium of the HMI device using a
key.
Notes on configuring
Configure the "GetDataRecordFromPLC" system function on the "Press" event for the desired
key. Transfer the following parameters:
Recipe number/name = 1
Data record number/name = 1
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 record is transferred from the PLC.
Procedure on HMI device
As soon as the key is activated, the system function is triggered. The constants or tags are
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 event is output after the transfer.

1.1.30 GetDataRecordName

Description
Writes the name of the specified recipe and recipe data record to specified 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.

WinCC Engineering V18 – Programming reference

56 System Manual, 11/2022, Online documentation
 VB scripting
1.1 System functions

Use in the function list

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

Use in user-defined functions

GetDataRecordName Recipe_number, Data_record_number, Recipe_name,
Data_record_name, Processing_status
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

Parameters

Recipe number
Number of the recipe whose name is written in the specified tag.

Data record number

Number of the recipe data record, whose name is written to the specified 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
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.
12 = System function was not performed because an error has occurred.
You can only use an HMI tag for the parameter.

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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 57
VB scripting
1.1 System functions

• "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.

1.1.31 GetDataRecordTagsFromPLC

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.

Use in the function list

GetDataRecordTagsFromPLC (Recipe number/name, Processing status)

Use in user-defined functions

GetDataRecordTagsFromPLC Recipe_number_or_name, Processing_status
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

Parameters

Recipe number/name
Number or name of the recipe data record whose values are written from the PLC to the tags.

WinCC Engineering V18 – Programming reference

58 System Manual, 11/2022, Online documentation
 VB scripting
1.1 System functions

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.
12 = System function was not performed because an error has occurred.
You can only use an HMI tag for the parameter.

1.1.32 GetGroupNumber

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.

Use in the function list

GetGroupNumber (Tag)

Use in user-defined functions

GetGroupNumber Tag
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

Parameter

Tag
The tag to which the number of the group is written.

1.1.33 GetPassword

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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 59
VB scripting
1.1 System functions

Note
The passwords of SIMATIC Logon users cannot be read.

Note
The "ReadPassword" 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 "ReadPassword" system
function appears to be faulty in the configuration. A warning is generated during compiling. The
"ReadPassword" system function is no longer included in the compiled Runtime project.

Use in the function list

ReadPassword (tag)

Use in user-defined functions

GetPassword Tag
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

Parameter

Tag
The tag to which the password is written.

1.1.34 GetUserName

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.

Use in the function list

GetUserName (Tag)

Use in user-defined functions

GetUserName Tag

WinCC Engineering V18 – Programming reference

60 System Manual, 11/2022, Online documentation
 VB scripting
1.1 System functions

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

Parameter

Tag
The tag to which the user name is written.

1.1.35 GoToEnd

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.

Use in the function list

GoToEnd

Use in user-defined functions

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

Parameter
--

1.1.36 GoToHome

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.

Use in the function list

GoToHome

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 61
VB scripting
1.1 System functions

Use in user-defined functions

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

Parameter
--

1.1.37 ImportDataRecords

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.

Note
No check of import file for inconsistencies
The import function doesn't check whether values that were changed in the CSV file between the
export and import are still valid, e.g. whether these are still within the defined limits.

Use in the function list

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

Use in user-defined functions

ImportDataRecords File_name, Data_record_number_or_name, Overwrite,
Output_status_message, Processing_status
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

Parameters

File name
Name of the file from which the recipe data records are imported. Also specify the storage
location and the file extension (*.csv or *.txt), e.g. "C:\TEMP\Orange.csv".
For a Basic Panel, specify the file name as follows: "\USB_X60.1\<Name>"
For additional devices: If a memory card is used as the storage location, specify the storage
location as follows: "\StorageCard\<Name>".

WinCC Engineering V18 – Programming reference

62 System Manual, 11/2022, Online documentation
 VB scripting
1.1 System functions

To import all recipe data records, specify only the path to the storage location without a file
name: "C:\TEMP\". The system function imports all CSV files from this storage location.

Data record number/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 will not be carried out.
1 (hmiOverwriteAlways) = Yes: Recipe data records are overwritten without prompting.
2 (hmiOverwriteWithPrompting) = With confirmation: Recipe data records are not
overwritten until confirmed.

Output status message

Determines whether a status message is output after the import:
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. Use the return value, for example, to
ensure that this system function has been successfully completed before executing other
system functions:
2 = System function is being performed.
4 = System function was successfully completed.
12 = System function was not performed because an error has occurred.
You can only use an HMI tag for the parameter.

Configurable objects

Object Event
Tag Value change
High limit violated
Low limit violated
Function key (global) Release
Press
Function key (local) Release
Press
Screen Loaded
Cleared

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 63
VB scripting
1.1 System functions

Object Event
Screen object Press
Release
Click
Change (or toggle for switch)
Switch on
Switch off
Enable
Disable
Scheduler Time expired

1.1.38 ImportDataRecordsWithChecksum

Description
Imports one or all data records of a recipe from a CSV file with checksum and verifies the
checksum.

Use in the function list

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

Use in user-defined functions

ImportDataRecordsWithChecksum File_name, Data_record_number_or_name, Overwrite,
Output_status_message, Processing_status, Verify_checksum
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

Parameters

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.

Data record number/name

Number or name of the recipe data record to be imported. Specify "0" if all recipe data
records are to be imported.

WinCC Engineering V18 – Programming reference

64 System Manual, 11/2022, Online documentation
 VB scripting
1.1 System functions

Overwrite
Determines whether existing recipe data records are to be overwritten:
0 (hmiOverwriteForbidden) = No: Recipe data records are not overwritten. The import
process will not be carried out.
1 (hmiOverwriteAlways) = Yes: Recipe data records are overwritten without prompting.
2 (hmiOverwriteWithConfirmation) = With confirmation: Recipe data records are not
overwritten until confirmed.

Output status message

Determines whether a status message is output after the import:
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. Use the return value, for example, to
ensure that this system function has been successfully completed before executing other
system functions:
2 = System function is being performed.
4 = System function was successfully completed.
12 = System function was not performed because an error has occurred.
You can only use an HMI tag for the parameter.

Verify checksum
Determines if the checksum should be verified during import:
0 (hmiFalse) = No: Checksum is not verified.
1 (hmiTrue) = Yes: Checksum is verified.

1.1.39 IncreaseTag

Description
Adds the given value to the value of the tags.
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, help tags must be used. You can use the "SetTag" system function to
assign the tag value to the auxiliary tags.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 65
VB scripting
1.1 System functions

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.

Use in the function list

IncreaseTag (Tag, Value)

Use in user-defined functions

IncreaseTag Tag, Value
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

Parameter

Tag
The tag to which the given value is added.

Value
The value that is added.

1.1.40 InverseLinearScaling

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.
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.

Use in the function list

InvertLinearScaling (X, Y, b, a)

WinCC Engineering V18 – Programming reference

66 System Manual, 11/2022, Online documentation
 VB scripting
1.1 System functions

Use in user-defined functions

InverseLinearScaling X, Y, b, a
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

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
The value which is subtracted.

a
The value through which is divided.

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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 67
VB scripting
1.1 System functions

1.1.41 InvertBit

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).

Use in the function list

InvertBit (Tag)

Use in user-defined functions

InvertBit Tag
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

Parameters

Tag
The tag whose bit is set.

WinCC Engineering V18 – Programming reference

68 System Manual, 11/2022, Online documentation
 VB scripting
1.1 System functions

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

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).

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 69
VB scripting
1.1 System functions

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.

Use in the function list

InvertBitInTag (Tag, Bit)

Use in user-defined functions

InvertBitInTag Tag, Bit
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

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.

WinCC Engineering V18 – Programming reference

70 System Manual, 11/2022, Online documentation
 VB scripting
1.1 System functions

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.

'Programming language: VB
Dim myTag
Dim myOutputField
Dim bValue, bSaved, bitposition, strResult

Set myTag = SmartTags("bStatusWord")

Set myOutputField=HMIRuntime.Screens("MyScreen").ScreenItems("objTextField")

'Get current value

bValue=myTag.Value

'Save current value

bSaved=bValue

'Invert Bit in position

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

'Output result old and new value:

strResult="Old Value: "&bSaved &Chr(13)&"New Value: "&bValue
myOutputField.Text=strResult

//Programming language: C
{
BYTE bStatusWord;
BYTE bsaved = bStatusWord;
BYTE bitposition = 2;

//Invert bit in bitposition

InvertBitInTag (bStatusWord, bitposition);
//print current and saved value
printf ("Current value: %d\r\n, Saved value: %d\r\n",bStatusWord, bsaved);
...
}

1.1.43 LinearScaling

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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 71
VB scripting
1.1 System functions

The inverse of this function is the "InvertLinearScaling" 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.

Use in the function list

LinearScaling (Y, a, X, b)

Use in user-defined functions

LinearScaling Y, a, X, b
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

Parameters

Y
The tag which is assigned the value calculated from the linear equation.

a
The value with which is multiplied.

X
The tag that contains the value used for calculation.

b
The value that is added.

WinCC Engineering V18 – Programming reference

72 System Manual, 11/2022, Online documentation
 VB scripting
1.1 System functions

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);

...
}

The saved return value can be processed in the following code.

1.1.44 LoadDataRecord

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.

Use in the function list

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

Use in user-defined functions

LoadDataRecord Recipe_number_or_name, Data_record_number_or_name, Confirmation,
Output_status_message, Processing_status
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

Parameters

Recipe number/name
Number or name of the recipe from which a recipe data record is loaded.

Data record number/name

Number or name of the recipe data record which is loaded.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 73
VB scripting
1.1 System functions

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.
12 = System function was not performed because an error has occurred.
You can only use an HMI tag for the parameter.

1.1.45 LogOff

Description
Logs off the current user on the HMI device.

Use in the function list

Logoff

Use in user-defined functions

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

Parameter
--

1.1.46 Logon

Description
Logs on the current user on the HMI device.

Use in the function list

Logon (Password, User name)

WinCC Engineering V18 – Programming reference

74 System Manual, 11/2022, Online documentation
 VB scripting
1.1 System functions

Use in user-defined functions

Logon Password, User_name
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

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

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".

Use in the function list

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

Use in user-defined functions

LookupText Output_text, Index, Language, Text_list
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

Parameters

Output text
The tag to which the result is written.

Index
The tag that defines the value of the list entry.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 75
VB scripting
1.1 System functions

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

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.

Use in the function list

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

Use in user-defined functions

NotifyUserAction Confirmation_type, Mandatory_commenting, Category, Object_name,
Description

WinCC Engineering V18 – Programming reference

76 System Manual, 11/2022, Online documentation
 VB scripting
1.1 System functions

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

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

Description
Reestablishes the connection between WinCC and the logs. Logging can be continued.

Note
Run the "StartLogging" system function in order to restart logging.

Use in the function list

OpenAllLogs

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 77
VB scripting
1.1 System functions

Use in user-defined functions

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

Parameter
--

Application example
You are in runtime and want to change the data medium on which the process values are logged.
Notes on configuring
Configure the "StopLogging" and "CloseAllLogs" system functions 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.
Procedure on HMI device
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

Description
Opens a Windows system prompt.
This function is used, e.g., to copy files or to call up another application.

Use in the function list

OpenCommandPrompt

Use in user-defined functions

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

WinCC Engineering V18 – Programming reference

78 System Manual, 11/2022, Online documentation
 VB scripting
1.1 System functions

Parameter
--

1.1.51 OpenControlPanel

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.

Use in the function list

OpenControlPanelDialog (Dialog)

Use in user-defined functions

-

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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 79
VB scripting
1.1 System functions

1.1.52 OpenInternetExplorer

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.

Use in the function list

OpenInternetExplorer (Start page)

Use in user-defined functions

OpenInternetExplorer Start_page
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

Parameter

Start page
The page which is loaded when Internet Explorer is started, e.g. "www.siemens.com".

1.1.53 OpenScreenKeyboard

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.

Use in the function list

OpenScreenKeyboard (Display mode)

WinCC Engineering V18 – Programming reference

80 System Manual, 11/2022, Online documentation
 VB scripting
1.1 System functions

Use in user-defined functions

OpenScreenKeyboard Display_mode
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

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

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.

Use in the function list

OpenTaskManager

Use in user-defined functions

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

Parameter
--

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 81
VB scripting
1.1 System functions

1.1.55 PageDown

Description
Executes the key function <Pagedown> on the HMI device.
This system function can only be used for function keys.

Use in the function list

PageDown

Use in user-defined functions

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

Parameter
-

1.1.56 PageUp

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.

Use in the function list

PageUp

Use in user-defined functions

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

Parameter
-

WinCC Engineering V18 – Programming reference

82 System Manual, 11/2022, Online documentation
 VB scripting
1.1 System functions

1.1.57 PrintReport

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.

Use in the function list

PrintReport (Report)

Use in user-defined functions

PrintReport Report
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

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

Description
Prints the screen currently being displayed on the HMI device from the printer which is
connected to the HMI device.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 83
VB scripting
1.1 System functions

Opened windows are also printed.

Note
The printer settings are taken over from the current settings in the Windows operation system.

Use in the function list

PrintScreen

Use in user-defined functions

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

Parameter
--

1.1.59 ResetBit

Description
Sets the value of a "Bool" type tag to 0 (FALSE).

Use in the function list

ResetBit (Tag)

Use in user-defined functions

ResetBit Tag
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

Parameters

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

WinCC Engineering V18 – Programming reference

84 System Manual, 11/2022, Online documentation
 VB scripting
1.1 System functions

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.

'Programming language: VB
Dim myTag
Dim myOutputField
Dim bValue, bSaved, strResult

Set myTag = SmartTags("bStatus")

Set myOutputField=HMIRuntime.Screens("MyScreen").ScreenItems("objTextField")

'Set value
bValue=1
myTag.Value=bValue

'Save current value

bSaved=bValue

'Reset Bit
ResetBit 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 = 1;
BOOL bSaved = bStatus;

//Reset bit
ResetBit (bStatus);

//print current and saved value

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

1.1.60 ResetBitInTag

Description
Sets a bit in the specified tag to 0 (FALSE).

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 85
VB scripting
1.1 System functions

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 "ResetBit" system
function instead.

Use in the function list

ResetBitInTag (Tag, Bit)

Use in user-defined functions

ResetBitInTag Tag, Bit
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

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.

WinCC Engineering V18 – Programming reference

86 System Manual, 11/2022, Online documentation
 VB scripting
1.1 System functions

Example
The following program code sets a bit to 0 at the specified bitposition in the bStatusWord tag and
outputs the result along with the original bSaved value.

'Programming language: VB
Dim myTag
Dim myOutputField
Dim bValue, bSaved, bitposition, strResult

Set myTag = SmartTags("bStatusWord")

Set myOutputField=HMIRuntime.Screens("MyScreen").ScreenItems("objTextField")

'Save current value

bValue=myTag.Value
bSaved=bValue

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

'Output result old and new value:

strResult="Old Value: "&bSaved &Chr(13)&"New Value: "&bValue
myOutputField.Text=strResult

//Programming language: C
{

BYTE bSaved;
BYTE bitposition = 2;

bSaved = GetTagByte("bStatusWord");

//Reset bit in bitposition

ResetBitInTag ("bStatusWord", bitposition);

//print current and saved value

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

1.1.61 SafelyRemoveHardware

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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 87
VB scripting
1.1 System functions

Use in the function list

SafelyRemoveHardware(Path, Result)

Use in user-defined functions

SafelyRemoveHardware Path, Result
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

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

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.
Data records are only saved if the "Synchronization" option is activated in the recipe.
• When "Synchronization" is not activated, no data records are saved.
To save data records, use either the "Save" button in the recipe control or the system function.

Synchronization Button System function

Activated Data records are saved. Data records are saved.
Deactivated Data records are saved only if list view Data records are not saved.
of the recipe view is displayed. "12" is returned as the processing sta‐
tus.

• Alarms related to the operation are not displayed.

WinCC Engineering V18 – Programming reference

88 System Manual, 11/2022, Online documentation
 VB scripting
1.1 System functions

Use in the function list

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

Use in user-defined functions

SaveDataRecord Recipe_number_or_name, Data_record_number_or_name, Overwrite,
Output_status_message, Processing_status
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

Parameters

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

Data record number/name

Number or name of the recipe data record which is 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.

Output status message

Determines whether a status message is output after saving:
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.
12 = System function was not performed because an error has occurred.
You can only use an HMI tag for the parameter.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 89
VB scripting
1.1 System functions

1.1.63 SendEMail

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.

Use in the function list

SendEMail (Address, Subject, Text, Return address)

Use in user-defined functions

SendEMail Address, Subject, Text, Return_address
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

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.

WinCC Engineering V18 – Programming reference

90 System Manual, 11/2022, Online documentation
 VB scripting
1.1 System functions

1.1.64 SetAcousticSignal

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.

Use in the function list

SetAcousticSignal (Volume)

Use in user-defined functions

SetAcousticSignal Volume
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

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

Description
Switches the automatic reporting of alarms on the printer on or off.

Use in the function list

SetAlarmReportMode (Mode)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 91
VB scripting
1.1 System functions

Use in user-defined functions

SetAlarmReportMode Mode
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

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

Description
Sets the value of a "Bool" type tag to 1 (TRUE).

Use in the function list

SetBit (Tag)

Use in user-defined functions

SetBit Tag
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

Parameters

Tag
The BOOL type tag which is set to 1 (TRUE).

WinCC Engineering V18 – Programming reference

92 System Manual, 11/2022, Online documentation
 VB scripting
1.1 System functions

Example
The following program code sets the value of the Boolean tag bStatus to 1 by means of the SetBit
function 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")

'Set value
bValue=0
myTag.Value=bValue

'Save current value

bSaved=bValue

'Set Bit
SetBit 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;

//Set bit
SetBit (bStatus);

//print current and saved value

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

1.1.67 SetBitInTag

Description
Sets a bit in the given tag to 1 (TRUE).

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 93
VB scripting
1.1 System functions

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 "SetBit" system function
instead.

Use in the function list

SetBitInTag (Tag, Bit)

Use in user-defined functions

SetBitInTag Tag, Bit
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

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).
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.

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.

WinCC Engineering V18 – Programming reference

94 System Manual, 11/2022, Online documentation
 VB scripting
1.1 System functions

Example
The following program code sets a bit to 1 at the specified bitposition in the bStatusWord tag and
outputs the result along with the original bSaved value.

'Programming language: VB
Dim myTag
Dim myOutputField
Dim bValue, bSaved, bitposition, strResult

Set myTag = SmartTags("bStatusWord")

Set myOutputField=HMIRuntime.Screens("MyScreen").ScreenItems("objTextField")

'Save current value

bValue=myTag.Value
bSaved=bValue

'Set Bit in tag

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

'Output result old and new value:

strResult="Old Value: "& bSaved & "New Value: " & bValue
myOutputField.Text=strResult

//Programming language: C
{

BYTE bSaved;
BYTE bitposition = 1;

bSaved = GetTagByte("bStatusWord");

//Reset bit in bitposition

SetBitInTag ("bStatusWord", bitposition);

//print current and saved value

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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 95
VB scripting
1.1 System functions

1.1.68 SetBrightness

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%.

Use in the function list

SetBrightness (value)

Use in user-defined functions

SetBrightness Value
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

Parameter

Value
New value for the brightness.

WinCC Engineering V18 – Programming reference

96 System Manual, 11/2022, Online documentation
 VB scripting
1.1 System functions

1.1.69 SetConnectionMode

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.

Use in the function list

SetConnectionMode (Mode, Connection)

Use in user-defined functions

SetConnectionMode Mode, Connection

Note
Good Manufacturing Practice

The use of the "SetConnectionMode" system function in user-defined functions is not GMP
compliant.
When using the "SetConnectionMode" system function in user-defined functions, disable the
Good Manufacturing Practice in the runtime settings of the HMI device.

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

Parameters

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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 97
VB scripting
1.1 System functions

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

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.

Use in the function list

SetDataRecordTagsToPLC (Recipe number/name, Processing status)

Use in user-defined functions

SetDataRecordTagsToPLC Recipe_ number_or_name, Processing_status
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

WinCC Engineering V18 – Programming reference

98 System Manual, 11/2022, Online documentation
 VB scripting
1.1 System functions

Parameters

Recipe number/name
Number or name of the recipe from which recipe data record is transferred to the PLC.

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.
12 = System function was not performed because an error has occurred.
You can only use an HMI tag for the parameter.

1.1.71 SetDataRecordToPLC

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.

Use in the function list

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

Use in user-defined functions

SetDataRecordToPLC Recipe_number_or_name, Data_record_number_or_name,
Output_status_message, Processing_status
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

Parameters

Recipe number/name
Number or name of the recipe from which recipe data record is transferred to the PLC.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 99
VB scripting
1.1 System functions

Data record number/name

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

Output status message

Determines whether a status message is output after the transfer:
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.
12 = System function was not performed because an error has occurred.
You can only use an HMI tag for the parameter.

1.1.72 SetDaylightSavingTime

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.

Use in the function list

SetDaylightSavingTime(DaylightSavingTime)

Use in user-defined functions

SetDaylightSavingTime Daylight_saving_time

WinCC Engineering V18 – Programming reference

100 System Manual, 11/2022, Online documentation
 VB scripting
1.1 System functions

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

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

Description
Toggles the operating mode on the HMI device. The following types of operation are possible:
"Online", "Offline" and "Loading".

Use in the function list

SetDeviceMode (Operating mode)

Use in user-defined functions

SetDeviceMode Operating_mode
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 101
VB scripting
1.1 System functions

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".

1.1.74 SetDisplayMode

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.

Use in the function list

SetDisplayMode (Layout)

Use in user-defined functions

SetDisplayMode Display_mode
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

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.

WinCC Engineering V18 – Programming reference

102 System Manual, 11/2022, Online documentation
 VB scripting
1.1 System functions

1.1.75 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.

Use in the function list

SetLanguage (Language)

Use in user-defined functions

SetLanguage Language
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

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

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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 103
VB scripting
1.1 System functions

Use in the function list

SetPLCDateTime (connection, time)

Use in user-defined functions

-

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

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.

Use in the function list

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

Use in user-defined functions

SetRecipeTags Recipe_number_or_name, Status, Output_status_message, Processing_status
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

Parameters

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.

WinCC Engineering V18 – Programming reference

104 System Manual, 11/2022, Online documentation
 VB scripting
1.1 System functions

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.

Output status message

Determines whether a status message is output after saving:
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.
12 = System function was not performed because an error has occurred.
You can only use an HMI tag for the parameter.

1.1.78 SetScreenKeyboardMode

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.

Use in the function list

SetScreenKeyboardMode (Mode)

Use in user-defined functions

SetScreenKeyboardMode Mode
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 105
VB scripting
1.1 System functions

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.

1.1.79 SetTag

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.

Use in the function list

SetTag (Tag, Value)

Use in user-defined functions

SetTag Tag, Value
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

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.

WinCC Engineering V18 – Programming reference

106 System Manual, 11/2022, Online documentation
 VB scripting
1.1 System functions

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." );
}
...
}

The saved return value can be processed in the following code.

1.1.80 ShiftAndMask

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.

Use in the function list

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

Use in user-defined functions

ShiftAndMask Source_tag, Target_tag, Bits_to_shift, Bits_to_mask

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 107
VB scripting
1.1 System functions

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

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".

WinCC Engineering V18 – Programming reference

108 System Manual, 11/2022, Online documentation
 VB scripting
1.1 System functions

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

Description
Hides or shows the alarm window on the HMI device.

Use in the function list

ShowAlarmWindow (Object name, Display mode)

Use in user-defined functions

ShowAlarmWindow Object_name, Display_mode
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

Parameter

Object name
Name of the alarm view which is hidden or shown.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 109
VB scripting
1.1 System functions

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 (hmiToggle) = Toggle: Toggles between the two modes

1.1.82 ShowOperatorNotes

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

Use in the function list

ShowOperatorNotes (Layout)

Use in user-defined functions

ShowOperatorNotes Display_mode

WinCC Engineering V18 – Programming reference

110 System Manual, 11/2022, Online documentation
 VB scripting
1.1 System functions

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

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 (hmiToggle) = Toggle: Toggles between the two modes

1.1.83 ShowPopUpScreen

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.

Use in the function list

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

Use in user-defined functions

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
Position of the pop-up screen in the current screen on the X axis

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 111
VB scripting
1.1 System functions

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

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>.

WinCC Engineering V18 – Programming reference

112 System Manual, 11/2022, Online documentation
 VB scripting
1.1 System functions

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 9" display 27 27
Comfort Panels with 15" display
Comfort Panels with 22" display
HMI devices with 7" display 34 34
HMI devices with 12" display

Use in the function list

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

Use in user-defined functions

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
Position of the pop-up screen in the current screen on the X axis

Y coordinate
Position of the pop-up screen in the current screen on the X axis

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 113
VB scripting
1.1 System functions

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

Description
Calls the slide-in screen, for example, when operating a button.

Use in the function list

ShowSlideinScreen (screen name, mode)

Use in user-defined functions

ShowSlideInScreen SlideInScreen_name, Mode

WinCC Engineering V18 – Programming reference

114 System Manual, 11/2022, Online documentation
 VB scripting
1.1 System functions

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

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

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.

Use in the function list

ShowSoftwareVersion (Display mode)

Use in user-defined functions

ShowSoftwareVersion Display_mode
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

Parameter

Display mode
Determines whether the version number is shown:

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 115
VB scripting
1.1 System functions

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

1 (hmiOn) = On: Version number is shown
-1 (hmiToggle) = Toggle: Toggles between the two modes

1.1.87 ShowSystemAlarm

Description
Displays the value of the parameter passed as a system event to the HMI device.

Use in the function list

ShowSystemAlarm (Text/value)

Use in user-defined functions

ShowSystemAlarm Text_or_value
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

Parameter

Text/Value
The text or the value, which was output as a system alarm.

1.1.88 ShowSystemDiagnosticsWindow

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.

Use in the function list

ShowSystemDiagnosticsWindow (Screen object)

Use in user-defined functions

ShowSystemDiagnosticsWindow Object_name
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

WinCC Engineering V18 – Programming reference

116 System Manual, 11/2022, Online documentation
 VB scripting
1.1 System functions

Parameters

Screen object
Name of the system diagnostic window which is hidden or shown.

1.1.89 StartLogging

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.

Use in the function list

StartLogging (Log type, Log)

Use in user-defined functions

StartLogging Log_type, Log
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

Parameter

Log type
Determines the type of log:
0 (hmiTagArchive) = Tag log
1 (hmiAlarmArchive) = Alarm log
2 (hmiAudittrailArchive) = Audit trail

Log
Name of the log which is started.

1.1.90 StartNextLog

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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 117
VB scripting
1.1 System functions

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

Use in the function list

StartNextLog (Log type, Log)

Use in user-defined functions

StartNextLog Log_type, Log
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

Parameter

Log type
Determines the type of log:
0 (hmiTagArchive) = Tag log
1 (hmiAlarmArchive) = Alarm log

Log
Name of the log for which the logging is stopped and continued in the next log.

1.1.91 StartProgram

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.

WinCC Engineering V18 – Programming reference

118 System Manual, 11/2022, Online documentation
 VB scripting
1.1 System functions

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".

Use in the function list

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

Use in user-defined functions

StartProgram Program_name, Program_parameters, Display_mode, Wait_for_program_to_end
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

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:
0 (hmiNo) = No: No change to project

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 119
VB scripting
1.1 System functions

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

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.

Use in the function list

StopLogging (Log type, Log)

Use in user-defined functions

StopLogging Log_type, Log
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

Parameter

Log type
Determines the type of log:
0 (hmiTagArchive) = Tag log
1 (hmiAlarmArchive) = Alarm log
2 (hmiAudittrailArchive) = Audit trail

Log
Name of the log that is stopped.

WinCC Engineering V18 – Programming reference

120 System Manual, 11/2022, Online documentation
 VB scripting
1.1 System functions

Application example
You are in runtime and want to change the data medium on which the process values are logged.
Notes on configuring
Configure the "StopLogging" and "CloseAllLogs" system functions 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.
Procedure on HMI device
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

Description
Exits the runtime software and thereby the project running on the HMI device.

Use in the function list

StopRuntime (Mode)

Use in user-defined functions

StopRuntime Mode
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

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)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 121
VB scripting
1.1 System functions

Example
The following program code shuts down Runtime and the operating system.

//Stop runtime and shutdown

StopRuntime (hmiStopRuntimeAndOperationSystem);

The saved return value can be processed in the following code.

1.1.94 TerminatePROFIsafe

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.

Use in the function list

TerminatePROFIsafe

Use in user-defined functions

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

Parameters
--

WinCC Engineering V18 – Programming reference

122 System Manual, 11/2022, Online documentation
 VB scripting
1.2 System functions

1.2 System functions

1.2.1 ActivateScreen

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.

Use in the function list

ActivateScreen (Screen name, Object number)

Use in user-defined functions

ActivateScreen Screen_name, Object_number
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

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.
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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 123
VB scripting
1.2 System functions

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.2.2 ActivateScreenInScreenWindow

Description
Performs a screen change to the specified screen in a specified screen window.

Use in the function list

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

Use in user-defined functions

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.

WinCC Engineering V18 – Programming reference

124 System Manual, 11/2022, Online documentation
 VB scripting
1.2 System functions

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

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. 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.

Use in the function list

DecreaseTag (Tag, Value)

Use in user-defined functions

DecreaseTag Tag, Value
Can be used if the configured device supports user-defined functions. For more information,
refer to "AUTOHOTSPOT".

Parameters

Tag
The tag from which the given value is subtracted.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 125
VB scripting
1.2 System functions

Value
The value which is subtracted.

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

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.

Use in the function list

ExportImportUserAdministration (File name, Direction)

Use in user-defined functions

ExportImportUserAdministration File_name, Direction

WinCC Engineering V18 – Programming reference

126 System Manual, 11/2022, Online documentation
 VB scripting
1.2 System functions

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

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

Description
The function determines the name of the parent screen from a specified screen path.

Use in the function list

GetParentScreen (screen)

Use in user-defined functions

GetParentScreen Screen
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

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>:<Screen
_name>...

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 127
VB scripting
1.2 System functions

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.
• "Screen_1", if the system function is called in the "Screen_2" screen.
GetParentScreenwindow returns:
• "Screenwindow_2", if the system function is called in the "Screen_3" screen.
• "Screenwindow_1", if the system function is called in the "Screen_2" screen.

1.2.6 GetParentScreenWindow

Description
The function determines the name of the parent screen window from a transferred screen path.

Use in the function list

GetParentScreenWindow (Screen)

Use in user-defined functions

GetParentScreenWindow Screen
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

WinCC Engineering V18 – Programming reference

128 System Manual, 11/2022, Online documentation
 VB scripting
1.2 System functions

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>:<Screen
_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
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 window.

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.
• "Screen_1", if the system function is called in the "Screen_2" screen.
GetParentScreenwindow returns:
• "Screenwindow_2", if the system function is called in the "Screen_3" screen.
• "Screenwindow_1", if the system function is called in the "Screen_2" screen.

1.2.7 IncreaseTag

Description
Adds the given value to the value of the tags.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 129
VB scripting
1.2 System functions

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. 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.

Use in the function list

IncreaseTag (Tag, Value)

Use in user-defined functions

IncreaseTag Tag, Value
Can be used if the configured device supports user-defined functions. For more information,
refer to "AUTOHOTSPOT".

Parameters

Tag
The tag to which the given value is added.

Value
The value that is added.

WinCC Engineering V18 – Programming reference

130 System Manual, 11/2022, Online documentation
 VB scripting
1.2 System functions

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
...
BYTE old_value = varX;

//Increase tag
IncreaseTag(varX, value);

//print original value and function result

printf ("User input: %i\r\n, Result of function IncreaseTag: %i\r\n", old_value, varX);
...
}

1.2.8 InverseLinearScaling

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.
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.

Use in the function list

InvertLinearScaling (X, Y, b, a)

Use in user-defined functions

InverseLinearScaling X, Y, b, a
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 131
VB scripting
1.2 System functions

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
The value which is subtracted.

a
The value through which is divided.

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.2.9 InvertBit

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).

Use in the function list

InvertBit (Tag)

WinCC Engineering V18 – Programming reference

132 System Manual, 11/2022, Online documentation
 VB scripting
1.2 System functions

Use in user-defined functions

InvertBit Tag
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

Parameters

Tag
The tag whose bit is set.

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);
...
}

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 133
VB scripting
1.2 System functions

1.2.10 InvertBitInTag

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).
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.

Use in the function list

InvertBitInTag (Tag, Bit)

Use in user-defined functions

InvertBitInTag Tag, Bit
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

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.

WinCC Engineering V18 – Programming reference

134 System Manual, 11/2022, Online documentation
 VB scripting
1.2 System functions

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.

'Programming language: VB
Dim myTag
Dim myOutputField
Dim bValue, bSaved, bitposition, strResult

Set myTag = SmartTags("bStatusWord")

Set myOutputField=HMIRuntime.Screens("MyScreen").ScreenItems("objTextField")

'Get current value

bValue=myTag.Value

'Save current value

bSaved=bValue

'Invert Bit in position

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

'Output result old and new value:

strResult="Old Value: "&bSaved &Chr(13)&"New Value: "&bValue
myOutputField.Text=strResult

//Programming language: C
{
BYTE bStatusWord;
BYTE bsaved = bStatusWord;
BYTE bitposition = 2;

//Invert bit in bitposition

InvertBitInTag (bStatusWord, bitposition);
//print current and saved value
printf ("Current value: %d\r\n, Saved value: %d\r\n",bStatusWord, bsaved);
...
}

1.2.11 LinearScaling

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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 135
VB scripting
1.2 System functions

The inverse of this function is the "InvertLinearScaling" 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.

Use in the function list

LinearScaling (Y, a, X, b)

Use in user-defined functions

LinearScaling Y, a, X, b
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

Parameters

Y
The tag which is assigned the value calculated from the linear equation.

a
The value with which is multiplied.

X
The tag that contains the value used for calculation.

b
The value that is added.

WinCC Engineering V18 – Programming reference

136 System Manual, 11/2022, Online documentation
 VB scripting
1.2 System functions

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);

...
}

The saved return value can be processed in the following code.

1.2.12 LookupText

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".

Use in the function list

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

Use in user-defined functions

LookupText Output_text, Index, Language, Text_list
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

Parameters

Output text
The tag to which the result is written.

Index
The tag that defines the value of the list entry.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 137
VB scripting
1.2 System functions

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

Description
Sets the value of a "Bool" type tag to 0 (FALSE).

Use in the function list

ResetBit (Tag)

Use in user-defined functions

ResetBit Tag
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

Parameters

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

WinCC Engineering V18 – Programming reference

138 System Manual, 11/2022, Online documentation
 VB scripting
1.2 System functions

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.

'Programming language: VB
Dim myTag
Dim myOutputField
Dim bValue, bSaved, strResult

Set myTag = SmartTags("bStatus")

Set myOutputField=HMIRuntime.Screens("MyScreen").ScreenItems("objTextField")

'Set value
bValue=1
myTag.Value=bValue

'Save current value

bSaved=bValue

'Reset Bit
ResetBit 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 = 1;
BOOL bSaved = bStatus;

//Reset bit
ResetBit (bStatus);

//print current and saved value

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

1.2.14 ResetBitInTag

Description
Sets a bit in the specified tag to 0 (FALSE).

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 139
VB scripting
1.2 System functions

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 "ResetBit" system
function instead.

Use in the function list

ResetBitInTag (Tag, Bit)

Use in user-defined functions

ResetBitInTag Tag, Bit
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

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.

WinCC Engineering V18 – Programming reference

140 System Manual, 11/2022, Online documentation
 VB scripting
1.2 System functions

Example
The following program code sets a bit to 0 at the specified bitposition in the bStatusWord tag and
outputs the result along with the original bSaved value.

'Programming language: VB
Dim myTag
Dim myOutputField
Dim bValue, bSaved, bitposition, strResult

Set myTag = SmartTags("bStatusWord")

Set myOutputField=HMIRuntime.Screens("MyScreen").ScreenItems("objTextField")

'Save current value

bValue=myTag.Value
bSaved=bValue

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

'Output result old and new value:

strResult="Old Value: "&bSaved &Chr(13)&"New Value: "&bValue
myOutputField.Text=strResult

//Programming language: C
{

BYTE bSaved;
BYTE bitposition = 2;

bSaved = GetTagByte("bStatusWord");

//Reset bit in bitposition

ResetBitInTag ("bStatusWord", bitposition);

//print current and saved value

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

1.2.15 SetBit

Description
Sets the value of a "Bool" type tag to 1 (TRUE).

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 141
VB scripting
1.2 System functions

Use in the function list

SetBit (Tag)

Use in user-defined functions

SetBit Tag
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

Parameters

Tag
The BOOL type tag which is set to 1 (TRUE).

Example
The following program code sets the value of the Boolean tag bStatus to 1 by means of the SetBit
function 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")

'Set value
bValue=0
myTag.Value=bValue

'Save current value

bSaved=bValue

'Set Bit
SetBit myTag
bValue=myTag.Value

'Output result old and new value:

strResult="Old Value: "&bSaved &Chr(13)&"New Value: "&bValue
myOutputField.Text=strResult

WinCC Engineering V18 – Programming reference

142 System Manual, 11/2022, Online documentation
 VB scripting
1.2 System functions

//Programming language: C
{
BOOL bStatus = 0;
BOOL bSaved = bStatus;

//Set bit
SetBit (bStatus);

//print current and saved value

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

1.2.16 SetBitInTag

Description
Sets a bit in the given tag to 1 (TRUE).
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 "SetBit" system function
instead.

Use in the function list

SetBitInTag (Tag, Bit)

Use in user-defined functions

SetBitInTag Tag, Bit
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

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).

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 143
VB scripting
1.2 System functions

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.

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
The following program code sets a bit to 1 at the specified bitposition in the bStatusWord tag and
outputs the result along with the original bSaved value.

'Programming language: VB
Dim myTag
Dim myOutputField
Dim bValue, bSaved, bitposition, strResult

Set myTag = SmartTags("bStatusWord")

Set myOutputField=HMIRuntime.Screens("MyScreen").ScreenItems("objTextField")

'Save current value

bValue=myTag.Value
bSaved=bValue

'Set Bit in tag

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

'Output result old and new value:

strResult="Old Value: "& bSaved & "New Value: " & bValue
myOutputField.Text=strResult

WinCC Engineering V18 – Programming reference

144 System Manual, 11/2022, Online documentation
 VB scripting
1.2 System functions

//Programming language: C
{

BYTE bSaved;
BYTE bitposition = 1;

bSaved = GetTagByte("bStatusWord");

//Reset bit in bitposition

SetBitInTag ("bStatusWord", bitposition);

//print current and saved value

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

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.

Use in the function list

SetLanguage (Language)

Use in user-defined functions

SetLanguage Language
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 145
VB scripting
1.2 System functions

• 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

Description
Specifies the value of an object property as a string.

Use in the function list

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

Use in user-defined functions

SetPropertyByConstant Screen_name, Screen_object, Property_name, Value
Can be used if the configured device supports user-defined functions. For more information,
refer to "AUTOHOTSPOT".
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.

WinCC Engineering V18 – Programming reference

146 System Manual, 11/2022, Online documentation
 VB scripting
1.2 System functions

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

...

{
//Programming language: C
//Name of the picture: Trends
//Name of the f(t) trend view control: Control_1

SetPropertyByConstant ("Trends", "Control_1", "ToolbarButtonClick", "26");

// 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.

'Programming language: VBS

'Name of the picture: Trends

SetPropertyByConstant "Trends", "Trends", "Backcolor", "255"

'User defined code

...

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 147
VB scripting
1.2 System functions

{
//Programming language: C
//Name of the picture: Trends

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

// User defined code

...
}

Alternatively, use the password ZERO or a space string instead of the second parameter
(object).

1.2.19 SetPropertyByProperty

Description
Specifies the value of an object property with another object property.

Use in the function list

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

Use in user-defined functions

SetPropertyByProperty Screen_name, Screen_object, Property_name, Source_screen_name,
Source_screen_object, Source_property_name
Can be used if the configured device supports user-defined functions. For more information,
refer to "AUTOHOTSPOT".
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
Name of the screen that contains the object.

Object
Name of the object whose property value is transferred to the target object.

WinCC Engineering V18 – Programming reference

148 System Manual, 11/2022, Online documentation
 VB scripting
1.2 System functions

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

Name of the property that will be changed.

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".

'Programming language: VBS

'Name of source picture: Trend_1
'Name of target picture: Trend_2
'Name of the f(t) trend view control: Control_1

SetPropertyByProperty "Trend_1", "Control_1", "ToolbarButtonClick", "Trend_2",

"Control_2", "ToolbarButtonClick"

'User defined code

...

{
//Programming language: C
//Name of source picture: Trend_1
//Name of target picture: Trend_2
//Name of the f(t) trend view control: Control_1

SetPropertyByProperty ("Trend_1", "Control_1", "ToolbarButtonClick", "Trend_2",

"Control_2", "ToolbarButtonClick");

// User defined code

...
}

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 149
VB scripting
1.2 System functions

1.2.20 SetPropertyByTag

Description
Specifies the value of an object property with a tag value.

Use in the function list

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

Use in user-defined functions

SetPropertyByTag Screen_name, Screen_object, Property_name, Tag_name
Can be used if the configured device supports user-defined functions. For more information,
refer to "AUTOHOTSPOT".
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
Name of the screen that contains the object.

Screen object
Name of the object containing the property to be set with the tag value.

Name of the property

Name of the property that is set with the tag value.

Tag name
Name of the tag that contains the value of the property.

WinCC Engineering V18 – Programming reference

150 System Manual, 11/2022, Online documentation
 VB scripting
1.2 System functions

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.

'Programming language: VBS

SetPropertyByTag screenName, objectName, "CaptionText", "HMI_value_1"

'User defined code

...

{
//Programming language: C
SetPropertyByTag (screenName, objectName, "CaptionText", "HMI_value_1");

// User defined code

...
}

Example
The SetPropertyByTag 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

...

{
//Programming language: C
//Name of the picture: Trends
//Name of the f(t) trend view control: Control_1

SetPropertyByConstant ("Trends", "Control_1", "ToolbarButtonClick", "26");

// User defined code

...
}

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 151
VB scripting
1.2 System functions

1.2.21 SetPropertyByTagIndirect

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.

Use in the function list

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

Use in user-defined functions

SetPropertyByTagIndirect Screen_name, Screen_object, Property_name, Tag_name
Can be used if the configured device supports user-defined functions. For more information,
refer to "AUTOHOTSPOT".
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
Name of the screen that contains the object.

Screen object
Name of the object whose property you want to change.

Name of the property

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: .

'Programming language: VBS

SetPropertyByTagIndirect GetParentScreen(screenName), GetParentScreenWindow(screenName),
"ScreenName", "HMI_value_1"

'User defined code

...

WinCC Engineering V18 – Programming reference

152 System Manual, 11/2022, Online documentation
 VB scripting
1.2 System functions

{
//Programming language: C
SetPropertyByTagIndirect (GetParentScreen(screenName), GetParentScreenWindow(screenName),
"ScreenName", "HMI_value_1");

// User defined code

...
}

1.2.22 SetTag

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.

Use in the function list

SetTag (Tag, Value)

Use in user-defined functions

SetTag Tag, Value
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 153
VB scripting
1.2 System functions

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." );
}
...
}

The saved return value can be processed in the following code.

1.2.23 SetTagByProperty

Description
Specifies a tag value with the value of an object property. The change is also logged in the alarm
system.

Use in the function list

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

Use in user-defined functions

SetTagByProperty Tag_name, Screen_name, Screen_object, Property_name,
With_or_without_operator_event
Can be used if the configured device supports user-defined functions. For more information,
refer to "AUTOHOTSPOT".

WinCC Engineering V18 – Programming reference

154 System Manual, 11/2022, Online documentation
 VB scripting
1.2 System functions

Parameters

Tag name
Name of the tag whose value is specified by the object property.

Screen name
Name of the screen that contains the object.

Screen object
Name of the object whose property supplies the tag value.

Name of the property

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

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.

Use in the function list

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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 155
VB scripting
1.2 System functions

Use in user-defined functions

SetTagByTagIndirect Tag_name, Source_tag_name, With_or_without_operator_event
Can be used if the configured device supports user-defined functions. For more information,
refer to "AUTOHOTSPOT".

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.

With or without operator event

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

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.

Use in the function list

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

Use in user-defined functions

SetTagIndirect Tag_name, Value, With_or_without_operator_event

WinCC Engineering V18 – Programming reference

156 System Manual, 11/2022, Online documentation
 VB scripting
1.2 System functions

Can be used if the configured device supports user-defined functions. For more information,
refer to "AUTOHOTSPOT".

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.

With or without operator event

0 (hmiWithoutOperatorEvent) = Without operator event
1 (hmiWithOperatorEvent) = With operator event

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

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.

Use in the function list

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

Use in user-defined functions

SetTagIndirectByProperty Tag_name, Screen_name, Screen_object, Property_name,
With_or_without_operator_event

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 157
VB scripting
1.2 System functions

Can be used if the configured device supports user-defined functions. For more information,
refer to "AUTOHOTSPOT".

Parameters

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

Screen name
Name of the screen that contains the object.

Screen object
Name of the object whose property supplies the value.

Name of the property

Name of the property which supplies the value.

With or without operator event

0 (hmiWithoutOperatorEvent) = Without input alarm
1 (hmiWithOperatorEvent) = With operator input alarm

Example
The following program code writes the value of the object property "Background color" to the tag
Tag2.

{
SetTag ("IndirectWrite", "Tag2");
SetTagIndirectByProperty ("IndirectWrite", screenName, objectName, "BackColor",
hmiWithoutOperatorEvent);
...
}

1.2.27 SetTagIndirectByTagIndirect

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.

Use in the function list

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

WinCC Engineering V18 – Programming reference

158 System Manual, 11/2022, Online documentation
 VB scripting
1.2 System functions

Use in user-defined functions

SetTagIndirectByTagIndirect Tag_name, Source_tag_name, With_or_without_operator_event
Can be used if the configured device supports user-defined functions. For more information,
refer to "AUTOHOTSPOT".

Parameters

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

Tag name
Name of the indirect tag that returns the tag value.

With or without operator event

0 (hmiWithoutOperatorEvent) = Without operator event
1 (hmiWithOperatorEvent) = With operator event

Example
The following program code writes the value of the tag "Tag4" to the tag "Tag2".

{
SetTag ("IndirectWrite", "Tag2");
SetTag ("IndirectRead", "Tag4");
SetTagIndirectByTagIndirect ("IndirectWrite", "IndirectRead");
...
}

1.2.28 SetTagWithOperatorEvent

Description
Specifies the value for a tag. The change is also logged in the alarm system.

Use in the function list

SetTagWithOperatorEvent (name of the tag, value)

Use in user-defined functions

SetTagWithOperatorEvent Tag_name, Value
Can be used if the configured device supports user-defined functions. For more information,
refer to "AUTOHOTSPOT".

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 159
VB scripting
1.2 System functions

Parameters

Name of the tag

Name of the tag whose value is to be set.

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.

'Programming language: VBS

SetTagWithOperatorEvent result, value
...

//Programming language: C
{
SetTagWithOperatorEvent ("result", "value");
...
}

1.2.29 ShowBlockInTIAPortalFromAlarm

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.
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.

WinCC Engineering V18 – Programming reference

160 System Manual, 11/2022, Online documentation
 VB scripting
1.2 System functions

Use in the function list

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

Use in user-defined functions

ShowBlockInTIAPortalFromAlarm ReadOnly, Offline_mode, TiaPortalProject_path,
AlarmScreen_name, AlarmView_name, Error_tag
Can be used if the configured device supports user-defined functions. For more information,
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.

1.2.30 ShowLogonDialog

Description
Opens a dialog on the HMI device with which the user can log on to the HMI device.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 161
VB scripting
1.2 System functions

Use in the function list

ShowLogonDialog

Use in user-defined functions

ShowLogonDialog
Can be used if the configured device supports user-defined functions. Additional information
is available under "AUTOHOTSPOT".

Parameters
--

1.2.31 ShowPLCCodeViewFromAlarm

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. No commas are permitted in the name of the PLC
from which the alarm originates.

Use in the function list

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)

Use in user-defined functions

ShowPLCCodeViewFromAlarm Screen_name, Alarmview_name, Screen_name,
Screen_window_name, Screen_name, PLCCodeView_name, Error_tag
Can be used if the configured device supports user-defined functions. For more information,
refer to "System functions for Runtime Professional".

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.

WinCC Engineering V18 – Programming reference

162 System Manual, 11/2022, Online documentation
 VB scripting
1.2 System functions

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 inter‐
lock supervisions (Interlock)
• With local supervisions, for all basic su‐
pervisions at input parameters

1.2.32 StopRuntime

Description
Exits the runtime software and thereby the project running on the HMI device.

Use in the function list

StopRuntime (Mode)

Use in user-defined functions

StopRuntime Mode
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 163
VB scripting
1.3 VBScript for Windows

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)

Example
The following program code shuts down Runtime and the operating system.

//Stop runtime and shutdown

StopRuntime (hmiStopRuntimeAndOperationSystem);

The saved return value can be processed in the following code.

1.3 VBScript for Windows

1.3.1 VBScript for Windows

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.
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

WinCC Engineering V18 – Programming reference

164 System Manual, 11/2022, Online documentation
 VB scripting
1.4 VBScript for Windows CE

1.4 VBScript for Windows CE

1.4.1 VBScript for Windows CE

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 (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 (http://msdn.microsoft.com/en-us/
goglobal/bb964664)

1.4.2 CreateObject

Function
This function generates a reference to an automation object.

Syntax
CreateObject (object)

Parameters

Object
A string that contains the ProgID of the object to be generated.

Return value
Outputs a reference to an automation object.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 165
VB scripting
1.4 VBScript for Windows CE

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

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

DLL
Mscefile.dll

File control element

The file control element supports the following properties:
• Attr
• EOF
• Loc

WinCC Engineering V18 – Programming reference

166 System Manual, 11/2022, Online documentation
 VB scripting
1.4 VBScript for Windows CE

• 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

1.4.4 Properties

1.4.4.1 Attr

Function
This property outputs a number that identifies the file mode that was used to open the file.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 167
VB scripting
1.4 VBScript for Windows CE

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

Function
This property outputs True when the end of a file is reached which was opened for random or
sequential input.

Syntax
File.EOF

Parameters

File
Reference to a "File" control.

Notes
Use the EOF property to avoid errors that occur due to reading after the end of a file.

WinCC Engineering V18 – Programming reference

168 System Manual, 11/2022, Online documentation
 VB scripting
1.4 VBScript for Windows CE

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

Function
This property outputs a number that names the current read/write position.

Syntax
File.Loc

Parameters

File
Reference to a "File" control.

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.

1.4.4.4 LOF

Function
This property outputs the size of a file, in bytes as number.

Syntax
File.LOF

Parameters

File
Reference to a "File" control.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 169
VB scripting
1.4 VBScript for Windows CE

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

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
Reference to a "File" control.

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.
An error is output if Seek produces a negative value or zero.

1.4.5 Methods

1.4.5.1 Close

Function
This method closes an open "File" control.

Syntax
File.Close

WinCC Engineering V18 – Programming reference

170 System Manual, 11/2022, Online documentation
 VB scripting
1.4 VBScript for Windows CE

Parameters

File
Reference to a "File" control.

Output values
None.

Notes
Use the Open method to open a file.

1.4.5.2 Dir

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.

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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 171
VB scripting
1.4 VBScript for Windows CE

Constant Value Description

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

Function
This method copies the content of a file to another file.

Syntax
FileSystem.FileCopy PathName, NewPathName

Parameters

FileSystem
Reference to a "FileSystem" control.

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.

WinCC Engineering V18 – Programming reference

172 System Manual, 11/2022, Online documentation
 VB scripting
1.4 VBScript for Windows CE

Notes
FileCopy outputs an error if the new file does not exist.

1.4.5.4 FileDateTime

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
Reference to a "FileSystem" control.

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.

1.4.5.5 FileLen

Function
This method outputs the value that describes the length of file in bytes.

Syntax
FileSystem.FileLen(Pathname)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 173
VB scripting
1.4 VBScript for Windows CE

Parameters

Filesystem
Reference to a "FileSystem" control.

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

Function
This method reads data from an open file into a tag.

Syntax
File.Get Data, [Recnumber]

Parameters

File
Reference to a "File" control.

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.

WinCC Engineering V18 – Programming reference

174 System Manual, 11/2022, Online documentation
 VB scripting
1.4 VBScript for Windows CE

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.

1.4.5.7 GetAttr

Function
This method outputs a value that describes the attributes of a file or folder.

Syntax
FileSystem.GetAttr(Pfadname)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 175
VB scripting
1.4 VBScript for Windows CE

Parameters

FileSystem
Reference to a "FileSystem" control.

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.

Constant Value Description

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

Function
This method outputs a string that contains the characters from a file opened in input or binary
mode.

Syntax
File.Input(Number)

Parameters

File
Reference to a "File" control.

Number
Numerical expression that defines the number of output characters.

WinCC Engineering V18 – Programming reference

176 System Manual, 11/2022, Online documentation
 VB scripting
1.4 VBScript for Windows CE

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

Function
This method returns bytes from a file opened in input or binary mode.

Syntax
File.InputB(Number)

Parameters

File
Reference to a "File" control.

Number
Each valid numerical expression that describes the number of output bytes.

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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 177
VB scripting
1.4 VBScript for Windows CE

1.4.5.10 InputFields

Function
The method reads data from an open sequential file and outputs a one-dimensional variant data
field.

Syntax
File.InputFields(Number)

Parameters

File
Reference to a "FileSystem" control.

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.

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.

WinCC Engineering V18 – Programming reference

178 System Manual, 11/2022, Online documentation
 VB scripting
1.4 VBScript for Windows CE

1.4.5.11 Kill

Function
This method deletes files and folders from the hard disk.

Syntax
FileSystem.Kill Pathname

Parameters

FileSystem
Reference to a "FileSystem" control.

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

Function
This method reads a single line from an open sequential file and links it with a string tag.

Syntax
File.LineInputString

Parameters

File
Reference to a "File" control.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 179
VB scripting
1.4 VBScript for Windows CE

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

Function
This method writes a single line to an open sequential file.

Syntax
File.LinePrint Output

Parameters

File
Reference to a "FileSystem" control.

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.

1.4.5.14 MkDir

Function
This method creates a new folder.

WinCC Engineering V18 – Programming reference

180 System Manual, 11/2022, Online documentation
 VB scripting
1.4 VBScript for Windows CE

Syntax
FileSystem.MkDir Pathname

Parameters

FileSystem
Reference to a "FileSystem" control.

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

Function
The method renames an already existing file or a directory and all subdirectories.

Syntax
FileSystem.MoveFile PathName, NewPathName

Parameters

FileSystem
Reference to a "FileSystem" control.

PathName
A character string that contains the file name.

NewPathName
A character string that contains the file name to be copied.

Output values
None.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 181
VB scripting
1.4 VBScript for Windows CE

1.4.5.16 Open

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
Reference to a "FileSystem" control.

Pathname
A character string that contains the file name.

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.

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.

WinCC Engineering V18 – Programming reference

182 System Manual, 11/2022, Online documentation
 VB scripting
1.4 VBScript for Windows CE

1.4.5.17 Put

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.
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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 183
VB scripting
1.4 VBScript for Windows CE

• 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

Function
This method deletes an empty directory.

Syntax
FileSystem.RmDir Pathname

Parameters

FileSystem
Reference to a "FileSystem" control.

PathName
A character string that contains the file name.

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

Function
This method set the attribute data of a file.

WinCC Engineering V18 – Programming reference

184 System Manual, 11/2022, Online documentation
 VB scripting
1.4 VBScript for Windows CE

Syntax
FileSystem.SetAttr Pathname, Attributes

Parameters

FileSystem
Reference to a FileSystem Control

Pathname
A character string that contains the file name.

Attributes
A numerical expression that contains the sum of the file attributes. The following table shows
the possible values.

Constant Value Description

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.

1.4.5.20 WriteFields

Function
This method writes data to a sequential file.

Syntax
File.WriteFields [Data]

Parameters

File
Reference to a "File" control.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 185
VB scripting
1.4 VBScript for Windows CE

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.

WinCC Engineering V18 – Programming reference

186 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

1.5 VBS object model

1.5.1 VBS object model

VBS object model in WinCC

The following screen shows the VBS object model in WinCC:

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 187
VB scripting
1.5 VBS object model

$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.

WinCC Engineering V18 – Programming reference

188 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

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 objects 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.

Additional information
You can find additional information on the VBS object model in the FAQ with entry ID
"53752382" in the SIMATIC Customer Online Support:
https://support.industry.siemens.com/cs/ww/en/view/53752382 (https://
support.industry.siemens.com/cs/ww/en/view/53752382)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 189
VB scripting
1.5 VBS object model

1.5.2 Objects

1.5.2.1 HMIRuntime

Description

+0,5XQWLPH

6FUHHQV 6PDUW7DJV

6FUHHQ 6PDUW7DJ

Portrays the graphic runtime system.

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 493)

WinCC Engineering V18 – Programming reference

190 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

1.5.2.2 Screen object (list)

Description

+0,5XQWLPH

6FUHHQV

6FUHHQ

6FUHHQ,WHPV

A list of screen objects.

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:

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 191
VB scripting
1.5 VBS object model

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.

1.5.2.3 Screen

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").

WinCC Engineering V18 – Programming reference

192 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Use the object name as an index.

In the following example, the background color is changed from black to green:
'VBS_Example_BackColor
HMIRuntime.Screens("Rootscreen").BackColor = vbGreen

See also
ScreenItem (Page 193)

1.5.2.4 ScreenItem

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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 193
VB scripting
1.5 VBS object model

• "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.

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.

WinCC Engineering V18 – Programming reference

194 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

1.5.2.5 ScreenItems

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.
In the following example, the background color of the "RootScreen" circle in the "myCircle"
screen is set to green.

Dim objCircle
Set objCircle = HMIRuntime.Screens("RootScreen").ScreenItems("myCircle")
objCircle.BackColor = vbGreen

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 195
VB scripting
1.5 VBS object model

1.5.2.6 SmartTags

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.

WinCC Engineering V18 – Programming reference

196 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 197
VB scripting
1.5 VBS object model

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)
HMIRuntime.Trace strAirPressure

1.5.2.7 SmartTag

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.

WinCC Engineering V18 – Programming reference

198 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Example

'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

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.

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]")".

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 199
VB scripting
1.5 VBS object model

1.5.3 Objects

1.5.3.1 Alarm

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.

WinCC Engineering V18 – Programming reference

200 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

1.5.3.2 Alarms (list)

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)
• 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)

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.UserName = "Hans-Peter"
MyAlarm.Create "MyApplication"

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 201
VB scripting
1.5 VBS object model

See also
AlarmID (Page 502)

1.5.3.3 AlarmLogs (list)

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.
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.

WinCC Engineering V18 – Programming reference

202 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

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 1339)
Remove (Page 1334)

1.5.3.4 DataItem

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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 203
VB scripting
1.5 VBS object model

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

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 1168)
Name (Page 827)

WinCC Engineering V18 – Programming reference

204 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

1.5.3.5 DataLogs (list)

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.
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.
You also set the type of log ("Fast data log", "Slow data log", "Fast data log and Slow data
log").
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 data log are connected to Runtime.
• "Remove" method
Previously swapped-in log segments of the data log are removed from the Runtime project.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 205
VB scripting
1.5 VBS object model

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 1339)
Remove (Page 1334)

1.5.3.6 DataSet (list)

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.

WinCC Engineering V18 – Programming reference

206 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

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
• "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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 207
VB scripting
1.5 VBS object model

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.Trace "motor1: " & HMIRuntime.DataSet("motor1").Value & vbNewLine
HMIRuntime.DataSet.Remove("motor1")

See also
RemoveAll (Page 1337)
Remove (Page 1334)
Item (Page 1315)
Add (Page 1254)

WinCC Engineering V18 – Programming reference

208 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

1.5.3.7 HMIRuntime

Description

+0,5XQWLPH

$ODUPV

$ODUP

7DJV

7DJ

6FUHHQV

6FUHHQ

'DWD6HW

'DWD,WHP

/RJJLQJ

$FWLYH3URMHFW

$FWLYH6FUHHQ

The HMIRuntime object represents the graphic Runtime environment.

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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 209
VB scripting
1.5 VBS object model

• "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 1359)
Stop (Page 1359)
Language (Page 759)
Tags (Page 998)
Logging (Page 794)
DataSet (Page 644)
CurrentContext (Page 639)
MenuToolBarConfig (Page 800)
ActiveScreen (Page 493)
BaseScreenName (Page 544)
SmartTags (Page 953)

1.5.3.8 Item

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.

WinCC Engineering V18 – Programming reference

210 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

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

Description

6FUHHQV

6FUHHQ

/D\HUV

/D\HU

The Layer object returns the result of access to the layers list.

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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 211
VB scripting
1.5 VBS object model

You can use the "Layer" object as follows:

• "Visible" property
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 827)

WinCC Engineering V18 – Programming reference

212 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

1.5.3.10 Layers (list)

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" property
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 1315)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 213
VB scripting
1.5 VBS object model

1.5.3.11 Logging

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.
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.
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 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.

WinCC Engineering V18 – Programming reference

214 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

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 1339)
Remove (Page 1334)
DataLogs (list) (Page 205)
AlarmLogs (list) (Page 202)

1.5.3.12 Project

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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 215
VB scripting
1.5 VBS object model

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 827)
Path (Page 860)

1.5.3.13 Screen

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.

WinCC Engineering V18 – Programming reference

216 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

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
Use the object name as an index.

Example
In the following example, the background color is changed from black to green:

'VBS_Example_BackColor
HMIRuntime.Screens("Rootscreen").BackColor = vbGreen

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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 217
VB scripting
1.5 VBS object model

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 1333)
Activate (Page 1250)
ObjectSizeDeclutteringEnable (Page 837)
ObjectSizeDeclutteringMax (Page 838)
ObjectSizeDeclutteringMin (Page 838)
LayerDeclutteringEnable (Page 769)
Layers (Page 770)
DataSet (Page 644)
ExtendedZoomingEnable (Page 682)
AccessPath (Page 492)

WinCC Engineering V18 – Programming reference

218 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

1.5.3.14 ScreenItem

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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 219
VB scripting
1.5 VBS object model

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.

See also
Activate (Page 1250)
Layer (Page 764)
ScreenItems (Page 900)
Top (Page 1083)

WinCC Engineering V18 – Programming reference

220 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

1.5.3.15 ScreenItems (list)

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" property
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
In the following example, the background color of the "RootScreen" circle in the "myCircle"
screen is set to green.

Dim objCircle
Set objCircle = HMIRuntime.Screens("RootScreen").ScreenItems("myCircle")
objCircle.BackColor = vbGreen

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 221
VB scripting
1.5 VBS object model

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 1315)
ScreenItems (Page 900)
Top (Page 1083)

WinCC Engineering V18 – Programming reference

222 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

1.5.3.16 Screen object (list)

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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 223
VB scripting
1.5 VBS object model

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 901)

WinCC Engineering V18 – Programming reference

224 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

1.5.3.17 SmartTag

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

'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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 225
VB scripting
1.5 VBS object model

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.

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

Description

+0,5XQWLPH

6PDUW7DJV

6PDUW7DJ

WinCC Engineering V18 – Programming reference

226 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

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.

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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 227
VB scripting
1.5 VBS object model

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

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)
HMIRuntime.Trace strAirPressure

See also
SmartTag (Page 225)

WinCC Engineering V18 – Programming reference

228 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

1.5.3.19 Tag

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".

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 229
VB scripting
1.5 VBS object model

Usage
Use the "Tag" object as follows:
• "Name", "QualityCode", "TimeStamp", "LastError" and "ErrorDescription" properties
Read information on the tag
• "Write" method, "Value" property
Set value of a tag
• "Read" method, "Value" property
Read value of 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 shows the declaration of an "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.

WinCC Engineering V18 – Programming reference

230 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

CrossReference and ChangeObjectReference

All the tags 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.
CrossReference and ChangeObjectReference will work together with the tag name. However,
if the "define", "const" or a string tag are used, CrossReference and ChangeObjectReference
won't work in the Engineering System. The script runs in Runtime.

Note
The WINCC:TAGNAME_SECTION code has no effect??? and must be rewritten during the
migration of a previous project, if necessary.

Note
Compound tag names might not be recognized by the CrossReference.

See also
Name (Page 827)
Value (Page 1168)
ErrorDescription (Page 670)
LastError (Page 763)
QualityCode (Page 875)
TimeStamp (Page 1042)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 231
VB scripting
1.5 VBS object model

1.5.3.20 Tags (list)

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.

WinCC Engineering V18 – Programming reference

232 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

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)

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")

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 233
VB scripting
1.5 VBS object model

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 670)
LastError (Page 763)

1.5.4 Object types

1.5.4.1 Object types available in VBS

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

WinCC Engineering V18 – Programming reference

234 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

VBS name Display name Script support Available in

WinCC RT CE WinCC RT Ad‐ WinCC RT Pro‐
(Panels) vanced fessional
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

VBS name Display name Script support Available in

WinCC RT CE WinCC RT Ad‐ WinCC RT Pro‐
(Panels) vanced fessional
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 Yes 2
- -
RoundButton Round button Yes - - Yes

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 235
VB scripting
1.5 VBS object model

VBS name Display name Script support Available in

WinCC RT CE WinCC RT Ad‐ WinCC RT Pro‐
(Panels) vanced fessional
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

VBS name Display name Script support Available in

WinCC RT CE WinCC RT Ad‐ WinCC RT Pro‐
(Panels) vanced fessional
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 view Yes Yes Yes Yes
SysDiagWindow System diagnostics view No1 Yes Yes -
TrendRulerControl Value table Yes - - Yes
TrendView Trend view Yes Yes Yes -

WinCC Engineering V18 – Programming reference

236 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

VBS name Display name Script support Available in

WinCC RT CE WinCC RT Ad‐ WinCC RT Pro‐
(Panels) vanced fessional
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

AlarmControl

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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 237
VB scripting
1.5 VBS object model

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 510) RW - - Specifies whether the alarms of all available servers
are displayed.
AllTagTypesAllowed - - - -
ApplyProjectSettings RW - - Specifies whether the project settings are applied
(Page 513) from the "HMI alarms" editor.
ApplyProjectSettingsFor‐ - - - -
DesignMode
AssignedFilters - - - -
AssignedHitlistFilters - - - -
AutoCompleteColumns RW - - Specifies whether empty columns are shown if the
(Page 519) control is wider than the configured columns.
AutoCompleteRows RW - - Specifies whether empty rows are shown if the con‐
(Page 519) trol is longer than the number of configured rows.
AutoScroll (Page 521) RW - - Specifies how the alarm window reacts when new
alarms appear.
AutoSelectionColors RW - - Specifies whether the colors defined by the system
(Page 521) are used as the selection colors for cells and rows.
AutoSelectionRectColor RW - - Specifies whether the selection frame is shown with
(Page 522) the color defined by the system.
BackColor (Page 526) RW - - Specifies the background color of the selected object.
Blocks - - - -
BorderColor - - - -
BorderWidth (Page 577) RW - - Specifies the line thickness of the selected object.
Bounds - - - -

WinCC Engineering V18 – Programming reference

238 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
CanBeGrouped - - - -
Caption (Page 587) RW - - Specifies the text that is displayed in the header of the
selected object.
CellCut (Page 591) RW - - Specifies whether the contents of the cells are abbre‐
viated if the cells are too narrow.
CellSpaceBottom RW - - Specifies the bottom margin of the table cells.
(Page 592)
CellSpaceLeft RW - - Specifies the left indent used in the table cells.
(Page 593)
CellSpaceRight RW - - Specifies the right indent used in the table cells.
(Page 593)
CellSpaceTop RW - - Specifies the top margin of the table cells.
(Page 594)
Closeable (Page 599) RW - - Specifies whether the object can be closed in runtime.
ColumnResize RW - - Specifies whether you can change the width of the
(Page 616) columns.
Columns - - - -
ColumnScrollbar RW - - Enables the display of column scroll bars.
(Page 617)
ColumnTitleAlignment RW - - Specifies the type of column title alignment.
(Page 627)
ColumnTitles (Page 628) RW - - Specifies whether the column header is displayed.
ControlDesignMode RW - - Specifies the style of the control.
(Page 634)
DefaultFilterEom - - - -
DefaultHitListFilterEom - - - -
DefaultMsgFilterSQL RW - - Specifies an SQL statement as default for alarm fil‐
(Page 645) ters.
DefaultSort (Page 646) RW - - Specifies the type of sorting.
DefaultSort2 (Page 646) RW - - Specifies the type of sorting.
DefaultSort2Column RW - - Specifies a column by which the alarm view is sorted
(Page 647) initially by default.
DiagnosticsContext RW - - Specifies the diagnostics context.
(Page 648)
DisplayOptions RW - - Specifies whether alarms whose view was sup‐
(Page 653) pressed are displayed.
DoubleClickAction RW - - Specifies the action to be executed in runtime by
(Page 655) double-clicking on a message line.
Enabled (Page 660) RW - - Specifies whether the selected object can be operat‐
ed in runtime.
ExportDelimiter - - - -
ExportDirectoryChange‐ RW - - Specifies whether the data export directory can be
able (Page 674) changed in runtime.
ExportDirectoryname RW - - Specifies the target directory for the exported run‐
(Page 675) time data.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 239
VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
ExportFileExtension RW - - Specifies the file extension of the export file. Only the
(Page 675) "csv" file extension is currently supported.
ExportFilename RW - - Specifies the name of the target file for the exported
(Page 676) runtime data.
ExportFilenameChange‐ RW - - Specifies whether the export file name can be
able (Page 677) changed in runtime.
ExportFormat - - - -
ExportFormatGuid RW - - Specifies the assignment of ID number and export
(Page 678) provider.
ExportFormatName RW - - Specifies the export file format. Only the "csv" file for‐
(Page 679) mat is currently available for the export.
ExportParameters RW - - Specifies the parameters of the selected format by
(Page 680) means of the properties dialog.
ExportSelection RW - - Specifies which runtime data of the control is expor‐
(Page 681) ted.
ExportShowDialog RW - - Specifies whether the data export dialog is shown in
(Page 681) runtime.
FillPattern - - - -
FillPatternColor - - - -
Filter - - - -
Font (Page 705) RW - - Specifies the font.
GridLineColor RW - - Specifies the color for the grid lines.
(Page 717)
GridLineWidth RW - - Specifies the width of the separation lines in pixels.
(Page 719)
Height (Page 720) RW - - Specifies the height of the selected object.
Hitlist - - - -
HitlistColumnAdd RW - - Transfers the selected alarm text block from the list of
(Page 727) available alarm blocks to the list of selected alarm
blocks.
HitlistColumnCount RW - - Specifies the number of alarm text blocks displayed in
(Page 727) the hit list in Runtime.
HitlistColumnIndex RW - - References an alarm text block that is selected for the
(Page 728) hit list.
HitlistColumnName RW - - Shows the name of the alarm text block from the hit
(Page 729) 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 729) lected alarm blocks and pastes it into the list of exist‐
ing alarm blocks.
HitlistColumnRepos RW - - Changes the sorting order of the alarm blocks.
(Page 730)
HitlistColumnSort RW - - Specifies the sorting order in the hit list for the alarm
(Page 730) text block that is referenced in "HitlistColumnIndex".
HitlistColumnSortIndex RW - - Defines the sorting order of the alarm text block ref‐
(Page 731) erenced in "HitlistColumnIndex" in the hit list.

WinCC Engineering V18 – Programming reference

240 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
HitlistColumnVisible RW - - Specifies a list with the selected alarm text blocks of
(Page 732) the hit list which are used in the control in Runtime.
HitlistDefaultSort RW - - Sets the default sorting order in the table columns of
(Page 732) the hit list.
HitlistFilter - - - -
HitlistMaxSourceItems RW - - Sets the maximum number of data records from the
(Page 733) 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 734) maximum number of data records that is defined in
"HitlistMaxSourceItems" is reached.
HitListRelTime RW - - Sets a time range for the statistics.
(Page 734)
HitListRelTimeFactor RW - - Specifies the time factor that together with time type
(Page 735) "HitlistRelTimeFactorType" determines the time peri‐
od for which the statistics of the hit list is created.
HitlistRelTimeFactor‐ RW - - Specifies the time type which, alongside the time fac‐
Type (Page 735) tor "HitlistRelativeTimeFactor", determines the time
period in which the statistics of the hit list will be
created.
HorizontalGridLines RW - - Specifies whether horizontal separating lines are dis‐
(Page 737) played.
IconSpace (Page 740) RW - - Specifies the spacing between icons and text in the
table cells.
IsActive - - - -
Layer (Page 764) RW - - Specifies the layer in the screen that contains an ob‐
ject.
Left (Page 770) RW - - Specifies the value of the X coordinate of the object.
LineBackgroundColor - - - -
LineColor (Page 786) RW - - Specifies the color of the window separation lines.
LineStyle - - - -
LineWidth (Page 790) RW - - Specifies the line thickness of the selected object.
Location - - - -
LongTermArchiveCon‐ RW - - Specifies how alarms are displayed in the alarm view
sistency (Page 795) when the "Historical alarm list (long-term)" is config‐
ured.
MessageBlockAlign‐ RW - - Sets the mode of alignment for the table contents of
ment (Page 801) the selected alarm block.
MessageBlockAutoPreci‐ RW - - Enables automatic setting of the number of decimal
sions (Page 802) places.
MessageBlockCaption RW - - Specifies the caption of the column header in the
(Page 803) alarm view for the selected alarm text block.
MessageBlockCount RW - - Specifies the number of existing alarm text blocks
(Page 803) that are available for the alarm list and hit list.
MessageBlockDateFor‐ RW - - Specifies the date format for displaying the alarms.
mat (Page 804)
MessageBlockExponen‐ RW - - Specifies the exponential notation for visualization of
tialFormat (Page 804) the values of a selected alarm block.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 241
VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
MessageBlockFlashOn RW - - Enables flashing of the selected alarm block in Run‐
(Page 805) time when an alarm appears.
MessageBlockHideText RW - - Enables the textual display of the content of the se‐
(Page 806) lected alarm block.
MessageBlockHideTitle‐ RW - - Specifies textual display of the caption of the selected
Text (Page 806) alarm block.
MessageBlockId RW - - Specifies the assignment of ID number and alarm text
(Page 807) block in the alarm view.
MessageBlockIndex RW - - References an existing alarm text block.
(Page 808)
MessageBlockLeading‐ RW - - Enables the display of the selected alarm block with
Zeros (Page 808) leading zeroes.
MessageBlockLength RW - - Specifies the length of the selected alarm block based
(Page 809) on the number of characters.
MessageBlockName RW - - Specifies the name for the selected alarm text block.
(Page 809)
MessageBlockPrecisions RW - - Specifies the number of decimal places for the values
(Page 810) of the selected alarm block.
MessageBlockSelected RW - - Existing alarm blocks are blocks that are available for
(Page 810) use in the control in Runtime for the alarm list or hit
list.
MessageBlockShowDate RW - - Specifies whether to display both the date and time in
(Page 811) the "Time" alarm text block.
MessageBlockShowIcon RW - - Enables the display of the content of the selected
(Page 812) alarm block as icon.
MessageBlockShowTi‐ RW - - Specifies textual display of the caption of the selected
tleIcon (Page 812) alarm block.
MessageBlockTextId RW - - Specifies naming of the selected alarm text block by
(Page 813) 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 813) display the alarms.
MessageBlockType RW - - Specifies the number of existing alarm text blocks
(Page 814) that are available for the alarm list and hit list.
MessageColumnAdd RW - - Adds the selected alarm text block from the list of
(Page 815) available alarm blocks to the list of selected alarm
blocks.
MessageColumnCount RW - - Specifies the number of selected alarm text blocks
(Page 815) displayed in the alarm list in Runtime.
MessageColumnIndex RW - - References an alarm text block selected for the alarm
(Page 816) list.
MessageColumnName RW - - Specifies the name of the alarm text block in the
(Page 817) 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 817) lected alarm blocks and pastes it into the list of exist‐
ing alarm blocks.

WinCC Engineering V18 – Programming reference

242 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
MessageColumnRepos RW - - Specifies the order of the alarm text blocks.
(Page 818)
MessageColumnSort RW - - Specifies the sorting order for the alarm text block
(Page 818) that is referenced in "MessageColumnIndex".
MessageColumnSortIn‐ RW - - Defines the sorting order of the alarm text block ref‐
dex (Page 819) erenced in "MessageColumnIndex".
MessageColumnVisible RW - - Specifies whether alarm text blocks are displayed in
(Page 820) the alarm view.
MessageListType RW - - This setting defines which alarm list contents are dis‐
(Page 820) played when screen opens.
Moveable (Page 825) RW - - Specifies whether the window can be moved in Run‐
time.
MsgFilterSQL RW - - Specifies one or several SQL statements for user-de‐
(Page 826) fined selection of the alarms.
Name - - - -
Object - - - -
OcxGuid - - - -
OcxState - - - -
OcxStateForEs2Rt - - - -
OperatorAlarms - - - -
OperatorMessageId RW - - Specifies the assignment of ID number and trigger
(Page 841) event in the alarm view.
OperatorMessageIndex RW - - References an operator message event.
(Page 842)
OperatorMessageName RW - - Specifies the name which is referenced with the "Op‐
(Page 842) eratorMessageIndex" event in message events for op‐
erator messages.
OperatorMessageNum‐ RW - - Specifies a message number for the operator mes‐
ber (Page 843) sage of the selected message event if you do not use
the operator message of WinCC.
OperatorMessageSelec‐ RW - - Activates the message events in the list that trigger
ted (Page 843) operator messages.
OperatorMessage‐ RW - - Specifies a alarm text block of the operated message
Source1 (Page 844) to be added to "Process value block 1" of the operator
message configured here.
OperatorMessage‐ RW - - Specifies a alarm text block of the operated message
Source10 (Page 850) to be added to "Process value block 10" of the opera‐
tor message configured here.
OperatorMessage‐ RW - - Specifies a alarm text block of the operated message
Source2 (Page 845) to be added to "Process value block 2" of the operator
message configured here.
OperatorMessage‐ RW - - Specifies a alarm text block of the operated message
Source3 (Page 845) to be added to "Process value block 3" of the operator
message configured here.
OperatorMessage‐ RW - - Specifies a alarm text block of the operated message
Source4 (Page 846) to be added to "Process value block 4" of the operator
message configured here.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 243
VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
OperatorMessage‐ RW - - Specifies a alarm text block of the operated message
Source5 (Page 847) to be added to "Process value block 5" of the operator
message configured here.
OperatorMessage‐ RW - - Specifies a alarm text block of the operated message
Source6 (Page 847) to be added to "Process value block 6" of the operator
message configured here.
OperatorMessage‐ RW - - Specifies a alarm text block of the operated message
Source7 (Page 848) to be added to "Process value block 7" of the operator
message configured here.
OperatorMessage‐ RW - - Specifies a alarm text block of the operated message
Source8 (Page 849) to be added to "Process value block 8" of the operator
message configured here.
OperatorMessage‐ RW - - Specifies a alarm text block of the operated message
Source9 (Page 849) to be added to "Process value block 9" of the operator
message configured here.
OperatorMessageSour‐ RW - - Specifies the format of the source content to be trans‐
ceType1 (Page 851) ferred.
OperatorMessageSour‐ RW - - Specifies the format of the source content to be trans‐
ceType10 (Page 857) ferred.
OperatorMessageSour‐ RW - - Specifies the format of the source content to be trans‐
ceType2 (Page 851) ferred.
OperatorMessageSour‐ RW - - Specifies the format of the source content to be trans‐
ceType3 (Page 852) ferred.
OperatorMessageSour‐ RW - - Specifies the format of the source content to be trans‐
ceType4 (Page 853) ferred.
OperatorMessageSour‐ RW - - Specifies the format of the source content to be trans‐
ceType5 (Page 853) ferred.
OperatorMessageSour‐ RW - - Specifies the format of the source content to be trans‐
ceType6 (Page 854) ferred.
OperatorMessageSour‐ RW - - Specifies the format of the source content to be trans‐
ceType7 (Page 855) ferred.
OperatorMessageSour‐ RW - - Specifies the format of the source content to be trans‐
ceType8 (Page 855) ferred.
OperatorMessageSour‐ RW - - Specifies the format of the source content to be trans‐
ceType9 (Page 856) ferred.
PageMode (Page 858) RW - - Enables paging in the historical alarm list (long-term).
PageModeMessage‐ RW - - Defines the number of alarm shown per page when
Number (Page 859) paging the historical alarm list (long-term).
PrintJob (Page 873) RW - - Specifies a print job that is created in the "Reports"
editor.
RowScrollbar (Page 886) RW - - Specifies whether row scroll bars are displayed.
RowTitleAlignment RW - - Specifies the type of row header alignment.
(Page 886)
RowTitles (Page 887) RW - - Specifies that row headers will be displayed.
RTPersistence RW - - Specifies how online configurations of WinCC are re‐
(Page 888) tained.
RTPersistenceAuthoriza‐ RW - - Specifies the authorization required for online config‐
tion (Page 889) uration in runtime.

WinCC Engineering V18 – Programming reference

244 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
RTPersistenceType RW - - Specifies how online configurations of WinCC are re‐
(Page 890) tained.
SelectedCellColor RW - - Specifies the background color of the selected cell.
(Page 906)
SelectedCellForeColor RW - - Specifies the font color of the selected cell.
(Page 907)
SelectedRowColor RW - - Specifies the background color of the selected row.
(Page 909)
SelectedRowForeColor RW - - Specifies the font color of the selected row.
(Page 909)
SelectedTitleColor RW - - Specifies the background color of the selected table
(Page 911) header.
SelectedTitleForeColor RW - - Specifies the font color of the selected table header.
(Page 912)
SelectionColoring RW - - Specifies whether selection colors are used for cells or
(Page 914) rows.
SelectionRect RW - - Specifies whether a selection frame is used for the
(Page 916) selected cells or rows.
SelectionRectColor RW - - Specifies the color of the selection rectangle in the
(Page 917) alarm window if SelectionType equals "1".
SelectionRectWidth RW - - Specifies the line width of the selection rectangle in
(Page 917) the alarm window if SelectionType equals "1".
SelectionType RW - - Specifies the number of lines you can mark.
(Page 918)
ServerNames RW - - Specifies the servers of a distributed system that form
(Page 923) the data source for the alarm view.
ShowSortButton RW - - Specifies whether the sorting button is shown above
(Page 941) the vertical scroll bar.
ShowSortIcon RW - - Specifies whether the sorting icon is displayed.
(Page 942)
ShowSortIndex RW - - Specifies whether a sort index is displayed.
(Page 942)
ShowTitle (Page 947) RW - - Specifies the representation of the control's window
title.
Size - - - -
Sizeable (Page 952) 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 954) mouse click.
StatusbarBackColor RW - - Specifies the background color for status bars.
(Page 959)
StatusbarElementAdd RW - - Creates a new, user-defined status bar element.
(Page 960)
StatusbarElementAuto‐ RW - - Specifies whether the width of the selected status bar
Size (Page 961) element is set automatically.
StatusbarElementCount RW - - Specifies the number of configurable status bar ele‐
(Page 962) ments.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 245
VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
StatusbarElementIconId RW - - Specifies the ID number and symbol assignment of a
(Page 963) status bar element.
StatusbarElementID RW - - Specifies the ID number of the selected status bar
(Page 963) element.
StatusbarElementIndex RW - - Specifies the reference for a status bar element.
(Page 964)
StatusbarElementName RW - - Specifies the object name of the selected status bar
(Page 965) element.
StatusbarElementRe‐ RW - - Removes the selected user-defined status bar ele‐
move (Page 966) ment.
StatusbarElementRe‐ RW - - Changes the name of the user-defined status bar el‐
name (Page 967) ement that is referenced by the "StatusbarElementIn‐
dex" property.
StatusbarElementRepos RW - - Specifies the index of an element in the status bar of
(Page 968) the display and operating object.
StatusbarElements - - - -
StatusbarElementText RW - - Specifies the text of the selected status bar element.
(Page 969)
StatusbarElementTool‐ RW - - Specifies the tooltip text for the selected user-defined
tipText (Page 970) status bar element.
StatusbarElementUser‐ RW - - Specifies whether the configuration engineer has
Defined (Page 970) added the status bar element as a new user-defined
element.
StatusbarElementVisi‐ RW - - Specifies whether the referenced element of the sta‐
ble (Page 971) tus bar element is displayed in Runtime.
StatusbarElementWidth RW - - Specifies the width of the referenced status bar ele‐
(Page 972) ment in pixels.
StatusbarFont RW - - Specifies the font of the texts in the status bar.
(Page 973)
StatusbarFontColor RW - - Specifies the color of the texts in the status bar.
(Page 974)
StatusbarShowTooltips RW - - Specifies whether tooltips are displayed for the ele‐
(Page 975) ments of the status bar in runtime.
StatusbarText RW - - Specifies the default text in the status bar.
(Page 976)
StatusbarUseBackColor RW - - Specifies whether the background color of the status
(Page 976) bar is shown.
StatusbarVisible RW - - Specifies whether the status bar of the control is dis‐
(Page 977) played.
TabIndex - - - -
TabIndexAlpha - - - -
TableColor (Page 988) RW - - Specifies the background color of the table rows in
the object.
TableColor2 (Page 989) RW - - Specifies the second background color of the rows.
TableForeColor RW - - Specifies the text color used in the table cells of the
(Page 990) object.

WinCC Engineering V18 – Programming reference

246 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
TableForeColor2 RW - - Specifies the second text color used in the table cells
(Page 991) of the object.
TimeBase (Page 1024) RW - - Specifies the time zone in which the time values are
displayed.
TitleColor (Page 1045) RW - - Specifies the background color of the table header.
TitleCut (Page 1046) 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 1047) for column and row headers in the object table.
TitleForeColor RW - - Specifies the text color for the table column and row
(Page 1047) headers of the object.
TitleGridLineColor RW - - Specifies the color of the separation lines in the title
(Page 1048) bar of the table.
TitleLightShadowColor RW - - Specifies the color for the light side of the 3D shading
(Page 1049) for table column and row headers of the object.
TitleSort (Page 1050) RW - - Specifies how sorting by column header is triggered.
TitleStyle (Page 1051) RW - - Specifies whether a shading color is used for the table
header.
ToolbarAlignment RW - - Specifies the position of the toolbar.
(Page 1059)
ToolbarBackColor RW - - Specifies the background color of the toolbar.
(Page 1060)
ToolbarButtonActive RW - - Specifies whether the function linked to the button is
(Page 1061) activated in runtime.
ToolbarButtonAdd RW - - Creates a new user-defined button in the object's
(Page 1062) toolbar.
ToolbarButtonAuthoriza‐ RW - - Shows the authorization for the selected button func‐
tion (Page 1063) tion.
ToolbarButtonBe‐ RW - - Inserts a leading separator (vertical line) for the se‐
ginGroup (Page 1064) lected key function on the toolbar.
ToolbarButtonClick RW - - Clicks a toolbar button.
(Page 1065)
ToolbarButtonCount RW - - Specifies the number of buttons in the toolbar.
(Page 1065)
ToolbarButtonEnabled RW - - Specifies whether a user-defined toolbar button can
(Page 1066) be operated.
ToolbarButtonHotKey RW - - Specifies the shortcut for the selected button of the
(Page 1067) object.
ToolbarButtonID RW - - Specifies the key function via your unique ID number.
(Page 1068)
ToolbarButtonIndex RW - - References a button function.
(Page 1069)
ToolbarButtonLocked RW - - Enables/disables display of the locked, pressed state
(Page 1070) for a user-defined toolbar button.
ToolbarButtonName RW - - Specifies the name of the selected user-defined but‐
(Page 1071) ton.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 247
VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

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

Table 1-2 Methods

Methods RT Professio‐ RT Ad‐ Panel RT Description

nal vanced
Activate (Page 1250) Yes - - Enables the permanent area or the root screen.
ActivateDynamic Yes - - Dynamically activates a trigger and the specified cy‐
(Page 1252) cle for a property at runtime.
AttachDB (Page 1256) Yes - - Executes the "Connect backup" key function of the
control.
CopyRows (Page 1257) Yes - - Executes the "Copy lines" key function of the control.

WinCC Engineering V18 – Programming reference

248 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Methods RT Professio‐ RT Ad‐ Panel RT Description

nal vanced
DeactivateDynamic Yes - - Deactivates the trigger of the "ActivateDynamic"
(Page 1259) method used for the specified property in/during run‐
time.
DetachDB (Page 1262) Yes - - Executes the "Disconnect backup" key function of the
control.
Export (Page 1263) 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 1267) designated by name or index as "ICCAxMessageCol‐
umn" type.
GetHistlistColumnCol‐ Yes - - Returns the list of all column objects of the alarm
lection (Page 1265) view hit list as "ICCAxCollection" type.
GetMessageBlock Yes - - Returns the alarm text block object of the alarm view
(Page 1268) designated by name or index as "ICCAxMessage‐
Block" type.
GetMessageBlockCollec‐ Yes - - Returns the list of all alarm text block objects of the
tion (Page 1269) alarm view as "ICCAxCollection" type.
GetMessageColumn Yes - - Returns the column object of the alarm view desig‐
(Page 1270) nated by name or index as "ICCAxMessageColumn"
type.
GetMessageColumnCol‐ Yes - - Returns the list of all column objects of the alarm
lection (Page 1271) view as "ICCAxCollection" type.
GetOperatorMessage Yes - - Returns the operator message object of the alarm
(Page 1272) view designated by name or index as "ICCAxOpera‐
torMessage" type.
GetOperatorMessage‐ Yes - - Returns the list of all operator message objects of the
Collection (Page 1273) alarm view as "ICCAxCollection" type.
GetRow (Page 1274) 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 1276) controls as "ICCAxDataRowCollection" type.
GetSelectedRow Yes - - Returns the selected row object of a table-based con‐
(Page 1282) trol as "ICCAxDataRow" type.
GetSelectedRows Yes - - Returns the selected row objects of a table-based
(Page 1283) control as type "ICCAxDataRow" for multiple selec‐
tion.
GetStatusbarElement Yes - - Returns the element of the control's status bar des‐
(Page 1289) ignated by name or index as "ICCAxStatusbarEle‐
ment" type.
GetStatusbarElement‐ Yes - - Returns the list of all status bar elements of the con‐
Collection (Page 1290) trol as "ICCAxCollection" type.
GetToolbarButton Yes - - Returns the button function designated by name or
(Page 1297) index on the control toolbar as "ICCAxToolbarButton"
type.
GetToolbarButtonCollec‐ Yes - - Returns the list of all button functions of the control
tion (Page 1298) toolbar as "ICCAxCollection" type.
HideAlarm (Page 1314) Yes - - Executes the "Hide alarm" button function of the
alarm view.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 249
VB scripting
1.5 VBS object model

Methods RT Professio‐ RT Ad‐ Panel RT Description

nal vanced
LockAlarm (Page 1317) Yes - - Executes the "Disable alarm" button function of the
alarm view.
LoopInAlarm (Page 1317) Yes - - Executes the "Loop in alarm" button function of the
alarm view.
MoveToFirstLine Yes - - Executes the "First alarm" button function of the
(Page 1319) alarm view.
MoveToFirstPage Yes - - Executes the "First page" button function of the alarm
(Page 1319) view.
MoveToLastLine Yes - - Executes the "Last alarm" button function of the
(Page 1320) alarm view.
MoveToLastPage Yes - - Executes the "Last page" button function of the alarm
(Page 1321) view.
MoveToNextLine Yes - - Executes the "Next alarm" button function of the
(Page 1322) alarm view.
MoveToNextPage Yes - - Executes the "Next page" button function of the
(Page 1322) alarm view.
MoveToPreviousLine Yes - - Executes the "Previous alarm" button function of the
(Page 1323) alarm view.
MoveToPreviousPage Yes - - Executes the "Previous page" button function of the
(Page 1324) alarm view.
Print (Page 1327) Yes - - Executes the "Print" button function of the control.
QuitHorn (Page 1328) Yes - - Executes the "Alarm annunciator acknowledgment"
button function of the alarm view.
QuitSelected (Page 1328) Yes - - Executes the "Single acknowledgment" button func‐
tion of the alarm view.
QuitVisible (Page 1329) Yes - - Executes the "Group acknowledgment" button func‐
tion of the alarm view.
SelectAll (Page 1342) Yes - - Selects all rows in a table-based control.
SelectRow (Page 1343) Yes - - Selects a specific row in a table-based control.
ShowComment Yes - - Executes the "Comment dialog" button function of
(Page 1346) the alarm view.
ShowDisplayOptionsDia‐ Yes - - Executes the "Display options dialog" button function
log (Page 1347) of the alarm view.
ShowEmergencyQuit‐ Yes - - Executes the "Emergency acknowledgment" button
Dialog (Page 1347) function of the alarm view.
ShowHelp (Page 1348) Yes - - Executes the "Help" button function of the control.
ShowHideList Yes - - Executes the "List of alarm to hide" button function of
(Page 1348) the alarm view.
ShowHitList (Page 1349) Yes - - Executes the "Hit list" button function of the alarm
view.
ShowInfoText Yes - - Executes the "About dialog" button function of the
(Page 1349) alarm view.
ShowLockDialog Yes - - Executes the "Lock dialog" button function of the
(Page 1350) alarm view.
ShowLockList Yes - - Executes the "Lock list" button function of the alarm
(Page 1350) view.

WinCC Engineering V18 – Programming reference

250 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Methods RT Professio‐ RT Ad‐ Panel RT Description

nal vanced
ShowLongTermArch‐ Yes - - Executes the "Historical alarm list (long-term)" button
iveList (Page 1351) function of the alarm view.
ShowMessageList Yes - - Executes the "Alarm list" button function of the alarm
(Page 1351) view.
ShowPropertyDialog Yes - - Executes the "Configuration dialog" button function
(Page 1352) of the control.
ShowSelectionDialog Yes - - Executes the "Selection dialog" button function of the
(Page 1354) alarm view.
ShowShortTermArch‐ Yes - - Executes the "Historical alarm list (short-term)" but‐
iveList (Page 1355) ton function of the alarm view.
ShowSortDialog Yes - - Executes the "Sorting dialog" button function of the
(Page 1356) alarm view.
ShowTimebaseDialog Yes - - Executes the "Timebase dialog" button function of
(Page 1357) the alarm view.
UnhideAlarm Yes - - Executes the "Unhide alarm" button function of the
(Page 1360) alarm view.
UnlockAlarm (Page 1360) Yes - - Executes the "Unlock alarm" button function of the
alarm view.
UnselectAll (Page 1361) Yes - - Removes all selections from the cells of a table-based
control.
UnselectRow (Page 1361) Yes - - Removes the selections from a specific cell of a table-
based control.

AlarmView

Description

6FUHHQV

6FUHHQ

6FUHHQ,WHPV

6FUHHQ,WHP

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 251
VB scripting
1.5 VBS object model

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.

Abbreviation Access in Runtime

R Read
RW Read and write
- No access

Table 1-3 Properties

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
AlarmAreaHeight - - - -
AlarmAreaWidth - - - -
AlarmClasses - - - -
AlarmLog - - - -
AlarmSource - - - -
AlarmTextTag - - - -
AllTagTypesAllowed - - - -
Authorization - - - -
BackColor (Page 526) - RW RW Specifies the background color of the selected object.
BorderBackColor - - - -
BorderColor - - - -
BorderWidth - - - -
Bounds - - - -
ButtonBackColor - - - -
ButtonBackFillStyle - - - -
ButtonBarElements - - - -
ButtonBarStyle - - - -
ButtonBorderBackColor - - - -
ButtonBorderColor - - - -
ButtonBorderWidth - - - -
ButtonCornerRadius - - - -
ButtonEdgeStyle - - - -
ButtonFirstGradientCol‐ - - - -
or

WinCC Engineering V18 – Programming reference

252 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
ButtonFirstGradientOff‐ - - - -
set
ButtonMiddleGradient‐ - - - -
Color
ButtonPositions - - - -
ButtonSecondGradient‐ - - - -
Color
ButtonSecondGradien‐ - - - -
tOffset
CanBeGrouped - - - -
ColumnOrder - - - -
Columns - - - -
ColumnsMoveable - - - -
ColumnTextAckGroup - - - -
ColumnTextAlarmState - - - -
ColumnTextAlarmText - - - -
ColumnTextClassName - - - -
ColumnTextDate - - - -
ColumnTextDevice - - - -
ColumnTextDiagnosable - - - -
ColumnTextNumber - - - -
ColumnTextTime - - - -
ColumnWidth - - - -
ConfiguredAlarmClasses - - - -
CornerRadius - - - -
CountOfLinesPerAlarms - - - -
CountOfVisibleAlarms - - - -
DeviceStyle - - - -
EdgeStyle - - - -
Enabled (Page 660) - RW RW Specifies whether the selected object can be operat‐
ed in runtime.
ES2RT_ButtonPositions - - - -
ES2RT_ColumnOrder - - - -
ES2RT_ColumnWidth - - - -
ES2RT_MessageArea‐ - - - -
Height
ES2RT_MessageArea‐ - - - -
Width
FilterTag - - - -
FilterText - - - -
FitToSize - - - -
Flashing - - - -
FocusColor (Page 703) - RW RW Specifies the color of the focus border when the ob‐
ject has the focus.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 253
VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
FocusWidth (Page 704) - RW RW Specifies the border width when the object has the
focus.
ForeColor - - - -
GridLineColor - RW RW Specifies the color for the grid lines.
(Page 717)
Height - R R Specifies the height.
HorizontalScrollingEna‐ - - - -
bled
IsRunningUnderCE - - - -
Layer (Page 764) - RW RW Specifies the layer in the screen that contains an ob‐
ject.
Left (Page 770) - RW RW Specifies the value of the X coordinate.
LineAlarmView - - - -
Location - - - -
MessageAreaHeight - - - -
MessageAreaLeft - - - -
MessageAreaTop - - - -
MessageAreaWidth - - - -
Name - - - -
PaddingBottom - - - -
PaddingLeft - - - -
PaddingRight - - - -
PaddingTop - - - -
PreferredUseOnAck - - - -
S7Device - - - -
SecurityForSimpleVie‐ - - - -
wEnabled
SelectionBackColor - RW RW Specifies the background color of the selected cells.
(Page 913)
SelectionForeColor - RW RW Specifies the foreground color of the selected cells.
(Page 915)
SeparateLineForAlarm‐ - - - -
Text
ShowAcknowledgeBut‐ - - - -
ton
ShowAlarmsFromDate - RW RW Specifies that only those message events are dis‐
(Page 925) played that are saved in this tag.
ShowAlarmsToAcknowl‐ - - - -
edge
ShowColumnHeaders - - - -
ShowHelpButton - - - -
ShowHorizontalGrid‐ - - - -
lines
ShowLoopInAlarmBut‐ - - - -
ton

WinCC Engineering V18 – Programming reference

254 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
ShowMilliseconds - - - -
ShowPendingAlarms - - - -
Size - - - -
SortByTimeDirection - RW RW Specifies whether the last alarm received is shown at
(Page 953) the top (ascending sorting order).
SortByTimeEnabled - RW RW Specifies whether alarm sorting can be altered ac‐
(Page 954) cording to the time.
StyleItem - - - -
SupportsS7Diagnostic‐ - - - -
sInSimpleView
TabIndex - - - -
TabIndexAlpha - - - -
TableBackColor - RW RW Specifies the background color of the table cells.
(Page 987)
TableEvenRowBackColor - - - -
TableFont - - - -
TableForeColor - RW RW Specifies the text color used in the table cells of the
(Page 990) object.
TableHeaderBackColor - RW RW Specifies the background color in the header of the
(Page 993) table.
TableHeaderBackFill‐ - - - -
Style
TableHeaderBorderBack‐ - - - -
Color
TableHeaderBorderColor - - - -
TableHeaderBorder‐ - - - -
Width
TableHeaderCornerRa‐ - - - -
dius
TableHeaderEdgeStyle - - - -
TableHeaderFirstGra‐ - - - -
dientColor
TableHeaderFirstGra‐ - - - -
dientOffset
TableHeaderFont - - - -
TableHeaderForeColor - RW RW Specifies the text color in the header of the table.
(Page 995)
TableHeaderMiddleGra‐ - - - -
dientColor
TableHeaderPaddingBot‐ - - - -
tom
TableHeaderPaddingLeft - - - -
TableHeaderPadding‐ - - - -
Right
TableHeaderPaddingTop - - - -

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 255
VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
TableHeaderSecondGra‐ - - - -
dientColor
TableHeaderSecondGra‐ - - - -
dientOffset
ToolbarHeight - - - -
ToolbarLeft - - - -
ToolbarTop - - - -
ToolbarWidth - - - -
Top (Page 1083) - RW RW Specifies the value of the Y coordinate.
UseButtonFirstGradient - - - -
UseButtonSecondGradi‐ - - - -
ent
UseDesignColorSchema - - - -
UseTableHeaderFirst‐ - - - -
Gradient
UseTableHeaderSecond‐ - - - -
Gradient
VerticalScrollBarEnabled - - - -
VerticalScrollingEnabled - - - -
ViewType - - - -
ViewTypeForSaveStream - - - -
Visible (Page 1204) - RW RW Specifies whether the selected object is visible.
Width - R R Specifies the width.

Table 1-4 Methods

Methods RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Activate (Page 1250) - Yes Yes Enables the permanent area or the root screen.

WinCC Engineering V18 – Programming reference

256 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

ApplicationWindow

Description

6FUHHQV

6FUHHQ

6FUHHQ,WHPV

6FUHHQ,WHP

Represents the "ApplicationWindow" object. The ApplicationWindow object is an element of

the ScreenItems list.

Type identifier in VBS

HMIApplicationWindow

Abbreviation Access in Runtime

R Read
RW Read and write
- No access

Table 1-5 Properties

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
AllTagTypesAllowed - - - -
BorderEnabled RW - - Specifies whether the window is displayed with a
(Page 565) border in runtime.
Bounds - - - -
CanBeGrouped - - - -
GSCRuntimeAllowed - - - -
Height (Page 720) RW - - Specifies the height.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 257
VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Layer (Page 764) RW - - Specifies the layer in the screen that contains an ob‐
ject.
Left (Page 770) RW - - Specifies the value of the X coordinate.
Location - - - -
Name - - - -
ShowCaption (Page 927) RW - - Specifies whether the title bar is shown.
Size - - - -
TabIndex - - - -
TabIndexAlpha - - - -
Template (Page 999) RW - - Specifies the template for displaying window content
in the "Print job/Script diagnostics" object.
Top (Page 1083) - - - -
Visible (Page 1204) RW - - Specifies whether the selected object is visible.
Width (Page 1217) RW - - Specifies the width of the object in pixels.
WindowCloseEnabled RW - - Specifies whether a window can be closed in Runtime.
(Page 1220)
WindowMaximizeEna‐ RW - - Specifies whether the object can be maximized in
bled (Page 1221) Runtime.
WindowMovingEnabled RW - - Specifies whether the object can be moved in Run‐
(Page 1221) time.
WindowOnTop RW - - Specifies whether the object always remains in the
(Page 1222) foreground in Runtime.
WindowsContents RW - - Specifies the content of the print job or script diag‐
(Page 1222) nostics.
WindowSizingEnabled RW - - Specifies whether the size can be changed.
(Page 1223)

Table 1-6 Methods

Methods RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Activate (Page 1250) Yes - - Enables the permanent area or the root screen.
ActivateDynamic Yes - - Dynamically activates a trigger and the specified cycle
(Page 1252) for a property at runtime.
DeactivateDynamic Yes - - Deactivates the trigger of the "ActivateDynamic"
(Page 1259) method used for the specified property in/during run‐
time.

WinCC Engineering V18 – Programming reference

258 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Bar

Description

6FUHHQV

6FUHHQ

6FUHHQ,WHPV

6FUHHQ,WHP

Represents the "Bar" object. The Bar object is an element of the ScreenItems list.

Type identifier in VBS

HMIBar

Abbreviation Access in Runtime

R Read
RW Read and write
- No access

Table 1-7 Properties

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
AlarmLowerLimit RW - - Specifies the low limit at which the alarm is triggered
(Page 503)
AlarmLowerLimitColor RW - - Specifies the bar color for the "AlarmLowerLimit" lim‐
(Page 504) it.
AlarmLowerLimitEna‐ RW - - Specifies whether the "AlarmLowerLimit" limit is
bled (Page 505) monitored.
AlarmLowerLimitRela‐ RW - - Specifies whether the low limit at which the interrupt
tive (Page 505) is triggered is evaluated as a percentage or an abso‐
lute value.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 259
VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
AlarmUpperLimit RW - - Specifies the high limit that triggers the interrupt.
(Page 506)
AlarmUpperLimitColor RW - - Specifies the bar color for the "AlarmUpperLimit" lim‐
(Page 507) it.
AlarmUpperLimitEna‐ RW - - Specifies whether the "AlarmUpperLimit" limit is
bled (Page 508) monitored.
AlarmUpperLimitRela‐ RW - - Specifies whether the high limit at which the inter‐
tive (Page 508) rupt is triggered is evaluated as a percentage or an
absolute value.
AllTagTypesAllowed - - - -
Authorization RW - - Specifies operating rights.
(Page 517)
AverageLast15Values RW - - Specifies whether the average of the last 15 values is
(Page 524) to be shown.
BackColor (Page 526) RW RW RW Specifies the background color.
BackFillStyle (Page 531) RW - - Specifies the fill pattern.
BackFlashingColorOff RW - - Specifies the background color for flash state "Off".
(Page 533)
BackFlashingColorOn RW - - Specifies the background color for flash state "On".
(Page 534)
BackFlashingEnabled RW - - Specifies whether the background flashes in run‐
(Page 535) time.
BackFlashingRate RW - - Specifies the flash rate of the background.
(Page 536)
BarBackColor (Page 539) RW RW RW Specifies the color of the bar background for the se‐
lected object.
BarBackFillStyle RW - - Specifies the fill style for the bar.
(Page 540)
BarBackFlashingColorOff - - - -
BarBackFlashingColorOn - - - -
BarBackFlashingEnabled - - - -
BarBackFlashingRate - - - -
BarEdgeStyle - - - -
BarOrientation RW - - Specifies the bar alignment.
(Page 544)
BorderBackColor RW - - Specifies the background color of the broken border
(Page 558) line.
BorderColor (Page 562) RW - - Specifies the line color.
BorderFlashingColorOff RW - - Specifies the color of the border line for the flashing
(Page 566) status "Off".
BorderFlashingColorOn RW - - Specifies the color of the border line for the flashing
(Page 567) status "On".
BorderFlashingEnabled RW - - Specifies whether the limit of the object can flash in
(Page 569) runtime.
BorderFlashingRate RW - - Specifies the flash rate of the border line.
(Page 570)

WinCC Engineering V18 – Programming reference

260 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
BorderStyle (Page 576) RW - - Specifies the type of border lines.
BorderWidth (Page 577) RW - - Specifies the line thickness of the selected object.
BorderWidth3D - - - -
Bounds - - - -
CanBeGrouped - - - -
ColorChangeHysteresis RW - - Specifies the hysteresis as a percentage of the display
(Page 601) value.
ColorChangeHysteresi‐ RW - - Specifies whether the object is displayed with hyste‐
sEnabled (Page 601) resis.
CompatibilityMode - - - -
CornerRadius - - - -
CornerStyle (Page 635) RW - - Specifies the shape of the corners of the specified
object.
CountDivisions RW - - Specifies the number of segments into which the bar
(Page 637) will be split by means of the large scale tick marks.
CountSubDivisions - RW RW Specifies the number of scale marks between two
(Page 637) main marks.
DeviceStyle - - - -
DrawInsideFrame RW - - Specifies whether the border line of the selected ob‐
(Page 655) ject with a line thickness greater than 1 should be
drawn within the border or symmetrically to the bor‐
der.
EdgeStyle (Page 657) RW - - Specifies the line style of the selected object.
Enabled (Page 660) RW RW RW Specifies whether the selected object can be operat‐
ed in runtime.
FillPatternColor RW - - Specifies the color of the fill pattern for the selected
(Page 685) object.
Flashing - - - -
FlashingColorOff - - - -
FlashingColorOn - - - -
FlashingEnabled - - - -
FlashingOnLimitViola‐ - - - -
tion
FlashingRate - - - -
Font - - - -
FontBold (Page 708) RW - - Specifies whether the text of the selected object is
shown in bold.
FontName (Page 709) RW - - Specifies the font of the selected object.
FontSize (Page 711) RW - - Specifies the font size of the text for the selected ob‐
ject.
ForeColor (Page 712) RW RW RW Specifies the font color of the text for the selected
object.
ForeColorTransparency - - - -
Height (Page 720) RW R R Specifies the height of the selected object.
InnerHeight - - - -

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 261
VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
InnerWidth - - - -
IntegerDigits (Page 748) RW - - Specifies the number of digits to the left of the deci‐
mal point (0 to 20).
LargeTickLabelingStep R - - Returns which scale sections are labeled.
(Page 760)
LargeTicksBold RW - - Specifies whether the long tick marks of a scale are
(Page 760) shown in bold.
LargeTicksSize RW - - Specifies the length of the long tick marks of a scale.
(Page 761)
Layer (Page 764) RW RW RW Specifies the layer in the screen that contains an ob‐
ject.
Left (Page 770) RW RW RW Specifies the value of the X coordinate of the selected
object.
Limit4LowerLimit RW - - Specifies the low limit for "Reserve4".
(Page 775)
Limit4LowerLimitColor RW - - Specifies the color for the "Reserve4" low limit.
(Page 776)
Limit4LowerLimitEna‐ RW - - Specifies whether the "Reserve4" low limit is moni‐
bled (Page 777) tored.
Limit4LowerLimitRela‐ RW - - Specifies whether the "Reserve4" low limit is evalu‐
tive (Page 777) ated as a percentage or an absolute value.
Limit4UpperLimit RW - - Specifies the high limit for "Reserve4".
(Page 778)
Limit4UpperLimitColor RW - - Specifies the color for the "Reserve4" high limit.
(Page 779)
Limit4UpperLimitEna‐ RW - - Specifies whether the "Reserve4" high limit is moni‐
bled (Page 779) tored.
Limit4UpperLimitRela‐ RW - - Specifies whether the "Reserve4" high limit is evalu‐
tive (Page 780) ated as a percentage or an absolute value.
Limit5LowerLimit RW - - Specifies the low limit for "Reserve5".
(Page 781)
Limit5LowerLimitColor RW - - Sets the color for the "Reserve5" low limit.
(Page 781)
Limit5LowerLimitEna‐ RW - - Specifies whether the "Reserve5" low limit is moni‐
bled (Page 782) tored.
Limit5LowerLimitRela‐ RW - - Specifies whether the "Reserve5" low limit is evalu‐
tive (Page 783) ated as a percentage or an absolute value.
Limit5UpperLimit RW - - Specifies the high limit for "Reserve5".
(Page 783)
Limit5UpperLimitColor RW - - Specifies the color for the "Reserve5" high limit.
(Page 784)
Limit5UpperLimitEna‐ RW - - Specifies whether the "Reserve5" high limit is moni‐
bled (Page 785) tored.
Limit5UpperLimitRela‐ RW - - Specifies whether the "Reserve5" high limit is evalu‐
tive (Page 785) ated as a percentage or an absolute value.
LimitRangeCollection - - - -

WinCC Engineering V18 – Programming reference

262 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
LineEndShapeStyle RW - - Specifies the shape of the line ends.
(Page 787)
Location - - - -
MaximumValue RW RW RW Specifies the maximum value of the scale in the se‐
(Page 799) lected object.
MinimumValue RW RW RW Specifies the minimum value of the scale in the se‐
(Page 822) lected object.
Name - - - -
Precision (Page 871) RW - - Specifies the number of decimal places (0 to 20).
ProcessValue (Page 874) RW RW RW Specifies the default for the value to be displayed.
ScaleColor (Page 892) RW RW RW Specifies the color of the scale of the selected object.
ScaleGradation RW RW RW Specifies the distance between two large tick marks
(Page 893) of the scale.
ScaleLabelFieldLength - - - -
ScaleLabelingDouble‐ - - - -
Lined
ScalePosition (Page 896) RW - - Specifies the position of the scale of the selected ob‐
ject.
ScaleStart - - - -
ScalingType (Page 899) RW - - Specifies the type of bar scaling.
SegmentColoring RW RW RW Specifies the type of color change to be displayed if
(Page 904) the limits are exceeded.
ShowBadTagState RW - - Defines whether the object is grayed out when a bad
(Page 926) quality code or tag status is detected.
ShowLargeTicksOnly RW - - Specifies whether only large scale marks are shown.
(Page 935)
ShowLimitLines - - - -
ShowLimitMarkers RW - - Specifies whether the limit values are shown as a
(Page 936) scale value.
ShowLimitRanges - - - -
ShowProcessValue - - - -
ShowScale (Page 940) RW - - Specifies whether the values are also shown in a
scale.
ShowSignForPositiveLa‐ - - - -
bel
ShowTickLabels - - - -
ShowTrendIndicator RW - - Specifies whether the trend (rising or falling) of the
(Page 950) measured value to be monitored is indicated by
means of a small arrow.
Size - - - -
StartValue (Page 958) RW - - Defines the absolute value of the zero point of the
scale indicator.
StyleItem - - - -
TabIndex - - - -
TabIndexAlpha - - - -

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 263
VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
ToleranceLowerLimit RW - - Sets the low limit for tolerance 1.
(Page 1054)
ToleranceLowerLimit‐ RW - - Specifies the color for the low limit "ToleranceLower‐
Color (Page 1054) Limit".
ToleranceLowerLimitEn‐ RW - - Specifies whether the "ToleranceLowerLimit" limit is
abled (Page 1055) monitored.
ToleranceLowerLimitRe‐ RW - - Specifies whether the low limit "ToleranceLowerLi‐
lative (Page 1056) mit" is evaluated as a percentage or as an absolute
value.
ToleranceUpperLimit RW - - Sets the high limit for tolerance 1.
(Page 1056)
ToleranceUpperLimit‐ RW - - Specifies the color for the high limit "ToleranceUp‐
Color (Page 1057) perLimit".
ToleranceUpperLimitEn‐ RW - - Specifies whether the "ToleranceUpperLimit" limit is
abled (Page 1058) monitored.
ToleranceUpperLimitRe‐ RW - - Specifies whether the high limit "ToleranceUpperLi‐
lative (Page 1058) mit" is to be evaluated as a percentage or as an ab‐
solute value.
ToolTipText (Page 1082) RW RW RW Specifies the tooltip text.
Top (Page 1083) RW RW RW Specifies the value of the Y coordinate of the selected
object.
Transparency RW - - Specifies the object transparency in percent.
(Page 1087)
TrendIndicatorColor RW - - Specifies the color for the trend view.
(Page 1101)
Unit (Page 1142) RW - - Specifies the unit of measurement.
UseAutoScaling - - - -
UseDesignColorSchema RW - - Specifies whether the colors defined in the global
(Page 1148) color scheme of the current design are to be used for
this object.
UseDesignShadowSet‐ RW - - Specifies whether the object is displayed with global
tings (Page 1150) shading.
UseExponentialFormat RW - - Specifies whether the numbers are displayed with
(Page 1153) exponentials (e.g. "1.00e+000").
Visible (Page 1204) RW RW RW Specifies whether the selected object is visible.
WarningLowerLimit RW - - Specifies the low limit for "WarningLowerLimit".
(Page 1209)
WarningLowerLimitCol‐ RW - - Specifies the color for the low limit "WarningLower‐
or (Page 1210) Limit".
WarningLowerLimitEna‐ RW - - Specifies whether the "WarningLowerLimit" limit is
bled (Page 1211) monitored.
WarningLowerLimitRela‐ RW - - Specifies whether the low limit "WarningLowerLimit"
tive (Page 1212) is evaluated as a percentage or as an absolute value.
WarningUpperLimit RW - - Specifies the upper warning limit.
(Page 1214)
WarningUpperLimitCol‐ RW R R Specifies the color for the high limit "WarningUpper‐
or (Page 1215) Limit".

WinCC Engineering V18 – Programming reference

264 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
WarningUpperLimitEna‐ RW R R Specifies whether the high limit is to be monitored.
bled (Page 1216)
WarningUpperLimitRela‐ RW RW RW Specifies whether the high limit "WarningUpperLi‐
tive (Page 1216) mit" is to be evaluated as a percentage or as an ab‐
solute value.
Width (Page 1217) RW R R Specifies the width of the object in pixels.
ZeroPoint (Page 1249) RW RW RW Specifies the position of the zero point as a percent‐
age of the bar height.

Table 1-8 Methods

Methods RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Activate (Page 1250) Yes Yes Yes Enables the permanent area or the root screen.
ActivateDynamic Yes - - Dynamically activates a trigger and the specified cycle
(Page 1252) for a property at runtime.
DeactivateDynamic Yes - - Deactivates the trigger of the "ActivateDynamic"
(Page 1259) method used for the specified property in/during run‐
time.

BatteryView

Description

6FUHHQV

6FUHHQ

6FUHHQ,WHPV

6FUHHQ,WHP

Represents the "Charge condition" object. The BatteryView object is an element of the
ScreenItems list.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 265
VB scripting
1.5 VBS object model

Type identifier in VBS

HMIBatteryView

Abbreviation Access in runtime

R Read
RW Read and write
- No access

Table 1-9 Properties

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
AllTagTypesAllowed - - - -
Bounds - - - -
CanBeGrouped - - - -
Height - R R Specifies the height.
Layer (Page 764) - - RW Specifies the layer in the screen that contains an ob‐
ject.
Left (Page 770) - - RW Specifies the value of the X coordinate.
Location - - - -
Name - - - -
Size - - - -
TabIndex - - - -
TabIndexAlpha - - - -
Top (Page 1083) - - RW Specifies the value of the Y coordinate.
Visible (Page 1204) - - RW Specifies whether the selected object is visible.
Width - R R Specifies the width.

Table 1-10 Methods

Methods RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Activate (Page 1250) - - Yes Enables the permanent area or the root screen.

See also
Height (Page 720)
Width (Page 1217)

WinCC Engineering V18 – Programming reference

266 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Button

Description

6FUHHQV

6FUHHQ

6FUHHQ,WHPV

6FUHHQ,WHP

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 -- --

Type identifier in VBS

HMIButton

Abbreviation Access in Runtime

R Read
RW Read and write
- No access

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 267
VB scripting
1.5 VBS object model

Table 1-11 Properties

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
AdaptBorder (Page 498) RW - - Specifies whether the border of the object will be dy‐
namically adapted to the text size.
AllTagTypesAllowed - - - -
Authorization RW RW RW Specifies the operating rights of the selected object in
(Page 517) runtime.
BackColor (Page 526) RW RW RW Specifies the background color of the selected object.
BackFillStyle (Page 531) RW - - Specifies the fill pattern of the selected object.
BackFlashingColorOff RW - - Specifies the background color for flash state "Off".
(Page 533)
BackFlashingColorOn RW - - Specifies the background color for flash state "On".
(Page 534)
BackFlashingEnabled RW - - Specifies whether the background of the selected ob‐
(Page 535) ject flashes in runtime.
BackFlashingRate RW - - Specifies the flash rate of the background for the se‐
(Page 536) lected object.
BitNumber - - - -
BorderBackColor RW - - Specifies the background color of the broken border
(Page 558) line for the selected object.
BorderBrightColor3D RW - - Specifies the frame color of the following frame parts
(Page 561) 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 562) RW - - Specifies the line color of the object.
BorderFlashingColorOff RW - - Specifies the border line color of the selected object
(Page 566) for the flash state "Off".
BorderFlashingColorOn RW - - Specifies the border line color of the selected object
(Page 567) for the flash state "On".
BorderFlashingEnabled RW - - Specifies whether the border line of the selected ob‐
(Page 569) ject flashes in runtime.
BorderFlashingRate RW - - Specifies the flash rate of the border line for the se‐
(Page 570) lected object.
BorderShadeColor3D RW - - Specifies the frame color of the following frame parts
(Page 575) 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 576) RW - - Specifies the type of border lines for the selected ob‐
ject.
BorderWidth (Page 577) RW - - Specifies the line thickness of the selected object.
BorderWidth3D RW - - Specifies the width of the inner border for the 3D
(Page 580) presentation of the selected object.
CanBeGrouped - - - -
CornerRadius - - - -

WinCC Engineering V18 – Programming reference

268 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
CornerStyle (Page 635) RW - - Specifies the shape of the corners of the specified
object.
DeviceStyle - - - -
DrawInsideFrame RW - - Specifies whether the border line of the selected ob‐
(Page 655) ject with a line thickness greater than 1 should be
drawn within the border or symmetrically to the bor‐
der.
EdgeStyle (Page 657) RW - - Specifies the line style of the selected object.
Enabled (Page 660) RW RW RW Specifies whether the selected object can be operat‐
ed in runtime.
ES2RT_StoreAsCheck‐ - - - -
Back
FillingDirection RW - - Specifies the fill direction.
(Page 687)
FillPatternColor RW - - Specifies the color of the fill pattern for the selected
(Page 685) object.
FirstGradientColor - - - -
FirstGradientOffset - - - -
FitToLargest - - - -
Flashing - - - -
FlashingColorOff RW - - Specifies the border line color of the selected object
(Page 693) for the flash state "Off".
FlashingColorOn RW - - Specifies the border line color of the selected object
(Page 695) for the flash state "On".
FlashingEnabled RW - - Specifies whether the border line of the selected ob‐
(Page 697) ject flashes in runtime.
FlashingRate (Page 699) RW - - Specifies the flash rate of the border line for the se‐
lected object.
FocusColor (Page 703) - RW RW Specifies the color for the focus frame of the selected
object when it is in focus.
FocusWidth (Page 704) - RW RW Specifies the border width of the specified object
when the object is in focus.
Font - - - -
FontBold (Page 708) RW - - Specifies whether the text of the selected object is
shown in bold.
FontItalic (Page 708) RW - - Specifies whether the text of the selected object is
shown in italics.
FontName (Page 709) RW - - Specifies the font of the selected object.
FontSize (Page 711) RW - - Specifies the font size of the text for the selected ob‐
ject.
FontUnderline RW - - Specifies whether the text of the selected object is
(Page 711) underlined.
ForeColor (Page 712) RW RW RW Specifies the font color of the text for the selected
object.
Height (Page 720) RW R R Specifies the height of the selected object.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 269
VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
HelpText (Page 724) - 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 736) the selected object.
HorizontalPictureAlign‐ - - - -
ment
Hotkey - - - -
Layer (Page 764) RW RW RW Specifies the layer in the screen that contains an ob‐
ject.
Left (Page 770) RW RW RW Specifies the value of the X coordinate of the selected
object.
LineEndShapeStyle RW - - Specifies the shape of the line ends.
(Page 787)
Location - - - -
MiddleGradientColor - - - -
Mode (Page 824) RW - - Specifies the field type of the selected object.
Name - - - -
PictureAlignment RW - - Specifies the display type for the background screen
(Page 864) in the process image.
PictureAreaBottomMar‐ - - - -
gin
PictureAreaLeftMargin - - - -
PictureAreaRightMargin - - - -
PictureAreaTopMargin - - - -
PictureAutoSizing - - - -
PictureList - - - -
PictureOff (Page 866) RW - - Specifies the picture that is displayed in the "Off" sta‐
tus.
PictureOn (Page 867) RW - - Specifies the screen to be displayed in the "On" state.
Pressed (Page 872) RW - - Specifies whether the selected object is displayed in a
pressed state.
ProcessValue (Page 874) RW - - Specifies the default for the value to be displayed.
RelativeFillLevel RW - - Specifies the fill percentage for the object.
(Page 881)
SecondGradientColor - - - -
SecondGradientOffset - - - -
ShowFillLevel RW - - Specifies whether the selected object is filled.
(Page 933)
Size - - - -
StyleItem - - - -
StyleSettings (Page 982) RW - - Specifies the style in which the object is displayed.
TabIndex - - - -
TabIndexAlpha - - - -
TextAreaBottomMargin - - - -
TextAreaLeftMargin - - - -

WinCC Engineering V18 – Programming reference

270 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
TextAreaRightMargin - - - -
TextAreaTopMargin - - - -
TextList - - - -
TextOff (Page 1002) RW RW RW Specifies the text to be displayed in the "Off" state of
the selected object.
TextOn (Page 1003) - 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 1004)
Toggle (Page 1052) RW - - Specifies whether the selected object engages after it
has been operated in Runtime.
ToolTipText (Page 1082) RW RW RW Specifies the tooltip text.
Top (Page 1083) RW RW RW Specifies the value of the Y coordinate of the selected
object.
Transparency RW - - Specifies the object transparency in percent.
(Page 1087)
TransparentColorPic‐ RW - - Specifies the color to be set to "transparent" for the
tureOff (Page 1090) "Off" state of the assigned bitmap object.
TransparentColorPictur‐ RW - - Specifies the color to be set to "transparent" for the
eOn (Page 1091) "On" state of the assigned bitmap object.
UseDesignColorSchema RW - - Specifies whether the colors defined in the global
(Page 1148) color scheme of the current design are to be used for
this object.
UseDesignShadowSet‐ RW - - Specifies whether the object is displayed with the
tings (Page 1150) shading defined in the active design.
UseFirstGradient - - - -
UseSecondGradient - - - -
UseTransparentColorPic‐ RW - - Specifies if the transparent color defined in the "Trans‐
tureOff (Page 1161) parentColorPictureOff" property is used for the "Off"
state.
UseTransparentColorPic‐ RW - - Specifies if the transparent color defined in the "Trans‐
tureOn (Page 1161) parentColorPictureOff" property is used for the "Off"
state.
UseTwoHandOperation - - - -
VerticalAlignment RW RW RW Specifies the vertical alignment of the text for the
(Page 1200) selected object.
VerticalPictureAlign‐ - - - -
ment
Visible (Page 1204) RW RW RW Specifies whether the selected object is visible.
Width (Page 1217) RW R R Specifies the width of the object in pixels.
WindowsStyle RW - - Specifies whether the object is displayed in the gen‐
(Page 1224) eral Windows style.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 271
VB scripting
1.5 VBS object model

Table 1-12 Methods

Methods RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Activate (Page 1250) Yes Yes Yes Enables the permanent area or the root screen.
ActivateDynamic Yes - - Dynamically activates a trigger and the specified cycle
(Page 1252) for a property at runtime.
DeactivateDynamic Yes - - Deactivates the trigger of the "ActivateDynamic"
(Page 1259) method used for the specified property in/during run‐
time.

CameraControl

Description

6FUHHQV

6FUHHQ

6FUHHQ,WHPV

6FUHHQ,WHP

Represents the "CameraControl" object. The CameraControl object is an element of the

ScreenItems list.

Type identifier in VBS

HMICameraControl

Abbreviation Access in Runtime

R Read
RW Read and write
- No access

WinCC Engineering V18 – Programming reference

272 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Table 1-13 Properties

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
AllTagTypesAllowed - - - -
Bounds - - - -
CameraUrl - - - -
CanBeGrouped - - - -
Height - R R Specifies the height.
Layer (Page 764) - - RW Specifies the layer in the screen that con‐
tains an object.
Left (Page 770) - - R Returns the value of the X coordinate.
Location - - - -
MaintainAspectRa‐ - - - -
tio
MaintainOriginal‐ - - - -
Size
Name - - - -
Size - - - -
TabIndex - - - -
TabIndexAlpha - - - -
Top (Page 1083) - - R Returns the value of the Y coordinate.
UseUdp - - - -
Visible (Page 1204) - - R Returns whether the specified object is visi‐
ble.
Width - R R Specifies the width.

Table 1-14 Methods

Methods RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Activate (Page 1250) - - Yes Enables the permanent area or the root screen.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 273
VB scripting
1.5 VBS object model

ChannelDiagnose

Description

6FUHHQV

6FUHHQ

6FUHHQ,WHPV

6FUHHQ,WHP

Represents the "Channel diagnostics display" object. The ChannelDiagnose object is an

element of the ScreenItems list.

Type identifier in VBS

HMIChannelDiagnose

Abbreviation Access in runtime

R Read
RW Read and write
- No access

Table 1-15 Properties

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
AllTagTypesAllowed - - - -
Bounds - - - -
CanBeGrouped - - - -
Enabled (Page 660) RW - - Specifies whether the selected object can be operat‐
ed in runtime.
Height (Page 720) RW - - Specifies the height.
Layer (Page 764) RW - - Specifies the layer in the screen that contains an ob‐
ject.

WinCC Engineering V18 – Programming reference

274 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Left (Page 770) RW - - Specifies the value of the X coordinate.
Location - - - -
Name - - - -
Size - - - -
TabIndex - - - -
TabIndexAlpha - - - -
Top (Page 1083) RW - - Specifies the value of the Y coordinate.
Visible (Page 1204) RW - - Specifies whether the selected object is visible.
Width (Page 1217) RW - - Specifies the width of the object in pixels.

Table 1-16 Methods

Methods RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Activate (Page 1250) Yes - - Enables the permanent area or the root screen.
ActivateDynamic Yes - - Dynamically activates a trigger and the specified cycle
(Page 1252) for a property at runtime.
DeactivateDynamic Yes - - Deactivates the trigger of the "ActivateDynamic"
(Page 1259) method used for the specified property in/during run‐
time.

CheckBox

Description

6FUHHQV

6FUHHQ

6FUHHQ,WHPV

6FUHHQ,WHP

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 275
VB scripting
1.5 VBS object model

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

Type identifier in VBS

HMICheckBox

Abbreviation Access in Runtime

R Read
RW Read and write
- No access

Table 1-17 Properties

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
AdaptBorder (Page 498) RW - - Specifies whether the border of the object will be dy‐
namically adapted to the text size.
AllTagTypesAllowed - - - -
Authorization RW - - Specifies operating rights.
(Page 517)
BackColor (Page 526) RW - - Specifies the background color.
BackFillStyle (Page 531) RW - - Specifies the fill pattern.
BackFlashingColorOff RW - - Specifies the background color for flash state "Off".
(Page 533)
BackFlashingColorOn RW - - Specifies the background color for flash state "On".
(Page 534)
BackFlashingEnabled RW - - Specifies whether the background flashes in runtime.
(Page 535)
BackFlashingRate RW - - Specifies the flash rate of the background.
(Page 536)
BorderBackColor RW - - Specifies the background color of the broken border
(Page 558) line.
BorderColor (Page 562) RW - - Specifies the line color.
BorderFlashingColorOff RW - - Specifies the color of the border line for the flashing
(Page 566) status "Off".
BorderFlashingColorOn RW - - Specifies the color of the border line for the flashing
(Page 567) status "On".
BorderFlashingEnabled RW - - Specifies whether the limit of the object can flash in
(Page 569) runtime.
BorderFlashingRate RW - - Specifies the flash rate of the border line.
(Page 570)
BorderStyle (Page 576) RW - - Specifies the type of border lines.
BorderWidth (Page 577) RW - - Specifies the line thickness.
Bounds - - - -
CanBeGrouped - - - -

WinCC Engineering V18 – Programming reference

276 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
CheckMarkAlignment RW - - Specifies whether the fields are right-aligned.
(Page 597)
CheckMarkCount RW - - Specifies the number of fields.
(Page 597)
CornerStyle (Page 635) RW - - Specifies the shape of the corners.
DrawInsideFrame RW - - Specifies whether the border line is to be shown with
(Page 655) a line thickness of greater than 1 within the border or
symmetrically to the border.
EdgeStyle (Page 657) RW - - Specifies the line style.
Enabled (Page 660) RW - - Specifies whether the selected object can be operat‐
ed in runtime.
FillingDirection RW - - Specifies the fill direction.
(Page 687)
FillPatternColor RW - - Specifies the color of the fill pattern.
(Page 685)
Flashing - - - -
FlashingColorOff RW - - Specifies the color of the border line for the flashing
(Page 693) status "Off".
FlashingColorOn RW - - Specifies the color of the border line for the flashing
(Page 695) status "On".
FlashingEnabled RW - - Specifies whether flashing is activated for the object
(Page 697) in runtime.
FlashingRate (Page 699) RW - - Specifies the flash rate of the border line.
Font - - - -
FontBold (Page 708) RW - - Specifies whether the text is shown in bold.
FontItalic (Page 708) RW - - Specifies whether the text is shown in italics.
FontName (Page 709) RW - - Specifies the font.
FontSize (Page 711) RW - - Specifies the font size of the text.
FontUnderline RW - - Specifies whether the text is shown underlined.
(Page 711)
ForeColor (Page 712) RW - - Specifies the font color of the text.
Height (Page 720) RW - - Specifies the height.
HorizontalAlignment RW - - Specifies the horizontal alignment of the text.
(Page 736)
Index (Page 741) RW - - Specifies the index for the selected text field.
Layer (Page 764) RW - - Specifies the layer in the screen that contains an ob‐
ject.
Left (Page 770) RW - - Specifies the value of the X coordinate.
LineEndShapeStyle RW - - Specifies the shape of the line ends.
(Page 787)
Location - - - -
LogOperation RW - - Specifies whether, after operating this object, an
(Page 794) alarm is output to the alarm system.
Name - - - -
ProcessValue (Page 874) RW - - Specifies the default for the value to be displayed.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 277
VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
RelativeFillLevel RW - - Specifies the fill percentage for the object.
(Page 881)
ShowBadTagState RW - - Defines whether the object is grayed out when a bad
(Page 926) quality code or tag status is detected.
ShowFillLevel RW - - Specifies whether the selected object is filled.
(Page 933)
Size - - - -
TabIndex - - - -
TabIndexAlpha - - - -
Text (Page 1000) RW - - Specifies the label for the text field.
TextHandles - - - -
TextOrientation RW - - Specifies the text orientation.
(Page 1004)
Texts - - - -
ToolTipText (Page 1082) RW - - Specifies the tooltip text.
Top (Page 1083) RW - - Specifies the value of the Y coordinate.
Transparency RW - - Specifies the object transparency in percent.
(Page 1087)
UseDesignColorSchema RW - - Specifies whether the colors defined in the global col‐
(Page 1148) or scheme of the current design are to be used for this
object.
UseDesignShadowSet‐ RW - - Specifies whether the object is displayed with global
tings (Page 1150) shading.
VerticalAlignment RW - - Specifies the vertical alignment of the text in the
(Page 1200) specified object.
Visible (Page 1204) RW - - Specifies whether the selected object is visible.
Width (Page 1217) RW - - Specifies the width of the object in pixels.

Table 1-18 Methods

Methods RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Activate (Page 1250) Yes Yes Yes Enables the permanent area or the root screen.
ActivateDynamic Yes - - Dynamically activates a trigger and the specified cycle
(Page 1252) for a property at runtime.
DeactivateDynamic Yes - - Deactivates the trigger of the "ActivateDynamic"
(Page 1259) method used for the specified property in/during run‐
time.

WinCC Engineering V18 – Programming reference

278 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Circle

Description

6FUHHQV

6FUHHQ

6FUHHQ,WHPV

6FUHHQ,WHP

Represents the "Circle" object. The Circle object is an element of the ScreenItems list.

Type identifier in VBS

HMICircle

Abbreviation Access in Runtime

R Read
RW Read and write
- No access

Table 1-19 Properties

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
AllTagTypesAllowed - - - -
Authorization RW - - Specifies the operating rights in Runtime.
(Page 517)
BackColor (Page 526) RW RW RW Specifies the background color.
BackFillStyle (Page 531) RW RW RW Specifies the fill pattern.
BorderBackColor RW - - Specifies the background color of the broken border
(Page 558) line.
BorderColor (Page 562) RW RW RW Specifies the line color.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 279
VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
BorderFlashingColorOff RW - - Specifies the color of the border line for the flashing
(Page 566) status "Off".
BorderFlashingColorOn RW - - Specifies the color of the border line for the flashing
(Page 567) status "On".
BorderFlashingEnabled RW - - Specifies whether the limit of the object can flash in
(Page 569) runtime.
BorderFlashingRate RW - - Specifies the flash rate of the border line.
(Page 570)
BorderStyle (Page 576) RW - - Specifies the type of border lines.
BorderWidth (Page 577) RW RW RW Specifies the line thickness.
CanBeGrouped - - - -
CornerStyle (Page 635) RW - - Specifies the shape of the corners.
DeviceStyle - - - -
DrawInsideFrame RW - - Specifies whether the border line is to be shown with
(Page 655) a line thickness of greater than 1 within the border or
symmetrically to the border.
EdgeStyle (Page 657) RW RW RW Specifies the line style.
Enabled (Page 660) RW RW RW Specifies whether the object can be operated in run‐
time.
FillingDirection RW - - Specifies the fill direction.
(Page 687)
FillPatternColor RW - - Specifies the color of the fill pattern.
(Page 685)
Flashing - - - -
FlashingColorOff RW - - Specifies the color of the border line for the flashing
(Page 693) status "Off".
FlashingColorOn RW - - Specifies the color of the border line for the flashing
(Page 695) status "On".
FlashingEnabled RW - - Specifies whether flashing is activated for the object
(Page 697) in runtime.
FlashingRate (Page 699) RW - - Specifies the flash rate of the border line.
Height (Page 720) RW RW RW Specifies the height.
Layer (Page 764) RW RW RW Specifies the layer in the screen that contains an ob‐
ject.
Left (Page 770) RW RW RW Specifies the value of the X coordinate.
LineEndShapeStyle RW - - Specifies the shape of the line ends.
(Page 787)
Location - - - -
Name - - - -
Radius (Page 876) RW RW RW Specifies the radius.
RadiusHeight - - - -
RadiusWidth - - - -
RelativeFillLevel RW - - Specifies the fill percentage for the object.
(Page 881)
ShowFillLevel RW - - Specifies whether the object is filled.
(Page 933)

WinCC Engineering V18 – Programming reference

280 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Size - - - -
StyleItem - - - -
TabIndex - - - -
TabIndexAlpha - - - -
ToolTipText (Page 1082) RW RW RW Specifies the tooltip text.
Top (Page 1083) RW RW RW Specifies the value of the Y coordinate.
Transparency RW - - Specifies the object transparency in percent.
(Page 1087)
UseDesignColorSchema RW - - Specifies whether the colors defined in the global col‐
(Page 1148) or scheme of the current design are to be used for this
object.
UseDesignShadowSet‐ RW - - Specifies whether the object is displayed with global
tings (Page 1150) shading.
Visible (Page 1204) RW RW RW Specifies whether the object is visible.
Width (Page 1217) RW RW RW Specifies the width of the object in pixels.

Table 1-20 Methods

Methods RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Activate (Page 1250) Yes Yes Yes Enables the permanent area or the root screen.
ActivateDynamic Yes - - Dynamically activates a trigger and the specified cycle
(Page 1252) for a property at runtime.
DeactivateDynamic Yes - - Deactivates the trigger of the "ActivateDynamic"
(Page 1259) method used for the specified property in/during run‐
time.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 281
VB scripting
1.5 VBS object model

CircleSegment

Description

6FUHHQV

6FUHHQ

6FUHHQ,WHPV

6FUHHQ,WHP

Represents the "CircleSegment" object. The CircleSegment object is an element of the

ScreenItems list.

Type identifier in VBS

HMICircleSegment

Abbreviation Access in Runtime

R Read
RW Read and write
- No access

Table 1-21 Properties

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
AllTagTypesAllowed - - - -
Authorization RW - - Specifies operating rights.
(Page 517)
BackColor (Page 526) RW - - Specifies the background color.
BackFillStyle (Page 531) RW - - Specifies the fill pattern.
BorderBackColor RW - - Specifies the background color of the broken border
(Page 558) line.
BorderColor (Page 562) RW - - Specifies the line color.

WinCC Engineering V18 – Programming reference

282 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
BorderFlashingColorOff RW - - Specifies the color of the border line for the flashing
(Page 566) status "Off".
BorderFlashingColorOn RW - - Specifies the color of the border line for the flashing
(Page 567) status "On".
BorderFlashingEnabled RW - - Specifies whether the limit of the object can flash in
(Page 569) runtime.
BorderFlashingRate RW - - Specifies the flash rate of the border line.
(Page 570)
BorderStyle (Page 576) RW - - Specifies the type of border lines.
BorderWidth (Page 577) RW - - Specifies the line thickness.
Bounds - - - -
CanBeGrouped - - - -
CornerStyle (Page 635) RW - - Specifies the shape of the corners.
DrawInsideFrame RW - - Specifies whether the border line is to be shown with
(Page 655) a line thickness of greater than 1 within the border or
symmetrically to the border.
EdgeStyle (Page 657) RW - - Specifies the line style.
Enabled (Page 660) RW - - Specifies whether the selected object can be operat‐
ed in runtime.
EndAngle (Page 666) RW - - Specifies the angle by which the end point deviates
from the zero position (0°).
FillingDirection RW - - Specifies the fill direction.
(Page 687)
FillPatternColor RW - - Specifies the color of the fill pattern.
(Page 685)
Flashing - - - -
FlashingColorOff RW - - Specifies the color of the border line for the flashing
(Page 693) status "Off".
FlashingColorOn RW - - Specifies the color of the border line for the flashing
(Page 695) status "On".
FlashingEnabled RW - - Specifies whether flashing is activated for the object
(Page 697) in runtime.
FlashingRate (Page 699) RW - - Specifies the flash rate of the border line.
Height (Page 720) RW - - Specifies the height.
Layer (Page 764) RW - - Specifies the layer in the screen that contains an ob‐
ject.
Left (Page 770) RW - - Specifies the value of the X coordinate.
LineEndShapeStyle RW - - Specifies the shape of the line ends.
(Page 787)
Location - - - -
Name - - - -
Radius (Page 876) RW - - Specifies the radius.
RelativeFillLevel RW - - Specifies the fill percentage for the object.
(Page 881)
ShowFillLevel RW - - Specifies whether the selected object is filled.
(Page 933)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 283
VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Size - - - -
StartAngle (Page 956) RW - - Specifies the angle by which the start point deviates
from the zero position (0°).
TabIndex - - - -
TabIndexAlpha - - - -
ToolTipText (Page 1082) RW - - Specifies the tooltip text.
Top (Page 1083) RW - - Specifies the value of the Y coordinate.
Transparency RW - - Specifies the object transparency in percent.
(Page 1087)
UseDesignColorSchema RW - - Specifies whether the colors defined in the global col‐
(Page 1148) or scheme of the current design are to be used for this
object.
UseDesignShadowSet‐ RW - - Specifies whether the object is displayed with global
tings (Page 1150) shading.
Visible (Page 1204) RW - - Specifies whether the selected object is visible.
Width (Page 1217) RW - - Specifies the width of the object in pixels.

Table 1-22 Methods

Methods RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Activate (Page 1250) Yes - - Enables the permanent area or the root screen.
ActivateDynamic Yes - - Dynamically activates a trigger and the specified cycle
(Page 1252) for a property at runtime.
DeactivateDynamic Yes - - Deactivates the trigger of the "ActivateDynamic"
(Page 1259) method used for the specified property in/during run‐
time.

WinCC Engineering V18 – Programming reference

284 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

CircularArc

Description

6FUHHQV

6FUHHQ

6FUHHQ,WHPV

6FUHHQ,WHP

Represents the "CircularArc" object. The CircularArc object is an element of the ScreenItems
list.

Type identifier in VBS

HMICircularArc

Abbreviation Access in runtime

R Read
RW Read and write
- No access

Table 1-23 Properties

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
AllTagTypesAllowed - - - -
Authorization RW - - Specifies operating rights.
(Page 517)
BackColor (Page 526) RW - - Specifies the background color.
BorderStyle (Page 576) RW - - Specifies the type of border lines.
Bounds - - - -
CanBeGrouped - - - -

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 285
VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Color (Page 600) RW - - Specifies the line color.
CornerStyle (Page 635) RW - - Specifies the shape of the corners.
DrawInsideFrame RW - - Specifies whether the border line is to be shown with
(Page 655) a line thickness of greater than 1 within the border or
symmetrically to the border.
Enabled (Page 660) RW - - Specifies whether the selected object can be operat‐
ed in runtime.
EndAngle (Page 666) RW - - Specifies the angle by which the end point deviates
from the zero position (0°).
Flashing - - - -
FlashingColorOff RW - - Specifies the color of the border line for the flashing
(Page 693) status "Off".
FlashingColorOn RW - - Specifies the color of the border line for the flashing
(Page 695) status "On".
FlashingEnabled RW - - Specifies whether flashing is activated for the object
(Page 697) in runtime.
FlashingRate (Page 699) RW - - Specifies the flash rate of the border line.
Height (Page 720) RW - - Specifies the height.
Layer (Page 764) RW - - Specifies the layer in the screen that contains an ob‐
ject.
Left (Page 770) RW - - Specifies the value of the X coordinate.
LineEndShapeStyle RW - - Specifies the shape of the line ends.
(Page 787)
LineWidth (Page 790) RW - - Specifies the line thickness.
Location - - - -
Name - - - -
Radius (Page 876) RW - - Specifies the radius.
Size - - - -
StartAngle (Page 956) RW - - Specifies the angle by which the start point deviates
from the zero position (0°).
Style (Page 981) RW - - Specifies the line style.
TabIndex - - - -
TabIndexAlpha - - - -
ToolTipText (Page 1082) RW - - Specifies the tooltip text.
Top (Page 1083) RW - - Specifies the value of the Y coordinate.
Transparency RW - - Specifies the object transparency in percent.
(Page 1087)
UseDesignColorSchema RW - - Specifies whether the colors defined in the global col‐
(Page 1148) or scheme of the current design are to be used for this
object.
UseDesignShadowSet‐ RW - - Specifies whether the object is displayed with global
tings (Page 1150) shading.
Visible (Page 1204) RW - - Specifies whether the selected object is visible.
Width (Page 1217) RW - - Specifies the width of the object in pixels.

WinCC Engineering V18 – Programming reference

286 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Table 1-24 Methods

Methods RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Activate (Page 1250) Yes - - Enables the permanent area or the root screen.
ActivateDynamic Yes - - Dynamically activates a trigger and the specified cycle
(Page 1252) for a property at runtime.
DeactivateDynamic Yes - - Deactivates the trigger of the "ActivateDynamic"
(Page 1259) method used for the specified property in/during run‐
time.

Clock

Description

6FUHHQV

6FUHHQ

6FUHHQ,WHPV

6FUHHQ,WHP

Represents the "Clock" object. The Clock object is an element of the ScreenItems list.

Type identifier in VBS

Clock

Abbreviation Access in Runtime

R Read
RW Read and write
- No access

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 287
VB scripting
1.5 VBS object model

Table 1-25 Properties

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
AllTagTypesAllowed - - - -
Analog (Page 510) RW - - Specifies whether the clock is displayed as an analog
clock.
BackFillStyle (Page 531) RW - - Specifies the fill pattern of the selected object.
BorderColor - - - -
BorderBackColor - - - -
BorderWidth - - - -
Bounds - - - -
CanBeGrouped - - - -
CornerRadius - - - -
DeviceStyle - - - -
DialColor (Page 649) RW RW RW Specifies the color of the dial for the selected object.
EdgeStyle - - - -
Enabled (Page 660) RW RW RW Specifies whether the selected object can be operat‐
ed in runtime.
Flashing (Page 692) RW - - Specifies whether the selected object flashes in run‐
time.
Font (Page 705) RW - - Specifies the font.
Height (Page 720) RW R R Specifies the height of the selected object.
HourNeedleHeight RW RW RW Specifies the length of the hour hand in the "Clock"
(Page 739) object.
HourNeedleWidth RW RW RW Specifies the width of the hour hand in the "Clock"
(Page 740) object.
Layer (Page 764) RW RW RW Specifies the layer in the screen that contains an ob‐
ject.
Left (Page 770) 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 adjus‐
(Page 793) ted with the mouse.
MinuteNeedleHeight RW RW RW Specifies the length of the minute hand in the "Clock"
(Page 823) object.
MinuteNeedleWidth RW RW RW Specifies the width of the minute hand in the "Clock"
(Page 823) object.
Name RW - - Specifies the object name.
NeedleBorderColor RW RW RW Specifies the line color of the pointer in the "Clock"
(Page 831) object.
NeedleColor (Page 832) RW RW RW Specifies the hand color in the "Clock" object.
NeedleFillStyle RW - - Specifies whether the pointers are displayed as filled
(Page 833) or transparent.
NumberStyle - - - -

WinCC Engineering V18 – Programming reference

288 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Picture (Page 864) 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 903) "Clock" object.
SecondNeedleWidth RW RW RW Specifies the width of the seconds hand in the "Clock"
(Page 903) object.
ShowFocusRectangle RW - - Specifies whether the button is given a selection bor‐
(Page 934) der when it is activated in Runtime.
ShowTicks (Page 946) RW RW RW Specifies whether the marking lengths are shown in
the scale of the selected object.
Size - - - -
StyleItem - - - -
TabIndex - - - -
TabIndexAlpha - - - -
TickDistance - - - -
TicksColor (Page 1008) RW RW RW Specifies the color of the hour markers on the face of
the "Clock" object.
TickStyle - - - -
Top (Page 1083) RW RW RW Specifies the value of the Y coordinate of the selected
object.
Transparency RW - - Specifies the object transparency in percent.
(Page 1087)
UseDesignColorSchema RW - - Specifies whether the colors defined in the global col‐
(Page 1148) or scheme of the current design are to be used for this
object.
UseDesignShadowSet‐ RW - - Specifies whether the object is displayed with the
tings (Page 1150) shading defined in the active design.
Visible (Page 1204) RW RW RW Specifies whether the selected object is visible.
Width (Page 1217) RW R R Specifies the width of the object in pixels.

Table 1-26 Methods

Methods RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Activate (Page 1250) Yes Yes Yes Enables the permanent area or the root screen.
ActivateDynamic Yes - - Dynamically activates a trigger and the specified cycle
(Page 1252) for a property at runtime.
DeactivateDynamic Yes - - Deactivates the trigger of the "ActivateDynamic"
(Page 1259) method used for the specified property in/during run‐
time.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 289
VB scripting
1.5 VBS object model

ComboBox

Description

6FUHHQV

6FUHHQ

6FUHHQ,WHPV

6FUHHQ,WHP

Represents the "Check box" object. The ComboBox object is an element of the ScreenItems
list.

Type identifier in VBS

HMIComboBox

Abbreviation Access in Runtime

R Read
RW Read and write
- No access

Table 1-27 Properties

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
AllTagTypesAllowed - - - -
AskOperationMotive RW - - Specifies whether the reason for operating this object
(Page 514) is logged.
Authorization RW - - Specifies operating rights.
(Page 517)
BackColor (Page 526) RW - - Specifies the background color.
BackFillStyle (Page 531) RW - - Specifies the fill pattern.

WinCC Engineering V18 – Programming reference

290 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
BorderBackColor RW - - Specifies the background color of the broken border
(Page 558) line.
BorderColor (Page 562) RW - - Specifies the line color.
BorderStyle (Page 576) RW - - Specifies the type of border lines.
BorderWidth (Page 577) RW - - Specifies the line thickness.
Bounds - - - -
CanBeGrouped - - - -
CornerStyle (Page 635) RW - - Specifies the shape of the corners.
CountVisibleItems RW - - Specifies how many lines the drop-down list is to con‐
(Page 638) tain.
EdgeStyle (Page 657) RW - - Specifies the line style.
Enabled (Page 660) RW - - Specifies whether the selected object can be operat‐
ed in runtime.
FillPatternColor - - - -
FitToLargest - - - -
Font - - - -
FontBold (Page 708) RW - - Specifies whether the text is shown in bold.
FontItalic (Page 708) RW - - Specifies whether the text is shown in italics.
FontName (Page 709) RW - - Specifies the font.
FontSize (Page 711) RW - - Specifies the font size of the text.
FontUnderline RW - - Specifies whether the text is shown underlined.
(Page 711)
ForeColor (Page 712) RW - - Specifies the font color of the text.
Height (Page 720) RW - - Specifies the height.
HorizontalAlignment RW - - Specifies the horizontal alignment of the text.
(Page 736)
Index (Page 741) RW - - Specifies the index for the selected text field.
Layer (Page 764) RW - - Specifies the layer in the screen that contains an ob‐
ject.
Left (Page 770) RW - - Specifies the value of the X coordinate.
LineEndShapeStyle RW - - Specifies the shape of the line ends.
(Page 787)
Location - - - -
LogOperation RW - - Specifies whether, after operating this object, an
(Page 794) alarm is output to the alarm system.
Name - - - -
SelectedIndex RW - - Specifies the index of which the associated text is
(Page 908) highlighted in the combo box or list box.
SelectedText (Page 910) RW - - Specifies the text for the entry referenced with "Se‐
lectedIndex".
Size - - - -
TabIndex - - - -
TabIndexAlpha - - - -
Text (Page 1000) RW - - Specifies the label for the text field.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 291
VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
TextHandles - - - -
Texts - - - -
ToolTipText (Page 1082) RW - - Specifies the tooltip text.
Top (Page 1083) RW - - Specifies the value of the Y coordinate.
Transparency RW - - Specifies the object transparency in percent.
(Page 1087)
UseDesignColorSchema RW - - Specifies whether the colors defined in the global col‐
(Page 1148) or scheme of the current design are to be used for this
object.
UseDesignShadowSet‐ RW - - Specifies whether the object is displayed with global
tings (Page 1150) shading.
Visible (Page 1204) RW - - Specifies whether the selected object is visible.
Width (Page 1217) RW - - Specifies the width of the object in pixels.

Table 1-28 Methods

Methods RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Activate Yes - - Enables the permanent area or the root screen.
ActivateDynamic Yes - - Dynamically activates a trigger and the specified cycle
(Page 1252) for a property at runtime.
DeactivateDynamic Yes - - Deactivates the trigger of the "ActivateDynamic"
(Page 1259) method used for the specified property in/during run‐
time.

WinCC Engineering V18 – Programming reference

292 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Connector

Description

6FUHHQV

6FUHHQ

6FUHHQ,WHPV

6FUHHQ,WHP

Represents the "Connector" object. The Connector object is an element of the ScreenItems
list.

Type identifier in VBS

HMIConnector

Abbreviation Access in Runtime

R Read
RW Read and write
- No access

Table 1-29 Properties

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
AllTagTypesAllowed - - - -
Authorization RW - - Specifies operating rights.
(Page 517)
BackColor (Page 526) RW - - Specifies the background color.
BorderEndStyle RW - - Specifies the type of line ends.
(Page 565)
BorderStyle (Page 576) RW - - Specifies the type of border lines.
Bounds - - - -

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 293
VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
CanBeGrouped - - - -
Color (Page 600) RW - - Specifies the line color.
ConnectionType RW - - Specifies the type of connector.
(Page 631)
CornerStyle (Page 635) RW - - Specifies the shape of the corners.
DeviceStyle - - - -
Enabled (Page 660) RW - - Specifies whether the selected object can be operat‐
ed in runtime.
EndStyle (Page 667) RW - - Specifies how the line end is displayed.
FirstConnectedObject - - - -
FirstConnectedObjectIn‐ RW - - Specifies the index number of the upper connector
dex (Page 689) point.
FirstConnectedObject‐ RW - - Specifies the name of the object that is docked to the
Name (Page 690) upper connector point.
Flashing - - - -
FlashingColorOff RW - - Specifies the color of the border line for the flashing
(Page 693) status "Off".
FlashingColorOn RW - - Specifies the color of the border line for the flashing
(Page 695) status "On".
FlashingEnabled RW - - Specifies whether flashing is activated for the object
(Page 697) in runtime.
FlashingRate (Page 699) RW - - Specifies the flash rate of the border line.
Height (Page 720) RW - - Specifies the height.
LastConnectedObject - - - -
LastConnectedObjectIn‐ RW - - Specifies the index number of the connection point to
dex (Page 762) the last connected object.
LastConnectedObject‐ RW - - Specifies the name of the object that is docked to the
Name (Page 762) lower connector point.
Layer (Page 764) RW - - Specifies the layer in the screen that contains an ob‐
ject.
Left (Page 770) RW - - Specifies the value of the X coordinate.
LineEndShapeStyle RW - - Specifies the shape of the line ends.
(Page 787)
LineWidth (Page 790) RW - - Specifies the line thickness.
Location - - - -
Name - - - -
NoHitTest - - - -
Points - - - -
PointsCount - - - -
Size - - - -
StartStyle (Page 957) RW - - Specifies how the line start is displayed.
Style (Page 981) RW - - Specifies the line style.
SwapFirstWithLastCon‐ RW - - Specifies that the first and last connection should be
nection (Page 983) swapped.
TabIndex - - - -

WinCC Engineering V18 – Programming reference

294 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
TabIndexAlpha - - - -
ToolTipText (Page 1082) RW - - Specifies the tooltip text.
Top (Page 1083) RW - - Specifies the value of the Y coordinate.
Transparency RW - - Specifies the object transparency in percent.
(Page 1087)
UseDesignColorSchema RW - - Specifies whether the colors defined in the global col‐
(Page 1148) or scheme of the current design are to be used for this
object.
UseDesignShadowSet‐ RW - - Specifies whether the object is displayed with global
tings (Page 1150) shading.
Visible (Page 1204) RW - - Specifies whether the selected object is visible.
Width (Page 1217) RW - - Specifies the width of the object in pixels.

Table 1-30 Methods

Methods RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Activate (Page 1250) Yes - - Enables the permanent area or the root screen.
ActivateDynamic Yes - - Dynamically activates a trigger and the specified cycle
(Page 1252) for a property at runtime.
DeactivateDynamic Yes - - Deactivates the trigger of the "ActivateDynamic"
(Page 1259) method used for the specified property in/during run‐
time.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 295
VB scripting
1.5 VBS object model

DateTimeField

Description

6FUHHQV

6FUHHQ

6FUHHQ,WHPV

6FUHHQ,WHP

Represents the "Date/time field" object. The DateTimeField object is an element of the
ScreenItems list.

Type identifier in VBS

HMIDateTimeField

Abbreviation Access in Runtime

R Read
RW Read and write
- No access

Table 1-31 Properties

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
AllTagTypesAllowed - - - -
Authorization - RW RW Specifies operating rights.
(Page 517)
BackColor (Page 526) - RW RW Specifies the background color.
BackFillStyle - - - -
BorderBackColor - - - -
BorderColor (Page 562) - RW RW Specifies the line color.

WinCC Engineering V18 – Programming reference

296 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
BorderWidth - - - -
BottomMargin - - - -
Bounds - - - -
CanBeGrouped - - - -
CornerRadius - - - -
DeviceStyle - - - -
DisplayCentury - - - -
DisplaySystemTime - - - -
EdgeStyle - - - -
Enabled (Page 660) - RW RW Specifies whether the selected object can be operat‐
ed in runtime.
FillPatternColor - - - -
FitToLargest - - - -
Flashing - - - -
Font - - - -
ForeColor (Page 712) - RW RW Specifies the font color of the text.
Format - - - -
Height - R R Specifies the height.
HelpText (Page 724) - RW RW Specifies the tooltip that is shown in Runtime as user
help for the specified object.
HorizontalAlignment - RW RW Specifies the horizontal alignment of the text.
(Page 736)
Layer (Page 764) - RW RW Specifies the layer in the screen that contains an ob‐
ject.
Left (Page 770) - RW RW Specifies the value of the X coordinate.
LeftMargin - - - -
LineWrap - - - -
Location - - - -
LongDateTimeFormat - - - -
Mode - - - -
Name - - - -
ProcessValue - - - -
RightMargin - - - -
ShowDate - - - -
ShowTime - - - -
Size - - - -
StyleItem - - - -
TabIndex - - - -
TabIndexAlpha - - - -
TextOrientation - - - -
TimeDisplayMode - - - -
Top (Page 1083) - RW RW Specifies the value of the Y coordinate.
TopMargin - - - -

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 297
VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
UseDesignColorSchema - - - -
UseTwoHandOperation - - - -
VerticalAlignment - RW RW Specifies the vertical alignment of the text in the
(Page 1200) specified object.
Visible (Page 1204) - RW RW Specifies whether the selected object is visible.
Width - R R Specifies the width.

Table 1-32 Methods

Methods RT Profes‐ RT Ad‐ Panel RT Description

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

DiskSpaceView

Description

6FUHHQV

6FUHHQ

6FUHHQ,WHPV

6FUHHQ,WHP

Represents the "Memory space view" object. The DiskSpaceView object is an element of the
ScreenItems list.

WinCC Engineering V18 – Programming reference

298 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Type identifier in VBS

IXDiskSpaceView

Abbreviation Access in Runtime

R Read
RW Read and write
- No access

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Alarm - - - -
AlarmColor - - - -
AllTagTypesAllowed - - - -
Bounds - - - -
CanBeGrouped - - - -
Drive - - - -
Enabled (Page 660) RW - - Specifies whether the selected object can be operat‐
ed in runtime.
Free - - - -
FreePercent (Page 715) R - - Returns the measured values for the free disk space as
a percentage.
Height (Page 720) RW - - Specifies the height.
Interval (Page 749) R - - Returns the time interval for updating the displayed
measured values.
Layer (Page 764) RW - - Specifies the layer in the screen that contains an ob‐
ject.
Left (Page 770) RW - - Specifies the value of the X coordinate.
Location - - - -
Name (Page 827) R - - Returns the name.
NormalColor (Page 834) R - - Returns the color of the used memory space in the
memory space view when memory availability is not
critical.
Size - - - -
TabIndex (Page 984) 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 985) when you toggle between the objects with the tab
key in Alpha Cursor mode.
Tolerance (Page 1052) 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 1053) space view is displayed as soon as the tolerance range
is exceeded.
Top (Page 1083) RW - - Specifies the value of the Y coordinate.
Total (Page 1086) R - - Returns the storage capacity.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 299
VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Used (Page 1148) R - - Returns the amount of used memory space.
UsedPercent (Page 1152) R - - Returns the measured values for the occupied mem‐
ory space as a percentage.
Visible (Page 1204) RW - - Specifies whether the selected object is visible.
Warning (Page 1208) 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 1209) space view is displayed as soon as the warning range
is reached.
Width (Page 1217) RW - - Specifies the width of the object in pixels.

Table 1-33 Methods

Methods RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Activate (Page 1250) Yes - - Enables the permanent area or the root screen.
ActivateDynamic Yes - - Dynamically activates a trigger and the specified cycle
(Page 1252) for a property at runtime.
DeactivateDynamic Yes - - Deactivates the trigger of the "ActivateDynamic"
(Page 1259) method used for the specified property in/during run‐
time.

Ellipse

Description

6FUHHQV

6FUHHQ

6FUHHQ,WHPV

6FUHHQ,WHP

WinCC Engineering V18 – Programming reference

300 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

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

Type identifier in VBS

HMIEllipse

Abbreviation Access in Runtime

R Read
RW Read and write
- No access

Table 1-34 Properties

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
AllTagTypesAllowed - - - -
Authorization RW - - Specifies the operating rights of the selected object in
(Page 517) runtime.
BackColor (Page 526) RW RW RW Specifies the background color of the selected object.
BackFillStyle (Page 531) RW RW RW Specifies the fill pattern of the selected object.
BorderBackColor RW - - Specifies the background color of the broken border
(Page 558) line for the selected object.
BorderColor (Page 562) RW RW RW Specifies the line color of the selected object.
BorderFlashingColorOff RW - - Specifies the border line color of the selected object
(Page 566) for the flash state "Off".
BorderFlashingColorOn RW - - Specifies the border line color of the selected object
(Page 567) for the flash state "On".
BorderFlashingEnabled RW - - Specifies whether the border line of the selected ob‐
(Page 569) ject flashes in runtime.
BorderFlashingRate RW - - Specifies the flash rate of the border line for the se‐
(Page 570) lected object.
BorderStyle (Page 576) RW - - Specifies the type of border lines for the selected ob‐
ject.
BorderWidth (Page 577) RW RW RW Specifies the line thickness of the selected object.
Bounds - - - -
CanBeGrouped - - - -
CornerStyle (Page 635) RW - - Specifies the shape of the corners of the specified
object.
DeviceStyle - - - -
DrawInsideFrame RW - - Specifies whether the border line of the selected ob‐
(Page 655) ject with a line thickness greater than 1 should be
drawn within the border or symmetrically to the bor‐
der.
EdgeStyle (Page 657) RW RW RW Specifies the line style of the selected object.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 301
VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Enabled (Page 660) RW RW RW Specifies whether the selected object can be operat‐
ed in runtime.
FillingDirection RW - - Specifies the fill direction.
(Page 687)
FillPatternColor RW - - Specifies the color of the fill pattern for the selected
(Page 685) object.
Flashing - - - -
FlashingColorOff RW - - Specifies the border line color of the selected object
(Page 693) for the flash state "Off".
FlashingColorOn RW - - Specifies the border line color of the selected object
(Page 695) for the flash state "On".
FlashingEnabled RW - - Specifies whether the border line of the selected ob‐
(Page 697) ject flashes in runtime.
FlashingRate (Page 699) RW - - Specifies the flash rate of the border line for the se‐
lected object.
Height (Page 720) RW RW RW Specifies the height of the selected object.
Layer (Page 764) RW RW RW Specifies the layer in the screen that contains an ob‐
ject.
Left (Page 770) RW RW RW Specifies the value of the X coordinate of the selected
object.
LineEndShapeStyle RW - - Specifies the shape of the line ends.
(Page 787)
Location - - - -
Name - - - -
RadiusHeight RW RW RW Specifies the secondary axis of the specified object.
(Page 876)
RadiusWidth (Page 877) RW RW RW Specifies the main axis of the specified object.
RelativeFillLevel RW - - Specifies the fill percentage for the object.
(Page 881)
ShowFillLevel RW - - Specifies whether the selected object is filled.
(Page 933)
Size - - - -
StyleItem - - - -
TabIndex - - - -
TabIndexAlpha - - - -
ToolTipText (Page 1082) RW RW RW Specifies the tooltip text.
Top (Page 1083) RW RW RW Specifies the value of the Y coordinate of the selected
object.
Transparency RW - - Specifies the object transparency in percent.
(Page 1087)
UseDesignColorSchema RW - - Specifies whether the colors defined in the global col‐
(Page 1148) or scheme of the current design are to be used for this
object.
UseDesignShadowSet‐ RW - - Specifies whether the object is displayed with the
tings (Page 1150) shading defined in the active design.

WinCC Engineering V18 – Programming reference

302 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Visible (Page 1204) RW RW RW Specifies whether the selected object is visible.
Width (Page 1217) RW RW RW Specifies the width of the object in pixels.

Table 1-35 Methods

Method RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Activate (Page 1250) Yes Yes Yes Enables the permanent area or the root screen.
ActivateDynamic Yes - - Dynamically activates a trigger and the specified cycle
(Page 1252) for a property at runtime.
DeactivateDynamic Yes - - Deactivates the trigger of the "ActivateDynamic"
(Page 1259) method used for the specified property in/during run‐
time.

EllipseSegment

Description

6FUHHQV

6FUHHQ

6FUHHQ,WHPV

6FUHHQ,WHP

Represents the "EllipseSegment" object. The EllipseSegment object is an element of the

ScreenItems list.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 303
VB scripting
1.5 VBS object model

Type identifier in VBS

HMIEllipseSegment

Abbreviation Access in Runtime

R Read
RW Read and write
- No access

Table 1-36 Properties

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
AllTagTypesAllowed - - - -
Authorization RW - - Specifies operating rights.
(Page 517)
BackColor (Page 526) RW - - Specifies the background color.
BackFillStyle (Page 531) RW - - Specifies the fill pattern.
BorderBackColor RW - - Specifies the background color of the broken border
(Page 558) line.
BorderColor (Page 562) RW - - Specifies the line color.
BorderFlashingColorOff RW - - Specifies the color of the border line for the flashing
(Page 566) status "Off".
BorderFlashingColorOn RW - - Specifies the color of the border line for the flashing
(Page 567) status "On".
BorderFlashingEnabled RW - - Specifies whether the limit of the object can flash in
(Page 569) runtime.
BorderFlashingRate RW - - Specifies the flash rate of the border line.
(Page 570)
BorderStyle (Page 576) RW - - Specifies the type of border lines.
BorderWidth (Page 577) RW - - Specifies the line thickness.
Bounds - - - -
CanBeGrouped - - - -
CornerStyle (Page 635) RW - - Specifies the shape of the corners.
DrawInsideFrame RW - - Specifies whether the border line is to be shown with
(Page 655) a line thickness of greater than 1 within the border or
symmetrically to the border.
EdgeStyle (Page 657) RW - - Specifies the line style.
Enabled (Page 660) RW - - Specifies whether the selected object can be operat‐
ed in runtime.
EndAngle (Page 666) RW - - Specifies the angle by which the end point deviates
from the zero position (0°).
FillingDirection RW - - Specifies the fill direction.
(Page 687)
FillPatternColor RW - - Specifies the color of the fill pattern.
(Page 685)
Flashing - - - -

WinCC Engineering V18 – Programming reference

304 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
FlashingColorOff RW - - Specifies the color of the border line for the flashing
(Page 693) status "Off".
FlashingColorOn RW - - Specifies the color of the border line for the flashing
(Page 695) status "On".
FlashingEnabled RW - - Specifies whether flashing is activated for the object
(Page 697) in runtime.
FlashingRate (Page 699) RW - - Specifies the flash rate of the border line.
Height (Page 720) RW - - Specifies the height.
Layer (Page 764) RW - - Specifies the layer in the screen that contains an ob‐
ject.
Left (Page 770) RW - - Specifies the value of the X coordinate.
LineEndShapeStyle RW - - Specifies the shape of the line ends.
(Page 787)
Location - - - -
Name - - - -
RadiusHeight RW - - Specifies the secondary axis.
(Page 876)
RadiusWidth (Page 877) RW - - Specifies the main axis.
RelativeFillLevel RW - - Specifies the fill percentage for the object.
(Page 881)
ShowFillLevel RW - - Specifies whether the selected object is filled.
(Page 933)
Size - - - -
StartAngle (Page 956) RW - - Specifies the angle by which the start point deviates
from the zero position (0°).
TabIndex - - - -
TabIndexAlpha - - - -
ToolTipText (Page 1082) RW - - Specifies the tooltip text.
Top (Page 1083) RW - - Specifies the value of the Y coordinate.
Transparency RW - - Specifies the object transparency in percent.
(Page 1087)
UseDesignColorSchema RW - - Specifies whether the colors defined in the global col‐
(Page 1148) or scheme of the current design are to be used for this
object.
UseDesignShadowSet‐ RW - - Specifies whether the object is displayed with global
tings (Page 1150) shading.
Visible (Page 1204) RW - - Specifies whether the selected object is visible.
Width (Page 1217) RW - - Specifies the width of the object in pixels.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 305
VB scripting
1.5 VBS object model

Table 1-37 Methods

Methods RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Activate (Page 1250) Yes Yes Yes Enables the permanent area or the root screen.
ActivateDynamic Yes - - Dynamically activates a trigger and the specified cycle
(Page 1252) for a property at runtime.
DeactivateDynamic Yes - - Deactivates the trigger of the "ActivateDynamic"
(Page 1259) method used for the specified property in/during run‐
time.

EllipticalArc

Description

6FUHHQV

6FUHHQ

6FUHHQ,WHPV

6FUHHQ,WHP

Represents the "EllipticalArc" object. The EllipticalArc object is an element of the ScreenItems
list.

Type identifier in VBS

HMIEllipticalArc

Abbreviation Access in runtime

R Read
RW Read and write
- No access

WinCC Engineering V18 – Programming reference

306 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Table 1-38 Properties

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
AllTagTypesAllowed - - - -
Authorization RW - - Specifies operating rights.
(Page 517)
BackColor (Page 526) RW - - Specifies the background color.
BorderStyle (Page 576) RW - - Specifies the type of border lines.
Bounds - - - -
CanBeGrouped - - - -
Color (Page 600) RW - - Specifies the line color.
CornerStyle (Page 635) RW - - Specifies the shape of the corners.
DrawInsideFrame RW - - Specifies whether the border line is to be shown with
(Page 655) a line thickness of greater than 1 within the border or
symmetrically to the border.
Enabled (Page 660) RW - - Specifies whether the selected object can be operat‐
ed in runtime.
EndAngle (Page 666) RW - - Specifies the angle by which the end point deviates
from the zero position (0°).
Flashing - - - -
FlashingColorOff RW - - Specifies the color of the border line for the flashing
(Page 693) status "Off".
FlashingColorOn RW - - Specifies the color of the border line for the flashing
(Page 695) status "On".
FlashingEnabled RW - - Specifies whether flashing is activated for the object
(Page 697) in runtime.
FlashingRate (Page 699) RW - - Specifies the flash rate of the border line.
Height (Page 720) RW - - Specifies the height.
Layer (Page 764) RW - - Specifies the layer in the screen that contains an ob‐
ject.
Left (Page 770) RW - - Specifies the value of the X coordinate.
LineEndShapeStyle RW - - Specifies the shape of the line ends.
(Page 787)
LineWidth (Page 790) RW - - Specifies the line thickness.
Location - - - -
Name - - - -
RadiusHeight RW - - Specifies the secondary axis.
(Page 876)
RadiusWidth (Page 877) RW - - Specifies the main axis.
Size - - - -
StartAngle (Page 956) RW - - Specifies the angle by which the start point deviates
from the zero position (0°).
Style (Page 981) RW - - Specifies the line style.
TabIndex - - - -

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 307
VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
TabIndexAlpha - - - -
ToolTipText (Page 1082) RW - - Specifies the tooltip text.
Top (Page 1083) RW - - Specifies the value of the Y coordinate.
Transparency RW - - Specifies the object transparency in percent.
(Page 1087)
UseDesignColorSchema RW - - Specifies whether the colors defined in the global col‐
(Page 1148) or scheme of the current design are to be used for this
object.
UseDesignShadowSet‐ RW - - Specifies whether the object is displayed with global
tings (Page 1150) shading.
Visible (Page 1204) RW - - Specifies whether the selected object is visible.
Width (Page 1217) RW - - Specifies the width of the object in pixels.

Table 1-39 Methods

Methods RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Activate (Page 1250) Yes - - Enables the permanent area or the root screen.
ActivateDynamic Yes - - Dynamically activates a trigger and the specified cycle
(Page 1252) for a property at runtime.
DeactivateDynamic Yes - - Deactivates the trigger of the "ActivateDynamic"
(Page 1259) method used for the specified property in/during run‐
time.

WinCC Engineering V18 – Programming reference

308 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

FunctionTrendControl

Description

6FUHHQV

6FUHHQ

6FUHHQ,WHPV

6FUHHQ,WHP

Represents the "f(x)FunctionTrendView" object. The FunctionTrendControl object is an

element of the ScreenItems list.

Type identifier in VBS

HMIFunctionTrendControl

Abbreviation Access in Runtime

R Read
RW Read and write
- No access

Table 1-40 Properties

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
AllTagTypesAllowed - - - -
ApplyProjectSettingsFor‐ - - - -
DesignMode
AvailableStatusbarEle‐ - - - -
ments
AvailableToolbarButtons - - - -
BackColor (Page 526) RW - - Specifies the background color.
BorderColor (Page 562) RW - - Specifies the line color.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 309
VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
BorderWidth (Page 577) RW - - Specifies the line thickness.
Bounds - - - -
CanBeGrouped - - - -
Caption (Page 587) RW - - Specifies the text to be displayed in the header.
Closeable (Page 599) RW - -
ConnectTrendWindows RW - - Specifies whether the configured trend views are con‐
(Page 632) nected.
ControlDesignMode RW - - Specifies the control design.
(Page 634)
Enabled (Page 660) - RW RW Specifies whether the selected object can be operat‐
ed in runtime.
ExportDelimiter - - - -
ExportDirectoryChange‐ RW - - Specifies whether the data export directory can be
able (Page 674) changed in runtime.
ExportDirectoryname RW - - Specifies the target directory for the exported run‐
(Page 675) time data.
ExportFileExtension RW - - Specifies the file extension of the export file.
(Page 675)
ExportFilename RW - - Specifies the name of the target file for the exported
(Page 676) runtime data.
ExportFilenameChange‐ RW - - Specifies whether the export file name can be
able (Page 677) changed in runtime.
ExportFormat - - - -
ExportFormatGuid RW - - Specifies the assignment of ID number and export
(Page 678) provider.
ExportFormatName RW - - Specifies the export file format.
(Page 679)
ExportParameters RW - - Specifies the parameters of the selected format by
(Page 680) means of the properties dialog.
ExportSelection RW - - Specifies which runtime data of the control is expor‐
(Page 681) ted.
ExportShowDialog RW - - Specifies whether the data export dialog is shown in
(Page 681) runtime.
Font (Page 705) RW - - Specifies the font.
GraphDirection RW - - Specifies at which border of the trend view the cur‐
(Page 717) rent values are displayed.
Height (Page 720) RW R R Specifies the height.
Layer (Page 764) - RW RW Specifies the layer in the screen that contains an ob‐
ject.
Left (Page 770) RW RW RW Specifies the value of the X coordinate.
LineColor (Page 786) RW - - Specifies the color of the window separation lines.
LineWidth (Page 790) RW - - Specifies the line thickness.
LoadDataImmediately RW - - Specifies whether the tag values are downloaded
(Page 792) from the logs for the time range to be displayed when
you call a screen.
Location - - - -

WinCC Engineering V18 – Programming reference

310 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Moveable (Page 825) RW - - Specifies whether the object can be moved in run‐
time.
Name - - - -
Object - - - -
OcxGuid - - - -
OcxState - - - -
OcxStateForEs2Rt - - - -
Online (Page 839) RW - - Specifies start and stop of the updating.
PrintJob (Page 873) RW - - Specifies a print job that is created in the "Reports"
editor.
RTPersistence RW - - Specifies whether online configurations are retained
(Page 888) after a screen change.
RTPersistenceAuthoriza‐ RW - - Specifies the authorization required for online config‐
tion (Page 889) uration in runtime.
RTPersistenceType RW - - Specifies how online configurations of WinCC are re‐
(Page 890) tained.
ShowRuler (Page 938) 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 time
(Page 939) axes.
ShowScrollbars RW - - Specifies whether scroll bars are displayed.
(Page 940)
ShowTitle (Page 947) 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 949) ue axes.
Size - - - -
Sizeable (Page 952) RW - - Specifies that the size of an object can be changed in
runtime.
StatusbarBackColor RW - - Specifies the background color for status bars.
(Page 959)
StatusbarElementAdd RW - - Creates a new, user-defined status bar element.
(Page 960)
StatusbarElementAuto‐ RW - - Specifies whether the width of a status bar element
Size (Page 961) referenced with "StatusbarElementIndex" is set auto‐
matically.
StatusbarElementCount RW - - Specifies the number of configured status bar ele‐
(Page 962) ments.
StatusbarElementIconId RW - - References a status bar element with its icon ID.
(Page 963)
StatusbarElementID RW - - References a status bar element with its element ID.
(Page 963)
StatusbarElementIndex RW - - References a status bar element.
(Page 964)
StatusbarElementName RW - - Specifies the name of a status bar element referenced
(Page 965) with "StatusbarElementIndex".

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 311
VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
StatusbarElementRe‐ RW - - Removes the user-defined status bar element refer‐
move (Page 966) enced with its name.
StatusbarElementRe‐ RW - - Specifies the new name of a user-defined status bar
name (Page 967) element referenced with "StatusbarElementIndex".
StatusbarElementRepos RW - - Specifies the position of an element referenced with
(Page 968) "StatusbarElementIndex" in the status bar of the ob‐
ject.
StatusbarElements - - - -
StatusbarElementText RW - - Specifies the text of a user-defined status bar element
(Page 969) referenced with "StatusbarElementIndex".
StatusbarElementTool‐ RW - - Specifies the text for the tooltip of a user-defined sta‐
tipText (Page 970) tus bar element referenced with "StatusbarElemen‐
tIndex".
StatusbarElementUser‐ RW - - Specifies whether the configuration engineer has
Defined (Page 970) 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 971) with "StatusbarElementIndex" is displayed in the ob‐
ject.
StatusbarElementWidth RW - - Specifies the width in pixels of a status bar element
(Page 972) referenced with "StatusbarElementIndex".
StatusbarFont RW - - Specifies the font of the texts in the status bar.
(Page 973)
StatusbarFontColor RW - - Specifies the color of the texts in the status bar.
(Page 974)
StatusbarShowTooltips RW - - Specifies whether tooltips are displayed for the ele‐
(Page 975) ments of the status bar in runtime.
StatusbarText RW - - Specifies the default text in the status bar.
(Page 976)
StatusbarUseBackColor RW - - Specifies whether the background color of the status
(Page 976) bar is shown.
StatusbarVisible RW - - Specifies whether the status bar of the control is dis‐
(Page 977) played.
SupportsUserDefined‐ - - - -
ToolbarButtons
TabIndex - - - -
TabIndexAlpha - - - -
TimeBase (Page 1024) RW - - Specifies the time zone in which the time values are
displayed.
ToolbarAlignment RW - - Specifies the position of the toolbar.
(Page 1059)
ToolbarBackColor RW - - Specifies the background color of the toolbar.
(Page 1060)
ToolbarButtonActive RW - - Specifies whether the function linked to the button is
(Page 1061) activated in runtime.
ToolbarButtonAdd RW - - Creates a new user-defined button in the object's
(Page 1062) toolbar.

WinCC Engineering V18 – Programming reference

312 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
ToolbarButtonAuthoriza‐ RW - - Specifies the authorization for the selected key func‐
tion (Page 1063) tion.
ToolbarButtonBe‐ RW - - Inserts a leading separator (vertical line) for the se‐
ginGroup (Page 1064) lected key function on the toolbar.
ToolbarButtonClick RW - - Clicks a toolbar button.
(Page 1065)
ToolbarButtonCount RW - - Specifies the number of configured buttons in the
(Page 1065) toolbar.
ToolbarButtonEnabled RW - - Specifies whether a user-defined toolbar button can
(Page 1066) be operated.
ToolbarButtonHotKey RW - - Specifies the hot key for the selected object button.
(Page 1067)
ToolbarButtonID RW - - References a button with its ID.
(Page 1068)
ToolbarButtonIndex RW - - References a button.
(Page 1069)
ToolbarButtonLocked RW - - Specifies whether the locked, pressed state of a user-
(Page 1070) defined button referenced with "ToolbarButtonIndex"
is displayed.
ToolbarButtonName RW - - Specifies the name of a user-defined button refer‐
(Page 1071) enced with "ToolbarButtonIndex".
ToolbarButtonRemove RW - - Removes a user-defined button referenced with its
(Page 1071) name.
ToolbarButtonRename RW - - Specifies the new name of a user-defined button ref‐
(Page 1072) erenced with "ToolbarButtonIndex".
ToolbarButtonRepos RW - - Specifies the position of a button referenced with
(Page 1073) "ToolbarButtonIndex" in the toolbar of the object.
ToolbarButtons - - - -
ToolbarButtonTooltip‐ RW - - Specifies the tooltip text for the user-defined button
Text (Page 1074) in the toolbar.
ToolbarButtonUserDe‐ RW - - Specifies whether the project engineer has added the
fined (Page 1075) toolbar button as new user-defined button.
ToolbarButtonVisible RW - - Specifies whether the button referenced with "Tool‐
(Page 1076) barButtonIndex" is displayed in the toolbar.
ToolbarShowTooltips RW - - Specifies whether the tooltips for the key functions
(Page 1078) are displayed in runtime.
ToolbarUseBackColor RW - - Specifies whether the background color for the tool‐
(Page 1079) bar is shown.
ToolbarUseHotKeys RW - - Specifies whether the hotkeys are activated for but‐
(Page 1080) tons in the toolbar.
ToolbarVisible RW - - Specifies whether the toolbar of the control is dis‐
(Page 1081) played.
Top (Page 1083) - R R Returns the value of the Y coordinate.
TrendActualize RW - - Specifies whether the selected trend is updated.
(Page 1091)
TrendAdd (Page 1092) RW - - Creates a new trend.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 313
VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

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

WinCC Engineering V18 – Programming reference

314 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 315
VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
TrendWindowGridIn‐ RW - - Specifies whether the grid lines for the main scaling
TrendColor (Page 1129) are displayed in the trend color.
TrendWindowHorizon‐ RW - - Specifies whether the horizontal grid lines are shown.
talGrid (Page 1130)
TrendWindowIndex RW - - References a trend view.
(Page 1131)
TrendWindowName RW - - Specifies the name of a trend view referenced with
(Page 1131) "TrendWindowIndex".
TrendWindowRemove RW - - Removes a trend view referenced with its name.
(Page 1132)
TrendWindowRename RW - - Specifies the new name of a trend view referenced
(Page 1132) with "TrendWindowIndex".
TrendWindowRepos RW - - Specifies the position of a trend view referenced with
(Page 1133) "TrendWindowIndex".
TrendWindowRulerCol‐ RW - - Specifies the color of the ruler.
or (Page 1134)
TrendWindowRulerLay‐ RW - - Specifies the display layer of the ruler in the trend
er (Page 1135) view.
TrendWindowRulerStyle RW - - Specifies the appearance of the ruler.
(Page 1135)
TrendWindowRuler‐ RW - - Specifies the thickness of the ruler in pixels.
Width (Page 1136)
TrendWindows - - - -
TrendWindowSpacePor‐ RW - - Specifies the range proportion of the referenced dia‐
tion (Page 1137) gram in the diagram area of the object.
TrendWindowVertical‐ RW - - Specifies whether the vertical grid lines are displayed.
Grid (Page 1140)
TrendWindowVisible RW - - Specifies whether the trend view referenced with
(Page 1140) "TrendWindowIndex" is displayed.
TrendXAxis (Page 1141) RW - - Defines the x-axis to be used for the referenced trend.
TrendYAxis (Page 1141) RW - - Defines the y-axis to be used for the referenced trend.
UseTrendNameAsLabel RW - - Specifies whether the "Name" or "Label" property is
(Page 1162) used as a designation for the trend in runtime.
Visible (Page 1204) - R R Specifies whether the selected object is visible.
Width (Page 1217) RW R R Specifies the width of the object in pixels.
XAxes - - - -
XAxisAdd (Page 1225) RW - - Creates a new X-axis.
XAxisAlignment RW - - Specifies the alignment of the X-axis referenced with
(Page 1226) "XAxisIndex".
XAxisAutoPrecisions RW - - Specifies whether the number of decimal places for
(Page 1226) an X-axis referenced with "XAxisIndex" is set auto‐
matically.
XAxisAutoRange RW - - Specifies whether the value range of an X-axis refer‐
(Page 1227) enced with "XAxisIndex" is calculated automatically.
XAxisBeginValue RW - - Specifies the lower end of the value range of an X-axis
(Page 1228) referenced with "XAxisIndex".

WinCC Engineering V18 – Programming reference

316 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 317
VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

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

Table 1-41 Methods

Methods RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Activate (Page 1250) Yes Yes Yes Enables the permanent area or the root screen.
ActivateDynamic Yes - - Dynamically activates a trigger and the specified cycle
(Page 1252) for a property at runtime.
AttachDB (Page 1256) Yes - - Executes the "Connect backup" key function of the
control.
DeactivateDynamic Yes - - Deactivates the trigger of the "ActivateDynamic"
(Page 1259) method used for the specified property in/during run‐
time.
DetachDB (Page 1262) Yes - - Executes the "Disconnect backup" key function of the
control.
Export (Page 1263) Yes - - Executes the "Export log" or "Export data" key func‐
tion of the control.
GetStatusbarElement Yes - - Returns the element of the control status bar desig‐
(Page 1289) nated by name or index as "ICCAxStatusbarElement"
type.
GetStatusbarElement‐ Yes - - Returns the list of all status bar elements of the con‐
Collection (Page 1290) trol as "ICCAxCollection" type.

WinCC Engineering V18 – Programming reference

318 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Methods RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
GetToolbarButton Yes - - Returns the control toolbar button function designa‐
(Page 1297) ted by name or index as "ICCAxToolbarButton" type.
GetToolbarButtonCollec‐ Yes - - Returns the list of all button functions of the control
tion (Page 1298) toolbar as "ICCAxCollection" type.
GetTrend (Page 1300) Yes - - Returns the f(t) or f(x) trend view trend designated by
name or index as "ICCAxTrend" or "ICCAxFunction‐
Trend" type.
GetTrendCollection Yes - - Returns the list of all trends of the f(t) or f(x) trend
(Page 1301) view as "ICCAxCollection" type.
GetTrendWindow Yes - - Returns the trend window object of the f(t) or f(x)
(Page 1302) trend view designated by name or index as "ICCAx‐
TrendWindow" type.
GetTrendWindowCollec‐ Yes - - Returns the list of all trend window objects of the f(t)
tion (Page 1303) or f(x) trend views as "ICCAxCollection" type.
GetXAxis (Page 1309) 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 1310) "ICCAxCollection" type.
GetYAxis (Page 1312) 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 as
(Page 1313) "ICCAxCollection" type.
MoveAxis (Page 1318) Yes - - Executes the "Move axes area" button function of the
f(t) and f(x) trend views.
NextTrend (Page 1325) 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 1325) f(t) and f(x) trend views.
PreviousTrend Yes - - Executes the "Previous trend" button function of the
(Page 1327) f(t) and f(x) trend views.
Print (Page 1327) Yes - - Executes the "Print" button function of the control.
ShowHelp (Page 1348) Yes - - Executes the "Help" button function of the control.
ShowPropertyDialog Yes - - Executes the "Configuration dialog" button function
(Page 1352) of the control.
ShowTagSelection Yes - - Executes the "Select data connection" button func‐
(Page 1356) tion of the control.
ShowTimeSelection Yes - - Executes the "Select time range" button function of
(Page 1357) the control.
ShowTrendSelection Yes - - Executes the "Select trends" button function of the
(Page 1358) f(t) and f(x) trend views.
StartStopUpdate Yes - - Executes the "Start" or "Stop" button function of the
(Page 1358) control.
ZoomArea (Page 1365) Yes - - Executes the "Zoom area" button function of the f(t)
and f(x) trend views.
ZoomInOut (Page 1366) Yes - - Executes the "Zoom +/-" button function of the f(t)
and f(x) trend views.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 319
VB scripting
1.5 VBS object model

Methods RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
ZoomInOutX (Page 1367) Yes - - Executes the "Zoom X axis +/-" button function of the
f(x) trend view.
ZoomInOutY (Page 1368) Yes - - Executes the "Zoom Y axis +/-" button function of the
f(x) trend view.
ZoomMove Yes - - Executes the "Move trend area" button function of
the f(t) and f(x) trend views.

Gauge

Description

6FUHHQV

6FUHHQ

6FUHHQ,WHPV

6FUHHQ,WHP

Represents the "Gauge" object. The Gauge object is an element of the ScreenItems list.

Type identifier in VBS

HMIGauge

Abbreviation Access in Runtime

R Read
RW Read and write
- No access

WinCC Engineering V18 – Programming reference

320 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Table 1-42 Properties

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
AllTagTypesAllowed - - - -
AngleMax (Page 511) RW RW RW Specifies the angle of the scale end of the "Gauge"
object.
AngleMin (Page 512) RW RW RW Specifies the angle of the scale start of the "Gauge"
object.
BackColor (Page 526) RW RW RW Specifies the background color.
BackFillStyle (Page 531) RW - - Specifies the fill pattern.
BackPicture (Page 538) RW - - Specifies the background graphic.
BackStyle (Page 538) RW - - Specifies the background style.
BorderBackColor - - - -
BorderColor - - - -
BorderInnerStyle3D RW - - Specifies the appearance of the inner part of the ob‐
(Page 572) ject border.
BorderOuterStyle3D RW - - Specifies the appearance of the outer part of the ob‐
(Page 573) ject border.
BorderWidth (Page 577) RW - - Specifies the line thickness.
BorderWidth3D RW - - Specifies the width of the inner border for 3D display.
(Page 580)
Bounds - - - -
CanBeGrouped - - - -
CaptionColor (Page 589) - RW RW Specifies the color of the text to be displayed in the
title bar.
CaptionFont (Page 589) RW - - Specifies the character set for the caption.
CaptionText (Page 590) RW RW RW Specifies the text to be displayed in the header.
CaptionTop (Page 591) RW - - Specifies the distance between the instrument labels
and the upper edge of the object.
CenterColor (Page 595) RW RW RW Specifies the color of the center point.
CenterSize (Page 595) RW - - Specifies the diameter of the scale center point.
CompatibilityMode - - - -
CornerRadius - - - -
DangerRangeColor RW RW RW Specifies the color of the danger range on the scale of
(Page 640) the "Gauge" object.
DangerRangeStart RW RW RW Specifies at which scale value the danger range of the
(Page 641) "Gauge" object will start.
DangerRangeVisible RW RW RW Specifies whether the danger range in the scale of the
(Page 642) "Gauge" object is to be displayed.
DeviceStyle - - - -
DialColor (Page 649) RW RW RW Specifies the color of the dial for the selected object.
DialFillStyle (Page 650) RW - - Specifies the type of background.
DialPicture (Page 650) RW - - Specifies a graphic for the dial.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 321
VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
DialSize (Page 651) RW - - Specifies the diameter of the scale in relation to the
smaller value of the geometry attributes "Width" and
"Height".
EdgeStyle (Page 657) - - - -
Enabled (Page 660) RW RW RW Specifies whether the selected object can be operat‐
ed in runtime.
Flashing (Page 692) RW - - Specifies whether the selected object flashes in run‐
time.
Gradation (Page 716) RW RW RW Specifies the value difference between two main
marks of the "Gauge" object.
InnerDialColor - - - -
InnerDialInnerDistance - - - -
InnerDialOuterDistane - - - -
Height (Page 720) RW R R Specifies the height.
Layer (Page 764) RW RW RW Specifies the layer in the screen that contains an ob‐
ject.
Left (Page 770) RW RW RW Specifies the value of the X coordinate.
LimitRangeCollection - - - -
Location - - - -
LockSquaredExtent RW - - Specifies whether the size of the clock can be adjus‐
(Page 793) ted with the mouse.
MaximumValue RW RW RW Specifies the maximum value of the scale in the se‐
(Page 799) lected object.
MinimumValue RW RW RW Specifies the minimum value of the scale in the se‐
(Page 822) lected object.
Name (Page 827) RW - - Specifies the object name.
NeedleHeight - - - -
NormalRangeColor RW RW RW Specifies the color of the normal range on the scale of
(Page 834) the "Gauge" object.
NormalRangeVisible RW RW RW Specifies whether the normal range in the scale of the
(Page 835) "Gauge" object is displayed.
PointerColor (Page 869) RW RW RW Specifies the pointer color of the "Gauge" object.
ProcessValue (Page 874) RW RW RW Specifies the default for the value to be displayed.
ScaleLabelColor RW RW RW Specifies the color of the label for the scale marks of
(Page 894) the "Gauge" object.
ScaleLabelFont RW - - Specifies the font for the scale label.
(Page 895)
ScaleTickColor RW RW RW Specifies the color of the scale gradation of the
(Page 896) "Gauge" object.
ScaleTickLabelPosition RW - - Specifies the diameter of the imaginary circle on
(Page 897) which the scale tick label is location.
ScaleTickLength RW - - Specifies the length of the main scale ticks.
(Page 898)
ScaleTickPosition RW - - Specifies the diameter of the assumed circle on which
(Page 898) the scale divisions are located.

WinCC Engineering V18 – Programming reference

322 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
ShowDecimalPoint RW - - Specifies whether the scale is labeled with decimal
(Page 928) figures (decimal point and one decimal place) or with
whole integers.
ShowInnerDial - - - -
ShowLimitRanges - - - -
ShowPeakValuePointer RW RW RW Specifies whether a slave pointer will be used for the
(Page 937) selected object.
Size - - - -
StyleItem - - - -
TabIndex - - - -
TabIndexAlpha - - - -
Top (Page 1083) RW RW RW Specifies the value of the Y coordinate.
Transparency RW - - Specifies the object transparency in percent.
(Page 1087)
UnitColor (Page 1143) RW RW RW Specifies the text color for the unit of measurement.
UnitFont (Page 1143) RW - - Specified the font of the unit of measurement.
UnitText (Page 1144) RW RW RW Specifies the text for the unit of measurement.
UnitTop (Page 1144) RW - - Specifies the distance from the unit of measurement
to the upper edge of the object.
UseDesignColorSchema RW - - Specifies whether the colors defined in the global
(Page 1148) color scheme of the current design are to be used for
this object.
UseDesignShadowSet‐ RW - - Specifies whether the object is displayed with global
tings (Page 1150) shading.
Visible (Page 1204) RW RW RW Specifies whether the selected object is visible.
WarningRangeColor RW RW RW Specifies the color of the warning range on the scale
(Page 1212) of the "Gauge" object.
WarningRangeStart RW RW RW Specifies at which scale value the warning range of
(Page 1213) the "Gauge" object will start.
WarningRangeVisible RW RW RW Specifies whether the warning range in the scale of
(Page 1214) the "Gauge" object is to be displayed.
Width (Page 1217) RW R R Specifies the width of the object in pixels.

Table 1-43 Methods

Methods RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Activate (Page 1250) Yes Yes Yes Enables the permanent area or the root screen.
ActivateDynamic Yes - - Dynamically activates a trigger and the specified cycle
(Page 1252) for a property at runtime.
DeactivateDynamic Yes - - Deactivates the trigger of the "ActivateDynamic"
(Page 1259) method used for the specified property in/during run‐
time.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 323
VB scripting
1.5 VBS object model

GraphicIOField

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

Type identifier in VBS

HMIGraphicIOField

Abbreviation Access in Runtime

R Read
RW Read and write
- No access

WinCC Engineering V18 – Programming reference

324 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Table 1-44 Properties

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
AboveUpperLimitColor - - - -
AdaptPicture - - - -
AllTagTypesAllowed - - - -
Authorization RW RW RW Specifies operating rights.
(Page 517)
AutoSizing - - - -
BackColor (Page 526) - RW RW Specifies the background color.
BackFillStyle - - - -
BelowLowerLimitColor - - - -
BitNumber - - - -
BorderBackColor RW - - Specifies the background color of the broken border
(Page 558) line.
BorderColor (Page 562) RW - - Specifies the line color.
BorderFlashingColorOff RW - - Specifies the color of the border line for the flashing
(Page 566) status "Off".
BorderFlashingColorOn RW - - Specifies the color of the border line for the flashing
(Page 567) status "On".
BorderFlashingEnabled RW - - Specifies whether the limit of the object can flash in
(Page 569) runtime.
BorderFlashingRate - - - -
BorderStyle (Page 576) RW - - Specifies the type of border lines.
BorderWidth (Page 577) RW - - Specifies the line thickness.
Bounds - - - -
CanBeGrouped - - - -
CornerStyle (Page 635) RW - - Specifies the shape of the corners.
DrawInsideFrame RW - - Specifies whether the border line is to be shown with
(Page 655) a line thickness of greater than 1 within the border or
symmetrically to the border.
EdgeStyle (Page 657) RW - - Specifies the line style.
Enabled (Page 660) RW RW RW Specifies whether the selected object can be operat‐
ed in runtime.
FitToLargest - - - -
Flashing - - - -
FlashingEnabled RW - - Specifies whether flashing is activated for the object
(Page 697) in runtime.
FlashingOnLimitViola‐ - - - -
tion
FlashingRate (Page 699) RW - - Specifies the flash rate of the border line.
FlashTransparentColor RW - - Specifies the color of the bitmap object of a flashing
(Page 701) graphic that is set to "transparent".

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 325
VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
FocusColor (Page 703) - RW RW Specifies the color of the focus border when the ob‐
ject has the focus.
FocusWidth (Page 704) - RW RW Specifies the border width when the object has the
focus.
Height (Page 720) RW R R Specifies the height.
HelpText (Page 724) - RW RW Specifies the tooltip that is shown in Runtime as user
help for the specified object.
IsImageMiddleAligned - - - -
Layer (Page 764) RW RW RW Specifies the layer in the screen that contains an ob‐
ject.
Left (Page 770) RW RW RW Specifies the value of the X coordinate.
LineEndShapeStyle RW - - Specifies the shape of the line ends.
(Page 787)
Location - - - -
Mode - - - -
Name - - - -
OnValue - - - -
PictureList - - - -
PictureOff (Page 866) RW - - Specifies the picture that is displayed in the "Off" sta‐
tus.
PictureOn (Page 867) RW - - Specifies the graphic that is displayed in the "On" sta‐
tus.
PictureRotation - - - -
ProcessValue (Page 874) RW - - Specifies the default for the value to be displayed.
ScrollBarOrientation - - - -
ShowScrollBar - - - -
Size - - - -
TabIndex - - - -
TabIndexAlpha - - - -
ToolTipText (Page 1082) RW RW RW Specifies the tooltip text.
Top (Page 1083) RW RW RW Specifies the value of the Y coordinate.
Transparency RW - - Specifies the object transparency in percent.
(Page 1087)
TransparentColor RW RW RW Specifies which color of the allocated graphic (*.bmp,
(Page 1089) *dib) is to be set to "transparent".
UseDesignShadowSet‐ RW - - Specifies whether the object is displayed with global
tings (Page 1150) shading.
UseFlashTransparent‐ RW - - Specifies whether the color of the bitmap object of a
Color (Page 1153) flashing graphic is set to "transparent".
UseTransparentColor RW RW RW Specifies whether the color defined with the "Trans‐
(Page 1159) parentColor" property is shown as transparent.
Visible (Page 1204) RW RW RW Specifies whether the selected object is visible.
Width (Page 1217) RW R R Specifies the width of the object in pixels.

WinCC Engineering V18 – Programming reference

326 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Table 1-45 Methods

Methods RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Activate (Page 1250) Yes Yes Yes Enables the permanent area or the root screen.
ActivateDynamic Yes - - Dynamically activates a trigger and the specified cycle
(Page 1252) for a property at runtime.
DeactivateDynamic Yes - - Deactivates the trigger of the "ActivateDynamic"
(Page 1259) method used for the specified property in/during run‐
time.

GraphicView

Description

6FUHHQV

6FUHHQ

6FUHHQ,WHPV

6FUHHQ,WHP

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

Type identifier in VBS

HMIGraphicView

Abbreviation Access in Runtime

R Read
RW Read and write
- No access

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 327
VB scripting
1.5 VBS object model

Table 1-46 Properties

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
AllTagTypesAllowed - - - -
AdaptPicture - - - -
Authorization RW - - Specifies operating rights.
(Page 517)
AutoSizing - - - -
BackColor (Page 526) RW RW RW Specifies the background color.
BackFillStyle (Page 531) RW - - Specifies the fill pattern.
BackFlashingColorOff RW - - Specifies the background color for flash state "Off".
(Page 533)
BackFlashingColorOn RW - - Specifies the background color for flash state "On".
(Page 534)
BackFlashingEnabled RW - - Specifies whether the background flashes in runtime.
(Page 535)
BackFlashingRate RW - - Specifies the flash rate of the background.
(Page 536)
BorderBackColor RW - - Specifies the background color of the broken border
(Page 558) line.
BorderColor (Page 562) RW - - Specifies the line color.
BorderFlashingColorOff RW - - Specifies the color of the border line for the flashing
(Page 566) status "Off".
BorderFlashingColorOn RW - - Specifies the color of the border line for the flashing
(Page 567) status "On".
BorderFlashingEnabled RW - - Specifies whether the limit of the object can flash in
(Page 569) runtime.
BorderFlashingRate RW - - Specifies the flash rate of the border line.
(Page 570)
BorderStyle (Page 576) RW - - Specifies the type of border lines.
BorderWidth (Page 577) RW - - Specifies the line thickness.
Bounds - - - -
CanBeGrouped - - - -
CornerStyle (Page 635) RW - - Specifies the shape of the corners.
DrawInsideFrame RW - - Specifies whether the border line is to be shown with
(Page 655) a line thickness of greater than 1 within the border or
symmetrically to the border.
EdgeStyle (Page 657) RW - - Specifies the line style.
Enabled (Page 660) RW RW RW Specifies whether the object can be operated in run‐
time.
FillingDirection RW - - Specifies the fill direction.
(Page 687)
FillPatternColor RW - - Specifies the color of the fill pattern.
(Page 685)
FitToLargest - - - -

WinCC Engineering V18 – Programming reference

328 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Flashing - - - -
Height (Page 720) RW R R Specifies the height.
IsImageMiddleAligned - - - -
Layer (Page 764) RW RW RW Specifies the layer in the screen that contains an ob‐
ject.
Left (Page 770) RW RW RW Specifies the value of the X coordinate.
LineEndShapeStyle RW - - Specifies the shape of the line ends.
(Page 787)
Location - - - -
Name - - - -
Picture (Page 864) RW - - Specifies the screen from the WinCC project graphics
to be displayed in the object in runtime.
PictureRotation - - - -
RelativeFillLevel RW - - Specifies the fill percentage for the object.
(Page 881)
ShowFillLevel RW - - Specifies whether the object is filled.
(Page 933)
Size - - - -
TabIndex - - - -
TabIndexAlpha - - - -
ToolTipText (Page 1082) RW RW RW Specifies the tooltip text.
Top (Page 1083) RW RW RW Specifies the value of the Y coordinate.
Transparency RW - - Specifies the object transparency in percent.
(Page 1087)
TransparentColor RW RW RW Specifies which color of the allocated graphic (*.bmp,
(Page 1089) *dib) is to be set to "transparent".
UseDesignColorSchema RW - - Specifies whether the colors defined in the global col‐
(Page 1148) or scheme of the current design are to be used for this
object.
UseDesignShadowSet‐ RW - - Specifies whether the object is displayed with global
tings (Page 1150) shading.
UseTransparentColor RW RW RW Specifies whether the color defined with the "Trans‐
(Page 1159) parentColor" property is shown as transparent.
Visible (Page 1204) RW RW RW Specifies whether the selected object is visible.
Width (Page 1217) RW R R Specifies the width of the object in pixels.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 329
VB scripting
1.5 VBS object model

Table 1-47 Methods

Methods RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Activate (Page 1250) Yes Yes Yes Enables the permanent area or the root screen.
ActivateDynamic Yes - - Dynamically activates a trigger and the specified cycle
(Page 1252) for a property at runtime.
DeactivateDynamic Yes - - Deactivates the trigger of the "ActivateDynamic"
(Page 1259) method used for the specified property in/during run‐
time.

HTMLBrowser

Description

6FUHHQV

6FUHHQ

6FUHHQ,WHPV

6FUHHQ,WHP

Represents the object "HTML Browser". The HTMLBrowser object is an element of the
ScreenItems-list.

Type identifier in VBS

HMIHTMLBrowser

Abbreviation Access in runtime

R Read
RW Read and write
- No access

WinCC Engineering V18 – Programming reference

330 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Table 1-48 Properties

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Address (Page 500) RW RW RW Specifies the web address that will be opened in the
HTML browser.
AddressEnabled - - - -
AllTagTypesAllowed - - - -
Bounds - - - -
BrowserTypeUsed - - - -
CanBeGrouped - - - -
Enabled (Page 660) RW RW RW Specifies whether the selected object can be operat‐
ed in runtime.
Flashing - - - -
Height (Page 720) RW R R Specifies the height.
Layer (Page 764) RW RW RW Specifies the layer in the screen that contains an ob‐
ject.
Left (Page 770) RW RW RW Specifies the value of the X coordinate.
Location - - - -
Name - - - -
ShowStatusBar RW - - Specifies whether the status bar is shown.
(Page 944)
ShowToolBar - - - -
Size - - - -
TabIndex - - - -
TabIndexAlpha - - - -
Top (Page 1083) RW RW RW Specifies the value of the Y coordinate.
Visible (Page 1204) RW RW RW Specifies whether the selected object is visible.
Width (Page 1217) RW R R Specifies the width of the object in pixels.

Table 1-49 Methods

Methods RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Activate (Page 1250) Yes Yes Yes Enables the permanent area or the root screen.
ActivateDynamic Yes - - Dynamically activates a trigger and the specified cycle
(Page 1252) for a property at runtime.
DeactivateDynamic Yes - - Deactivates the trigger of the "ActivateDynamic"
(Page 1259) method used for the specified property in/during run‐
time.
SetHtml (Page 1344) Yes - - Writes a HTML code in the display range of the HTML
browser.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 331
VB scripting
1.5 VBS object model

See also
SetHTML (Page 1344)

IOField

Description

6FUHHQV

6FUHHQ

6FUHHQ,WHPV

6FUHHQ,WHP

Represents the "I/O field" object. The IOField object is an element of the ScreenItems list.

Type identifier in VBS

HMIIOField

Abbreviation Access in Runtime

R Read
RW Read and write
- No access

Table 1-50 Properties

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
AboveUpperLimitColor RW - - Sets the color of the specified object for the "High
(Page 490) limit violated" event.
AcceptOnExit RW - - Specifies whether the input field is confirmed auto‐
(Page 491) matically when it is left.

WinCC Engineering V18 – Programming reference

332 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
AcceptOnFull RW - - Specifies whether the input field will be left and con‐
(Page 491) firmed automatically when the defined number of
values has been entered.
AdaptBorder (Page 498) RW - - Specifies whether the border of the object will be dy‐
namically adapted to the text size.
AllTagTypesAllowed - - - -
AskOperationMotive RW - - Specifies whether the reason for operating this object
(Page 514) is logged.
Authorization R R R Specifies the operating rights of the selected object in
(Page 517) runtime.
BackColor (Page 526) RW RW RW Specifies the background color of the selected object.
BackFillStyle (Page 531) RW - - Specifies the fill pattern of the selected object.
BackFlashingColorOff RW - - Specifies the background color for flash state "Off".
(Page 533)
BackFlashingColorOn RW - - Specifies the background color for flash state "On".
(Page 534)
BackFlashingEnabled RW - - Specifies whether the background of the selected ob‐
(Page 535) ject flashes in runtime.
BackFlashingRate RW - - Specifies the flash rate of the background for the se‐
(Page 536) lected object.
BelowLowerLimitColor RW - - Specifies the color for the "Low limit violated" event.
(Page 545)
BorderBackColor RW - - Specifies the background color of the broken border
(Page 558) line for the selected object.
BorderColor - - - -
BorderFlashingColorOff RW - - Specifies the border line color of the selected object
(Page 566) for the flash state "Off".
BorderFlashingColorOn RW - - Specifies the border line color of the selected object
(Page 567) for the flash state "On".
BorderFlashingEnabled RW - - Specifies whether the border line of the selected ob‐
(Page 569) ject flashes in runtime.
BorderFlashingRate RW - - Specifies the flash rate of the border line for the se‐
(Page 570) lected object.
BorderStyle (Page 576) RW - - Specifies the type of border lines for the selected ob‐
ject.
BorderWidth (Page 577) RW - - Specifies the line thickness of the selected object.
BorderWidth3D - - - -
BottomMargin - - - -
CanBeGrouped - - - -
ClearOnError (Page 598) RW - - Specifies whether an invalid input in this object is
deleted automatically.
ClearOnFocus RW - - Specifies whether the field entry is deleted as soon as
(Page 598) the I/O field is activated.
CornerRadius - - - -
CornerStyle (Page 635) RW - - Specifies the shape of the corners of the specified
object.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 333
VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
CursorControl RW - - Specifies whether the mouse cursor jumps to the next
(Page 639) field of the TAB sequence after leaving a field.
DataFormat (Page 642) RW - - Specifies the display format of an I/O field.
DeviceStyle - - - -
EdgeStyle (Page 657) RW RW RW Specifies the line style of the selected object.
EditOnFocus (Page 659) RW - - Specifies whether data input is immediately possible
if the input field is selected using the <Tab> key.
Enabled (Page 660) RW RW RW Specifies whether the selected object can be operat‐
ed in runtime.
FieldLength - - - -
FillPatternColor RW - - Specifies the color of the fill pattern for the selected
(Page 685) object.
FitToLargest - - - -
Flashing - - - -
FlashingColorOff RW - - Specifies the border line color of the selected object
(Page 693) for the flash state "Off".
FlashingColorOn RW - - Specifies the border line color of the selected object
(Page 695) for the flash state "On".
FlashingEnabled RW - - Specifies whether the border line of the selected ob‐
(Page 697) ject flashes in runtime.
FlashingOnLimitViola‐ - - - -
tion
FlashingRate (Page 699) RW - - Specifies the flash rate of the border line for the se‐
lected object.
Font - - - -
FontBold (Page 708) RW - - Specifies whether the text of the selected object is
shown in bold.
FontItalic (Page 708) RW - - Specifies whether the text of the selected object is
shown in italics.
FontName (Page 709) RW - - Specifies the font of the selected object.
FontSize (Page 711) RW - - Specifies the font size of the text for the selected ob‐
ject.
FontUnderline RW - - Specifies whether the text of the selected object is
(Page 711) underlined.
ForeColor (Page 712) RW RW RW Specifies the font color of the text for the selected
object.
FormatPattern RW - - Specifies the format of the output value.
(Page 714)
Height (Page 720) RW R R Specifies the height of the selected object.
HelpText (Page 724) - RW RW Specifies the tooltip that is shown in Runtime as user
help for the specified object.
HiddenInput (Page 725) 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
(Page 736) the selected object.
InputValue (Page 747) RW - - Specifies the input value.

WinCC Engineering V18 – Programming reference

334 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Layer (Page 764) RW RW RW Specifies the layer in the screen that contains an ob‐
ject.
Left (Page 770) RW RW RW Specifies the value of the X coordinate of the selected
object.
LeftMargin - - - -
LineEndShapeStyle RW - - Specifies the shape of the line ends.
(Page 787)
LineWrap - - - -
Location - - - -
LogOperation RW - - Specifies whether, after operating this object, an
(Page 794) alarm is output to the alarm system.
LowerLimit (Page 795) RW - - Specifies the low limit for input values.
Mode (Page 824) RW - - Specifies the field type of the selected object.
Name - - - -
ProcessValue (Page 874) RW RW RW Specifies the default for the value to be displayed.
RightMargin - - - -
ShiftDecimalPoint - - - -
ShowBadTagState RW - - Defines whether the object is grayed out when a bad
(Page 926) quality code or tag status is detected.
ShowLeadingZeros - - - -
Size - - - -
StyleItem - - - -
TabIndex - - - -
TabIndexAlpha - - - -
TextOrientation RW - - Specifies the text orientation of the selected object.
(Page 1004)
ToolTipText (Page 1082) RW RW RW Specifies the tooltip text.
Top (Page 1083) RW RW RW Specifies the value of the Y coordinate of the object.
TopMargin - - - -
Transparency RW - - Specifies the object transparency in percent.
(Page 1087)
Unit (Page 1142) RW - - Specifies the unit of measurement.
UpperLimit (Page 1145) RW - - Specifies the high limit for input values.
UseDesignColorSchema RW - - Specifies whether the colors defined in the global col‐
(Page 1148) or scheme of the current design are to be used for this
object.
UseDesignShadowSet‐ RW - - Specifies whether the object is displayed with the
tings (Page 1150) shading defined in the active design.
UseTagLimitColors RW - - Specifies whether the violation of the configured
(Page 1159) high and low limits for the object are highlighted in
color.
UseTwoHandOperation - R R Returns whether two-hand operation is enabled.
(Page 1162)
VerticalAlignment RW RW RW Specifies the vertical alignment of the text in the
(Page 1200) specified object.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 335
VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Visible (Page 1204) RW RW RW Specifies whether the selected object is visible.
Width (Page 1217) RW R R Specifies the width of the object in pixels.

Table 1-51 Methods

Methods RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Activate (Page 1250) Yes Yes Yes Enables the permanent area or the root screen.
ActivateDynamic Yes - - Dynamically activates a trigger and the specified cycle
(Page 1252) for a property at runtime.
DeactivateDynamic Yes - - Deactivates the trigger of the "ActivateDynamic"
(Page 1259) method used for the specified property in/during run‐
time.

See also
BorderColor (Page 562)

1.5.4.3 Objects K-Z

Line

Description

6FUHHQV

6FUHHQ

6FUHHQ,WHPV

6FUHHQ,WHP

WinCC Engineering V18 – Programming reference

336 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Represents the "Line" object. The Line object is an element of the ScreenItems list.

Type identifier in VBS

HMILine

Abbreviation Access in runtime

R Read
RW Read and write
- No access

Table 1-52 Properties

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
ActualPointIndex - - - -
ActualPointLeft - - - -
ActualPointTop - - - -
AllTagTypesAllowed - - - -
Authorization RW - - Specifies the operating rights of the selected object in
(Page 517) runtime.
BackColor (Page 526) RW RW RW Specifies the background color of the selected object.
BorderEndStyle RW - - Specifies the type of line ends for the selected object.
(Page 565)
BorderStyle (Page 576) RW - - Specifies the type of border lines for the selected ob‐
ject.
Bounds - - - -
CanBeGrouped - - - -
Color (Page 600) RW RW RW Specifies the line color of the selected object.
CornerStyle (Page 635) RW - - Specifies the shape of the corners of the selected ob‐
ject.
DeviceStyle - - - -
Enabled (Page 660) RW RW RW Specifies whether the selected object can be operat‐
ed in runtime.
EndLeft - - - -
EndStyle (Page 667) RW RW RW Specifies how the line end of the selected object is
displayed.
EndTop - - - -
FillStyle (Page 687) - RW RW Specifies the fill pattern of the selected object.
Flashing - - - -
FlashingColorOff RW - - Specifies the border line color of the selected object
(Page 693) for the flash state "Off".
FlashingColorOn RW - - Specifies the border line color of the selected object
(Page 695) for the flash state "On".
FlashingEnabled RW - - Specifies whether the border line of the selected ob‐
(Page 697) ject flashes in runtime.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 337
VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
FlashingRate (Page 699) RW - - Specifies the flash rate of the border line for the se‐
lected object.
Height (Page 720) RW R R Specifies the height of the selected object.
Layer (Page 764) RW RW RW Specifies the layer in the screen that contains an ob‐
ject.
Left (Page 770) RW RW RW Specifies the value of the X coordinate of the selected
object.
LineEndShapeStyle RW - - Specifies the shape of the line end.
(Page 787)
LineWidth (Page 790) 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 883)
RotationCenterLeft RW - - Specifies the X coordinate of the pivot point for the
(Page 883) object in runtime.
RotationCenterTop RW - - Specifies the Y coordinate of the pivot point for the
(Page 884) object in runtime.
Size - - - -
StartLeft - - - -
StartStyle (Page 957) RW RW RW Specifies how the line start of the selected object is
displayed.
StartTop - - - -
Style (Page 981) RW RW RW Specifies the line style of the selected object.
StyleItem - - - -
TabIndex - - - -
TabIndexAlpha - - - -
ToolTipText (Page 1082) RW RW RW Specifies the tooltip text.
Top (Page 1083) RW RW RW Specifies the value of the Y coordinate of the selected
object.
Transparency RW - - Specifies the object transparency in percent.
(Page 1087)
UseDesignColorSchema RW - - Specifies whether the colors defined in the global col‐
(Page 1148) or scheme of the current design are to be used for this
object.
UseDesignShadowSet‐ RW - - Specifies whether the object is displayed with the
tings (Page 1150) shading defined in the active design.
Visible (Page 1204) RW RW RW Specifies whether the selected object is visible.
Width (Page 1217) RW R R Specifies the width of the object in pixels.

WinCC Engineering V18 – Programming reference

338 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Table 1-53 Methods

Methods RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Activate (Page 1250) Yes Yes Yes Enables the permanent area or the root screen.
ActivateDynamic Yes - - Dynamically activates a trigger and the specified cycle
(Page 1252) for a property at runtime.
DeactivateDynamic Yes - - Deactivates the trigger of the "ActivateDynamic"
(Page 1259) method used for the specified property in/during run‐
time.

Listbox

Description

6FUHHQV

6FUHHQ

6FUHHQ,WHPV

6FUHHQ,WHP

Represents the "Listbox" object. The Listbox object is an element of the ScreenItems list.

Type identifier in VBS

HMIListBox

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 339
VB scripting
1.5 VBS object model

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

Abbreviation Access in Runtime

R Read
RW Read and write
- No access

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
AllTagTypesAllowed - - - -
AskOperationMotive RW - - Specifies whether the reason for operating this object
(Page 514) is logged.
Authorization RW - - Specifies operating rights.
(Page 517)
BackColor (Page 526) RW - - Specifies the background color.
BackFillStyle (Page 531) RW - - Specifies the fill pattern.
BorderBackColor RW - - Specifies the background color of the broken border
(Page 558) line.
BorderColor (Page 562) RW - - Specifies the line color.
BorderStyle (Page 576) RW - - Specifies the type of border lines.
BorderWidth (Page 577) RW - - Specifies the line thickness.
Bounds - - - -
CanBeGrouped - - - -
CornerStyle (Page 635) RW - - Specifies the shape of the corners.
CountVisibleItems RW - - Specifies how many lines the drop-down list is to con‐
(Page 638) tain.
EdgeStyle (Page 657) RW - - Specifies the line style.
Enabled (Page 660) RW - - Specifies whether the selected object can be operat‐
ed in runtime.
FillPatternColor - - - -
FitToLargest - - - -
Font - - - -
FontBold (Page 708) RW - - Specifies whether the text is shown in bold.
FontItalic (Page 708) RW - - Specifies whether the text is shown in italics.
FontName (Page 709) RW - - Specifies the font.
FontSize (Page 711) RW - - Specifies the font size of the text.

WinCC Engineering V18 – Programming reference

340 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
FontUnderline RW - - Specifies whether the text is shown underlined.
(Page 711)
ForeColor (Page 712) RW - - Specifies the font color of the text.
Height (Page 720) RW - - Specifies the height.
HorizontalAlignment RW - - Specifies the horizontal alignment of the text.
(Page 736)
Index (Page 741) RW - - Specifies the index for the selected text field.
Layer (Page 764) RW - - Specifies the layer in the screen that contains an ob‐
ject.
Left (Page 770) RW - - Specifies the value of the X coordinate.
LineEndShapeStyle RW - - Specifies the shape of the line ends.
(Page 787)
Location - - - -
LogOperation RW - - Specifies whether, after operating this object, an
(Page 794) alarm is output to the alarm system.
Name - - - -
SelectedIndex RW - - Specifies the index of which the associated text is
(Page 908) highlighted in the combo box or list box.
SelectedText (Page 910) RW - - Specifies the text for the entry referenced with "Se‐
lectedIndex".
Size - - - -
TabIndex - - - -
TabIndexAlpha - - - -
Text (Page 1000) RW - - Specifies the label for the text field.
TextHandles - - - -
Texts - - - -
ToolTipText (Page 1082) RW - - Specifies the tooltip text.
Top (Page 1083) RW - - Specifies the value of the Y coordinate.
Transparency (Page 1087) RW - - Specifies the object transparency in percent.
UseDesignColorSchema RW - - Specifies whether the colors defined in the global col‐
(Page 1148) or scheme of the current design are to be used for this
object.
UseDesignShadowSet‐ RW - - Specifies whether the object is displayed with global
tings (Page 1150) shading.
Visible (Page 1204) RW - - Specifies whether the selected object is visible.
Width (Page 1217) RW - - Specifies the width of the object in pixels.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 341
VB scripting
1.5 VBS object model

Table 1-54 Methods

Methods RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Activate (Page 1250) Yes - - Enables the permanent area or the root screen.
ActivateDynamic Yes - - Dynamically activates a trigger and the specified cycle
(Page 1252) for a property at runtime.
DeactivateDynamic Yes - - Deactivates the trigger of the "ActivateDynamic"
(Page 1259) method used for the specified property in/during run‐
time.

MediaPlayer

Description

6FUHHQV

6FUHHQ

6FUHHQ,WHPV

6FUHHQ,WHP

Represents the "Media Player" object. The MediaPlayer object is an element of the
ScreenItems list.

Type identifier in VBS

HMIMediaPlayer

WinCC Engineering V18 – Programming reference

342 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Application
In the following example, the object with the name "Control1" is moved 16 pixels to the right:

'VBS60
Dim objControl
Set objControl = ScreenItems("Control1")
objControl.Left = objControl.Left + 16

Abbreviation Access in runtime

R Read
RW Read and write
- No access

Table 1-55 Properties

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
AllTagTypesAllowed - - - -
AspectRatio (Page 515) RW - - Specifies whether the aspect ratio of the media player
is maintained when the size is changed.
AutoStart - - - -
Bounds - - - -
CanBeGrouped - - - -
Enabled (Page 660) RW RW RW Specifies whether the selected object can be operat‐
ed in runtime.
FileName (Page 683) RW - - Specifies the name of the file to be loaded.
Height (Page 720) RW R R Specifies the height.
Layer (Page 764) RW RW RW Specifies the layer in the screen that contains an ob‐
ject.
Left (Page 770) RW RW RW Specifies the value of the X coordinate.
Location - - - -
Name - - - -
PictureSizeMode RW - - Specifies the size adjustment between the media
(Page 868) player and the content to be displayed.
PlayCount - - - -
PlayEndless (Page 869) RW - - Specifies that the media file is to play endlessly.
PopupMenuEnabled - - - -
ShowControls RW - - Specifies that a toolbar is displayed.
(Page 928)
ShowFeatureBackward RW - - Specifies that the "Backward" button is to be displayed
(Page 930) in runtime.
ShowFeatureForward RW - - Specifies that the "Forward" button is displayed in
(Page 930) runtime.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 343
VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
ShowFeatureFullScreen RW - - Specifies that the Media Player can be displayed as a
(Page 931) full screen.
ShowFeatureFullVolume - - - -
ShowFeaturePause RW - - Specifies that the "Pause" button is displayed in run‐
(Page 931) time.
ShowFeaturePlay RW - - Specifies that the "Play" button is displayed in runtime.
(Page 932)
ShowFeatureStop RW - - Specifies that the "Stop" button is displayed in run‐
(Page 932) time.
ShowStatusBar - - - -
ShowTracker (Page 948) RW - - Specifies that the tracker is displayed.
Size - - - -
StepSeconds (Page 980) RW - - Specifies the step interval in seconds after the "For‐
ward" or "Backward" key is pressed.
TabIndex - - - -
TabIndexAlpha - - - -
Top (Page 1083) RW RW RW Specifies the value of the Y coordinate.
Visible (Page 1204) RW RW RW Specifies whether the selected object is visible.
Width (Page 1217) RW R R Specifies the width of the object in pixels.

Table 1-56 Methods

Methods RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Activate (Page 1250) Yes - Yes Enables the permanent area or the root screen.
ActivateDynamic Yes - - Dynamically activates a trigger and the specified cycle
(Page 1252) for a property at runtime.
DeactivateDynamic Yes - - Deactivates the trigger of the "ActivateDynamic"
(Page 1259) method used for the specified property in/during run‐
time.

WinCC Engineering V18 – Programming reference

344 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

MultiLineEdit

Description

6FUHHQV

6FUHHQ

6FUHHQ,WHPV

6FUHHQ,WHP

Represents the "Editable text field" object. The MultiLineEdit object is an element of the
ScreenItems list.

Type identifier in VBS

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

Abbreviation Access in Runtime

R Read
RW Read and write
- No access

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 345
VB scripting
1.5 VBS object model

Table 1-57 Properties

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
AllTagTypesAllowed - - - -
Authorization RW - - Specifies operating rights.
(Page 517)
BackColor (Page 526) RW - - Specifies the background color.
BorderBackColor RW - - Specifies the background color of the broken border
(Page 558) line.
BorderColor (Page 562) RW - - Specifies the line color.
BorderStyle (Page 576) RW - - Specifies the type of border lines.
BorderWidth (Page 577) RW - - Specifies the line thickness.
Bounds - - - -
CanBeGrouped - - - -
CornerStyle (Page 635) RW - - Specifies the shape of the corners.
EdgeStyle (Page 657) RW - - Specifies the line style.
Enabled (Page 660) RW - - Specifies whether the selected object can be operat‐
ed in runtime.
Font - - - -
FontBold (Page 708) RW - - Specifies whether the text is shown in bold.
FontItalic (Page 708) RW - - Specifies whether the text is shown in italics.
FontName - - - -
FontSize (Page 711) RW - - Specifies the font size of the text.
FontUnderline RW - - Specifies whether the text is shown underlined.
(Page 711)
ForeColor (Page 712) RW - - Specifies the font color of the text.
Height (Page 720) RW - - Specifies the height.
HorizontalAlignment RW - - Specifies the horizontal alignment of the text.
(Page 736)
Layer (Page 764) RW - - Specifies the layer in the screen that contains an ob‐
ject.
Left (Page 770) RW - - Specifies the value of the X coordinate.
LineEndShapeStyle RW - - Specifies the shape of the line ends.
(Page 787)
Location - - - -
Name - - - -
Size - - - -
TabIndex - - - -
TabIndexAlpha - - - -
Text (Page 1000) RW - - Specifies the label for the text field.
ToolTipText (Page 1082) RW - - Specifies the tooltip text.
Top (Page 1083) RW - - Specifies the value of the Y coordinate.
Transparency (Page 1087) RW - - Specifies the object transparency in percent.

WinCC Engineering V18 – Programming reference

346 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
UseDesignColorSchema RW - - Specifies whether the colors defined in the global col‐
(Page 1148) or scheme of the current design are to be used for this
object.
UseDesignShadowSet‐ RW - - Specifies whether the object is displayed with global
tings (Page 1150) shading.
Visible (Page 1204) RW - - Specifies whether the selected object is visible.
Width (Page 1217) RW - - Specifies the width of the object in pixels.

Table 1-58 Methods

Methods RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Activate (Page 1250) Yes - - Enables the permanent area or the root screen.
ActivateDynamic Yes - - Dynamically activates a trigger and the specified cy‐
(Page 1252) cle for a property at runtime.
DeactivateDynamic Yes - - Deactivates the trigger of the "ActivateDynamic"
(Page 1259) method used for the specified property in/during run‐
time.
GetSelectionText Yes - - -
SetSelection Yes - - -
SetSelectionText Yes - - -

OnlineTableControl

Description

6FUHHQV

6FUHHQ

6FUHHQ,WHPV

6FUHHQ,WHP

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 347
VB scripting
1.5 VBS object model

Represents the "Table view" object. The OnlineTableControl object is an element of the
ScreenItems list.

Type identifier in VBS

HMIOnlineTableControl

Abbreviation Access in Runtime

R Read
RW Read and write
- No access

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
AllTagTypesAllowed - - - -
ApplyProjectSettingsFor‐ - - - -
DesignMode
AutoCompleteColumns RW - - Specifies whether empty columns are shown if the
(Page 519) control is wider than the configured columns.
AutoCompleteRows RW - - Specifies whether empty rows are shown if the con‐
(Page 519) trol is longer than the number of configured rows.
AutoSelectionColors RW - - Specifies whether the colors defined by the system
(Page 521) are used as the selection colors for cells and rows.
AutoSelectionRectColor RW - - Specifies whether the selection frame is shown with
(Page 522) the color defined by the system.
BackColor (Page 526) RW - - Specifies the background color.
BorderColor (Page 562) RW - - Specifies the line color.
BorderWidth (Page 577) RW - - Specifies the line thickness.
Bounds - - - -
CanBeGrouped - - - -
Caption - - - -
CellCut (Page 591) RW - - Specifies whether the contents of the cells are abbre‐
viated if the cells are too narrow.
CellSpaceBottom RW - - Specifies the bottom margin of the table cells.
(Page 592)
CellSpaceLeft RW - - Specifies the left indent used in the table cells.
(Page 593)
CellSpaceRight RW - - Specifies the right indent used in the table cells.
(Page 593)
CellSpaceTop (Page 594) RW - - Specifies the top margin of the table cells.
Closeable (Page 599) RW - - Specifies whether the object can be closed in runtime.
ColumnResize RW - - Specifies whether you can change the width of the
(Page 616) columns.
ColumnScrollbar RW - - Specifies when the horizontal scroll bar is to be dis‐
(Page 617) played.

WinCC Engineering V18 – Programming reference

348 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
ColumnTitleAlignment RW - - Specifies the alignment of the title in a column refer‐
(Page 627) enced with "ColumnIndex".
ColumnTitles (Page 628) RW - - Specifies whether the column header is displayed.
ControlDesignMode RW - - Specifies the control design.
(Page 634)
Enabled (Page 660) - - - -
EnableEdit (Page 664) RW - - Specifies whether the data shown can be edited in
runtime.
ExportDelimiter - - - -
ExportDirectoryChange‐ RW - - Specifies whether the data export directory can be
able (Page 674) changed in runtime.
ExportDirectoryname RW - - Specifies the target directory for the exported run‐
(Page 675) time data.
ExportFileExtension RW - - Specifies the file extension of the export file.
(Page 675)
ExportFilename RW - - Specifies the name of the target file for the exported
(Page 676) runtime data.
ExportFilenameChange‐ RW - - Specifies whether the export file name can be
able (Page 677) changed in runtime.
ExportFormat - - - -
ExportFormatGuid RW - - Specifies the assignment of ID number and export
(Page 678) provider.
ExportFormatName RW - - Specifies the export file format.
(Page 679)
ExportParameters RW - - Specifies the parameters of the selected format by
(Page 680) means of the properties dialog.
ExportSelection RW - - Specifies which runtime data of the control is expor‐
(Page 681) ted.
ExportShowDialog RW - - Specifies whether the data export dialog is shown in
(Page 681) runtime.
FillPattern - - - -
FillPatternColor - - - -
Font (Page 705) RW - - Specifies the font.
GridLineColor RW - - Specifies the color for the grid lines.
(Page 717)
GridLineWidth RW - - Specifies the width of the separation lines in pixels.
(Page 719)
Height (Page 720) RW - - Specifies the height.
HorizontalGridLines RW - - Specifies whether horizontal separating lines are dis‐
(Page 737) played.
IconSpace (Page 740) RW - - Specifies the spacing between icons and text in the
table cells.
Layer - - - -
Left (Page 770) RW - - Specifies the value of the X coordinate.
LineBackgroundColor - - - -
LineColor (Page 786) RW - - Specifies the color of the window separation lines.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 349
VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
LineStyle - - - -
LineWidth (Page 790) RW - - Specifies the line thickness.
LoadDataImmediately RW - - Specifies whether the tag values are downloaded
(Page 792) from the logs for the time range to be displayed when
you call a screen.
Location - - - -
MaximumNumberOfTi‐ - - - -
meColumns
MaximumNumberOfVa‐ - - - -
lueColumns
MinimumNumberOfTi‐ - - - -
meColumns
MinimumNumberOfVa‐ - - - -
lueColumns
Moveable (Page 825) RW - - Specifies whether the object can be moved in run‐
time.
Name - - - -
Object - - - -
OcxGuid - - - -
OcxState - - - -
OcxStateForEs2Rt - - - -
Online (Page 839) RW - - Specifies start and stop of the updating.
PrintJob (Page 873) RW - - Specifies a print job that is created in the "Reports"
editor.
RowScrollbar (Page 886) RW - - Specifies when the vertical scroll bar is displayed.
RowTitleAlignment RW - - Specifies the type of row header alignment.
(Page 886)
RowTitles (Page 887) RW - - Specifies whether numbered column headers are dis‐
played.
RTPersistence RW - - Specifies whether online configurations are retained
(Page 888) after a screen change.
RTPersistenceAuthoriza‐ RW - - Specifies the authorization required for online config‐
tion (Page 889) uration in runtime.
RTPersistenceType RW - - Specifies how online configurations of WinCC are re‐
(Page 890) tained.
SelectedCellColor RW - - Specifies the background color of the selected cell.
(Page 906)
SelectedCellForeColor RW - - Specifies the font color of the selected cell.
(Page 907)
SelectedRowColor RW - - Specifies the background color of the selected row.
(Page 909)
SelectedRowForeColor RW - - Specifies the font color of the selected row.
(Page 909)
SelectedTitleColor RW - - Specifies the background color of the selected table
(Page 911) header.

WinCC Engineering V18 – Programming reference

350 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
SelectedTitleForeColor RW - - Specifies the font color of the selected table header.
(Page 912)
SelectionColoring RW - - Specifies whether selection colors are used for cells or
(Page 914) rows.
SelectionRect (Page 916) RW - - Enables the use of a selection border for selected cells
or rows.
SelectionRectColor RW - - Specifies the color of the selection rectangle in the
(Page 917) alarm window.
SelectionRectWidth RW - - Specifies the line width of the selection rectangle in
(Page 917) the alarm window if SelectionType equals "1".
SelectionType RW - - Specifies the number of lines you can mark.
(Page 918)
ShowSortButton RW - - Specifies whether the sorting button is shown above
(Page 941) the vertical scroll bar.
ShowSortIcon RW - - Specifies whether the sorting icon is displayed.
(Page 942)
ShowSortIndex RW - - Specifies whether a sort index is displayed.
(Page 942)
ShowTitle (Page 947) RW - - Specifies the style of the window border and window
title for the object.
Size - - - -
Sizeable (Page 952) RW - - Specifies that the size of an object can be changed in
runtime.
SortSequence RW - - Specifies how the sorting order is changed if the op‐
(Page 954) erator clicks on the column header in runtime.
StatusbarBackColor RW - - Specifies the background color for status bars.
(Page 959)
StatusbarElementAdd RW - - Creates a new, user-defined status bar element.
(Page 960)
StatusbarElementAuto‐ RW - - Specifies whether the width of a status bar element
Size (Page 961) referenced with "StatusbarElementIndex" is set auto‐
matically.
StatusbarElementCount RW - - Specifies the number of configured status bar ele‐
(Page 962) ments.
StatusbarElementIconId RW - - References a status bar element with its icon ID.
(Page 963)
StatusbarElementID RW - - References a status bar element with its element ID.
(Page 963)
StatusbarElementIndex RW - - References a status bar element.
(Page 964)
StatusbarElementName RW - - Specifies the name of a status bar element referenced
(Page 965) with "StatusbarElementIndex".
StatusbarElementRe‐ RW - - Removes the user-defined status bar element refer‐
move (Page 966) enced with its name.
StatusbarElementRe‐ RW - - Specifies the new name of a user-defined status bar
name (Page 967) element referenced with "StatusbarElementIndex".

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 351
VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
StatusbarElementRepos RW - - Specifies the position of an element referenced with
(Page 968) "StatusbarElementIndex" in the status bar of the ob‐
ject.
StatusbarElements - - - -
StatusbarElementText RW - - Specifies the text of a user-defined status bar element
(Page 969) referenced with "StatusbarElementIndex".
StatusbarElementTool‐ RW - - Specifies the text for the tooltip of a user-defined sta‐
tipText (Page 970) tus bar element referenced with "StatusbarElemen‐
tIndex".
StatusbarElementUser‐ RW - - Specifies whether the configuration engineer has
Defined (Page 970) 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 971) with "StatusbarElementIndex" is displayed in the ob‐
ject.
StatusbarElementWidth RW - - Specifies the width in pixels of a status bar element
(Page 972) referenced with "StatusbarElementIndex".
StatusbarFont RW - - Specifies the font of the texts in the status bar.
(Page 973)
StatusbarFontColor RW - - Specifies the color of the texts in the status bar.
(Page 974)
StatusbarShowTooltips RW - - Specifies whether tooltips are displayed for the ele‐
(Page 975) ments of the status bar in runtime.
StatusbarText RW - - Specifies the default text in the status bar.
(Page 976)
StatusbarUseBackColor RW - - Specifies whether the background color of the status
(Page 976) bar is shown.
StatusbarVisible RW - - Specifies whether the status bar of the control is dis‐
(Page 977) played.
TabIndex - - - -
TabIndexAlpha - - - -
TableColor (Page 988) RW - - Specifies the background color of the table rows in
the object.
TableColor2 (Page 989) RW - - Specifies the second background color of the table
rows in the object.
TableForeColor RW - - Specifies the text color used in the table cells of the
(Page 990) object.
TableForeColor2 RW - - Specifies the second text color used in the table cells
(Page 991) of the object.
TimeBase (Page 1024) RW - - Specifies the time zone in which the time values are
displayed.
TimeColumnActualize RW - - Specifies whether the values of the time column ref‐
(Page 1025) erenced with "TimeColumnIndex" are updated.
TimeColumnAdd RW - - Creates a new time column.
(Page 1025)
TimeColumnAlignment RW - - Specifies how the text in the time column referenced
(Page 1026) with "TimeColumnIndex" is aligned.

WinCC Engineering V18 – Programming reference

352 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
TimeColumnBackColor RW - - Specifies the background color of the time column
(Page 1026) referenced with "TimeColumnIndex".
TimeColumnBeginTime RW - - Specifies the start of the time range for the time col‐
(Page 1027) umn referenced with "TimeColumnIndex".
TimeColumnCaption RW - - Specifies the label of the time column referenced
(Page 1028) with "TimeColumnIndex".
TimeColumnCount RW - - Specifies the number of configured time columns.
(Page 1028)
TimeColumnDateFor‐ RW - - Specifies the date format for displaying the time col‐
mat (Page 1029) umn referenced with "TimeColumnIndex".
TimeColumnEndTime RW - - Defines the end of the time range of for a time col‐
(Page 1029) umn referenced with "TimeColumnIndex".
TimeColumnForeColor RW - - Specifies the font color of the time column referenced
(Page 1030) with "TimeColumnIndex".
TimeColumnHideText RW - - Specifies whether the content of the time column
(Page 1030) referenced with "TimeColumnIndex" is displayed as
text.
TimeColumnHideTitle‐ RW - - Specifies whether the header of the time column ref‐
Text (Page 1031) erenced with "TimeColumnIndex" is displayed as text.
TimeColumnIndex RW - - References a configured time column.
(Page 1032)
TimeColumnLength RW - - Specifies the width of the time column referenced
(Page 1032) with "TimeColumnIndex".
TimeColumnMeasure‐ RW - - Specifies the number of measuring points to be dis‐
Points (Page 1033) played in the time column referenced with "TimeCo‐
lumnIndex".
TimeColumnName RW - - Specifies the name of a time column referenced with
(Page 1033) "TimeColumnIndex".
TimeColumnRangeType RW - - Specifies the time range for a time column referenced
(Page 1034) with "TimeColumnIndex".
TimeColumnRemove RW - - Removes a time column referenced with its name.
(Page 1034)
TimeColumnRename RW - - Specifies the new name of a time column referenced
(Page 1035) with "TimeColumnIndex".
TimeColumnRepos RW - - For multiple time columns with corresponding value
(Page 1035) columns, specifies the position of a time column ref‐
erenced with "TimeColumnIndex".
TimeColumns - - - -
TimeColumnShowDate RW - - Specifies whether the time column referenced with
(Page 1036) "TimeColumnIndex" is displayed with date and time.
TimeColumnShowIcon RW - - Specifies whether the content of the time column
(Page 1037) referenced with "TimeColumnIndex" is displayed as
an icon.
TimeColumnShowTitleI‐ RW - - Specifies whether the header of the time column ref‐
con (Page 1037) erenced with "TimeColumnIndex" is displayed as an
icon.
TimeColumnSort RW - - Specifies how a time column referenced with "Time‐
(Page 1038) ColumnIndex" is sorted.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 353
VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
TimeColumnSortIndex RW - - Specifies the sorting order of the time column refer‐
(Page 1039) enced in "TimeColumnIndex".
TimeColumnTimeFor‐ RW - - Specifies the time format for displaying the time col‐
mat (Page 1039) umn referenced with "TimeColumnIndex".
TimeColumnTimeRange‐ RW - - Specifies the time unit for calculating the time range
Base (Page 1040) displayed in the time column referenced with "Time‐
ColumnIndex".
TimeColumnTimeRange‐ RW - - Specifies the factor for calculating the time range.
Factor (Page 1040)
TimeColumnUseValue‐ RW - - Specifies whether the time column referenced with
ColumnColors "TimeColumnIndex" is displayed in the colors of the
(Page 1041) value column.
TimeColumnVisible RW - - Specifies whether the time column referenced with
(Page 1042) "TimeColumnIndex" is displayed in the table view.
TimeStepBase RW - - Specifies the time unit for the accuracy of the time
(Page 1044) stamp that is displayed in the table.
TimeStepFactor RW - - Specifies the time stamp accuracy with the "Time‐
(Page 1044) StepBase" time unit.
TitleColor (Page 1045) RW - - Specifies the background color of the table header.
TitleCut (Page 1046) 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 1047) for column and row headers in the object table.
TitleForeColor RW - - Specifies the text color for the table column and row
(Page 1047) headers of the object.
TitleGridLineColor RW - - Specifies the color of the separation lines in the title
(Page 1048) bar of the table.
TitleLightShadowColor RW - - Specifies the color for the light side of the 3D shading
(Page 1049) for table column and row headers of the object.
TitleSort (Page 1050) RW - - Specifies how sorting by column header is triggered.
TitleStyle (Page 1051) RW - - Specifies whether to use a shading color for the text
in the column headers.
ToolbarAlignment RW - - Specifies the position of the toolbar.
(Page 1059)
ToolbarBackColor RW - - Specifies the background color of the toolbar.
(Page 1060)
ToolbarButtonActive RW - - Specifies whether the function linked to the button is
(Page 1061) activated in runtime.
ToolbarButtonAdd RW - - Creates a new user-defined button in the object's
(Page 1062) toolbar.
ToolbarButtonAuthoriza‐ RW - - Specifies the authorization for the selected key func‐
tion (Page 1063) tion.
ToolbarButtonBe‐ RW - - Inserts a leading separator (vertical line) for the se‐
ginGroup (Page 1064) lected key function on the toolbar.
ToolbarButtonClick RW - - Clicks a toolbar button.
(Page 1065)

WinCC Engineering V18 – Programming reference

354 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
ToolbarButtonCount RW - - Specifies the number of configured buttons in the
(Page 1065) toolbar.
ToolbarButtonEnabled RW - - Specifies whether a user-defined toolbar button can
(Page 1066) be operated.
ToolbarButtonHotKey RW - - Specifies the hot key for the selected object button.
(Page 1067)
ToolbarButtonID RW - - References a button with its ID.
(Page 1068)
ToolbarButtonIndex RW - - References a button.
(Page 1069)
ToolbarButtonLocked RW - - Specifies whether the locked, pressed state of a user-
(Page 1070) defined button referenced with "ToolbarButtonIndex"
is displayed.
ToolbarButtonName RW - - Specifies the name of a user-defined button refer‐
(Page 1071) enced with "ToolbarButtonIndex".
ToolbarButtonRemove RW - - Removes a user-defined button referenced with its
(Page 1071) name.
ToolbarButtonRename RW - - Specifies the new name of a user-defined button ref‐
(Page 1072) erenced with "ToolbarButtonIndex".
ToolbarButtonRepos RW - - Specifies the position of a button referenced with
(Page 1073) "ToolbarButtonIndex" in the toolbar of the object.
ToolbarButtons - - - -
ToolbarButtonTooltip‐ RW - - Specifies the tooltip text for the user-defined button
Text (Page 1074) in the toolbar.
ToolbarButtonUserDe‐ RW - - Specifies whether the project engineer has added the
fined (Page 1075) toolbar button as new user-defined button.
ToolbarButtonVisible RW - - Specifies whether the button referenced with "Tool‐
(Page 1076) barButtonIndex" is displayed in the toolbar.
ToolbarShowTooltips RW - - Specifies whether the tooltips for the key functions
(Page 1078) are displayed in runtime.
ToolbarUseBackColor RW - - Specifies whether the background color for the tool‐
(Page 1079) bar is shown.
ToolbarUseHotKeys RW - - Specifies whether the hotkeys are activated for but‐
(Page 1080) tons in the toolbar.
ToolbarVisible RW - - Specifies whether the toolbar of the control is dis‐
(Page 1081) played.
Top (Page 1083) RW - - Specifies the value of the Y coordinate.
UseColumnBackColor RW - - Specifies the settings for the background color of the
(Page 1146) columns.
UseColumnForeColor RW - - Specifies the settings for the font color of the col‐
(Page 1147) umns.
UseSelectedTitleColor RW - - Specifies whether a selection color is used for the
(Page 1156) headers of selected table cells.
UseTableColor2 RW - - Specifies whether a second row color is used for the
(Page 1158) representation of the table.
ValueColumnAdd RW - - Creates a new value column.
(Page 1183)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 355
VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
ValueColumnAlignment RW - - Specifies how the text in the value column referenced
(Page 1183) with "ValueColumnIndex" is aligned.
ValueColumnAutoPreci‐ RW - - Specifies whether the number of decimal places for a
sions (Page 1184) value axis referenced with "ValueColumnIndex" is set
automatically.
ValueColumnBackColor RW - - Specifies the background color of the value column
(Page 1185) referenced with "ValueColumnIndex".
ValueColumnCaption RW - - Specifies the name of the value column referenced
(Page 1185) with "ValueColumnIndex".
ValueColumnCount RW - - Specifies the number of configured value columns.
(Page 1186)
ValueColumnExponen‐ RW - - Specifies whether the values of a value column refer‐
tialFormat (Page 1186) enced with "ValueColumnIndex" are displayed in ex‐
ponential notation.
ValueColumnForeColor RW - - Specifies the font color of the value column refer‐
(Page 1187) enced with "ValueColumnIndex".
ValueColumnHideText RW - - Specifies whether the text in the value column refer‐
(Page 1188) enced with "ValueColumnIndex" is hidden.
ValueColumnHideTitle‐ RW - - Specifies whether the text in the header of the value
Text (Page 1188) column referenced with "ValueColumnIndex" is hid‐
den.
ValueColumnIndex RW - - References a value column.
(Page 1189)
ValueColumnLength RW - - Specifies the width in characters of the value column
(Page 1189) referenced with "ValueColumnIndex".
ValueColumnName RW - - Specifies the name of a value column referenced with
(Page 1190) "ValueColumnIndex".
ValueColumnPrecisions RW - - Specifies the number of decimal places for values in
(Page 1190) the value column referenced with "ValueColumnIn‐
dex".
ValueColumnProvider RW - - Specifies the data source for the value column refer‐
(Page 1191) enced with "ValueColumnIndex".
ValueColumnProvi‐ RW - - Specifies the provider CLSID of the data for a value
derCLSID (Page 1192) column referenced with "ValueColumnIndex".
ValueColumnRemove RW - - Removes a value column referenced with its name.
(Page 1192)
ValueColumnRename RW - - Specifies the new name of a value column referenced
(Page 1193) with "ValueColumnIndex".
ValueColumnRepos RW - - Specifies the position of a value column referenced
(Page 1193) with "ValueColumnIndex".
ValueColumns - - - -
ValueColumnSelectTag‐ RW - - Specifies that the dialog for selecting the tag name of
Name (Page 1194) the data source for the value column referenced with
"ValueColumnIndex" is displayed in Runtime initial.
ValueColumnShowIcon RW - - Specifies whether an icon is displayed in the value
(Page 1195) column referenced with "ValueColumnIndex".

WinCC Engineering V18 – Programming reference

356 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
ValueColumnShowTi‐ RW - - Specifies whether an icon is displayed in the header of
tleIcon (Page 1195) the value column referenced with "ValueColumnIn‐
dex".
ValueColumnSort RW - - Specifies the type of sorting for the value column ref‐
(Page 1196) erenced with "ValueColumnIndex" ".
ValueColumnSortIndex RW - - Specifies the sorting order.
(Page 1196)
ValueColumnTagName RW - - Specifies the names of the tags whose values are dis‐
(Page 1197) played in the value column referenced with "Value‐
ColumnIndex".
ValueColumnTimeCol‐ RW - - Specifies the corresponding time column.
umn (Page 1197)
ValueColumnVisible RW - - Specifies whether the value column referenced with
(Page 1198) "ValueColumnIndex" is displayed in the object.
VerticalGridLines RW - - Specifies whether vertical separation lines are dis‐
(Page 1201) played.
Visible (Page 1204) RW - - Specifies whether the selected object is visible.
Width (Page 1217) RW - - Specifies the width of the object in pixels.

Table 1-59 Methods

Methods RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Activate (Page 1250) Yes - - Enables the permanent area or the root screen.
ActivateDynamic Yes - - Dynamically activates a trigger and the specified cycle
(Page 1252) for a property at runtime.
AttachDB (Page 1256) Yes - - Executes the "Connect backup" key function of the
control.
CalculateStatistic Yes - - Executes the "Calculate statistics" key function of the
(Page 1257) f(t) trend view and the table view.
CopyRows (Page 1257) Yes - - Executes the "Copy lines" key function of the control.
DeactivateDynamic Yes - - Deactivates the trigger of the "ActivateDynamic"
(Page 1259) method used for the specified property in/during run‐
time.
DetachDB (Page 1262) Yes - - Executes the "Disconnect backup" key function of the
control.
Edit (Page 1262) Yes - - Executes the "Edit" key function of the table view.
Export (Page 1263) Yes - - Executes the "Export log" or "Export data" key func‐
tion of the control.
GetOperatorMessage Yes - - Returns the operator message object of the alarm
(Page 1272) view designated by name or index as "ICCAxOpera‐
torMessage" type.
GetOperatorMessage‐ Yes - - -
Collection
GetRow (Page 1274) Yes - - Returns the row object designated by its row number
in the table-based controls as "ICCAxDataRow" type.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 357
VB scripting
1.5 VBS object model

Methods RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
GetRowCollection Yes - - Returns the list of all row objects of the table-based
(Page 1276) controls as "ICCAxDataRowCollection" type.
GetSelectedRow Yes - - Returns the selected row object of a table-based con‐
(Page 1282) trol as "ICCAxDataRow" type.
GetSelectedRows Yes - - Returns the selected row objects of a table-based
(Page 1283) control as type "ICCAxDataRow" for multiple selec‐
tion.
GetStatusbarElement Yes - - Returns the element of the control status bar desig‐
(Page 1289) nated by name or index as "ICCAxStatusbarElement"
type.
GetStatusbarElement‐ Yes - - Returns the list of all status bar elements of the con‐
Collection (Page 1290) trol as "ICCAxCollection" type.
GetTimeColumn Yes - - Returns the time column object of the table view des‐
(Page 1295) ignated by name or index as "ICCAxTimeColumn"
type.
GetTimeColumnCollec‐ Yes - - Returns the list of all time column objects of the table
tion (Page 1296) view as "ICCAxCollection" type.
GetToolbarButton Yes - - Returns the control toolbar button function designa‐
(Page 1297) ted by name or index as "ICCAxToolbarButton" type.
GetToolbarButtonCollec‐ Yes - - Returns the list of all button functions of the control
tion (Page 1298) toolbar as "ICCAxCollection" type.
GetValueColumn Yes - - Returns the value column object of the f(t) trend view
(Page 1307) designated by name or index as "ICCAxValueColumn"
type.
GetValueColumnCollec‐ Yes - - Returns the list of all value column objects of the f(t)
tion (Page 1308) trend view as "ICCAxCollection" type.
MoveToFirst (Page 1318) Yes - - Executes the "First line" button function of the con‐
trol.
MoveToLast (Page 1320) Yes - - Executes the "Last data record" button function of the
control.
MoveToNext (Page 1321) Yes - - Executes the "Next data record" button function of
the control.
MoveToPrevious Yes - - Executes the "Previous data record" button function
(Page 1323) of the control.
NextColumn (Page 1324) Yes - - Executes the "Next column" button function of the
table view.
PreviousColumn Yes - - Executes the "Previous column" button function of
(Page 1326) the table view.
Print (Page 1327) Yes - - Executes the "Print" button function of the control.
SelectAll (Page 1342) Yes - - Selects all rows in a table-based control.
SelectRow (Page 1343) Yes - - Selects a specific row in a table-based control.
SelectStatisticArea Yes - - Executes the "Set statistics range" button function of
(Page 1342) the table view.
ShowColumnSelection Yes - - Executes the "Select columns" button function of the
(Page 1346) table view.
ShowHelp (Page 1348) Yes - - Executes the "Help" button function of the control.
ShowInsertValueDialog Yes - - -

WinCC Engineering V18 – Programming reference

358 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Methods RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
ShowPropertyDialog Yes - - Executes the "Configuration dialog" button function
(Page 1352) of the control.
ShowTagSelection Yes - - Executes the "Select data connection" button func‐
(Page 1356) tion of the control.
ShowTimeSelection Yes - - Executes the "Select time range" button function of
(Page 1357) the control.
StartStopUpdate Yes - - Executes the "Start" or "Stop" button function of the
(Page 1358) control.
UnselectAll (Page 1361) Yes - - Removes all selections from the cells of a table-based
control.
UnselectRow (Page 1361) Yes - - Removes the selections from a specific cell of a table-
based control.

OnlineTrendControl

Description

6FUHHQV

6FUHHQ

6FUHHQ,WHPV

6FUHHQ,WHP

Represents the "f(t) TrendView" object. The OnlineTrendControl object is an element of the
ScreenItems list.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 359
VB scripting
1.5 VBS object model

Type identifier in VBS

HMIOnlineTrendControl

Abbreviation Access in Runtime

R Read
RW Read and write
- No access

Table 1-60 Properties

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
AllTagTypesAllowed - - - -
ApplyProjectSettingsFor‐ - - - -
DesignMode
BackColor (Page 526) RW - - Specifies the background color.
BorderColor (Page 562) RW - - Specifies the line color.
BorderWidth (Page 577) RW - - Specifies the line thickness.
Bounds - - - -
CanBeGrouped - - - -
Caption (Page 587) RW - - Specifies the text to be displayed in the header.
Closeable (Page 599) RW - - Specifies whether the object can be closed in runtime.
ConnectTrendWindows RW - - Specifies whether the configured trend views are con‐
(Page 632) nected.
ControlDesignMode RW - - Specifies the control design.
(Page 634)
Enabled - - - -
ExportDelimiter - - - -
ExportDirectoryChange‐ RW - - Specifies whether the directory for data export can be
able (Page 674) changed in runtime
ExportDirectoryname RW - - Specifies the target directory for the exported run‐
(Page 675) time data.
ExportFileExtension RW - - Specifies the file extension of the export file.
(Page 675)
ExportFilename RW - - Specifies the name of the target file for the exported
(Page 676) runtime data.
ExportFilenameChange‐ RW - - Specifies whether the export file name can be
able (Page 677) changed in runtime.
ExportFormat - - - -
ExportFormatGuid RW - - Specifies the assignment of ID number and export
(Page 678) provider.
ExportFormatName RW - - Specifies the export file format.
(Page 679)
ExportParameters RW - - Specifies the parameters of the selected format by
(Page 680) means of the properties dialog.

WinCC Engineering V18 – Programming reference

360 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
ExportSelection RW - - Specifies which runtime data of the control is expor‐
(Page 681) ted.
ExportShowDialog RW - - Specifies whether the data export dialog is shown in
(Page 681) runtime.
Font (Page 705) RW - - Specifies the font.
GraphDirection RW - - Specifies at which border of the trend view the cur‐
(Page 717) rent values are displayed.
Height (Page 720) RW - - Specifies the height.
Layer - - - -
Left (Page 770) RW - - Specifies the value of the X coordinate.
LineColor (Page 786) RW - - Specifies the color of the window separation lines.
LineWidth (Page 790) RW - - Specifies the line thickness.
LoadDataImmediately RW - - Specifies whether the tag values are downloaded
(Page 792) from the logs for the time range to be displayed when
you call a screen.
Location - - - -
MaximumNumberOfTi‐ - - - -
meAxes
MaximumNumberOfVa‐ - - - -
lueAxes
MinimumNumberOfTi‐ - - - -
meAxes
MinimumNumberOfVa‐ - - - -
lueAxes
Moveable (Page 825) RW - - Specifies whether the object can be moved in run‐
time.
Name - - - -
Object - - - -
OcxGuid - - - -
OcxState - - - -
OcxStateForEs2Rt - - - -
Online (Page 839) RW - - Specifies start and stop of the updating.
PercentageAxis RW - - Specifies that an additional axis with percentage scal‐
(Page 862) ing is shown in the trend view.
PercentageAxisAlign‐ RW - - Specifies the alignment of the percentage axis.
ment (Page 862)
PercentageAxisColor RW - - Specifies the font and line color of the percentage
(Page 863) axis.
PrintJob (Page 873) RW - - Specifies a print job that is created in the "Reports"
editor.
RTPersistence RW - - Specifies whether online configurations are retained
(Page 888) after a screen change.
RTPersistenceAuthoriza‐ RW - - Specifies the authorization required for online config‐
tion (Page 889) uration in runtime.
RTPersistenceType RW - - Specifies how online configurations of WinCC are re‐
(Page 890) tained.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 361
VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
ShowRuler (Page 938) 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 time
(Page 939) axes.
ShowScrollbars RW - - Specifies whether scroll bars are displayed.
(Page 940)
ShowStatisticRuler RW - - Specifies whether the lines defining the statistics
(Page 943) range are displayed.
ShowTitle (Page 947) 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 949) ue axes.
Size - - - -
Sizeable (Page 952) RW - - Specifies that the size of an object can be changed in
runtime.
StatusbarBackColor RW - - Specifies the background color for status bars.
(Page 959)
StatusbarElementAdd RW - - Creates a new, user-defined status bar element.
(Page 960)
StatusbarElementAuto‐ RW - - Specifies whether the width of the selected status bar
Size (Page 961) element is set automatically.
StatusbarElementCount RW - - Specifies the number of configured status bar ele‐
(Page 962) ments.
StatusbarElementIconId RW - - Specifies the ID number and symbol assignment of a
(Page 963) status bar element.
StatusbarElementID RW - - References a status bar element with its element ID.
(Page 963)
StatusbarElementIndex RW - - References a status bar element.
(Page 964)
StatusbarElementName RW - - Specifies the name of a status bar element referenced
(Page 965) with "StatusbarElementIndex".
StatusbarElementRe‐ RW - - Removes the user-defined status bar element refer‐
move (Page 966) enced with its name.
StatusbarElementRe‐ RW - - Specifies the new name of a user-defined status bar
name (Page 967) element referenced with "StatusbarElementIndex".
StatusbarElementRepos RW - - Specifies the position of an element referenced with
(Page 968) "StatusbarElementIndex" in the status bar of the ob‐
ject.
StatusbarElements - - - -
StatusbarElementText RW - - Specifies the text of the selected status bar element.
(Page 969)
StatusbarElementTool‐ RW - - Specifies the tooltip text for the selected user-defined
tipText (Page 970) status bar element.
StatusbarElementUser‐ RW - - Specifies whether the configuration engineer has
Defined (Page 970) added the status bar element as a new user-defined
element.

WinCC Engineering V18 – Programming reference

362 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
StatusbarElementVisi‐ RW - - Specifies whether the status bar element referenced
ble (Page 971) with "StatusbarElementIndex" is displayed in the ob‐
ject.
StatusbarElementWidth RW - - Specifies the width of the referenced status bar ele‐
(Page 972) ment in pixels.
StatusbarFont RW - - Specifies the font of the texts in the status bar.
(Page 973)
StatusbarFontColor RW - - Specifies the color of the texts in the status bar.
(Page 974)
StatusbarShowTooltips RW - - Specifies whether tooltips are displayed for the ele‐
(Page 975) ments of the status bar in runtime.
StatusbarText RW - - Specifies the default text in the status bar.
(Page 976)
StatusbarUseBackColor RW - - Specifies whether the background color of the status
(Page 976) bar is shown.
StatusbarVisible RW - - Specifies whether the status bar of the control is dis‐
(Page 977) played.
TabIndex - - - -
TabIndexAlpha - - - -
TimeAxes - - - -
TimeAxisAdd (Page 1009) RW - - Creates a new time axis. The newly created time axis
is automatically referenced with "TimeAxisIndex".
TimeAxisAlignment RW - - Specifies the alignment of the time axis.
(Page 1010)
TimeAxisBeginTime RW - - Specifies the start time for the display of the selected
(Page 1011) trend.
TimeAxisColor RW - - Specifies the color of the time axis.
(Page 1011)
TimeAxisCount RW - - Specifies the number of configured time axes.
(Page 1012)
TimeAxisDateFormat RW - - Defines the date format for displaying the selected
(Page 1013) time axis.
TimeAxisEndTime RW - - Specifies the end time for the display of the selected
(Page 1013) trend.
TimeAxisIndex RW - - References a time axis.
(Page 1014)
TimeAxisInTrendColor RW - - Specifies whether the color of the axis referenced
(Page 1014) with "TimeAxisIndex" corresponds to the trend color.
TimeAxisLabel RW - - Specifies the label text for a time axis referenced with
(Page 1015) "TimeAxisIndex".
TimeAxisMeasurePoints RW - - Specifies the number of measurement points to be
(Page 1016) displayed for the selected time axis.
TimeAxisName RW - - Specifies the name of a time axis referenced with
(Page 1016) "TimeAxisIndex".
TimeAxisOnline RW - - Specifies that the time axis is updated continuously.
(Page 1017)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 363
VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
TimeAxisRangeType RW - - Defines the time range setting for the selected time
(Page 1017) axis.
TimeAxisRemove RW - - Removes a time axis referenced with its name.
(Page 1018)
TimeAxisRename RW - - Specifies the new name of a time axis referenced with
(Page 1019) "TimeAxisIndex".
TimeAxisRepos RW - - Specifies the position of a time axis referenced with
(Page 1019) "TimeAxisIndex" in the trend diagram of the object.
TimeAxisShowDate RW - - Specifies whether the selected time axis is shown
(Page 1020) with date and time.
TimeAxisTimeFormat RW - - Specifies the format of the information along the
(Page 1021) time axis for the selected trend.
TimeAxisTimeRange‐ RW - - Specifies the time unit that defines the time range
Base (Page 1021) together with the time factor "TimeAxisTimeRange‐
Factor".
TimeAxisTimeRangeFac‐ RW - - Specifies the time factor that defines the time period
tor (Page 1022) together with the time unit "TimeAxisTimeRange‐
Base".
TimeAxisTrendWindow RW - - Specifies the trend diagram in which the axis refer‐
(Page 1022) enced with "TimeAxisIndex" is displayed.
TimeAxisVisible RW - - Specifies whether the time axis referenced with
(Page 1023) "TimeAxisIndex" is displayed in the object.
TimeBase (Page 1024) RW - - Specifies the time zone in which the time values are
displayed.
ToolbarAlignment RW - - Specifies the position of the toolbar.
(Page 1059)
ToolbarBackColor RW - - Specifies the background color of the toolbar.
(Page 1060)
ToolbarButtonActive RW - - Specifies whether the function linked to the button is
(Page 1061) activated in runtime.
ToolbarButtonAdd RW - - Creates a new user-defined button in the object's
(Page 1062) toolbar.
ToolbarButtonAuthoriza‐ RW - - Specifies the authorization for the selected key func‐
tion (Page 1063) tion.
ToolbarButtonBe‐ RW - - Inserts a leading separator (vertical line) for the se‐
ginGroup (Page 1064) lected key function on the toolbar.
ToolbarButtonClick RW - - Clicks a toolbar button.
(Page 1065)
ToolbarButtonCount RW - - Specifies the number of configured buttons in the
(Page 1065) toolbar.
ToolbarButtonEnabled RW - - Specifies whether a user-defined toolbar button can
(Page 1066) be operated.
ToolbarButtonHotKey RW - - Specifies the shortcut for the selected button of the
(Page 1067) object.
ToolbarButtonID RW - - References a button with its ID.
(Page 1068)
ToolbarButtonIndex RW - - References a button.
(Page 1069)

WinCC Engineering V18 – Programming reference

364 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
ToolbarButtonLocked RW - - Specifies whether the locked, pressed state of a user-
(Page 1070) defined button referenced with "ToolbarButtonIndex"
is displayed.
ToolbarButtonName RW - - Specifies the name of a user-defined button refer‐
(Page 1071) enced with "ToolbarButtonIndex".
ToolbarButtonRemove RW - - Removes a user-defined button referenced with its
(Page 1071) name.
ToolbarButtonRename RW - - Specifies the new name of a user-defined button ref‐
(Page 1072) erenced with "ToolbarButtonIndex".
ToolbarButtonRepos RW - - Specifies the position of a button referenced with
(Page 1073) "ToolbarButtonIndex" in the toolbar of the object.
ToolbarButtons - - - -
ToolbarButtonTooltip‐ RW - - Specifies the tooltip text for the user-defined button
Text (Page 1074) in the toolbar.
ToolbarButtonUserDe‐ RW - - Specifies whether the project engineer has added the
fined (Page 1075) toolbar button as new user-defined button.
ToolbarButtonVisible RW - - Specifies whether the button referenced with "Tool‐
(Page 1076) barButtonIndex" is displayed in the toolbar.
ToolbarShowTooltips RW - - Specifies whether the tooltips for the key functions
(Page 1078) are displayed in runtime.
ToolbarUseBackColor RW - - Specifies whether the background color for the tool‐
(Page 1079) bar is shown.
ToolbarUseHotKeys RW - - Specifies whether the hotkeys are activated for but‐
(Page 1080) tons in the toolbar.
ToolbarVisible RW - - Specifies whether the toolbar of the control is dis‐
(Page 1081) played.
Top (Page 1083) RW - - Specifies the value of the Y coordinate.
TrendAdd (Page 1092) RW - - Creates a new trend.
TrendAutoRangeBegin‐ RW - - Specifies a tag that defines the start value of the trend
TagName (Page 1092) data area.
TrendAutoRangeBegin‐ RW - - Specifies the start value of the trend data area.
Value (Page 1093)
TrendAutoRangeEnd‐ RW - - Specifies a tag that defines the end value of the trend
TagName (Page 1093) data area.
TrendAutoRangeEndVal‐ RW - - Specifies the end value of the trend data area.
ue (Page 1094)
TrendAutoRangeSource RW - - Specifies how the automatic data range of the trend
(Page 1095) data is determined.
TrendColor (Page 1096) RW - - Specifies the color of a referenced trend in the trend
view.
TrendCount (Page 1097) RW - - Specifies the number of configured trends.
TrendExtendedColorSet RW - - Specifies whether the point and fill colors of the trend
(Page 1098) are shown.
TrendFill (Page 1098) RW - - Specifies whether the area below the trend is shown
filled.
TrendFillColor RW - - Defines the fill color of the trend.
(Page 1099)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 365
VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
TrendIndex (Page 1100) RW - - References a configured trend.
TrendLabel (Page 1101) RW - - Defines the label text for a trend referenced with
"TrendIndex".
TrendLineStyle RW - - Specifies which line type is used for display of the
(Page 1102) trend.
TrendLineType RW - - Specifies how the trend is displayed.
(Page 1103)
TrendLineWidth RW - - Specifies the line thickness of the selected trend in
(Page 1103) pixels.
TrendLowerLimit RW - - Specifies the low limit of a tag that is displayed in the
(Page 1104) object as a trend.
TrendLowerLimitColor RW - - Specifies the color that marks trend values which are
(Page 1105) below the value of "TrendLowerLimit".
TrendLowerLimitColor‐ RW - - Specifies whether "TrendLowerLimitColor" is used to
ing (Page 1105) identify tag values which are less than the value of
"TrendLowerLimit".
TrendName (Page 1106) RW - - Specifies the name of a trend referenced with "Tren‐
dIndex".
TrendPointColor RW - - Specifies the color of the dots on the reference trend.
(Page 1107)
TrendPointStyle RW - - Specifies how the trend points are displayed.
(Page 1108)
TrendPointWidth RW - - Specifies the point width in pixels.
(Page 1109)
TrendProvider RW - - Specifies the data source for a selected trend.
(Page 1109)
TrendProviderCLSID RW - - Specifies the provider CLSID of the data for a trend.
(Page 1110)
TrendRemove RW - - Removes a trend referenced with its name.
(Page 1111)
TrendRename RW - - Specifies the new name of a trend referenced with
(Page 1112) "TrendIndex".
TrendRepos (Page 1113) RW - - Specifies the position of a trend referenced with
"TrendIndex" in the trend window of the object.
Trends - - - -
TrendSelectTagName RW - - Specifies that the dialog for selecting the tag name
(Page 1113) 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 1115) axis with data.
TrendTimeAxis RW - - Specifies the time axis to be used for the selected
(Page 1117) trend.
TrendTrendWindow RW - - Specifies the trend window in which the selected
(Page 1119) trend is shown.
TrendUncertainColor RW - - Specifies the color for values of uncertain status.
(Page 1119)

WinCC Engineering V18 – Programming reference

366 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
TrendUncertainColoring RW - - Specifies that values of uncertain status are to be
(Page 1120) highlighted.
TrendUpperLimit RW - - Specifies the high limit of a tag that is displayed in the
(Page 1121) specified object as a trend.
TrendUpperLimitColor RW - - Specifies the color that marks trend values which are
(Page 1121) above the value of "TrendUpperLimit".
TrendUpperLimitColor‐ RW - - Specifies whether the selection frame is shown with
ing (Page 1122) the color defined by the system.
TrendValueAlign - - - -
TrendValueAxis RW - - Specifies the value axis that is used for the trend se‐
(Page 1123) lected.
TrendValueUnit RW - - For the trend type "Display values", specifies a unit for
(Page 1123) the values that is then attached to the values to be
displayed, e.g. "%" or "°C".
TrendVisible (Page 1124) RW - - Specifies whether the trend referenced with ""Tren‐
dIndex" is displayed in the object.
TrendWindowAdd RW - - Creates a new trend view.
(Page 1125)
TrendWindowCoarse‐ RW - - Specifies if the grid lines for the main scale are dis‐
Grid (Page 1125) played.
TrendWindowCoarse‐ RW - - Specifies the color of the main grid for the referenced
GridColor (Page 1126) diagram in the object.
TrendWindowCount RW - - Specifies the number of configured trend diagrams in
(Page 1127) the trend view.
TrendWindowFineGrid RW - - Specifies whether grid lines are displayed for the sec‐
(Page 1127) ondary scaling.
TrendWindowFineGrid‐ RW - - Specifies the color of the secondary grid for the ref‐
Color (Page 1128) 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 1129) dow.
TrendWindowGridIn‐ RW - - Specifies whether the grid lines for the main scaling
TrendColor (Page 1129) are displayed in the trend color.
TrendWindowHorizon‐ RW - - Specifies whether the horizontal grid lines are shown.
talGrid (Page 1130)
TrendWindowIndex RW - - References a trend view. To access the properties of a
(Page 1131) trend view, you need to set "TrendWindowIndex".
TrendWindowName RW - - Specifies the name of a trend view referenced with
(Page 1131) "TrendWindowIndex".
TrendWindowRemove RW - - Removes a trend view referenced with its name.
(Page 1132)
TrendWindowRename RW - - Specifies the new name of a trend view referenced
(Page 1132) with "TrendWindowIndex".
TrendWindowRepos RW - - Specifies the position of a trend view referenced with
(Page 1133) "TrendWindowIndex".
TrendWindowRulerCol‐ RW - - Specifies the color of the ruler.
or (Page 1134)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 367
VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
TrendWindowRulerLay‐ RW - - Specifies the display layer of the ruler in the trend
er (Page 1135) view.
TrendWindowRulerStyle RW - - Specifies the appearance of the ruler.
(Page 1135)
TrendWindowRuler‐ RW - - Specifies the thickness of the ruler in pixels.
Width (Page 1136)
TrendWindows - - - -
TrendWindowSpacePor‐ RW - - Specifies the range proportion of the referenced dia‐
tion (Page 1137) gram in the diagram area of the object.
TrendWindowStatisti‐ RW - - Specifies the color of the statistics ruler.
cRulerColor (Page 1138)
TrendWindowStatisti‐ RW - - Defines the graphical configurability of the lines for
cRulerStyle (Page 1138) specifying the statistics area in the trend window.
TrendWindowStatisti‐ RW - - Specifies the line thickness of the statistics ruler.
cRulerWidth (Page 1139)
TrendWindowVertical‐ RW - - Specifies whether the vertical grid lines are displayed.
Grid (Page 1140)
TrendWindowVisible RW - - Specifies whether the trend view referenced with
(Page 1140) "TrendWindowIndex" is displayed.
UseTrendNameAsLabel RW - - Specifies whether the "Name" or "Label" property is
(Page 1162) used as a designation for the trend in runtime.
ValueAxes - - - -
ValueAxisAdd RW - - Creates a new value axis.
(Page 1171)
ValueAxisAlignment RW - - Specifies the alignment of the value axis.
(Page 1171)
ValueAxisAutoPreci‐ RW - - Specifies whether the number of decimal places for a
sions (Page 1172) value axis referenced with "ValueAxisIndex" is set au‐
tomatically.
ValueAxisAutoRange RW - - Specifies whether the value range of a value axis ref‐
(Page 1173) erenced with "ValueAxisIndex" is calculated automat‐
ically.
ValueAxisBeginValue RW - - Specifies the lower end of the value range of a value
(Page 1173) axis referenced with "ValueAxisIndex".
ValueAxisColor RW - - Specifies the color of a value axis.
(Page 1174)
ValueAxisCount RW - - Specifies the number of configured value axes.
(Page 1175)
ValueAxisEndValue RW - - Specifies the upper end of the value range of a value
(Page 1175) axis referenced with "ValueAxisIndex".
ValueAxisExponential‐ RW - - Specifies whether the values of a value axis refer‐
Format (Page 1176) enced with "ValueAxisIndex" are displayed in expo‐
nential notation.
ValueAxisIndex RW - - References a value axis.
(Page 1176)
ValueAxisInTrendColor RW - - Specifies whether the color of the axis referenced
(Page 1177) with "ValueAxisIndex" corresponds to the trend color.

WinCC Engineering V18 – Programming reference

368 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
ValueAxisLabel RW - - Defines the label text for a value axis referenced with
(Page 1178) "ValueAxisIndex".
ValueAxisName RW - - Specifies the name of a value axis referenced with
(Page 1178) "ValueAxisIndex".
ValueAxisPrecisions RW - - Specifies the number of displayed decimal places.
(Page 1179)
ValueAxisRemove RW - - Removes a value axis referenced with its name.
(Page 1179)
ValueAxisRename RW - - Specifies the new name of a value axis referenced
(Page 1180) with "ValueAxisIndex".
ValueAxisRepos RW - - Specifies the position of a value axis referenced with
(Page 1180) "ValueAxisIndex".
ValueAxisScalingType RW - - Specifies the type of scaling for the value axis refer‐
(Page 1181) enced with "ValueAxisIndex".
ValueAxisTrendWindow RW - - Specifies the trend diagram in which the axis refer‐
(Page 1182) enced with "ValueAxisIndex" is displayed.
ValueAxisVisible RW - - Specifies whether the value axis referenced with "Val‐
(Page 1182) ueAxisIndex" is displayed in the object.
Visible (Page 1204) RW - - Specifies whether the selected object is visible.
Width (Page 1217) RW - - Specifies the width of the object in pixels.

Table 1-61 Methods

Methods RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Activate (Page 1250) Yes - - Enables the permanent area or the root screen.
ActivateDynamic Yes - - Dynamically activates a trigger and the specified cycle
(Page 1252) for a property at runtime.
AttachDB (Page 1256) Yes - - Executes the "Connect backup" key function of the
control.
CalculateStatistic Yes - - Executes the "Calculate statistics" key function of the
(Page 1257) f(t) trend view and the table view.
DeactivateDynamic Yes - - Deactivates the trigger of the "ActivateDynamic"
(Page 1259) method used for the specified property in/during run‐
time.
DetachDB (Page 1262) Yes - - Executes the "Disconnect backup" key function of the
control.
Export (Page 1263) Yes - - Executes the "Export log" or "Export data" key func‐
tion of the control.
GetRulerData Yes - - Returns the value of the called trend at the ruler po‐
(Page 1281) sition.
GetStatusbarElement Yes - - Returns the element of the control status bar desig‐
(Page 1289) nated by name or index as "ICCAxStatusbarElement"
type.
GetStatusbarElement‐ Yes - - Returns the list of all status bar elements of the con‐
Collection (Page 1296) trol as "ICCAxCollection" type.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 369
VB scripting
1.5 VBS object model

Methods RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
GetTimeAxis (Page 1292) Yes - - Returns the f(t) trend view time axis object that is
specified by name or index as "ICCAxTimeAxis" type.
GetTimeAxisCollection Yes - - Returns a list of all f(t) trend view time axis objects as
(Page 1293) "ICCAxCollection" type.
GetToolbarButton Yes - - Returns the control toolbar button function designa‐
(Page 1297) ted by name or index as "ICCAxToolbarButton" type.
GetToolbarButtonCollec‐ Yes - - Returns the list of all button functions of the control
tion (Page 1298) toolbar as "ICCAxCollection" type.
GetTrend (Page 1300) Yes - - Returns the f(t) or f(x) trend view trend designated by
name or index as "ICCAxTrend" or "ICCAxFunction‐
Trend" type.
GetTrendCollection Yes - - Returns the list of all trends of the f(t) or f(x) trend
(Page 1301) view as "ICCAxCollection" type.
GetTrendWindow Yes - - Returns the trend window object of the f(t) or f(x)
(Page 1302) trend view designated by name or index as "ICCAx‐
TrendWindow" type.
GetTrendWindowCollec‐ Yes - - Returns the list of all trend window objects of the f(t)
tion (Page 1303) or f(x) trend views as "ICCAxCollection" type.
GetValueAxis Yes - - Returns the f(t) trend view value axis object that is
(Page 1304) specified by name or index as "ICCAxValueAxis" type.
GetValueAxisCollection Yes - - Returns a list of all f(t) trend view value axis objects as
(Page 1305) "ICCAxCollection" type.
MoveAxis (Page 1318) Yes - - Executes the "Move axes area" button function of the
f(t) and f(x) trend views.
MoveRuler Yes - -
MoveToFirst (Page 1318) Yes - - Executes the "First line" button function of the con‐
trol.
MoveToLast (Page 1320) Yes - - Executes the "Last data record" button function of the
control.
MoveToNext (Page 1321) Yes - - Executes the "Next data record" button function of
the control.
MoveToPrevious Yes - - Executes the "Previous data record" button function
(Page 1323) of the control.
NextTrend (Page 1325) 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 1325) f(t) and f(x) trend views.
PreviousTrend Yes - - Executes the "Previous trend" button function of the
(Page 1327) f(t) and f(x) trend views.
Print (Page 1327) Yes - - Executes the "Print" button function of the control.
ShowHelp (Page 1348) Yes - - Executes the "Help" button function of the control.
ShowPercentageAxis Yes - - Executes the "Relative axis" button function of the f(t)
(Page 1352) trend view.
ShowPropertyDialog Yes - - Executes the "Configuration dialog" button function
(Page 1352) of the control.
ShowTagSelection Yes - - Executes the "Select data connection" button func‐
(Page 1356) tion of the control.

WinCC Engineering V18 – Programming reference

370 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Methods RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
ShowTimeSelection Yes - - Executes the "Select time range" button function of
(Page 1357) the control.
ZoomArea (Page 1365) Yes - - Executes the "Zoom area" button function of the f(t)
and f(x) trend views.
ZoomInOut (Page 1366) Yes - - Executes the "Zoom +/-" button function of the f(t)
and f(x) trend views.
ZoomInOutTime Yes - - Executes the "Zoom time axis +/-" button function of
(Page 1366) the f(t) trend view.
ZoomInOutValues Yes - - Executes the "Zoom value axis +/-" button function of
(Page 1367) the f(t) trend view.
ZoomMove (Page 1368) Yes - - Executes the "Move trend area" button function of
the f(t) and f(x) trend views.

OptionGroup

Description

6FUHHQV

6FUHHQ

6FUHHQ,WHPV

6FUHHQ,WHP

Represents the "Option button" object. The OptionGroup object is an element of the
ScreenItems list.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 371
VB scripting
1.5 VBS object model

Type identifier in VBS

HMIOptionGroup

Abbreviation Access in Runtime

R Read
RW Read and write
- No access

Table 1-62 Properties

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
AdaptBorder (Page 498) RW - - Specifies whether the border of the object will be dy‐
namically adapted to the text size.
AllTagTypesAllowed - - - -
Authorization RW - - Specifies operating rights.
(Page 517)
BackColor (Page 526) RW - - Specifies the background color.
BackFillStyle (Page 531) RW - - Specifies the fill pattern.
BackFlashingColorOff RW - - Specifies the background color for flash state "Off".
(Page 533)
BackFlashingColorOn RW - - Specifies the background color for flash state "On".
(Page 534)
BackFlashingEnabled RW - - Specifies whether the background flashes in runtime.
(Page 535)
BackFlashingRate RW - - Specifies the flash rate of the background.
(Page 536)
BorderBackColor RW - - Specifies the background color of the broken border
(Page 558) line.
BorderColor (Page 562) RW - - Specifies the line color.
BorderFlashingColorOff RW - - Specifies the color of the border line for the flashing
(Page 566) status "Off".
BorderFlashingColorOn RW - - Specifies the color of the border line for the flashing
(Page 567) status "On".
BorderFlashingEnabled RW - - Specifies whether the limit of the object can flash in
(Page 569) runtime.
BorderFlashingRate RW - - Specifies the flash rate of the border line.
(Page 570)
BorderStyle - - - -
BorderWidth (Page 577) RW - - Specifies the line thickness.
Bounds - - - -
CanBeGrouped - - - -
CheckMarkAlignment RW - - Specifies whether the fields are right-aligned.
(Page 597)
CheckMarkCount RW - - Specifies the number of fields.
(Page 597)

WinCC Engineering V18 – Programming reference

372 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
CornerStyle (Page 635) RW - - Specifies the shape of the corners.
DrawInsideFrame RW - - Specifies whether the border line is to be shown with
(Page 655) a line thickness of greater than 1 within the border or
symmetrically to the border.
EdgeStyle (Page 657) RW - - Specifies the line style.
Enabled (Page 660) RW - - Specifies whether the selected object can be operat‐
ed in runtime.
FillingDirection RW - - Specifies the fill direction.
(Page 687)
FillPatternColor RW - - Specifies the color of the fill pattern.
(Page 685)
Flashing - - - -
FlashingColorOff RW - - Specifies the color of the border line for the flashing
(Page 693) status "Off".
FlashingColorOn RW - - Specifies the color of the border line for the flashing
(Page 695) status "On".
FlashingEnabled RW - - Specifies whether flashing is activated for the object
(Page 697) in runtime.
FlashingRate (Page 699) RW - - Specifies the flash rate of the border line.
Font - - - -
FontBold (Page 708) RW - - Specifies whether the text is shown in bold.
FontItalic (Page 708) RW - - Specifies whether the text is shown in italics.
FontName (Page 709) RW - - Specifies the font.
FontSize (Page 711) RW - - Specifies the font size of the text.
FontUnderline RW - - Specifies whether the text is shown underlined.
(Page 711)
ForeColor (Page 712) RW - - Specifies the font color of the text.
Height (Page 720) RW - - Specifies the height.
HorizontalAlignment RW - - Specifies the horizontal alignment of the text.
(Page 736)
Index (Page 741) RW - - Specifies the index for the selected text field.
Layer (Page 764) RW - - Specifies the layer in the screen that contains an ob‐
ject.
Left (Page 770) RW - - Specifies the value of the X coordinate.
LineEndShapeStyle RW - - Specifies the shape of the line ends.
(Page 787)
Location - - - -
LogOperation RW - - Specifies whether, after operating this object, an
(Page 794) alarm is output to the alarm system.
Name - - - -
ProcessValue (Page 874) RW - - Specifies the default for the value to be displayed.
RelativeFillLevel RW - - Specifies the fill percentage for the object.
(Page 881)
ShowBadTagState RW - - Defines whether the object is grayed out when a bad
(Page 926) quality code or tag status is detected.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 373
VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
ShowFillLevel RW - - Specifies whether the selected object is filled.
(Page 933)
Size - - - -
TabIndex - - - -
TabIndexAlpha - - - -
Text (Page 1000) RW - - Specifies the label for the text field.
TextHandles - - - -
TextOrientation RW - - Specifies the text orientation.
(Page 1004)
Texts - - - -
ToolTipText (Page 1082) RW - - Specifies the tooltip text.
Top (Page 1083) RW - - Specifies the value of the Y coordinate.
Transparency RW - - Specifies the object transparency in percent.
(Page 1087)
UseDesignColorSchema RW - - Specifies whether the colors defined in the global col‐
(Page 1148) or scheme of the current design are to be used for this
object.
UseDesignShadowSet‐ RW - - Specifies whether the object is displayed with global
tings (Page 1150) shading.
VerticalAlignment RW - - Specifies the vertical alignment of the text in the
(Page 1200) specified object.
Visible (Page 1204) RW - - Specifies whether the selected object is visible.
Width (Page 1217) RW - - Specifies the width of the object in pixels.

Table 1-63 Methods

Methods RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Activate (Page 1250) Yes - - Enables the permanent area or the root screen.
ActivateDynamic Yes - - Dynamically activates a trigger and the specified cycle
(Page 1252) for a property at runtime.
DeactivateDynamic Yes - - Deactivates the trigger of the "ActivateDynamic"
(Page 1259) method used for the specified property in/during run‐
time.

WinCC Engineering V18 – Programming reference

374 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

PDFview

Description

6FUHHQV

6FUHHQ

6FUHHQ,WHPV

6FUHHQ,WHP

Represents the "PDF view" object. The PDFview object is an element of the ScreenItems list.

Type identifier in VBS

HMIPDFview

Abbreviation Access in Runtime

R Read
RW Read and write
- No access

Table 1-64 Properties

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
AllTagTypesAllowed - - - -
Authorization - - - -
Bounds - - - -
CanBeGrouped - - - -
Enabled (Page 660) - RW RW Specifies whether the selected object can
be operated in runtime.
FileName - - - -

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 375
VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Height - R R Specifies the height.
Layer - RW RW Specifies the layer in the screen that con‐
tains an object.
Left (Page 770) - RW RW Specifies the value of the X coordinate.
Location - - - -
Name - - - -
Size - - - -
TabIndex - - - -
TabIndexAlpha - - - -
Top (Page 1083) - RW RW Specifies the value of the Y coordinate.
Visible - - - -
Width - R R Specifies the width of the object in pixels.

Table 1-65 Methods

Methods RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Activate (Page 1250) - Yes Yes Enables the permanent area or the root screen.

PLCCodeViewer

Description

6FUHHQV

6FUHHQ

6FUHHQ,WHPV

6FUHHQ,WHP

Displays the "PLC Code Viewer" object. The PLCCodeViewer object is an element of the
ScreenItems list.

WinCC Engineering V18 – Programming reference

376 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Type identifier in VBS

HMIPLCCodeViewer

Abbreviation Access in Runtime

R Read
RW Read and write
- No access

Table 1-66 Properties

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
AllTagTypesAllowed - - - -
Authorization - - - -
Bounds - - - -
CanBeGrouped - - - -
Enabled (Page 660) - RW RW Specifies whether the selected object can be operat‐
ed in runtime.
Height (Page 720) RW R R Specifies the height.
Layer (Page 764) - RW RW Specifies the layer in the screen that contains an ob‐
ject.
Left (Page 770) - RW RW Specifies the value of the X coordinate.
Location - - - -
Name - - - -
NavigateTo (Page 830) RW RW RW Specifies the module to be jumped to.
NumberOfVisibleLines RW - - Specifies the number of visible lines in the PLC Code
(Page 836) Viewer.
PathHeaderFont RW - - Specifies the header font.
(Page 860)
Size - - - -
SymbolTableFont RW - - Specifies the font of the symbol table in the PLC Code
(Page 983) Viewer.
TabIndex - - - -
TabIndexAlpha - - - -
ToolbarButtons - - - -
Top (Page 1083) - RW RW Specifies the value of the Y coordinate.
TransitionHeaderFont RW - - Specifies the font in the information area of this PLC
(Page 1087) Code Viewer.
Visible (Page 1204) - RW RW Specifies whether the selected object is visible.
Width (Page 1217) RW R R Specifies the width of the object in pixels.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 377
VB scripting
1.5 VBS object model

Table 1-67 Methods

Methods RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Activate Yes - - Enables the permanent area or the root screen.
ActivateDynamic Yes - - Dynamically activates a trigger and the specified cycle
for a property at runtime.
DeactivateDynamic Yes - - Deactivates the trigger of the "ActivateDynamic"
method used for the specified property in/during run‐
time.

Polygon

Description

6FUHHQV

6FUHHQ

6FUHHQ,WHPV

6FUHHQ,WHP

Represents the "Polygon" object. The Polygon object is an element of the ScreenItems list.

Type identifier in VBS

HMIPolygon

Abbreviation Access in Runtime

R Read
RW Read and write
- No access

WinCC Engineering V18 – Programming reference

378 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Table 1-68 Properties

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
ActualPointIndex RW - - Specifies the number of the current corner point.
(Page 496)
ActualPointLeft RW - - Specifies the X coordinate of the current corner point
(Page 496) with reference to the screen origin.
ActualPointTop RW - - Specifies the Y coordinate of the current corner point
(Page 497) with reference to the screen origin.
AllTagTypesAllowed - - - -
Authorization RW - - Specifies operating rights.
(Page 517)
BackColor (Page 526) RW RW RW Specifies the background color.
BackFillStyle (Page 531) RW RW RW Specifies the fill pattern.
BorderBackColor RW - - Specifies the background color of the broken border
(Page 558) line.
BorderColor (Page 562) RW RW RW Specifies the line color.
BorderFlashingColorOff RW - - Specifies the color of the border line for the flashing
(Page 566) status "Off".
BorderFlashingColorOn RW - - Specifies the color of the border line for the flashing
(Page 567) status "On".
BorderFlashingEnabled RW - - Specifies whether the limit of the object can flash in
(Page 569) runtime.
BorderFlashingRate RW - - Specifies the flash rate of the border line.
(Page 570)
BorderStyle (Page 576) RW - - Specifies the type of border lines.
BorderWidth (Page 577) RW RW RW Specifies the line thickness.
Bounds - - - -
CanBeGrouped - - - -
CornerStyle (Page 635) RW - - Specifies the shape of the corners.
DeviceStyle - - - -
EdgeStyle (Page 657) RW RW RW Specifies the line style.
Enabled (Page 660) RW RW RW Specifies whether the selected object can be operat‐
ed in runtime.
FillingDirection RW - - Specifies the fill direction.
(Page 687)
FillPatternColor RW - - -
Flashing - - - -
FlashingColorOff RW - - Specifies the color of the border line for the flashing
(Page 693) status "Off".
FlashingColorOn RW - - Specifies the color of the border line for the flashing
(Page 695) status "On".
FlashingEnabled RW - - Specifies whether flashing is activated for the object
(Page 697) in runtime.
FlashingRate (Page 699) RW - - Specifies the flash rate of the border line.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 379
VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Height (Page 720) RW R R Specifies the height.
Layer (Page 764) RW RW RW Specifies the layer in the screen that contains an ob‐
ject.
Left (Page 770) RW RW RW Specifies the value of the X coordinate.
LineEndShapeStyle RW - - Specifies the shape of the line ends.
(Page 787)
LineWidth - - - -
Location - - - -
Name - - - -
Points - - - -
PointsCount (Page 870) RW - - Specifies the number of corner points of the polyline
or of the polygon.
RelativeFillLevel RW - - Specifies the fill percentage for the object.
(Page 881)
RotationAngle RW - - Specifies the angle of rotation in degrees.
(Page 883)
RotationCenterLeft RW - - Specifies the X coordinate of the pivot point for the
(Page 883) object in runtime.
RotationCenterTop RW - - Specifies the Y coordinate of the pivot point for the
(Page 884) object in runtime.
ShowFillLevel RW - - Specifies whether the selected object is filled.
(Page 933)
Size - - - -
StyleItem - - - -
TabIndex - - - -
TabIndexAlpha - - - -
ToolTipText (Page 1082) RW RW RW Specifies the tooltip text.
Top (Page 1083) RW RW RW Specifies the value of the Y coordinate.
Transparency (Page 1087) RW - - Specifies the object transparency in percent.
UseDesignColorSchema RW - - Specifies whether the colors defined in the global col‐
(Page 1148) or scheme of the current design are to be used for this
object.
UseDesignShadowSet‐ RW - - Specifies whether the object is displayed with global
tings (Page 1150) shading.
Visible (Page 1204) RW RW RW Specifies whether the selected object is visible.
Width (Page 1217) RW R R Specifies the width of the object in pixels.

WinCC Engineering V18 – Programming reference

380 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Table 1-69 Methods

Methods RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Activate (Page 1250) Yes Yes Yes Enables the permanent area or the root screen.
ActivateDynamic Yes - - Dynamically activates a trigger and the specified cycle
(Page 1252) for a property at runtime.
DeactivateDynamic Yes - - Deactivates the trigger of the "ActivateDynamic"
(Page 1259) method used for the specified property in/during run‐
time.

Polyline

Description

6FUHHQV

6FUHHQ

6FUHHQ,WHPV

6FUHHQ,WHP

Represents the "Polyline" object. The Polyline object is an element of the ScreenItems list.

Type identifier in VBS

HMIPolyline

Abbreviation Access in runtime

R Read
RW Read and write
- No access

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 381
VB scripting
1.5 VBS object model

Table 1-70 Properties

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
AllTagTypesAllowed - - - -
ActualPointIndex RW - - Specifies the number of the current corner point.
(Page 496)
ActualPointLeft RW - - Specifies the X coordinate of the current corner point
(Page 496) with reference to the screen origin.
ActualPointTop RW - - Specifies the Y coordinate of the current corner point
(Page 497) with reference to the screen origin.
Authorization RW - - Specifies operating rights.
(Page 517)
BackColor (Page 526) RW RW RW Specifies the background color.
BorderEndStyle RW - - Specifies the type of line ends.
(Page 565)
BorderStyle (Page 576) RW - - Specifies the type of border lines.
Bounds - - - -
CanBeGrouped - - - -
Color (Page 600) RW RW RW Specifies the line color.
CornerStyle (Page 635) RW - - Specifies the shape of the corners.
DeviceStyle - - - -
Enabled (Page 660) RW RW RW Specifies whether the selected object can be operat‐
ed in runtime.
EndStyle (Page 667) RW RW RW Specifies how the line end is displayed.
FillStyle (Page 687) - RW RW Specifies whether the background color is displayed
with a broken line.
Flashing - - - -
FlashingColorOff RW - - Specifies the color of the border line for the flashing
(Page 693) status "Off".
FlashingColorOn RW - - Specifies the color of the border line for the flashing
(Page 695) status "On".
FlashingEnabled RW - - Specifies whether flashing is activated for the object
(Page 697) in runtime.
FlashingRate (Page 699) RW - - Specifies the flash rate of the border line.
Height (Page 720) RW R R Specifies the height.
Layer (Page 764) RW RW RW Specifies the layer in the screen that contains an ob‐
ject.
Left (Page 770) RW RW RW Specifies the value of the X coordinate of the object.
LineEndShapeStyle RW - - Specifies the shape of the line end.
(Page 787)
LineWidth (Page 790) RW RW RW Specifies the line thickness.
Location - - - -
Name - - - -
Points - - - -

WinCC Engineering V18 – Programming reference

382 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
PointsCount (Page 870) RW - - Specifies the number of corner points of the polyline
or of the polygon.
RotationAngle RW - - Specifies the angle of rotation in degrees.
(Page 883)
RotationCenterLeft RW - - Specifies the X coordinate of the pivot point for the
(Page 883) object in runtime.
RotationCenterTop RW - - Specifies the Y coordinate of the pivot point for the
(Page 884) object in runtime.
Size - - - -
StartStyle (Page 957) RW RW RW Specifies how the line start is displayed.
Style (Page 981) RW RW RW Specifies the line style.
StyleItem - - - -
TabIndex - - - -
TabIndexAlpha - - - -
ToolTipText (Page 1082) RW RW RW Specifies the tooltip text.
Top (Page 1083) RW RW RW Specifies the value of the Y coordinate of the object.
Transparency RW - - Specifies the object transparency in percent.
(Page 1087)
UseDesignColorSchema RW - - Specifies whether the colors defined in the global col‐
(Page 1148) or scheme of the current design are to be used for this
object.
UseDesignShadowSet‐ RW - - Specifies whether the object is displayed with global
tings (Page 1150) shading.
Visible (Page 1204) RW RW RW Specifies whether the object is visible.
Width (Page 1217) RW R R Specifies the width of the object in pixels.

Table 1-71 Methods

Methods RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Activate (Page 1250) Yes Yes Yes Enables the permanent area or the root screen.
ActivateDynamic Yes - - Dynamically activates a trigger and the specified cy‐
(Page 1252) cle for a property at runtime.
DeactivateDynamic Yes - - Deactivates the trigger of the "ActivateDynamic"
(Page 1259) method used for the specified property in/during run‐
time.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 383
VB scripting
1.5 VBS object model

ProDiag overview

Description

6FUHHQV

6FUHHQ

6FUHHQ,WHPV

6FUHHQ,WHP

Represents the "ProDiagOverview" object. The ProDiagOverview object is an element of the

ScreenItems list.

Type identifier in VBS

HMIProDiagOverview

Abbreviation Access in Runtime

R Read
RW Read and write
- No access

Table 1-72 Properties

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Enabled (Page 660) RW RW RW Specifies whether the selected object can be operat‐
ed in runtime.
Height (Page 720) RW R R Specifies the height.
Layer (Page 764) RW RW RW Specifies the layer in the screen that contains an ob‐
ject.
Left (Page 770) RW RW RW Specifies the value of the X coordinate.
Name - - - -
Top (Page 1083) RW - - Specifies the value of the Y coordinate.

WinCC Engineering V18 – Programming reference

384 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Visible (Page 1204) RW RW RW Specifies whether the selected object is visible.
Width (Page 1217) RW R R Specifies the width of the object in pixels.

Table 1-73 Methods

Methods RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Activate (Page 1250) Yes - - Enables the permanent area or the root screen.
ActivateDynamic Yes - - Dynamically activates a trigger and the specified cycle
(Page 1252) for a property at runtime.
DeactivateDynamic Yes - - Deactivates the trigger of the "ActivateDynamic"
(Page 1259) method used for the specified property in/during run‐
time.

ProtectedAreaNameView

Description

Screen

ScreensItems
ScreenItem
Represents the "EffectiveRangeName" (RFID)" object. The ProtectedAreaNameView object is
an element of the ScreenItems list.

Type identifier in VBS

HMIProtectedAreaNameView

Abbreviation Access in runtime

R Read
RW Read and write
- No access

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 385
VB scripting
1.5 VBS object model

Table 1-74 Properties

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
AllTagTypesAllowed - - - -
Authorization - - - -
Bounds - - - -
CanBeGrouped - - - -
Font - - - -
Height - R R Specifies the height.
Layer (Page 764) - - RW Specifies the layer in the screen that contains an ob‐
ject.
Left (Page 770) - - RW Specifies the value of the X coordinate.
Location - - - -
Name - - - -
Size - - - -
TabIndex - - - -
TabIndexAlpha - - - -
Top (Page 1083) - - RW Specifies the value of the Y coordinate.
Visible (Page 1204) - - RW Specifies whether the selected object is visible.
Width - R R Specifies the width.

Table 1-75 Methods

Methods RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Activate (Page 1250) - - Yes Enables the permanent area or the root screen.

RangeLabelView

Description

Screen

ScreensItems
ScreenItem
Represents the "EffectiveRangeName" object. The RangeLabelView object is an element of
the ScreenItems list.

WinCC Engineering V18 – Programming reference

386 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Type identifier in VBS

HMIRangeLabelView

Abbreviation Access in runtime

R Read
RW Read and write
- No access

Table 1-76 Properties

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
AllTagTypesAllowed - - - -
Authorization - - - -
Bounds - - - -
CanBeGrouped - - - -
Font - - - -
Height - R R Specifies the height.
Layer (Page 764) - - RW Specifies the layer in the screen that contains an ob‐
ject.
Left (Page 770) - - RW Specifies the value of the X coordinate.
Location - - - -
Name - - - -
Size - - - -
TabIndex - - - -
TabIndexAlpha - - - -
Top (Page 1083) - - RW Specifies the value of the Y coordinate.
Visible (Page 1204) - - RW Specifies whether the selected object is visible.
Width - R R Specifies the width.

Table 1-77 Methods

Methods RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Activate (Page 1250) - - Yes Enables the permanent area or the root screen.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 387
VB scripting
1.5 VBS object model

RangeQualityView

Description

Screen

ScreensItems
ScreenItem
Represents the "EffectiveRangeSignal" object. The RangeQualityView object is an element of
the ScreenItems list.

Type identifier in VBS

HMIRangeQualityView

Abbreviation Access in runtime

R Read
RW Read and write
- No access

Table 1-78 Properties

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
AllTagTypesAllowed - - - -
Bounds - - - -
CanBeGrouped - - - -
Height - R R Specifies the height.
Layer (Page 764) - - RW Returns the layer in the screen in which an object is
located.
Left (Page 770) - - RW Specifies the value of the X coordinate.
Location - - - -
Name - - - -
Size - - - -
TabIndex - - - -
TabIndexAlpha - - - -
Top (Page 1083) - - RW Specifies the value of the Y coordinate.
Visible (Page 1204) - - RW Specifies whether the selected object is visible.
Width - R R Specifies the width.

WinCC Engineering V18 – Programming reference

388 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Table 1-79 Methods

Methods RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Activate (Page 1250) - - Yes Enables the permanent area or the root screen.

See also
Height (Page 720)
Width (Page 1217)

RecipeView

Description

6FUHHQV

6FUHHQ

6FUHHQ,WHPV

6FUHHQ,WHP

Displays the "Recipe view" object. The RecipeView 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 RecipeView" cannot be dynamized with a user-defined function.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 389
VB scripting
1.5 VBS object model

Abbreviation Access in Runtime

R Read
RW Read and write
- No access

Table 1-80 Properties

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
AdvancedButtonPosi‐ - - - -
tions
AdvancedView - - - -
AllowEdit - - - -
AllTagTypesAllowed - - - -
Authorization - RW RW Specifies the operating rights of the selected object in
(Page 517) runtime.
BackButtonVisible - - - -
BackColor (Page 526) - RW RW Specifies the background color.
BorderBackColor - - - -
BorderColor - - - -
BorderWidth - - - -
Bounds - - - -
ButtonBackColor - - - -
ButtonBackFillStyle - - - -
ButtonBorderBackColor - - - -
ButtonBorderColor - - - -
ButtonBorderWidth - - - -
ButtonCornerRadius - - - -
ButtonEdgeStyle - - - -
ButtonFirstGradientCol‐ - - - -
or
ButtonFirstGradientOff‐ - - - -
set
ButtonMiddleGradient‐ - - - -
Color
ButtonPositions - - - -
ButtonSecondGradient‐ - - - -
Color
ButtonSecondGradien‐ - - - -
tOffset
CanBeGrouped - - - -
ColumnOrder - - - -
ColumnWidth - - - -

WinCC Engineering V18 – Programming reference

390 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
ComboboxFont - - - -
CornerRadius - - - -
DataRecordNameCap‐ - - - -
tion
DataRecordNrCaption - - - -
DeviceStyle - - - -
Display3D - - - -
DisplayButton2Plc - - - -
DisplayButtonCompari‐ - - - -
son
DisplayButtonDelete - - - -
DisplayButtonFromPlc - - - -
DisplayButtonHelp - - - -
DisplayButtonNew - - - -
DisplayButtonSave - - - -
DisplayButtonSaveAs - - - -
DisplayComboBox - - - -
DisplayGridLines - - - -
DisplayLabeling - - - -
DisplayNumbers - - - -
DisplaySize - - - -
DisplayStatusBar - - - -
DisplayTable - - - -
EdgeStyle - - - -
Enabled (Page 660) - RW RW Specifies whether the selected object can be operat‐
ed in runtime.
EntryNameCaption - - - -
EntryNameColumn‐ - - - -
Width
EntryValueColFirst - - - -
EntryValueColumn‐ - - - -
Width
EntryValueFieldLength - - - -
EntryValuePos - - - -
ES2RT_ButtonPositions - - - -
ES2RT_ColumnOrder - - - -
ES2RT_ColumnWidth - - - -
ES2RT_EntryNameCo‐ - - - -
lumnWidth
ES2RT_EntryValueCo‐ - - - -
lumnWidth
ES2RT_ListAreaHeight - - - -
ES2RT_ListAreaWidth - - - -

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 391
VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
FitToSize - - - -
Flashing - - - -
FocusColor (Page 703) - RW RW Specifies the color of the focus border when the ob‐
ject has the focus.
FocusWidth (Page 704) - RW RW Specifies the border width when the object has the
focus.
Font - - - -
ForeColor (Page 712) - RW RW Specifies the font color of the text.
HeaderFont - - - -
Height - R R Specifies the height.
IsRunningUnderCE - - - -
IsVerticalScrollBarEna‐ - - - -
bled
KeyboardOnline - - - -
Layer (Page 764) - RW RW Specifies the layer in the screen that contains an ob‐
ject.
Left (Page 770) - RW RW Specifies the value of the X coordinate.
ListAreaHeight - - - -
ListAreaLeft - - - -
ListAreaTop - - - -
ListAreaWidth - - - -
Location - - - -
MaxNumberOfCombo‐ - - - -
BoxCharacters
MenuButtonVisible - - - -
Name - - - -
NameColumnWidth - - - -
NumberOfButtons - - - -
NumberOfLines - - - -
PaddingBottom - - - -
PaddingLeft - - - -
PaddingRight - - - -
PaddingTop - - - -
PlcUDTFilter - - - -
ProhibitDataRecordTagI‐ - - - -
nOnlySimpleView
Recipe - - - -
RecipeName (Page 878) - RW RW Specifies the name of the recipe that is displayed in
the "Recipe view".
RecipeNameCaption - - - -
RecipeNrCaption - - - -
RecipeNrColFirst - - - -
RecipeNumber - RW RW Specifies the number of the recipe that is displayed in
(Page 879) the "Recipe view".

WinCC Engineering V18 – Programming reference

392 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
RecordName (Page 880) - RW RW Specifies the name of the recipe data record that is
displayed in the "Recipe view".
RecordNrColFirst - - - -
RecordNumber - R R Returns the number of the recipe data record that is
(Page 880) currently being displayed in the "Recipe view".
RenameButtonVisible - - - -
SelectionBackColor - R R Returns the background color of the selected cells.
(Page 913)
SelectionForeColor - R R Returns the foreground color of the selected cells.
(Page 915)
SimpleView - - - -
Size - - - -
StatuslineFont - - - -
StyleItem - - - -
TabIndex - - - -
TabIndexAlpha - - - -
TableBackColor - R R Returns the background color of the table cells.
(Page 987)
TableEvenRowBackColor - - - -
TableForeColor - R R Returns the font color used in the table cells of the
(Page 990) object.
TableGridLineColor - R R Returns the color of the grid lines in the table.
(Page 992)
TableHeaderBackColor - R R Returns the background color in the header of the
(Page 993) table.
TableHeaderBackFill‐ - - - -
Style
TableHeaderBorderBack‐ - - - -
Color
TableHeaderBorderColor - - - -
TableHeaderBorder‐ - - - -
Width
TableHeaderCornerRa‐ - - - -
dius
TableHeaderEdgeStyle - - - -
TableHeaderFirstGra‐ - - - -
dientColor
TableHeaderFirstGra‐ - - - -
dientOffset
TableHeaderForeColor - R R Returns the text color in the header of the table.
(Page 995)
TableHeaderMiddleGra‐ - - - -
dientColor
TableHeaderPaddingBot‐ - - - -
tom
TableHeaderPaddingLeft - - - -

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 393
VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
TableHeaderPadding‐ - - - -
Right
TableHeaderPaddingTop - - - -
TableHeaderSecondGra‐ - - - -
dientColor
TableHeaderSecondGra‐ - - - -
dientOffset
Tag4DataRecord - - - -
Tag4RecipeNumber - - - -
TextualObjectPositions - - - -
TextualObjectsAutoSize - - - -
TextualObjectsBorder‐ - - - -
BackColor
TextualObjectsBorder‐ - - - -
Color
TextualObjectsBorder‐ - - - -
Width
TextualObjectsCornerRa‐ - - - -
dius
TextualObjectsEdgeStyle - - - -
TextualObjectsPadding‐ - - - -
Bottom
TextualObjectsPaddin‐ - - - -
gLeft
TextualObjectsPadding‐ - - - -
Right
TextualObjectsPadding‐ - - - -
Top
Top (Page 1083) - R R Returns the value of the Y coordinate.
UseButtonFirstGradient - - - -
UseButtonSecondGradi‐ - - - -
ent
UseDesignColorSchema - - - -
UseTableHeaderFirst‐ - - - -
Gradient
UseTableHeaderSecond‐ - - - -
Gradient
ValueCaption - - - -
ValueColumnWidth - - - -
VerticalScrolling - - - -
ViewType - - - -
ViewTypeForSaveStream - - - -
Visible (Page 1204) - RW RW Specifies whether the selected object is visible.
VisibleItems - - - -
Width - R R Specifies the width.

WinCC Engineering V18 – Programming reference

394 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Table 1-81 Methods

Methods RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Activate (Page 1250) - Yes Yes Enables the permanent area or the root screen.

Rectangle

Description

6FUHHQV

6FUHHQ

6FUHHQ,WHPV

6FUHHQ,WHP

Represents the "Rectangle" object. The Rectangle object is an element of the ScreenItems list.

Type identifier in VBS

HMIRectangle

Abbreviation Access in Runtime

R Read
RW Read and write
- No access

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 395
VB scripting
1.5 VBS object model

Table 1-82 Properties

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
AllTagTypesAllowed - - - -
Authorization RW - - Specifies the operating rights of the selected object in
(Page 517) runtime.
BackColor (Page 526) RW RW RW Specifies the background color of the selected object.
BackFillStyle (Page 531) RW RW RW Specifies the fill pattern of the selected object.
BorderBackColor RW - - Specifies the background color of the broken border
(Page 558) line for the selected object.
BorderColor (Page 562) RW RW RW Specifies the line color of the selected object.
BorderFlashingColorOff RW - - Specifies the border line color of the selected object
(Page 566) for the flash state "Off".
BorderFlashingColorOn RW - - Specifies the border line color of the selected object
(Page 567) for the flash state "On".
BorderFlashingEnabled RW - - Specifies whether the border line of the selected ob‐
(Page 569) ject flashes in runtime.
BorderFlashingRate RW - - Specifies the flash rate of the border line for the se‐
(Page 570) lected object.
BorderStyle (Page 576) RW - - Specifies the type of border lines for the selected ob‐
ject.
BorderWidth (Page 577) RW RW RW Specifies the line thickness of the selected object.
Bounds - - - -
CanBeGrouped - - - -
CornerStyle (Page 635) RW - - Specifies the shape of the corners of the specified
object.
DeviceStyle - - - -
DrawInsideFrame RW - - Specifies whether the border line of the selected ob‐
(Page 655) ject with a line thickness greater than 1 should be
drawn within the border or symmetrically to the bor‐
der.
EdgeStyle (Page 657) RW RW RW Specifies the line style of the selected object.
Enabled (Page 660) RW RW RW Specifies whether the selected object can be operat‐
ed in runtime.
FillingDirection RW - - Specifies the fill direction.
(Page 687)
FillPatternColor RW - - Specifies the color of the fill pattern for the selected
(Page 685) object.
Flashing - - - -
FlashingColorOff RW - - Specifies the border line color of the selected object
(Page 693) for the flash state "Off".
FlashingColorOn RW - - Specifies the border line color of the selected object
(Page 695) for the flash state "On".
FlashingEnabled RW - - Specifies whether the border line of the selected ob‐
(Page 697) ject flashes in runtime.

WinCC Engineering V18 – Programming reference

396 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
FlashingRate (Page 699) RW - - Specifies the flash rate of the border line for the se‐
lected object.
Height (Page 720) RW RW RW Specifies the height of the selected object.
Layer (Page 764) RW RW RW Specifies the layer in the screen that contains an ob‐
ject.
Left (Page 770) RW RW RW Specifies the value of the X coordinate of the selected
object.
LineEndShapeStyle RW - - Specifies the shape of the line ends.
(Page 787)
Location - - - -
Name - - - Returns the object name as STRING.
RelativeFillLevel RW - - Specifies the fill percentage for the object.
(Page 881)
RoundCornerHeight RW - - Specifies the corner radius.
(Page 885)
RoundCornerWidth RW - - Specifies the corner radius.
(Page 885)
ShowFillLevel RW - - Specifies whether the selected object is filled.
(Page 933)
Size - - - -
StyleItem - - - -
TabIndex - - - -
TabIndexAlpha - - - -
ToolTipText (Page 1082) RW RW RW Specifies the tooltip text.
Top (Page 1083) RW RW RW Specifies the value of the Y coordinate of the selected
object.
Transparency (Page 1087) RW - - Specifies the object transparency in percent.
UseDesignColorSchema RW - - Specifies whether the colors defined in the global
(Page 1148) color scheme of the current design are to be used for
this object.
UseDesignShadowSet‐ RW - - Specifies whether the object is displayed with the
tings (Page 1150) shading defined in the active design.
Visible (Page 1204) RW RW RW Specifies whether the selected object is visible.
Width (Page 1217) RW RW RW Specifies the width of the object in pixels.

Table 1-83 Methods

Methods RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Activate (Page 1250) Yes Yes Yes Enables the permanent area or the root screen.
ActivateDynamic Yes - - Dynamically activates a trigger and the specified cycle
(Page 1252) for a property at runtime.
DeactivateDynamic Yes - - Deactivates the trigger of the "ActivateDynamic" meth‐
(Page 1259) od used for the specified property in/during runtime.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 397
VB scripting
1.5 VBS object model

RoundButton

Description

6FUHHQV

6FUHHQ

6FUHHQ,WHPV

6FUHHQ,WHP

Represents the "Round button" object. The RoundButton object is an element of the
ScreenItems list.

Type identifier in VBS

HMIRoundButton

Abbreviation Access in Runtime

R Read
RW Read and write
- No access

Table 1-84 Properties

Properties RT Professio‐ RT Ad‐ Panel RT Description

nal vanced
AllTagTypesAllowed - - - -
Authorization RW - - Specifies the operating rights of the selected object in
(Page 517) runtime.
BackColor (Page 526) RW - - Specifies the background color of the selected object.
BackFillStyle (Page 531) RW - - Specifies the fill pattern of the selected object.

WinCC Engineering V18 – Programming reference

398 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Professio‐ RT Ad‐ Panel RT Description

nal vanced
BackFlashingColorOff RW - - Specifies the background color for flash state "Off".
(Page 533)
BackFlashingColorOn RW - - Specifies the background color for flash state "On".
(Page 534)
BackFlashingEnabled RW - - Specifies whether the background of the selected ob‐
(Page 535) ject flashes in runtime.
BackFlashingRate RW - - Specifies the flash rate of the background for the se‐
(Page 536) lected object.
BorderBackColor RW - - Specifies the background color of the broken border
(Page 558) line for the selected object.
BorderBrightColor3D RW - - Specifies the frame color of the following frame parts
(Page 561) 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 562) RW - - Specifies the line color.
BorderFlashingColorOff RW - - Specifies the border line color of the selected object
(Page 566) for the flash state "Off".
BorderFlashingColorOn RW - - Specifies the border line color of the selected object
(Page 567) for the flash state "On".
BorderFlashingEnabled RW - - Specifies whether the border line of the selected ob‐
(Page 569) ject flashes in runtime.
BorderFlashingRate RW - - Specifies the flash rate of the border line for the se‐
(Page 570) lected object.
BorderShadeColor3D - - - -
BorderStyle (Page 576) RW - - Specifies the type of border lines for the selected ob‐
ject.
BorderWidth (Page 577) RW - - Specifies the line thickness of the selected object.
BorderWidth3D RW - - Specifies the width of the border for 3D display of the
(Page 580) selected object.
Bounds - - - -
CanBeGrouped - - - -
CornerStyle (Page 635) RW - - Specifies the shape of the corners of the specified ob‐
ject.
DrawInsideFrame RW - - Specifies whether the border line of the selected ob‐
(Page 655) ject with a line thickness greater than 1 should be
drawn within the border or symmetrically to the bor‐
der.
EdgeStyle (Page 657) RW - - Specifies the line style of the selected object.
Enabled (Page 660) RW - - Specifies whether the selected object can be operat‐
ed in runtime.
FillingDirection RW - - Specifies the fill direction.
(Page 687)
FillPatternColor RW - - Specifies the color of the fill pattern for the selected
(Page 685) object.
Flashing - - - -
FlashingColorOff RW - - Specifies the border line color of the selected object
(Page 693) for the flash state "Off".

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 399
VB scripting
1.5 VBS object model

Properties RT Professio‐ RT Ad‐ Panel RT Description

nal vanced
FlashingColorOn RW - - Specifies the border line color of the selected object
(Page 695) for the flash state "On".
FlashingEnabled RW - - Specifies whether the border line of the selected ob‐
(Page 697) ject flashes in runtime.
FlashingRate (Page 699) RW - - Specifies the flash rate of the border line for the se‐
lected object.
Font - - - -
FontBold (Page 708) RW - - Specifies whether the text of the selected object is
shown in bold.
FontItalic (Page 708) RW - - Specifies whether the text of the selected object is
shown in italics.
FontName (Page 709) RW - - Specifies the font of the selected object.
FontSize (Page 711) RW - - Specifies the font size of the text for the selected ob‐
ject.
FontUnderline RW - - Specifies whether the text of the selected object is
(Page 711) underlined.
ForeColor (Page 712) R - - Specifies the font color of the text for the selected
object.
Height (Page 720) R - - Specifies the height of the selected object.
HorizontalAlignment R - - Specifies the horizontal alignment of the text within
(Page 736) the selected object.
Layer (Page 764) R - - Returns the layer in the screen in which an object is
located.
Left (Page 770) R - - Returns the value of the X coordinate of the object.
LineEndShapeStyle R - - Specifies the shape of the line ends.
(Page 787)
Location - - - -
Mode (Page 824) R - - Returns the field type of the specified object.
Name - - - -
PictureAlignment R - - Returns the display type for the background screen in
(Page 864) the process image.
PictureDeactivated R - - Returns the graphic that is displayed in the "Disabled"
(Page 865) state.
PictureOff (Page 866) R - - Returns the graphic that is displayed in the "Off" state.
PictureOn (Page 867) R - - Returns the screen that is displayed in the "On" state.
Pressed (Page 872) R - - Returns whether the specified object is displayed as
pressed.
Radius (Page 876) R - - Returns the radius of the specified "Circle" object.
RelativeFillLevel R - - Returns the percentage to which the object is filled.
(Page 881)
ShowFillLevel R - - Returns whether the specified object is filled.
(Page 933)
Size - - - -
StyleSettings (Page 982) R - - Returns the style in which the object is displayed.
TabIndex - - - -
TabIndexAlpha - - - -

WinCC Engineering V18 – Programming reference

400 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Professio‐ RT Ad‐ Panel RT Description

nal vanced
Text (Page 1000) R - - Returns the label for the text field.
TextOrientation R - - Returns the text orientation of the specified object.
(Page 1004)
Toggle (Page 1052) R - - Returns whether the specified object engages after it
has been operated in Runtime.
ToolTipText (Page 1082) R - - Returns the tooltip text.
Top (Page 1083) R - - Returns the value of the Y coordinate of the object.
Transparency R - - Returns the object transparency in percent.
(Page 1087)
TransparentColorDeacti‐ R - - Returns the color of the assigned bitmap object to be
vatedPicture (Page 1089) set to "transparent" for the "Disabled" state.
TransparentColorPic‐ R - - Returns the color of the assigned bitmap object to be
tureOff (Page 1090) set to "transparent" for the "Off" state.
TransparentColorPictur‐ R - - Returns the color of the assigned bitmap object to be
eOn (Page 1091) set to "transparent" for the "On" state.
UseDesignColorSchema R - - Returns whether the colors defined in the global color
(Page 1148) scheme of the current design are used for this object.
UseDesignShadowSet‐ R - - Returns whether the object is displayed with the
tings (Page 1150) shading defined in the active design.
UseTransparentColor‐ R - - Returns whether the transparent color specified with
DeactivatedPicture the "TransparentColorDeactivatedPicture" property is
(Page 1160) used for the "Disabled" state.
UseTransparentColorPic‐ R - - Returns whether the transparent color defined with
tureOff (Page 1161) the property "TransparentColorPictureOff" is used for
the "Off" state.
UseTransparentColorPic‐ R - - Returns whether the transparent color defined with
tureOn (Page 1161) the property "TransparentColorPictureOn" is used for
the "On" state.
VerticalAlignment R - - Returns the vertical alignment of the text of the speci‐
(Page 1200) fied object.
Visible (Page 1204) R - - Returns whether the specified object is visible.
Width (Page 1217) R - - Returns the width of the object in pixels.

Table 1-85 Methods

Methods RT Professio‐ RT Ad‐ Panel RT Description

nal vanced
Activate (Page 1250) Yes Yes Yes Enables the permanent area or the root screen.
ActivateDynamic Yes - - Dynamically activates a trigger and the specified cy‐
(Page 1252) cle for a property at runtime.
DeactivateDynamic Yes - - Deactivates the trigger of the "ActivateDynamic"
(Page 1259) method used for the specified property in/during run‐
time.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 401
VB scripting
1.5 VBS object model

S7GraphOverview

Description

6FUHHQV

6FUHHQ

6FUHHQ,WHPV

6FUHHQ,WHP

Represents the "GRAPH overview" object. The S7GraphOverview object is an element of the
ScreenItems list.

Type identifier in VBS

HMIS7GraphOverview

Abbreviation Access in runtime

R Read
RW Read and write
- No access

Table 1-86 Properties

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
AllTagTypesAllowed - - - -
AssociatedS7Graph‐ - - - -
DBName
AssociatedS7Graph‐ - - - -
DBTag
Authorization RW - - Specifies operating rights.
(Page 517)
Bounds - - - -

WinCC Engineering V18 – Programming reference

402 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
CanBeGrouped - - - -
Enabled (Page 660) - RW RW Specifies whether the selected object can be operat‐
ed in runtime.
ErrorColor (Page 669) RW - - Specifies the color of errors in the GRAPH overview.
Errorflag (Page 671) RW - - Specifies whether an error description is displayed in
the device / detail view.
Height (Page 720) - R R Specifies the height.
HighlightColor RW - - Specifies the highlight color in the GRAPH overview.
(Page 725)
Layer (Page 764) RW RW RW Specifies the layer in the screen that contains an ob‐
ject.
Left (Page 770) - RW RW Specifies the value of the X coordinate.
Location - - - -
Name - - - -
PathHeaderBackColor - - -
(Page 860)
PathHeaderFont RW - - Specifies the header font.
(Page 860)
PathHeaderTextColor RW - - Specifies the font color in the header of the GRAPH
(Page 861) overview.
SeparatorColor RW - - Specifies the color of the separation lines in the se‐
(Page 920) lection list.
Size - - - -
StepBackColor RW - - Specifies the background color of the step.
(Page 978)
StepFont (Page 979) RW - - Specifies the font color of the step.
StepTextColor RW - - Specifies the text color of the step.
(Page 980)
TabIndex - - - -
TabIndexAlpha - - - -
Top (Page 1083) - RW RW Specifies the value of the Y coordinate.
Visible (Page 1204) - RW RW Specifies whether the selected object is visible.
Width (Page 1217) - R R Specifies the width.

Table 1-87 Methods

Methods RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Activate Yes - - Enables the permanent area or the root screen.
ActivateDynamic Yes - - Dynamically activates a trigger and the specified cycle
for a property at runtime.
DeactivateDynamic Yes - - Deactivates the trigger of the "ActivateDynamic"
method used for the specified property in/during run‐
time.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 403
VB scripting
1.5 VBS object model

ScreenWindow

Description

6FUHHQV

6FUHHQ

6FUHHQ,WHPV

6FUHHQ,WHP

Represents the "ScreenWindow" object. The ScreenWindow object is an element of the

ScreenItems list.

Type identifier in VBS

HMIScreenWindow

Abbreviation Access in Runtime

R Read
RW Read and write
- No access

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
AdaptScreenToWindow R - - Specifies whether or not the screen visualized in a
(Page 499) screen window is adapted to fit the size of the screen
window in runtime.
AdaptWindowtoScreen R - - Specifies whether the screen window is adapted to fit
(Page 500) the screen it visualizes in runtime.
AllTagTypesAllowed - - - -
BorderEnabled R - - Specifies whether the window is displayed with a
(Page 565) border in runtime.
Bounds - - - -
CanBeGrouped - - - -

WinCC Engineering V18 – Programming reference

404 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
CaptionText (Page 590) RW - - Specifies the text to be displayed in the header.
Flashing - - - -
Height (Page 720) RW - - Specifies the height.
HorizontalScrollBarPosi‐ RW - - Specifies the position of the slider in the horizontal
tion (Page 738) scroll bar.
IndipendentWindow - - - -
Layer (Page 764) RW - - Specifies the layer in the screen that contains an ob‐
ject.
Left (Page 770) RW - - Specifies the value of the X coordinate.
LeftOffset (Page 775) 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 800) menu and toolbars.
MonitorNumber R - - Specifies the number of the monitor whose content is
(Page 825) displayed in the screen window.
Name - - - -
ProcessTag - - - -
ScreenName (Page 901) R - - Specifies the screen to be displayed in the screen win‐
dow in runtime.
ScreenScaleMode R - - Specifies the scaling mode of the displayed screen.
(Page 902)
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.
ShowCaption (Page 927) R - - Specifies whether the title bar is shown.
ShowScrollbars R - - Specifies whether scroll bars are displayed.
(Page 940)
Size - - - -
TabIndex - - - -
TabIndexAlpha - - - -
TagPrefix (Page 997) RW - - Specifies the tag prefix that is prefixed for all tags
contained in the screen window.
Top (Page 1083) RW - - Specifies the value of the Y coordinate.
TopOffset (Page 1085) RW - - Sets the vertical shift of the zero point of the display
of a screen that is larger than the screen window.
VerticalScrollbarPosition RW - - Specifies the position of the slider in the vertical scroll
(Page 1202) bar of the object.
Visible (Page 1204) RW - - Specifies whether the selected object is visible.
Width (Page 1217) RW - - Specifies the width of the object in pixels.
WindowCloseEnabled R - - Specifies whether a window can be closed in Runtime.
(Page 1220)
WindowMaximizeEna‐ R - - Specifies whether the object can be maximized in
bled (Page 1221) Runtime.
WindowMovingEnabled R - - Specifies whether the object can be moved in Run‐
(Page 1221) time.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 405
VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
WindowOnTop R - - Specifies whether the object always remains in the
(Page 1222) foreground in Runtime.
WindowSizingEnabled R - - Specifies whether the size can be changed.
(Page 1223)
WindowStartupPosition R - - Specifies the position and the mode of the screen
(Page 1224) window when an independent screen window is con‐
figured.
ZoomFactor (Page 1249) RW - - Specifies the zoom factor of a screen or screen win‐
dow.

Table 1-88 Methods

Methods RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Activate (Page 1250) Yes - - Enables the permanent area or the root screen.
ActivateDynamic Yes - - Dynamically activates a trigger and the specified cycle
(Page 1252) for a property at runtime.
DeactivateDynamic Yes - - Deactivates the trigger of the "ActivateDynamic"
(Page 1259) method used for the specified property in/during run‐
time.

ScriptDiagnostics

Description

6FUHHQV

6FUHHQ

6FUHHQ,WHPV

6FUHHQ,WHP

WinCC Engineering V18 – Programming reference

406 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Represents the "ApplicationWindow" object. The ApplicationWindow object is an element of

the ScreenItems list.

Type identifier in VBS

HMIApplicationWindow

Abbreviation Access in Runtime

R Read
RW Read and write
- No access

Table 1-89 Properties

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
AllTagTypesAllowed - - - -
BorderEnabled RW - - Specifies whether the window is displayed with a
(Page 565) border in runtime.
Bounds - - - -
CanBeGrouped - - - -
GSCRuntimeAllowed - - - -
Height (Page 720) RW - - Specifies the height.
Layer (Page 764) RW - - Specifies the layer in the screen that contains an ob‐
ject.
Left (Page 770) RW - - Specifies the value of the X coordinate.
Location - - - -
Name - - - -
ShowCaption (Page 927) RW - - Specifies whether the title bar is shown.
Size - - - -
TabIndex - - - -
TabIndexAlpha - - - -
Template (Page 999) RW - - Specifies the template for displaying window content
in the "Print job/Script diagnostics" object.
Top (Page 1083) - - - -
Visible (Page 1204) RW - - Specifies whether the selected object is visible.
Width (Page 1217) RW - - Specifies the width of the object in pixels.
WindowCloseEnabled RW - - Specifies whether a window can be closed in Runtime.
(Page 1220)
WindowMaximizeEna‐ RW - - Specifies whether the object can be maximized in
bled (Page 1221) Runtime.
WindowMovingEnabled RW - - Specifies whether the object can be moved in Run‐
(Page 1221) time.
WindowOnTop RW - - Specifies whether the object always remains in the
(Page 1222) foreground in Runtime.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 407
VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
WindowsContents RW - - Specifies the content of the print job or script diag‐
(Page 1222) nostics.
WindowSizingEnabled RW - - Specifies whether the size can be changed.
(Page 1223)

Table 1-90 Methods

Methods RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Activate (Page 1250) Yes - - Enables the permanent area or the root screen.
ActivateDynamic Yes - - Dynamically activates a trigger and the specified cycle
(Page 1252) for a property at runtime.
DeactivateDynamic Yes - - Deactivates the trigger of the "ActivateDynamic"
(Page 1259) method used for the specified property in/during run‐
time.

See also
Name (Page 827)

Slider

Description

6FUHHQV

6FUHHQ

6FUHHQ,WHPV

6FUHHQ,WHP

Represents the "Slider" object. The Slider object is an element of the ScreenItems list.

WinCC Engineering V18 – Programming reference

408 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Type identifier in VBS

HMISlider

Abbreviation Access in Runtime

R Read
RW Read and write
- No access

Table 1-91 Properties

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
AlarmLowerLimitColor - - - -
AlarmUpperLimitColor - - - -
AllTagTypesAllowed - - - -
Authorization RW RW RW Specifies operating rights.
(Page 517)
BackColor (Page 526) RW RW RW Specifies the background color.
BackFillStyle (Page 531) RW - - Specifies the fill pattern of the selected object.
BackPicture (Page 538) RW - - Specifies the background graphic.
BarBackColor (Page 539) RW RW RW Specifies the color of the bar background for the se‐
lected object.
BarColor (Page 542) RW RW RW Specifies the color of the bar.
BarOrientation - - - -
BorderBackColor - - - -
BorderBrightColor3D RW RW RW Specifies the border color of the following border
(Page 561) parts for 3D presentation.
BorderColor - - - -
BorderInnerStyle3D RW - - Specifies the appearance of the inner part of the ob‐
(Page 572) ject border.
BorderInnerWidth3D RW RW RW Specifies the width of the inner border for 3D display.
(Page 573)
BorderOuterStyle3D - - - -
BorderOuterWidth3D RW RW RW Specifies the width of the outer border for 3D display.
(Page 574)
BorderShadeColor3D RW RW RW Specifies the border color of the following border
(Page 575) parts for 3D presentation.
BorderWidth (Page 577) RW RW RW Specifies the line thickness.
Bounds - - - -
CanBeGrouped - - - -
Caption (Page 587) RW RW RW Specifies the text to be displayed in the header.
CompatibilityMode - - - -
ContinousChange RW - - Specifies whether to transfer the value of the "Proc‐
(Page 633) essValue" when the mouse button is released, or im‐
mediately on a change of the slider position in run‐
time.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 409
VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
CornerRadius - - - -
DeviceStyle - - - -
EdgeStyle - - - -
Enabled (Page 660) RW RW RW Specifies whether the selected object can be operat‐
ed in runtime.
Flashing (Page 692) RW - - Specifies that flashing is activated.
FocusColor (Page 703) RW RW RW Specifies the color of the focus border when the ob‐
ject has the focus.
FocusWidth (Page 704) RW RW RW Specifies the border width when the object has the
focus.
Font (Page 705) RW - - Specifies the font.
ForeColor (Page 712) RW RW RW Specifies the font color of the text.
ForeColorTransparency - - - -
Height (Page 720) RW R R Specifies the height.
LabelColor (Page 758) RW RW RW Specifies the color of the scale label.
Layer (Page 764) RW RW RW Specifies the layer in the screen that contains an ob‐
ject.
Left (Page 770) RW RW RW Specifies the value of the X coordinate.
LimitRangeCollection - - - -
Location - - - -
MaximumValue RW RW RW Specifies the maximum value of the scale in the se‐
(Page 799) lected object.
MinimumValue RW RW RW Specifies the minimum value of the scale in the se‐
(Page 822) lected object.
Name (Page 827) RW - - Specifies the object name.
PositionFont (Page 871) RW - - Sets the font for the label of the slider.
ProcessValue (Page 874) RW RW RW Specifies the default for the value to be displayed.
ScaleLabelFieldLength - - - -
ScalePosition - - - -
ShowBar (Page 926) RW RW RW Specifies whether the displayed process value is also
shown by a filled bar.
ShowLimitLines - - - -
ShowLimitMarkers - - - -
ShowLimitRanges - - - -
ShowPosition RW RW RW Adds a numerical display of the value of the slider
(Page 938) position.
ShowScale - - - -
ShowThumb (Page 945) R RW RW Displays the slider of the "Slider" object.
ShowTickLabels R RW RW Specifies whether the label is shown in the scale.
(Page 946)
ShowTicks (Page 946) R RW RW Specifies whether the marks in the scale are dis‐
played.
Size - - - -
StyleItem - - - -

WinCC Engineering V18 – Programming reference

410 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
TabIndex - - - -
TabIndexAlpha - - - -
ThumbBackColor R RW RW Specifies the background color of the slider.
(Page 1006)
ThumbPicture R - - Returns a graphic for the slider element in the slider.
(Page 1007)
TickStyle (Page 1008) R - - Returns how the marks are displayed in the scale.
Top (Page 1083) R RW RW Specifies the value of the Y coordinate.
Transparency (Page 1087) R - - Returns the object transparency in percent.
UseDesignColorSchema R - - Returns whether the colors defined in the global color
(Page 1148) scheme of the current design are used for this object.
UseDesignShadowSet‐ R - - Returns whether the object is displayed with global
tings (Page 1150) shading.
UseTwoHandOperation - - - -
Visible (Page 1204) R RW RW Specifies whether the selected object is visible.
Width (Page 1217) RW R R Specifies the width of the object in pixels.

Table 1-92 Methods

Methods RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Activate (Page 1250) Yes Yes Yes Enables the permanent area or the root screen.
ActivateDynamic Yes - - Dynamically activates a trigger and the specified cycle
(Page 1252) for a property at runtime.
DeactivateDynamic Yes - - Deactivates the trigger of the "ActivateDynamic"
(Page 1259) method used for the specified property in/during run‐
time.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 411
VB scripting
1.5 VBS object model

SmartClientView

Description

6FUHHQV

6FUHHQ

6FUHHQ,WHPV

6FUHHQ,WHP

Represents the "Sm@rtClient View" object. The SmartClientView object is an element of the
ScreenItems list.

Type identifier in VBS

HMISmartClientView

Abbreviation Access in Runtime

R Read
RW Read and write
- No access

Table 1-93 Properties

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
AdressPreview - - - -
AllowMenu - - - -
AllTagTypesAllowed - - - -
Bounds - - - -
CanBeGrouped - - - -
ConnectionType - - - -
ConnectOnStart - - - -

WinCC Engineering V18 – Programming reference

412 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Enabled (Page 660) - RW RW Specifies whether the selected object can be operat‐
ed in runtime.
EncryptCommunication - - - -
Flashing - - - -
Font - - - -
Height - R R Specifies the height.
Layer (Page 764) - RW RW Specifies the layer in the screen that contains an ob‐
ject.
Left (Page 770) - RW RW Specifies the value of the X coordinate.
LocalCursor - - - -
Location - - - -
Machine - - - -
MachineName - RW RW Sets the network ID of the device that is to be moni‐
(Page 797) tored.
Name - - - -
Password (Page 859) - RW RW Sets the password for remote monitoring.
PasswordsMustBeEn‐ - - - -
crypted
ScaleDenominator - - - -
ScaleNumerator - - - -
Scaling - - - -
ServerScale - - - -
Shared - - - -
ShowControls - - - -
Size - - - -
TabIndex - - - -
TabIndexAlpha - - - -
TcpPortNr - - - -
Top (Page 1083) - RW RW Specifies the value of the Y coordinate.
UseCurserKeyScroll - - - -
ViewOnly (Page 1203) - RW RW Specifies whether the Sm@rtClient display will be
used for remote monitoring or remote maintenance.
Visible (Page 1204) - RW RW Specifies whether the selected object is visible.
Width - R R Specifies the width.

Table 1-94 Methods

Methods RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Activate (Page 1250) - Yes Yes Enables the permanent area or the root screen.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 413
VB scripting
1.5 VBS object model

StatusForce

Description

6FUHHQV

6FUHHQ

6FUHHQ,WHPV

6FUHHQ,WHP

Represents the "Watch table" object. The StatusForce 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.

Type identifier in VBS

HMIStatusForce

Abbreviation Access in Runtime

R Read
RW Read and write
- No access

Table 1-95 Properties

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
AllTagTypesAllowed - - - -
Appearance - - - -
Authorization - RW RW Specifies operating rights.
(Page 517)
BackColor (Page 526) - RW RW Specifies the background color.

WinCC Engineering V18 – Programming reference

414 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
BorderBackColor - - - -
BorderColor - - - -
BorderWidth - - - -
Bounds - - - -
ButtonBackColor - - - -
ButtonBackFillStyle - - - -
ButtonBorderBackColor - - - -
ButtonBorderColor - - - -
ButtonBorderWidth - - - -
ButtonCornerRadius - - - -
ButtonEdgeStyle - - - -
ButtonFirstGradientCol‐ - - - -
or
ButtonFirstGradientOff‐ - - - -
set
ButtonMiddleGradient‐ - - - -
Color
ButtonPositions - - - -
ButtonSecondGradient‐ - - - -
Color
ButtonSecondGradien‐ - - - -
tOffset
CanBeGrouped - - - -
ColumnOrder - - - -
ColumnsMoveable - - - -
ColumnTextBit - - - -
ColumnTextConnection - - - -
ColumnTextDataType - - - -
ColumnTextDbNumber - - - -
ColumnTextFormat - - - -
ColumnTextOffset - - - -
ColumnTextRead - - - -
ColumnTextType - - - -
ColumnTextWrite - - - -
ColumnWidth - - - -
CornerRadius - - - -
CountVisibleItems - - - -
DeviceStyle - - - -
EdgeStyle - - - -
Enabled (Page 660) - RW RW Specifies whether the selected object can be operat‐
ed in runtime.
ES2RT_ColumnOrder - - - -
ES2RT_ColumnWidth - - - -

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 415
VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
FitToSize - - - -
Flashing - - - -
FocusColor (Page 703) - RW RW Specifies the color of the focus border when the ob‐
ject has the focus.
FocusWidth (Page 704) - RW RW Specifies the border width when the object has the
focus.
Height - R R Specifies the height.
IsRunningUnderCE - - - -
Layer (Page 764) - RW RW Specifies the layer in the screen that contains an ob‐
ject.
Left (Page 770) - RW RW Specifies the value of the X coordinate.
ListAreaHeight - - - -
ListAreaLeft - - - -
ListAreaTop - - - -
ListAreaWidth - - - -
Location - - - -
Name - - - -
Object - - - -
PaddingBottom - - - -
PaddingLeft - - - -
PaddingRight - - - -
PaddingTop - - - -
PLCFilter - - - -
SelectionBackColor - RW RW Specifies the background color of the selected cells.
(Page 913)
SelectionForeColor - RW RW Specifies the foreground color of the selected cells.
(Page 915)
SetOfVisibleColumns - - - -
ShowReadButton - - - -
ShowTableGridlines - RW RW Specifies whether grid lines are shown in the table.
(Page 944)
ShowWriteButton - - - -
Size - - - -
StyleItem - - - -
TabIndex - - - -
TabIndexAlpha - - - -
TableBackColor - RW RW Specifies the background color of the table cells.
(Page 987)
TableEvenRowBackColor - - - -
TableFont - - - -
TableForeColor - RW RW Specifies the text color used in the table cells of the
(Page 990) object.
TableGridlineColor - - - -

WinCC Engineering V18 – Programming reference

416 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
TableHeaderBackColor - RW RW Specifies the background color in the header of the
(Page 993) table.
TableHeaderBackFill‐ - - - -
Style
TableHeaderBorderBack‐ - - - -
Color
TableHeaderBorderColor - - - -
TableHeaderBorder‐ - - - -
Width
TableHeaderCornerRa‐ - - - -
dius
TableHeaderEdgeStyle - - - -
TableHeaderFirstGra‐ - - - -
dientColor
TableHeaderFirstGra‐ - - - -
dientOffset
TableHeaderFont - - - -
TableHeaderForeColor - R R Returns the text color in the header of the table of the
(Page 995) specified object.
TableHeaderMiddleGra‐ - - - -
dientColor
TableHeaderPaddingBot‐ - - - -
tom
TableHeaderPaddingLeft - - - -
TableHeaderPadding‐ - - - -
Right
TableHeaderPaddingTop - - - -
TableHeaderSecondGra‐ - - - -
dientColor
TableHeaderSecondGra‐ - - - -
dientOffset
ToolTipText (Page 1082) - R R Specifies the tooltip text.
Top (Page 1083) - R R Returns the value of the Y coordinate.
UseButtonFirstGradient - - - -
UseButtonSecondGradi‐ - - - -
ent
UseDesignColorSchema - - - -
UseTableHeaderFirst‐ - - - -
Gradient
UseTableHeaderSecond‐ - - - -
Gradient
Visible (Page 1204) - R R Returns whether the specified object is visible.
Width - R R Specifies the width.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 417
VB scripting
1.5 VBS object model

Table 1-96 Methods

Methods RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Activate (Page 1250) - Yes Yes Enables the permanent area or the root screen.

Switch

Description

6FUHHQV

6FUHHQ

6FUHHQ,WHPV

6FUHHQ,WHP

Represents the "Switch" object. The Switch object is an element of the ScreenItems list.
The availability of the following object properties depends on the selected mode:

Property "Switch with text" "Switch with graphic" "Switch"

CaptionColor (Page 589) -- -- x
CaptionText (Page 590) -- -- x
HorizontalAlignment X -- --
(Page 736)
InnerBackColorOff -- -- x
(Page 744)
InnerBackColorOn -- -- x
(Page 745)
TextOn (Page 1003) x -- x
TextOff (Page 1002) x -- x
VerticalAlignment x -- --
(Page 1200)

WinCC Engineering V18 – Programming reference

418 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Type identifier in VBS

HMISwitch

Abbreviation Access in Runtime

R Read
RW Read and write
- No access

Table 1-97 Properties

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
AboveUpperLimitColor - - - -
AllTagTypesAllowed - - - -
Authorization - RW RW Specifies operating rights.
(Page 517)
BackColor (Page 526) - RW RW Specifies the background color.
BackFillStyle - - - -
BackFlashingColorOff - - - -
BackFlashingColorOn - - - -
BackFlashingEnabled - - - -
BackFlashingRate - - - -
BelowLowerLimitColor - - - -
BorderBackColor - - - -
BorderBrightColor3D - - - -
BorderColor - - - -
BorderFlashingColorOff - - - -
BorderFlashingColorOn - - - -
BorderFlashingEnabled - - - -
BorderFlashingRate - - - -
BorderShadeColor3D - - - -
BorderWidth - - - -
BorderWidth3D - - - -
CanBeGrouped - - - -
CaptionColor (Page 589) - RW RW Specifies the color of the text to be displayed in the
title bar.
CaptionFont - - - -
CaptionText (Page 590) - RW RW Specifies the text to be displayed in the header.
CornerRadius - - - -
CornerStyle - - - -
DeviceStyle - - - -
DrawInsideFrame - - - -
EdgeStyle - - - -

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 419
VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Enabled (Page 660) - RW RW Specifies whether the selected object can be operat‐
ed in runtime.
FirstGradientColor - - - -
FirstGradientOffset - - - -
FitToLargest - - - -
Flashing - - - -
FlashingColorOff - - - -
FlashingColorOn - - - -
FlashingEnabled - - - -
FlashingOnLimitViola‐ - - - -
tion
FlashingRate - - - -
FocusColor (Page 703) - RW RW Specifies the color of the focus border when the ob‐
ject has the focus.
FocusWidth (Page 704) - RW RW Specifies the border width when the object has the
focus.
Font - - - -
ForeColor (Page 712) - RW RW Specifies the font color of the text.
Height - R R Specifies the height.
HelpText (Page 724) - RW RW Specifies the tooltip that is shown in Runtime as user
help for the specified object.
HorizontalAlignment - RW RW Specifies the horizontal alignment of the text.
(Page 736)
HorizontalPictureAlign‐ - - - -
ment
HotKey - - - -
InnerBackColorOff - RW RW Sets the color underneath the slider of the "Switch"
(Page 744) object for the object in OFF state.
InnerBackColorOn - RW RW Sets the color underneath the slider of the "Switch"
(Page 745) object for the object in ON state.
Layer (Page 764) - RW RW Specifies the layer in the screen that contains an ob‐
ject.
Left (Page 770) - RW RW Specifies the value of the X coordinate.
LineEndShapeStyle - - - -
Location - - - -
MiddleGradientColor - - - -
Mode - - - -
Name - - - -
OnValue - - - -
PictureAreaBottomMar‐ - - - -
gin
PictureAreaLeftMargin - - - -
PictureAreaRightMargin - - - -
PictureAreaTopMargin - - - -

WinCC Engineering V18 – Programming reference

420 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
PictureAutoSizing - - - -
PictureOff - - - -
PictureOn - - - -
ProcessValue - - - -
SecondGradientColor - - - -
SecondGradientOffset - - - -
ShowCaption - - - -
Size - - - -
StyleItem - - - -
SwitchOrientation - - - -
TabIndex - - - -
TabIndexAlpha - - - -
TextAreaBottomMargin - - - -
TextAreaLeftMargin - - - -
TextAreaRightMargin - - - -
TextAreaTopMargin - - - -
TextOff (Page 1002) - R R Returns the text that is displayed in the "Off" state.
TextOn (Page 1003) - R R Returns the text that is displayed in the "On" state.
TextOrientation - - - -
ToolTipText (Page 1082) - R R Returns the tooltip text.
Top (Page 1083) - R R Returns the value of the Y coordinate.
UseDesignColorSchema - - - -
UseFirstGradient - - - -
UseSecondGradient - - - -
VerticalAlignment - R R Returns the vertical alignment of the text in the speci‐
(Page 1200) fied object.
VerticalPictureAlign‐ - - - -
ment
Visible (Page 1204) - R R Returns whether the specified object is visible.
Width - R R Specifies the width.

Table 1-98 Methods

Methods RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Activate (Page 1250) - Yes Yes Enables the permanent area or the root screen.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 421
VB scripting
1.5 VBS object model

SymbolicIOField

Description

6FUHHQV

6FUHHQ

6FUHHQ,WHPV

6FUHHQ,WHP

Represents the "SymbolicIOField" object. The SymbolicIOField 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"

BackColor (Page 526) x x x x
BorderColor -- x -- x
(Page 562)
BorderWidth -- -- -- x
(Page 577)
Enabled (Page 660) x -- x --
HelpText (Page 724) x -- x --
VerticalAlignment -- x -- x
(Page 1200)
HorizontalAlign‐ -- x -- x
ment (Page 736)

WinCC Engineering V18 – Programming reference

422 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Type identifier in VBS

HMISymbolicIOField

Abbreviation Access in Runtime

R Read
RW Read and write
- No access

Table 1-99 Properties

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
AboveUpperLimitColor - - - -
AcceptOnExit RW - - Specifies whether the input field is confirmed auto‐
(Page 491) matically when it is left.
AdaptBorder (Page 498) RW - - Specifies whether the border of the object will be dy‐
namically adapted to the text size.
AllTagTypesAllowed - - - -
AskOperationMotive RW - - Specifies whether the reason for operating this object
(Page 514) is logged.
Assignments (Page 516) RW - - Specifies a list which contains the assignments be‐
tween the output value and the output text actually
to be output.
Authorization RW RW RW Specifies the operating rights of the selected object in
(Page 517) runtime.
BackColor (Page 526) RW RW RW Specifies the background color of the selected object.
BackFillStyle (Page 531) RW - - Specifies the fill pattern of the selected object.
BackFlashingColorOff RW - - Specifies the background color for flash state "Off".
(Page 533)
BackFlashingColorOn RW - - Specifies the background color for flash state "On".
(Page 534)
BackFlashingEnabled RW - - Specifies whether the background of the selected ob‐
(Page 535) ject flashes in runtime.
BackFlashingRate RW - - Specifies the flash rate of the background for the se‐
(Page 536) lected object.
BelowLowerLimitColor - - - -
BitNumber (Page 546) RW - - Specifies the bit whose status must change to trigger
a value change.
BorderBackColor - - - -
BorderColor (Page 562) RW RW RW Specifies the line color of the selected object.
BorderFlashingColorOff RW - - Specifies the border line color of the selected object
(Page 566) for the flash state "Off".
BorderFlashingColorOn RW - - Specifies the border line color of the selected object
(Page 567) for the flash state "On".
BorderFlashingEnabled RW - - Specifies whether the border line of the selected ob‐
(Page 569) ject flashes in runtime.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 423
VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
BorderFlashingRate RW - - Specifies the flash rate of the border line for the se‐
(Page 570) lected object.
BorderStyle (Page 576) RW - - Specifies the type of border lines for the selected ob‐
ject.
BorderWidth (Page 577) RW RW RW Specifies the line thickness of the selected object.
BottomMargin - - - -
CanBeGrouped - - - -
CaptionBackColor RW - - Specifies the background color of the caption for the
(Page 588) selected object.
CaptionColor (Page 589) RW - - Specifies the color of the text that is displayed in the
header of the selected object.
CornerRadius - - - -
CornerStyle (Page 635) RW - - Specifies the shape of the corners of the specified
object.
CountVisibleItems RW - - Specifies how many lines the drop-down list is to
(Page 638) contain.
CursorControl RW - - Specifies whether the mouse cursor jumps to the
(Page 639) next field of the TAB sequence after leaving a field.
DeviceStyle - - - -
DrawInsideFrame RW - - Specifies whether the border line of the selected ob‐
(Page 655) ject with a line thickness greater than 1 should be
drawn within the border or symmetrically to the bor‐
der.
EdgeStyle (Page 657) RW - - Specifies the line style of the selected object.
EditOnFocus (Page 659) RW - - Specifies whether data input is immediately possible
if the input field is selected using the "Tab" key.
Enabled (Page 660) RW RW RW Specifies whether the selected object can be operat‐
ed in runtime.
EvenRowBackColor - - - -
ExtraHeightOffset - - - -
FillPatternColor R - - Returns the color of the fill pattern for the specified
(Page 685) object.
FitToLargest - - - -
Flashing - - - -
FlashingColorOff R - - Returns the color of the border line of the specified
(Page 693) object for the flashing state "Off".
FlashingColorOn R - - Returns the color of the border line for the specified
(Page 695) object for the flashing state "On".
FlashingEnabled R - - Returns whether the border line of the specified ob‐
(Page 697) ject flashes in Runtime.
FlashingOnLimitViola‐ - - - -
tion
FlashingRate (Page 699) R - - Returns the flash rate of the border line of the speci‐
fied object.
FocusColor - - - -
FocusWidth - - - -

WinCC Engineering V18 – Programming reference

424 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Font - - - -
FontBold (Page 708) R - - Returns whether the text of the specified object is
displayed bold.
FontItalic (Page 708) R - - Returns whether the text of the specified object is
displayed italic.
FontName (Page 709) R - - Returns the font of the specified object.
FontSize (Page 711) 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 711) displayed underlined.
ForeColor (Page 712) R RW RW Specifies the font color of the text for the selected
object.
Height (Page 720) RW R R Specifies the height of the selected object.
HelpText (Page 724) - RW RW Specifies the tooltip that is shown in Runtime as user
help for the specified object.
HorizontalAlignment R RW RW Specifies the horizontal alignment of the text within
(Page 736) the selected object.
InputValue (Page 747) R - - Returns the input value.
ItemBorderStyle R - - Returns the line style of the separation lines in the
(Page 750) selection list of the specified object.
Layer (Page 764) R RW RW Specifies the layer in the screen that contains an ob‐
ject.
Left (Page 770) R RW RW Specifies the value of the X coordinate of the selected
object.
LeftMargin - - - -
LineEndShapeStyle R - - Returns the shape of the line ends.
(Page 787)
Location - - - -
LogOperation R - - Returns whether an alarm is output on the alarm sys‐
(Page 794) tem after operation of this object.
Mode (Page 824) R - - Returns the field type of the specified object.
Name - - - -
OnValue - - - -
ProcessValue (Page 874) R - - Returns the default for the value to be displayed.
RightMargin - - - -
SelectBackColor R - - Returns the background color of the selected text en‐
(Page 905) try for the specified object.
SelectForeColor R - - Returns the color of the selected text entry for the
(Page 913) specified object.
SeparatorBackColor R - - Returns the background color of the broken separa‐
(Page 919) tion lines in the selection list of the specified object.
SeparatorColor R - - Returns the color of the separation lines in the selec‐
(Page 920) tion list of the specified object.
SeparatorCornerStyle R - - Returns the shape of the corners for the specified ob‐
(Page 921) ject.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 425
VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
SeparatorLineEndSha‐ R - - Returns the shape of the line end for the specified
peStyle (Page 921) object.
SeparatorStyle R - - Returns the line style of the separation lines in the
(Page 922) selection list of the specified object.
SeparatorWidth R - - Returns the separation line width in the selection list
(Page 922) of the specified object.
ShowBadTagState R - - Returns whether the object is grayed out in the event
(Page 926) of a bad quality code or tag status.
ShowDropDownButton R - - Returns whether a button for the selection list is dis‐
(Page 929) played.
ShowDropDownList - - - -
Size - - - -
StyleItem - - - -
TabIndex - - - -
TabIndexAlpha - - - -
TextList (Page 1002) 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 1004)
ToolTipText (Page 1082) R R R Returns the tooltip text.
Top (Page 1083) R R R Returns the value of the Y coordinate of the specified
object.
TopMargin - - - -
Transparency R - - Returns the object transparency in percent.
(Page 1087)
UseDesignColorSchema R - - Returns whether the colors defined in the global color
(Page 1148) scheme of the current design are used for this object.
UseDesignShadowSet‐ R - - Returns whether the object is displayed with the
tings (Page 1150) shading defined in the active design.
VerticalAlignment R RW RW Specifies the vertical alignment of the text in the
(Page 1200) specified object.
Visible (Page 1204) R RW RW Specifies whether the selected object is visible.
Width (Page 1217) RW R R Specifies the width of the object in pixels.

WinCC Engineering V18 – Programming reference

426 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Table 1-100 Methods

Methods RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Activate (Page 1250) Yes Yes Yes Enables the permanent area or the root screen.
ActivateDynamic Yes - - Dynamically activates a trigger and the specified cycle
(Page 1252) for a property at runtime.
DeactivateDynamic Yes - - Deactivates the trigger of the "ActivateDynamic"
(Page 1259) method used for the specified property in/during run‐
time.

SymbolLibrary

Description

6FUHHQV

6FUHHQ

6FUHHQ,WHPV

6FUHHQ,WHP

Represents the "SymbolLibrary" object. The SymbolLibrary object is an element of the

ScreenItems list.

Type identifier in VBS

HMISymbolLibrary

Abbreviation Access in Runtime

R Read
RW Read and write
- No access

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 427
VB scripting
1.5 VBS object model

Table 1-101 Properties

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
AboveUpperLimitColor - - - -
AllTagTypesAllowed - - - -
Authorization - RW RW Specifies operating rights.
(Page 517)
BackColor (Page 526) RW RW RW Specifies the background color.
BackFillStyle (Page 531) RW - - Specifies the fill pattern.
BelowLowerLimitColor - - - -
BlinkColor (Page 547) RW RW RW Specifies the color in which the object flashes in run‐
time.
BlinkMode (Page 547) RW - - Specifies the type of flash graphic for the specified
object.
BlinkSpeed (Page 548) RW - - Sets the flash rate.
Bounds - - - -
CanBeGrouped - - - -
ChangeMouseCursor RW - - Specifies how the appearance of the cursor changes
(Page 596) in runtime when it is above the icon.
Enabled (Page 660) RW RW RW Specifies whether the selected object can be operat‐
ed in runtime.
FillColorMode RW - - Specifies the type of foreground for the selected ob‐
(Page 684) ject.
FixedAspectRatio RW - - Specifies whether the aspect ratio should be retained
(Page 691) on changes of the icon size, or follow the change
dynamically.
Flashing - - - -
FlashingOnLimitViola‐ - - - -
tion
Flip (Page 702) RW - - Specifies whether the symbol is flipped on the verti‐
cal and / or horizontal center axis of the symbol.
ForeColor (Page 712) RW RW RW Specifies the font color of the text.
Height (Page 720) RW R R Specifies the height.
Layer (Page 764) RW RW RW Specifies the layer in the screen that contains an ob‐
ject.
Left (Page 770) RW RW RW Specifies the value of the X coordinate.
Location - - - -
Name - - - -
Object - - - -
OcxGuid - - - -
OcxState - - - -
OcxStateForEs2Rt - - - -
ProcessValue - - - -
Rotation (Page 882) RW - - Specifies the angle of rotation in degrees.

WinCC Engineering V18 – Programming reference

428 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Size - - - -
TabIndex - - - -
TabIndexAlpha - - - -
Top (Page 1083) RW RW RW Specifies the value of the Y coordinate.
Visible (Page 1204) RW RW RW Specifies whether the selected object is visible.
Width (Page 1217) RW R R Specifies the width of the object in pixels.

Table 1-102 Methods

Methods RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Activate (Page 1250) Yes Yes Yes Enables the permanent area or the root screen.
ActivateDynamic Yes - - Dynamically activates a trigger and the specified cycle
(Page 1252) for a property at runtime.
DeactivateDynamic Yes - - Deactivates the trigger of the "ActivateDynamic"
(Page 1259) method used for the specified property in/during run‐
time.

SysDiagControl

Description

6FUHHQV

6FUHHQ

6FUHHQ,WHPV

6FUHHQ,WHP

Represents the "System diagnostic view" object. The SystemDiagnoseView object is an

element of the ScreenItems list.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 429
VB scripting
1.5 VBS object model

Type identifier in VBS

HMISysDiagView

Abbreviation Access in Runtime

R Read
RW Read and write
- No access

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
AllTagTypesAllowed - - - -
Authorization - - - -
BackgroundColor - - - -
BorderBackColor - - - -
BorderColor - - - -
BorderWidth - - - -
Bounds - - - -
BufferViewColumnOrder - - - -
BufferViewInternalRow‐ - - - -
Order
BusyText - - - -
ButtonBackColor - - - -
ButtonBackFillStyle - - - -
ButtonBorderBackColor - - - -
ButtonBorderColor - - - -
ButtonBorderWidth - - - -
ButtonCornerRadius - - - -
ButtonEdgeStyle - - - -
ButtonFirstGradientCol‐ - - - -
or
ButtonFirstGradientOff‐ - - - -
set
ButtonMiddleGradient‐ - - - -
Color
ButtonSecondGradient‐ - - - -
Color
ButtonSecondGradien‐ - - - -
tOffset
BV_ColumnWidth_Date - - - -
BV_ColumnWidth_Event - - - -
BV_ColumnWidth_Even‐ - - - -
tSeverity
BV_ColumnWidth_Even‐ - - - -
tState

WinCC Engineering V18 – Programming reference

430 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
BV_ColumnWidth_Num‐ - - - -
ber
BV_ColumnWidth_Time - - - -
BV_ItemText_Date - - - -
BV_ItemText_Event - - - -
BV_ItemText_EventSe‐ - - - -
verity
BV_ItemText_EventState - - - -
BV_ItemText_Number - - - -
BV_ItemText_Time - - - -
BV_ShowItem_Date - - - -
BV_ShowItem_Event - - - -
BV_ShowItem_EventSe‐ - - - -
verity
BV_ShowItem_Even‐ - - - -
tState
BV_ShowItem_Number - - - -
BV_ShowItem_Time - - - -
CanBeGrouped - - - -
ColumnSettings - - - -
ColumnSettingsBuffer‐ - - - -
View
ComplexViewToolbar - - - -
ComplexViewToolbar‐ - - - -
Bounds
ComponentInfoText - - - -
CornerRadius - - - -
DeviceStyle - - - -
EdgeStyle - - - -
Enabled (Page 660) R R R Returns whether the specified object can be operated
in Runtime.
EnterButtonVisible - - - -
Es2RtTableBounds - - - -
EscButtonVisible - - - -
EsPreviewType - - - -
FitToSize - - - -
FitToSizeLowerRows - - - -
FitToSizeUpperRows - - - -
Flashing - - - -
Height (Page 720) RW R R Specifies the height.
HomeButtonVisible - - - -
InfoArea_Background‐ - - - -
Color

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 431
VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
InfoArea_ColumnsMov‐ - - - -
able
InfoArea_DefaultText‐ - - - -
Color
InfoArea_ErrorTextBack‐ - - - -
groundColor
InfoArea_ErrorTextColor - - - -
InfoArea_FocusFrame‐ - - - -
Color
InfoArea_FocusFrame‐ - - - -
Width
InfoArea_Font - - - -
InfoArea_RootNodeText - - - -
InfoArea_SelectionBack‐ - - - -
groundColor
InfoArea_SelectionFore‐ - - - -
groundColor
InfoArea_ShowGridLines - - - -
InfoArea_TableHeader‐ - - - -
BackgroundColor
InfoArea_TableHeader‐ - - - -
TextColor
InputAddressText - - - -
InspectorViewInternal‐ - - - -
ColumnOrder
InspectorViewRowOrder - - - -
ItemText_AKZ - - - -
ItemText_Descriptor - - - -
ItemText_ErrorText - - - -
ItemText_HardwareRevi‐ - - - -
sion
ItemText_IMDataVersion - - - -
ItemText_Installation‐ - - - -
Date
ItemText_LADDR - - - -
ItemText_Manufacturer‐ - - - -
ID
ItemText_Name - - - -
ItemText_OKZ - - - -
ItemText_Operation‐ - - - -
State
ItemText_OrderID - - - -
ItemText_ProfileID - - - -
ItemText_Rack - - - -

WinCC Engineering V18 – Programming reference

432 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
ItemText_Revision‐ - - - -
Counter
ItemText_SerialNumber - - - -
ItemText_Slot - - - -
ItemText_SoftwareRevi‐ - - - -
sion
ItemText_SpecificProfile‐ - - - -
Data
ItemText_State - - - -
ItemText_Station - - - -
ItemText_SubAddress - - - -
ItemText_SubSlot - - - -
ItemText_SubSystem - - - -
ItemText_Type - - - -
IV_ShowItem_AKZ - - - -
IV_ShowItem_Descriptor - - - -
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 - - - -
IV_ShowItem_Softwar‐ - - - -
eRevision
IV_ShowItem_Specific‐ - - - -
ProfileData
IV_ShowItem_State - - - -
IV_ShowItem_Station - - - -

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 433
VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
IV_ShowItem_SubAd‐ - - - -
dress
IV_ShowItem_SubSlot - - - -
IV_ShowItem_SubSys‐ - - - -
tem
IV_ShowItem_Type - - - -
Layer (Page 764) R R R Returns the layer in the screen in which an object is
located.
Left (Page 770) R R R Returns the value of the X coordinate.
LinesPerDiagEntry - - - -
Location - - - -
MaxToolbarRows - - - -
Name - - - -
NavigateTo (Page 830) RW - - -
NavigationButtons - - - -
NavigationPath_Font - - - -
NavigationPath_Root‐ - - - -
Text
NavigationPath_TextCol‐ - - - -
or
NavigationpathDiagbuf‐ - - - -
ferDetailText
NavigationpathDiagbuf‐ - - - -
ferText
OutputAddressText - - - -
PaddingBottom - - - -
PaddingLeft - - - -
PaddingRight - - - -
PaddingTop - - - -
RTPersistence - - - -
RTPersistenceAuthoriza‐ - - - -
tion
RTPersistenceType - - - -
ShowMilliseconds - - - -
ShowNavigationButtons - - - -
ShowPathInformation - - - -
ShowSplittedView - - - -
ShowToolbarBack‐ - - - -
groundColor
SimpleViewToolbar - - - -
Size - - - -
SplittedViewRatio - - - -
StyleItem - - - -
SupportsInplaceEdit - - - -

WinCC Engineering V18 – Programming reference

434 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
SysDiagBuffButtonVisi‐ - - - -
ble
TabIndex - - - -
TabIndexAlpha - - - -
TableEvenRowBackColor - - - -
TableGridlineColor - - - -
TableHeaderBackFill‐ - - - -
Style
TableHeaderBorderBack‐ - - - -
Color
TableHeaderBorderColor - - - -
TableHeaderBorder‐ - - - -
Width
TableHeaderCornerRa‐ - - - -
dius
TableHeaderEdgeStyle - - - -
TableHeaderFirstGra‐ - - - -
dientColor
TableHeaderFirstGra‐ - - - -
dientOffset
TableHeaderFont - - - -
TableHeaderMiddleGra‐ - - - -
dientColor
TableHeaderPaddingBot‐ - - - -
tom
TableHeaderPaddingLeft - - - -
TableHeaderPadding‐ - - - -
Right
TableHeaderPaddingTop - - - -
TableHeaderSecondGra‐ - - - -
dientColor
TableHeaderSecondGra‐ - - - -
dientOffset
ToolBar_ButtonsHeight - - - -
ToolBar_ButtonsWidth - - - -
ToolbarAlignment - - - -
ToolbarBackgroundColor - - - -
ToolbarButtonClick - - - -
ToolbarButtonHeight - - - -
ToolbarButtonSettings - - - -
ToolbarButtonWidth - - - -
ToolbarIconStyle - - - -
Top (Page 1083) R R R Returns the value of the Y coordinate.
UnitViewColumnOrder - - - -
UpdateButtonVisible - - - -

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 435
VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
UseButtonFirstGradient - - - -
UseButtonSecondGradi‐ - - - -
ent
UseDesignColorSchema - - - -
UseScadaRendererStyle - - - -
UseSystemScrollbar‐ - - - -
Width
UseTableHeaderFirst‐ - - - -
Gradient
UseTableHeaderSecond‐ - - - -
Gradient
UV_ColumnWidth_AKZ - - - -
UV_ColumnWidth_De‐ - - - -
scriptor
UV_ColumnWidth_In‐ - - - -
stallationDate
UV_Colum‐ - - - -
nWidth_LADDR
UV_Colum‐ - - - -
nWidth_Name
UV_ColumnWidth_OKZ - - - -
UV_ColumnWidth_Oper‐ - - - -
ationState
UV_ColumnWidth_Or‐ - - - -
derID
UV_ColumnWidth_Profi‐ - - - -
leID
UV_ColumnWidth_Rack - - - -
UV_ColumnWidth_Slot - - - -
UV_ColumnWidth_Soft‐ - - - -
wareRevision
UV_ColumnWidth_Spe‐ - - - -
cificProfileData
UV_ColumnWidth_State - - - -
UV_ColumnWidth_Sta‐ - - - -
tion
UV_ColumnWidth_Sub‐ - - - -
Address
UV_ColumnWidth_Sub‐ - - - -
Slot
UV_ColumnWidth_Sub‐ - - - -
System
UV_ColumnWidth_Type - - - -
UV_ShowItem_AKZ - - - -
UV_ShowItem_Descrip‐ - - - -
tor

WinCC Engineering V18 – Programming reference

436 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
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 - - - -
Visible (Page 1204) RW RW RW Specifies whether the selected object is visible.
Width (Page 1217) RW R R Specifies the width of the object in pixels.

Table 1-103 Methods

Methods RT Profes‐ RT Ad‐ Panel RT Description

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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 437
VB scripting
1.5 VBS object model

TextField

Description

6FUHHQV

6FUHHQ

6FUHHQ,WHPV

6FUHHQ,WHP

Represents the "TextField" object. The TextField object is an element of the ScreenItems list.

Type identifier in VBS

HMITextField

Abbreviation Access in runtime

R Read
RW Read and write
- No access

Table 1-104 Properties

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
AdaptBorder (Page 498) RW - - Specifies whether the border of the object will be dy‐
namically adapted to the text size.
AllTagTypesAllowed - - - -
Authorization RW - - Specifies operating rights.
(Page 517)
BackColor (Page 526) RW RW RW Specifies the background color.
BackFillStyle (Page 531) RW - - Specifies the fill pattern.
BackFlashingColorOff RW - - Specifies the background color for flash state "Off".
(Page 533)

WinCC Engineering V18 – Programming reference

438 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
BackFlashingColorOn RW - - Specifies the background color for flash state "On".
(Page 534)
BackFlashingEnabled RW - - Specifies whether the background flashes in runtime.
(Page 535)
BackFlashingRate RW - - Specifies the flash rate of the background.
(Page 536)
BorderBackColor RW - - Specifies the background color of the broken border
(Page 558) line.
BorderColor (Page 562) RW - RW Specifies the line color.
BorderFlashingColorOff RW - - Specifies the color of the border line for the flashing
(Page 566) status "Off".
BorderFlashingColorOn RW - - Specifies the color of the border line for the flashing
(Page 567) status "On".
BorderFlashingEnabled RW - - Specifies whether the limit of the object can flash in
(Page 569) runtime.
BorderFlashingRate RW - - Specifies the flash rate of the border line.
(Page 570)
BorderStyle (Page 576) RW - - Specifies the type of border lines.
BorderWidth (Page 577) RW RW RW Specifies the line thickness.
BottomMargin - - - -
Bounds - - - -
CanBeGrouped - - - -
CornerRadius - - - -
CornerStyle (Page 635) RW - - Specifies the shape of the corners.
DrawInsideFrame RW - - Specifies whether the border line is to be shown with
(Page 655) a line thickness of greater than 1 within the border or
symmetrically to the border.
EdgeStyle (Page 657) RW RW RW Specifies the line style.
Enabled (Page 660) RW RW RW Specifies whether the selected object can be operat‐
ed in runtime.
FillPatternColor RW - - Specifies the color of the fill pattern.
(Page 685)
FitToLargest - - - -
Flashing - - - -
FlashingColorOff RW - - Specifies the color of the border line for the flashing
(Page 693) status "Off".
FlashingColorOn RW - - Specifies the color of the border line for the flashing
(Page 695) status "On".
FlashingEnabled RW - - Specifies whether flashing is activated for the object
(Page 697) in runtime.
FlashingRate (Page 699) RW - - Specifies the flash rate of the border line.
Font - - - -
FontBold (Page 708) RW - - Specifies whether the text is shown in bold.
FontItalic (Page 708) RW - - Specifies whether the text is shown in italics.
FontName (Page 709) RW - - Specifies the font.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 439
VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
FontSize (Page 711) RW - - Specifies the font size of the text.
FontUnderline RW - - Specifies whether the text is shown underlined.
(Page 711)
ForeColor (Page 712) RW RW RW Specifies the font color of the text.
Height (Page 720) RW R R Specifies the height.
HorizontalAlignment RW RW RW Specifies the horizontal alignment of the text.
(Page 736)
Layer (Page 764) R R R Returns the layer in the screen in which an object is
located.
Left (Page 770) RW RW RW Specifies the value of the X coordinate.
LeftMargin - - - -
LineEndShapeStyle RW - - Specifies the shape of the line ends.
(Page 787)
LineWrap - - - -
Location - - - -
Name - - - -
RelativeFillLevel RW - - Specifies the fill percentage for the object.
(Page 881)
ReSizeable - - - -
RightMargin - - - -
RotationAngle RW - - Specifies the angle of rotation in degrees.
(Page 883)
RotationCenterLeft RW - - Specifies the X coordinate of the pivot point for the
(Page 883) object in runtime.
RotationCenterTop RW - - Specifies the Y coordinate of the pivot point for the
(Page 884) object in runtime.
ShowFillLevel RW - - Specifies whether the selected object is filled.
(Page 933)
Size - - - -
TabIndex - - - -
TabIndexAlpha - - - -
Text (Page 1000) RW RW RW Specifies the label for the text field.
TextOrientation RW - - Specifies the text orientation.
(Page 1004)
ToolTipText (Page 1082) RW R R Specifies the tooltip text.
Top (Page 1083) RW RW RW Specifies the value of the Y coordinate.
TopMargin - - - -
Transparency (Page 1087) RW - - Specifies the object transparency in percent.
UseDesignColorSchema RW - - Specifies whether the colors defined in the global col‐
(Page 1148) or scheme of the current design are to be used for this
object.
UseDesignShadowSet‐ RW - - Specifies whether the object is displayed with global
tings (Page 1150) shading.
VerticalAlignment RW RW RW Specifies the vertical alignment of the text in the
(Page 1200) specified object.

WinCC Engineering V18 – Programming reference

440 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Visible (Page 1204) RW RW RW Specifies whether the selected object is visible.
Width (Page 1217) RW R R Specifies the width of the object in pixels.

Table 1-105 Methods

Methods RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Activate (Page 1250) Yes Yes Yes Enables the permanent area or the root screen.
ActivateDynamic Yes - - Dynamically activates a trigger and the specified cycle
(Page 1252) for a property at runtime.
DeactivateDynamic Yes - - Deactivates the trigger of the "ActivateDynamic"
(Page 1259) method used for the specified property in/during run‐
time.

TrendRulerControl

Description

6FUHHQV

6FUHHQ

6FUHHQ,WHPV

6FUHHQ,WHP

Represents the "Value table" object. The TrendRulerControl object is an element of the
ScreenItems list.

Type identifier in VBS

HMITrendRulerControl

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 441
VB scripting
1.5 VBS object model

Example
In the following example, the object with the name "Control1" is moved 16 pixels to the right:

'VBS60
Dim objControl
Set objControl = ScreenItems("Control1")
objControl.Left = objControl.Left + 16

Abbreviation Access in Runtime

R Read
RW Read and write
- No access

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
AllTagTypesAllowed - - - -
ApplyProjectSettingsFor‐ - - - -
DesignMode
AutoCompleteColumns RW - - Specifies whether empty columns are shown if the
(Page 519) control is wider than the configured columns.
AutoCompleteRows RW - - Specifies whether empty rows are shown if the con‐
(Page 519) trol is longer than the number of configured rows.
AutoPosition (Page 520) RW - - Specifies whether the value table is automatically
placed under the object that supplies the value table
with data.
AutoSelectionColors RW - - Specifies whether the colors defined by the system
(Page 521) are used as the selection colors for cells and rows.
AutoSelectionRectColor RW - - Specifies whether the selection frame is shown with
(Page 522) the color defined by the system.
AutoShow (Page 523) RW - - Specifies whether the value table is automatically dis‐
played.
BackColor (Page 526) RW - - Specifies the background color.
BlockAlignment RW - - Specifies the alignment of the text within the column
(Page 549) header of the referenced block.
BlockAutoPrecision RW - - Specifies whether the number of decimal places dis‐
(Page 549) played in the current block is adjusted automatically.
BlockCaption (Page 550) RW - - Specifies the header for the current block.
BlockCount (Page 550) RW - - Sets the number of blocks.
BlockDateFormat RW - - Specifies the date format for the current block.
(Page 551)
BlockExponentialFor‐ RW - - Specifies whether the values in the current block are
mat (Page 551) displayed in exponential notation.
BlockHideText - - - -
BlockHideTitleText RW - - Specifies whether the header of the block is displayed
(Page 552) as a text.

WinCC Engineering V18 – Programming reference

442 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
BlockId (Page 553) RW - - References a block with its block ID.
BlockIndex (Page 553) RW - - References a block.
BlockLength (Page 554) RW - - Specifies the number of characters for the current
block.
BlockName (Page 554) RW - - Specifies the name of the current block.
BlockPrecision RW - - Specifies the number of decimal places in the current
(Page 555) block.
Blocks - - - -
BlockShowDate RW - - Specifies that the date is to be displayed in the current
(Page 555) block.
BlockShowIcon RW - - Specifies whether the content of the current block is
(Page 556) displayed as an icon.
BlockShowTitleIcon RW - - Specifies whether the header of the current block is
(Page 557) shown as an icon.
BlockTimeFormat RW - - Specifies the time format for the current block.
(Page 557)
BlockUseSourceFormat RW - - Specifies whether the format of the connected con‐
(Page 558) trol is used in the current block.
BorderColor (Page 562) RW - - Specifies the line color.
BorderWidth (Page 577) RW - - Specifies the line thickness.
Bounds - - - -
CanBeGrouped - - - -
Caption (Page 587) RW - - Specifies the text to be displayed in the header.
CellCut (Page 591) RW - - Specifies whether the contents of the cells are abbre‐
viated if the cells are too narrow.
CellSpaceBottom RW - - Specifies the bottom margin of the table cells.
(Page 592)
CellSpaceLeft RW - - Specifies the left indent used in the table cells.
(Page 593)
CellSpaceRight RW - - Specifies the right indent used in the table cells.
(Page 593)
CellSpaceTop (Page 594) RW - - Specifies the top margin of the table cells.
Closeable (Page 599) RW - - Specifies whether the object can be closed in runtime.
ColumnAdd (Page 602) RW - - Creates a new column.
ColumnCount RW - - Specifies the number of configured columns.
(Page 605)
ColumnIndex (Page 609) RW - - References a column.
ColumnName RW - - Specifies the name of a column referenced with "Col‐
(Page 612) umnIndex".
ColumnRemove RW - - Removes a column referenced with its name.
(Page 615)
ColumnRepos RW - - For multiple columns, specifies the position of a col‐
(Page 615) umn referenced with "ColumnIndex".
ColumnResize RW - - Specifies whether you can change the width of the
(Page 616) columns.
Columns - - - -

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 443
VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
ColumnScrollbar RW - - Specifies when the horizontal scroll bar is to be dis‐
(Page 617) played.
ColumnSort (Page 620) RW - - Specifies the sorting type of a column referenced
with "ColumnIndex".
ColumnSortIndex RW - - Specifies the sorting order for a column referenced
(Page 621) with "ColumnIndex" in which the columns are sorted
one after another.
ColumnTitleAlignment RW - - Specifies the alignment of the header in a column
(Page 627) referenced with "ColumnIndex".
ColumnTitles (Page 628) RW - - Specifies whether the column header is displayed.
ColumnVisible RW - - Specifies whether the column referenced with "Col‐
(Page 629) umnIndex" is displayed in the object.
ControlDesignMode RW - - Specifies the control design.
(Page 634)
Enabled (Page 660) RW - - Specifies whether the selected object can be operat‐
ed in runtime.
ExportDelimiter - - - -
ExportDirectoryChange‐ RW - - Specifies whether the data export directory can be
able (Page 674) changed in runtime.
ExportDirectoryname RW - - Specifies the target directory for the exported run‐
(Page 675) time data.
ExportFileExtension RW - - Specifies the file extension of the export file.
(Page 675)
ExportFilename RW - - Specifies the name of the target file for the exported
(Page 676) runtime data.
ExportFilenameChange‐ RW - - Specifies whether the export file name can be
able (Page 677) changed in runtime.
ExportFormat - - - -
ExportFormatGuid RW - - Specifies the assignment of ID number and export
(Page 678) provider.
ExportFormatName RW - - Specifies the export file format.
(Page 679)
ExportParameters RW - - Specifies the parameters of the selected format by
(Page 680) means of the properties dialog.
ExportSelection RW - - Specifies which runtime data of the control is expor‐
(Page 681) ted.
ExportShowDialog RW - - Specifies whether the data export dialog is shown in
(Page 681) runtime.
FillPattern - - - -
FillPatternColor - - - -
Font (Page 705) RW - - Specifies the font.
GridLineColor RW - - Specifies the color for the grid lines.
(Page 717)
GridLineWidth RW - - Specifies the width of the separation lines in pixels.
(Page 719)
Height (Page 720) RW - - Specifies the height.

WinCC Engineering V18 – Programming reference

444 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
HorizontalGridLines RW - - Specifies whether horizontal separating lines are dis‐
(Page 737) played.
IconSpace (Page 740) RW - - Specifies the spacing between icons and text in the
table cells.
Layer (Page 764) RW - - Specifies the layer in the screen that contains an ob‐
ject.
Left (Page 770) RW - - Specifies the value of the X coordinate.
LineBackgroundColor - - - -
LineColor (Page 786) RW - - Specifies the color of the window separation lines.
LineStyle - - - -
LineWidth (Page 790) RW - - Specifies the line thickness.
Location - - - -
Moveable (Page 825) RW - - Specifies whether the object can be moved in Run‐
time.
Name - - - -
Object - - - -
OcxGuid - - - -
OcxState - - - -
OcxStateForEs2Rt - - - -
PrintJob (Page 873) RW - - Specifies a print job that is created in the "Reports"
editor.
RowScrollbar (Page 886) RW - - Specifies when the vertical scroll bar is displayed.
RowTitleAlignment RW - - Specifies the type of row header alignment.
(Page 886)
RowTitles (Page 887) RW - - Specifies whether numbered column headers are dis‐
played.
RTPersistence RW - - Specifies whether online configurations are retained
(Page 888) after a screen change.
RTPersistenceAuthoriza‐ RW - - Specifies the authorization required for online config‐
tion (Page 889) uration in runtime.
RTPersistenceType RW - - Specifies how online configurations of WinCC are re‐
(Page 890) tained.
RulerColumns - - - -
RulerType (Page 891) RW - - Specifies the display mode of the value table.
SelectedCellColor RW - - Specifies the background color of the selected cell.
(Page 906)
SelectedCellForeColor RW - - Specifies the font color of the selected cell.
(Page 907)
SelectedRowColor RW - - Specifies the background color of the selected row.
(Page 909)
SelectedRowForeColor RW - - Specifies the font color of the selected row.
(Page 909)
SelectedTitleColor RW - - Specifies the background color of the selected table
(Page 911) header.
SelectedTitleForeColor RW - - Specifies the font color of the selected table header.
(Page 912)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 445
VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
SelectionColoring RW - - Specifies whether selection colors are used for cells or
(Page 914) rows.
SelectionRect (Page 916) RW - - Specifies whether a selection frame is used for the
selected cells or rows.
SelectionRectColor RW - - Specifies the color of the selection rectangle in the
(Page 917) alarm window.
SelectionRectWidth RW - - Specifies the line width of the selection rectangle in
(Page 917) the alarm window if SelectionType equals "1".
SelectionType RW - - Specifies the number of lines you can mark.
(Page 918)
ShareSpaceWithSource‐ RW - - Specifies that the display area of the data source is
Control (Page 924) adapted to the size of the value table.
ShowSortButton RW - - Specifies whether the sorting button is shown above
(Page 941) the vertical scroll bar.
ShowSortIcon RW - - Specifies whether the sorting icon is displayed.
(Page 942)
ShowSortIndex RW - - Specifies whether a sort index is displayed.
(Page 942)
ShowTitle (Page 947) RW - - Specifies the style of the window border and window
title for the object.
Size - - - -
Sizeable (Page 952) RW - - Specifies that the size of an object can be changed in
runtime.
SortSequence RW - - Specifies how the sorting order is changed if the op‐
(Page 954) erator clicks on the column header in runtime.
SourceControl RW - - Specifies the trend or table view to which the value
(Page 955) table is connected.
SourceControlType RW - - Sets the data source type.
(Page 955)
StatisticAreaColumns - - - -
StatisticResultColumns - - - -
StatusbarBackColor RW - - Specifies the background color for status bars.
(Page 959)
StatusbarElementAdd RW - - Creates a new, user-defined status bar element.
(Page 960)
StatusbarElementAuto‐ RW - - Specifies whether the width of a status bar element
Size (Page 961) referenced with "StatusbarElementIndex" is set auto‐
matically.
StatusbarElementCount RW - - Specifies the number of configured status bar ele‐
(Page 962) ments.
StatusbarElementIconId RW - - References a status bar element with its icon ID.
(Page 963)
StatusbarElementID RW - - References a status bar element with its element ID.
(Page 963)
StatusbarElementIndex RW - - References a status bar element.
(Page 964)

WinCC Engineering V18 – Programming reference

446 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
StatusbarElementName RW - - Specifies the name of a status bar element referenced
(Page 965) with "StatusbarElementIndex".
StatusbarElementRe‐ RW - - Removes the user-defined status bar element refer‐
move (Page 966) enced with its name.
StatusbarElementRe‐ RW - - Specifies the new name of a user-defined status bar
name (Page 967) element referenced with "StatusbarElementIndex".
StatusbarElementRepos RW - - Specifies the position of an element referenced with
(Page 968) "StatusbarElementIndex" in the status bar of the ob‐
ject.
StatusbarElements - - - -
(Page 969)
StatusbarElementText RW - - Specifies the text of a user-defined status bar element
(Page 969) referenced with "StatusbarElementIndex".
StatusbarElementTool‐ RW - - Specifies the text for the tooltip of a user-defined sta‐
tipText (Page 970) tus bar element referenced with "StatusbarElemen‐
tIndex".
StatusbarElementUser‐ RW - - Specifies whether the configuration engineer has
Defined (Page 970) 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 971) with "StatusbarElementIndex" is displayed in the ob‐
ject.
StatusbarElementWidth RW - - Specifies the width in pixels of a status bar element
(Page 972) referenced with "StatusbarElementIndex".
StatusbarFont RW - - Specifies the font of the texts in the status bar.
(Page 973)
StatusbarFontColor RW - - Specifies the color of the texts in the status bar.
(Page 974)
StatusbarShowTooltips RW - - Specifies whether tooltips are displayed for the ele‐
(Page 975) ments of the status bar in runtime.
StatusbarText RW - - Specifies the default text in the status bar.
(Page 976)
StatusbarUseBackColor RW - - Specifies whether the background color of the status
(Page 976) bar is shown.
StatusbarVisible RW - - Specifies whether the status bar of the control is dis‐
(Page 977) played.
TabIndex - - - -
TabIndexAlpha - - - -
TableColor (Page 988) RW - - Specifies the background color of the table rows in
the object.
TableColor2 (Page 989) RW - - Specifies the second background color of the table
rows in the object.
TableForeColor RW - - Specifies the text color used in the table cells of the
(Page 990) object.
TableForeColor2 RW - - Specifies the second text color used in the table cells
(Page 991) of the object.
TitleColor (Page 1045) RW - - Specifies the background color of the table header.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 447
VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
TitleCut (Page 1046) 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 1047) for column and row headers in the object table.
TitleForeColor RW - - Specifies the text color for the table column and row
(Page 1047) headers of the object.
TitleGridLineColor RW - - Specifies the color of the separation lines in the title
(Page 1048) bar of the table.
TitleLightShadowColor RW - - Specifies the color for the light side of the 3D shading
(Page 1049) for table column and row headers of the object.
TitleSort (Page 1050) RW - - Specifies how sorting by column header is triggered.
TitleStyle (Page 1051) RW - - Specifies whether to use a shading color for the text
in the column headers.
ToolbarAlignment RW - - Specifies the position of the toolbar.
(Page 1059)
ToolbarBackColor RW - - Specifies the background color of the toolbar.
(Page 1060)
ToolbarButtonActive RW - - Specifies whether the function linked to the button is
(Page 1061) activated in runtime.
ToolbarButtonAdd RW - - Creates a new user-defined button in the object's
(Page 1062) toolbar.
ToolbarButtonAuthoriza‐ RW - - Specifies the authorization for the selected key func‐
tion (Page 1063) tion.
ToolbarButtonBe‐ RW - - Inserts a leading separator (vertical line) for the se‐
ginGroup (Page 1064) lected key function on the toolbar.
ToolbarButtonClick RW - - Clicks a toolbar button.
(Page 1065)
ToolbarButtonCount RW - - Specifies the number of configured buttons in the
(Page 1065) toolbar.
ToolbarButtonEnabled RW - - Specifies whether a user-defined toolbar button can
(Page 1066) be operated.
ToolbarButtonHotKey RW - - Specifies the hot key for the selected object button.
(Page 1067)
ToolbarButtonID RW - - References a button with its ID.
(Page 1068)
ToolbarButtonIndex RW - - References a button.
(Page 1069)
ToolbarButtonLocked RW - - Specifies whether the locked, pressed state of a user-
(Page 1070) defined button referenced with "ToolbarButtonIndex"
is displayed.
ToolbarButtonName RW - - Specifies the name of a user-defined button refer‐
(Page 1071) enced with "ToolbarButtonIndex".
ToolbarButtonRemove RW - - Removes a user-defined button referenced with its
(Page 1071) name.
ToolbarButtonRename RW - - Specifies the new name of a user-defined button ref‐
(Page 1072) erenced with "ToolbarButtonIndex".

WinCC Engineering V18 – Programming reference

448 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
ToolbarButtonRepos RW - - Specifies the position of a button referenced with
(Page 1073) "ToolbarButtonIndex" in the toolbar of the object.
ToolbarButtons - - - -
ToolbarButtonTooltip‐ RW - - Specifies the tooltip text for the user-defined button
Text (Page 1074) in the toolbar.
ToolbarButtonUserDe‐ RW - - Specifies whether the project engineer has added the
fined (Page 1075) toolbar button as new user-defined button.
ToolbarButtonVisible RW - - Specifies whether the button referenced with "Tool‐
(Page 1076) barButtonIndex" is displayed in the toolbar.
ToolbarShowTooltips RW - - Specifies whether the tooltips for the key functions
(Page 1078) are displayed in runtime.
ToolbarUseBackColor RW - - Specifies whether the background color for the tool‐
(Page 1079) bar is shown.
ToolbarUseHotKeys RW - - Specifies whether the hotkeys are activated for but‐
(Page 1080) tons in the toolbar.
ToolbarVisible RW - - Specifies whether the toolbar of the control is dis‐
(Page 1081) played.
Top (Page 1083) RW - - Specifies the value of the Y coordinate.
UseSelectedTitleColor RW - - Specifies whether a selection color is used for the
(Page 1156) headers of selected table cells.
UseSourceBackColors RW - - Specifies the use of the background color of the data
(Page 1156) source.
UseSourceForeColors RW - - Specifies the use of the font color of the data source.
(Page 1157)
UseTableColor2 RW - - Specifies whether a second row color is used for the
(Page 1158) representation of the table.
VerticalGridLines RW - - Specifies whether vertical separation lines are dis‐
(Page 1201) played.
Visible (Page 1204) RW - - Specifies whether the selected object is visible.
Width (Page 1217) RW - - Specifies the width of the object in pixels.

Table 1-106 Methods

Methods RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Activate (Page 1250) Yes - - Enables the permanent area or the root screen.
ActivateDynamic Yes - - Dynamically activates a trigger and the specified cycle
(Page 1252) for a property at runtime.
DeactivateDynamic Yes - - Deactivates the trigger of the "ActivateDynamic"
(Page 1259) method used for the specified property in/during run‐
time.
Export (Page 1263) Yes - - Executes the "Export log" or "Export data" key func‐
tion of the control.
GetRow (Page 1274) Yes - - Returns the row object designated by its row number
in the table-based controls as "ICCAxDataRow" type.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 449
VB scripting
1.5 VBS object model

Methods RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
GetRowCollection Yes - - Returns the list of all row objects of the table-based
(Page 1276) controls as "ICCAxDataRowCollection" type.
GetRulerBlock Yes - - Returns the block object of the evaluation table des‐
(Page 1277) ignated by name or index as "ICCAxRulerBlock" type.
GetRulerBlockCollection Yes - - Returns the list of all block objects of the evaluation
(Page 1278) table as "ICCAxCollection" type.
GetRulerColumn Yes - - Returns the column object of the evaluation table
(Page 1279) designated by name or index as "ICCAxRulerColumn"
type.
GetRulerColumnCollec‐ Yes - - Returns the list of all column objects of the evaluation
tion (Page 1280) table as "ICCAxCollection" type.
GetSelectedRow Yes - - Returns the selected row object of a table-based con‐
(Page 1282) trol as "ICCAxDataRow" type.
GetSelectedRows Yes - - Returns the selected row objects of a table-based
(Page 1283) control as type "ICCAxDataRow" for multiple selec‐
tion.
GetStatisticAreaColumn Yes - - Returns the column object of the statistics area win‐
(Page 1285) dow of the evaluation table designated by name or
index as "ICCAxRulerColumn" type.
GetStatisticAreaColumn‐ Yes - - Returns the list of all column objects of the statistics
Collection (Page 1286) area window of the evaluation table as "ICCAxCollec‐
tion" type.
GetStatisticResultCol‐ Yes - - Returns the column object of the statistics window of
umn (Page 1287) 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 1288) type.
GetStatusbarElement Yes - - Returns the element of the control status bar desig‐
(Page 1289) nated by name or index as "ICCAxStatusbarElement"
type.
GetStatusbarElement‐ Yes - - Returns the list of all status bar elements of the con‐
Collection (Page 1290) trol as "ICCAxCollection" type.
GetToolbarButton Yes - - Returns the control toolbar button function designa‐
(Page 1297) ted by name or index as "ICCAxToolbarButton" type.
GetToolbarButtonCollec‐ Yes - - Returns the list of all button functions of the control
tion (Page 1298) toolbar as "ICCAxCollection" type.
Print (Page 1327) Yes - - Executes the "Print" button function of the control.
SelectAll (Page 1342) Yes - - Selects all rows in a table-based control.
SelectRow (Page 1343) Yes - - Selects a specific row in a table-based control.
ShowHelp (Page 1348) Yes - - Executes the "Help" button function of the control.
ShowPropertyDialog Yes - - Executes the "Configuration dialog" button function
(Page 1352) of the control.
UnselectAll (Page 1361) Yes - - Removes all selections from the cells of a table-based
control.
UnselectRow (Page 1361) Yes - - Removes the selections from a specific cell of a table-
based control.

WinCC Engineering V18 – Programming reference

450 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

TrendView

Description

6FUHHQV

6FUHHQ

6FUHHQ,WHPV

6FUHHQ,WHP

Represents the "TrendView" object. The TrendView object is an element of the ScreenItems
list.

Type identifier in VBS

HMITrendView

Abbreviation Access in runtime

R Read
RW Read and write
- No access

Table 1-107 Properties

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
AllTagTypesAllowed - - - -
Authorization - RW RW Specifies the operating rights of the selected object in
(Page 517) runtime.
AxisXBunchCount - - - -
AxisXMarkCount - - - -
AxisXNoOfDigits - - - -
AxisXShowBunchValues - - - -

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 451
VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
AxisXStyle - - - -
AxisY1BunchCount - - - -
AxisY1MarkCount - - - -
AxisY1ShowBunchVal‐ - - - -
ues
AxisY2BunchCount - - - -
AxisY2MarkCount - - - -
AxisY2ShowBunchVal‐ - - - -
ues
BackColor - - - -
BorderBackColor - - - -
BorderColor - - - -
BorderWidth - - - -
Bounds - - - -
ButtonBackColor - - - -
ButtonBackFillStyle - - - -
ButtonBarHeight - - - -
ButtonBorderBackColor - - - -
ButtonBorderColor - - - -
ButtonBorderWidth - - - -
ButtonCornerRadius - - - -
ButtonEdgeStyle - - - -
ButtonFirstGradientCol‐ - - - -
or
ButtonFirstGradientOff‐ - - - -
set
ButtonMiddleGradient‐ - - - -
Color
ButtonPositions - - - -
ButtonSecondGradient‐ - - - -
Color
ButtonSecondGradien‐ - - - -
tOffset
CanBeGrouped - - - -
ColumnOrder - - - -
ColumnsMoveable - - - -
ColumnTextDateTime - - - -
ColumnTextTagConnec‐ - - - -
tion
ColumnTextTrend - - - -
ColumnTextValue - - - -
ColumnTextXValue - - - -
ColumnWidth - - - -
CornerRadius - - - -

WinCC Engineering V18 – Programming reference

452 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
CountVisibleItems - - - -
Curves - - - -
DeviceStyle - - - -
DiagramAreaHeight - - - -
DiagramAreaLeft - - - -
DiagramAreaTop - - - -
DiagramAreaWidth - - - -
EdgeStyle - - - -
Enabled (Page 660) - RW RW Specifies whether the selected object can be operat‐
ed in runtime.
EnableNavigateButtons - - - -
EnableNavigateKeys - - - -
ES2RT_ColumnOrder - - - -
ES2RT_ColumnWidth - - - -
FitToSize - - - -
Flashing - - - -
FocusColor (Page 703) - RW RW Specifies the color for the focus frame of the selected
object when it is in focus.
FocusWidth (Page 704) - RW RW Specifies the border width of the specified object
when the object is in focus.
Font - - - -
GridlineAxis - - - -
GridlineColor - - - -
GridlineEnabled - - - -
GridlineFillColor - - - -
GridlineStyle - - - -
Height - R R Specifies the height.
HelpText (Page 724) - RW RW Specifies the tooltip that is shown in runtime as user
help for the specified object.
IsRunningUnderCE - - - -
Layer (Page 764) - RW RW Specifies the layer in the screen that contains an ob‐
ject.
Left (Page 770) - RW RW Specifies the value of the X coordinate of the selected
object.
Location - - - -
Look3D - - - -
MaxNrOfCurves - - - -
MinNrOfCurves - - - -
Name - - - -
PaddingBottom - - - -
PaddingLeft - - - -
PaddingRight - - - -
PaddingTop - - - -

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 453
VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
RulerColor (Page 890) - RW RW Defines the color of the scale gradation (help line) of
the axis label in the specified object.
ScaleColor (Page 892) - RW RW Specifies the color of the scale of the selected object.
SelectionBackColor - - - -
SelectionForeColor - - - -
ShowRuler (Page 938) - 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 - - - -
TabIndexAlpha - - - -
TableBackColor - RW RW Specifies the background color of the table cells for
(Page 987) the selected object.
TableColumnsWid‐ - - - -
thAndOrder
TableEvenRowBackColor - - - -
TableFont - - - -
TableGridLineColor - R R Returns the color of the gridlines in the table of the
(Page 992) selected object.
TableHeaderBackColor - R R Returns the background color in the header of the
(Page 993) table of the selected object.
TableHeaderBackFill‐ - - - -
Style
TableHeaderBorderBack‐ - - - -
Color
TableHeaderBorderColor - - - -
TableHeaderBorder‐ - - - -
Width
TableHeaderCornerRa‐ - - - -
dius
TableHeaderEdgeStyle - - - -
TableHeaderFirstGra‐ - - - -
dientColor
TableHeaderFirstGra‐ - - - -
dientOffset

WinCC Engineering V18 – Programming reference

454 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
TableHeaderFont - - - -
TableHeaderForeColor - R R Returns the text color in the header of the table of the
(Page 995) selected object.
TableHeaderMiddleGra‐ - - - -
dientColor
TableHeaderPaddingBot‐ - - - -
tom
TableHeaderPaddingLeft - - - -
TableHeaderPadding‐ - - - -
Right
TableHeaderPaddingTop - - - -
TableHeaderSecondGra‐ - - - -
dientColor
TableHeaderSecondGra‐ - - - -
dientOffset
TagForExternalTime - - - -
TimeAxisBegin - - - -
TimeAxisBeginTime - - - -
TimeAxisCountPoints - - - -
TimeAxisEnd - - - -
TimeAxisMode - - - -
TimeAxisRange - - - -
TimeAxisSide - - - -
TimeAxisTimeRange - - - -
ToolbarButtons - - - -
ToolbarButtonsForMi‐ - - - -
gration
ToolbarEnabled - - - -
ToolbarHeight - - - -
ToolbarLeft - - - -
ToolbarStyle - - - -
ToolbarTop - - - -
ToolbarWidth - - - -
Top (Page 1083) - R R Returns the value of the Y coordinate of the selected
object.
TrendsForPrinting - - - -
UseButtonFirstGradient - - - -
UseButtonSecondGradi‐ - - - -
ent
UseDesignColorSchema - - - -
UseTableHeaderFirst‐ - - - -
Gradient
UseTableHeaderSecond‐ - - - -
Gradient

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 455
VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
ValueAxis1AutoRange - - - -
ValueAxis1Begin - - - -
ValueAxis1End - - - -
ValueAxis1LabelLength - - - -
ValueAxis1Style - - - -
ValueAxis2AutoRange - - - -
ValueAxis2Begin - - - -
ValueAxis2End - - - -
ValueAxis2LabelLength - - - -
ValueAxis2Style - - - -
ValueTableHeight - - - -
ValueTableLeft - - - -
ValueTableTop - - - -
ValueTableWidth - - - -
ValueY1HlpLine - - - -
ValueY2HlpLine - - - -
Visible (Page 1204) - R R Specifies whether the selected object is visible.
Width - R R Specifies the width.

Table 1-108 Methods

Methods RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Activate (Page 1250) - Yes Yes Enables the permanent area or the root screen.

See also
Height (Page 720)
Width (Page 1217)

WinCC Engineering V18 – Programming reference

456 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

TubeArcObject

Description

6FUHHQV

6FUHHQ

6FUHHQ,WHPV

6FUHHQ,WHP

Represents the "TubeArc" object. The TubeArcObject is an element of the ScreenItems list.

Type identifier in VBS

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

Abbreviation Access in runtime

R Read
RW Read and write
- No access

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 457
VB scripting
1.5 VBS object model

Table 1-109 Properties

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
AllTagTypesAllowed - - - -
Authorization RW - - Specifies operating rights.
(Page 517)
BackColor - - - -
Bounds - - - -
CanBeGrouped - - - -
Color (Page 600) RW - - Specifies the line color.
CornerStyle - - - -
DrawInsideFrame - - - -
Enabled (Page 660) RW - - Specifies whether the selected object can be operat‐
ed in runtime.
EndAngle (Page 666) RW - - Specifies the angle at which the end point of the se‐
lected object deviates from the zero position (0°).
Flashing - - - -
FlashingColorOff - - - -
FlashingColorOn - - - -
FlashingEnabled - - - -
FlashingRate - - - -
Height (Page 720) RW - - Specifies the height.
Layer (Page 764) RW - - Specifies the layer in the screen that contains an ob‐
ject.
Left (Page 770) RW - - Specifies the value of the X coordinate.
LineEndShapeStyle - - - -
LineWidth (Page 790) RW - - Specifies the line thickness.
Location - - - -
Name - - - -
RadiusHeight RW - - Specifies the secondary axis.
(Page 876)
RadiusWidth (Page 877) RW - - Specifies the main axis.
Size - - - -
StartAngle (Page 956) RW - - Specifies the angle by which the start point deviates
from the zero position (0°).
TabIndex - - - -
TabIndexAlpha - - - -
ToolTipText (Page 1082) RW - - Specifies the tooltip text.
Top (Page 1083) RW - - Specifies the value of the Y coordinate.
Transparency RW - - Specifies the object transparency in percent.
(Page 1087)
UseDesignColorSchema RW - - Specifies whether the colors defined in the global col‐
(Page 1148) or scheme of the current design are to be used for this
object.
UseDesignShadowSet‐ RW - - Specifies whether the object is displayed with global
tings (Page 1150) shading.

WinCC Engineering V18 – Programming reference

458 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Visible (Page 1204) RW - - Specifies whether the selected object is visible.
Width (Page 1217) RW - - Specifies the width of the object in pixels.

Table 1-110 Methods

Methods RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Activate (Page 1250) Yes - - Enables the permanent area or the root screen.
ActivateDynamic Yes - - Dynamically activates a trigger and the specified cycle
(Page 1252) for a property at runtime.
DeactivateDynamic Yes - - Deactivates the trigger of the "ActivateDynamic"
(Page 1259) method used for the specified property in/during run‐
time.

TubeDoubleTeeObject

Description

6FUHHQV

6FUHHQ

6FUHHQ,WHPV

6FUHHQ,WHP

Represents the "DoubleTee" object. The TubeDoubleTeeObject is an element of the

ScreenItems list.

Type identifier in VBS

HMITubeDoubleTeeObject

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 459
VB scripting
1.5 VBS object model

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

Abbreviation Access in runtime

R Read
RW Read and write
- No access

Table 1-111 Properties

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
AllTagTypesAllowed - - - -
Authorization RW - - Specifies operating rights.
(Page 517)
Bounds - - - -
CanBeGrouped - - - -
Color (Page 600) RW - - Specifies the line color.
Enabled (Page 660) RW - - Specifies whether the selected object can be operat‐
ed in runtime.
Height (Page 720) RW - - Specifies the height.
Layer (Page 764) RW - - Specifies the layer in the screen that contains an ob‐
ject.
Left (Page 770) RW - - Specifies the value of the X coordinate.
LineWidth (Page 790) RW - - Specifies the line thickness.
Location - - - -
Name - - - -
Size - - - -
TabIndex - - - -
TabIndexAlpha - - - -
ToolTipText (Page 1082) RW - - Specifies the tooltip text.
Top (Page 1083) RW - - Specifies the value of the Y coordinate.
Transparency RW - - Specifies the object transparency in percent.
(Page 1087)
UseDesignColorSchema RW - - Specifies whether the colors defined in the global col‐
(Page 1148) or scheme of the current design are to be used for this
object.

WinCC Engineering V18 – Programming reference

460 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
UseDesignShadowSet‐ RW - - Specifies whether the object is displayed with global
tings (Page 1150) shading.
Visible (Page 1204) RW - - Specifies whether the selected object is visible.
Width (Page 1217) RW - - Specifies the width of the object in pixels.

Table 1-112 Methods

Methods RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Activate (Page 1250) Yes - - Enables the permanent area or the root screen.
ActivateDynamic Yes - - Dynamically activates a trigger and the specified cycle
(Page 1252) for a property at runtime.
DeactivateDynamic Yes - - Deactivates the trigger of the "ActivateDynamic"
(Page 1259) method used for the specified property in/during run‐
time.

TubePolyline

Description

6FUHHQV

6FUHHQ

6FUHHQ,WHPV

6FUHHQ,WHP

Represents the "Pipe" object. The TubePolyline object is an element of the ScreenItems list.

Type identifier in VBS

HMITubePolyline

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 461
VB scripting
1.5 VBS object model

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

Abbreviation Access in runtime

R Read
RW Read and write
- No access

Table 1-113 Properties

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
ActualPointIndex RW - - Specifies the number of the current corner point.
(Page 496)
ActualPointLeft RW - - Specifies the X coordinate of the current corner point
(Page 496) with reference to the screen origin.
ActualPointTop RW - - Specifies the Y coordinate of the current corner point
(Page 497) with reference to the screen origin.
AllTagTypesAllowed - - - -
Authorization RW - - Specifies operating rights.
(Page 517)
Bounds - - - -
CanBeGrouped - - - -
Color (Page 600) RW - - Specifies the line color.
CornerStyle (Page 635) RW - - Specifies the shape of the corners.
DeviceStyle - - - -
Enabled (Page 660) RW - - Specifies whether the selected object can be operat‐
ed in runtime.
Height (Page 720) RW - - Specifies the height.
Layer (Page 764) RW - - Specifies the layer in the screen that contains an ob‐
ject.
Left (Page 770) RW - - Specifies the value of the X coordinate.
LineWidth (Page 790) RW - - Specifies the line thickness.
Location - - - -
Name - - - -
Points - - - -
PointsCount (Page 870) RW - - Specifies the number of corner points of the polyline
or of the polygon.

WinCC Engineering V18 – Programming reference

462 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Size - - - -
TabIndex - - - -
TabIndexAlpha - - - -
ToolTipText (Page 1082) RW - - Specifies the tooltip text.
Top (Page 1083) RW - - Specifies the value of the Y coordinate.
Transparency RW - - Specifies the object transparency in percent.
(Page 1087)
UseDesignColorSchema RW - - Specifies whether the colors defined in the global col‐
(Page 1148) or scheme of the current design are to be used for this
object.
UseDesignShadowSet‐ RW - - Specifies whether the object is displayed with global
tings (Page 1150) shading.
Visible (Page 1204) RW - - Specifies whether the selected object is visible.
Width (Page 1217) RW - - Specifies the width of the object in pixels.

Table 1-114 Methods

Methods RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Activate (Page 1250) Yes - - Enables the permanent area or the root screen.
ActivateDynamic Yes - - Dynamically activates a trigger and the specified cycle
(Page 1252) for a property at runtime.
DeactivateDynamic Yes - - Deactivates the trigger of the "ActivateDynamic"
(Page 1259) method used for the specified property in/during run‐
time.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 463
VB scripting
1.5 VBS object model

TubeTeeObject

Description

6FUHHQV

6FUHHQ

6FUHHQ,WHPV

6FUHHQ,WHP

Represents the "Tee" object. The TubeTeeObject is an element of the ScreenItems list.

Type identifier in VBS

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

Abbreviation Access in runtime

R Read
RW Read and write
- No access

WinCC Engineering V18 – Programming reference

464 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Table 1-115 Properties

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
AllTagTypesAllowed - - - -
Authorization RW - - Specifies operating rights.
(Page 517)
Bounds - - - -
CanBeGrouped - - - -
Color (Page 600) RW - - Specifies the line color.
Enabled (Page 660) RW - - Specifies whether the selected object can be operat‐
ed in runtime.
Height (Page 720) RW - - Specifies the height.
Layer (Page 764) RW - - Specifies the layer in the screen that contains an ob‐
ject.
Left (Page 770) RW - - Specifies the value of the X coordinate.
LineWidth (Page 790) RW - - Specifies the line thickness.
Location - - - -
Name - - - -
RotationAngle RW - - Specifies the angle of rotation in degrees.
(Page 883)
Size - - - -
TabIndex - - - -
TabIndexAlpha - - - -
ToolTipText (Page 1082) RW - - Specifies the tooltip text.
Top (Page 1083) RW - - Specifies the value of the Y coordinate.
Transparency RW - - Specifies the object transparency in percent.
(Page 1087)
UseDesignColorSchema RW - - Specifies whether the colors defined in the global col‐
(Page 1148) or scheme of the current design are to be used for this
object.
UseDesignShadowSet‐ RW - - Specifies whether the object is displayed with global
tings (Page 1150) shading.
Visible (Page 1204) RW - - Specifies whether the selected object is visible.
Width (Page 1217) RW - - Specifies the width of the object in pixels.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 465
VB scripting
1.5 VBS object model

Table 1-116 Methods

Methods RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Activate (Page 1250) Yes - - Enables the permanent area or the root screen.
ActivateDynamic Yes - - Dynamically activates a trigger and the specified cycle
(Page 1252) for a property at runtime.
DeactivateDynamic Yes - - Deactivates the trigger of the "ActivateDynamic"
(Page 1259) method used for the specified property in/during run‐
time.

UserArchiveControl

Description

6FUHHQV

6FUHHQ

6FUHHQ,WHPV

6FUHHQ,WHP

Displays the "Recipe view" object. The UserArchiveControl object is an element of the
ScreenItems list.

Type identifier in VBS

HMIUserArchiveControl

Abbreviation Access in Runtime

R Read
RW Read and write
- No access

WinCC Engineering V18 – Programming reference

466 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Table 1-117 Properties

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
AllTagTypesAllowed - - - -
ApplyProjectSet‐ - - - -
tingsForDesign‐
Mode
ArchiveName RW - - Sets the log name.
(Page 513)
ArchiveType RW - - Sets the log type.
(Page 514)
AutoCompleteCol‐ RW - - Specifies whether empty columns are
umns (Page 519) shown if the control is wider than the con‐
figured columns.
AutoCompleteRows RW - - Specifies whether empty rows are shown if
(Page 519) the control is longer than the number of
configured rows.
AutoSelectionCol‐ RW - - Specifies whether the colors defined by the
ors (Page 521) system are used as the selection colors for
cells and rows.
AutoSelectionRect‐ RW - - Specifies whether the selection frame is
Color (Page 522) shown with the color defined by the system.
BackColor RW - - Specifies the background color.
(Page 526)
Blocks - - - -
BorderColor RW - - Specifies the line color.
(Page 562)
BorderWidth RW - - Specifies the line thickness.
(Page 577)
Bounds - - - -
CanBeGrouped - - - -
Caption (Page 587) RW - - Specifies the text to be displayed in the
header.
CellCut - - - -
CellSpaceBottom RW - - Specifies the bottom margin of the table
(Page 592) cells.
CellSpaceLeft RW - - Specifies the left indent used in the table
(Page 593) cells.
CellSpaceRight RW - - Specifies the right indent used in the table
(Page 593) cells.
CellSpaceTop RW - - Specifies the top margin of the table cells.
(Page 594)
Closeable RW - - Specifies whether the object can be closed
(Page 599) in runtime.
ColumnAlias RW - - Specifies the display name of the column
(Page 602) referenced with "ColumnIndex".
ColumnAlignment RW - - Specifies the alignment of the column con‐
(Page 603) tent in a column referenced with "Colum‐
nIndex".

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 467
VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

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

WinCC Engineering V18 – Programming reference

468 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
ColumnReadonly RW - - Specifies whether the values of a column
(Page 614) referenced with "ColumnIndex" can only be
read.
ColumnRepos RW - - For multiple columns, specifies the position
(Page 615) of a column referenced with "ColumnIn‐
dex".
ColumnResize RW - - Specifies whether you can change the width
(Page 616) of the columns.
Columns - - - -
ColumnScrollbar RW - - Specifies when the horizontal scroll bar is to
(Page 617) be displayed.
ColumnShowDate RW - - Specifies whether the date is to be displayed
(Page 618) in a column referenced with "ColumnIndex".
ColumnShowIcon RW - - Specifies whether a symbol is to be dis‐
(Page 619) played in a column referenced with "Colum‐
nIndex".
ColumnShowTitleI‐ RW - - Specifies whether a symbol is to be dis‐
con (Page 619) played in a column referenced with "Colum‐
nIndex".
ColumnSort RW - - Specifies the sorting type of a column refer‐
(Page 620) enced with "ColumnIndex".
ColumnSortIndex RW - - Specifies the sorting order for a column ref‐
(Page 621) erenced with "ColumnIndex" in which the
columns are sorted one after another.
ColumnStartValue RW - - Specifies the start value defined in the user
(Page 621) archive of a column referenced with "Col‐
umnIndex".
ColumnStrin‐ RW - - Specifies the string length defined in the
gLength (Page 622) user archive for a column referenced with
"ColumnIndex".
ColumnTimeFor‐ RW - - Specifies the time format for a column ref‐
mat (Page 626) erenced with "ColumnIndex".
ColumnTitleAlign‐ RW - - Specifies the alignment of the header in a
ment (Page 627) column referenced with "ColumnIndex".
ColumnTitles RW - - Specifies whether the column header is dis‐
(Page 628) played.
ColumnType RW - - Specifies the data type defined in the user
(Page 628) archive of a column referenced with "Col‐
umnIndex".
ColumnVisible RW - - Specifies whether the column referenced
(Page 629) with "ColumnIndex" is displayed in the ob‐
ject.
ColumnWriteAccess RW - - Specifies the write access authorization de‐
(Page 630) fined in the user archive for a column refer‐
enced with "ColumnIndex".
ControlDesign‐ RW - - Specifies the control design.
Mode (Page 634)
DataProviderGuid R - - Determines the GUID of the control.
(Page 643)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 469
VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
DataSource - - - -
DefaultFilterEom - - - -
Enabled - - - -
EnableDelete RW - - Specifies whether data can be deleted in
(Page 664) runtime.
EnableEdit RW - - Specifies whether the data shown can be
(Page 664) edited in runtime.
EnableInsert RW - - Specifies whether data can be inserted in
(Page 665) runtime.
ExportDelimiter - - - -
ExportDirectory‐ RW - - Specifies whether the data export directory
Changeable can be changed in runtime.
(Page 674)
ExportDirectory‐ RW - - Specifies the target directory for the expor‐
name (Page 675) ted runtime data.
ExportFileExten‐ RW - - Specifies the file extension of the export file.
sion (Page 675)
ExportFilename RW - - Specifies the name of the target file for the
(Page 676) exported runtime data.
ExportFilename‐ RW - - Specifies whether the export file name can
Changeable be changed in runtime.
(Page 677)
ExportFormat - - - -
ExportFormatGuid RW - - Specifies the assignment of ID number and
(Page 678) export provider.
ExportFormatName RW - - Specifies the export file format.
(Page 679)
ExportParameters RW - - Specifies the parameters of the selected for‐
(Page 680) mat by means of the properties dialog.
ExportSelection RW - - Specifies which runtime data of the control
(Page 681) is exported.
ExportShowDialog RW - - Specifies whether the data export dialog is
(Page 681) shown in runtime.
FillPattern - - - -
FillPatternColor - - - -
Filter - - - -
FilterSQL RW - - Sets an SQL statement for the filter criterion.
(Page 688)
Font (Page 705) RW - - Specifies the font.
GridLineColor RW - - Specifies the color for the grid lines.
(Page 717)
GridLineWidth RW - - Specifies the width of the separation lines in
(Page 719) pixels.
Height (Page 720) RW - - Specifies the height.
HorizontalGrid‐ RW - - Specifies whether horizontal separating
Lines (Page 737) lines are displayed.

WinCC Engineering V18 – Programming reference

470 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
IconSpace RW - - Specifies the spacing between icons and
(Page 740) text in the table cells.
Layer - - - -
Left (Page 770) RW - - Specifies the value of the X coordinate.
LineBackgroundCol‐ - - - -
or
LineColor RW - - Specifies the color of the window separa‐
(Page 786) tion lines.
LineStyle - - - -
LineWidth RW - - Specifies the line thickness.
(Page 790)
Location - - - -
Moveable RW - - Specifies whether the object can be moved
(Page 825) in runtime.
Name - - - -
Object - - - -
OcxGuid - - - -
OcxState - - - -
OcxStateForEs2Rt - - - -
PrintJob (Page 873) RW - - Specifies a print job that is created in the
"Reports" editor.
RowScrollbar RW - - Specifies when the vertical scroll bar is dis‐
(Page 886) played.
RowTitleAlignment RW - - Specifies the type of row header alignment.
(Page 886)
RowTitles RW - - Specifies whether numbered column head‐
(Page 887) ers are displayed.
RTPersistence RW - - Specifies whether online configurations are
(Page 888) retained after a screen change.
RTPersistenceAu‐ RW - - Specifies the authorization required for on‐
thorization line configuration in runtime.
(Page 889)
RTPersistenceType RW - - Specifies how online configurations of
(Page 890) WinCC are retained.
SelectArchiveName RW - - Specifies that the selection dialog for the
(Page 904) data source of the recipe view is displayed
initially in Runtime.
SelectedCellColor RW - - Specifies the background color of the selec‐
(Page 906) ted cell.
SelectedCellFore‐ RW - - Specifies the font color of the selected cell.
Color (Page 907)
SelectedID RW - - Specifies the ID of the data record selected
(Page 907) in the recipe view.
SelectedRowColor RW - - Specifies the background color of the selec‐
(Page 909) ted row.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 471
VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
SelectedRowFore‐ RW - - Specifies the font color of the selected row.
Color (Page 909)
SelectedTitleColor RW - - Specifies the background color of the selec‐
(Page 911) ted table header.
SelectedTitleFore‐ RW - - Specifies the font color of the selected table
Color (Page 912) header.
SelectionColoring RW - - Specifies whether selection colors are used
(Page 914) for cells or rows.
SelectionRect RW - - Specifies whether a selection frame is used
(Page 916) for the selected cells or rows.
SelectionRectColor RW - - Specifies the color of the selection rectangle
(Page 917) in the alarm window.
SelectionRectWidth RW - - Specifies the line width of the selection rec‐
(Page 917) tangle in the alarm window if SelectionType
equals "1".
SelectionType RW - - Specifies the number of lines you can mark.
(Page 918)
ShowSortButton RW - - Specifies whether the sorting button is
(Page 941) shown above the vertical scroll bar.
ShowSortIcon RW - - Specifies whether the sorting icon is dis‐
(Page 942) played.
ShowSortIndex RW - - Specifies whether a sort index is displayed.
(Page 942)
ShowTitle RW - - Specifies the style of the window border
(Page 947) and window title for the object.
Size - - - -
Sizeable (Page 952) RW - - Specifies that the size of an object can be
changed in runtime.
SortSequence RW - - Specifies how the sorting order is changed if
(Page 954) the operator clicks on the column header in
runtime.
StatusbarBackColor RW - - Specifies the background color for status
(Page 959) bars.
StatusbarElemen‐ RW - - Creates a new, user-defined status bar ele‐
tAdd (Page 960) ment.
StatusbarElemen‐ RW - - Specifies whether the width of a status bar
tAutoSize element referenced with "StatusbarElemen‐
(Page 961) tIndex" is set automatically.
StatusbarElement‐ RW - - Specifies the number of configured status
Count (Page 962) bar elements.
StatusbarElementI‐ RW - - References a status bar element with its
conId (Page 963) icon ID.
StatusbarElemen‐ RW - - References a status bar element with its el‐
tID (Page 963) ement ID.
StatusbarElemen‐ RW - - References a status bar element.
tIndex (Page 964)
StatusbarElement‐ RW - - Specifies the name of a status bar element
Name (Page 965) referenced with "StatusbarElementIndex".

WinCC Engineering V18 – Programming reference

472 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
StatusbarElemen‐ RW - - Removes the user-defined status bar ele‐
tRemove (Page 966) ment referenced with its name.
StatusbarElemen‐ RW - - Specifies the new name of a user-defined
tRename (Page 967) status bar element referenced with "Status‐
barElementIndex".
StatusbarElemen‐ RW - - Specifies the position of an element refer‐
tRepos (Page 968) enced with "StatusbarElementIndex" in the
status bar of the object.
StatusbarElements - - - -
StatusbarElement‐ RW - - Specifies the text of a user-defined status
Text (Page 969) bar element referenced with "StatusbarEle‐
mentIndex".
StatusbarElement‐ RW - - Specifies the text for the tooltip of a user-
TooltipText defined status bar element referenced with
(Page 970) "StatusbarElementIndex".
StatusbarElementU‐ RW - - Specifies whether the configuration engi‐
serDefined neer has added a status bar element refer‐
(Page 970) enced with "StatusbarElementIndex" as a
new user-defined element.
StatusbarElement‐ RW - - Specifies whether the status bar element
Visible (Page 971) referenced with "StatusbarElementIndex" is
displayed in the object.
StatusbarElement‐ RW - - Specifies the width in pixels of a status bar
Width (Page 972) element referenced with "StatusbarElemen‐
tIndex".
StatusbarFont RW - - Specifies the font of the texts in the status
(Page 973) bar.
StatusbarFontColor RW - - Specifies the color of the texts in the status
(Page 974) bar.
StatusbarShowTool‐ RW - - Specifies whether tooltips are displayed for
tips (Page 975) the elements of the status bar in runtime.
StatusbarText RW - - Specifies the default text in the status bar.
(Page 976)
StatusbarUseBack‐ RW - - Specifies whether the background color of
Color (Page 976) the status bar is shown.
StatusbarVisible RW - - Specifies whether the status bar of the con‐
(Page 977) trol is displayed.
TabIndex - - - -
TabIndexAlpha - - - -
TableColor RW - - Specifies the background color of the table
(Page 988) rows in the object.
TableColor2 RW - - Specifies the second background color of
(Page 989) the table rows in the object.
TableForeColor RW - - Specifies the text color used in the table
(Page 990) cells of the object.
TableForeColor2 RW - - Specifies the second text color used in the
(Page 991) table cells of the object.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 473
VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
TimeBase RW - - Specifies the time zone in which the time
(Page 1024) values are displayed.
TitleColor RW - - Specifies the background color of the table
(Page 1045) header.
TitleCut (Page 1046) RW - - Specifies whether the content of the fields
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 3D
Color (Page 1047) shading for column and row headers in the
object table.
TitleForeColor RW - - Specifies the text color for the table column
(Page 1047) and row headers of the object.
TitleGridLineColor RW - - Specifies the color of the separation lines in
(Page 1048) the title bar of the table.
TitleLightShadow‐ RW - - Specifies the color for the light side of the
Color (Page 1049) 3D shading for table column and row head‐
ers of the object.
TitleSort (Page 1050) RW - - Specifies how sorting by column header is
triggered.
TitleStyle RW - - Specifies whether to use a shading color for
(Page 1051) the text in the column headers.
ToolbarAlignment RW - - Specifies the position of the toolbar.
(Page 1059)
ToolbarBackColor RW - - Specifies the background color of the tool‐
(Page 1060) bar.
ToolbarButtonAc‐ RW - - Specifies whether the function linked to the
tive (Page 1061) button is activated in runtime.
ToolbarButtonAdd RW - - Creates a new user-defined button in the
(Page 1062) object's toolbar.
ToolbarButtonAu‐ RW - - Specifies the authorization for the selected
thorization key function.
(Page 1063)
ToolbarButtonBe‐ RW - - Inserts a leading separator (vertical line) for
ginGroup the selected key function on the toolbar.
(Page 1064)
ToolbarButtonClick RW - - Clicks a toolbar button.
(Page 1065)
ToolbarButton‐ RW - - Specifies the number of configured buttons
Count (Page 1065) in the toolbar.
ToolbarButtonEna‐ RW - - Specifies whether a user-defined toolbar
bled (Page 1066) button can be operated.
ToolbarButtonHot‐ RW - - Specifies the hot key for the selected object
Key (Page 1067) button.
ToolbarButtonID RW - - References a button with its ID.
(Page 1068)
ToolbarButtonIndex RW - - References a button.
(Page 1069)

WinCC Engineering V18 – Programming reference

474 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
ToolbarButton‐ RW - - Specifies whether the locked, pressed state
Locked (Page 1070) of a user-defined button referenced with
"ToolbarButtonIndex" is displayed.
ToolbarButton‐ RW - - Specifies the name of a user-defined button
Name (Page 1071) referenced with "ToolbarButtonIndex".
ToolbarButtonRe‐ RW - - Removes a user-defined button referenced
move (Page 1071) with its name.
ToolbarButtonRe‐ RW - - Specifies the new name of a user-defined
name (Page 1072) button referenced with "ToolbarButtonIn‐
dex".
ToolbarButtonRe‐ RW - - Specifies the position of a button refer‐
pos (Page 1073) enced with "ToolbarButtonIndex" in the
toolbar of the object.
ToolbarButtons - - - -
ToolbarButtonTool‐ RW - - Specifies the tooltip text for the user-de‐
tipText (Page 1074) fined button in the toolbar.
ToolbarButtonUser‐ RW - - Specifies whether the project engineer has
Defined (Page 1075) added the toolbar button as new user-de‐
fined button.
ToolbarButtonVisi‐ RW - - Specifies whether the button referenced
ble (Page 1076) with "ToolbarButtonIndex" is displayed in
the toolbar.
ToolbarShowTool‐ RW - - Specifies whether the tooltips for the key
tips (Page 1078) functions are displayed in runtime.
ToolbarUseBackCol‐ RW - - Specifies whether the background color for
or (Page 1079) the toolbar is shown.
ToolbarUseHotKeys RW - - Specifies whether the hotkeys are activated
(Page 1080) for buttons in the toolbar.
ToolbarVisible RW - - Specifies whether the toolbar of the control
(Page 1081) is displayed.
Top (Page 1083) RW - - Specifies the value of the Y coordinate.
UseSelectedTitle‐ RW - - Specifies whether a selection color is used
Color (Page 1156) for the headers of selected table cells.
UseTableColor2 RW - - Specifies whether a second row color is
(Page 1158) used for the representation of the table.
VerticalGridLines RW - - Specifies whether vertical separation lines
(Page 1201) are displayed.
Visible (Page 1204) RW - - Specifies whether the selected object is visi‐
ble.
Width (Page 1217) RW - - Specifies the width of the object in pixels.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 475
VB scripting
1.5 VBS object model

Table 1-118 Methods

Methods RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Activate (Page 1250) Yes - - Enables the permanent area or the root screen.
ActivateDynamic Yes - - Dynamically activates a trigger and the specified cycle
(Page 1252) for a property with VBScript during runtime.
CopyRows (Page 1257) Yes - - Executes the "Copy lines" key function of the control.
CutRows (Page 1259) Yes - - Executes the "Cut rows" key function of the recipe
view.
DeactivateDynamic Yes - - Deactivates the trigger of the "ActivateDynamic"
(Page 1259) method used for the specified property in/during run‐
time.
DeleteRows (Page 1261) Yes - - Executes the "Delete rows" key function of the recipe
view.
Export (Page 1263) Yes - - Executes the "Export log" or "Export data" key func‐
tion of the control.
GetColumn (Page 1263) Yes - - Returns the column object of the recipe view desig‐
nated by name or index as "ICCAxUAColumn" type.
GetColumnCollection Yes - - Returns the list of all column objects of the recipe
(Page 1264) view as "ICCAxCollection" type.
GetRow (Page 1274) Yes - - Returns the row object designated 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 1276) controls as "ICCAxDataRowCollection" type.
GetSelectedRow Yes - - Returns the selected row object of a table-based con‐
(Page 1282) trol as "ICCAxDataRow" type.
GetSelectedRows Yes - - Returns the selected row objects of a table-based
(Page 1283) control as type "ICCAxDataRow" for multiple selec‐
tion.
GetStatusbarElement Yes - - Returns the element of the control status bar desig‐
(Page 1289) nated by name or index as "ICCAxStatusbarElement"
type.
GetStatusbarElement‐ Yes - - Returns the list of all status bar elements of the con‐
Collection (Page 1290) trol as "ICCAxCollection" type.
GetToolbarButton Yes - - Returns the control toolbar button function designa‐
(Page 1297) ted by name or index as "ICCAxToolbarButton" type.
GetToolbarButtonCollec‐ Yes - - Returns the list of all button functions of the control
tion (Page 1298) toolbar as "ICCAxCollection" type.
MoveToFirst (Page 1318) Yes - - Executes the "First line" button function of the con‐
trol.
MoveToLast (Page 1320) Yes - - Executes the "Last data record" button function of the
control.
MoveToNext (Page 1321) Yes - - Executes the "Next data record" button function of
the control.
MoveToPrevious Yes - - Executes the "Previous data record" button function
(Page 1323) of the control.

WinCC Engineering V18 – Programming reference

476 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Methods RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
PasteRows (Page 1326) Yes - - Executes the "Insert rows" button function of the rec‐
ipe view.
Print (Page 1327) Yes - - Executes the "Print" button function of the control.
ReadTags (Page 1332) Yes - - Executes the "Read tags" button function of the rec‐
ipe view.
SelectAll (Page 1342) Yes - - Selects all rows in a table-based control.
SelectRow (Page 1343) Yes - - Selects a specific row in a table-based control.
ServerExport (Page 1343) Yes - - Executes the "Export log" button function of the rec‐
ipe view.
ServerImport Yes - - Executes the "Import log" button function of the rec‐
(Page 1344) ipe view.
ShowHelp (Page 1348) Yes - - Executes the "Help" button function of the control.
ShowPropertyDialog Yes - - Executes the "Configuration dialog" button function
(Page 1352) of the control.
ShowSelectArchive Yes - - Executes the "Select data connection" button func‐
(Page 1353) tion of the recipe view.
ShowSelection Yes - - Executes the "Selection dialog" button function of the
(Page 1353) recipe view.
ShowSelectTimeBase Yes - - Executes the "Timebase dialog" button function of
(Page 1354) the recipe view.
ShowSort (Page 1355) Yes - - Executes the "Sorting dialog" button function of the
recipe view.
UnselectAll (Page 1361) Yes - - Removes all selections from the cells of a table-based
control.
UnselectRow (Page 1361) Yes - - Removes the selections from a specific cell of a table-
based control.
WriteTags (Page 1365) Yes - - Executes the "Write tags" button function of the rec‐
ipe view.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 477
VB scripting
1.5 VBS object model

UserView

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.

Type identifier in VBS

HMIUserView

Abbreviation Access in runtime

R Read
RW Read and write
- No access

Table 1-119 Properties

Properties RT Profes‐ RT Ad‐ Panel RT Description

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

WinCC Engineering V18 – Programming reference

478 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Authorization - RW RW Specifies the operating rights of the selected object in
(Page 517) runtime.
BackColor (Page 526) - RW RW Specifies the background color of the selected object.
BorderBackColor - - - -
BorderColor - - - -
BorderWidth - - - -
Bounds - - - -
CanBeGrouped - - - -
Columns - - - -
ColumnsMoveable - - - -
ColumnTextGroup - - - -
ColumnTextLogTime - - - -
ColumnTextPassword - - - -
ColumnTextUser - - - -
CornerRadius - - - -
CountVisibleItems - - - -
DeviceStyle - - - -
EdgeStyle - - - -
Enabled (Page 660) RW RW RW Specifies whether the selected object can be operat‐
ed in runtime.
Es2rtButtonPositions - - - -
FitToSize - - - -
Flashing - - - -
Height (Page 720) RW R R Specifies the height of the selected object.
IsMinPasswordValueSet - - - -
IsRunningUnderCE - - - -
Layer (Page 764) RW RW RW Specifies the layer in the screen that contains an ob‐
ject.
Left (Page 770) RW RW RW Specifies the value of the X coordinate of the selected
object.
ListAreaHeight - - - -
ListAreaWidth - - - -
Location - - - -
MinPasswordValue - - - -
Name - - - -
PaddingBottom - - - -
PaddingLeft - - - -
PaddingRight - - - -
PaddingTop - - - -
RTPersistence - - - -
RTPersistenceAuthoriza‐ - - - -
tion
RTPersistenceType - - - -

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 479
VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
SelectionBackColor - RW RW Specifies the background color of the selected cells.
(Page 913)
SelectionForeColor - RW RW Specifies the foreground color of the selected cells.
(Page 915)
ShowColumnHeaders - - - -
ShowTableGridlines - - - -
Size - - - -
StyleItem - - - -
TabIndex - - - -
TabIndexAlpha - - - -
TableBackColor - RW RW Specifies the background color of the table cells for
(Page 987) the selected object.
TableEvenRowBackColor - - - -
TableFont - - - -
TableForeColor - RW RW Specifies the text color used in the table cells of the
(Page 990) object.
TableGridLineColor - RW RW Determines the color of the gridlines in the table of
(Page 992) the given object.
TableHeaderBackColor - RW RW Specifies the background color in the header of the
(Page 993) table of the selected object.
TableHeaderBackFill‐ - - - -
Style
TableHeaderBorderBack‐ - - - -
Color
TableHeaderBorderColor - - - -
TableHeaderBorder‐ - - - -
Width
TableHeaderCornerRa‐ - - - -
dius
TableHeaderEdgeStyle - - - -
TableHeaderFirstGra‐ - - - -
dientColor
TableHeaderFirstGra‐ - - - -
dientOffset
TableHeaderFont - - - -
TableHeaderForeColor - RW RW Specifies the text color in the header of the table of
(Page 995) the selected object.
TableHeaderMiddleGra‐ - - - -
dientColor
TableHeaderPaddingBot‐ - - - -
tom
TableHeaderPaddingLeft - - - -
TableHeaderPadding‐ - - - -
Right
TableHeaderPaddingTop - - - -

WinCC Engineering V18 – Programming reference

480 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
TableHeaderSecondGra‐ - - - -
dientColor
TableHeaderSecondGra‐ - - - -
dientOffset
Top (Page 1083) R RW RW Specifies the value of the Y coordinate of the selected
object.
UseDesignColorSchema - - - -
UseTableHeaderFirst‐ - - - -
Gradient
UseTableHeaderSecond‐ - - - -
Gradient
VerticalScrolling - - - -
ViewType - - - -
ViewTypeForSaveStream - - - -
Visible (Page 1204) R RW RW Specifies whether the selected object is visible.
Width (Page 1217) RW R R Specifies the width of the object in pixels.

Table 1-120 Methods

Methods RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Activate (Page 1250) Yes Yes Yes Enables the permanent area or the root screen.
ActivateDynamic Yes - - Dynamically activates a trigger and the specified cycle
(Page 1252) for a property at runtime.
DeactivateDynamic Yes - - Deactivates the trigger of the "ActivateDynamic"
(Page 1259) method used for the specified property in/during run‐
time.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 481
VB scripting
1.5 VBS object model

WindowSlider

Description

6FUHHQV

6FUHHQ

6FUHHQ,WHPV

6FUHHQ,WHP

Represents the "Window slider" object. The WindowSlider object is an element of the
ScreenItems list.

Type identifier in VBS

HMIWindowSlider

Abbreviation Access in Runtime

R Read
RW Read and write
- No access

Table 1-121 Properties

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
AllTagTypesAllowed - - - -
AskOperationMotive RW - - Specifies whether the reason for operating this object
(Page 514) is logged.
Authorization RW - - Specifies operating rights.
(Page 517)
BackColor (Page 526) RW - - Specifies the background color.
BackColorBottom RW - - Specifies the color for the lower / right part of the
(Page 529) object.

WinCC Engineering V18 – Programming reference

482 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
BackColorTop RW - - Specifies the color for the upper / left part of the ob‐
(Page 530) ject.
BackFillStyle (Page 531) RW - - Specifies the fill pattern.
BackFlashingColorOff RW - - Specifies the background color for flash state "Off".
(Page 533)
BackFlashingColorOn RW - - Specifies the background color for flash state "On".
(Page 534)
BackFlashingEnabled RW - - Specifies whether the background flashes in runtime.
(Page 535)
BackFlashingRate RW - - Specifies the flash rate of the background.
(Page 536)
BorderBackColor RW - - Specifies the background color of the broken border
(Page 558) line.
BorderColor (Page 562) RW - - Specifies the line color.
BorderFlashingColorOff RW - - Specifies the color of the border line for the flashing
(Page 566) status "Off".
BorderFlashingColorOn RW - - Specifies the color of the border line for the flashing
(Page 567) status "On".
BorderFlashingEnabled - - - -
BorderFlashingRate RW - - Specifies the flash rate of the border line.
(Page 570)
BorderStyle (Page 576) RW - - Specifies the type of border lines.
BorderWidth (Page 577) RW - - Specifies the line thickness.
Bounds - - - -
CanBeGrouped - - - -
CornerStyle (Page 635) RW - - Specifies the shape of the corners.
DrawInsideFrame RW - - Specifies whether the border line is to be shown with
(Page 655) a line thickness of greater than 1 within the border or
symmetrically to the border.
EdgeStyle (Page 657) RW - - Specifies the line style.
Enabled (Page 660) RW - - Specifies whether the selected object can be operat‐
ed in runtime.
FillingDirection RW - - Specifies the fill direction.
(Page 687)
FillPatternColor RW - - Specifies the color of the fill pattern.
(Page 685)
Flashing - - - -
Height (Page 720) RW - - Specifies the height.
HighLimitColor RW - - Specifies the color of the top or right scroll button in
(Page 726) a scroll bar.
JumpToLimitsAfterMou‐ RW - - Specifies whether the slider is set to the associated
seClick (Page 758) end value.
Layer (Page 764) RW - - Specifies the layer in the screen that contains an ob‐
ject.
Left (Page 770) RW - - Specifies the value of the X coordinate.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 483
VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
LineEndShapeStyle RW - - Specifies the shape of the line ends.
(Page 787)
Location - - - -
LogOperation RW - - Specifies whether, after operating this object, an
(Page 794) alarm is output to the alarm system.
LowLimitColor RW - - Specifies the color of the bottom or left scroll button
(Page 796) in a scroll bar.
MarginToBorder RW - - Specifies the width of the 3D border in pixels.
(Page 798)
MaximumValue RW - - Specifies the maximum value of the scale in the se‐
(Page 799) lected object.
MinimumValue RW - - Specifies the minimum value of the scale in the se‐
(Page 822) lected object.
Name - - - -
OperationSteps R - - Returns the number of steps by which the slider of the
(Page 840) scrollbar is moved with one mouse click.
ProcessValue (Page 874) R - - Returns the default for the value to be displayed.
RelativeFillLevel R - - Returns the percentage to which the object is filled.
(Page 881)
ShowBadTagState R - - Returns whether the object is grayed out in the event
(Page 926) of a bad quality code or tag status.
ShowFillLevel R - - Returns whether the specified object is filled.
(Page 933)
Size - - - -
StyleSettings (Page 982) R - - Returns the style in which the object is displayed.
TabIndex - - - -
TabIndexAlpha - - - -
TextOrientation R - - Returns the text orientation.
(Page 1004)
ThumbBackColor R - - Returns the background color of the slider.
(Page 1006)
ToolTipText (Page 1082) R - - Returns the tooltip text.
Top (Page 1083) R - - Returns the value of the Y coordinate.
Transparency R - - Returns the object transparency in percent.
(Page 1087)
UseDesignColorSchema R - - Returns whether the colors defined in the global color
(Page 1148) scheme of the current design are used for this object.
UseDesignShadowSet‐ R - - Returns whether the object is displayed with global
tings (Page 1150) shading.
Visible (Page 1204) R - - Returns whether the specified object is visible.
Width (Page 1217) R - - Returns the width of the object in pixels.
WindowsStyle R - - Returns whether the object is displayed in the general
(Page 1224) Windows style.

WinCC Engineering V18 – Programming reference

484 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Table 1-122 Methods

Methods RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Activate (Page 1250) Yes - - Enables the permanent area or the root screen.
ActivateDynamic Yes - - Dynamically activates a trigger and the specified cycle
(Page 1252) for a property at runtime.
DeactivateDynamic Yes - - Deactivates the trigger of the "ActivateDynamic"
(Page 1259) method used for the specified property in/during run‐
time.

See also
BorderFlashingEnabled (Page 569)

WLanQualityView

Description

6FUHHQV

6FUHHQ

6FUHHQ,WHPV

6FUHHQ,WHP

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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 485
VB scripting
1.5 VBS object model

Type identifier in VBS

Abbreviation Access in runtime

R Read
RW Read and write
- No access

Table 1-123 Properties

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
AllTagTypesAllowed - - - -
Bounds - - - -
CanBeGrouped - - - -
Height - R R Specifies the height.
Layer (Page 764) - - RW Specifies the layer in the screen that contains an ob‐
ject.
Left (Page 770) - - RW Specifies the value of the X coordinate.
Location - - - -
Name - - - -
Size - - - -
TabIndex - - - -
TabIndexAlpha - - - -
Top (Page 1083) - - RW Specifies the value of the Y coordinate.
Visible (Page 1204) - - RW Specifies whether the selected object is visible.
Width - R R Specifies the width.

Table 1-124 Methods

Methods RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Activate (Page 1250) - - Yes Enables the permanent area or the root screen.

WinCC Engineering V18 – Programming reference

486 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

ZoneLabelView

Description

6FUHHQV

6FUHHQ

6FUHHQ,WHPV

6FUHHQ,WHP

Represents the "Zone name" object. The ZoneLabelView object is an element of the
ScreenItems list.

Type identifier in VBS

HMIZoneLabelView

Abbreviation Access in runtime

R Read
RW Read and write
- No access

Table 1-125 Properties

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
AllTagTypesAllowed - - - -
Bounds - - - -
CanBeGrouped - - - -
Font - - - -
Height - R R Specifies the height.
Layer (Page 764) - - RW Specifies the layer in the screen that contains an ob‐
ject.
Left (Page 770) - - RW Specifies the value of the X coordinate.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 487
VB scripting
1.5 VBS object model

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Location - - - -
Name - - - -
Size - - - -
TabIndex - - - -
TabIndexAlpha - - - -
Top (Page 1083) - - RW Specifies the value of the Y coordinate.
Visible (Page 1204) - - RW Specifies whether the selected object is visible.
Width - R R Specifies the width.

Table 1-126 Methods

Methods RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Activate (Page 1250) - - Yes Enables the permanent area or the root screen.

ZoneQualityView

Description

6FUHHQV

6FUHHQ

6FUHHQ,WHPV

6FUHHQ,WHP

Represents the "ZoneSignal" object. The ZoneQualityView object is an element of the

ScreenItems list.

WinCC Engineering V18 – Programming reference

488 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Type identifier in VBS

Abbreviation Access in runtime

R Read
RW Read and write
- No access

Table 1-127 Properties

Properties RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
AllTagTypesAllowed - - - -
Bounds - - - -
CanBeGrouped - - - -
Height - R R Specifies the height.
Layer (Page 764) - - RW Specifies the layer in the screen that contains an ob‐
ject.
Left (Page 770) - - RW Specifies the value of the X coordinate.
Location - - - -
Name - - - -
Size - - - -
TabIndex - - - -
TabIndexAlpha - - - -
Top (Page 1083) - - RW Specifies the value of the Y coordinate.
Visible (Page 1204) - - RW Specifies whether the selected object is visible.
Width - R R Specifies the width.

Table 1-128 Methods

Methods RT Profes‐ RT Ad‐ Panel RT Description

sional vanced
Activate (Page 1250) - - Yes Enables the permanent area or the root screen.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 489
VB scripting
1.5 VBS object model

1.5.5 Properties

1.5.5.1 Properties A

AboveUpperLimitColor

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 332)
GraphicIOField (Page 324)

WinCC Engineering V18 – Programming reference

490 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Switch (Page 418)

SymbolLibrary (Page 427)
SymbolicIOField (Page 422)

AcceptOnExit

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 332)
SymbolicIOField (Page 422)

AcceptOnFull

Description
Specifies whether the input field will be left and confirmed automatically when the set number
of values have been entered.
Access in runtime: Read and write

Syntax
Object.AcceptOnFull[=BOOLEAN]

Object
Required. A "ScreenItem" object with the following format:
• IOField

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 491
VB scripting
1.5 VBS object model

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 332)

AccessPath

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 216)

ActiveProject

Description
Returns the specified project.
Access in Runtime: Read

WinCC Engineering V18 – Programming reference

492 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Syntax
Object.ActiveProject

Object
Required A "HMIRuntime" object.

See also
HMIRuntime (Page 209)
Project (Page 215)

ActiveScreen

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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 493
VB scripting
1.5 VBS object model

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
HMIRuntime (Page 209)

ActiveScreen

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.

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.

WinCC Engineering V18 – Programming reference

494 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

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
HMIRuntime (Page 209)

ActiveScreenItem

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

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".

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 495
VB scripting
1.5 VBS object model

Application
The "ActiveScreenItem" object is used to address the object property which has the focus in
runtime.

ActualPointIndex

Description
Specifies the number of the current corner point.
Access in runtime:
• RT Advanced: No access
• RT Professional: Read and write

Syntax
Object.ActualPointIndex[=Int32]

Object
Required. An object of the type "ScreenItem" with the format:
• Polygon
• Polyline
• Tubepolyline
You have no access in runtime with the following format:
• 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 461)
Line (Page 336)

ActualPointLeft

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.

WinCC Engineering V18 – Programming reference

496 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Access in runtime:
• RT Advanced: No access
• RT Professional: Read and write

Syntax
Object.ActualPointLeft[=Int32]

Object
Required. An object of the type "ScreenItem" with the format:
• Polygon
• Polyline
• Tubepolyline
You have no access in runtime with the following format:
• 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)
TubePolyline (Page 461)
Line (Page 336)

ActualPointTop

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:
• RT Advanced: No access
• RT Professional: Read and write

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 497
VB scripting
1.5 VBS object model

Syntax
Object.ActualPointTop[=Int32]

Object
Required. An object of the type "ScreenItem" with the format:
• Polygon
• Polyline
• Tubepolyline
You have no access in runtime with the following format:
• 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)
TubePolyline (Page 461)
Line (Page 336)

AdaptBorder

Description
Specifies whether the border of the object will be dynamically adapted to the text size.
Access in runtime: Read and write

Syntax
Object.AdaptBorder[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the format:
• Button
• CheckBox

WinCC Engineering V18 – Programming reference

498 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

• 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 267)
CheckBox (Page 275)
IOField (Page 332)
OptionGroup (Page 371)
SymbolicIOField (Page 422)

AdaptPicture

Description
No access in runtime.

AdaptScreenToWindow

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
Required. A "ScreenItem" object with the following format:
• Screenwindow

BOOLEAN
Optional.
TRUE, if the screen adapts to the screen window size.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 499
VB scripting
1.5 VBS object model

FALSE, if the screen does not adapt to the screen window size.

See also
ScreenWindow (Page 404)

AdaptWindowtoScreen

Description
Specifies whether the screen window adapts to the screen it displays in runtime.
Access in runtime Read and write

Syntax
Object.AdaptWindowtoScreen[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• 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
ScreenWindow (Page 404)

Address

Description
Specifies the web address that will be opened in the HTML browser.
Access in runtime: Read and write

Syntax
Object.Address[=STRING]

WinCC Engineering V18 – Programming reference

500 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Object
Required. An object of the type "ScreenItem" with the format:
• HTMLBrowser

STRING
Optional. A value or a constant that contains the web address.

See also
HTMLBrowser (Page 330)

AddressEnabled

Description
No access in runtime.

AdressPreview

Description
No access in runtime.

AdvancedButtonPositions

Description
No access in runtime.

AdvancedView

Description
No access in runtime.

Alarm

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 501
VB scripting
1.5 VBS object model

AlarmAreaHeight

Description
No access in runtime.

AlarmAreaWidth

Description
No access in runtime.

AlarmClasses

Description
No access in runtime.

AlarmColor

Description
No access in runtime.

AlarmID

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 201)

AlarmLog

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

502 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

AlarmLogs

Description
Returns an object of type "AlarmLogs".
Access in Runtime: Read

Syntax
Object.AlarmLogs

Object
Required A "Logging" object.

See also
Logging (Page 214)

AlarmLowerLimit

Description
Specifies the low limit at which the alarm is triggered.
Access in runtime: Read and write

Syntax
Object.AlarmLowerLimit[=DOUBLE]

Object
Required. A "ScreenItem" object with the following format:
• 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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 503
VB scripting
1.5 VBS object model

See also
Bar (Page 259)

AlarmLowerLimitColor

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:
• RT Advanced: No access
• RT Professional: Read and write

Syntax
Object.AlarmLowerLimitColor[=Color]

Object
Required. An object of the type "ScreenItem" with the following format:
• Bar
You have no access in runtime with the following format:
• Slider

Color
Optional. A value or a constant that specifies the bar color for the "AlarmLowerLimit" limit.

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
Bar (Page 259)
Slider (Page 408)

WinCC Engineering V18 – Programming reference

504 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

AlarmLowerLimitEnabled

Description
Specifies whether the "AlarmLowerLimit" limit is monitored.
Access in runtime: Read and write

Syntax
Object.AlarmLowerLimitEnabled[=BOOLEAN]

Object
Required. A "ScreenItem" object with the following format:
• 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 259)

AlarmLowerLimitRelative

Description
Establish whether the lower limit at which the interrupt is triggered is evaluated as a percentage
or an absolute value.
Access in runtime: Read and write

Syntax
Object.AlarmLowerLimitRelative[=BOOLEAN]

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 505
VB scripting
1.5 VBS object model

Object
Required. A "ScreenItem" object with the following format:
• Bar

BOOLEAN
Optional TRUE, if the lower limit at which the interrupt is triggered is evaluated as a
percentage.

See also
Bar (Page 259)

AlarmSource

Description
No access in runtime.

AlarmTextTag

Description
No access in runtime.

AlarmUpperLimit

Description
Establishes the upper limit at which the interrupt will be triggered.
Access in runtime: Read and write

Syntax
Object.AlarmUpperLimit[=DOUBLE]

Object
Required. A "ScreenItem" object with the following format:
• Bar

DOUBLE
Optional A value or a constant that defines the upper limit at which an interrupt will be
triggered.

WinCC Engineering V18 – Programming reference

506 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

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 259)

AlarmUpperLimitColor

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:
• RT Advanced: No access
• RT Professional: Read and write

Syntax
Object.AlarmUpperLimitColor[=Color]

Object
Required. An object of the type "ScreenItem" with the format:
• Bar
You have no access in runtime with the following format:
• Slider

Color
Optional. A value or a constant that specifies the bar color for the "AlarmUpperLimit" limit.

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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 507
VB scripting
1.5 VBS object model

See also
Bar (Page 259)
Slider (Page 408)

AlarmUpperLimitEnabled

Description
Specifies whether the "AlarmUpperLimit" limit is monitored.
Access in runtime: Read and write

Syntax
Object.AlarmUpperLimitEnabled[=BOOLEAN]

Object
Required. A "ScreenItem" object with the following format:
• 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 259)

AlarmUpperLimitRelative

Description
Establish whether the upper limit at which the interrupt is triggered is evaluated as a percentage
or an absolute value.
Access in runtime: Read and write

WinCC Engineering V18 – Programming reference

508 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Syntax
Object.AlarmUpperLimitRelative[=BOOLEAN]

Object
Required. A "ScreenItem" object with the following format:
• Bar

BOOLEAN
Optional TRUE, if the high limit at which the interrupt is triggered is evaluated as a
percentage.

See also
Bar (Page 259)

AllFilters

Description
No access in runtime.

AllFiltersForHitlist

Description
No access in runtime.

AllowEdit

Description
No access in runtime.

AllowMenu

Description
No access in runtime

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 509
VB scripting
1.5 VBS object model

AllServer

Description
Specifies whether the alarms of all available servers are displayed.
Access in runtime: Read and write

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 237)

AllTagTypesAllowed

Description
No access in runtime.

Analog

Description
Specifies whether the clock should be shown as an analog clock.
Access in runtime: Read and write

Syntax
Object.Analog[=BOOLEAN]

WinCC Engineering V18 – Programming reference

510 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Object
Required. A "ScreenItem" object with the following format:
• Clock

BOOLEAN
Optional TRUE, if the clock should be shown as an analog clock.

See also
Clock (Page 287)

AngleMax

Description
Specifies the angle of the scale end of the "Gauge" object.
Access in runtime: Read and write

Syntax
Object.AngleMax[=DOUBLE]

Object
Required. A "ScreenItem" object with the following format:
• 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 320)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 511
VB scripting
1.5 VBS object model

AngleMin

Description
Specifies the angle of the scale start of the "Gauge" object.
Access in runtime: Read and write

Syntax
Object.AngleMin[=DOUBLE]

Object
Required. A "ScreenItem" object with the following format:
• 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 320)

AnimationIgnore

Description
No access in runtime.

Appearance

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

512 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

ApplyProjectSettings

Description
Specifies whether the project settings are applied from the "HMI alarms" editor.
Access in runtime Read and write

Syntax
Object.ApplyProjectSettings[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• 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
AlarmControl (Page 237)

ApplyProjectSettingsForDesignMode

Description
No access in runtime.

ArchiveName

Description
Specifies the log name.
Access in runtime: Read and write

Syntax
Object.ArchiveName[=STRING]

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 513
VB scripting
1.5 VBS object model

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 466)

ArchiveType

Description
Sets the log type.
Access in runtime: Read and write

Syntax
Object.ArchiveType[=RecipeControlDataSourceType]

Object
Required. A "ScreenItem" object with the characteristics:
• UserArchiveControl

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
UserArchiveControl (Page 466)

AskOperationMotive

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.

WinCC Engineering V18 – Programming reference

514 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Access in runtime Read and write

Syntax
Object.AskOperationMotive[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• ComboBox
• IOField
• ListBox
• SymbolicIOField
• WindowSlider

BOOLEAN
Optional.TRUE if the reason for operating this object is to be logged.

See also
ComboBox (Page 290)
IOField (Page 332)
Listbox (Page 339)
SymbolicIOField (Page 422)
WindowSlider (Page 482)

AspectRatio

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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 515
VB scripting
1.5 VBS object model

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)

AssignedFilters

Description
No access in runtime.

AssignedHitlistFilters

Description
No access in runtime.

Assignments

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.
Access in runtime: Read and write

Syntax
Object.Assignments[=STRING]

Object
Required. A "ScreenItem" object with the following format:
• SymbolicIOField

STRING
Optional Specifies a list which contains the assignments between the output value and the
output text actually to be output.

See also
SymbolicIOField (Page 422)

WinCC Engineering V18 – Programming reference

516 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

AssociatedS7GraphDBName

Description
No access in runtime.

AssociatedS7GraphDBTag

Description
No access in runtime.

Authorization

Description
Specifies operating rights.
Access in runtime: Read and write

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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 517
VB scripting
1.5 VBS object model

• Line *
• ListBox *
• MultiLineEdit *
• OptionGroup *
• Polygon *
• 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

You have no access in runtime with the following format:

• AlarmView
• PLCCodeViewer
• PdfView
• ProtectedAreaNameView
• RangeLabelView
• SysDiagControl

HMIRTAuthorization
Optional. A value or a constant which specifies the operating rights.

WinCC Engineering V18 – Programming reference

518 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

AutoCompleteColumns

Description
Specifies whether empty columns are shown if the control is wider than the configured
columns.
Access in runtime Read and write

Syntax
Object.AutoCompleteColumns[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• OnlineTableControl
• TrendRulerControl
• UserArchiveControl

BOOLEAN
Optional.
TRUE if the empty columns are shown.
FALSE if the empty columns are not shown.

See also
AlarmControl (Page 237)
OnlineTableControl (Page 347)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

AutoCompleteRows

Description
Specifies whether empty rows are shown if the control is longer than the number of configured
rows.
Access in runtime Read and write

Syntax
Object.AutoCompleteRows[=BOOLEAN]

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 519
VB scripting
1.5 VBS object model

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• OnlineTableControl
• TrendRulerControl
• UserArchiveControl

BOOLEAN
Optional.
TRUE if the empty rows are shown.
FALSE if the empty rows are not shown.

See also
AlarmControl (Page 237)
OnlineTableControl (Page 347)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

AutoPosition

Description
Specifies whether the value table is automatically placed below the object that supplies the
value table with data.
Access in Runtime: Read and write

Syntax
Object.AutoPosition[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• TrendRulerControl

BOOLEAN
Optional.
TRUE, if the object is automatically placed below the data source.
FALSE, if the object is placed at the configured position.

WinCC Engineering V18 – Programming reference

520 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

See also
TrendRulerControl (Page 441)

AutoScroll

Description
Specifies whether autoscroll is used.
Access in runtime Read and write

Syntax
Object.AutoScroll[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl

BOOLEAN
Optional.
TRUE if autoscroll is used.

See also
AlarmControl (Page 237)

AutoSelectionColors

Description
Specifies whether the colors defined by the system are used as the selection colors for cells and
rows.
Access in runtime Read and write

Syntax
Object.AutoSelectionColors[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• OnlineTableControl

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 521
VB scripting
1.5 VBS object model

• TrendRulerControl
• UserArchiveControl

BOOLEAN
Optional.
TRUE if the system color is used.
FALSE if the user-defined color is used.

See also
AlarmControl (Page 237)
OnlineTableControl (Page 347)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

AutoSelectionRectColor

Description
Specifies whether the selection frame is shown with the color defined by the system.
Access in runtime: Read and write

Syntax
Object.AutoSelectionRectColor[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• OnlineTableControl
• TrendRulerControl
• UserArchiveControl

BOOLEAN
Optional.
TRUE if the system color is used.
FALSE if the user-defined color is used.

WinCC Engineering V18 – Programming reference

522 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

See also
AlarmControl (Page 237)
OnlineTableControl (Page 347)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

AutoShow

Description
Specifies whether the value table is shown automatically.
Access in runtime: Read and write

Syntax
Object.AutoShow[=BOOLEAN]

Object
Required. A "ScreenItem" object with the following characteristics:
• TrendRulerControl

BOOLEAN
Optional.
TRUE, if the value table is shown automatically.
FALSE, if the value table is not shown automatically.

See also
TrendRulerControl (Page 441)

AutoSizing

Description
No access in runtime.

AutoStart

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 523
VB scripting
1.5 VBS object model

AvailableStatusbarElements

Description
No access in runtime.

AvailableToolbarButtons

Description
No access in runtime.

AverageLast15Values

Description
Specifies whether the average of the last 15 values is to be shown.
Access in runtime Read and write

Syntax
Object.AverageLast15Values[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the format:
• 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 259)

AxisXBunchCount

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

524 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

AxisXMarkCount

Description
No access in runtime.

AxisXNoOfDigits

Description
No access in runtime.

AxisXShowBunchValues

Description
No access in runtime.

AxisXStyle

Description
No access in runtime.

AxisY1BunchCount

Description
No access in runtime.

AxisY1MarkCount

Description
No access in runtime.

AxisY1ShowBunchValues

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 525
VB scripting
1.5 VBS object model

AxisY2BunchCount

Description
No access in runtime.

AxisY2MarkCount

Description
No access in runtime.

AxisY2ShowBunchValues

Description
No access in runtime.

1.5.5.2 Properties B

BackButtonVisible

Description
No access in runtime.

BackColor

Description
Specifies the background color.
Access in runtime: Read and write

Syntax
Object.BackColor[=Color]

Object
Required. An object of the type "ScreenItem" with the format:
• AlarmControl *
• AlarmView
• Bar

WinCC Engineering V18 – Programming reference

526 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

• Button **
• CheckBox *
• Circle
• CircleSegment *
• CircularArc *
• ComboBox *
• Connector *
• DateTimeField **
• Ellipse
• EllipseSegment *
• 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 *

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 527
VB scripting
1.5 VBS object model

• UserView **
• WindowSlider *
* RT Advanced No access
** RT Professional No access

You have no access in runtime with the following format:

• TrendView
• TubeArcObject

Color
Optional. A value or a constant that specifies the background color.

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.
The background color is not visible if the "BorderStyle" property has the value "0".

See also
AlarmControl (Page 237)
AlarmView (Page 251)
Bar (Page 259)
Button (Page 267)
CheckBox (Page 275)
Circle (Page 279)
CircleSegment (Page 282)
CircularArc (Page 285)
ComboBox (Page 290)
Connector (Page 293)
DateTimeField (Page 296)
Ellipse (Page 300)
EllipseSegment (Page 303)
EllipticalArc (Page 306)
FunctionTrendControl (Page 309)

WinCC Engineering V18 – Programming reference

528 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Gauge (Page 320)

GraphicIOField (Page 324)
GraphicView (Page 327)
IOField (Page 332)
Line (Page 336)
Listbox (Page 339)
MultiLineEdit (Page 345)
OnlineTableControl (Page 347)
OnlineTrendControl (Page 359)
OptionGroup (Page 371)
Polygon (Page 378)
Polyline (Page 381)
RecipeView (Page 389)
Rectangle (Page 395)
RoundButton (Page 398)
Slider (Page 408)
StatusForce (Page 414)
Switch (Page 418)
SymbolicIOField (Page 422)
SymbolLibrary (Page 427)
TextField (Page 438)
TrendRulerControl (Page 441)
TrendView (Page 451)
TubeArcObject (Page 457)
UserArchiveControl (Page 466)
UserView (Page 478)
WindowSlider (Page 482)

BackColorBottom

Description
Specifies the color for the lower / right part of the object.
Access in runtime Read and write

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 529
VB scripting
1.5 VBS object model

Syntax
Object.BackColorBottom[=Color]

Object
Required. An object of the type "ScreenItem" with the following format:
• WindowSlider

Color
Optional. A value or a constant that specifies the color for the lower / right part of the object.

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
WindowSlider (Page 482)

BackColorTop

Description
Specifies the color for the upper / left part of the object.
Access in runtime Read and write

Syntax
Object.BackColorTop[=Color]

Object
Required. An object of the type "ScreenItem" with the following format:
• WindowSlider

Color
Optional. A value or a constant that specifies the color for the upper / left part of the object.

WinCC Engineering V18 – Programming reference

530 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

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
WindowSlider (Page 482)

BackFillStyle

Description
Specifies the fill pattern.
Access in runtime: Read and write

Syntax
Object.BackFillStyle[=FillStyle]

Object
Required. An object of the type "ScreenItem" with the following format:
• Bar
• Button*
• CheckBox*
• Circle
• CircleSegment *
• Clock*
• ComboBox
• Ellipse
• EllipseSegment *
• Gauge*
• GraphicView*
• IOField*
• ListBox*
• OptionGroup*
• Polygon

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 531
VB scripting
1.5 VBS object model

• Rectangle
• RoundButton*
• Slider*
• SymbolLibrary*
• SymbolicIOField*
• TextField*
• WindowSlider*
* RT Advanced No access

You have no access in runtime with the following format:

• 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 259)
Button (Page 267)
CheckBox (Page 275)
Clock (Page 287)
ComboBox (Page 290)
DateTimeField (Page 296)
Gauge (Page 320)
GraphicIOField (Page 324)
GraphicView (Page 327)
IOField (Page 332)
Listbox (Page 339)
OptionGroup (Page 371)
RoundButton (Page 398)
Slider (Page 408)
Switch (Page 418)

WinCC Engineering V18 – Programming reference

532 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

SymbolicIOField (Page 422)

SymbolLibrary (Page 427)
WindowSlider (Page 482)

BackFlashingColorOff

Description
Specifies the background color for flash state "Off".
Access in runtime:
• RT Advanced: No access
• RT Professional: Read and write

Syntax
Object.BackFlashingColorOff[=Color]

Object
Required. An object of the type "ScreenItem" with the format:
• Bar
• Button
• CheckBox
• GraphicView
• IOField
• OptionGroup
• RoundButton
• SymbolicIOField
• TextField
• WindowSlider
You have no access in runtime with the following format:
• Switch

Color
Optional. A value or a constant that specifies the color of the background for the flashing
status "off".

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:

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 533
VB scripting
1.5 VBS object model

RGB (255, 0, 0)
You can also use the VBS color constants such as vbRed and vbGreen.

See also
Bar (Page 259)
Button (Page 267)
CheckBox (Page 275)
GraphicView (Page 327)
IOField (Page 332)
OptionGroup (Page 371)
RoundButton (Page 398)
Switch (Page 418)
SymbolicIOField (Page 422)
WindowSlider (Page 482)

BackFlashingColorOn

Description
Specifies the background color for flash state "On".
Access in runtime:
• RT Advanced: No access
• RT Professional: Read and write

Syntax
Object.BackFlashingColorOn[=Color]

Object
Required. An object of the type "ScreenItem" with the format:
• Bar
• Button
• CheckBox
• GraphicView
• IOField
• OptionGroup
• RoundButton
• SymbolicIOField

WinCC Engineering V18 – Programming reference

534 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

• TextField
• WindowSlider
You have no access in runtime with the following format:
• Switch

Color
Optional. A value or a constant that specifies the color of the background for the flashing
status "on".

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
Bar (Page 259)
Button (Page 267)
CheckBox (Page 275)
GraphicView (Page 327)
IOField (Page 332)
OptionGroup (Page 371)
RoundButton (Page 398)
Switch (Page 418)
SymbolicIOField (Page 422)
WindowSlider (Page 482)

BackFlashingEnabled

Description
Specifies whether the background flashes in runtime.
Access in runtime:
• RT Advanced: No access
• RT Professional: Read and write

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 535
VB scripting
1.5 VBS object model

Syntax
Object.BackFlashingEnabled[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the format:
• Bar
• Button
• CheckBox
• GraphicView
• IOField
• OptionGroup
• RoundButton
• SymbolicIOField
• TextField
• WindowSlider
You have no access in runtime with the following format:
• Switch

BOOLEAN
Optional. TRUE if the background flashes in runtime.

See also
Bar (Page 259)
Button (Page 267)
CheckBox (Page 275)
GraphicView (Page 327)
IOField (Page 332)
OptionGroup (Page 371)
RoundButton (Page 398)
Switch (Page 418)
SymbolicIOField (Page 422)
WindowSlider (Page 482)

BackFlashingRate

Description
Specifies the flash rate of the background.

WinCC Engineering V18 – Programming reference

536 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Access in runtime:
• RT Advanced: No access
• RT Professional: Read and write

Syntax
Object.BackFlashingRate[=FlashingRate]

Object
Required. An object of the type "ScreenItem" with the format:
• Bar
• Button
• CheckBox
• GraphicView
• IOField
• OptionGroup
• RoundButton
• SymbolicIOField
• TextField
• WindowSlider
You have no access in runtime with the following format:
• Switch

FlashingRate
Optional. A value or a constant that specifies the flash rate of the background.

Value VB constant Explanation

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 259)
Button (Page 267)
CheckBox (Page 275)
GraphicView (Page 327)
IOField (Page 332)
OptionGroup (Page 371)
RoundButton (Page 398)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 537
VB scripting
1.5 VBS object model

Switch (Page 418)

SymbolicIOField (Page 422)
WindowSlider (Page 482)

BackgroundColor

Description
No access in runtime.

See also
TrendRulerControl (Page 441)

BackPicture

Description
Specifies the background graphic.
Access in runtime: Read and write

Syntax
Object.BackPicture[=HmiObjectHandle]

Object
Required. A "ScreenItem" object with the characteristics:
• Gauge
• Slider

HmiObjectHandle
Optional. A value or a constant that specifies the background graphic.

See also
Gauge (Page 320)
Slider (Page 408)

BackStyle

Description
Specifies the background style.

WinCC Engineering V18 – Programming reference

538 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Access in runtime: Read and write

Syntax
Object.BackStyle[=Int32]

Object
Required. A "ScreenItem" object with the characteristics:
• Gauge

Int32
Optional. A value or a constant that specifies the background style.

Value Designation Explanation

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 320)

BarBackColor

Description
Specifies the color of the bar background for the selected object.
Access in runtime Read and write

Syntax
Object.BarBackColor[=Color]

Object
Required. An object of the type "ScreenItem" with the following format:
• Bar
• Slider

Color
Optional. A value or a constant that specifies the color of the bar background.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 539
VB scripting
1.5 VBS object model

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
Bar (Page 259)
Slider (Page 408)

BarBackFillStyle

Description
Specifies the fill style for the bar.
Access in runtime Read and write

Syntax
Object.BarBackFillStyle[=FillStyle]

Object
Required. An object of the type "ScreenItem" with the following format:
• Bar

FillStyle
Optional. A value or a constant that specifies the fill pattern of the bar.

Value VB constant Explanation

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

WinCC Engineering V18 – Programming reference

540 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

See also
Bar (Page 259)

BarBackFlashingColorOff

Description
Specifies the color ###
Access in Runtime: Read and write

Syntax
Object.BarBackFlashingColorOff[=Color]

Object
Required. An object of the type "ScreenItem" with the format:
• Bar

Color
Optional. A value or a constant that specifies the color of ###

BarBackFlashingColorOn

Description
Specifies the color ###
Access in Runtime: Read and write

Syntax
Object.BarBackFlashingColorOn[=Color]

Object
Required. An object of the type "ScreenItem" with the format:
• Bar

Color
Optional. A value or a constant that specifies the color of ###

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 541
VB scripting
1.5 VBS object model

BarBackFlashingEnabled

Description
Specifies whether ###
Access in Runtime: Read and write

Syntax
Object.BarBackFlashingEnabled[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the format:
• Bar

BOOLEAN
Optional. TRUE, if ###

BarBackFlashingRate

Description
Sets the flash rate ###
Access in Runtime: Read and write

Syntax
Object.BarBackFlashingRate[=FlashingRate]

Object
Required. An object of the type "ScreenItem" with the format:
• Bar

FlashingRate
Optional. A value or a constant that specifies the flash rate ###

BarColor

Description
Specifies the color of the bar.
Access in runtime Read and write

WinCC Engineering V18 – Programming reference

542 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Syntax
Object.BarColor[=Color]

Object
Required. An object of the type "ScreenItem" with the format:
• Slider

Color
Optional. A value or a constant that specifies the color of the slider.

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.
The range extends from the value in "MinimumValue (Page 822)" to the position of the
slider.

See also
Slider (Page 408)

BarEdgeStyle

Description
Specifies ###
Access in Runtime:
• RT Advanced: Read
• RT Professional: Read and write

Syntax
Object.BarEdgeStyle[=LineStyle]

Object
Required. An object of the type "ScreenItem" with the format:
• Bar

LineStyle
Optional. A value or a constant, which ###

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 543
VB scripting
1.5 VBS object model

BarOrientation

Description
Specifies the bar alignment.
Access in runtime
• RT Advanced: No access
• RT Professional: Read and write

Syntax
Object.BarOrientation[=BarOrientation]

Object
Required. An object of the type "ScreenItem" with the following format:
• Bar
You have no access in runtime with the following format:
• 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 259)
Slider (Page 408)

BaseScreenName

Description
Reads the name of the current root screen or triggers a root screen change by setting a new
screen name.
Access in Runtime: Read and write

WinCC Engineering V18 – Programming reference

544 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

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
HMIRuntime (Page 209)

BelowLowerLimitColor

Description
Specifies the color for the "Low limit violated" event.
Access in runtime:
• RT Advanced: No access
• RT Professional: Read and write

Syntax
Object.BelowLowerLimitColor[=Color]

Object
Required. An object of the type "ScreenItem" with the format:
• IOField
You have no access in runtime with the following format:
• GraphicIOField
• Switch
• SymbolLibrary
• SymbolicIOField

Color
Optional. A value or a constant which specifies the color.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 545
VB scripting
1.5 VBS object model

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.

BitNumber

Description
Specifies the bit whose status must change to trigger a value change.
Access in runtime:
• RT Advanced: No access
• RT Professional: Read and write

Syntax
Object.BitNumber[=Int32]

Object
Required. A "ScreenItem" object with the format:
• SymbolicIOField
You have no access in runtime with the following format:
• 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
SymbolicIOField (Page 422)
Button (Page 267)
GraphicIOField (Page 324)

WinCC Engineering V18 – Programming reference

546 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

BlinkColor

Description
Specifies the color in which the object flashes in runtime.
Access in runtime Read and write

Syntax
Object.BlinkColor[=Color]

Object
Required. An object of the type "ScreenItem" with the following format:
• SymbolLibrary

Color
Optional. A value or a constant that specifies the flash color.

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
SymbolLibrary (Page 427)

BlinkMode

Description
Specifies the type of flash graphic for the specified object.
Access in runtime Read and write

Syntax
Object.BlinkMode[=SymbolLibraryBlinkMode]

Object
Required. An object of the type "ScreenItem" with the following format:
• SymbolLibrary

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 547
VB scripting
1.5 VBS object model

SymbolLibraryBlinkMode
Optional. A value or a constant that specifies the type of flash picture for the specified object.

Value VB constant Explanation

0 hmiSymbolLibraryFlashing‐ Flashing is switched off.
None
1 hmiSymbolLibraryFlashingIn‐ The flash picture is invisible.
visible
2 hmiSymbolLibraryFlashing‐ The flash picture is given a colored, shaded surface. The color
Shaded of the surface corresponds to the settings in the property
"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
SymbolLibrary (Page 427)

BlinkSpeed

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.
Access in runtime Read and write

Syntax
Object.BlinkSpeed[=FlashingRate]

Object
Required. An object of the type "ScreenItem" with the following format:
• SymbolLibrary

FlashingRate
Optional. A value or a constant that specifies the flash rate.

Value VB constant Explanation

0 hmiFlashingRateSlow The length of the flashing interval is 250 ms.
1 hmiFlashingRateMedi‐ The length of the flashing interval is 500 ms.
um
2 hmiFlashingRateFast The length of the flashing interval is 1000 ms.

WinCC Engineering V18 – Programming reference

548 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

See also
SymbolLibrary (Page 427)

BlockAlignment

Description
Specifies the alignment of the text within the column header of the referenced block.
Access in runtime Read and write

Syntax
Object.BlockAlignment[=HorizontalAlignment]

Object
Required. An object of the type "ScreenItem" with the format:
• TrendRulerControl

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
TrendRulerControl (Page 441)

BlockAutoPrecision

Description
Specifies whether the number of decimal places displayed in the current block is adjusted
automatically.
Access in runtime: Read and write

Syntax
Object.BlockAutoPrecisions[=BOOLEAN]

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 549
VB scripting
1.5 VBS object model

Object
Required. A "ScreenItem" object with the characteristics:
• TrendRulerControl

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
TrendRulerControl (Page 441)

BlockCaption

Description
Specifies the header of the current block.
Access in runtime: Read and write

Syntax
Object.BlockCaption[=STRING]

Object
Required. A "ScreenItem" object with the following characteristics:
• TrendRulerControl

STRING
Optional. A value or a constant that specifies the header of the block.

See also
TrendRulerControl (Page 441)

BlockCount

Description
Specifies the number of blocks.
Access in runtime: Read and write

WinCC Engineering V18 – Programming reference

550 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Syntax
Object.BlockCount[=Int32]

Object
Required. A "ScreenItem" object with the following characteristics:
• TrendRulerControl

Int32
Optional. A value or a constant that specifies the number of blocks.

See also
TrendRulerControl (Page 441)

BlockDateFormat

Description
Specifies the format for date information in the current block.
Access in runtime: Read and write

Syntax
Object.BlockDateFormat[=STRING]

Object
Required. A "ScreenItem" object with the following characteristics:
• TrendRulerControl

STRING
Optional. A value or a constant that specifies the format for date information.

See also
TrendRulerControl (Page 441)

BlockExponentialFormat

Description
Specifies whether the values in the current block are displayed in exponential notation.
Access in runtime: Read and write

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 551
VB scripting
1.5 VBS object model

Syntax
Object.BlockExponentialFormat[=BOOLEAN]

Object
Required. A "ScreenItem" object with the following characteristics:
• TrendRulerControl

BOOLEAN
Optional.
TRUE, if the values are displayed in exponential notation.
FALSE, if the values are displayed in decimal notation.

See also
TrendRulerControl (Page 441)

BlockHideText

Description
No access in runtime.

BlockHideTitleText

Description
Specifies whether the header of the block is displayed as text.
Access in runtime: Read and write

Syntax
Object.BlockHideTitleText[=BOOLEAN]

Object
Required. A "ScreenItem" object with the following characteristics:
• TrendRulerControl

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.

WinCC Engineering V18 – Programming reference

552 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

See also
TrendRulerControl (Page 441)

BlockId

Description
References a block with its block ID. To access the properties of a block, you need to set "BlockId".
Access in runtime Read and write

Syntax
Object.BlockId[=Int32]

Object
Required. An object of the type "ScreenItem" with the following format:
• TrendRulerControl

Int32
Optional. A value or a constant that specifies the ID of the current block.

See also
TrendRulerControl (Page 441)

BlockIndex

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.
Access in runtime Read and write

Syntax
Object.BlockIndex[=Int32]

Object
Required. An object of the type "ScreenItem" with the following format:
• TrendRulerControl

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 553
VB scripting
1.5 VBS object model

Int32
Optional. A value or a constant that specifies the number of the current block.

See also
TrendRulerControl (Page 441)

BlockLength

Description
Specifies the number of characters of the current block.
Access in runtime: Read and write

Syntax
Object.BlockLength[=Int32]

Object
Required. A "ScreenItem" object with the following characteristics:
• TrendRulerControl

Int32
Optional. A value or a constant that specifies the number of characters.

See also
TrendRulerControl (Page 441)

BlockName

Description
Specifies the name of the current block.
Access in runtime: Read and write

Syntax
Object.BlockName[=STRING]

Object
Required. A "ScreenItem" object with the following characteristics:
• TrendRulerControl

WinCC Engineering V18 – Programming reference

554 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

STRING
Optional. A value or a constant that specifies the name of the block.

See also
TrendRulerControl (Page 441)

BlockPrecision

Description
Specifies the number of decimal places in the current block.
Access in runtime: Read and write

Syntax
Object.BlockPrecisions[=Int16]

Object
Required. A "ScreenItem" object with the following characteristics:
• TrendRulerControl

Int16
Optional. A value or a constant that specifies the number of decimal places.

See also
TrendRulerControl (Page 441)

Blocks

Description
No access in runtime.

BlockShowDate

Description
Specifies that the date is displayed in the current block.
Access in runtime: Read and write

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 555
VB scripting
1.5 VBS object model

Syntax
Object.BlockShowDate[=BOOLEAN]

Object
Required. A "ScreenItem" object with the following characteristics:
• TrendRulerControl

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
TrendRulerControl (Page 441)

BlockShowIcon

Description
Specifies whether the content of the current block is displayed as an icon.
Access in runtime: Read and write

Syntax
Object.BlockShowIcon[=BOOLEAN]

Object
Required. A "ScreenItem" object with the following characteristics:
• TrendRulerControl

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
TrendRulerControl (Page 441)

WinCC Engineering V18 – Programming reference

556 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

BlockShowTitleIcon

Description
Specifies whether the header of the current block is displayed as an icon.
Access in runtime: Read and write

Syntax
Object.BlockShowTitleIcon[=BOOLEAN]

Object
Required. A "ScreenItem" object with the following characteristics:
• TrendRulerControl

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
TrendRulerControl (Page 441)

BlockTimeFormat

Description
Specifies the format of the time information in the current block.
Access in runtime: Read and write

Syntax
Object.BlockTimeFormat[=STRING]

Object
Required. A "ScreenItem" object with the following characteristics:
• TrendRulerControl

STRING
A value or a constant that specifies the format of the time information.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 557
VB scripting
1.5 VBS object model

See also
TrendRulerControl (Page 441)

BlockUseSourceFormat

Description
Specifies whether the format of the connected control is used in the current block.
Access in runtime: Read and write

Syntax
Object.BlockUseSourceFormat[=BOOLEAN]

Object
Required. A "ScreenItem" object with the following characteristics:
• TrendRulerControl

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
TrendRulerControl (Page 441)

BorderBackColor

Description
Specifies the background color of the broken border line.
Access in runtime
• RT Advanced: No access
• RT Professional: Read and write

Syntax
Object.BorderBackColor[=Color]

WinCC Engineering V18 – Programming reference

558 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Object
Required. An object of the type "ScreenItem" with the format:
• Bar
• Button
• CheckBox
• Circle
• CircleSegment
• ComboBox
• Ellipse
• EllipseSegment
• GraphicIOField
• GraphicView
• IOField
• ListBox
• MultiLineEdit
• OptionGroup
• Pölygon
• Rectangle
• RoundButton
• TextField
• WindowSlider
You have no access in runtime with the following format:
• AlarmView
• Clock
• DateTimeField
• Gauge
• RecipeView
• Slider
• StatusForce
• Switch
• SymbolicIOField
• SysDiagControl
• TrendView
• UserView

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 559
VB scripting
1.5 VBS object model

Color
Optional. A value or a constant that specifies the background color of the broken border line.

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
AlarmView (Page 251)
Bar (Page 259)
Button (Page 267)
CheckBox (Page 275)
Clock (Page 287)
ComboBox (Page 290)
DateTimeField (Page 296)
GraphicIOField (Page 324)
GraphicView (Page 327)
Gauge (Page 320)
IOField (Page 332)
Listbox (Page 339)
MultiLineEdit (Page 345)
OptionGroup (Page 371)
RecipeView (Page 389)
RoundButton (Page 398)
Slider (Page 408)
StatusForce (Page 414)
Switch (Page 418)
SymbolicIOField (Page 422)
SysDiagControl (Page 429)
TextField (Page 438)
TrendView (Page 451)
UserView (Page 478)
WindowSlider (Page 482)

WinCC Engineering V18 – Programming reference

560 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

BorderBrightColor3D

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:
• RT Advanced: No access
• RT Professional: Read and write

Syntax
Object.BorderBrightColor3D[=Color]

Object
Required. An object of the type "ScreenItem" with the format:
• Button
• RoundButton
• Slider*
* RT Advanced read and write access
You have no access in runtime with the following format:
• Switch

Color
Optional. A value or a constant that specifies the frame color.

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
Button (Page 267)
RoundButton (Page 398)
Slider (Page 408)
Switch (Page 418)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 561
VB scripting
1.5 VBS object model

BorderColor

Description
Specifies the line color.
Access in runtime:
• RT Advanced: No access
• RT Professional: Read and write

Syntax
Object.BorderColor[=Color]

Object
Required. An object of the type "ScreenItem" with the format:
• Bar
• Button
• CheckBox
• Circle*
• CircleSegment
• ComboBox
• DateTimeField**
• Ellipse*
• EllipseSegment
• FunctionTrendControl
• GraphicIOField
• GraphicView
• IOField
• ListBox
• MultiLineEdit
• OnlineTableControl
• OnlineTrendControl
• OptionGroup
• Polygon*
• Rectangle*
• RoundButton
• SymbolicIOField*
• TextField***

WinCC Engineering V18 – Programming reference

562 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

• TrendRulerControl
• UserArchiveControl
• WindowSlider
* RT Advanced read and write access
** RT Advanced read and write access, RT Professional no access
*** RT Advanced No access
You have no access in runtime with the following format:
• AlarmControl
• AlarmView
• Clock
• Gauge
• RecipeView
• Slider
• StatusForce
• Switch
• SysDiagControl
• TrendView
• UserView

Color
Optional. A value or a constant that specifies the line color.

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
AlarmControl (Page 237)
AlarmView (Page 251)
Bar (Page 259)
Button (Page 267)
CheckBox (Page 275)
Circle (Page 279)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 563
VB scripting
1.5 VBS object model

CircleSegment (Page 282)

Clock (Page 287)
ComboBox (Page 290)
DateTimeField (Page 296)
Ellipse (Page 300)
EllipseSegment (Page 303)
FunctionTrendControl (Page 309)
Gauge (Page 320)
GraphicIOField (Page 324)
GraphicView (Page 327)
IOField (Page 332)
Listbox (Page 339)
MultiLineEdit (Page 345)
OnlineTableControl (Page 347)
OnlineTrendControl (Page 359)
OptionGroup (Page 371)
Polygon (Page 378)
RecipeView (Page 389)
Rectangle (Page 395)
RoundButton (Page 398)
Slider (Page 408)
StatusForce (Page 414)
Switch (Page 418)
SymbolicIOField (Page 422)
SysDiagControl (Page 429)
TextField (Page 438)
TrendRulerControl (Page 441)
TrendView (Page 451)
UserArchiveControl (Page 466)
UserView (Page 478)
WindowSlider (Page 482)

WinCC Engineering V18 – Programming reference

564 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

BorderEnabled

Description
Returns whether the window is displayed with a border in runtime.
Access in runtime: Read and write

Syntax
Object.BorderEnabled[=BOOLEAN]

Object
Required. A "ScreenItem" object with the following format:
• ApplicationWindow
• Screenwindow

BOOLEAN
Optional. TRUE, if the window is displayed with a border in runtime.

See also
ApplicationWindow (Page 257)
ScreenWindow (Page 404)

BorderEndStyle

Description
Specifies the type of line ends.
Access in runtime: Read and write

Syntax
Object.BorderEndStyle[=Int32]

Object
Required. An object of the type "ScreenItem" with the format:
• Connector
• Line
• Polyline

Int32
Optional. A value or a constant that specifies the type of line end.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 565
VB scripting
1.5 VBS object model

See also
Connector (Page 293)
Line (Page 336)
Polyline (Page 381)

BorderFlashingColorOff

Description
Specifies the color of the border line for the flashing status "Off".
Access in runtime:
• RT Advanced: No access
• RT Professional: Read and write

Syntax
Object.BorderFlashingColorOff[=Color]

Object
Required. An object of the type "ScreenItem" with the format:
• Bar
• Button
• CheckBox
• Circle
• CircleSegment
• Ellipse
• EllipseSegment
• GraphicIOField
• GraphicView
• IOField
• OptionGroup
• Polyline
• Polygon
• Rectangle
• RoundButton
• SymbolicIOField
• TextField
• WindowSlider

WinCC Engineering V18 – Programming reference

566 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

You have no access in runtime with the following format:

• Switch

Color
Optional. A value or a constant that specifies the color of the border line for the flashing
status "Off".

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
Bar (Page 259)
Button (Page 267)
CheckBox (Page 275)
GraphicIOField (Page 324)
IOField (Page 332)
OptionGroup (Page 371)
RoundButton (Page 398)
Switch (Page 418)
SymbolicIOField (Page 422)
TextField (Page 438)
WindowSlider (Page 482)

BorderFlashingColorOn

Description
Specifies the color of the border line for the flashing status "On".
Access in runtime:
• RT Advanced: No access
• RT Professional: Read and write

Syntax
Object.BorderFlashingColorOn[=Color]

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 567
VB scripting
1.5 VBS object model

Object
Required. A "ScreenItem" object with the format:
• Bar
• Button
• CheckBox
• Circle
• CircleSegment
• Ellipse
• EllipseSegment
• GraphicIOField
• GraphicView
• IOField
• OptionGroup
• Polyline
• Polygon
• Rectangle
• RoundButton
• SymbolicIOField
• TextField
• WindowSlider
You have no access in runtime with the following format:
• Switch

Color
Optional. A value or a constant that specifies the color of the border line for the flashing
status "On".

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
Bar (Page 259)
Button (Page 267)

WinCC Engineering V18 – Programming reference

568 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

CheckBox (Page 275)

GraphicIOField (Page 324)
IOField (Page 332)
OptionGroup (Page 371)
RoundButton (Page 398)
Switch (Page 418)
SymbolicIOField (Page 422)
WindowSlider (Page 482)

BorderFlashingEnabled

Description
Specifies whether the limit of the object can flash in runtime.
Access in runtime:
• RT Advanced: No access
• RT Professional: Read and write

Syntax
Object.BorderFlashingEnabled[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the format:
• Bar
• Button
• CheckBox
• Circle
• CircleSegment
• Ellipse
• EllipseSegment
• GraphicIOField
• GraphicView
• IOField
• OptionGroup
• Polyline
• Polygon
• Rectangle

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 569
VB scripting
1.5 VBS object model

• RoundButton
• SymbolicIOField
• TextField
You have no access in runtime with the following format:
• 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 259)
Button (Page 267)
CheckBox (Page 275)
GraphicIOField (Page 324)
IOField (Page 332)
OptionGroup (Page 371)
RoundButton (Page 398)
Switch (Page 418)
SymbolicIOField (Page 422)
WindowSlider (Page 482)

BorderFlashingRate

Description
Specifies the flash rate of the border line.
Access in runtime:
• RT Advanced: No access
• RT Professional: Read and write

Syntax
Object.BorderFlashingRate[=FlashingRate]

WinCC Engineering V18 – Programming reference

570 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Object
Required. An object of the type "ScreenItem" with the format:
• Bar
• Button
• CheckBox
• Circle
• CircleSegment
• Ellipse
• EllipseSegment
• GraphicView
• IOField
• OptionGroup
• Polyline
• Polygon
• Rectangle
• RoundButton
• SymbolicIOField
• TextField
• WindowSlider
You have no access in runtime with the following format:
• GraphicIOField
• Switch

FlashingRate
Optional. A value or a constant that specifies the flash rate of the border line.

Value VB constant Explanation

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 259)
Button (Page 267)
CheckBox (Page 275)
GraphicIOField (Page 324)
IOField (Page 332)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 571
VB scripting
1.5 VBS object model

OptionGroup (Page 371)

RoundButton (Page 398)
Switch (Page 418)
SymbolicIOField (Page 422)
WindowSlider (Page 482)

BorderInnerStyle3D

Description
Specifies the appearance of the inner part of the object border.
Access in runtime Read and write

Syntax
Object.BorderInnerStyle3D[=3DStyle]

Object
Required. An object of the type "ScreenItem" with the following format:
• Gauge
• Slider

3DStyle
Optional. A value or a constant that defines how the inside part of the object border is
displayed.

Value VB constant Explanation

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 320)
Slider (Page 408)

WinCC Engineering V18 – Programming reference

572 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

BorderInnerWidth3D

Description
Specifies the width of the inner border for 3D display.
Access in runtime Read and write

Syntax
Object.BorderInnerWidth3D[=Int32]

Object
Required. An object of the type "ScreenItem" with the following format:
• Slider

Int32
Optional. A value or a constant that specifies the width of the inner border in pixels.

See also
Slider (Page 408)

BorderOuterStyle3D

Description
Specifies the appearance of the outer part of the object border.
Access in runtime
• RT Advanced: No access
• RT Professional: Read and write

Syntax
Object.BorderOuterStyle3D[=3DStyle]

Object
Required. An object of the type "ScreenItem" with the following format:
• Gauge
You have no access in runtime with the following format:
• Slider

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 573
VB scripting
1.5 VBS object model

3DStyle
Optional. A value or a constant that defines how the outside part of the object border is
displayed.

Value VB constant Explanation

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 320)
Slider (Page 408)

BorderOuterWidth3D

Description
Specifies the width of the outer border for 3D display.
Access in runtime Read and write

Syntax
Object.BorderOuterWidth3D[=Int32]

Object
Required. An object of the type "ScreenItem" with the following format:
• Slider

Int32
Optional. A value or a constant that specifies the width of the outer border in pixels.

See also
Slider (Page 408)

WinCC Engineering V18 – Programming reference

574 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

BorderShadeColor3D

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:
• RT Advanced: No access
• RT Professional: Read and write

Syntax
Object.BorderShadeColor3D[=Color]

Object
Required. An object of the type "ScreenItem" with the format:
• Button
• Slider*
* RT Advanced read and write access

You have no access in runtime with the following format:

• RoundButton
• Switch

Color
Optional. A value or a constant that specifies the color of the shading.

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
Button (Page 267)
RoundButton (Page 398)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 575
VB scripting
1.5 VBS object model

Slider (Page 408)

Switch (Page 418)

BorderStyle

Description
Specifies the type of border lines.
Access in runtime: Read and write

Syntax
Object.BorderStyle[=Int32]

Object
Required. An object of the type "ScreenItem" with the format:
• Bar
• Button
• CheckBox
• Circle
• CircleSegment
• CircularArc
• ComboBox
• Connector
• Ellipse
• EllipseSegment
• EllipticalArc
• GraphicIOField
• GraphicView
• IOField
• Line
• ListBox
• MultiLineEdit
• Polygon
• Polyline
• Rectangle
• RoundButton
• SymbolicIOField

WinCC Engineering V18 – Programming reference

576 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

• TextField
• WindowSlider
You have no access in runtime with the following format:
• 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
TextField (Page 438)
Bar (Page 259)
Button (Page 267)
CheckBox (Page 275)
ComboBox (Page 290)
GraphicIOField (Page 324)
IOField (Page 332)
Listbox (Page 339)
MultiLineEdit (Page 345)
OptionGroup (Page 371)
RoundButton (Page 398)
SymbolicIOField (Page 422)
WindowSlider (Page 482)

BorderWidth

Description
Specifies the line thickness.
Access in runtime:
• RT Advanced: No access
• RT Professional: Read and write

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 577
VB scripting
1.5 VBS object model

Syntax
Object.BorderWidth[=Int32]

Object
Required. An object of the type "ScreenItem" with the format:
• Ala rmControl
• Bar
• Button
• Circle *
• CircleSegment
• CheckBox
• ComboBox
• Ellipse *
• EllipseSegment
• FunctionTrendControl
• Gauge
• GraphicIOField
• GraphicView
• IOField
• ListBox
• MultiLineEdit
• OnlineTableControl
• OnlineTrendControl
• Polygon *
• Rectangle *
• OptionGroup
• RoundButton
• Slider *
• SymbolicIOField *
• TextField *
• TrendRulerControl
• UserArchiveControl
• WindowSlider
* RT Advanced read and write access

WinCC Engineering V18 – Programming reference

578 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

You have no access in runtime with the following format:

• 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
AlarmControl (Page 237)
AlarmView (Page 251)
Bar (Page 259)
Button (Page 267)
CheckBox (Page 275)
Clock (Page 287)
ComboBox (Page 290)
DateTimeField (Page 296)
FunctionTrendControl (Page 309)
Gauge (Page 320)
GraphicIOField (Page 324)
IOField (Page 332)
Listbox (Page 339)
MultiLineEdit (Page 345)
OnlineTableControl (Page 347)
OnlineTrendControl (Page 359)
OptionGroup (Page 371)
RecipeView (Page 389)
RoundButton (Page 398)
Slider (Page 408)
StatusForce (Page 414)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 579
VB scripting
1.5 VBS object model

Switch (Page 418)

SymbolicIOField (Page 422)
SysDiagControl (Page 429)
TrendRulerControl (Page 441)
TrendView (Page 451)
UserArchiveControl (Page 466)
UserView (Page 478)
WindowSlider (Page 482)

BorderWidth3D

Description
Specifies the width of the inner border for 3D display.
Access in runtime
• RT Advanced: No access
• RT Professional: Read and write

Syntax
Object.BorderWidth3D[=Int32]

Object
Required. An object of the type "ScreenItem" with the format:
• Button
• Gauge
• RoundButton
You have no access in runtime with the following format:
• 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 259)
Button (Page 267)

WinCC Engineering V18 – Programming reference

580 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Gauge (Page 320)

IOField (Page 332)
RoundButton (Page 398)
Switch (Page 418)

BottomMargin

Description
No access in runtime.

Bounds

Description
No access in runtime.

BrowserTypeUsed

Description
No access in runtime.

BufferViewColumnOrder

Description
No access in runtime.

BufferViewInternalRowOrder

Description
No access in runtime.

BusyText

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 581
VB scripting
1.5 VBS object model

ButtonBackColor

Description
No access in runtime.

ButtonBackFillStyle

Description
No access in runtime.

ButtonBarElements

Description
No access in runtime.

ButtonBarHeight

Description
No access in runtime.

ButtonBarStyle

Description
No access in runtime.

ButtonBorderBackColor

Description
No access in runtime.

ButtonBorderColor

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

582 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

ButtonBorderWidth

Description
No access in runtime.

ButtonCornerRadius

Description
No access in runtime.

ButtonEdgeStyle

Description
No access in runtime.

ButtonFirstGradientColor

Description
No access in runtime.

ButtonFirstGradientOffset

Description
No access in runtime.

ButtonMiddleGradientColor

Description
No access in runtime.

ButtonPositions

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 583
VB scripting
1.5 VBS object model

ButtonSecondGradientColor

Description
No access in runtime.

ButtonSecondGradientOffset

Description
No access in runtime.

BV_ColumnWidth_Date

Description
No access in runtime.

BV_ColumnWidth_Event

Description
No access in runtime.

BV_ColumnWidth_EventSeverity

Description
No access in runtime.

BV_ColumnWidth_EventState

Description
No access in runtime.

BV_ColumnWidth_Number

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

584 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

BV_ColumnWidth_Time

Description
No access in runtime.

BV_ItemText_Date

Description
No access in runtime.

BV_ItemText_Event

Description
No access in runtime.

BV_ItemText_EventSeverity

Description
No access in runtime.

BV_ItemText_EventState

Description
No access in runtime.

BV_ItemText_Number

Description
No access in runtime.

BV_ItemText_Time

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 585
VB scripting
1.5 VBS object model

BV_ShowItem_Date

Description
No access in runtime.

BV_ShowItem_Event

Description
No access in runtime.

BV_ShowItem_EventSeverity

Description
No access in runtime.

BV_ShowItem_EventState

Description
No access in runtime.

BV_ShowItem_Number

Description
No access in runtime.

BV_ShowItem_Time

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

586 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

1.5.5.3 Properties C

CameraUrl

Description
No access in runtime.

CanBeGrouped

Description
No access in runtime.

Caption

Description
Specifies the text to be displayed in the header.
Access in runtime:
• RT Advanced: No access
• RT Professional: Read and write

Syntax
Object.Caption[=STRING]

Object
Required. An object of the type "ScreenItem" with the format:
• AlarmControl
• FunctionTrendControl
• OnlineTrendControl
• Slider *
• TrendRulerControl
• UserArchiveControl
* RT Advanced read and write access
You have no access in runtime with the following format:
• OnlineTableControl

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 587
VB scripting
1.5 VBS object model

STRING
Optional. A value or a constant that contains the text that will be shown in the title line.

See also
AlarmControl (Page 237)
FunctionTrendControl (Page 309)
OnlineTableControl (Page 347)
OnlineTrendControl (Page 359)
Slider (Page 408)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

CaptionBackColor

Description
Specifies the background color of the title bar.
Access in runtime Read and write

Syntax
Object.CaptionBackColor[=Color]

Object
Required. An object of the type "ScreenItem" with the following format:
• SymbolicIOField

Color
Optional. A value or a constant that specifies the background color of the title bar.

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
SymbolicIOField (Page 422)

WinCC Engineering V18 – Programming reference

588 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

CaptionColor

Description
Specifies the color of the text to be displayed in the title bar.
Access in runtime Read and write

Syntax
Object.CaptionColor[=Color]

Object
Required. An object of the type "ScreenItem" with the format:
• Gauge
• Switch
• SymbolicIOField

Color
Optional. A value or a constant that specifies the text color.

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
Gauge (Page 320)
Switch (Page 418)
SymbolicIOField (Page 422)

CaptionFont

Description
Sets the font.
Access in runtime:
• RT Advanced: No access
• RT Professional: Read and write

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 589
VB scripting
1.5 VBS object model

Syntax
Object.CaptionFont[=Font]

Object
Required. A "ScreenItem" object with the characteristics:
• 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 320)
Switch (Page 418)

CaptionText

Description
Specifies the text to be displayed in the header.
Access in runtime Read and write

Syntax
Object.CaptionText[= STRING]

Object
Required. An object of the type "ScreenItem" with the format:
• 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 320)
ScreenWindow (Page 404)
Switch (Page 418)

WinCC Engineering V18 – Programming reference

590 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

CaptionTop

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.
Access in runtime Read and write

Syntax
Object.CaptionTop[=DOUBLE]

Object
Required. An object of the type "ScreenItem" with the following format:
• 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 320)

CellCut

Description
Specifies whether the contents of the cells are abbreviated if the cells are too narrow.
Access in runtime Read and write

Syntax
Object.CellCut[=BOOLEAN]

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 591
VB scripting
1.5 VBS object model

Object
Required. An object of the type "ScreenItem" with the format:
• AlarmControl
• OnlineTableControl
• TrendRulerControl
You have no access in runtime with the following format:
• UserArchiveControl

BOOLEAN
Optional.
TRUE, if the contents are abbreviated.

See also
AlarmControl (Page 237)
OnlineTableControl (Page 347)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

CellSpaceBottom

Description
Specifies the bottom margin of the table cells.
Access in runtime: Read and write

Syntax
Object.CellSpaceBottom[=Int32]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• OnlineTableControl
• TrendRulerControl
• UserArchiveControl

Int32
Optional. A value or constant that defines the bottom margin used in the table cells.

WinCC Engineering V18 – Programming reference

592 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

See also
AlarmControl (Page 237)
OnlineTableControl (Page 347)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

CellSpaceLeft

Description
Specifies the left indent used in the table cells.
Access in runtime: Read and write

Syntax
Object.CellSpaceLeft[=Int32]

Object
Required. A "ScreenItem" object with the following format:
• AlarmControl
• OnlineTableControl
• TrendRulerControl
• UserArchiveControl

Int32
Optional A value or parameter that defines the left indent in the table cells.

See also
AlarmControl (Page 237)
OnlineTableControl (Page 347)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

CellSpaceRight

Description
Specifies the right indent used in the table cells.
Access in runtime: Read and write

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 593
VB scripting
1.5 VBS object model

Syntax
Object.CellSpaceRight[=Int32]

Object
Required. A "ScreenItem" object with the following formats:
• AlarmControl
• OnlineTableControl
• TrendRulerControl
• UserArchiveControl

Int32
Optional A value or constant that defines the right indent used in the table cells.

See also
AlarmControl (Page 237)
OnlineTableControl (Page 347)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

CellSpaceTop

Description
Defines the top margin of the table cells.
Access in runtime: Read and write

Syntax
Object.CellSpaceTop[=Int32]

Object
Required. A "ScreenItem" object with the following formats:
• AlarmControl
• OnlineTableControl
• TrendRulerControl
• UserArchiveControl

Int32
Optional A value or constant that defines the top margin used in the table cells.

WinCC Engineering V18 – Programming reference

594 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

See also
AlarmControl (Page 237)
OnlineTableControl (Page 347)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

CenterColor

Description
Specifies the color of the center point.
Access in runtime Read and write

Syntax
Object.CenterColor[=Color]

Object
Required. An object of the type "ScreenItem" with the following format:
• Gauge

Color
Optional. A value or a constant that specifies the color of the center.

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
Gauge (Page 320)

CenterSize

Description
Specifies the diameter of the scale center point.
Access in runtime: Read and write

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 595
VB scripting
1.5 VBS object model

Syntax
Object.CenterSize[=SINGLE]

Object
Required. A "ScreenItem" object with the following format:
• 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 320)

ChangeMouseCursor

Description
Specifies how the appearance of the cursor changes in runtime when it is above the icon.
Access in runtime Read and write

Syntax
Object.ChangeMouseCursor[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• 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
SymbolLibrary (Page 427)

WinCC Engineering V18 – Programming reference

596 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

CheckMarkAlignment

Description
Specifies whether the fields are right-aligned.
Access in runtime: Read and write

Syntax
Object.CheckMarkAlignment[=CheckMarkAlignment]

Object
Required. An object of the type "ScreenItem" with the format:
• 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
OptionGroup (Page 371)
CheckBox (Page 275)

CheckMarkCount

Description
Specifies the number of fields.
Access in runtime: Read and write

Syntax
Object.CheckMarkCount[=Int32]

Object
Required. An object of the type "ScreenItem" with the format:
• CheckBox
• OptionGroup

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 597
VB scripting
1.5 VBS object model

Int32
Optional. A value or a constant that specifies the number of fields. Value range from 0 to 31

See also
OptionGroup (Page 371)
CheckBox (Page 275)

ClearOnError

Description
Specifies whether an invalid input in this object will be deleted automatically.
Access in runtime: Read and write

Syntax
Object.ClearOnError[=BOOLEAN]

Object
Required. A "ScreenItem" object with the following format:
• IOField

BOOLEAN
Optional TRUE, if an invalid input in this object will be deleted automatically.

See also
IOField (Page 332)

ClearOnFocus

Description
Specifies whether the field entry will be deleted as soon as the I/O field is activated.
Access in runtime: Read and write

Syntax
Object.ClearOnFocus[=BOOLEAN]

WinCC Engineering V18 – Programming reference

598 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Object
Required. A "ScreenItem" object with the following format:
• IOField

BOOLEAN
Optional TRUE, if the field entry is deleted as soon as the I/O field is activated.

See also
IOField (Page 332)

Closeable

Description
Specifies whether the object can be closed in runtime.
Access in runtime: Read and write

Syntax
Object.Closeable[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the format:
• AlarmControl
• FunctionTrendControl
• OnlineTableControl
• OnlineTrendControl
• TrendRulerControl
• UserArchiveControl

BOOLEAN
Optional. TRUE if the object can be closed in runtime.

See also
AlarmControl (Page 237)
FunctionTrendControl (Page 309)
OnlineTableControl (Page 347)
OnlineTrendControl (Page 359)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 599
VB scripting
1.5 VBS object model

TrendRulerControl (Page 441)

UserArchiveControl (Page 466)

Color

Description
Specifies the line color.
Access in runtime: Read and write

Syntax
Object.Color[=Color]

Object
Required. An object of the type "ScreenItem" with the format:
• CircularArc
• Connector
• EllipticalArc
• Line
• Polyline
• TubeArcObject
• TubeDoubleTeeObject
• TubeTeeObject
• Tubepolyline

Color
Optional. A value or a constant that specifies the line color.

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
CircularArc (Page 285)
Connector (Page 293)

WinCC Engineering V18 – Programming reference

600 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

EllipticalArc (Page 306)

Line (Page 336)
Polyline (Page 381)
TubeArcObject (Page 457)
TubeDoubleTeeObject (Page 459)
TubePolyline (Page 461)
TubeTeeObject (Page 464)

ColorChangeHysteresis

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.
Access in runtime: Read and write

Syntax
Object.ColorChangeHysteresis[=DOUBLE]

Object
Required. A "ScreenItem" object with the following format:
• Bar

DOUBLE
Optional A value or a constant that specifies the hysteresis as a percentage of the display
value.

See also
Bar (Page 259)

ColorChangeHysteresisEnabled

Description
Determines whether the object will be displayed with a hysteresis.
Access in runtime: Read and write

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 601
VB scripting
1.5 VBS object model

Syntax
Object.ColorChangeHysteresisEnabled[=BOOLEAN]

Object
Required. A "ScreenItem" object with the following format:
• Bar

BOOLEAN
Optional TRUE, if the object will be displayed with a hysteresis.

See also
Bar (Page 259)

ColumnAdd

Description
Creates a new column. The newly created column is automatically referenced with
"ColumnIndex".
Access in runtime Read and write

Syntax
Object.ColumnAdd[=STRING]

Object
Required. An object of the type "ScreenItem" with the format:
• TrendRulerControl

STRING
Required. A value or a constant that specifies the name of a new column.

See also
ColumnIndex (Page 609)
TrendRulerControl (Page 441)

ColumnAlias

Description
Returns the display name of the column referenced with "ColumnIndex".

WinCC Engineering V18 – Programming reference

602 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Access in runtime Read and write

Syntax
Object.ColumnAlias[=STRING]

Object
Required. An object of the type "ScreenItem" with the format:
• UserArchiveControl

STRING
Optional. A value or a constant that specifies the display name of the column.

See also
UserArchiveControl (Page 466)

ColumnAlignment

Description
Specifies the alignment of the column content in a column referenced with "ColumnIndex".
Access in runtime Read and write

Syntax
Object.ColumnAlignment[=HorizontalAlignment]

Object
Required. An object of the type "ScreenItem" with the format:
• UserArchiveControl

HorizontalAlignment
Optional. A value or constant that determines the horizontal alignment.

Value Designation Description

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
UserArchiveControl (Page 466)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 603
VB scripting
1.5 VBS object model

ColumnAutoPrecisions

Description
Specifies whether the number of decimal places for a column referenced with "ColumnIndex" is
set automatically.
Access in runtime Read and write

Syntax
Object.ColumnAutoPrecisions[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the format:
• UserArchiveControl

BOOLEAN
Optional.
TRUE if the number of decimal places is automatically determined.
FALSE if the value of "ColumnPrecisions" is used.

See also
UserArchiveControl (Page 466)

ColumnCaption

Description
Specifies the header of the current column.
Access in runtime: Read and write

Syntax
Object.ColumnCaption[=STRING]

Object
Required. A "ScreenItem" object with the characteristics:
• UserArchiveControl

STRING
Optional. A value or a constant that specifies the header of the current column.

WinCC Engineering V18 – Programming reference

604 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

See also
UserArchiveControl (Page 466)

ColumnCount

Description
Specifies the number of configured columns.
Access in runtime Read and write

Syntax
Object.ColumnCount[=Int32]

Object
Required. An object of the type "ScreenItem" with the format:
• TrendRulerControl
• UserArchiveControl

Int32
Optional. A value or a constant that specifies the number of configured columns.

See also
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

ColumnDateFormat

Description
Specifies the date format.
Access in runtime Read and write

Syntax
Object.ColumnDateFormat[=STRING]

Object
Required. An object of the type "ScreenItem" with the format:
• UserArchiveControl

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 605
VB scripting
1.5 VBS object model

STRING
Optional. A value or a constant that specifies the date format.

See also
UserArchiveControl (Page 466)

ColumnDMVarName

Description
Specifies the name of a tag.
Access in runtime: Read and write

Syntax
Object.ColumnDMVarName[=STRING]

Object
Required. A "ScreenItem" object with the characteristics:
• UserArchiveControl

STRING
Optional. A value or a constant that specifies the name of a tag.

See also
UserArchiveControl (Page 466)

ColumnExponentialFormat

Description
Specifies whether the values of a column referenced with "ColumnIndex" are displayed in
exponential notation.
Access in runtime Read and write

Syntax
Object.ColumnExponentialFormat[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the format:
• UserArchiveControl

WinCC Engineering V18 – Programming reference

606 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

BOOLEAN
Optional.
TRUE if the values are displayed in exponential notation.
FALSE if the values are not displayed in exponential notation.

See also
ColumnIndex (Page 609)
UserArchiveControl (Page 466)

ColumnFlagNotNull

Description
Specifies whether the user archive field assigned to a column referenced with "ColumnIndex" has
to have a value.
Access in runtime Read and write

Syntax
Object.ColumnFlagNotNull[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• UserArchiveControl

BOOLEAN
Optional.
TRUE, if a value is required.
FALSE, if no value is required.

See also
UserArchiveControl (Page 466)

ColumnFlagUnique

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.
Access in runtime Read and write

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 607
VB scripting
1.5 VBS object model

Syntax
Object.ColumnFlagUnique[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• UserArchiveControl

BOOLEAN
Optional.
TRUE, if the value must be unique.
FALSE, if the value does not have to be unique.

See also
UserArchiveControl (Page 466)

ColumnHideText

Description
Specifies whether the text in a column referenced with "ColumnIndex" is hidden.
Access in runtime Read and write

Syntax
Object.ColumnHideText[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• UserArchiveControl

BOOLEAN
Optional.
TRUE, if the text in the current column is hidden.
FALSE, if the text in the current column is shown.

See also
UserArchiveControl (Page 466)

WinCC Engineering V18 – Programming reference

608 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

ColumnHideTitleText

Description
Specifies whether the header of a column referenced with "ColumnIndex" is hidden.
Access in runtime Read and write

Syntax
Object.ColumnHideTitleText[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• UserArchiveControl

BOOLEAN
Optional.
TRUE if the header of the referenced column is hidden.
FALSE if the header of the referenced column is displayed.

See also
UserArchiveControl (Page 466)

ColumnIndex

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.
Access in runtime Read and write

Syntax
Object.ColumnIndex[=Int32]

Object
Required. An object of the type "ScreenItem" with the following format:
• TrendRulerControl
• UserArchiveControl

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 609
VB scripting
1.5 VBS object model

Int32
Optional. A value or a constant that the specifies the column to be edited over the index.

See also
ColumnCount (Page 605)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

ColumnLeadingZeros

Description
Specifies how many leading zeros are displayed for the values of a column referenced with
"ColumnIndex".
Access in runtime Read and write

Syntax
Object.ColumnLeadingZeros[=Int32]

Object
Required. An object of the type "ScreenItem" with the following format:
• UserArchiveControl

Int32
Optional. A value or a constant that specifies the number of leading zeros. The maximum
number is 11.

See also
UserArchiveControl (Page 466)

ColumnLength

Description
Specifies the number of characters displayed in a column referenced with "ColumnIndex".
Access in runtime Read and write

Syntax
Object.ColumnLength[=Int32]

WinCC Engineering V18 – Programming reference

610 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Object
Required. An object of the type "ScreenItem" with the following format:
• UserArchiveControl

Int32
Optional. A value or a constant that specifies the number of characters displayed.

See also
UserArchiveControl (Page 466)

ColumnMaxValue

Description
Returns the maximum value defined in the user archive of a column referenced with
"ColumnIndex".
Access in runtime Read and write

Syntax
Object.ColumnMaxValue[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• UserArchiveControl

STRING
Optional. A value or a constant that returns the maximum value of the column specified in
the user log.

See also
UserArchiveControl (Page 466)

ColumnMinValue

Description
Returns the minimum value defined in the user archive of a column referenced with
"ColumnIndex".
Access in runtime Read and write

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 611
VB scripting
1.5 VBS object model

Syntax
Object.ColumnMinValue[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• UserArchiveControl

STRING
Optional. A value or a constant that returns the minimum value of the column specified in
the user log.

See also
UserArchiveControl (Page 466)

ColumnName

Description
Specifies the name of a column referenced with "ColumnIndex".
Access in runtime Read and write

Syntax
Object.ColumnName[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• TrendRulerControl
• UserArchiveControl

STRING
Optional. A value or a constant that returns the name of the referenced column.

See also
ColumnIndex (Page 609)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

WinCC Engineering V18 – Programming reference

612 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

ColumnOrder

Description
No access in runtime.

ColumnPosition

Description
Specifies the position of a column referenced with "ColumnIndex".
Access in runtime Read and write

Syntax
Object.ColumnPosition[=Int32]

Object
Required. An object of the type "ScreenItem" with the following format:
• UserArchiveControl

Int32
Optional. A value or a constant that specifies the position of the column.

See also
UserArchiveControl (Page 466)

ColumnPrecisions

Description
Specifies the number of decimal places in a column referenced with "ColumnIndex".
Access in runtime Read and write

Syntax
Object.ColumnPrecisions[=Int16]

Object
Required. An object of the type "ScreenItem" with the following format:
• UserArchiveControl

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 613
VB scripting
1.5 VBS object model

Int16
Optional. A value or a constant that specifies the number of decimal places in the column.

See also
UserArchiveControl (Page 466)

ColumnReadAccess

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.
Access in runtime Read and write

Syntax
Object.ColumnReadAccess[=Int32]

Object
Required. An object of the type "ScreenItem" with the following format:
• UserArchiveControl

Int32
Optional. A value or a constant that returns the authorization for read access specified in the
user log to the column.

See also
UserArchiveControl (Page 466)

ColumnReadonly

Description
Specifies whether the values of a column referenced with "ColumnIndex" can only be read.
Access in runtime Read and write

Syntax
Object.ColumnReadonly[=BOOLEAN]

WinCC Engineering V18 – Programming reference

614 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Object
Required. An object of the type "ScreenItem" with the following format:
• UserArchiveControl

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
UserArchiveControl (Page 466)

ColumnRemove

Description
Removes a column referenced with its name.
Access in runtime Read and write

Syntax
Object.ColumnRemove[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• TrendRulerControl

STRING
Optional. A value or a constant that returns the name of the referenced column to be
removed.

See also
TrendRulerControl (Page 441)

ColumnRepos

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".

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 615
VB scripting
1.5 VBS object model

Access in runtime Read and write

Syntax
Object.ColumnRepos[=Int32]

Object
Required. An object of the type "ScreenItem" with the following format:
• TrendRulerControl
• UserArchiveControl

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
ColumnIndex (Page 609)
ColumnCount (Page 605)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

ColumnResize

Description
Specifies whether you can change the width of the columns.
Access in runtime Read and write

Syntax
Object.ColumnResize[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• OnlineTableControl
• TrendRulerControl
• UserArchiveControl

WinCC Engineering V18 – Programming reference

616 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

BOOLEAN
Optional.
TRUE if you can change the width of the columns.
FALSE if you cannot change the width of the columns.

See also
AlarmControl (Page 237)
OnlineTableControl (Page 347)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

Columns

Description
No access in runtime.

ColumnScrollbar

Description
Specifies when the horizontal scroll bar is to be displayed.
Access in runtime Read and write

Syntax
Object.ColumnScrollbar[=ScrollbarVisibility]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• OnlineTableControl
• TrendRulerControl
• UserArchiveControl

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 617
VB scripting
1.5 VBS object model

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.

See also
UserArchiveControl (Page 466)
TrendRulerControl (Page 441)
OnlineTableControl (Page 347)
AlarmControl (Page 237)

ColumnSettings

Description
No access in runtime.

ColumnSettingsBufferView

Description
No access in runtime.

ColumnShowDate

Description
Specifies whether the date is to be displayed in a column referenced with "ColumnIndex".
Access in runtime Read and write

Syntax
Object.ColumnShowDate[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• UserArchiveControl

WinCC Engineering V18 – Programming reference

618 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

BOOLEAN
Optional.
TRUE, if the date is displayed in the column.
FALSE, if the date is not displayed in the column.

See also
UserArchiveControl (Page 466)

ColumnShowIcon

Description
Specifies whether a symbol is to be displayed in a column referenced with "ColumnIndex".
Access in runtime Read and write

Syntax
Object.ColumnShowIcon[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• UserArchiveControl

BOOLEAN
Optional.
TRUE, if an icon is displayed in the column.
FALSE, if no icon is displayed in the column.

See also
UserArchiveControl (Page 466)

ColumnShowTitleIcon

Description
Specifies whether a symbol is to be displayed in a column referenced with "ColumnIndex".
Access in runtime Read and write

Syntax
Object.ColumnShowTitleIcon[=BOOLEAN]

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 619
VB scripting
1.5 VBS object model

Object
Required. An object of the type "ScreenItem" with the following format:
• UserArchiveControl

BOOLEAN
Optional.
TRUE, if an icon is displayed in the column.
FALSE, if no icon is displayed in the column.

See also
UserArchiveControl (Page 466)

ColumnsMoveable

Description
No access in runtime.

ColumnSort

Description
Specifies the sorting type of a column referenced with "ColumnIndex".
Access in runtime Read and write

Syntax
Object.ColumnSort[=SortMode]

Object
Required. An object of the type "ScreenItem" with the following format:
• TrendRulerControl
• UserArchiveControl

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

WinCC Engineering V18 – Programming reference

620 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

See also
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

ColumnSortIndex

Description
Specifies the sorting order for a column referenced with "ColumnIndex" in which the columns
are sorted one after another.
Access in runtime Read and write

Syntax
Object.ColumnSortIndex[=Int32]

Object
Required. An object of the type "ScreenItem" with the following format:
• TrendRulerControl
• UserArchiveControl

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 620)" 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
ColumnIndex (Page 609)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

ColumnStartValue

Description
Returns the start value defined in the user log of a column referenced with "ColumnIndex".
Access in runtime Read and write

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 621
VB scripting
1.5 VBS object model

Syntax
Object.ColumnStartValue[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• UserArchiveControl

STRING
Optional. A value or a constant that returns the start value of the column specified in the user
log.

See also
UserArchiveControl (Page 466)

ColumnStringLength

Description
Returns the string length defined in the user archive for a column referenced with
"ColumnIndex".
Access in runtime Read and write

Syntax
Object.ColumnStringLength[=Int32]

Object
Required. An object of the type "ScreenItem" with the following format:
• UserArchiveControl

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
UserArchiveControl (Page 466)

ColumnTextAckGroup

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

622 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

ColumnTextAlarmState

Description
No access in runtime.

ColumnTextAlarmText

Description
No access in runtime.

ColumnTextBit

Description
No access in runtime.

ColumnTextClassName

Description
No access in runtime.

ColumnTextConnection

Description
No access in runtime.

ColumnTextDataType

Description
No access in runtime.

ColumnTextDate

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 623
VB scripting
1.5 VBS object model

ColumnTextDateTime

Description
No access in runtime.

ColumnTextDbNumber

Description
No access in runtime.

ColumnTextDevice

Description
No access in runtime.

ColumnTextDiagnosable

Description
No access in runtime.

ColumnTextFormat

Description
No access in runtime.

ColumnTextGroup

Description
No access in runtime.

ColumnTextLogTime

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

624 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

ColumnTextNumber

Description
No access in runtime.

ColumnTextOffset

Description
No access in runtime.

ColumnTextPassword

Description
No access in runtime.

ColumnTextRead

Description
No access in runtime.

ColumnTextTagConnection

Description
No access in runtime.

ColumnTextTime

Description
No access in runtime.

ColumnTextTrend

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 625
VB scripting
1.5 VBS object model

ColumnTextType

Description
No access in runtime.

ColumnTextUser

Description
No access in runtime.

ColumnTextValue

Description
No access in runtime.

ColumnTextWrite

Description
No access in runtime.

ColumnTextXValue

Description
No access in runtime.

ColumnTimeFormat

Description
Specifies the time format for a column referenced with "ColumnIndex".
Access in runtime Read and write

Syntax
Object.ColumnTimeFormat[=STRING]

WinCC Engineering V18 – Programming reference

626 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Object
Required. An object of the type "ScreenItem" with the following format:
• UserArchiveControl

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
UserArchiveControl (Page 466)

ColumnTitleAlignment

Description
Specifies the alignment of the header in a column referenced with "ColumnIndex".
Access in runtime Read and write

Syntax
Object.ColumnTitleAlignment[=GridColumnHeaderHorizontalAlignment]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• OnlineTableControl
• TrendRulerControl
• UserArchiveControl

GridColumnHeaderHorizontalAlignment
Optional. A value or a constant that specifies the column header alignment.

Value Designation Description

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 603)" property for the column content.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 627
VB scripting
1.5 VBS object model

See also
AlarmControl (Page 237)
OnlineTableControl (Page 347)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

ColumnTitles

Description
Specifies whether the column header is displayed.
Access in runtime: Read and write

Syntax
Object.ColumnTitles[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the format:
• AlarmControl
• OnlineTableControl
• TrendRulerControl
• UserArchive Control

BOOLEAN
Optional.
TRUE if the column header is displayed.
FALSE if the column header is not displayed.

See also
AlarmControl (Page 237)
OnlineTableControl (Page 347)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

ColumnType

Description
Returns the data type defined in the user archive of a column referenced with "ColumnIndex".

WinCC Engineering V18 – Programming reference

628 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Access in runtime Read and write

Syntax
Object.ColumnType[=Int32]

Object
Required. An object of the type "ScreenItem" with the following format:
• UserArchiveControl

Int32
Optional. A value or a constant that returns the data type of the column specified in the user
log.

See also
UserArchiveControl (Page 466)

ColumnVisible

Description
Specifies whether the column referenced with "ColumnIndex" is displayed in the object.
Access in runtime Read and write

Syntax
Object.ColumnVisible[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• TrendRulerControl
• UserArchiveControl

BOOLEAN
Optional.
TRUE if the referenced column is displayed.
FALSE if the referenced column is not displayed.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 629
VB scripting
1.5 VBS object model

See also
ColumnIndex (Page 609)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

ColumnWidth

Description
No access in runtime.

ColumnWriteAccess

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.
Access in runtime Read and write

Syntax
Object.ColumnWriteAccess[=Int32]

Object
Required. An object of the type "ScreenItem" with the following format:
• UserArchiveControl

Int32
Optional. A value or a constant that returns the authorization for write access specified in the
user log to the column.

See also
UserArchiveControl (Page 466)

ComboboxFont

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

630 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

CompatibilityMode

Description
No access in runtime.

ComplexViewToolbar

Description
No access in runtime.

ComplexViewToolbarBounds

Description
No access in runtime.

ComponentInfoText

Description
No access in runtime.

ComputerName

Description
Returns the name of the computer on which the alarm object was triggered.
ComputerName (readonly)

ConfiguredAlarmClasses

Description
No access in runtime.

ConnectionType

Description
Specifies the type of connector. You can select one of two connection types.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 631
VB scripting
1.5 VBS object model

Access in runtime:
• RT Advanced: No access
• RT Professional: Read and write

Syntax
Object.ConnectionType[=ConnectorConnectionType]

Object
Required. An object of the type "ScreenItem" with the format:
• Connector
You have no access in runtime with the following format:
• 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
Connector (Page 293)
SmartClientView (Page 412)

ConnectOnStart

Description
No access in runtime.

ConnectTrendWindows

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

WinCC Engineering V18 – Programming reference

632 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Access in runtime Read and write

Syntax
Object.ConnectTrendWindows[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl
• OnlineTrendControl

BOOLEAN
Optional.
TRUE if all configured trend views are connected.
FALSE if the trend views are displayed separately.

See also
FunctionTrendControl (Page 309)
OnlineTrendControl (Page 359)

Context

Description
Reads or sets the alarm object server prefix.

ContinousChange

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.
Access in runtime: Read and write

Syntax
Object.ContinousChange[=BOOLEAN]

Object
Required. A "ScreenItem" object with the following format:
• Slider

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 633
VB scripting
1.5 VBS object model

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 408)

ControlDesignMode

Description
Specifies the control design.
Access in runtime Read and write

Syntax
Object.ControlDesignMode[=RTControlModes]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• FunctionTrendControl
• OnlineTableControl
• OnlineTrendControl
• TrendRulerControl
• UserArchiveControl

RTControlModes
Optional. A value or a constant that specifies the control design.

Value Designation Description

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
AlarmControl (Page 237)
FunctionTrendControl (Page 309)
OnlineTableControl (Page 347)
OnlineTrendControl (Page 359)

WinCC Engineering V18 – Programming reference

634 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

TrendRulerControl (Page 441)

UserArchiveControl (Page 466)

CornerRadius

Description
No access in runtime.

CornerStyle

Description
Specifies the shape of the corners.
Access in runtime:
• RT Advanced: No access
• RT Professional: Read and write

Syntax
Object.CornerStyle[=CornerStye | LineJoinStyle]

Object
Required. An object of the type "ScreenItem" with the format:
• Bar
• Button
• CheckBox
• Circle
• CircleSegment
• CircularArc
• ComboBox
• Connector
• Ellipse
• EllipseSegment
• EllipticalArc
• GraphicIOField
• GraphicView
• IOField
• Line

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 635
VB scripting
1.5 VBS object model

• ListBox
• MultiLineEdit
• OptionGroup
• Polygon
• Polyline
• Rectangle
• RoundButton
• SymbolicIOField
• TextField
• Tubepolyline
• WindowSlider
You have no access in runtime with the following format:
• 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
3 Dashed and dotted line
4 Dash-dot-dot line

Count

Description
Returns the number of elements in the specified list.
Access in Runtime: Read

Syntax
Object.Count

Object
Required A "Collection" object.

WinCC Engineering V18 – Programming reference

636 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

CountDivisions

Description
Specifies the number of segments in which the bar will be divided by the large marking lengths
of the scale.
Access in runtime: Read and write

Syntax
Object.CountDivisions[=Int32]

Object
Required. A "ScreenItem" object with the following format:
• 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 259)

CountOfLinesPerAlarms

Description
No access in runtime.

CountOfVisibleAlarms

Description
No access in runtime.

CountSubDivisions

Description
Specifies the number of scale marks between two main marks.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 637
VB scripting
1.5 VBS object model

Access in runtime Read and write

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 259)

CountVisibleItems

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:
• RT Advanced: Read
• RT Professional: Read and write

Syntax
Object.CountVisibleItems[=Int32]

Object
Required. A "ScreenItem" object with the format:
• ComboBox
• ListBox
• SymbolicIOField
You have no access in runtime with the following format:
• StatusForce
• TrendView
• UserView

WinCC Engineering V18 – Programming reference

638 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Int32
Optional A value or a constant that specifies how many lines the selection list will contain.

See also
ComboBox (Page 290)
Listbox (Page 339)
SymbolicIOField (Page 422)
StatusForce (Page 414)
TrendView (Page 451)
UserView (Page 478)

CurrentContext

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.
Access in Runtime: Read

Syntax
Object.CurrentContext

Object
Required A "HMIRuntime" object.

See also
HMIRuntime (Page 209)

CursorControl

Description
Specifies whether the mouse cursor jumps to the next field of the TAB sequence after leaving the
field.
Access in runtime: Read and write

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 639
VB scripting
1.5 VBS object model

Syntax
Object.CursorControl[=BOOLEAN]

Object
Required. A "ScreenItem" object with the following format:
• 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 332)
SymbolicIOField (Page 422)

Curves

Description
No access in runtime.

1.5.5.4 Properties D

DangerRangeColor

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.
Access in runtime Read and write

Syntax
Object.DangerRangeColor[=Color]

WinCC Engineering V18 – Programming reference

640 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Object
Required. An object of the type "ScreenItem" with the following format:
• Gauge

Color
Optional. A value or a constant that specifies the color of the warning range.

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
Gauge (Page 320)

DangerRangeStart

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.
Access in runtime Read and write

Syntax
Object.DangerRangeStart[=SINGLE]

Object
Required. An object of the type "ScreenItem" with the following format:
• 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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 641
VB scripting
1.5 VBS object model

See also
Gauge (Page 320)

DangerRangeVisible

Description
Specifies whether the warning range in the scale of the "Gauge" object will be displayed.
Access in runtime: Read and write

Syntax
Object.DangerRangeVisible[=BOOLEAN]

Object
Required. A "ScreenItem" object with the following format:
• 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 320)

DataFormat

Description
Returns the display format.
Access in runtime: Read and write

Syntax
Object.DataFormat[=IOFieldDataFormat]

WinCC Engineering V18 – Programming reference

642 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Object
Required. An object of the type "ScreenItem" with the format:
• IOField

IOFieldDataFormat
Optional. A value or a constant that returns the display format.

Value Designation Description

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 332)

DataLogs

Description
Returns an object of type "DataLogs".
Access in Runtime: Read

Syntax
Object.DataLogs

Object
Required A "Logging" object.

See also
Logging (Page 214)

DataProviderGuid

Description
Returns the GUID of the control.
Access in Runtime: Read

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 643
VB scripting
1.5 VBS object model

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
UserArchiveControl (Page 466)

DataRecordNameCaption

Description
No access in runtime.

DataRecordNrCaption

Description
No access in runtime.

DataSet

Description
Returns an object of type "DataSet".
Access in Runtime: Read

Syntax
Object.DataSet

Object
Required A "Screen" object.

WinCC Engineering V18 – Programming reference

644 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

See also
HMIRuntime (Page 209)
Screen (Page 216)

DataSource

Description
No access in runtime.

DefaultFilterEom

Description
No access in runtime.

DefaultHitListFilterEom

Description
No access in runtime.

DefaultMsgFilterSQL

Description
Specifies an SQL statement as default for alarm filter.
Access in runtime: Read and write

Syntax
Object.DefaultMsgFilterSQL[=STRING]

Object
Required. A "ScreenItem" object with the following characteristics:
• AlarmControl

STRING
Optional. A value or a constant that specifies an SQL statement as default for alarm filter.

See also
AlarmControl (Page 237)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 645
VB scripting
1.5 VBS object model

DefaultSort

Description
Specifies the type of sorting.
Access in runtime: Read and write

Syntax
Object.DefaultSort[=SortMode]

Object
Required. A "ScreenItem" object with the following characteristics:
• 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
AlarmControl (Page 237)

DefaultSort2

Description
Specifies the type of sorting.
Access in runtime: Read and write

Syntax
Object.DefaultSort2[=SortMode]

Object
Required. A "ScreenItem" object with the following characteristics:
• AlarmControl

WinCC Engineering V18 – Programming reference

646 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

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
AlarmControl (Page 237)

DefaultSort2Column

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
Access in runtime Read and write

Syntax
Object.DefaultSort2Column[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl

STRING
Optional. A value or a constant that specifies the name of the column for initial sorting of the
table entries.

See also
AlarmControl (Page 237)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 647
VB scripting
1.5 VBS object model

DeviceStyle

Description
No access in runtime.

DiagnosticsContext

Description
Specifies the diagnostics context.
Access in runtime: Read and write

Syntax
Object.DiagnosticsContext[=STRING]

Object
Required. A "ScreenItem" object with the following characteristics:
• AlarmControl

STRING
Optional. A value or a constant that specifies the diagnostics context.

See also
AlarmControl (Page 237)

DiagramAreaHeight

Description
No access in runtime.

DiagramAreaLeft

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

648 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

DiagramAreaTop

Description
No access in runtime.

DiagramAreaWidth

Description
No access in runtime.

DialColor

Description
Specifies the color of the dial for the selected object.
Access in runtime Read and write

Syntax
Object.DialColor[=Color]

Object
Required. An object of the type "ScreenItem" with the following format:
• Clock
• Gauge

Color
Optional. A value or a constant that specifies the color of the dial.

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
Clock (Page 287)
Gauge (Page 320)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 649
VB scripting
1.5 VBS object model

DialFillStyle

Description
Specifies the type of background.
Access in runtime Read and write

Syntax
Object.DialFillStyle[=GaugeFillStyle]

Object
Required. An object of the type "ScreenItem" with the following format:
• Gauge

GaugeFillStyle
Optional. A value or a constant that specifies the type of background.

Value VB constant Explanation

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 hmiBackStyleFrameTransparent The rectangular background is transparent. The scale is filled with the specified
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 320)

DialPicture

Description
Specifies a graphic for the dial face.
Access in runtime: Read and write

Syntax
Object.DialPicture[=HmiObjectHandle]

Object
Required. A "ScreenItem" object with the following characteristics:
• Gauge

WinCC Engineering V18 – Programming reference

650 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

HmiObjectHandle
Optional. A value or a constant that specifies the graphic for the dial face.

See also
Gauge (Page 320)

DialSize

Description
Specifies the diameter of the scale in relation to the smaller value of the geometry attributes
"Width" and "Height".
Access in runtime: Read and write

Syntax
Object.DialSize[=SINGLE]

Object
Required. A "ScreenItem" object with the following format:
• 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 320)

Display3D

Description
No access in runtime.

DisplayButton2Plc

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 651
VB scripting
1.5 VBS object model

DisplayButtonComparison

Description
No access in runtime.

DisplayButtonDelete

Description
No access in runtime.

DisplayButtonFromPlc

Description
No access in runtime.

DisplayButtonHelp

Description
No access in runtime.

DisplayButtonNew

Description
No access in runtime.

DisplayButtonSave

Description
No access in runtime.

DisplayButtonSaveAs

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

652 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

DisplayCentury

Description
No access in runtime.

DisplayComboBox

Description
No access in runtime.

DisplayGridLines

Description
No access in runtime.

DisplayLabeling

Description
No access in runtime.

DisplayNumbers

Description
No access in runtime.

DisplayOptions

Description
Specifies whether alarms whose view was suppressed are displayed.
Access in runtime Read and write

Syntax
Object.DisplayOptions[=AlarmDisplayOptions]

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 653
VB scripting
1.5 VBS object model

Object
Required. An object of the type "ScreenItem" with the format:
• 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
AlarmControl (Page 237)

DisplaySize

Description
No access in runtime.

DisplayStatusBar

Description
No access in runtime.

DisplaySystemTime

Description
No access in runtime.

DisplayTable

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

654 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

DoubleClickAction

Description
Specifies the action to be executed in runtime by double-clicking on a message line.
Access in runtime Read and write

Syntax
Object.DoubleClickAction[=AlarmControlActions]

Object
Required. An object of the type "ScreenItem" with the following format:
• 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
AlarmControl (Page 237)

DrawInsideFrame

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:
• RT Advanced: No access
• RT Professional: Read and write

Syntax
Object.DrawInsideFrame[=BOOLEAN]

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 655
VB scripting
1.5 VBS object model

Object
Required. An object of the type "ScreenItem" with the format:
• Bar
• Button
• CheckBox
• Circle
• CircleSegment
• CircularArc
• Ellipse
• EllipseSegment
• EllipticalArc
• GraphicIOField
• OptionGroup
• Rectangle
• RoundButton
• SymbolicIOField
• TextField
• WindowSlider
You have no access in runtime with the following format:
• Switch
• TubeArcObject

BOOLEAN
Optional. TRUE if the border line is shown with a line thickness of greater than 1 within the
border.

Drive

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

656 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

1.5.5.5 Properties E-F

EdgeStyle

Description
Specifies the line style.
Access in runtime:
• RT Advanced: No access
• RT Professional: Read and write

Syntax
Object.EdgeStyle[=LineStyle]

Object
Required. An object of the type "ScreenItem" with the format:
• Bar
• Button
• CheckBox
• Circle *
• CircleSegment
• ComboBox
• Ellipse *
• EllipseSegment
• GraphicIOField
• GraphicView
• IOField *
• ListBox
• MultiLineEdit
• OptionGroup
• Polygon *
• Rectangle *
• RoundButton
• SymbolicIOField
• TextField *
• WindowSlider
* RT Advanced read and write access

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 657
VB scripting
1.5 VBS object model

You have no access in runtime with the following format:

• 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:

Value VB constant Explanation

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:

Value VB constant Explanation

-1 hmiLineStyleNone No line
0 hmiLineStyleSolid Solid line

See also
Bar (Page 259)
Button (Page 267)
CheckBox (Page 275)
Circle (Page 279)
CircleSegment (Page 282)
ComboBox (Page 290)
Ellipse (Page 300)
EllipseSegment (Page 303)

WinCC Engineering V18 – Programming reference

658 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

GraphicIOField (Page 324)

GraphicView (Page 327)
IOField (Page 332)
Listbox (Page 339)
MultiLineEdit (Page 345)
OptionGroup (Page 371)
Polygon (Page 378)
Rectangle (Page 395)
RoundButton (Page 398)
SymbolicIOField (Page 422)
TextField (Page 438)
WindowSlider (Page 482)
AlarmView (Page 251)
DateTimeField (Page 296)
Gauge (Page 320)
RecipeView (Page 389)
Slider (Page 408)
StatusForce (Page 414)
Switch (Page 418)
SysDiagControl (Page 429)
TrendView (Page 451)
UserView (Page 478)

EditOnFocus

Description
Specifies whether the data input is immediately possible if the input field is selected using the
<Tab> key.
Access in runtime: Read and write

Syntax
Object.EditOnFocus[=BOOLEAN]

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 659
VB scripting
1.5 VBS object model

Object
Required. A "ScreenItem" object with the following format:
• 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 332)
SymbolicIOField (Page 422)

Enabled

Description
Specifies whether the selected object can be operated in runtime.
Access in runtime: Read and write

Syntax
Object.Enabled[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the format:
• AlarmControl *
• AlarmView **
• Bar
• Button
• ChannelDiagnose *
• CheckBox *
• Circle
• CircleSegment *
• CircularArc *
• Clock
• ComboBox *
• Connector *
• DateTimeField **

WinCC Engineering V18 – Programming reference

660 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

• DiscSpaceView *
• Ellipse
• EllipseSegment *
• 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
• TrendRulerControl *
• TrendView **
• TubeArcObject *

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 661
VB scripting
1.5 VBS object model

• TubeDoubleTeeObject *
• TubeTeeObject *
• Tubepolyline *
• UserView
• WindowSlider *
* RT Advanced No access
** RT Professional No access
*** RT Advanced Read access
**** Read access only

You have no access in runtime with the following format:

• OnlineTableControl
• OnlineTrendControl
• UserArchiveControl

BOOLEAN
Optional. T RUE, if the specified object can be operated in Runtime.

See also
AlarmControl (Page 237)
AlarmView (Page 251)
Bar (Page 259)
Button (Page 267)
ChannelDiagnose (Page 274)
CheckBox (Page 275)
Circle (Page 279)
CircleSegment (Page 282)
CircularArc (Page 285)
Clock (Page 287)
ComboBox (Page 290)
DateTimeField (Page 296)
DiskSpaceView (Page 298)
Ellipse (Page 300)
EllipseSegment (Page 303)
EllipticalArc (Page 306)
FunctionTrendControl (Page 309)

WinCC Engineering V18 – Programming reference

662 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Gauge (Page 320)

GraphicIOField (Page 324)
GraphicView (Page 327)
HTMLBrowser (Page 330)
IOField (Page 332)
Line (Page 336)
Listbox (Page 339)
MediaPlayer (Page 342)
MultiLineEdit (Page 345)
OnlineTableControl (Page 347)
OnlineTrendControl (Page 359)
OptionGroup (Page 371)
PLCCodeViewer (Page 376)
Polygon (Page 378)
Polyline (Page 381)
RecipeView (Page 389)
Rectangle (Page 395)
RoundButton (Page 398)
S7GraphOverview (Page 402)
Slider (Page 408)
SmartClientView (Page 412)
StatusForce (Page 414)
Switch (Page 418)
SymbolicIOField (Page 422)
SymbolLibrary (Page 427)
SysDiagControl (Page 429)
TextField (Page 438)
TrendRulerControl (Page 441)
TrendView (Page 451)
TubeArcObject (Page 457)
TubeDoubleTeeObject (Page 459)
TubePolyline (Page 461)
TubeTeeObject (Page 464)
UserArchiveControl (Page 466)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 663
VB scripting
1.5 VBS object model

UserView (Page 478)

WindowSlider (Page 482)

EnableDelete

Description
Specifies whether data can be deleted in runtime.
Access in runtime: Read and write

Syntax
Object.EnableDelete[=BOOLEAN]

Object
Required. A "ScreenItem" object with the following characteristics:
• UserArchiveControl

BOOLEAN
Optional.
TRUE, if data can be deleted in runtime.
FALSE, if data cannot be deleted in runtime.

See also
UserArchiveControl (Page 466)

EnableEdit

Description
Specifies whether the data shown can be edited in runtime.
Access in runtime Read and write

Syntax
Object.EnableEdit[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTableControl
• UserArchiveControl

WinCC Engineering V18 – Programming reference

664 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

BOOLEAN
Optional.
TRUE if the data can be changed in runtime.
FALSE if the data cannot be changed in runtime.

See also
OnlineTableControl (Page 347)
UserArchiveControl (Page 466)

EnableInsert

Description
Specifies whether data can be inserted in runtime.
Access in runtime: Read and write

Syntax
Object.EnableInsert[=BOOLEAN]

Object
Required. A "ScreenItem" object with the following characteristics:
• UserArchiveControl

BOOLEAN
Optional.
TRUE, if data can be inserted in runtime.
FALSE, if data cannot be inserted in runtime.

See also
UserArchiveControl (Page 466)

EnableNavigateButtons

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 665
VB scripting
1.5 VBS object model

EnableNavigateKeys

Description
No access in runtime.

EncryptCommunication

Description
No access in runtime.

EndAngle

Description
Specifies the angle by which the end point deviates from the zero position (0°).
Access in runtime Read and write

Syntax
Object.EndAngle[=Int32]

Object
Required. An object of the type "ScreenItem" with the format:
• 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
CircleSegment (Page 282)
CircularArc (Page 285)
EllipseSegment (Page 303)
EllipticalArc (Page 306)
TubeArcObject (Page 457)

WinCC Engineering V18 – Programming reference

666 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

EndLeft

Description
No access in runtime.

EndStyle

Description
Specifies how the line end is displayed.
Access in runtime: Read and write

Syntax
Object.EndStyle[=LineEndStyle]

Object
Required. An object of the type "ScreenItem" with the format:
• Connector
• Line
• Polyline

LineEndStyle
Optional. A value or a constant that specifies the line-end shapes.

Value VB constant Description

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)
Connector (Page 293)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 667
VB scripting
1.5 VBS object model

EndTop

Description
No access in runtime.

EnterButtonVisible

Description
No access in runtime.

EntryNameCaption

Description
No access in runtime.

EntryNameColumnWidth

Description
No access in runtime.

EntryValueColFirst

Description
No access in runtime.

EntryValueColumnWidth

Description
No access in runtime.

EntryValueFieldLength

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

668 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

EntryValuePos

Description
No access in runtime.

ErrorColor

Description
Specifies the color of errors in the GRAPH overview.
Access in runtime: Read and write

Syntax
Object.ErrorColor[=Color]

Object
Required. An object of the type "ScreenItem" with the following format:
• S7GraphOverview

Color
Optional. A value or a constant that specifies the color for errors.

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.
The background color is not visible if the "BorderStyle" property has the value "0".

See also
S7GraphOverview (Page 402)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 669
VB scripting
1.5 VBS object model

ErrorDescription

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.

Access in Runtime: Read

Syntax
Object.ErrorDescription

Object
Required A "Tag" object.

Example
The following example shows the error description for the "Tag1" tag:

'VBS72
Dim objTag
Set objTag = HMIRuntime.Tags("Tag1")
objtag.Read
MsgBox objTag.ErrorDescription

WinCC Engineering V18 – Programming reference

670 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

The following example adds two tags to the TagSet list and outputs the ErrorDescription
property as Trace:

'VBS179
Dim group
Set group = HMIRuntime.Tags.CreateTagSet
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 229)
TagSet (list) (Page 233)

Errorflag

Description
Specifies whether an error description is displayed in the device / detail view.
Access in runtime Read and write

Syntax
Object.Errorflag[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• 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
S7GraphOverview (Page 402)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 671
VB scripting
1.5 VBS object model

ES2RT_ButtonPositions

Description
No access in runtime.

ES2RT_ColumnOrder

Description
No access in runtime.

ES2RT_ColumnWidth

Description
No access in runtime.

ES2RT_EntryNameColumnWidth

Description
No access in runtime.

ES2RT_EntryValueColumnWidth

Description
No access in runtime.

ES2RT_ListAreaHeight

Description
No access in runtime.

ES2RT_ListAreaWidth

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

672 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

ES2RT_MessageAreaHeight

Description
No access in runtime.

ES2RT_MessageAreaWidth

Description
No access in runtime.

ES2RT_StoreAsCheckBack

Description
No access in runtime.

Es2rtButtonPositions

Description
No access in runtime.

Es2rtTableBounds

Description
No access in runtime.

EscButtonVisible

Description
No access in runtime.

EsPreviewType

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 673
VB scripting
1.5 VBS object model

EvenRowBackColor

Description
No access in runtime.

ExportDelimiter

Description
No access in runtime.

ExportDirectoryChangeable

Description
Specifies whether the data export directory can be changed in runtime.
Access in runtime: Read and write

Syntax
Object.ExportDirectoryChangeable[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• FunctionTrendControl
• OnlineTableControl
• OnlineTrendControl
• TrendRulerControl
• UserArchiveControl

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
AlarmControl (Page 237)
FunctionTrendControl (Page 309)
OnlineTableControl (Page 347)

WinCC Engineering V18 – Programming reference

674 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

OnlineTrendControl (Page 359)

TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

ExportDirectoryname

Description
Defines the directory to which the exported Runtime data is written.
Access in runtime: Read and write

Syntax
Object.ExportDirectoryname[=STRING]

Object
Required. A "ScreenItem" object with the following format:
• AlarmControl
• FunctionTrendControl
• OnlineTableControl
• OnlineTrendControl
• TrendRulerControl
• UserArchiveControl

STRING
Optional A value or a constant which specifies the directory.

See also
AlarmControl (Page 237)
FunctionTrendControl (Page 309)
OnlineTableControl (Page 347)
OnlineTrendControl (Page 359)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

ExportFileExtension

Description
Specifies the file extension of the export file. Only the "csv" file extension is currently supported.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 675
VB scripting
1.5 VBS object model

Access in runtime: Read and write

Syntax
Object.ExportFileExtension[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• FunctionTrendControl
• OnlineTableControl
• OnlineTrendControl
• TrendRulerControl
• UserArchiveControl

STRING
Optional. Specifies the file extension of the export file.

See also
AlarmControl (Page 237)
FunctionTrendControl (Page 309)
OnlineTableControl (Page 347)
OnlineTrendControl (Page 359)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

ExportFilename

Description
Specifies the name of the target file for the exported runtime data.
Access in runtime: Read and write

Syntax
Object.ExportFilename[=STRING]

WinCC Engineering V18 – Programming reference

676 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• FunctionTrendControl
• OnlineTableControl
• OnlineTrendControl
• TrendRulerControl
• UserArchiveControl

STRING
Optional. Specifies the name of the target file for the exported runtime data.

See also
AlarmControl (Page 237)
FunctionTrendControl (Page 309)
OnlineTableControl (Page 347)
OnlineTrendControl (Page 359)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

ExportFilenameChangeable

Description
Specifies whether the export file name can be changed in runtime.
Access in runtime: Read and write

Syntax
Object.ExportFilenameChangeable[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the format:
• AlarmControl
• FunctionTrendControl
• OnlineTableControl
• OnlineTrendControl
• TrendRulerControl
• UserArchiveControl

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 677
VB scripting
1.5 VBS object model

BOOLEAN
Optional.
TRUE if the export file can be renamed in runtime.
FALSE if the export file cannot be renamed in runtime.

See also
AlarmControl (Page 237)
FunctionTrendControl (Page 309)
OnlineTableControl (Page 347)
OnlineTrendControl (Page 359)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

ExportFormat

Description
No access in runtime.

ExportFormatGuid

Description
Specifies the assignment of ID number and export provider.
Access in runtime: Read and write

Syntax
Object.ExportFormatGuid[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• FunctionTrendControl
• OnlineTableControl
• OnlineTrendControl
• TrendRulerControl
• UserArchiveControl

WinCC Engineering V18 – Programming reference

678 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

STRING
Optional. A value or constant that specifies the assignment of ID number and export
provider.

See also
AlarmControl (Page 237)
FunctionTrendControl (Page 309)
OnlineTableControl (Page 347)
OnlineTrendControl (Page 359)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

ExportFormatName

Description
Defines the export file format. Only the "csv" file format is currently available for the export.
Access in runtime: Read and write

Syntax
Object.ExportFormatName[=STRING]

Object
Required. A "ScreenItem" object with the following format:
• AlarmControl
• FunctionTrendControl
• OnlineTableControl
• OnlineTrendControl
• TrendRulerControl
• UserArchiveControl

STRING
Optional A value or a constant that defines the file format for export.

See also
AlarmControl (Page 237)
FunctionTrendControl (Page 309)
OnlineTableControl (Page 347)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 679
VB scripting
1.5 VBS object model

OnlineTrendControl (Page 359)

TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

ExportParameters

Description
Specifies the parameters of the selected format by means of the properties dialog.
Access in runtime Read and write

Syntax
Object.ExportParameters

Object
Required. An object of the type "ScreenItem" with the format:
• AlarmControl
• FunctionTrendControl
• OnlineTableControl
• OnlineTrendControl
• TrendRulerControl
• UserArchiveControl

ExportParameters
Optional. A value or constant that specifies the parameters of the selected format in the
Properties dialog.

See also
AlarmControl (Page 237)
FunctionTrendControl (Page 309)
OnlineTableControl (Page 347)
OnlineTrendControl (Page 359)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

WinCC Engineering V18 – Programming reference

680 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

ExportSelection

Description
Specifies which runtime data of the control is exported.
Access in runtime: Read and write

Syntax
Object.ExportSelection[=ExportRange]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• FunctionTrendControl
• OnlineTableControl
• OnlineTrendControl
• TrendRulerControl
• UserArchiveControl

ExportRange
Optional. A value or a constant that specifies which runtime data of the control can be
exported.

Value Description Explanation

0 all All Runtime data of the control is exported.
1 Selection Selected Runtime data of the control is exported.

See also
AlarmControl (Page 237)
FunctionTrendControl (Page 309)
OnlineTableControl (Page 347)
OnlineTrendControl (Page 359)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

ExportShowDialog

Description
Enables the display of the export dialog during runtime.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 681
VB scripting
1.5 VBS object model

Access in runtime: Read and write

Syntax
Object.ExportShowDialog[=BOOLEAN]

Object
Required. A "ScreenItem" object with the following format:
• AlarmControl
• FunctionTrendControl
• OnlineTableControl
• OnlineTrendControl
• TrendRulerControl
• UserArchiveControl

BOOLEAN
Optional TRUE, if the dialog box is shown in Runtime.

See also
AlarmControl (Page 237)
FunctionTrendControl (Page 309)
OnlineTableControl (Page 347)
OnlineTrendControl (Page 359)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

ExtendedZoomingEnable

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
Necessary. A "Screen" object.

WinCC Engineering V18 – Programming reference

682 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

BOOLEAN
Optional TRUE, if the operator can zoom the screen in and out in runtime.

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 216)

ExtraHeightOffset

Description
No access in runtime.

FieldLength

Description
No access in runtime.

FileName

Description
Specifies the name of the file to be loaded.
Access in runtime:
• RT Advanced: No access
• RT Professional: Read and write

Syntax
Object.FileName[=STRING]

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 683
VB scripting
1.5 VBS object model

Object
Required. A "ScreenItem" object with the following characteristics:
• MediaPlayer
You have no access in runtime with the following format:
• PdfView

STRING
Optional. A value or a constant that specifies the name of the file to be loaded.

See also
MediaPlayer (Page 342)

FillColorMode

Description
Specifies the type of foreground for the selected object.
Access in runtime Read and write

Syntax
Object.FillColorMode[=SymbolLibraryColorMode]

Object
Required. An object of the type "ScreenItem" with the following format:
• 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
SymbolLibrary (Page 427)

WinCC Engineering V18 – Programming reference

684 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

FillPattern

Description
No access in runtime.

FillPatternColor

Description
Specifies the color of the fill pattern.
Access in runtime
• RT Advanced: No access
• RT Professional: Read and write

Syntax
Object.FillPatternColor[=Color]

Object
Required. An object of the type "ScreenItem" with the format:
• Bar
• Button
• CheckBox
• Circle
• CircleSegment
• Ellipse
• EllipseSegment
• GraphicView
• IOField
• OptionGroup
• Polygon
• Rectangle
• RoundButton
• SymbolicIOField*
• TextField
• WindowSlider
*: Read access only

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 685
VB scripting
1.5 VBS object model

You have no access in runtime with the following format:

• AlarmControl
• ComboBox
• DateTimeField
• ListBox
• OnlineTableControl
• TrendRulerControl
• UserArchiveControl

Color
Optional. A value or a constant that specifies the color of the fill pattern.

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
Bar (Page 259)
Button (Page 267)
CheckBox (Page 275)
Circle (Page 279)
CircleSegment (Page 282)
ComboBox (Page 290)
Ellipse (Page 300)
EllipseSegment (Page 303)
GraphicView (Page 327)
IOField (Page 332)
Listbox (Page 339)
OptionGroup (Page 371)
Polygon (Page 378)
Rectangle (Page 395)
RoundButton (Page 398)
SymbolicIOField (Page 422)

WinCC Engineering V18 – Programming reference

686 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

TextField (Page 438)

WindowSlider (Page 482)
AlarmControl (Page 237)
DateTimeField (Page 296)
OnlineTableControl (Page 347)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

FillStyle

Description
Specifies whether the background color is displayed with a broken line.
Access in runtime Read and write

Syntax
Object.FillStyle[=LineFillStyle]

Object
Required. An object of the type "ScreenItem" with the format:
• Line
• Polyline

LineFillStyle
Optional. A value or a constant that specifies the fill style.

Value VB constant Description

0 hmiLineFillStyleTransparent Transparent background
1 hmiLineFillStyleSolid Object background is filled with the specified color

See also
Line (Page 336)
Polyline (Page 381)

FillingDirection

Description
Specifies the fill direction.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 687
VB scripting
1.5 VBS object model

Access in Runtime: Read and write

Syntax
Object.FillingDirection[=FillDirection]

Object
Required. An object of the type "ScreenItem" with the following format:
• 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

Description

No access in runtime.

FilterSQL

Description
Sets an SQL statement for the filter criterion.
Access in runtime: Read and write

WinCC Engineering V18 – Programming reference

688 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Syntax
Object.FilterSQL[=STRING]

Object
Required. A "ScreenItem" object with the following characteristics:
• UserArchiveControl

STRING
Optional. A value or constant that specifies the SQL statement for the filter criterion.

See also
UserArchiveControl (Page 466)

FilterTag

Description
No access in runtime.

FilterText

Description
No access in runtime.

FirstConnectedObject

Description
No access in runtime.

FirstConnectedObjectIndex

Description
Specifies the index number of the upper connector point.
Access in runtime: Read and write

Syntax
Object.FirstConnectedObjectIndex[=Int]
Object

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 689
VB scripting
1.5 VBS object model

Required. An object of the type "ScreenItem" with the format:

• Connector

Int
Optional. A value or a constant that specifies the index number of the upper connector point.

See also
Connector (Page 293)

FirstConnectedObjectName

Description
Specifies the name of the object that is docked to the upper connector point.
Access in runtime: Read and write

Syntax
Object.FirstConnectedObjectName[=String]

Object
Required. An object of the type "ScreenItem" with the format:
• 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
Connector (Page 293)

FirstGradientColor

Description
No access in runtime.

FirstGradientOffset

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

690 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

FitToLargest

Description
No access in runtime.

FitToSize

Description
No access in runtime.

FitToSizeLowerRows

Description
No access in runtime.

FitToSizeUpperRows

Description
No access in runtime.

FixedAspectRatio

Description
Specifies whether the aspect ratio should be maintained or changed when the symbol size is
altered.
Access in runtime: Read and write

Syntax
Object.FixedAspectRatio[=BOOLEAN]

Object
Required. A "ScreenItem" object with the following format:
• SymbolLibrary

BOOLEAN
Optional TRUE, if the aspect ratio should be maintained when the symbol size is altered.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 691
VB scripting
1.5 VBS object model

See also
SymbolLibrary (Page 427)

Flashing

Description
Specifies whether the selected object flashes in runtime.
Access in runtime:
• RT Advanced: No access
• RT Professional: Read and write

Syntax
Object.Flashing[=FlashingType]

Object
Required. An object of the type "ScreenItem" with the format:
• Clock
• Gauge
• Slider
You have no access in runtime with the following format:
• AlarmView
• Bar
• Button
• CheckBox
• Circle
• CircleSegment
• CircularArc
• Connector
• DateTimeField
• Ellipse
• EllipseSegment
• EllipticalArc
• GraphicIOField
• GraphicView
• HTMLBrowser
• IOField

WinCC Engineering V18 – Programming reference

692 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

• 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

Description
Specifies the color of the border line for the flashing status "Off".
Access in runtime:
• RT Advanced: No access
• RT Professional: Read and write

Syntax
Object.FlashingColorOff[=Color]

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 693
VB scripting
1.5 VBS object model

Object
Required. An object of the type "ScreenItem" with the format:
• Button
• CheckBox
• Circle
• CircleSegment
• CircularArc
• Connector
• Ellipse
• EllipseSegment
• EllipticalArc
• IOField
• Line
• OptionGroup
• Polygon
• Polyline
• Rectangle
• RoundButton
• SymbolicIOField*
• TextField
*: Read access only

You have no access in runtime with the following format:

• Bar
• Switch
• TubeArcObject

Color
Optional. A value or a constant that specifies the color of the border line for the flashing
status "Off".

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.

WinCC Engineering V18 – Programming reference

694 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

See also
Button (Page 267)
Circle (Page 279)
CircleSegment (Page 282)
CircularArc (Page 285)
Ellipse (Page 300)
EllipseSegment (Page 303)
EllipticalArc (Page 306)
IOField (Page 332)
Line (Page 336)
OptionGroup (Page 371)
Polygon (Page 378)
Polyline (Page 381)
Rectangle (Page 395)
RoundButton (Page 398)
SymbolicIOField (Page 422)
TextField (Page 438)
Bar (Page 259)
CheckBox (Page 275)
Switch (Page 418)
TubeArcObject (Page 457)

FlashingColorOn

Description
Specifies the color of the border line for the flashing status "On".
Access in runtime:
• RT Advanced: No access
• RT Professional: Read and write

Syntax
Object.FlashingColorOn[=Color]

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 695
VB scripting
1.5 VBS object model

Object
Required. An object of the type "ScreenItem" with the format:
• Button
• CheckBox
• Circle
• CircleSegment
• CircularArc
• Connector
• Ellipse
• EllipseSegment
• EllipticalArc
• GraphicIOField
• IOField
• Line
• OptionGroup
• Polygon
• Polyline
• Rectangle
• RoundButton
• SymbolicIOField*
• TextField
*: Read access only

You have no access in runtime with the following format:

• Bar
• Switch
• TubeArcObject

Color
Optional. A value or a constant that specifies the color of the border line for the flashing
status "On".

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)

WinCC Engineering V18 – Programming reference

696 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

You can also use the VBS color constants such as vbRed and vbGreen.

See also
Button (Page 267)
Circle (Page 279)
CircleSegment (Page 282)
CircularArc (Page 285)
Ellipse (Page 300)
EllipseSegment (Page 303)
EllipticalArc (Page 306)
IOField (Page 332)
Line (Page 336)
OptionGroup (Page 371)
Polygon (Page 378)
Polyline (Page 381)
Rectangle (Page 395)
RoundButton (Page 398)
SymbolicIOField (Page 422)
TextField (Page 438)
Bar (Page 259)
CheckBox (Page 275)
Switch (Page 418)
TubeArcObject (Page 457)

FlashingEnabled

Description
Specifies whether flashing is activated for the object in runtime.
Access in runtime:
• RT Advanced: No access
• RT Professional: Read and write

Syntax
Object.FlashingEnabled[=BOOLEAN]

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 697
VB scripting
1.5 VBS object model

Object
Required. An object of the type "ScreenItem" with the format:
• Button
• CheckBox
• Circle
• CircleSegment
• CircularArc
• Connector
• Ellipse
• EllipseSegment
• EllipticalArc
• GraphicIOField
• IOField
• Line
• OptionGroup
• Polygon
• Polyline
• Rectangle
• RoundButton
• SymbolicIOField*
• TextField
*: Read access only

You have no access in runtime with the following format:

• 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 267)
Circle (Page 279)

WinCC Engineering V18 – Programming reference

698 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

CircleSegment (Page 282)

CircularArc (Page 285)
Ellipse (Page 300)
EllipseSegment (Page 303)
EllipticalArc (Page 306)
IOField (Page 332)
Line (Page 336)
OptionGroup (Page 371)
Polygon (Page 378)
Polyline (Page 381)
Rectangle (Page 395)
RoundButton (Page 398)
SymbolicIOField (Page 422)
TextField (Page 438)
Bar (Page 259)
CheckBox (Page 275)
Switch (Page 418)
TubeArcObject (Page 457)

FlashingOnLimitViolation

Description
No access in runtime.

FlashingRate

Description
Specifies the flash rate of the border line.
Access in runtime:
• RT Advanced: No access
• RT Professional: Read and write

Syntax
Object.FlashingRate[=FlashingRate]

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 699
VB scripting
1.5 VBS object model

Object
Required. An object of the type "ScreenItem" with the format:
• Button
• CheckBox
• Circle
• CircleSegment
• CircularArc
• Connector
• Ellipse
• EllipseSegment
• EllipticalArc
• GraphicIOField
• IOField
• Line
• OptionGroup
• Polygon
• Polyline
• Rectangle
• RoundButton
• SymbolicIOField*
• TextField
* Read access only

You have no access in runtime with the following format:

• Bar
• Switch
• TubeArcObject

FlashingRate
Optional. A value or a constant that specifies the flash rate of the border line.

Value VB constant Explanation

0 hmiFlashingRateSlow The length of the flashing interval is 1000 ms.
1 hmiFlashingRateMedium The length of the flashing interval is 500 ms.
2 hmiFlashingRateFast The length of the flashing interval is 250 ms.

WinCC Engineering V18 – Programming reference

700 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

See also
Button (Page 267)
Circle (Page 279)
CircleSegment (Page 282)
CircularArc (Page 285)
Ellipse (Page 300)
EllipseSegment (Page 303)
EllipticalArc (Page 306)
IOField (Page 332)
Line (Page 336)
OptionGroup (Page 371)
Polygon (Page 378)
Polyline (Page 381)
Rectangle (Page 395)
RoundButton (Page 398)
SymbolicIOField (Page 422)
TextField (Page 438)
Bar (Page 259)
CheckBox (Page 275)
Switch (Page 418)
TubeArcObject (Page 457)

FlashTransparentColor

Description
Specifies the color of the bitmap object of a flashing graphic that is set to "transparent".
Access in runtime: Read and write

Syntax
Object.FlashTransparentColor[=Color]

Object
Required. An object of the type "ScreenItem" with the format:
• GraphicIOField

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 701
VB scripting
1.5 VBS object model

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
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.
The background color is not visible if the "BorderStyle" property has the value "0".

See also
GraphicIOField (Page 324)

Flip

Description
Specifies whether the symbol is flipped on the vertical and / or horizontal center axis of the
symbol.
Access in runtime Read and write

Syntax
Object.Flip[=SymbolLibraryFlip]

Object
Required. An object of the type "ScreenItem" with the following format:
• 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.

Value VB constant Explanation

0 hmiSymbolLibraryFlipNone The symbol is not flipped.
1 hmiSymbolLibraryFlipHori‐ The symbol is flipped horizontally.
zontal
2 hmiSymbolLibraryFlipVertical The symbol is flipped vertically.
3 hmiSymbolLibraryFlipBoth The symbol is flipped horizontally and vertically.

WinCC Engineering V18 – Programming reference

702 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

See also
SymbolLibrary (Page 427)

FocusColor

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
Required. An object of the type "ScreenItem" with the format:
• AlarmView
• Button
• GraphicIOField
• RecipeView
• Slider *
• StatusForce
• Switch
• TrendView
* RT Professional read and write access
You have no access in runtime with the following format:
• SymbolicIOField

Color
Optional. A value or a constant that specifies the color of the focus border.

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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 703
VB scripting
1.5 VBS object model

See also
AlarmView (Page 251)
RecipeView (Page 389)
Slider (Page 408)
StatusForce (Page 414)
Switch (Page 418)
TrendView (Page 451)
Button (Page 267)
GraphicIOField (Page 324)
SymbolicIOField (Page 422)

FocusWidth

Description
Specifies the border width when the object has the focus.
Access in runtime:
• RT Advanced: Read and write
• RT Professional: No access

Syntax
Object.FocusWidth[=Int32]

Object
Required. An object of the type "ScreenItem" with the format:
• AlarmView
• Button
• GraphicIOField
• RecipeView
• Slider *
• StatusForce
• Switch
• TrendView
* RT Professional read and write access
You have no access in runtime with the following format:
• SymbolicIOField

WinCC Engineering V18 – Programming reference

704 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Int32
Optional. A value or a constant that specifies the border width in pixels. Value range from 1
to 10.

See also
AlarmView (Page 251)
RecipeView (Page 389)
Slider (Page 408)
StatusForce (Page 414)
Switch (Page 418)
TrendView (Page 451)
Button (Page 267)
GraphicIOField (Page 324)
SymbolicIOField (Page 422)

Font

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:
• RT Advanced: No access
• RT Professional: Read and write

Syntax
Object.Font.[Size|Bold|Name|Italic|Underline|StrikeThrough][=Value]

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 705
VB scripting
1.5 VBS object model

Object
Required. An object of the type "ScreenItem" with the format:
• AlarmControl
• Bar
• Clock
• FunctionTrendControl
• OnlineTableControl
• OnlineTrendControl
• Slider
• TrendRulerControl
• UserArchiveControl
You have no access in runtime with the following format:
• Button
• CheckBox
• ComboBox
• DateTimeField
• IOField
• ListBox
• MultiLineEdit
• OptionGroup
• ProtectedAreaNameView
• RangeLabelView
• RecipeView
• RoundButton
• SmartClientView
• Switch
• SymbolicIOField
• TextField
• TrendView
• ZoneLabelView

Value
Optional. A value or a constant which specifies the selected subproperty.

WinCC Engineering V18 – Programming reference

706 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

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
AlarmControl (Page 237)
Clock (Page 287)
FunctionTrendControl (Page 309)
OnlineTableControl (Page 347)
OnlineTrendControl (Page 359)
Slider (Page 408)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)
Bar (Page 259)
Button (Page 267)
CheckBox (Page 275)
ComboBox (Page 290)
DateTimeField (Page 296)
IOField (Page 332)
Listbox (Page 339)
MultiLineEdit (Page 345)
OptionGroup (Page 371)
ProtectedAreaNameView (Page 385)
RangeLabelView (Page 386)
RecipeView (Page 389)
RoundButton (Page 398)
SmartClientView (Page 412)
Switch (Page 418)
SymbolicIOField (Page 422)
TextField (Page 438)
TrendView (Page 451)
ZoneLabelView (Page 487)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 707
VB scripting
1.5 VBS object model

FontBold

Description
Specifies whether the text is shown in bold.
Access in runtime: Read and write

Syntax
Object.FontBold[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the format:
• Bar
• Button
• CheckBox
• ComboBox
• IOField
• ListBox
• MultiLineEdit
• OptionGroup
• RoundButton
• SymbolicIOField*
• TextField
*: Read access only.

BOOLEAN
Optional. TRUE if the text is shown in bold.

FontItalic

Description
Specifies whether the text is shown in italics.
Access in runtime: Read and write

Syntax
Object.FontItalic[=BOOLEAN]

WinCC Engineering V18 – Programming reference

708 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Object
Required. An object of the type "ScreenItem" with the format:
• Button
• CheckBox
• ComboBox
• IOField
• ListBox
• MultiLineEdit
• OptionGroup
• RoundButton
• SymbolicIOField*
• TextField
*: Read access only

BOOLEAN
Optional. TRUE if the text is shown in italics.

See also
TextField (Page 438)
Button (Page 267)
CheckBox (Page 275)
ComboBox (Page 290)
IOField (Page 332)
Listbox (Page 339)
MultiLineEdit (Page 345)
OptionGroup (Page 371)
RoundButton (Page 398)
SymbolicIOField (Page 422)

FontName

Description
Specifies the font.
Access in runtime: Read and write

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 709
VB scripting
1.5 VBS object model

Syntax
Object.FontName[=STRING]

Object
Required. An object of the type "ScreenItem" with the format:
• Bar
• Button
• CheckBox
• ComboBox
• IOField
• ListBox
• OptionGroup
• RoundButton
• SymbolicIOField*
• TextField
*: Read access only

You have no access in runtime with the following format:

• MultiLineEdit

STRING
Optional. A value or a constant that specifies the font.

See also
TextField (Page 438)
Bar (Page 259)
Button (Page 267)
CheckBox (Page 275)
ComboBox (Page 290)
IOField (Page 332)
Listbox (Page 339)
MultiLineEdit (Page 345)
OptionGroup (Page 371)
RoundButton (Page 398)
SymbolicIOField (Page 422)

WinCC Engineering V18 – Programming reference

710 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

FontSize

Description
Specifies the font size of the text.
Access in runtime: Read and write

Syntax
Object.FontSize[=Int32]

Object
Required. An object of the type "ScreenItem" with the format:
• Bar
• Button
• CheckBox
• ComboBox
• IOField
• ListBox
• MultiLineEdit
• OptionGroup
• RoundButton
• SymbolicIOField*
• TextField
*: Read access only.

Int32
Optional. A value or a constant that specifies the font size of the text.

FontUnderline

Description
Specifies whether the text is shown underlined.
Access in runtime: Read and write

Syntax
Object.FontUnderline[=BOOLEAN]

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 711
VB scripting
1.5 VBS object model

Object
Required. An object of the type "ScreenItem" with the format:
• Button
• CheckBox
• ComboBox
• IOField
• ListBox
• MultiLineEdit
• OptionGroup
• RoundButton
• SymbolicIOField*
• TextField
*: Read access only

BOOLEAN
Optional. TRUE if the text is shown underlined.

ForeColor

Description
Specifies the font color of the text.
Access in runtime Read and write

Syntax
Object.ForeColor[=Color]

Object
Required. An object of the type "ScreenItem" with the format:
• Bar
• Button
• CheckBox **
• ComboBox **
• DateTimeField *
• IOField
• ListBox **
• MultiLineEdit **
• OptionGroup **

WinCC Engineering V18 – Programming reference

712 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

• 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
You have no access in runtime with the following format:
• AlarmView

Color
Optional. A value or a constant that specifies the font color of the text.

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
Bar (Page 259)
Button (Page 267)
CheckBox (Page 275)
ComboBox (Page 290)
DateTimeField (Page 296)
IOField (Page 332)
Listbox (Page 339)
MultiLineEdit (Page 345)
OptionGroup (Page 371)
RecipeView (Page 389)
RoundButton (Page 398)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 713
VB scripting
1.5 VBS object model

Slider (Page 408)

Switch (Page 418)
SymbolicIOField (Page 422)
SymbolLibrary (Page 427)
TextField (Page 438)
AlarmView (Page 251)

ForeColorTransparency

Description
No access in runtime.

Format

Description
No access in runtime.

FormatPattern

Description
Specifies the format of the output value.
Access in runtime: Read and write

Syntax
Object.FormatPattern[=STRING]

Object
Required. An object of the type "ScreenItem" with the format:
• IOField

STRING
Optional. A value or a constant that specifies the format of the output value.

See also
IOField (Page 332)

WinCC Engineering V18 – Programming reference

714 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

FrameColor

Description
Specifies the background color of the gauge.
Also set "background graphic" to "none".
Access in Runtime:
• RT Advanced: No access
• RT Professional: Read and write

Syntax
Object.FrameColor[=Color]

Object
Required. An object of the type "ScreenItem" with the following format:
• Gauge

Color
Optional. A value or a constant that specifies the background color of the gauge.

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.

Free

Description
No access in runtime.

FreePercent

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.
Access in runtime: Read

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 715
VB scripting
1.5 VBS object model

Syntax
Object.FreePercent[=Int32]

Object
Required. A "ScreenItem" object with the following format:
• DiscSpaceView

Int32
Optional A value or a constant that returns the measured values for the free disk space as a
percentage.

See also
DiskSpaceView (Page 298)

1.5.5.6 Properties G-H

Gradation

Description
Specifies the value difference between two main marking lengths of the "Gauge" object.
Access in runtime: Read and write

Syntax
Object.Gradation[=SINGLE]

Object
Required. A "ScreenItem" object with the following format:
• Gauge

SINGLE
Optional A value or a constant that specifies the value difference.

See also
Gauge (Page 320)

WinCC Engineering V18 – Programming reference

716 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

GraphDirection

Description
Specifies at which border of the trend view the current values are displayed.
Access in runtime Read and write

Syntax
Object.GraphDirection[=GraphDirection]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl
• OnlineTrendControl

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
FunctionTrendControl (Page 309)
OnlineTrendControl (Page 359)

GridlineAxis

Description
No access in runtime.

GridLineColor

Description
Specifies the color for the grid lines.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 717
VB scripting
1.5 VBS object model

Access in runtime
• RT Advanced: No access
• RT Professional: Read and write
Read and write

Syntax
Object.GridLineColor[=Color]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• AlarmView*
• OnlineTableControl
• TrendRulerControl
• UserArchiveControl
* RT Advanced read and write access, RT Professional no access

You have no access in runtime with the following format:

• TrendView

Color
Optional. A value or a constant that specifies the color of the grid lines.

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
AlarmControl (Page 237)
AlarmView (Page 251)
OnlineTableControl (Page 347)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)
TrendView (Page 451)

WinCC Engineering V18 – Programming reference

718 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

GridlineEnabled

Description
No access in runtime.

GridlineFillColor

Description
No access in runtime.

GridlineStyle

Description
No access in runtime.

GridLineWidth

Description
Defines the line weight of the row/column dividers in pixels.
Access in runtime: Read and write

Syntax
Object.GridLineWidth[=Int32]

Object
Required. A "ScreenItem" object with the following format:
• AlarmControl
• OnlineTableControl
• TrendRulerControl
• UserArchiveControl

Int32
Optional A value or a constant which specifies the width of the grid line.

See also
AlarmControl (Page 237)
OnlineTableControl (Page 347)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 719
VB scripting
1.5 VBS object model

TrendRulerControl (Page 441)

UserArchiveControl (Page 466)

GSCRuntimeAllowed

Description
No access in runtime.

HeaderFont

Description
No access in runtime.

Height

Description
Specifies the height.
Access in runtime: Read and write
You have read-only access in "Runtime Advanced" and "Panel Runtime" with the following
formats:
• AlarmView
• Bar
• BatteryView
• Button
• CameraControl
• Clock
• DateTimeField
• FunctionTrendControl
• Gauge
• GraphicIOField
• GraphicView
• HTMLBrowser
• IOField
• Line
• MediaPlayer

WinCC Engineering V18 – Programming reference

720 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

• PDFView
• PLCCodeViewer
• Polygon
• Polyline
• ProDiagOverview
• ProtectedAreaNameView
• RangeLabelView
• RangeQualityView
• RecipeView
• S7GraphOverview
• Slider
• SmartClientView
• StatusForce
• Switch
• SymbolicIOField
• SymbolLibrary
• SysDiagControl
• TextField
• TrendView
• UserView
• WLanQualityView
• ZoneLabelView
• ZoneQualityView

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.

Int32
Optional. A value or a constant that specifies the height in pixels.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 721
VB scripting
1.5 VBS object model

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
Set objScreen = HMIRuntime.Screens("NewPDL1")
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 300)
Circle (Page 279)
EllipseSegment (Page 303)
CircleSegment (Page 282)
EllipticalArc (Page 306)
CircularArc (Page 285)
Rectangle (Page 395)
Polygon (Page 378)
TextField (Page 438)
IOField (Page 332)
SymbolicIOField (Page 422)
Button (Page 267)
Switch (Page 418)
GraphicView (Page 327)
GraphicIOField (Page 324)
Bar (Page 259)

WinCC Engineering V18 – Programming reference

722 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Clock (Page 287)

Gauge (Page 320)
Slider (Page 408)
SymbolLibrary (Page 427)
OnlineTrendControl (Page 359)
FunctionTrendControl (Page 309)
OnlineTableControl (Page 347)
AlarmControl (Page 237)
HTMLBrowser (Page 330)
CheckBox (Page 275)
OptionGroup (Page 371)
WindowSlider (Page 482)
Connector (Page 293)
ScreenWindow (Page 404)
DiskSpaceView (Page 298)
ChannelDiagnose (Page 274)
ScriptDiagnostics (Page 406)
ProtectedAreaNameView (Page 385)
UserView (Page 478)
TubeTeeObject (Page 464)
TubePolyline (Page 461)
TubeDoubleTeeObject (Page 459)
TubeArcObject (Page 457)
MultiLineEdit (Page 345)
MediaPlayer (Page 342)
Listbox (Page 339)
DateTimeField (Page 296)
UserArchiveControl (Page 466)
TrendRulerControl (Page 441)
AlarmView (Page 251)
BatteryView (Page 265)
RangeLabelView (Page 386)
ZoneQualityView (Page 488)
ZoneLabelView (Page 487)
WLanQualityView (Page 485)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 723
VB scripting
1.5 VBS object model

TrendView (Page 451)

SysDiagControl (Page 429)
StatusForce (Page 414)
SmartClientView (Page 412)
RecipeView (Page 389)
RangeQualityView (Page 388)
ApplicationWindow (Page 257)
ComboBox (Page 290)
PLCCodeViewer (Page 376)
RoundButton (Page 398)
S7GraphOverview (Page 402)

HelpText

Description
Returns the tooltip that is shown in Runtime as an operating aid for the specified object.
Access in runtime: Read and write

Syntax
Object.HelpText[=STRING]

Object
Required. An object of the "ScreenItem" type with the format:
• 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.

WinCC Engineering V18 – Programming reference

724 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

See also
Button (Page 267)
DateTimeField (Page 296)
GraphicIOField (Page 324)
IOField (Page 332)
Switch (Page 418)
SymbolicIOField (Page 422)
TrendView (Page 451)

HiddenInput

Description
Specifies whether the input value or a * for each character will be shown during the input.
Access in runtime: Read and write

Syntax
Object.HiddenInput[=BOOLEAN]

Object
Required. A "ScreenItem" object with the following format:
• IOField

BOOLEAN
Optional TRUE, if the input value is not shown during the input. An * is shown for each
character.

See also
IOField (Page 332)

HighlightColor

Description
Specifies the highlight color in the GRAPH overview.
Access in runtime Read and write

Syntax
Object.HighlightColor[=Color]

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 725
VB scripting
1.5 VBS object model

Object
Required. An object of the type "ScreenItem" with the format:
• S7GraphOverview

Color
Optional. A value or a constant that specifies the highlight color.

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
S7GraphOverview (Page 402)

HighLimitColor

Description
Specifies the color of the top or right scroll button in a scroll bar.
Access in runtime Read and write

Syntax
Object.HighLimitColor[=Color]

Object
Required. An object of the type "ScreenItem" with the format:
• WindowSlider

Color
Optional. A value or a constant that specifies the color of the top or right scroll button in a
scroll bar.

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)

WinCC Engineering V18 – Programming reference

726 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

You can also use the VBS color constants such as vbRed and vbGreen.

See also
WindowSlider (Page 482)

Hitlist

Description
No access in runtime.

HitlistColumnAdd

Description
Creates a new alarm text block in alarm statistics. The newly created alarm text block is
automatically referenced with "HitlistColumnIndex".
Access in runtime Read and write

Syntax
Object.HitlistColumnAdd[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• 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 728)
AlarmControl (Page 237)

HitlistColumnCount

Description
Specifies the number of configured alarm text blocks in alarm statistics.
Access in runtime Read and write

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 727
VB scripting
1.5 VBS object model

Syntax
Object.HitlistColumnCount[=Int32]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl

Int32
Optional. A value or a constant that specifies the number of configured alarm text blocks in
alarm statistics.

See also
AlarmControl (Page 237)

HitlistColumnIndex

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.
Access in runtime Read and write

Syntax
Object.HitlistColumnIndex[=Int32]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl

Int32
Optional. A value or a constant that specifies, with the index, the alarm text block to be
edited.

See also
HitlistColumnCount (Page 727)
AlarmControl (Page 237)

WinCC Engineering V18 – Programming reference

728 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

HitlistColumnName

Description
Specifies the name of an alarm statistics alarm text block referenced with "HitlistColumnIndex".
You cannot edit this name.
Access in runtime Read and write

Syntax
Object.HitlistColumnName[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl

STRING
Optional. A value or a constant that specifies the name of the referenced alarm text block in
alarm statistics.

See also
HitlistColumnIndex (Page 728)
AlarmControl (Page 237)

HitlistColumnRemove

Description
Removes an alarm statistics alarm text block referenced with its name.
Access in runtime Read and write

Syntax
Object.HitlistColumnRemove[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl

STRING
Optional. A value or a constant that specifies the name of the referenced alarm statistics
alarm text block to be removed.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 729
VB scripting
1.5 VBS object model

See also
AlarmControl (Page 237)

HitlistColumnRepos

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".
Access in runtime Read and write

Syntax
Object.HitlistColumnRepos[=Int32]

Object
Required. An object of the type "ScreenItem" with the following format:
• 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
HitlistColumnIndex (Page 728)
HitlistColumnCount (Page 727)
AlarmControl (Page 237)

HitlistColumnSort

Description
Specifies the sorting order in the hit list for the alarm text block that is referenced in
"HitlistColumnIndex".
Access in runtime Read and write

WinCC Engineering V18 – Programming reference

730 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Syntax
Object.HitlistColumnSort[=SortMode]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl

SortMode
Optional. A value or a constant that specifies which runtime data of the control can be
exported.

Value Explanation
0 No sorting
1 Ascending sorting from the smallest to largest value
2 Descending sorting from the largest to smallest value

See also
AlarmControl (Page 237)

HitlistColumnSortIndex

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.
Access in runtime Read and write

Syntax
Object.HitlistColumnSortIndex[=Int32]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl

Int32
Optional. Specifies the sorting order of the referenced alarm statistics alarm text block.

See also
AlarmControl (Page 237)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 731
VB scripting
1.5 VBS object model

HitlistColumnVisible

Description
Specifies whether the alarm text block referenced with "HitlistColumnIndex" is displayed in
alarm statistics.
Access in runtime Read and write

Syntax
Object.HitlistColumnVisible[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• 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
HitlistColumnIndex (Page 728)
AlarmControl (Page 237)

HitlistDefaultSort

Description
Specifies the default sorting order in the table columns of alarm statistics.
Access in runtime Read and write

Syntax
Object.HitlistDefaultSort[=SortMode]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl

WinCC Engineering V18 – Programming reference

732 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

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
AlarmControl (Page 237)

HitlistFilter

Description
No access in runtime.

HitlistMaxSourceItems

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".
Access in runtime Read and write

Syntax
Object.HitlistMaxSourceItems[=Int32]

Object
Required. An object of the type "ScreenItem" with the following format:
• 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
AlarmControl (Page 237)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 733
VB scripting
1.5 VBS object model

HitlistMaxSourceItemsWarn

Description
Specifies that a warning is output when the maximum number of data records in the alarm view
is reached.
Access in runtime Read and write

Syntax
Object.HitlistMaxSourceItemsWarn[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• 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
AlarmControl (Page 237)

HitListRelTime

Description
Specifies whether the calculation period for alarm statistics is limited.
Access in runtime Read and write

Syntax
Object.HitListRelTime [=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl

BOOLEAN
TRUE if the specified time range is used for statistics.
FALSE if the specified time range is not used.

WinCC Engineering V18 – Programming reference

734 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

See also
AlarmControl (Page 237)

HitListRelTimeFactor

Description
Specifies the time factor which, alongside the time type "HitlistRelTimeFactorType (Page 735)",
determines the time period for which the alarm statistics are created.
Access in runtime: Read and write

Syntax
Object.HitListRelTimeFactor[=Int32]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl

Int32
Optional. A value or a constant that specifies the time factor.

See also
AlarmControl (Page 237)

HitlistRelTimeFactorType

Description
Specifies the time unit that, together with the time factor "HitlistRelTimeFactor", defines the time
range displayed for alarm statistics.
Access in runtime Read and write

Syntax
Object.HitListRelTimeFactorType[=AlarmControlTimeUnit)

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 735
VB scripting
1.5 VBS object model

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
AlarmControl (Page 237)

HomeButtonVisible

Description
No access in runtime.

HorizontalAlignment

Description
Specifies the horizontal alignment of the text.
Access in runtime Read and write

Syntax
Object.HorizontalAlignment[=HorizontalAlignment]

Object
Required. An object of the type "ScreenItem" with the format:
• Button
• CheckBox *
• ComboBox *
• DateTimeField **
• IOField
• ListBox *
• MultiLineEdit *
• OptionGroup *

WinCC Engineering V18 – Programming reference

736 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

• RoundButton ***
• Switch **
• SymbolicIOField ****
• TextField
* RT Advanced No access
** RT Professional No access
*** 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.

Value VB constant Explanation

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 267)
CheckBox (Page 275)
ComboBox (Page 290)
DateTimeField (Page 296)
IOField (Page 332)
Listbox (Page 339)
MultiLineEdit (Page 345)
OptionGroup (Page 371)
RoundButton (Page 398)
Switch (Page 418)
SymbolicIOField (Page 422)
TextField (Page 438)

HorizontalGridLines

Description
Specifies whether horizontal separating lines are displayed.
Access in runtime Read and write

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 737
VB scripting
1.5 VBS object model

Syntax
Object.HorizontalGridLines[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• OnlineTableControl
• TrendRulerControl
• UserArchiveControl

BOOLEAN
Optional.
TRUE if horizontal separation lines are displayed.
FALSE if horizontal separation lines are not displayed.

See also
AlarmControl (Page 237)
OnlineTableControl (Page 347)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

HorizontalPictureAlignment

Description
No access in runtime.

HorizontalScrollBarPosition

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 775)" and "TopOffset (Page 1085)" properties as the
source of this cutout.
Access in runtime Read and write

Syntax
Object.HorizontalScrollBarPosition[=Int32]

WinCC Engineering V18 – Programming reference

738 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Object
Required. An object of the type "ScreenItem" with the following format:
• ScreenWindow

Int32
Optional. A value or a constant that specifies the horizontal position of the slide in the scroll
bar.

See also
ScreenWindow (Page 404)

HorizontalScrollingEnabled

Description
No access in runtime.

Hotkey

Description
No access in runtime.

HourNeedleHeight

Description
Specifies the length of the hour hand.
Access in runtime Read and write

Syntax
Object.HourNeedleHeight[=Int32]

Object
Required. An object of the type "ScreenItem" with the following format:
• 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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 739
VB scripting
1.5 VBS object model

See also
Clock (Page 287)

HourNeedleWidth

Description
Specifies the width of the hour hand.
Access in runtime Read and write

Syntax
Object.HourNeedleWidth[=Int32]

Object
Required. An object of the type "ScreenItem" with the following format:
• 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 287)

1.5.5.7 Properties I-J

IconSpace

Description
Defines the spacing between the icons and text in the table cells. The value is active if and icon
and text are displayed.
Access in runtime: Read and write

Syntax
Object.IconSpace[=Int32]

WinCC Engineering V18 – Programming reference

740 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Object
Required. A "ScreenItem" object with the following format:
• AlarmControl
• OnlineTableControl
• TrendRulerControl
• UserArchiveControl

Int32
Optional Value that specifies the spacing.

See also
AlarmControl (Page 237)
OnlineTableControl (Page 347)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

Index

Description
Specifies the index for the selected text field.
Access in runtime: Read and write

Syntax
Object.Index[=Int32]

Object
Required. A "ScreenItem" object with the following format:
• CheckBox
• ComboBox
• ListBox
• OptionGroup

Int32
Optional A value or a constant that specifies the index of the selected text field.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 741
VB scripting
1.5 VBS object model

See also
CheckBox (Page 275)
ComboBox (Page 290)
Listbox (Page 339)
OptionGroup (Page 371)

IndipendentWindow

Description
No access in runtime.

InfoArea_BackgroundColor

Description
No access in runtime.

InfoArea_ColumnsMovable

Description
No access in runtime.

InfoArea_DefaultTextColor

Description
No access in runtime.

InfoArea_ErrorTextBackgroundColor

Description
No access in runtime.

InfoArea_ErrorTextColor

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

742 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

InfoArea_FocusFrameColor

Description
No access in runtime.

InfoArea_FocusFrameWidth

Description
No access in runtime.

InfoArea_Font

Description
No access in runtime.

InfoArea_RootNodeText

Description
No access in runtime.

InfoArea_SelectionBackgroundColor

Description
No access in runtime.

InfoArea_SelectionForegroundColor

Description
No access in runtime.

InfoArea_ShowGridLines

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 743
VB scripting
1.5 VBS object model

InfoArea_TableHeaderBackgroundColor

Description
No access in runtime.

InfoArea_TableHeaderTextColor

Description
No access in runtime.

InnerBackColorOff

Description
Specifies the color under the slider of the "Switch" object if the object is in OFF status.
Access in runtime Read and write

Syntax
Object.InnerBackColorOff[=Color]

Object
Required. An object of the type "ScreenItem" with the following format:
• Switch

Color
Optional. A value or a constant that specifies the color for the OFF status.

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
Switch (Page 418)

WinCC Engineering V18 – Programming reference

744 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

InnerBackColorOn

Description
Specifies the color under the slider of the "Switch" object if the object is in ON status.
Access in runtime Read and write

Syntax
Object.InnerBackColorOn[=Color]

Object
Required. An object of the type "ScreenItem" with the following format:
• Switch

Color
Optional. A value or a constant that specifies the color for the ON status.

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
Switch (Page 418)

InnerDialColor

Description
No access in runtime.

InnerDialInnerDistance

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 745
VB scripting
1.5 VBS object model

InnerDialOuterDistance

Description
No access in runtime.

InnerHeight

Description
Specifies ###
Access in runtime
• RT Advanced: No access
• RT Professional: Read and write

Syntax
Object.InnerHeight[=Int32]

Object
Required. An object of the type "ScreenItem" with the format:
• Button
• IOField
• RoundButton*
• SymbolicIOField*
*: Read access only

Int32
Optional. A value or a constant, which ###

InnerWidth

Description
Specifies ###
Access in Runtime: Read and write

Syntax
Object.InnerWidth[=Int32]

WinCC Engineering V18 – Programming reference

746 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Object
Required. An object of the type "ScreenItem" with the format:
• Button
• RoundButton*
*: Read access only

Int32
Optional. A value or a constant, which ###

InputAddressText

Description
No access in runtime.

InputValue

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.
Access in runtime Read and write

Syntax
Object.InputValue[=Int32]

Object
Required. An object of the type "ScreenItem" with the format:
• IOField
• SymbolicIOField*
*: Read access only

Int32
Optional. A value or a constant that specifies the input value.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 747
VB scripting
1.5 VBS object model

InspectorViewInternalColumnOrder

Description
No access in runtime.

InspectorViewRowOrder

Description
No access in runtime.

Instance

Description
Returns an instance of the alarm object.

IntegerDigits

Description
Establishes the number of integer digits (0 to 20).
Access in runtime: Read and write

Syntax
Object.IntegerDigits[=Int32]

Object
Required. A "ScreenItem" object with the following format:
• Bar

Int32
Optional A value or a constant that specifies the number of integer digits (0 to 20).

See also
Bar (Page 259)

WinCC Engineering V18 – Programming reference

748 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Interval

Description
Specifies the time interval for updating the displayed measured value. You enter the value in
minutes.
Access in runtime: Read

Syntax
Object.Interval[=Int32]

Object
Required. A "ScreenItem" object with the following format:
• DiscSpaceView

Int32
Optional A value or a constant that specifies the time interval for updating the measured
values.

See also
DiskSpaceView (Page 298)

IsActive

Description
No access in runtime.

IsImageMiddleAligned

Description
No access in runtime.

IsMinPasswordValueSet

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 749
VB scripting
1.5 VBS object model

IsRunningUnderCE

Description
No access in runtime.

IsVerticalScrollBarEnabled

Description
No access in runtime.

ItemBorderStyle

Description
Specifies the line type of the separation lines in the selection list.
Access in runtime Read

Syntax
Object.ItemBorderStyle[=Int32]

Object
Required. An object of the type "ScreenItem" with the following format:
• SymbolicIOField

Int32
Optional. A value or a constant that specifies the type of separation lines in the selection list.

Value VB constant Explanation

-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
SymbolicIOField (Page 422)

WinCC Engineering V18 – Programming reference

750 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

ItemText_AKZ

Description
No access in runtime.

ItemText_Descriptor

Description
No access in runtime.

ItemText_ErrorText

Description
No access in runtime.

ItemText_HardwareRevision

Description
No access in runtime.

ItemText_IMDataVersion

Description
No access in runtime.

ItemText_InstallationDate

Description
No access in runtime.

ItemText_LADDR

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 751
VB scripting
1.5 VBS object model

ItemText_ManufacturerID

Description
No access in runtime.

ItemText_Name

Description
No access in runtime.

ItemText_OKZ

Description
No access in runtime.

ItemText_OperationState

Description
No access in runtime.

ItemText_OrderID

Description
No access in runtime.

ItemText_ProfileID

Description
No access in runtime.

ItemText_Rack

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

752 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

ItemText_RevisionCounter

Description
No access in runtime.

ItemText_SerialNumber

Description
No access in runtime.

ItemText_Slot

Description
No access in runtime.

ItemText_SoftwareRevision

Description
No access in runtime.

ItemText_SpecificProfileData

Description
No access in runtime.

ItemText_State

Description
No access in runtime.

ItemText_Station

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 753
VB scripting
1.5 VBS object model

ItemText_SubAddress

Description
No access in runtime.

ItemText_SubSlot

Description
No access in runtime.

ItemText_SubSystem

Description
No access in runtime.

ItemText_Type

Description
No access in runtime.

IV_ShowItem_AKZ

Description
No access in runtime.

IV_ShowItem_Descriptor

Description
No access in runtime.

IV_ShowItem_ErrorText

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

754 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

IV_ShowItem_HardwareRevision

Description
No access in runtime.

IV_ShowItem_IMDataVersion

Description
No access in runtime.

IV_ShowItem_InstallationDate

Description
No access in runtime.

IV_ShowItem_LADDR

Description
No access in runtime.

IV_ShowItem_ManufacturerID

Description
No access in runtime.

IV_ShowItem_Name

Description
No access in runtime.

IV_ShowItem_OKZ

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 755
VB scripting
1.5 VBS object model

IV_ShowItem_OperationState

Description
No access in runtime.

IV_ShowItem_OrderID

Description
No access in runtime.

IV_ShowItem_ProfileID

Description
No access in runtime.

IV_ShowItem_Rack

Description
No access in runtime.

IV_ShowItem_RevisionCounter

Description
No access in runtime.

IV_ShowItem_SerialNumber

Description
No access in runtime.

IV_ShowItem_Slot

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

756 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

IV_ShowItem_SoftwareRevision

Description
No access in runtime.

IV_ShowItem_SpecificProfileData

Description
No access in runtime.

IV_ShowItem_State

Description
No access in runtime.

IV_ShowItem_Station

Description
No access in runtime.

IV_ShowItem_SubAddress

Description
No access in runtime.

IV_ShowItem_SubSlot

Description
No access in runtime.

IV_ShowItem_SubSystem

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 757
VB scripting
1.5 VBS object model

IV_ShowItem_Type

Description
No access in runtime.

JumpToLimitsAfterMouseClick

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.
Access in runtime: Read and write

Syntax
Object.JumpToLimitsAfterMouseClick[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the format:
• WindowSlider

BOOLEAN
Optional. TRUE, if the slider is set to the associated end value.

See also
WindowSlider (Page 482)

1.5.5.8 Properties K-L

KeyboardOnline

Description
No access in runtime.

LabelColor

Description
Specifies the color of the scale label.

WinCC Engineering V18 – Programming reference

758 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Access in runtime Read and write

Syntax
Object.LabelColor[=Color]

Object
Required. An object of the type "ScreenItem" with the following format:
• Slider

Color
Optional. A value or a constant that specifies the color of the scale label.

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
Slider (Page 408)

Language

Description
Determines the current Runtime language.
Access in Runtime: Read and write

Syntax
Object.Language[= LONG]

Object
Required A "HMIRuntime" object.

LONG
Optional A value or a constant that specifies the national code.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 759
VB scripting
1.5 VBS object model

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
HMIRuntime (Page 209)

LargeTickLabelingStep

Description
Returns the interval at which scale sections are labeled.
Access in runtime: Read and write

Syntax
Object.LargeTickLabelingStep[=Int32]

Object
Required. An object of the type "ScreenItem" with the following format:
• Bar

Int32
Optional. A value or constant that returns the interval at which scale sections are labeled.

See also
Bar (Page 259)

LargeTicksBold

Description
Specifies whether the long marking lengths of a scale are shown in bold.
Access in runtime: Read and write

Syntax
Object.LargeTicksBold[=BOOLEAN]

WinCC Engineering V18 – Programming reference

760 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Object
Required. A "ScreenItem" object with the following format:
• Bar

BOOLEAN
Optional TRUE, if the long marking lengths of a scale are shown in bold.

See also
Bar (Page 259)

LargeTicksSize

Description
Specifies the length of the long marking lengths of a scale.
Access in runtime: Read and write

Syntax
Object.LargeTicksSize[=Int32]

Object
Required. A "ScreenItem" object with the following format:
• Bar

Int32
Optional A value or a constant that specifies the length of the long marking lengths of a scale.

See also
Bar (Page 259)

LastConnectedObject

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 761
VB scripting
1.5 VBS object model

LastConnectedObjectIndex

Description
Specifies the index number of the connection point to the last connected object.
Access in runtime: Read and write

Syntax
Object.LastConnectedObjectIndex[=Int]

Object
Required. An object of the type "ScreenItem" with the format:
• Connector

Int
Optional. A value or a constant that specifies the index number of the connection point to
the last connected object.

See also
Connector (Page 293)

LastConnectedObjectName

Description
Specifies the name of the object that is docked to the lower connector point.
Access in runtime: Read and write

Syntax
Object.LastConnectedObjectName[=String]

Object
Required. An object of the type "ScreenItem" with the following format:
• 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
Connector (Page 293)

WinCC Engineering V18 – Programming reference

762 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

LastError

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.
Access during runtime: Read

Syntax
Object.LastError

Object
Necessary. A "Tag" object.

Example
The following example shows the error code for the "Tag1" tag:

'VBS77
Dim objTag
Set objTag = HMIRuntime.Tags("Tag1")
objTag.Read
MsgBox objTag.LastError

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 763
VB scripting
1.5 VBS object model

The following example adds two tags to the TagSet list and outputs the LastError property as
Trace:

'VBS178
Dim group
Set group = HMIRuntime.Tags.CreateTagSet
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 229)
TagSet (list) (Page 233)

Layer

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.
Access in runtime: Read and write

Syntax
Object.Layer[=Int32]

Object
Required. An object of the type "ScreenItem" with the format:
• AlarmControl *
• AlarmView **
• ApplicationWindow *
• Bar
• BatteryView ***
• Button
• CameraControl ***
• ChannelDiagnose *

WinCC Engineering V18 – Programming reference

764 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

• CheckBox *
• Circle
• CircleSegment *
• CircularArc *
• Clock
• ComboBox *
• Connector *
• DateTimeField **
• DiscSpaceView *
• Ellipse
• EllipseSegment *
• EllipticalArc *
• FunctionTrendControl **
• Gauge
• GraphicIOField
• GraphicView
• HTMLBrowser
• IOField
• Line
• ListBox *
• MediaPlayer
• MultiLineEdit *
• OptionGroup *
• PLCCodeViewer **
• Polygon
• Polyline
• ProDiagOverview ****
• ProtectedAreaNameView ***
• RangeLabelView ***
• RangeQualityView ***
• RecipeView **
• Rectangle
• RoundButton *****
• S7GraphOverview
• ScreenWindow *

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 765
VB scripting
1.5 VBS object model

• Slider
• SmartClientView **
• StatusForce **
• Switch **
• SymbolLibrary
• SymbolicIOField ******
• SysDiagControl *******
• TextField
• TrendRulerControl *
• TrendView **
• TubeArcObject *
• TubeDoubleTeeObject *
• TubeTeeObject *
• Tubepolyline *
• UserView
• WLanQualityView ***
• WindowSlider *
• ZoneLabelView ***
• ZoneQualityView ***
* RT Advanced No access
** RT Professional No access
*** 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

You have no access in runtime with the following format:

• OnlineTableControl
• OnlineTrendControl
• UserArchiveControl

Int32
Optional. A value or a constant returns the layer in the screen in which an object is located.

WinCC Engineering V18 – Programming reference

766 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

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
Set objScreen = HMIRuntime.Screens("NewPDL1")
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
AlarmControl (Page 237)
AlarmView (Page 251)
ApplicationWindow (Page 257)
Bar (Page 259)
BatteryView (Page 265)
Button (Page 267)
CameraControl (Page 272)
ChannelDiagnose (Page 274)
CheckBox (Page 275)
Circle (Page 279)
CircleSegment (Page 282)
CircularArc (Page 285)
Clock (Page 287)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 767
VB scripting
1.5 VBS object model

ComboBox (Page 290)

Connector (Page 293)
DateTimeField (Page 296)
DiskSpaceView (Page 298)
Ellipse (Page 300)
EllipseSegment (Page 303)
EllipticalArc (Page 306)
FunctionTrendControl (Page 309)
Gauge (Page 320)
GraphicIOField (Page 324)
GraphicView (Page 327)
HTMLBrowser (Page 330)
IOField (Page 332)
Line (Page 336)
Listbox (Page 339)
MediaPlayer (Page 342)
MultiLineEdit (Page 345)
OnlineTableControl (Page 347)
OnlineTrendControl (Page 359)
OptionGroup (Page 371)
PLCCodeViewer (Page 376)
Polygon (Page 378)
Polyline (Page 381)
ProtectedAreaNameView (Page 385)
RangeLabelView (Page 386)
RangeQualityView (Page 388)
RecipeView (Page 389)
Rectangle (Page 395)
RoundButton (Page 398)
S7GraphOverview (Page 402)
ScreenWindow (Page 404)
Slider (Page 408)
SmartClientView (Page 412)
StatusForce (Page 414)
Switch (Page 418)

WinCC Engineering V18 – Programming reference

768 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

SymbolicIOField (Page 422)

SymbolLibrary (Page 427)
SysDiagControl (Page 429)
TextField (Page 438)
TrendRulerControl (Page 441)
TrendView (Page 451)
TubeArcObject (Page 457)
TubeDoubleTeeObject (Page 459)
TubePolyline (Page 461)
TubeTeeObject (Page 464)
UserArchiveControl (Page 466)
UserView (Page 478)
WindowSlider (Page 482)
WLanQualityView (Page 485)
ZoneLabelView (Page 487)
ZoneQualityView (Page 488)

LayerDeclutteringEnable

Description
Indicates whether the layers of a screen can be shown or hidden dependent on the set minimum
and maximum zoom.
Access during runtime: Read

Syntax
Object.LayerDeclutteringEnable

Object
Necessary. A "Screen" object.

Example:
The example outputs the LayerDecluttering property of the "NewPDL1" screen as Trace.

'VBS156
Dim objScreen
Set objScreen = HMIRuntime.Screens("NewPDL1")
HMIRuntime.Trace "Enable: " & objScreen.LayerDeclutteringEnable & vbNewLine

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 769
VB scripting
1.5 VBS object model

See also
Screen (Page 216)

Layers

Description
Returns an object of type "Layers".
Access in Runtime: Read

Syntax
Object.Layers

Object
Required A "Screen" object.

See also
Screen (Page 216)

Left

Description
Specifies the value of the X coordinate.
Access in runtime: Read and write

Syntax
Object.Left[=Int32]

Object
Required. An object of the type "ScreenItem" with the format:
• AlarmControl *
• AlarmView **
• ApplicationWindow *
• Bar
• BatteryView ***
• Button
• ChannelDiagnose *
• CheckBox *

WinCC Engineering V18 – Programming reference

770 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

• Circle
• CircleSegment *
• CircularArc *
• Clock
• ComboBox *
• Connector *
• DateTimeField **
• DiscSpaceView *
• Ellipse
• EllipseSegment *
• EllipticalArc *
• FunctionTrendControl
• Gauge
• GraphicIOField
• GraphicView
• HTMLBrowser
• IOField
• Line
• ListBox *
• MediaPlayer
• MultiLineEdit *
• OnlineTableControl *
• OnlineTrendControl *
• OptionGroup *
• PLCCodeViewer **
• Polygon
• Polyline
• ProDiagOverview ***
• ProtectedAreaNameView ***
• RangeLabelView ***
• RangeQualityView ***
• RecipeView**
• Rectangle
• RoundButton *****
• S7GraphOverview **

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 771
VB scripting
1.5 VBS object model

• ScreenWindow *
• Slider
• SmartClientView **
• StatusForce **
• Switch **
• SymbolLibrary
• SymbolicIOField ******
• SysDiagControl *******
• TextField
• TrendRulerControl *
• TrendView **
• TubeArcObject *
• TubeDoubleTeeObject *
• TubeTeeObject *
• Tubepolyline *
• UserArchiveControl *
• UserView
• WLanQualityView ***
• WindowSlider *
• ZoneLabelView ***
• ZoneQualityView ***
* RT Advanced No access
** RT Professional No access
*** 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.

WinCC Engineering V18 – Programming reference

772 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

See also
Bar (Page 259)
BorderWidth (Page 577)
CameraControl (Page 272)
Connector (Page 293)
AlarmControl (Page 237)
AlarmView (Page 251)
ApplicationWindow (Page 257)
BatteryView (Page 265)
Button (Page 267)
ChannelDiagnose (Page 274)
CheckBox (Page 275)
Circle (Page 279)
CircleSegment (Page 282)
CircularArc (Page 285)
Clock (Page 287)
ComboBox (Page 290)
DateTimeField (Page 296)
DiskSpaceView (Page 298)
Ellipse (Page 300)
EllipseSegment (Page 303)
EllipticalArc (Page 306)
FunctionTrendControl (Page 309)
Gauge (Page 320)
GraphicIOField (Page 324)
GraphicView (Page 327)
HTMLBrowser (Page 330)
IOField (Page 332)
Line (Page 336)
Listbox (Page 339)
MediaPlayer (Page 342)
MultiLineEdit (Page 345)
OnlineTableControl (Page 347)
OnlineTrendControl (Page 359)
OptionGroup (Page 371)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 773
VB scripting
1.5 VBS object model

PLCCodeViewer (Page 376)

Polygon (Page 378)
Polyline (Page 381)
ProtectedAreaNameView (Page 385)
RangeLabelView (Page 386)
RangeQualityView (Page 388)
RecipeView (Page 389)
Rectangle (Page 395)
RoundButton (Page 398)
S7GraphOverview (Page 402)
ScreenWindow (Page 404)
Slider (Page 408)
SmartClientView (Page 412)
StatusForce (Page 414)
Switch (Page 418)
SymbolicIOField (Page 422)
SymbolLibrary (Page 427)
SysDiagControl (Page 429)
TextField (Page 438)
TrendRulerControl (Page 441)
TrendView (Page 451)
TubeArcObject (Page 457)
TubeDoubleTeeObject (Page 459)
TubePolyline (Page 461)
TubeTeeObject (Page 464)
UserArchiveControl (Page 466)
UserView (Page 478)
WindowSlider (Page 482)
WLanQualityView (Page 485)
ZoneLabelView (Page 487)
ZoneQualityView (Page 488)

WinCC Engineering V18 – Programming reference

774 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

LeftMargin

Description
No access in runtime.

LeftOffset

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 738)" and
"VerticalScrollbarPosition (Page 1202) properties for the offset.
Access in Runtime: Read and write

Syntax
Object.LeftOffset[=Int32]

Object
Required. An object of the type "ScreenItem" with the following format:
• 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
ScreenWindow (Page 404)

Limit4LowerLimit

Description
Specifies the lower limit for ""Reserve4".
The "Limit4LowerLimitEnabled" property must be set to TRUE so that the limit "Reserve4"" can
be monitored.
Access in runtime: Read and write

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 775
VB scripting
1.5 VBS object model

Syntax
Object.Limit4LowerLimit[=DOUBLE]

Object
Required. A "ScreenItem" object with the following format:
• 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 259)

Limit4LowerLimitColor

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.
Access in runtime Read and write

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
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:

WinCC Engineering V18 – Programming reference

776 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

RGB (255, 0, 0)
You can also use the VBS color constants such as vbRed and vbGreen.

See also
Bar (Page 259)

Limit4LowerLimitEnabled

Description
Specifies whether the lower limit ""Reserve4"" is to be monitored.
Access in runtime: Read and write

Syntax
Object.Limit4LowerLimitEnabled[=BOOLEAN]

Object
Required. A "ScreenItem" object with the following format:
• 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
• Representation upon reaching the limit
• Type of evaluation

See also
Bar (Page 259)

Limit4LowerLimitRelative

Description
Specifies whether the low limit "Reserve4" is evaluated as a percentage or as an absolute value.
Access in runtime Read and write

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 777
VB scripting
1.5 VBS object model

Syntax
Object.Limit4LowerLimitRelative[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• 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 259)

Limit4UpperLimit

Description
Specifies the lower limit for "Reserve4".
The "Limit4UpperLimitEnabled"" property must be set to TRUE so that the limit ""Reserve4"
can be monitored.
Access in runtime: Read and write

Syntax
Object.Limit4UpperLimit[=DOUBLE]

Object
Required. A "ScreenItem" object with the following format:
• 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
percentage or absolutely.

See also
Bar (Page 259)

WinCC Engineering V18 – Programming reference

778 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Limit4UpperLimitColor

Description
Specifies the color for the upper limit ""Reserve4".
The "Limit4UpperLimitEnabled"" property must have the value TRUE if the bar color is to
change once the limit has been reached.
Access in runtime Read and write

Syntax
Object.Limit4UpperLimitColor[=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 upper limit "Reserve4".

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
Bar (Page 259)

Limit4UpperLimitEnabled

Description
Specifies whether the upper limit "Reserve4" is to be monitored.
Access in runtime: Read and write

Syntax
Object.Limit4UpperLimitEnabled[=BOOLEAN]

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 779
VB scripting
1.5 VBS object model

Object
Required. A "ScreenItem" object with the following format:
• 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
• Representation upon reaching the limit
• Type of evaluation

See also
Bar (Page 259)

Limit4UpperLimitRelative

Description
Specifies whether the high limit "Reserve4" is to be evaluated as a percentage or as an absolute
value.
Access in runtime Read and write

Syntax
Object.Limit4UpperLimitRelative[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• 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 259)

WinCC Engineering V18 – Programming reference

780 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Limit5LowerLimit

Description
Specifies the lower limit for "Reserve5"".
The "Limit5LowerLimitEnabled" property must be set to TRUE so that the limit ""Reserve5" can
be monitored.
Access in runtime: Read and write

Syntax
Object.Limit5LowerLimit[=DOUBLE]

Object
Required. A "ScreenItem" object with the following format:
• 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
percentage or absolutely.

See also
Bar (Page 259)

Limit5LowerLimitColor

Description
Specifies the color for the lower limit ""Reserve5"".
The "Limit5LowerLimitEnabled" property must have the value TRUE if the bar color is to
change once the limit has been reached.
Access in runtime Read and write

Syntax
Object.Limit5LowerLimitColor[=Color]

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 781
VB scripting
1.5 VBS object model

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 ""Reserve5".

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
Bar (Page 259)

Limit5LowerLimitEnabled

Description
Specifies whether the lower limit "Reserve5" is to be monitored.
Access in runtime: Read and write

Syntax
Object.Limit5LowerLimitEnabled[=BOOLEAN]

Object
Required. A "ScreenItem" object with the following format:
• Bar

BOOLEAN
Optional TRUE, if the lower limit ""Reserve5" is to be monitored.

WinCC Engineering V18 – Programming reference

782 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Comments
The following values will be defined via the properties "Limit5LowerLimit",
"Limit5LowerLimitColor" and "Limit5LowerLimitRelative":
• Limit
• Representation upon reaching the limit
• Type of evaluation

See also
Bar (Page 259)

Limit5LowerLimitRelative

Description
Specifies whether the lower limit ""Reserve5" is to be evaluated as a percentage or as an absolute
value.
Access in runtime Read and write

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 259)

Limit5UpperLimit

Description
Specifies the lower limit for "Reserve5".
The ""Limit5UpperLimitEnabled" property must be set to TRUE so that the limit ""Reserve5"
can be monitored.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 783
VB scripting
1.5 VBS object model

Access in runtime: Read and write

Syntax
Object.Limit5UpperLimit[=DOUBLE]

Object
Required. A "ScreenItem" object with the following format:
• 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 259)

Limit5UpperLimitColor

Description
Specifies the color for the upper limit "Reserve5"".
The "Limit5UpperLimitEnabled" property must have the value TRUE if the bar color is to
change once the limit has been reached.
Access in runtime Read and write

Syntax
Object.Limit5UpperLimitColor[=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 upper limit ""Reserve5".

WinCC Engineering V18 – Programming reference

784 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

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
Bar (Page 259)

Limit5UpperLimitEnabled

Description
Specifies whether the upper limit "Reserve5" is to be monitored.
Access in runtime: Read and write

Syntax
Object.Limit5UpperLimitEnabled[=BOOLEAN]

Object
Required. A "ScreenItem" object with the following format:
• Bar

BOOLEAN
Optional TRUE, if the upper limit ""Reserve5"" is to be monitored.

See also
Bar (Page 259)

Limit5UpperLimitRelative

Description
Specifies whether the high limit "Reserve5" is to be evaluated as a percentage or as an absolute
value.
Access in runtime Read and write

Syntax
Object.Limit5UpperLimitRelative[=BOOLEAN]

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 785
VB scripting
1.5 VBS object model

Object
Required. An object of the type "ScreenItem" with the following format:
• 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 259)

LimitRangeCollection

Description
No access in runtime.

LineAlarmView

Description
No access in runtime.

LineBackgroundColor

Description
No access in runtime.

LineColor

Description
Specifies the color of the window separation lines.
Access in runtime Read and write

Syntax
Object.LineColor[=Color]

WinCC Engineering V18 – Programming reference

786 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• FunctionTrendControl
• OnlineTableControl
• OnlineTrendControl
• TrendRulerControl
• UserArchiveControl

Color
Optional. A value or a constant that specifies the color of the window separation lines.

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
AlarmControl (Page 237)
FunctionTrendControl (Page 309)
OnlineTableControl (Page 347)
OnlineTrendControl (Page 359)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

LineEndShapeStyle

Description
Specifies the shape of the line ends.
Access in runtime:
• RT Advanced: No access
• RT Professional: Read and write

Syntax
Object.LineEndShapeStyle[=LineEndShapeStyle]

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 787
VB scripting
1.5 VBS object model

Object
Required. An object of the type "ScreenItem" with the format:
• Bar
• Button
• CheckBox
• Circle
• CircleSegment
• CircularArc
• ComboBox
• Connector
• Ellipse
• EllipseSegment
• EllipticalArc
• GraphicIOField
• GraphicView
• IOField
• Line
• ListBox
• MultiLineEdit
• OptionGroup
• Polygon
• Polyline
• Rectangle
• RoundButton *
• SymbolicIOField *
• TextField
• WindowSlider
* Read access only
You have no access in runtime with the following format:
• Switch
• TubeArcObject

WinCC Engineering V18 – Programming reference

788 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

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 259)
Button (Page 267)
CheckBox (Page 275)
Circle (Page 279)
CircleSegment (Page 282)
CircularArc (Page 285)
ComboBox (Page 290)
Connector (Page 293)
Ellipse (Page 300)
EllipseSegment (Page 303)
EllipticalArc (Page 306)
GraphicIOField (Page 324)
GraphicView (Page 327)
IOField (Page 332)
Line (Page 336)
Listbox (Page 339)
MultiLineEdit (Page 345)
OptionGroup (Page 371)
Polygon (Page 378)
Polyline (Page 381)
Rectangle (Page 395)
RoundButton (Page 398)
Switch (Page 418)
SymbolicIOField (Page 422)
TextField (Page 438)
TubeArcObject (Page 457)
WindowSlider (Page 482)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 789
VB scripting
1.5 VBS object model

LinesPerDiagEntry

Description
No access in runtime.

LineStyle

Description
No access in runtime.

LineWidth

Description
Specifies the line thickness.
Access in runtime:
• RT Advanced: No access
• RT Professional: Read and write

Syntax
Object.LineWidth[=Int32]

Object
Required. An object of the type "ScreenItem" with the format:
• AlarmControl
• CircularArc
• Connector
• EllipticalArc
• FunctionTrendControl
• Line *
• OnlineTableControl
• OnlineTrendControl
• Polyline *
• TrendRulerControl
• TubeArcObject
• TubeDoubleTeeObject
• TubeTeeObject

WinCC Engineering V18 – Programming reference

790 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

• Tubepolyline
• UserArchiveControl
* RT Advanced read and write access
You have no access in runtime with the following format:
• Polygon

Int32
Optional. A value or a constant that specifies the line weight in pixels.

See also
AlarmControl (Page 237)
CircularArc (Page 285)
EllipticalArc (Page 306)
FunctionTrendControl (Page 309)
Line (Page 336)
OnlineTableControl (Page 347)
OnlineTrendControl (Page 359)
Polyline (Page 381)
TrendRulerControl (Page 441)
TubeArcObject (Page 457)
TubeDoubleTeeObject (Page 459)
TubePolyline (Page 461)
TubeTeeObject (Page 464)
UserArchiveControl (Page 466)
Polygon (Page 378)

LineWrap

Description
No access in runtime.

ListAreaHeight

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 791
VB scripting
1.5 VBS object model

ListAreaLeft

Description
No access in runtime.

ListAreaTop

Description
No access in runtime.

ListAreaWidth

Description
No access in runtime.

LoadDataImmediately

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.
Access in runtime: Read and write

Syntax
Object.LoadDataImmediately[=BOOLEAN]

Object
Required. A "ScreenItem" object with the following format:
• FunctionTrendControl
• OnlineTableControl
• OnlineTrendControl

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.

WinCC Engineering V18 – Programming reference

792 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

See also
FunctionTrendControl (Page 309)
OnlineTableControl (Page 347)
OnlineTrendControl (Page 359)

LocalCursor

Description
No access in runtime.

Location

Description
No access in runtime.

LockSquaredExtent

Description
Specifies whether the size of the clock can be adjusted with the mouse.
Access in runtime: Read and write

Syntax
Object.LockSquaredExtent[=BOOLEAN]

Object
Required. A "ScreenItem" object with the following format:
• 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 287)
Gauge (Page 320)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 793
VB scripting
1.5 VBS object model

Logging

Description
Returns an object of type "Logging".
Access in Runtime: Read

Syntax
Object.Logging

Object
Required A "HMIRuntime" object.

See also
HMIRuntime (Page 209)

LogOperation

Description
Specifies whether, after operating this object, an alarm is output on the alarm system.
Access in runtime: Read and write

Syntax
Object.LogOperation[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the format:
• CheckBox
• ComboBox
• IOField
• ListBox
• OptionGroup
• SymbolicIOField *
• WindowSlider
*: Read access only

BOOLEAN
Optional TRUE, if, after operating this object, an alarm is output on the alarm system.

WinCC Engineering V18 – Programming reference

794 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

LongDateTimeFormat

Description
No access in runtime.

LongTermArchiveConsistency

Description
Specifies how alarms are displayed in the alarm view when the "Historical alarm list (long-term)"
is configured.
Access in runtime Read and write

Syntax
Object.LongTermArchiveConsistency[= BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• 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-station system, server or client for each server, or for each redundant server pair.

See also
AlarmControl (Page 237)

Look3D

Description
No access in runtime.

LowerLimit

Description
Specifies the lower limit for input values.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 795
VB scripting
1.5 VBS object model

Access in runtime: Read and write

Syntax
Object.LowerLimit[=DOUBLE]

Object
Required. A "ScreenItem" object with the following format:
• IOField

DOUBLE
Optional A value or a constant that specifies the lower limit for input values.

See also
IOField (Page 332)

LowLimitColor

Description
Specifies the color of the bottom or left scroll button in a scroll bar.
Access in runtime Read and write

Syntax
Object.LowLimitColor[=Color]

Object
Required. An object of the type "ScreenItem" with the format:
• WindowSlider

Color
Optional. A value or a constant that specifies the color of the bottom or left scroll button in a
scroll bar.

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.

WinCC Engineering V18 – Programming reference

796 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

See also
WindowSlider (Page 482)

1.5.5.9 Properties M-N

Machine

Description
No access in runtime.

MachineName

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.
Access in runtime: Read and write

Syntax
Object.MachineName[=STRING]

Object
Required. A "ScreenItem" object with the following format:
• SmartClientView

STRING
Optional A value or a constant that contains the network code.

See also
SmartClientView (Page 412)

MaintainAspectRatio

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 797
VB scripting
1.5 VBS object model

MaintainOriginalSize

Description
No access in runtime.

MarginToBorder

Description
Specifies the width of the 3D border in pixels. The value of the width is dependent on the size of
the object.
Access in runtime: Read and write

Syntax
Object.MarginToBorder[=Int32]

Object
Required. An object of the type "ScreenItem" with the format:
• WindowSlider

Int32
Optional A value or a constant that specifies the width of the 3D border in pixels.

See also
WindowSlider (Page 482)

MaximumNumberOfTimeAxes

Description
No access in runtime.

MaximumNumberOfTimeColumns

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

798 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

MaximumNumberOfValueAxes

Description
No access in runtime.

MaximumNumberOfValueColumns

Description
No access in runtime.

MaximumValue

Description
Specifies the maximum value of the scale in the selected object.
Access in runtime: Read and write

Syntax
Object.MaximumValue[=DOUBLE | Int32 | SINGLE]

Object
Required. A "ScreenItem" object with the format:
• 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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 799
VB scripting
1.5 VBS object model

MaxNrOfCurves

Description
No access in runtime.

MaxNumberOfComboBoxCharacters

Description
No access in runtime.

MaxToolbarRows

Description
No access in runtime.

MenuButtonVisible

Description
No access in runtime.

MenuToolBarConfig

Description
Determines the configuration file with user-defined menu and toolbars.
Access in Runtime: Read and write

Syntax
Object.MenuToolBarConfig[=HmiObjectHandle]

Object
Required. An object of the type "ScreenItem" with the format:
• ScreenWindow

HmiObjectHandle
Optional. A value or a constant that specifies the configuration file with user-defined menu
and toolbars.

WinCC Engineering V18 – Programming reference

800 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

MessageAreaHeight

Description
No access in runtime.

MessageAreaLeft

Description
No access in runtime.

MessageAreaTop

Description
No access in runtime.

MessageAreaWidth

Description
No access in runtime.

MessageBlockAlignment

Description
Specifies the designation of an alarm text block referenced with "MessageBlockIndex" in the
column header.
Also set "ApplyProjectSettings" to "FALSE".
Access in runtime Read and write

Syntax
Object.MessageBlockAlignment [=HorizontalAlignment]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 801
VB scripting
1.5 VBS object model

HorizontalAlignment
Optional. A value or constant that determines the alignment.

Value Designation Description

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 513)
AlarmControl (Page 237)

MessageBlockAutoPrecisions

Description
Specifies whether the number of decimal places for an alarm text block referenced with
"MessageBlockIndex" is automatically determined.
Also set "ApplyProjectSettings" to "FALSE".
Access in runtime Read and write

Syntax
Object.MessageBlockAutoPrecisions[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl

BOOLEAN
Optional.
TRUE if the number of decimal places is automatically determined.
FALSE if the value of "MessageBlockPrecisions" is used.

See also
MessageBlockIndex (Page 808)
ApplyProjectSettings (Page 513)
AlarmControl (Page 237)

WinCC Engineering V18 – Programming reference

802 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

MessageBlockCaption

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.
Also set "ApplyProjectSettings" to "FALSE".
Access in runtime Read and write

Syntax
Object.MessageBlockCaption[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl

STRING
Optional. Specifies the designation in the column header for the selected alarm text block.

See also
ApplyProjectSettings (Page 513)
AlarmControl (Page 237)

MessageBlockCount

Description
Specifies the number of configured alarm text blocks.
Access in runtime Read and write

Syntax
Object.MessageBlockCount[=Int32]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl

Int32
Optional. A value or a constant that specifies the number of configured alarm text blocks.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 803
VB scripting
1.5 VBS object model

See also
AlarmControl (Page 237)

MessageBlockDateFormat

Description
Specifies the date format for displaying the alarms.
Also set "ApplyProjectSettings" to "FALSE".
Access in runtime Read and write

Syntax
Object.MessageBlockDateFormat[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• 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
ApplyProjectSettings (Page 513)
AlarmControl (Page 237)

MessageBlockExponentialFormat

Description
Specifies whether the values of an alarm text block referenced with "MessageBlockIndex" are
displayed in exponential notation.
Also set "ApplyProjectSettings" to "FALSE".
Access in runtime Read and write

WinCC Engineering V18 – Programming reference

804 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Syntax
Object.MessageBlockExponentialFormat[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl

BOOLEAN
Optional.
TRUE if the values are displayed in exponential notation.
FALSE if the values are displayed in decimal notation.

See also
ApplyProjectSettings (Page 513)
AlarmControl (Page 237)

MessageBlockFlashOn

Description
Specifies whether the content of an alarm text block referenced with "MessageBlockIndex"
flashes in runtime when an alarm appears.
Also set "ApplyProjectSettings" to "FALSE".
Access in runtime Read and write

Syntax
Object.MessageBlockFlashOn[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• 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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 805
VB scripting
1.5 VBS object model

See also
ApplyProjectSettings (Page 513)
AlarmControl (Page 237)

MessageBlockHideText

Description
Specifies whether the content of an alarm text block referenced with "MessageBlockIndex" is
displayed as text.
Also set "ApplyProjectSettings" to "FALSE".
Access in runtime Read and write

Syntax
Object.MessageBlockHideText[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl

BOOLEAN
Optional.
TRUE if the content is not displayed as text.
FALSE if the content is displayed as text.

See also
ApplyProjectSettings (Page 513)
AlarmControl (Page 237)

MessageBlockHideTitleText

Description
Specifies whether the header of an alarm text block referenced with "MessageBlockIndex" is
displayed as text.
Also set "ApplyProjectSettings" to "FALSE".
Access in runtime Read and write

WinCC Engineering V18 – Programming reference

806 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Syntax
Object.MessageBlockHideTitleText[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl

BOOLEAN
Optional.
TRUE if the header is not displayed as text.
FALSE if the header is displayed as text.

See also
AlarmControl (Page 237)

MessageBlockId

Description
Specifies the assignment of ID number and alarm text block in the alarm view.
Access in runtime: Read and write

Syntax
Object.MessageBlockId[=Int32]

Object
Required. A "ScreenItem" object with the following format:
• AlarmControl

Int32
Optional Specifies the assignment of ID number and alarm text block in the alarm view.

See also
AlarmControl (Page 237)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 807
VB scripting
1.5 VBS object model

MessageBlockIndex

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.
Access in runtime Read and write

Syntax
Object.MessageBlockIndex[=Int32]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl

Int32
Optional. A value or a constant that specifies, with the index, the alarm text block to be
edited.

See also
MessageBlockCount (Page 803)
AlarmControl (Page 237)

MessageBlockLeadingZeros

Description
Specifies whether the entries in an alarm text block referenced with "MessageBlockIndex" are
displayed with leading zeros.
Also set "ApplyProjectSettings" to "FALSE".
Access in runtime Read and write

Syntax
Object.MessageBlockLeadingZeros[=Int32]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl

WinCC Engineering V18 – Programming reference

808 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

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
ApplyProjectSettings (Page 513)
AlarmControl (Page 237)

MessageBlockLength

Description
Specifies the length in characters of the content of an alarm text block referenced with
"MessageBlockIndex".
Also set "ApplyProjectSettings" to "FALSE".
Access in runtime Read and write

Syntax
Object.MessageBlockLength[=Int32]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl

Int32
Optional. Value which specifies the length of the alarm text block.

See also
ApplyProjectSettings (Page 513)
AlarmControl (Page 237)

MessageBlockName

Description
Specifies the name of an alarm text block referenced with "MessageBlockIndex".
Access in runtime: Read and write

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 809
VB scripting
1.5 VBS object model

Syntax
Object.MessageBlockName[=STRING]

Object
Required. An object of the type "ScreenItem" with the format:
• AlarmControl

STRING
Optional. A value or a constant that specifies the name of the referenced alarm text block.

MessageBlockPrecisions

Description
Specifies the number of decimal places for values in an alarm text block referenced with
"MessageBlockIndex".
Also set "ApplyProjectSettings" to "FALSE".
Access in runtime Read and write

Syntax
Object.MessageBlockPrecisions[=Int16]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl

Int16
Optional. Specifies the number of decimal places.

See also
ApplyProjectSettings (Page 513)
AlarmControl (Page 237)

MessageBlockSelected

Description
Specifies whether an alarm text block referenced with "MessageBlockIndex" is selected.
Also set "ApplyProjectSettings (Page 513)" to "FALSE".
Access in runtime Read and write

WinCC Engineering V18 – Programming reference

810 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Syntax
Object.MessageBlockSelected[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl

BOOLEAN
Optional. TRUE if the alarm text block is selected.

See also
AlarmControl (Page 237)

MessageBlockShowDate

Description
Specifies whether to display both the date and time in the "Time" alarm text block.
Also set "ApplyProjectSettings" to "FALSE".
Access in runtime Read and write

Syntax
Object.MessageBlockShowDate[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl

BOOLEAN
Optional.
TRUE if both date and time are displayed.
FALSE if the time is displayed.

See also
ApplyProjectSettings (Page 513)
AlarmControl (Page 237)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 811
VB scripting
1.5 VBS object model

MessageBlockShowIcon

Description
Specifies whether the content of an alarm text block referenced with "MessageBlockIndex" is
displayed as an icon.
Also set "ApplyProjectSettings" to "FALSE".
Access in runtime Read and write

Syntax
Object.MessageBlockShowIcon[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl

BOOLEAN
Optional.
TRUE if the content is displayed as an icon.
FALSE if the content is not displayed as an icon.

See also
ApplyProjectSettings (Page 513)
AlarmControl (Page 237)

MessageBlockShowTitleIcon

Description
Specifies whether the header of an alarm text block referenced with "MessageBlockIndex" is
displayed as text.
Also set "ApplyProjectSettings" to "FALSE".
Access in runtime Read and write

Syntax
Object.MessageBlockShowTitleIcon[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl

WinCC Engineering V18 – Programming reference

812 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

BOOLEAN
Optional.
TRUE if the header is shown as an icon.
FALSE if the header is not shown as an icon.

See also
ApplyProjectSettings (Page 513)
AlarmControl (Page 237)

MessageBlockTextId

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.
Also set "ApplyProjectSettings" to "FALSE".
Access in runtime: Read and write

Syntax
Object.MessageBlockTextId[=Int32]

Object
Required. An object of the type "ScreenItem" with the format:
• AlarmControl

Int32
Optional. Specifies the name of the selected alarm text block using a text ID number.

MessageBlockTimeFormat

Description
Specifies which time format or duration format is used for displaying alarms.
Also set "ApplyProjectSettings" to "FALSE".
Access in runtime Read and write

Syntax
Object.MessageBlockTimeFormat[=STRING]

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 813
VB scripting
1.5 VBS object model

Object
Required. An object of the type "ScreenItem" with the following format:
• 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
Automatic The time format is set automatically.
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.
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.

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
ApplyProjectSettings (Page 513)
AlarmControl (Page 237)

MessageBlockType

Description
Returns the type of an alarm text block referenced with "MessageBlockIndex".
Access in runtime Read and write

Syntax
Object.MessageBlockType[=AlarmBlockType]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl

WinCC Engineering V18 – Programming reference

814 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

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
ApplyProjectSettings (Page 513)
AlarmControl (Page 237)

MessageColumnAdd

Description
Creates a new alarm text block. The newly created alarm text block is automatically referenced
with "MessageColumnIndex".
Access in runtime Read and write

Syntax
Object.MessageColumnAdd[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl

STRING
Required. A value or a constant that specifies the name of the new alarm text block with
"MessageColumnName".

See also
MessageColumnIndex (Page 816)
AlarmControl (Page 237)

MessageColumnCount

Description
Specifies the number of configured alarm text blocks.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 815
VB scripting
1.5 VBS object model

Access in runtime Read and write

Syntax
Object.MessageColumnCount[=Int32]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl

Int32
Optional. A value or a constant that specifies the number of configured alarm text blocks.

See also
AlarmControl (Page 237)

MessageColumnIndex

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.
Access in runtime Read and write

Syntax
Object.MessageColumnIndex[=Int32]

Object
Required. An object of the type "ScreenItem" with the following format:
• 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 815)
AlarmControl (Page 237)

WinCC Engineering V18 – Programming reference

816 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

MessageColumnName

Description
Specifies the name of an alarm text block referenced with "MessageColumnIndex".
Access in runtime Read and write

Syntax
Object.MessageColumnName[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl

STRING
Optional. A value or a constant that specifies the name of the referenced alarm text block.

See also
MessageColumnIndex (Page 816)
AlarmControl (Page 237)

MessageColumnRemove

Description
Removes an alarm text block referenced with its name.
Access in runtime Read and write

Syntax
Object.MessageColumnRemove[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl

STRING
Optional. A value or a constant that specifies the name of the referenced alarm text block to
be removed.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 817
VB scripting
1.5 VBS object model

See also
AlarmControl (Page 237)

MessageColumnRepos

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".
Access in runtime Read and write

Syntax
Object.MessageColumnRepos[=Int32]

Object
Required. An object of the type "ScreenItem" with the following format:
• 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
MessageColumnIndex (Page 816)
MessageColumnCount (Page 815)
AlarmControl (Page 237)

MessageColumnSort

Description
Specifies how the content of an alarm text block referenced with "MessageColumnIndex" is
sorted.
Access in runtime Read and write

WinCC Engineering V18 – Programming reference

818 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Syntax
Object.MessageColumnSort[=SortMode]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl

SortMode
Optional. A value or a constant that specifies sorting for the referenced alarm text block.

Value Explanation
0 No sorting
1 Ascending sorting from the smallest to largest value
2 Descending sorting from the largest to smallest value

See also
AlarmControl (Page 237)

MessageColumnSortIndex

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".
Access in runtime: Read and write

Syntax
Object.MessageColumnSortIndex[=Int32]

Object
Required. A "ScreenItem" object with the following format:
• AlarmControl

Int32
Optional Defines the sorting order of the alarm text block referenced in
"MessageColumnIndex".

See also
AlarmControl (Page 237)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 819
VB scripting
1.5 VBS object model

MessageColumnVisible

Description
Specifies whether the alarm text block referenced with "MessageColumnIndex" is displayed.
Access in runtime Read and write

Syntax
Object.MessageColumnVisible[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl

BOOLEAN
Optional.
TRUE if the referenced alarm text block is displayed.
FALSE if the referenced alarm text block is not displayed.

See also
MessageColumnIndex (Page 816)
AlarmControl (Page 237)

MessageListType

Description
Specifies the content to be displayed.
Access in runtime Read and write

Syntax
Object.MessageListType[=AlarmListType]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl

WinCC Engineering V18 – Programming reference

820 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

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
AlarmControl (Page 237)

MiddleGradientColor

Description
No access in runtime.

MinimumNumberOfTimeAxes

Description
No access in runtime.

MinimumNumberOfTimeColumns

Description
No access in runtime.

MinimumNumberOfValueAxes

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 821
VB scripting
1.5 VBS object model

MinimumNumberOfValueColumns

Description
No access in runtime.

MinimumValue

Description
Specifies the minimum value of the scale in the selected object.
Access in runtime: Read and write

Syntax
Object.MinimumValue[=DOUBLE | Int32 | SINGLE]

Object
Required. A "ScreenItem" object with the format:
• Bar
• Gauge
• Slider
• WindowSlider*
*: Read access only

DOUBLE | Int32 | SINGLE

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

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

822 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

MinPasswordValue

Description
No access in runtime.

MinuteNeedleHeight

Description
Specifies the length of the minute hand.
Access in runtime Read and write

Syntax
Object.MinuteNeedleHeight[=Int32]

Object
Required. An object of the type "ScreenItem" with the following format:
• 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 287)

MinuteNeedleWidth

Description
Specifies the width of the minute hand.
Access in runtime Read and write

Syntax
Object.MinuteNeedleWidth[=Int32]

Object
Required. An object of the type ""ScreenItem" with the following format:
• Clock

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 823
VB scripting
1.5 VBS object model

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 287)

Mode

Description
Specifies the mode for the behavior of a text object in runtime.
Access in runtime
• RT Advanced: No access
• RT Professional: Read and write

Syntax
Object.Mode[=Type]

Object
Required. An object of the type "ScreenItem" with the format:
• Button
• IOField
• RoundButton*
• SymbolicIOField*
*: Read access only

You have no access in runtime with the following format:

• DateTimeField
• GraphicIOField
• Switch

WinCC Engineering V18 – Programming reference

824 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Type
Optional. A value or a constant that specifies the mode for the behavior of a text object in
runtime.

Value VB constant Description

0 hmiIOFieldOutput Output field
1 hmiIOFieldInput Input field
2 hmiIOFieldInOutput Input and output field

MonitorNumber

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"
Access in runtime: Read and write

Syntax
Object.MonitorNumber[=Int32]

Object
Required. A "ScreenItem" object with the following characteristics:
• Screenwindow

Int32
Optional. A value or a constant that specifies the number of the displayed monitor.

See also
ScreenWindow (Page 404)

Moveable

Description
Specifies whether the object can be moved in runtime.
Access in runtime Read and write

Syntax
Object.Moveable[=BOOLEAN]

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 825
VB scripting
1.5 VBS object model

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• FunctionTrendControl
• OnlineTableControl
• OnlineTrendControl
• TrendRulerControl
• UserArchiveControl

BOOLEAN
Optional.
TRUE if the window can be moved in runtime.
FALSE if the window is fixed in runtime.

See also
AlarmControl (Page 237)
UserArchiveControl (Page 466)
TrendRulerControl (Page 441)
FunctionTrendControl (Page 309)
OnlineTableControl (Page 347)
OnlineTrendControl (Page 359)

MsgFilterSQL

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".
Access in runtime: Read and write

Syntax
Object.MsgFilterSQL[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl

WinCC Engineering V18 – Programming reference

826 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

STRING
Optional. A value or constant that specifies the SQL statements for user-defined selection of
messages.

See also
AlarmControl (Page 237)

Name

Description
Returns the object name as STRING. The returned value is dependent upon the used object.
Access in runtime: Read and write

Syntax
Object.Name[=STRING]

Object
Required. An object of the type "ScreenItem" with the format:
• Clock
• DiscSpaceView *
• Gauge
• Slider
* Read access only
You have no access in runtime with the following format:
• AlarmControl
• AlarmView
• ApplicationWindow
• BatteryView
• Bar
• Button
• ChannelDiagnose
• CheckBox
• Circle
• CircleSegment
• CircularArc
• ComboBox

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 827
VB scripting
1.5 VBS object model

• Connector
• DateTimeField
• Ellipse
• EllipseSegment
• EllipticalArc
• FunctionTrendControl
• GraphicIOField
• GraphicView
• HTMLBrowser
• IOField
• Line
• ListBox
• MediaPlayer
• MultiLineEdit
• OnlineTableControl
• OnlineTrendControl
• OptionGroup
• PLCCodeViewer
• ProDiagOverview
• Polygon
• Polyline
• ProtectedAreaNameView
• RangeLabelView
• RangeQualityView
• RecipeView
• Rectangle
• RoundButton
• S7GraphOverview
• ScreenWindow
• SmartClientView
• StatusForce
• Switch
• SymbolLibrary
• SymbolicIOField
• SysDiagControl

WinCC Engineering V18 – Programming reference

828 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

• TextField
• TrendRulerControl
• TrendView
• TubeArcObject
• TubeDoubleTeeObject
• TubeTeeObject
• Tubepolyline
• UserArchiveControl
• 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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 829
VB scripting
1.5 VBS object model

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

Description
No access in runtime.

NavigateTo

Description
Specifies the module to be jumped to.
Access in runtime: Read and write

Syntax
Object.NavigateTo[=String]

Object
Required. An object of the type "ScreenItem" with the following format:
• PLCCodeViewer
• SysDiagControl *
* RT Advanced No access, RT Professional read access only

String
Optional. A value or a constant that specifies the module.

NavigationButtons

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

830 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

NavigationPath_Font

Description
No access in runtime.

NavigationPath_RootText

Description
No access in runtime.

NavigationPath_TextColor

Description
No access in runtime.

NavigationpathDiagbufferDetailText

Description
No access in runtime.

NavigationpathDiagbufferText

Description
No access in runtime.

NeedleBorderColor

Description
Specifies the line color of the pointer.
Access in runtime Read and write

Syntax
Object.NeedleBorderColor[=Color]

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 831
VB scripting
1.5 VBS object model

Object
Required. An object of the type "ScreenItem" with the following format:
• Clock

Color
Optional. A value or a constant that specifies the line color of the pointer.

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
Clock (Page 287)

NeedleColor

Description
Specifies the pointer color.
Also specify with ""NeedleFillStyle" that the pointer color is to be displayed.
Access in runtime Read and write

Syntax
Object.NeedleColor[=Color]

Object
Required. An object of the type "ScreenItem" with the following format:
• Clock

Color
Optional. A value or a constant that specifies the pointer color.

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)

WinCC Engineering V18 – Programming reference

832 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

You can also use the VBS color constants such as vbRed and vbGreen.

See also
Clock (Page 287)

NeedleFillStyle

Description
Specifies whether the pointers are displayed as filled or transparent.
Access in runtime Read and write

Syntax
Object.NeedleFillStyle[=THmiFillStyle]

Object
Required. An object of the type "ScreenItem" with the following format:
• Clock

THmiFillStyle
Optional. A value or a constant that specifies whether the pointers are filled or transparent.

Value VB constant Explanation

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 mar‐
gin in the foreground color.

See also
Clock (Page 287)

NeedleHeight

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 833
VB scripting
1.5 VBS object model

NoHitTest

Description
No access in runtime.

NormalColor

Description
Specifies the color of the utilized memory in the memory space view when the memory space
utilization is in the non-critical range.
Access in runtime: Read

Syntax
Object.NormalColor[=Color]

Object
Required. A "ScreenItem" object with the following characteristics:
• 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)
You can also use the VBS color constants such as vbRed and vbGreen.

See also
DiskSpaceView (Page 298)

NormalRangeColor

Description
Specifies the color of the normal range on the scale of the "Gauge" object.

WinCC Engineering V18 – Programming reference

834 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

The "NormalRangeVisible" property must have the value TRUE for the normal range to be
displayed.
Access in runtime Read and write

Syntax
Object.NormalRangeColor[=Color]

Object
Required. A "ScreenItem" object with the following format:
• Gauge

Color
Optional. A value or a constant that specifies the color of the normal range.

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
Gauge (Page 320)

NormalRangeVisible

Description
Specifies whether the normal range in the scale of the "Gauge" object is displayed.
Access in runtime: Read and write

Syntax
Object.NormalRangeVisible[=BOOLEAN]

Object
Required. A "ScreenItem" object with the following format:
• Gauge

BOOLEAN
Optional TRUE, if the normal range will be displayed in the scale.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 835
VB scripting
1.5 VBS object model

Comments
Specify the color of the normal range with the "NormalRangeColor" property.

See also
Gauge (Page 320)

NumberOfButtons

Description
No access in runtime.

NumberOfLines

Description
No access in runtime.

NumberOfVisibleLines

Description
Specifies the number of visible lines in the PLC code display.
Access in runtime: Read and write

Syntax
Object.NumberOfVisibleLines[=Int32]

Object
Required. A "ScreenItem" object with the following characteristics:
• PLCCodeViewer

Int32
Optional. A value or a constant that specifies the number of lines in the PLC code display.

See also
PLCCodeViewer (Page 376)

WinCC Engineering V18 – Programming reference

836 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

NumberStyle

Description
No access in runtime.

1.5.5.10 Properties O-P

Object

Description
No access in runtime.

ObjectSizeDeclutteringEnable

Description
Specifies whether only the objects within a set size range are displayed.
Access during runtime: Read

Syntax
Object.ObjectSizeDeclutteringEnable

Object
Necessary. A "Screen" object.

Example
The example outputs the Decluttering properties of the screen "NewPDL1" as Trace.

'VBS157
Dim objScreen
Set objScreen = HMIRuntime.Screens("NewPDL1")
HMIRuntime.Trace "Min: " & objScreen.ObjectSizeDeclutteringMin & vbNewLine
HMIRuntime.Trace "Max: " & objScreen.ObjectSizeDeclutteringMax & vbNewLine
HMIRuntime.Trace "Enable: " & objScreen.LayerDeclutteringEnable & vbNewLine

See also
Screen (Page 216)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 837
VB scripting
1.5 VBS object model

ObjectSizeDeclutteringMax

Description
Returns the upper size range for the display suppression of objects of the specified screen as
LONG.
Access during runtime: Read

Syntax
Object.ObjectSizeDeclutteringMax

Object
Necessary. A "Screen" object.

Example
The example outputs the Decluttering properties of the screen "NewPDL1" as Trace.

'VBS157
Dim objScreen
Set objScreen = HMIRuntime.Screens("NewPDL1")
HMIRuntime.Trace "Min: " & objScreen.ObjectSizeDeclutteringMin & vbNewLine
HMIRuntime.Trace "Max: " & objScreen.ObjectSizeDeclutteringMax & vbNewLine
HMIRuntime.Trace "Enable: " & objScreen.LayerDeclutteringEnable & vbNewLine

See also
Screen (Page 216)

ObjectSizeDeclutteringMin

Description
Returns the lower size range for the display suppression of objects of the specified screen as
LONG.
Access during runtime: Read

Syntax
Object.ObjectSizeDeclutteringMin

Object
Necessary. A "Screen" object.

WinCC Engineering V18 – Programming reference

838 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Example
The example outputs the Decluttering properties of the screen "NewPDL1" as Trace.

'VBS157
Dim objScreen
Set objScreen = HMIRuntime.Screens("NewPDL1")
HMIRuntime.Trace "Min: " & objScreen.ObjectSizeDeclutteringMin & vbNewLine
HMIRuntime.Trace "Max: " & objScreen.ObjectSizeDeclutteringMax & vbNewLine
HMIRuntime.Trace "Enable: " & objScreen.LayerDeclutteringEnable & vbNewLine

See also
Screen (Page 216)

OcxGuid

Description
No access in runtime.

OCXState

Description
No access in runtime.

OcxStateForEs2Rt

Description
No access in runtime.

Online

Description
Specifies start and stop of the updating.
Access in runtime: Read and write

Syntax
Object.Online[=BOOLEAN]

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 839
VB scripting
1.5 VBS object model

Object
Required. An object of the type "ScreenItem" with the format:
• FunctionTrendControl
• OnlineTableControl
• OnlineTrendControl

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
OnlineTrendControl (Page 359)
FunctionTrendControl (Page 309)
OnlineTableControl (Page 347)

OnValue

Description
No access in runtime.

OperationSteps

Description
Specifies by how many steps the slider of the scrollbar is moved with one mouseclick.
Access in runtime: Read and write

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.

WinCC Engineering V18 – Programming reference

840 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

See also
WindowSlider (Page 482)

OperatorAlarms

Description
No access in runtime.

OperatorMessageId

Description
Specifies the assignment of ID number and trigger event in the alarm view.
Access in runtime: Read and write

Syntax
Object.OperatorMessageId[=Int32]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl

Int32
Optional. A value or constant that specifies the assignment of ID number and trigger event in
the alarm view.

Value Description Explanation

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
AlarmControl (Page 237)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 841
VB scripting
1.5 VBS object model

OperatorMessageIndex

Description
References an operator message event. You can assign the values of other properties to a
specific operator message by using the property.
Access in runtime: Read and write

Syntax
Object.OperatorMessageIndex[=Int32]

Object
Required. An object of the type "ScreenItem" with the following format:
• 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
AlarmControl (Page 237)

OperatorMessageName

Description
Specifies the name which is referenced with the "OperatorMessageIndex" event in message
events for operator messages.
Access in runtime: Read and write

Syntax
Object.OperatorMessageName[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl

WinCC Engineering V18 – Programming reference

842 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

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
AlarmControl (Page 237)

OperatorMessageNumber

Description
Specifies a message number for the operator message of the selected message event if you
do not use the operator message of WinCC.
Access in runtime: Read and write

Syntax
Object.OperatorMessageNumber[=Int32]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl

Int32
Optional. Specifies a message number for the operator message of the selected message
event.

See also
AlarmControl (Page 237)

OperatorMessageSelected

Description
Activates the message events in the list that trigger operator messages.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 843
VB scripting
1.5 VBS object model

Access in runtime: Read and write

Syntax
Object.OperatorMessageSelected[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl

BOOLEAN
Optional.
TRUE if the alarm events in the list that trigger operator input alarms are activated.

See also
AlarmControl (Page 237)

OperatorMessageSource1

Description
Specifies a alarm text block of the operated message to be added to "Process value block 1" of the
operator message configured here.
Access in runtime: Read and write

Syntax
Object.OperatorMessageSource1[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• 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".

WinCC Engineering V18 – Programming reference

844 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

See also
AlarmControl (Page 237)

OperatorMessageSource2

Description
Specifies a alarm text block of the operated message to be added to "Process value block 2" of the
operator message configured here.
Access in runtime: Read and write

Syntax
Object.OperatorMessageSource2[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl

STRING
Optional. Specifies a alarm text block of the operated message to be added to "Process value
block 2" 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 "2" at process value as the alarm text block of the
operated alarm "User text block 1".

See also
AlarmControl (Page 237)

OperatorMessageSource3

Description
Specifies a alarm text block of the operated message to be added to "Process value block 3" of the
operator message configured here.
Access in runtime: Read and write

Syntax
Object.OperatorMessageSource3[=STRING]

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 845
VB scripting
1.5 VBS object model

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl

STRING
Optional. Specifies a alarm text block of the operated message to be added to "Process value
block 3" 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 "3" at process value as the alarm text block of the
operated alarm "User text block 1".

See also
AlarmControl (Page 237)

OperatorMessageSource4

Description
Specifies a alarm text block of the operated message to be added to "Process value block 4" of the
operator message configured here.
Access in runtime: Read and write

Syntax
Object.OperatorMessageSource4[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl

STRING
Optional. Specifies a alarm text block of the operated message to be added to "Process value
block 4" 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 "4" at process value as the alarm text block of the
operated alarm "User text block 1".

WinCC Engineering V18 – Programming reference

846 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

See also
AlarmControl (Page 237)

OperatorMessageSource5

Description
Specifies a alarm text block of the operated message to be added to "Process value block 5" of the
operator message configured here.
Access in runtime: Read and write

Syntax
Object.OperatorMessageSource5[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl

STRING
Optional. Specifies a alarm text block of the operated message to be added to "Process value
block 5" 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 "5" at process value as the alarm text block of the
operated alarm "User text block 1".

See also
AlarmControl (Page 237)

OperatorMessageSource6

Description
Specifies a alarm text block of the operated message to be added to "Process value block 6" of the
operator message configured here.
Access in runtime: Read and write

Syntax
Object.OperatorMessageSource6[=STRING]

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 847
VB scripting
1.5 VBS object model

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl

STRING
Optional. Specifies a alarm text block of the operated message to be added to "Process value
block 6" 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 "6" at process value as the alarm text block of the
operated alarm "User text block 1".

See also
AlarmControl (Page 237)

OperatorMessageSource7

Description
Specifies a alarm text block of the operated message to be added to "Process value block 7" of the
operator message configured here.
Access in runtime: Read and write

Syntax
Object.OperatorMessageSource7[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl

STRING
Optional. Specifies a alarm text block of the operated message to be added to "Process value
block 7" 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 "7" at process value as the alarm text block of the
operated alarm "User text block 1".

WinCC Engineering V18 – Programming reference

848 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

See also
AlarmControl (Page 237)

OperatorMessageSource8

Description
Specifies a alarm text block of the operated message to be added to "Process value block 8" of the
operator message configured here.
Access in runtime: Read and write

Syntax
Object.OperatorMessageSource8[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl

STRING
Optional. Specifies a alarm text block of the operated message to be added to "Process value
block 8" 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 "8" at process value as the alarm text block of the
operated alarm "User text block 1".

See also
AlarmControl (Page 237)

OperatorMessageSource9

Description
Specifies a alarm text block of the operated message to be added to "Process value block 9" of the
operator message configured here.
Access in runtime: Read and write

Syntax
Object.OperatorMessageSource9[=STRING]

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 849
VB scripting
1.5 VBS object model

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl

STRING
Optional. Specifies a alarm text block of the operated message to be added to "Process value
block 9" 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 "9" at process value as the alarm text block of the
operated alarm "User text block 1".

See also
AlarmControl (Page 237)

OperatorMessageSource10

Description
Specifies a alarm text block of the operated message to be added to "Process value block 10" of
the operator message configured here.
Access in runtime: Read and write

Syntax
Object.OperatorMessageSource10[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl

STRING
Optional. Specifies a alarm text block of the operated message to be added to "Process value
block 10" 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 "10" at process value as the alarm text block of the
operated alarm "User text block 1".

WinCC Engineering V18 – Programming reference

850 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

See also
AlarmControl (Page 237)

OperatorMessageSourceType1

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.
Access in runtime Read and write

Syntax
Object.OperatorMessageSourceType1[=TransferAs]

Object
Required. An object of the type "ScreenItem" with the following format:
• 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:

Value Designation Description

0 Text The alarm text block is shown as text.
1 Value The alarm text block is shown as a value.

See also
AlarmControl (Page 237)

OperatorMessageSourceType2

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.
Access in runtime Read and write

Syntax
Object.OperatorMessageSourceType2[=TransferAs]

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 851
VB scripting
1.5 VBS object model

Object
Required. An object of the type "ScreenItem" with the following format:
• 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:

Value Designation Description

0 Text The alarm text block is shown as text.
1 Value The alarm text block is shown as a value.

See also
AlarmControl (Page 237)

OperatorMessageSourceType3

Description
Specifies whether the content of the alarm text block in the operator input alarm is to be
transferred as text or as value.
Access in runtime: Read and write

Syntax
Object.OperatorMessageSourceType3[=TransferAs]

Object
Required. An object of the type "ScreenItem" with the format:
• 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:

Value Designation Description

0 Text The alarm text block is shown as text.
1 Value The alarm text block is shown as a value.

WinCC Engineering V18 – Programming reference

852 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

OperatorMessageSourceType4

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.
Access in runtime Read and write

Syntax
Object.OperatorMessageSourceType4[=TransferAs]

Object
Required. An object of the type "ScreenItem" with the following format:
• 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:

Value Designation Description

0 Text The alarm text block is shown as text.
1 Value The alarm text block is shown as a value.

See also
AlarmControl (Page 237)

OperatorMessageSourceType5

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.
Access in runtime Read and write

Syntax
Object.OperatorMessageSourceType5[=TransferAs]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 853
VB scripting
1.5 VBS object model

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:

Value Designation Description

0 Text The alarm text block is shown as text.
1 Value The alarm text block is shown as a value.

See also
AlarmControl (Page 237)

OperatorMessageSourceType6

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.
Access in runtime Read and write

Syntax
Object.OperatorMessageSourceType6[=TransferAs]

Object
Required. An object of the type "ScreenItem" with the following format:
• 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:

Value Designation Description

0 Text The alarm text block is shown as text.
1 Value The alarm text block is shown as a value.

See also
AlarmControl (Page 237)

WinCC Engineering V18 – Programming reference

854 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

OperatorMessageSourceType7

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.
Access in runtime Read and write

Syntax
Object.OperatorMessageSourceType7[=TransferAs]

Object
Required. An object of the type "ScreenItem" with the following format:
• 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:

Value Designation Description

0 Text The alarm text block is shown as text.
1 Value The alarm text block is shown as a value.

See also
AlarmControl (Page 237)

OperatorMessageSourceType8

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.
Access in runtime Read and write

Syntax
Object.OperatorMessageSourceType8[=TransferAs]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 855
VB scripting
1.5 VBS object model

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:

Value Designation Description

0 Text The alarm text block is shown as text.
1 Value The alarm text block is shown as a value.

See also
AlarmControl (Page 237)

OperatorMessageSourceType9

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.
Access in runtime Read and write

Syntax
Object.OperatorMessageSourceType9[=TransferAs]

Object
Required. An object of the type "ScreenItem" with the following format:
• 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:

Value Designation Description

0 Text The alarm text block is shown as text.
1 Value The alarm text block is shown as a value.

See also
AlarmControl (Page 237)

WinCC Engineering V18 – Programming reference

856 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

OperatorMessageSourceType10

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.
Access in runtime Read and write

Syntax
Object.OperatorMessageSourceType10[=TransferAs]

Object
Required. An object of the type "ScreenItem" with the following format:
• 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:

Value Designation Description

0 Text The alarm text block is shown as text.
1 Value The alarm text block is shown as a value.

See also
AlarmControl (Page 237)

OutputAddressText

Description
No access in runtime.

PaddingBottom

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 857
VB scripting
1.5 VBS object model

PaddingLeft

Description
No access in runtime.

PaddingRight

Description
No access in runtime.

PaddingTop

Description
No access in runtime.

PageMode

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.
Access in runtime: Read and write

Syntax
Object.PageMode[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• 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
AlarmControl (Page 237)

WinCC Engineering V18 – Programming reference

858 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

PageModeMessageNumber

Description
Defines the number of messages shown per page when paging the long-term archive list.
Access in runtime: Read and write

Syntax
Object.PageModeMessageNumber[=Int32]

Object
Required. A "ScreenItem" object with the following format:
• AlarmControl

Int32
Optional A value or constant that specifies the number of messages per page.

See also
AlarmControl (Page 237)

Password

Description
Determines the password for the loading of the remote monitor.
Access in runtime: Read and write

Syntax
Object.Password[=STRING]

Object
Required. A "ScreenItem" object with the following format:
• SmartClientView

STRING
Optional A value or constant that contains the password for establishing remote monitoring.

See also
SmartClientView (Page 412)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 859
VB scripting
1.5 VBS object model

PasswordsMustBeEncrypted

Description
No access in runtime.

Path

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.
Access during runtime: Read

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 215)

PathHeaderBackColor

Description
No access in runtime.

PathHeaderFont

Description
Specifies the header font.

WinCC Engineering V18 – Programming reference

860 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Access in runtime Read and write

Syntax
Object.PathHeaderFont[=Font]

Object
Required. An object of the type "ScreenItem" with the following format:
• PLCCodeViewer
• S7GraphOverview

Font
Optional. A value or a constant that specifies the font of the header.

See also
PLCCodeViewer (Page 376)
S7GraphOverview (Page 402)

PathHeaderTextColor

Description
Specifies the font color in the header of the GRAPH overview.
Access in runtime Read and write

Syntax
Object.PathHeaderTextColor[=Color]

Object
Required. An object of the type "ScreenItem" with the following format:
• S7GraphOverview

Color
Optional. A value or a constant that specifies the font color in the header of the S7-GRAPH
overview.

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)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 861
VB scripting
1.5 VBS object model

You can also use the VBS color constants such as vbRed and vbGreen.

See also
S7GraphOverview (Page 402)

PercentageAxis

Description
Specifies that an additional axis with percentage scaling is shown in the trend view.
Access in runtime: Read and write

Syntax
Object.PercentageAxis[=BOOLEAN]

Object
Required. A "ScreenItem" object with the following characteristics:
• OnlineTrendControl

BOOLEAN
Optional.
TRUE, if an axis with percentage scaling is shown.
FALSE, if only value and time axes are shown.

See also
OnlineTrendControl (Page 359)

PercentageAxisAlignment

Description
Specifies the alignment of the percentage axis.
Access in runtime: Read and write

Syntax
Object.PercentageAxisAlignment[=AxisAlignment]

WinCC Engineering V18 – Programming reference

862 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Object
Required. A "ScreenItem" object with the following characteristics:
• OnlineTrendControl

AxisAlignment
Optional. Value or constant that specifies the alignment of the percentage axis.

Value Designation Description

0 Left The axis with percentage scaling is left-aligned.
1 Right The axis with percentage scaling is right-aligned

See also
OnlineTrendControl (Page 359)

PercentageAxisColor

Description
Specifies the font color and line color of the percentage axis.
Access in runtime: Read and write

Syntax
Object.PercentageAxisColor[=Color]

Object
Required. A "ScreenItem" object with the following characteristics:
• OnlineTrendControl

Color
Optional. A value or a constant that specifies the color of the percentage axis.

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)
You can also use the VBS color constants such as vbRed and vbGreen.

See also
OnlineTrendControl (Page 359)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 863
VB scripting
1.5 VBS object model

Picture

Description
Specifies the screen from the WinCC project graphics to be displayed in the object in runtime.
Access in runtime: Read and write

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

Description
Specifies the display type for the background screen in the process image.
Access in runtime: Read and write

Syntax
Object.PictureAlignment[=PictureAlignment]

Object
Required. A "ScreenItem" object with the following format:
• 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.

WinCC Engineering V18 – Programming reference

864 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

PictureAreaBottomMargin

Description
No access in runtime.

PictureAreaLeftMargin

Description
No access in runtime.

PictureAreaRightMargin

Description
No access in runtime.

PictureAreaTopMargin

Description
No access in runtime.

PictureAutoSizing

Description
No access in runtime.

PictureDeactivated

Description
Specifies the graphic from the WinCC project graphics that is displayed in the "Disabled" status.
Access in runtime Read

Syntax
Object.PictureDeactivated[=HmiObjectHandle]

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 865
VB scripting
1.5 VBS object model

Object
Required. An object of the type ""ScreenItem" with the following format:
• Roundbutton

HmiObjectHandle
Optional. A value or a constant that specifies the picture that will be displayed in the
"Deactivated" status.

See also
RoundButton (Page 398)

PictureList

Description
No access in runtime.

PictureOff

Description
Specifies the picture that is displayed in the "Off" status.
Access in runtime:
• RT Advanced: No access
• RT Professional: Read and write

Syntax
Object.PictureOff[=HmiObjectHandle]

Object
Required. A "ScreenItem" object with the format:
• Button
• GraphicIOField
• RoundButton*
*: Read access only
You have no access in runtime with the following format:
• Switch

WinCC Engineering V18 – Programming reference

866 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

HmiObjectHandle
Optional A value or a constant that specifies the picture that will be displayed in the "Off"
status.

Comments
The picture (*.BMP or *.DIB) must be in the "GraCS" folder of the current project so that you can
integrate it.

PictureOn

Description
Specifies the screen that will be displayed in the "on" state.
Access in runtime:
• RT Advanced: No access
• RT Professional: Read and write

Syntax
Object.PictureOn[=HmiObjectHandle]

Object
Required. A "ScreenItem" object with the format:
• Button
• GraphicIOField
• RoundButton*
*: Read access only
You have no access in runtime with the following format:
• 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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 867
VB scripting
1.5 VBS object model

PictureRotation

Description
No access in runtime.

PictureSizeMode

Description
Specifies the size adaptation between Media Player and the contents to be displayed.
Access in runtime: Read and write

Syntax
Object.PictureSizeMode[=PictureSizeMode]

Object
Required. A "ScreenItem" object with the following characteristics:
• MediaPlayer

PictureSizeMode
Optional. Value or constant that specifies the size adaptation between Media Player and the
contents to be displayed.

Value Designation Description

0 Fit object size to content Specifies that the size of the Media Player is adapted to the size of
the contents to be displayed.
1 Fit content to object size Specifies that the contents to be displayed are adapted to the size of
the Media Player.

See also
MediaPlayer (Page 342)

PlayCount

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

868 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

PlayEndless

Description
Specifies that the media file is repeated in an endless loop.
Access in runtime: Read and write

Syntax
Object.PlayEndless[=BOOLEAN]

Object
Required. A "ScreenItem" object with the following characteristics:
• 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
MediaPlayer (Page 342)

PLCFilter

Description
No access in runtime.

PlcUDTFilter

Description
No access in runtime.

PointerColor

Description
Specifies the pointer color of the "Gauge" object.
Access in runtime Read and write

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 869
VB scripting
1.5 VBS object model

Syntax
Object.PointerColor[=Color]

Object
Required. An object of the type ""ScreenItem" with the following format:
• Gauge

Color
Optional. A value or a constant that specifies the pointer color.

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
Gauge (Page 320)

Points

Description
No access in runtime.

PointsCount

Description
Specifies the number of corner points of the polyline or of the polygon.
Access in runtime:
• RT Advanced: No access
• RT Professional: Read and write

Syntax
Object.PointsCount[=Int32]

WinCC Engineering V18 – Programming reference

870 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Object
Required. An object of the type "ScreenItem" with the format:
• Polygon
• Polyline
• Tubepolyline
You have no access in runtime with the following format:
• Connector
• Line

Int32
Optional. A value or a constant that specifies the number of corner points of the polyline.

PopupMenuEnabled

Description
No access in runtime.

PositionFont

Description
Sets the font for the label of the slider.
Access in runtime: Read and write

Syntax
Object.PositionFont[=Font]

Object
Required. An object of the type "ScreenItem" with the format:
• Slider

Font
Optional. Value or constant that specifies the font.

Precision

Description
Specifies the number of decimal places (0 to 20).

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 871
VB scripting
1.5 VBS object model

Access in runtime: Read and write

Syntax
Object.Precision[=Int32]

Object
Required. A "ScreenItem" object with the following format:
• Bar

Int32
Optional A value or a constant that specifies the number of decimal places (0 to 20).

See also
Bar (Page 259)

PreferredUseOnAck

Description
No access in runtime.

Pressed

Description
Specifies whether the selected object is displayed in a pressed state.
Access in runtime: Read and write

Syntax
Object.Pressed[=BOOLEAN]

Object
Required. A "ScreenItem" object with the following format:
• Button
• RoundButton*
*: Read access only

BOOLEAN
Optional. TRUE, if the selected object is displayed in a pressed state.

WinCC Engineering V18 – Programming reference

872 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

PrintJob

Description
Specifies a print job that is created in the "Reports" editor.
Access in runtime: Read and write

Syntax
Object.PrintJob[=HmiObjectHandle]

Object
Required. A "ScreenItem" object with the following characteristics:
• AlarmControl
• FunctionTrendControl
• OnlineTableControl
• OnlineTrendControl
• TrendRulerControl
• UserArchiveControl

HmiObjectHandle
Optional. A value or a constant that specifies the layout of the printout.

See also
AlarmControl (Page 237)
FunctionTrendControl (Page 309)
OnlineTableControl (Page 347)
OnlineTrendControl (Page 359)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

ProcessTag

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 873
VB scripting
1.5 VBS object model

ProcessValue

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:
• RT Advanced: No access
• RT Professional: Read and write

Syntax
Object.ProcessValue[=DOUBLE | Int32 | Object | SINGLE]

Object
Required. An object of the type "ScreenItem" with the format:
• Bar
• CheckBox
• Gauge
• GraphicIOField
• IOField
• OptionGroup
• Slider
• SymbolicIOField*
• WindowsSlider*
*: Read access only
You have no access in runtime with the following format:
• Button
• DateTimeField
• Switch
• SymbolLibrary

DOUBLE | Int32 | SINGLE

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

WinCC Engineering V18 – Programming reference

874 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

• 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

ProgID

Description
In the case of non-WinCC controls, the version-independent ProgID is returned as the type.

ProhibitDataRecordTagInOnlySimpleView

Description
No access in runtime.

1.5.5.11 Properties Q-R

QualityCode

Description
Returns the quality of a tag value after reading the tag as SHORT. After a tag has been written,
the value is invalid.
Access during runtime: Read

Syntax
Object.QualityCode

Object
Necessary. An object of the "HMIRuntime" type.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 875
VB scripting
1.5 VBS object model

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
Set objTag = HMIRuntime.Tags("Tag1")
objTag.Read
lngLastErr = objTag.LastError
If 0 = lngLastErr Then
MsgBox objTag.QualityCode
End If

See also
Tag (Page 229)

Radius

Description
Specifies the radius.
Access in runtime: Read and write

Syntax
Object.Radius[=Int32]

Object
Required. An object of the type "ScreenItem" with the format:
• Circle
• CircleSegment
• CircularArc
• RoundButton

Int32
Optional. A value or constant which determines the radius in pixels.

RadiusHeight

Description
Specifies the secondary axis.

WinCC Engineering V18 – Programming reference

876 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Access in runtime: Read and write

Syntax
Object.RadiusHeight[=Int32]

Object
Required. An object of the type "ScreenItem" with the format:
• Ellipse
• EllipseSegment
• EllipticalArc
• TubeArcObject
You have no access in runtime with the following format:
• Circle

Int32
Optional. A value or constant which determines the secondary axis in pixels.

See also
Ellipse (Page 300)
EllipseSegment (Page 303)
EllipticalArc (Page 306)
TubeArcObject (Page 457)
Circle (Page 279)

RadiusWidth

Description
Specifies the main axis.
Access in runtime: Read and write

Syntax
Object.RadiusWidth[=Int32]

Object
Required. An object of the type "ScreenItem" with the format:
• Ellipse
• EllipseSegment

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 877
VB scripting
1.5 VBS object model

• EllipticalArc
• TubeArcObject
You have no access in runtime with the following format:
• Circle

Int32
Optional. A value or constant which determines the main axis in pixels.

See also
Ellipse (Page 300)
EllipseSegment (Page 303)
EllipticalArc (Page 306)
TubeArcObject (Page 457)
Circle (Page 279)

Recipe

Description
No access in runtime.

RecipeName

Description
Returns the name of the recipe that is currently being displayed in the "Recipe view".
Access in runtime: Read and write

Syntax
Object.RecipeName[=STRING]

Object
Required. A "ScreenItem" object with the following format:
• RecipeView

STRING
Optional A value or a constant that returns the name of the recipe.

WinCC Engineering V18 – Programming reference

878 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

See also
RecipeView (Page 389)

RecipeNameCaption

Description
No access in runtime.

RecipeNrCaption

Description
No access in runtime.

RecipeNrColFirst

Description
No access in runtime.

RecipeNumber

Description
Returns the number of the recipe that is currently being displayed in the "Recipe view".
Access in runtime: Read and write

Syntax
Object.RecipeNumber[=Int32]

Object
Required. A "ScreenItem" object with the following format:
• RecipeView

Int32
Optional A value or a constant that returns the number of the recipe.

See also
RecipeView (Page 389)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 879
VB scripting
1.5 VBS object model

RecordName

Description
Returns the name of the recipe data record that is currently being displayed in the "Recipe view".
Access in runtime: Read and write

Syntax
Object.RecordName[=STRING]

Object
Required. A "ScreenItem" object with the following format:
• RecipeView

STRING
Optional A value or a constant that returns the name of the recipe data record.

See also
RecipeView (Page 389)

RecordNrColFirst

Description
No access in runtime.

RecordNumber

Description
Returns the number of the recipe data record that is currently being displayed in the "Recipe
view".
Access in runtime: Read

Syntax
Object.RecordNumber[=Int32]

Object
Required. A "ScreenItem" object with the following format:
• RecipeView

WinCC Engineering V18 – Programming reference

880 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Int32
Optional A value or a constant that returns the number of the recipe data record.

See also
RecipeView (Page 389)

RelativeFillLevel

Description
Specifies the fill percentage for the object.
Access in runtime: Read and write

Syntax
Object.RelativeFillLevel[=Int32]

Object
Required. An object of the type "ScreenItem" with the format:
• Button
• CheckBox
• Circle
• Ellipse
• EllipseSegment
• GraphicView
• OptionGroup
• Polygon
• Rectangle
• RoundButton*
• TextField
• WindowsSlider*
*: Read access only
You have no access in runtime with the following format:
• CircleSegment

Int32
Optional. A value or a constant that specifies the fill percentage of the object.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 881
VB scripting
1.5 VBS object model

RenameButtonVisible

Description
No access in runtime.

ReSizeable

Description
No access in runtime.

RightMargin

Description
No access in runtime.

Rotation

Description
Specifies the angle of rotation in degrees. The angle of rotation is measured counterclockwise.
Access in runtime: Read and write

Syntax
Object.Rotation[=SymbolLibraryRotation]

Object
Required. An object of the type "ScreenItem" with the format:
• SymbolLibrary

SymbolLibraryRotation
Optional. A value or a constant that specifies the angle of rotation in degrees.

Value VB constant Explanation

0 hmiSymbolLibraryRotationNone The object rotates by 0 degrees.
90 hmiSymbolLibraryRotation90Degree The object rotates by 90 degrees.
180 hmiSymbolLibraryRotation180Degree The object rotates by 180 degrees.
270 hmiSymbolLibraryRotation270Degree The object rotates by 270 degrees.

WinCC Engineering V18 – Programming reference

882 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

RotationAngle

Description
Specifies the angle of rotation in degrees.
Access in runtime: Read and write

Syntax
Object.RotationAngle[=Int32]

Object
Required. An object of the type "ScreenItem" with the format:
• 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)
TextField (Page 438)
TubeTeeObject (Page 464)

RotationCenterLeft

Description
Specifies the X coordinate of the pivot point for the object in runtime.
Access in runtime: Read and write

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 883
VB scripting
1.5 VBS object model

Syntax
Object.RotationCenterLeft[=Int32]

Object
Required. An object of the type "ScreenItem" with the format:
• Line
• Polygon
• Polyline
• TextField*
*: Read access only

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

Description
Specifies the Y coordinate of the pivot point for the object in runtime.
Access in runtime: Read and write

Syntax
Object.RotationCenterTop[=Int32]

Object
Required. An object of the type "ScreenItem" with the format:
• 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.

WinCC Engineering V18 – Programming reference

884 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

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

Description
Specifies the corner radius. Enter the value as a percentage of half the height of the object.
Access in runtime: Read and write

Syntax
Object.RoundCornerHeight[=Int32]

Object
Required. An object of the type "ScreenItem" with the format:
• Rectangle

Int32
Optional A value or a constant that specifies the corner radius.

RoundCornerWidth

Description
Specifies the corner radius. Enter the value as a percentage of half the width of the object.
Access in runtime: Read and write

Syntax
Object.RoundCornerWidth[=Int32]

Object
Required. An object of the type "ScreenItem" with the format:
• Rectangle

Int32
Optional A value or a constant that specifies the corner radius.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 885
VB scripting
1.5 VBS object model

RowScrollbar

Description
Specifies when the vertical scroll bar is displayed.
Access in runtime Read and write

Syntax
Object.RowScrollbar[=ScrollbarVisibility]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• OnlineTableControl
• TrendRulerControl
• UserArchiveControl

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
AlarmControl (Page 237)
OnlineTableControl (Page 347)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

RowTitleAlignment

Description
Specifies the type of row header alignment.
Access in runtime Read and write

Syntax
Object.RowTitleAlignment[=HorizontalAlignment]

WinCC Engineering V18 – Programming reference

886 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• OnlineTableControl
• TrendRulerControl
• UserArchiveControl

HorizontalAlignment
Optional. A value or a constant that specifies the row header alignment.

Value Description Explanation

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.

See also
AlarmControl (Page 237)
OnlineTableControl (Page 347)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

RowTitles

Description
Specifies whether numbered column headers are displayed.
Access in runtime Read and write

Syntax
Object.RowTitles[=BOOLEAN]

Object
Required. A "ScreenItem" object with the following format:
• AlarmControl
• OnlineTableControl
• TrendRulerControl
• UserArchiveControl

BOOLEAN
Optional. TRUE if numbered column headers are displayed.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 887
VB scripting
1.5 VBS object model

See also
AlarmControl (Page 237)
OnlineTableControl (Page 347)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

RTPersistence

Description
Specifies whether online configurations are retained after a screen change.
Also set "RTPersistenceType" to 1 or 2.
Access in runtime:
• RT Advanced: No access
• RT Professional: Read and write

Syntax
Object.RTPersistence[=RTPersistence]

Object
Required. An object of the type "ScreenItem" with the format:
• AlarmControl
• FunctionTrendControl
• OnlineTableControl
• OnlineTrendControl
• TrendRulerControl
• UserArchiveControl
You have no access in runtime with the following format:
• 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.

WinCC Engineering V18 – Programming reference

888 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

RTPersistenceAuthorization

Description
Specifies the authorization required for online configuration in runtime.
Access in runtime:
• RT Advanced: No access
• RT Professional: Read and write

Syntax
Object.RTPersistenceAuthorization[=HmiObjectHandle]

Object
Required. A "ScreenItem" object with the following characteristics:
• AlarmControl
• FunctionTrendControl
• OnlineTableControl
• OnlineTrendControl
• TrendRulerControl
• UserArchiveControl
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
AlarmControl (Page 237)
FunctionTrendControl (Page 309)
OnlineTableControl (Page 347)
OnlineTrendControl (Page 359)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)
SysDiagControl (Page 429)
UserView (Page 478)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 889
VB scripting
1.5 VBS object model

RTPersistenceType

Description
Specifies how online configurations of WinCC are retained.
Access in Runtime:
• RT Advanced: No access
• RT Professional: Read

Syntax
Object.RTPersistenceType

Object
Required. An object of the type "ScreenItem" with the format:
• AlarmControl
• FunctionTrendControl
• OnlineTableControl
• OnlineTrendControl
• TrendRulerControl
• UserArchiveControl
You have no access in runtime with the following format:
• 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

Description
Specifies the color of the scale gradation (help line) of the axis label.
Access in runtime Read and write

WinCC Engineering V18 – Programming reference

890 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Syntax
Object.RulerColor[=Color]

Object
Required. An object of the type "ScreenItem" with the following format:
• TrendView

Color
Optional. A value or a constant that specifies the color of the scale gradation.

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
TrendView (Page 451)

RulerColumns

Description
No access in runtime.

RulerType

Description
Specifies the display mode of the value table.
Access in runtime: Read and write

Syntax
Object.RulerType[=TrendRulerControlType]

Object
Required. A "ScreenItem" object with the following characteristics:
• TrendRulerControl

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 891
VB scripting
1.5 VBS object model

TrendRulerControlType
Optional. A value or a constant that specifies the display mode of the value table.

Value Designation Explanation

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 statistical
evaluation of the trend between two rulers or of the selected values in the table.

See also
TrendRulerControl (Page 441)

1.5.5.12 Properties S

S7Device

Description
No access in runtime.

ScaleColor

Description
Specifies the color of the scale.
Access in runtime: Read and write

Syntax
Object.ScaleColor[=Color]

Object
Required. An object of the type "ScreenItem" with the format:
• Bar
• TrendView

WinCC Engineering V18 – Programming reference

892 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

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.
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.

ScaleDenominator

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
SmartClientView (Page 412)

ScaleDenominator

Description
No access in runtime.

ScaleGradation

Description
Specifies the distance between two large marking lengths of the scale.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 893
VB scripting
1.5 VBS object model

Access in runtime: Read and write

Syntax
Object.ScaleGradation[=DOUBLE]

Object
Required. A "ScreenItem" object with the following format:
• Bar

DOUBLE
Optional A value or a constant that specifies the distance between two large marking lengths
of the scale.

See also
Bar (Page 259)

ScaleLabelColor

Description
Specifies the color of the label for the scale marks of the "Gauge" object.
Access in runtime Read and write

Syntax
Object.ScaleLabelColor[=Color]

Object
Required. An object of the type "ScreenItem" with the following format:
• Gauge

Color
Optional. A value or a constant that specifies the label color of the scale gradation.

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.

WinCC Engineering V18 – Programming reference

894 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

See also
Gauge (Page 320)

ScaleLabelFieldLength

Description
No access in runtime.

ScaleLabelFont

Description
Specifies the font for the scale label.
Access in runtime: Read and write

Syntax
Object.ScaleLabelFont[=Font]

Object
Required. An object of the type "ScreenItem" with the format:
• Gauge

Font
Optional. A value or a constant that specifies the font for scale labeling.

ScaleLabelingDoubleLined

Description
No access in runtime.

ScaleNumerator

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 895
VB scripting
1.5 VBS object model

ScalePosition

Description
Specifies the position of the scale.
Also set "ShowScale" to "TRUE".
Access in runtime:
• RT Advanced: No access
• RT Professional: Read and write

Syntax
Object.ScalePosition[=ScalePosition]

Object
Required. An object of the type "ScreenItem" with the format:
• Bar
You have no access in runtime with the following format:
• Slider

ScalePosition
Optional. A value or a constant that specifies the position of the scale.

Value VB constant Explanation

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

Description
No access in runtime.

ScaleTickColor

Description
Specifies the color of the scale gradation of the "Gauge" object.
Access in runtime: Read and write

WinCC Engineering V18 – Programming reference

896 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Syntax
Object.ScaleTickColor[=Color]

Object
Required. An object of the type "ScreenItem" with the format:
• Gauge

Color
Optional. A value or a constant that specifies the color of the scale gradation.

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.

ScaleTickLabelPosition

Description
Specifies the diameter of the assumed circle on which the label of the scale divisions is located.
Access in runtime: Read and write

Syntax
Object.ScaleTickLabelPosition[=DOUBLE]

Object
Required. A "ScreenItem" object with the following format:
• 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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 897
VB scripting
1.5 VBS object model

See also
Gauge (Page 320)

ScaleTickLength

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.
Access in runtime: Read and write

Syntax
Object.ScaleTickLength[=DOUBLE]

Object
Required. A "ScreenItem" object with the following format:
• 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 320)

ScaleTickPosition

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.
Access in runtime: Read and write

Syntax
Object.ScaleTickPosition[=DOUBLE]

WinCC Engineering V18 – Programming reference

898 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Object
Required. A "ScreenItem" object with the following format:
• 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 320)

Scaling

Description
No access in runtime.

ScalingType

Description
Specifies the type of bar scaling.
Also set "ShowScale" to "TRUE".
Access in runtime Read and write

Syntax
Object.ScalingType[=BarScalingType]

Object
Required. An object of the type "ScreenItem" with the following format:
• Bar

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 899
VB scripting
1.5 VBS object model

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 distance
between the large marks corresponds to the value of "LargeTicks‐
Size".
1 hmiBarScalingLogarithmic Logarithmic The distribution of the large marks on the scale follows a logarith‐
mic function.
The representation of low values is very strongly highlighted.
2 hmiBarScalingNegativeLogar‐ Negative loga‐ The distribution of the large marks on the scale follows a negative
ithmic 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 distance
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.

See also
Bar (Page 259)

ScreenItems

Description
Returns the ScreenItems list.
Access in Runtime: Read

Syntax
Object.ScreenItems

Object
Required A "ScreenItems"." object.

See also
ScreenItem (Page 219)
ScreenItems (list) (Page 221)

WinCC Engineering V18 – Programming reference

900 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

ScreenName

Description
Specifies the screen to be displayed in the screen window in runtime.
Access in runtime: Read and write

Syntax
Object.ScreenName[=HmiObjectHandle]

Object
Required. A "ScreenItem" object with the following format:
• ScreenWindow

HmiObjectHandle
Optional A value or a constant that specifies the screen to be displayed in the screen window
in runtime.

See also
ScreenWindow (Page 404)

Screens

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.
Access in runtime: Read

Syntax
Object.Screens

Object
Required. An object of the type "Screens".

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 901
VB scripting
1.5 VBS object model

See also
Screen object (list) (Page 223)

ScreenScaleMode

Description
Specifies the scaling mode of the displayed screen.
Access in Runtime: Read and write

Syntax
Object.ScreenScaleMode[=ScreenScaleModeType]

Object
Required. An object of the type "ScreenItem" with the format:
• ScreenWindow

ScreenScaleModeType
Optional. A value or a constant that specifies the scaling mode of the displayed screen.

ScrollBarOrientation

Description
No access in runtime.

SecondGradientColor

Description
No access in runtime.

SecondGradientOffset

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

902 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

SecondNeedleHeight

Description
Specifies the length of the second hand.
Access in runtime Read and write

Syntax
Object.SecondNeedleHeight[=Int32]

Object
Required. An object of the type ""ScreenItem" with the following format:
• 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 287)

SecondNeedleWidth

Description
Specifies the width of the second hand.
Access in runtime Read and write

Syntax
Object.SecondNeedleWidth[=Int32]

Object
Required. An object of the type "ScreenItem" with the following format:
• 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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 903
VB scripting
1.5 VBS object model

See also
Clock (Page 287)

SecurityForSimpleViewEnabled

Description
No access in runtime.

SegmentColoring

Description
Specifies the type of color change to be displayed if the limits are exceeded.
Access in runtime Read and write

Syntax
Object.SegmentColoring[=THmiBarColorType]

Object
Required. An object of the type "ScreenItem" with the following format:
• Bar

THmiBarColorType
Optional. A value or a constant that specifies the type of color change. Value range from 0 to
1.

Value VB constant Description

0 hmiBarColorEntire Color change applied to the entire bar.
1 hmiBarColorSegmented Color change applied to segments.

See also
Bar (Page 259)

SelectArchiveName

Description
Specifies that the selection dialog for the data source of the recipe view is displayed initially in
runtime.
Access in runtime: Read and write

WinCC Engineering V18 – Programming reference

904 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Syntax
Object.SelectArchiveName[=BOOLEAN]

Object
Required. A "ScreenItem" object with the following characteristics:
• UserArchiveControl

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
UserArchiveControl (Page 466)

SelectBackColor

Description
Specifies the background color of the selected text entry.
Access in runtime Read

Syntax
Object.SelectBackColor[=Color]

Object
Required. An object of the type "ScreenItem" with the following format:
• SymbolicIOField

Color
Optional. A value or a constant that specifies the background color of the selected text entry.

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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 905
VB scripting
1.5 VBS object model

See also
SymbolicIOField (Page 422)

SelectedCellColor

Description
Specifies the background color of the selected cell.
Access in runtime Read and write

Syntax
Object.SelectedCellColor[=Color]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• OnlineTableControl
• TrendRulerControl
• UserArchiveControl

Color
Optional. A value or a constant which specifies the background color.

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
AlarmControl (Page 237)
OnlineTableControl (Page 347)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

WinCC Engineering V18 – Programming reference

906 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

SelectedCellForeColor

Description
Specifies the font color of the selected cell.
Access in runtime Read and write

Syntax
Object.SelectedCellForeColor[=Color]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• OnlineTableControl
• TrendRulerControl
• UserArchiveControl

Color
Optional. A value or a constant which specifies the font color.

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
AlarmControl (Page 237)
OnlineTableControl (Page 347)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

SelectedID

Description
Returns the ID of the data record selected in the recipe view.
Access in runtime Read and write

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 907
VB scripting
1.5 VBS object model

Syntax
Object.SelectedID[=Int32]

Object
Required. An object of the type "ScreenItem" with the following format:
• UserArchiveControl

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.

See also
UserArchiveControl (Page 466)

SelectedIndex

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.
Access in runtime: Read and write

Syntax
Object.SelectedIndex[=Int32]

Object
Required. A "ScreenItem" object with the following format:
• ComboBox
• ListBox

Int32
Optional A value or a constant that specifies the index of the text highlighted.

See also
ComboBox (Page 290)
Listbox (Page 339)

WinCC Engineering V18 – Programming reference

908 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

SelectedRowColor

Description
Specifies the background color of the selected row.
Access in runtime Read and write

Syntax
Object.SelectedRowColor[=Color]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• OnlineTableControl
• TrendRulerControl
• UserArchiveControl

Color
Optional. A value or a constant which specifies the background color.

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
AlarmControl (Page 237)
OnlineTableControl (Page 347)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

SelectedRowForeColor

Description
Specifies the font color of the selected row.
Access in runtime Read and write

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 909
VB scripting
1.5 VBS object model

Syntax
Object.SelectedRowForeColor[=Color]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• OnlineTableControl
• TrendRulerControl
• UserArchiveControl

Color
Optional. A value or a constant which specifies the font color.

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
AlarmControl (Page 237)
OnlineTableControl (Page 347)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

SelectedText

Description
Specifies the text for the entry referenced with "SelectedIndex".
Access in runtime Read and write

Syntax
Object.SelectedText[=STRING]

WinCC Engineering V18 – Programming reference

910 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Object
Required. An object of the type "ScreenItem" with the following format:
• ComboBox
• ListBox

STRING
Optional. A value or a constant that specifies the text for an entry.

See also
ComboBox (Page 290)
Listbox (Page 339)

SelectedTitleColor

Description
Specifies the background color of the selected table header.
Also set "UseSelectedTitleColor" to "TRUE".
Access in runtime Read and write

Syntax
Object.SelectedTitleColor[=Color]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• OnlineTableControl
• TrendRulerControl
• UserArchiveControl

Color
Optional. A value or a constant which specifies the background color.

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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 911
VB scripting
1.5 VBS object model

See also
AlarmControl (Page 237)
OnlineTableControl (Page 347)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

SelectedTitleForeColor

Description
Specifies the font color of the selected table header.
Also set "UseSelectedTitleColor" to "TRUE".
Access in runtime Read and write

Syntax
Object.SelectedTitleForeColor[=Color]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• OnlineTableControl
• TrendRulerControl
• UserArchiveControl

Color
Optional. A value or a constant which specifies the font color.

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
UserArchiveControl (Page 466)
TrendRulerControl (Page 441)

WinCC Engineering V18 – Programming reference

912 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

OnlineTableControl (Page 347)

AlarmControl (Page 237)

SelectForeColor

Description
Specifies the color of the selected text entry.
Access in runtime Read

Syntax
Object.SelectForeColor[=Color]

Object
Required. An object of the type "ScreenItem" with the following format:
• SymbolicIOField

Color
Optional. A value or a constant that specifies the color of the selected text entry.

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
SymbolicIOField (Page 422)

SelectionBackColor

Description
Specifies the background color of the selected cells.
Access in runtime Read and write

Syntax
Object.SelectionBackColor[=Color]

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 913
VB scripting
1.5 VBS object model

Object
Required. A "ScreenItem" object with the format:
• AlarmView
• RecipeView*
• StatusForce
• UserView
*: Read access only
You have no access in runtime with the following format:
• TrendView

Color
Optional. A value or constant that specifies the background color of the selected row.

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.

SelectionColoring

Description
Specifies whether selection colors are used for cells or rows.
Access in runtime Read and write

Syntax
Object.SelectionColoring[=GridSelectionColoring]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• OnlineTableControl
• TrendRulerControl
• UserArchiveControl

WinCC Engineering V18 – Programming reference

914 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

GridSelectionColoring
Optional. A value or a constant that specifies whether highlight colors are used for cells or
rows.

Value Description Explanation

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.

See also
AlarmControl (Page 237)
OnlineTableControl (Page 347)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

SelectionForeColor

Description
Specifies the foreground color of the selected cells.
Access in runtime Read and write

Syntax
Object.SelectionForeColor[=Color]

Object
Required. An object of the type "ScreenItem" with the format:
• AlarmView
• RecipeView*
• StatusForce
• UserView
*: Read access only
You have no access in runtime with the following format:
• TrendView

Color
Optional. A value or constant that specifies the background color of the selected row.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 915
VB scripting
1.5 VBS object model

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.

SelectionRect

Description
Specifies whether a selection frame is used for the selected cells or rows.
Access in runtime Read and write

Syntax
Object.SelectionRect[=GridSelectionBorder]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• OnlineTableControl
• TrendRulerControl
• UserArchiveControl

GridSelectionBorder
Optional. A value or a constant that specifies whether a selection border is used for the
selected cell or rows.

Value Description Explanation

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
AlarmControl (Page 237)
OnlineTableControl (Page 347)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

WinCC Engineering V18 – Programming reference

916 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

SelectionRectColor

Description
Specifies the color of the selection rectangle in the alarm window.
Also set "SelectionType" to "1" or "2".
Access in runtime Read and write

Syntax
Object.SelectionRectColor[=Color]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• OnlineTableControl
• TrendRulerControl
• UserArchiveControl

Color
Optional. A value or a constant which specifies the color.

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
AlarmControl (Page 237)
OnlineTableControl (Page 347)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

SelectionRectWidth

Description
Specifies the line width of the selection rectangle in the alarm window if SelectionType equals
"1".

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 917
VB scripting
1.5 VBS object model

Access in runtime: Read and write

Syntax
Object.SelectionRectWidth[=Int32]

Object
Required. A "ScreenItem" object with the following format:
• AlarmControl
• OnlineTableControl
• TrendRulerControl
• UserArchiveControl

Int32
Optional A value or a constant which specifies the line width.

See also
AlarmControl (Page 237)
OnlineTableControl (Page 347)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

SelectionType

Description
Specifies the number of lines you can mark.
Access in runtime: Read and write

Syntax
Object.SelectionType[=GridSelectionType]

Object
Required. A "ScreenItem" object with the format:
• AlarmControl
• OnlineTableControl
• TrendRulerControl
• UserArchiveControl

WinCC Engineering V18 – Programming reference

918 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

GridSelectionType
Optional A value or a constant that specifies the number of lines that you can select.
The following settings are available:

Value Description Explanation

0 None No line is selected.
1 Single selection One line can be selected.
2 Multiple selection Several lines can be selected.

See also
AlarmControl (Page 237)
OnlineTableControl (Page 347)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

SeparateLineForAlarmText

Description
No access in runtime.

SeparatorBackColor

Description
Specifies the background color of the broken separation lines in the selection list.
Access in runtime Read

Syntax
Object.SeparatorBackColor[=Color]

Object
Required. An object of the type "ScreenItem" with the following format:
• SymbolicIOField

Color
Optional. A value or a constant that specifies the background color of the broken separation
lines in the selection list.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 919
VB scripting
1.5 VBS object model

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
SymbolicIOField (Page 422)

SeparatorColor

Description
Specifies the color of the separation lines in the selection list.
Access in runtime: Read and write

Syntax
Object.SeparatorColor[=Color]

Object
Required. An object of the type "ScreenItem" with the format:
• S7GraphOverview
• SymbolicIOField *
* Read access only

Color
Optional. A value or a constant that specifies the color of the separation lines in the selection
list.

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.

WinCC Engineering V18 – Programming reference

920 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

SeparatorCornerStyle

Description
Returns the shape of the corners for the separation line.
Access in runtime: Read

Syntax
Object.SeparatorCornerStyle[=CornerStyle]

Object
Required. An object of the type "ScreenItem" with the format:
• 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
3 Dashed and dotted line
4 Dash-dot-dot line

SeparatorLineEndShapeStyle

Description
Returns the shape of the line ends for the separation line.
Access in runtime: Read

Syntax
Object.SeparatorLineEndShapeStyle[=LineEndShapeStyle]

Object
Required. An object of the type "ScreenItem" with the format:
• SymbolicIOField

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 921
VB scripting
1.5 VBS object model

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

SeparatorStyle

Description
Specifies the line type of the separation lines in the selection list.
Access in runtime: Read

Syntax
Object.SeparatorStyle[=LineStyle]

Object
Required. An object of the type "ScreenItem" with the format:
• SymbolicIOField

LineStyle
Optional. A value or a constant that specifies the type of separation lines in the selection list.

Value VB constant Description

-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

Description
Specifies the width of the separation lines in the selection list.
Access in runtime Read

Syntax
Object.SeparatorWidth[=Int32]

WinCC Engineering V18 – Programming reference

922 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Object
Required. An object of the type "ScreenItem" with the following format:
• SymbolicIOField

Int32
Optional. A value or a constant that specifies the width of separation lines in the selection list.

See also
SymbolicIOField (Page 422)

ServerNames

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.
Access in runtime Read and write

Syntax
Object.ServerNames[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl

STRING
Optional. A value or a constant that specifies the servers of a distributed system from which
the object receives data.

See also
AlarmControl (Page 237)

ServerPrefix

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.
Access in Runtime: Read and write

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 923
VB scripting
1.5 VBS object model

Syntax
Object.ServerPrefix[=String]

Object
Required. An object of the type "ScreenItem" with the following format:
• ScreenWindow

String
Optional. A value or a constant which specifies the server name.

ServerScale

Description
No access in runtime.

SetOfVisibleColumns

Description
No access in runtime.

Shared

Description
No access in runtime.

ShareSpaceWithSourceControl

Description
Specifies that the display area of the data source is adapted to the size of the value table.
Access in runtime Read and write

Syntax
Object.ShareSpaceWithSourceControl[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• TrendRulerControl

WinCC Engineering V18 – Programming reference

924 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

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.

See also
TrendRulerControl (Page 441)

ShiftDecimalPoint

Description
No access in runtime.

ShowAcknowledgeButton

Description
No access in runtime.

ShowAlarmsFromDate

Description
Specifies that only those message events are displayed that are saved in this tag.
Access in runtime: Read and write

Syntax
Object.ShowAlarmsFromDate[=HmiObjectHandle]

Object
Required. A "ScreenItem" object with the format:
• AlarmView

HmiObjectHandle
Optional A value or a constant which specifies that only those message events are displayed
that are saved in this tag.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 925
VB scripting
1.5 VBS object model

See also
AlarmView (Page 251)

ShowAlarmsToAcknowledge

Description
No access in runtime.

ShowBadTagState

Description
Defines whether the object is grayed out when a bad quality code or tag status is detected.
Access in runtime: Read and write

Syntax
Object.ShowBadTagState[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the format:
• Bar
• CheckBox
• IOField
• OptionGroup
• SymbolicIOField *
• 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

Description
Specifies whether the displayed process value is also shown by a filled bar.
Access in runtime Read and write

WinCC Engineering V18 – Programming reference

926 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Syntax
Object.ShowBar[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• Slider

BOOLEAN
Optional. TRUE if the process value is also shown by a filled bar.

See also
Slider (Page 408)

ShowCaption

Description
Specifies whether the title bar is shown.
Access in runtime:
• RT Advanced: No access
• RT Professional: Read and write

Syntax
Object.ShowCaption[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the format:
• ApplicationWindow
• ScreenWindow
You have no access in runtime with the following format:
• Switch

BOOLEAN
Optional. TRUE if the header is shown.

ShowColumnHeaders

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 927
VB scripting
1.5 VBS object model

ShowControls

Description
Specifies that a toolbar is displayed.
Access in runtime:
• RT Advanced: No access
• RT Professional: Read and write

Syntax
Object.ShowControls[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the format:
• MediaPlayer
You have no access in runtime with the following format:
• SmartClientView

BOOLEAN
Optional.
TRUE, if a toolbar is displayed.
FALS E, if no toolbar will be displayed.

ShowDate

Description
No access in runtime.

ShowDecimalPoint

Description
Specifies whether the scale is identified with decimal figures (decimal point and one decimal
place) or with whole integers.
Access in runtime: Read and write

Syntax
Object.ShowDecimalPoint[=BOOLEAN]

WinCC Engineering V18 – Programming reference

928 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Object
Required. A "ScreenItem" object with the following format:
• Gauge

BOOLEAN
Optional TRUE, if the scale is identified with decimal figures (decimal point and one decimal
place).

See also
Gauge (Page 320)

ShowDropDownButton

Description
Returns whether a button for the selection list is displayed.
Access in runtime Read

Syntax
Object.ShowDropDownButton[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• 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
SymbolicIOField (Page 422)

ShowDropDownList

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 929
VB scripting
1.5 VBS object model

ShowFeatureBackward

Description
Specifies that the "Backward" button is to be displayed in runtime.
Access in runtime Read and write

Syntax
Object.ShowFeatureBackward[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• MediaPlayer

BOOLEAN
Optional.
TRUE, if the "Backward" button is displayed.
FALSE if no "Backward" button is displayed.

See also
MediaPlayer (Page 342)

ShowFeatureForward

Description
Specifies that the "Forward" button is displayed in runtime.
Access in runtime Read and write

Syntax
Object.ShowFeatureForward[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• MediaPlayer

BOOLEAN
Optional.
TRUE, if the "Forward" button is displayed.
FALSE if no "Forward" button is displayed.

WinCC Engineering V18 – Programming reference

930 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

See also
MediaPlayer (Page 342)

ShowFeatureFullScreen

Description
Specifies that the Media Player can be displayed as a full screen.
Access in runtime Read and write

Syntax
Object.ShowFeatureFullScreen[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• 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
MediaPlayer (Page 342)

ShowFeatureFullVolume

Description
No access in runtime.

ShowFeaturePause

Description
Specifies that the "Pause" button is displayed in runtime.
Access in runtime: Read and write

Syntax
Object.ShowFeaturePause[=BOOLEAN]

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 931
VB scripting
1.5 VBS object model

Object
Required. A "ScreenItem" object with the following characteristics:
• MediaPlayer

BOOLEAN
Optional.
TRUE, if the "Pause" button is displayed in runtime.
FALSE, if no "Pause" button is displayed in runtime.

See also
MediaPlayer (Page 342)

ShowFeaturePlay

Description
Specifies that the "Play" button is displayed in runtime.
Access in runtime: Read and write

Syntax
Object.ShowFeaturePlay[=BOOLEAN]

Object
Required. A "ScreenItem" object with the following characteristics:
• MediaPlayer

BOOLEAN
Optional.
TRUE, if the "Play" button is displayed in runtime.
FALSE, if no "Play" button is displayed in runtime.

See also
MediaPlayer (Page 342)

ShowFeatureStop

Description
Specifies that the "Stop" button is displayed in runtime.

WinCC Engineering V18 – Programming reference

932 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Access in runtime: Read and write

Syntax
Object.ShowFeatureStop[=BOOLEAN]

Object
Required. A "ScreenItem" object with the following characteristics:
• MediaPlayer

BOOLEAN
Optional.
TRUE, if the "Stop" button is displayed in runtime.
FALSE, if no "Stop" button is displayed in runtime.

See also
MediaPlayer (Page 342)

ShowFillLevel

Description
Specifies whether the selected object is filled.
Access in runtime: Read and write

Syntax
Object.ShowFillLevel[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the format:
• Button
• CheckBox
• Circle
• CircleSegment
• Ellipse
• EllipseSegment
• GraphicView
• OptionGroup
• Polygon

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 933
VB scripting
1.5 VBS object model

• Rectangle
• RoundButton*
• TextField
• WindowsSlider*
*: Read access only

BOOLEAN
Optional.TRUE, if the selected object is filled.

ShowFocusRectangle

Description
Specifies whether the button is given a selection border when it is activated in Runtime.
Access in runtime: Read and write

Syntax
Object.ShowFocusRectangle[=BOOLEAN]

Object
Required. A "ScreenItem" object with the following format:
• Clock

BOOLEAN
Optional TRUE, if the button is given a selection border when it is activated in Runtime.

See also
Clock (Page 287)

ShowHelpButton

Description
No access in runtime.

ShowHorizontalGridlines

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

934 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

ShowInnerDial

Description
No access in runtime.

ShowLargeTicksOnly

Description
Specifies whether only large scale marks are shown.
Access in runtime: Read and write

Syntax
Object.ShowLargeTicksOnly[=BOOLEAN]

Object
Required. A "ScreenItem" object with the following format:
• Bar

BOOLEAN
Optional TRUE if only large scale marks are shown.

See also
Bar (Page 259)

ShowLeadingZeros

Description
No access in runtime.

ShowLimitLines

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 935
VB scripting
1.5 VBS object model

ShowLimitRanges

Description
No access in runtime.

ShowLimitMarkers

Description
Specifies whether the limit values are shown as a scale value.
Access in runtime:
• RT Advanced: No access
• RT Professional: Read and write

Syntax
Object.ShowLimitMarkers[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the format:
• Bar
You have no access in runtime with the following format:
• Slider

BOOLEAN
Optional. TRUE, if the limit value is shown as a scale value.

ShowLoopInAlarmButton

Description
No access in runtime.

ShowMilliseconds

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

936 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

ShowNavigationButtons

Description
No access in runtime.

ShowPathInformation

Description
No access in runtime.

ShowPeakValuePointer

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.
Access in runtime: Read and write

Syntax
Object.ShowPeakValuePointer[=BOOLEAN]

Object
Required. A "ScreenItem" object with the following format:
• Gauge

BOOLEAN
Optional TRUE, if the slave pointer is used.

See also
Gauge (Page 320)

ShowPendingAlarms

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 937
VB scripting
1.5 VBS object model

ShowPosition

Description
Specifies whether the value of the current slider position should also be displayed numerically.
The value is then displayed beneath the slider.
Access in runtime: Read and write

Syntax
Object.ShowPosition[=BOOLEAN]

Object
Required. A "ScreenItem" object with the following format:
• Slider

BOOLEAN
Optional TRUE if the value is also shown numerically.

See also
Slider (Page 408)

ShowProcessValue

Description
No access in runtime.

ShowReadButton

Description
No access in runtime.

ShowRuler

Description
Specifies whether a scale division (help line) is displayed for an axis label of the object.
Access in runtime: Read and write

WinCC Engineering V18 – Programming reference

938 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Syntax
Object.ShowRuler[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the format:
• FunctionTrendControl
• OnlineTrendControl
• TrendView

BOOLEAN
Optional. TRUE, if the scale gradation is shown.

ShowRulerInAxis

Description
Specifies whether rulers are also displayed in the time axes.
Access in runtime Read and write

Syntax
Object.ShowRulerInAxis[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl
• OnlineTrendControl

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
FunctionTrendControl (Page 309)
OnlineTrendControl (Page 359)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 939
VB scripting
1.5 VBS object model

ShowScale

Description
Specifies whether the values are also shown in a scale.
Access in runtime:
• RT Advanced: No access
• RT Professional: Read and write

Syntax
Object.ShowScale[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the format:
• Bar
You have no access in runtime with the following format:
• Slider

BOOLEAN
Optional. TRUE, if the values will also be shown in a scale.

ShowScrollBar

Description
No access in runtime.

ShowScrollbars

Description
Specifies whether scroll bars are displayed.
Access in runtime: Read and write

Syntax
Object.ShowScrollbars[=BOOLEAN]

WinCC Engineering V18 – Programming reference

940 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Object
Required. An object of the type "ScreenItem" with the format:
• FunctionTrendControl
• OnlineTrendControl
• ScreenWindow

BOOLEAN
Optional. TRUE if scroll bars are displayed.

ShowSignForPositiveLabel

Description
No access in runtime.

ShowSortButton

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.
Access in runtime Read and write

Syntax
Object.ShowSortButton[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• OnlineTableControl
• TrendRulerControl
• UserArchiveControl

BOOLEAN
Optional.
TRUE if the sort button is displayed. You can sort the selected column.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 941
VB scripting
1.5 VBS object model

See also
AlarmControl (Page 237)
OnlineTableControl (Page 347)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

ShowSortIcon

Description
Specifies whether the sorting icon is displayed.
Access in runtime Read and write

Syntax
Object.ShowSortIcon[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• OnlineTableControl
• TrendRulerControl
• UserArchiveControl

BOOLEAN
Optional.
TRUE if the sort icon is displayed.
FALSE if the sort icon is not displayed.

See also
AlarmControl (Page 237)
OnlineTableControl (Page 347)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

ShowSortIndex

Description
Specifies whether a sort index is displayed.

WinCC Engineering V18 – Programming reference

942 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Access in runtime Read and write

Syntax
Object.ShowSortIndex[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• OnlineTableControl
• TrendRulerControl
• UserArchiveControl

BOOLEAN
Optional.
TRUE if a sort index is displayed.
FALSE if a sort index is not displayed.

See also
AlarmControl (Page 237)
OnlineTableControl (Page 347)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

ShowSplittedView

Description
No access in runtime.

ShowStatisticRuler

Description
Specifies whether the lines that define the statistics area are shown.
Access in runtime: Read and write

Syntax
Object.ShowStatisticRuler[=BOOLEAN]

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 943
VB scripting
1.5 VBS object model

Object
Required. A "ScreenItem" object with the following characteristics:
• OnlineTrendControl

BOOLEAN
Optional.
TRUE, if the lines for the statistics area are shown.
FALSE, if no lines for the statistics area are shown.

See also
OnlineTrendControl (Page 359)

ShowStatusBar

Description
Specifies whether the status bar is shown.
Access in runtime:
• RT Advanced: No access
• RT Professional: Read and write

Syntax
Object.ShowStatusBar[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the format:
• HTMLBrowser
You have no access in runtime with the following format:
• MediaPlayer

BOOLEAN
Optional. TRUE, if the status bar is shown.

ShowTableGridlines

Description
Specifies whether grid lines are shown in the table.

WinCC Engineering V18 – Programming reference

944 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Access in runtime:
• RT Advanced: Read and write
• RT Professional: No access

Syntax
Object.ShowTableGridlines[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the format:
• StatusForce
You have no access in runtime with the following format:
• TrendView
• UserView

BOOLEAN
Optional. TRUE if grid lines are shown in the table.

ShowThumb

Description
Specifies whether the slider of the "Slider" object will be displayed.
Access in runtime:
• RT Advanced: Read and write
• RT Professional: Read

Syntax
Object.ShowThumb[=BOOLEAN]

Object
Required. A "ScreenItem" object with the following format:
• Slider

BOOLEAN
Optional. TRUE, if the slider is shown.

See also
Slider (Page 408)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 945
VB scripting
1.5 VBS object model

ShowTickLabels

Description
Specifies whether the label is shown in the scale.
Access in runtime
• RT Advanced: Read and write
• RT Profession al: Read

Syntax
Object.ShowTickLabels[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the format:
• Slider
You have no access in runtime with the following format:
• 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

Description
Specifies whether the marks in the scale are displayed.
Access in runtime Read and write

Syntax
Object.ShowTicks[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• Clock
• Slider*
* RT Professional, read access only

WinCC Engineering V18 – Programming reference

946 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

BOOLEAN
Optional. TRUE if the marks are shown.

See also
Clock (Page 287)
Slider (Page 408)

ShowTime

Description
No access in runtime.

ShowTimeAxis

Description
No access in runtime.

ShowTimeAxisLabeling

Description
No access in runtime.

ShowTitle

Description
Specifies the style of the window border and window title for the object.
Access in runtime Read and write

Syntax
Object.ShowTitle[=WindowHeaderStyle]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• FunctionTrendControl
• OnlineTableControl

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 947
VB scripting
1.5 VBS object model

• OnlineTrendControl
• TrendRulerControl
• UserArchiveControl

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
AlarmControl (Page 237)
FunctionTrendControl (Page 309)
OnlineTableControl (Page 347)
OnlineTrendControl (Page 359)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

ShowToolBar

Description
No access in runtime.

ShowToolbarBackgroundColor

Description
No access in runtime.

ShowTracker

Description
Specifies that the tracker is displayed.
Access in runtime: Read and write

WinCC Engineering V18 – Programming reference

948 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Syntax
Object.ShowTracker[=BOOLEAN]

Object
Required. A "ScreenItem" object with the following characteristics:
• MediaPlayer

BOOLEAN
Optional.
TRUE, if the tracker is displayed.
FALSE, if no tracker is displayed.

See also
MediaPlayer (Page 342)

ShowTrendIcon

Description
Specifies whether an icon is displayed below the value axes. The icon indicates the trend
currently displayed in the foreground.
Access in runtime Read and write

Syntax
Object.ShowTrendIcon[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl
• OnlineTrendControl

BOOLEAN
Optional.
TRUE if the icon is displayed.
FALSE if the icon is not displayed.

See also
FunctionTrendControl (Page 309)
OnlineTrendControl (Page 359)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 949
VB scripting
1.5 VBS object model

ShowTrendIndicator

Description
Specifies whether the tendency (increasing or falling) of the measurement value that is to be
monitored is shown with a small arrow.
Access in runtime: Read and write

Syntax
Object.ShowTrendIndicator[=BOOLEAN]

Object
Required. A "ScreenItem" object with the following format:
• 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 259)

ShowValueAxis1

Description
No access in runtime.

ShowValueAxis1Label

Description
No access in runtime.

ShowValueAxis2

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

950 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

ShowValueAxis2Label

Description
No access in runtime.

ShowValueTable

Description
No access in runtime.

ShowWriteButton

Description
No access in runtime.

ShowY1HlpLine

Description
No access in runtime.

ShowY2HlpLine

Description
No access in runtime.

SimpleView

Description
No access in runtime.

SimpleViewToolbar

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 951
VB scripting
1.5 VBS object model

Size

Description
No access in runtime.

Sizeable

Description
Specifies that the size of an object can be changed in Runtime.
Access in Runtime: Read and write

Syntax
Object.Sizeable[=BOOLEAN]

Object
Required. An object of the "ScreenItem" type with the format:
• AlarmControl
• FunctionTrendControl
• OnlineTableControl
• OnlineTrendControl
• TrendRulerControl
• UserArchiveControl

Sizable
Optional. A value or a constant that specifies whether the size of the object can be modified.

See also
TrendRulerControl (Page 441)
OnlineTableControl (Page 347)
OnlineTrendControl (Page 359)
AlarmControl (Page 237)
FunctionTrendControl (Page 309)
UserArchiveControl (Page 466)

WinCC Engineering V18 – Programming reference

952 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

SmartTags

Description
Returns the SmartTags list.
Access in Runtime: Read

Syntax
Object.SmartTags

Object
Required A ""HMIRuntime" object.

See also
HMIRuntime (Page 209)

SortByTimeDirection

Description
Specifies whether the last alarm received is shown at the top (ascending sorting order).
Access in runtime Read and write

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.

Value Designation Description

0 Descending The last alarm received is shown at the top.
1 Ascending The last alarm received is shown at the bottom.

See also
AlarmView (Page 251)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 953
VB scripting
1.5 VBS object model

SortByTimeEnabled

Description
Specifies whether alarm sorting can be altered according to the time.
Access in runtime Read and write

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
AlarmView (Page 251)

SortSequence

Description
Specifies how the sorting order is changed if the operator clicks on the column header in
runtime.
Access in runtime: Read and write

Syntax
Object.SortSequence[=GridSortSequence]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• OnlineTableControl
• TrendRulerControl
• UserArchiveControl

WinCC Engineering V18 – Programming reference

954 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

GridSortSequence
Optional. A value or a constant that specifies how the sorting order will be changed by a
mouse click.

Value Description Explanation

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

Description
Specifies the trend or table view that is connected to the value table.
Access in runtime: Read and write

Syntax
Object.SourceControl[=HmiObjectHandle]

Object
Required. A "ScreenItem" object with the following characteristics:
• TrendRulerControl

HmiObjectHandle
Optional. A value or a constant that specifies the trend or table view that is connected to the
value table.

See also
TrendRulerControl (Page 441)

SourceControlType

Description
Specifies the type of data source.
Access in runtime: Read and write

Syntax
Object.SourceControlType[=TrendRulerControlSourceControlType]

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 955
VB scripting
1.5 VBS object model

Object
Required. A "ScreenItem" object with the following characteristics:
• TrendRulerControl

TrendRulerControlSourceControlType
Optional. Value or constant that specifies the type of the data source of the value table.

Value Designation Explanation

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
TrendRulerControl (Page 441)

SplittedViewRatio

Description
No access in runtime.

StartAngle

Description
Specifies the angle by which the start point deviates from the zero position (0°).
Access in runtime: Read and write

Syntax
Object.StartAngle[=Int32]

Object
Required. An object of the type "ScreenItem" with the format:
• CircleSegment
• CircularArc
• EllipseSegment
• EllipticalArc
• TubeArcObject

WinCC Engineering V18 – Programming reference

956 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Int32
Optional. A value or a constant that specifies the angle by which the start point deviates from
the zero position (0°).

See also
CircleSegment (Page 282)
CircularArc (Page 285)
EllipseSegment (Page 303)
EllipticalArc (Page 306)
TubeArcObject (Page 457)

StartLeft

Description
No access in runtime.

StartStyle

Description
Specifies how the line start is displayed.
Access in runtime: Read and write

Syntax
Object.StartStyle[=LineEndStyle]

Object
Required. An object of the type "ScreenItem" with the format:
• Connector
• Line
• Polyline

LineEndStyle
Optional. A value or constant which determines the line start. Value range from 0 to 6.

Value VB constant Explanation

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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 957
VB scripting
1.5 VBS object model

Value VB constant Explanation

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

Description
No access in runtime.

StartValue

Description
Defines the absolute value of the zero point of the scale indicator.
Access in runtime: Read and write

Syntax
Object.StartValue[=DOUBLE]

Object
Required. A "ScreenItem" object with the following format:
• 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 259)

State

Description
Returns the status of a message.

WinCC Engineering V18 – Programming reference

958 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

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

Description
No access in runtime.

StatisticResultColumns

Description
No access in runtime.

StatusbarBackColor

Description
Specifies the background color for status bars.
Also set "StatusbarUseBackColor" to "TRUE".
Access in runtime Read and write

Syntax
Object.StatusbarBackColor[=Color]

Object
Required. An object of the type "ScreenItem" with the format:
• AlarmControl
• FunctionTrendControl
• OnlineTableControl
• OnlineTrendControl
• TrendRulerControl
• UserArchiveControl

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 959
VB scripting
1.5 VBS object model

Color
Optional. A value or a constant that specifies the background color of the status bar.

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
AlarmControl (Page 237)
FunctionTrendControl (Page 309)
OnlineTableControl (Page 347)
OnlineTrendControl (Page 359)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

StatusbarElementAdd

Description
Creates a new, user-defined status bar element. The newly created element is automatically
referenced with "StatusbarElementIndex".
Access in runtime Read and write

Syntax
Object.StatusbarElementAdd[=STRING]

Object
Required. An object of the type "ScreenItem" with the format:
• AlarmControl
• FunctionTrendControl
• OnlineTableControl
• OnlineTrendControl
• TrendRulerControl
• UserArchiveControl

WinCC Engineering V18 – Programming reference

960 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

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 964)
AlarmControl (Page 237)
FunctionTrendControl (Page 309)
OnlineTableControl (Page 347)
OnlineTrendControl (Page 359)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

StatusbarElementAutoSize

Description
Specifies whether the width of a status bar element referenced with "StatusbarElementIndex" is
set automatically.
Access in runtime Read and write

Syntax
Object.StatusbarElementAutoSize[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• FunctionTrendControl
• OnlineTableControl
• OnlineTrendControl
• TrendRulerControl
• UserArchiveControl

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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 961
VB scripting
1.5 VBS object model

See also
UserArchiveControl (Page 466)
TrendRulerControl (Page 441)
FunctionTrendControl (Page 309)
OnlineTableControl (Page 347)
OnlineTrendControl (Page 359)
AlarmControl (Page 237)

StatusbarElementCount

Description
Specifies the number of configured status bar elements.
Access in runtime Read and write

Syntax
Object.StatusbarElementCount[=Int32]

Object
Required. An object of the type "ScreenItem" with the format:
• AlarmControl
• FunctionTrendControl
• OnlineTableControl
• OnlineTrendControl
• TrendRulerControl
• UserArchiveControl

Int32
Optional. A value or a constant that specifies the number of configured status bar elements.

See also
AlarmControl (Page 237)
FunctionTrendControl (Page 309)
OnlineTableControl (Page 347)
OnlineTrendControl (Page 359)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

WinCC Engineering V18 – Programming reference

962 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

StatusbarElementIconId

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.
Access in runtime Read and write

Syntax
Object.StatusbarElementIconId[=Int32]

Object
Required. An object of the type "ScreenItem" with the format:
• AlarmControl
• FunctionTrendControl
• OnlineTableControl
• OnlineTrendControl
• TrendRulerControl
• UserArchiveControl

Int32
Optional. A value or a constant that specifies the status bar element to be edited with the
icon ID.

See also
AlarmControl (Page 237)
FunctionTrendControl (Page 309)
OnlineTableControl (Page 347)
OnlineTrendControl (Page 359)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

StatusbarElementID

Description
References a status bar element with its element ID. To access the properties of a status bar
element, you need to set ""StatusbarElementID"".

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 963
VB scripting
1.5 VBS object model

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".
Access in runtime Read and write

Syntax
Object.StatusbarElementID[=Int32]

Object
Required. An object of the type "ScreenItem" with the format:
• AlarmControl
• FunctionTrendControl
• OnlineTableControl
• OnlineTrendControl
• TrendRulerControl
• UserArchiveControl

Int32
Optional. A value or a constant that specifies the status bar element to be edited with the
element ID.

See also
AlarmControl (Page 237)
FunctionTrendControl (Page 309)
OnlineTableControl (Page 347)
OnlineTrendControl (Page 359)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

StatusbarElementIndex

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.
Access in runtime Read and write

WinCC Engineering V18 – Programming reference

964 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Syntax
Object.StatusbarElementIndex[=Int32]

Object
Required. An object of the type "ScreenItem" with the format:
• AlarmControl
• FunctionTrendControl
• OnlineTableControl
• OnlineTrendControl
• TrendRulerControl
• UserArchiveControl

Int32
Optional. A value or a constant that specifies the status bar element to be edited with the
index.

See also
StatusbarElementCount (Page 962)
AlarmControl (Page 237)
FunctionTrendControl (Page 309)
OnlineTableControl (Page 347)
OnlineTrendControl (Page 359)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

StatusbarElementName

Description
Specifies the name of a status bar element referenced with "StatusbarElementIndex".
Access in runtime Read and write

Syntax
Object.StatusbarElementName[=STRING]

Object
Required. An object of the type "ScreenItem" with the format:
• AlarmControl
• FunctionTrendControl

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 965
VB scripting
1.5 VBS object model

• OnlineTableControl
• OnlineTrendControl
• TrendRulerControl
• UserArchiveControl

STRING
Optional. A value or a constant that specifies the name of the referenced status bar element.

See also
StatusbarElementIndex (Page 964)
AlarmControl (Page 237)
FunctionTrendControl (Page 309)
OnlineTableControl (Page 347)
OnlineTrendControl (Page 359)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

StatusbarElementRemove

Description
Removes the user-defined status bar element referenced with its name.
Access in runtime Read and write

Syntax
Object.StatusbarElementRemove[=STRING]

Object
Required. An object of the type "ScreenItem" with the format:
• AlarmControl
• FunctionTrendControl
• OnlineTableControl
• OnlineTrendControl
• TrendRulerControl
• UserArchiveControl

STRING
Optional. A value or a constant that specifies the name of the referenced user-defined
element of the status bar to be removed.

WinCC Engineering V18 – Programming reference

966 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

See also
AlarmControl (Page 237)
FunctionTrendControl (Page 309)
OnlineTableControl (Page 347)
OnlineTrendControl (Page 359)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

StatusbarElementRename

Description
Specifies the new name of a user-defined status bar element referenced with
"StatusbarElementIndex".
Access in runtime Read and write

Syntax
Object.StatusbarElementRename[=STRING]

Object
Required. An object of the type "ScreenItem" with the format:
• AlarmControl
• FunctionTrendControl
• OnlineTableControl
• OnlineTrendControl
• TrendRulerControl
• UserArchiveControl

STRING
Optional. A value or constant that specifies the new name of the selected user-defined status
bar element.

See also
StatusbarElementIndex (Page 964)
AlarmControl (Page 237)
FunctionTrendControl (Page 309)
OnlineTableControl (Page 347)
OnlineTrendControl (Page 359)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 967
VB scripting
1.5 VBS object model

TrendRulerControl (Page 441)

UserArchiveControl (Page 466)

StatusbarElementRepos

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".
Access in runtime Read and write

Syntax
Object.StatusbarElementRepos[=Int32]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• FunctionTrendControl
• OnlineTableControl
• OnlineTrendControl
• TrendRulerControl
• UserArchiveControl

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
StatusbarElementIndex (Page 964)
StatusbarElementCount (Page 962)
AlarmControl (Page 237)
FunctionTrendControl (Page 309)
OnlineTableControl (Page 347)
OnlineTrendControl (Page 359)

WinCC Engineering V18 – Programming reference

968 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

TrendRulerControl (Page 441)

UserArchiveControl (Page 466)

StatusbarElements

Description
No access in runtime.

StatusbarElementText

Description
Specifies the text of a user-defined status bar element referenced with "StatusbarElementIndex".
Access in runtime Read and write

Syntax
Object.StatusbarElementText[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• FunctionTrendControl
• OnlineTableControl
• OnlineTrendControl
• TrendRulerControl
• UserArchiveControl

STRING
Optional. A value or a constant that specifies the text of the selected element of the status
bar.

See also
AlarmControl (Page 237)
FunctionTrendControl (Page 309)
OnlineTableControl (Page 347)
OnlineTrendControl (Page 359)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 969
VB scripting
1.5 VBS object model

StatusbarElementTooltipText

Description
Specifies the text for the tooltip of a user-defined status bar element referenced with
"StatusbarElementIndex".
Access in runtime Read and write

Syntax
Object.StatusbarElementTooltipText[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• FunctionTrendControl
• OnlineTableControl
• OnlineTrendControl
• TrendRulerControl
• UserArchiveControl

STRING
Optional. A value or a constant that specifies the tooltip text for the selected user-defined
status bar element.

See also
AlarmControl (Page 237)
FunctionTrendControl (Page 309)
OnlineTableControl (Page 347)
OnlineTrendControl (Page 359)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

StatusbarElementUserDefined

Description
Specifies whether the configuration engineer has added a status bar element referenced with
"StatusbarElementIndex" as a new user-defined element.
Access in runtime Read and write

WinCC Engineering V18 – Programming reference

970 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Syntax
Object.StatusbarElementUserDefined[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• FunctionTrendControl
• OnlineTableControl
• OnlineTrendControl
• TrendRulerControl
• UserArchiveControl

BOOLEAN
Optional.
TRUE if the status bar element is user-defined.
FALSE if the status bar element is specified by the system.

See also
AlarmControl (Page 237)
FunctionTrendControl (Page 309)
OnlineTableControl (Page 347)
OnlineTrendControl (Page 359)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

StatusbarElementVisible

Description
Specifies whether the status bar element referenced with "StatusbarElementIndex" is displayed
in the object.
Access in runtime Read and write

Syntax
Object.StatusbarElementVisible[=BOOLEAN]

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 971
VB scripting
1.5 VBS object model

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• FunctionTrendControl
• OnlineTableControl
• OnlineTrendControl
• TrendRulerControl
• UserArchiveControl

BOOLEAN
Optional. TRUE if the referenced status bar element is displayed.

See also
StatusbarElementIndex (Page 964)
AlarmControl (Page 237)
FunctionTrendControl (Page 309)
OnlineTableControl (Page 347)
OnlineTrendControl (Page 359)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

StatusbarElementWidth

Description
Specifies the width in pixels of a status bar element referenced with "StatusbarElementIndex".
Also set "StatusbarElementAutoSize (Page 961)" to "FALSE".
Access in runtime Read and write

Syntax
Object.StatusbarElementWidth[=Int32]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• FunctionTrendControl
• OnlineTableControl
• OnlineTrendControl

WinCC Engineering V18 – Programming reference

972 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

• TrendRulerControl
• UserArchiveControl

Int32
Optional. A value or constant that specifies the width of the referenced status bar element in
pixels.

See also
StatusbarElementIndex (Page 964)
AlarmControl (Page 237)
FunctionTrendControl (Page 309)
OnlineTableControl (Page 347)
OnlineTrendControl (Page 359)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

StatusbarFont

Description
Specifies the font of the texts in the status bar.
Access in runtime: Read and write

Syntax
Object.StatusbarFont[=Font]

Object
Required. A "ScreenItem" object with the following characteristics:
• AlarmControl
• FunctionTrendControl
• OnlineTableControl
• OnlineTrendControl
• TrendRulerControl
• UserArchiveControl

Font
Optional. A value or constant that specifies the font of the texts in the status bar.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 973
VB scripting
1.5 VBS object model

See also
AlarmControl (Page 237)
FunctionTrendControl (Page 309)
OnlineTableControl (Page 347)
OnlineTrendControl (Page 359)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

StatusbarFontColor

Description
Specifies the color of the texts in the status bar.
Access in runtime Read and write

Syntax
Object.StatusbarFontColor[=Color]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• FunctionTrendControl
• OnlineTableControl
• OnlineTrendControl
• TrendRulerControl
• UserArchiveControl

Color
Optional. A value or constant that specifies the color of the texts in the status bar.

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.

WinCC Engineering V18 – Programming reference

974 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

See also
AlarmControl (Page 237)
FunctionTrendControl (Page 309)
OnlineTableControl (Page 347)
OnlineTrendControl (Page 359)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

StatusbarShowTooltips

Description
Specifies whether tooltips are displayed for the elements of the status bar in runtime.
Access in runtime Read and write

Syntax
Object.StatusbarShowTooltips[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• FunctionTrendControl
• OnlineTableControl
• OnlineTrendControl
• TrendRulerControl
• UserArchiveControl

BOOLEAN
Optional.
TRUE if the tooltips are shown.
FALSE if the tooltips are not shown.

See also
AlarmControl (Page 237)
FunctionTrendControl (Page 309)
OnlineTableControl (Page 347)
OnlineTrendControl (Page 359)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 975
VB scripting
1.5 VBS object model

TrendRulerControl (Page 441)

UserArchiveControl (Page 466)

StatusbarText

Description
Specifies the default text in the status bar.
Access in runtime: Read and write

Syntax
Object.StatusbarText[=STRING]

Object
Required. A "ScreenItem" object with the following format:
• AlarmControl
• FunctionTrendControl
• OnlineTableControl
• OnlineTrendControl
• TrendRulerControl
• UserArchiveControl

STRING
Optional A value or a constant that specifies the default text in the status bar.

See also
AlarmControl (Page 237)
FunctionTrendControl (Page 309)
OnlineTableControl (Page 347)
OnlineTrendControl (Page 359)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

StatusbarUseBackColor

Description
Specifies whether the background color of the status bar is shown.
Access in runtime Read and write

WinCC Engineering V18 – Programming reference

976 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Syntax
Object.StatusbarUseBackColor[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• FunctionTrendControl
• OnlineTableControl
• OnlineTrendControl
• TrendRulerControl
• UserArchiveControl

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
AlarmControl (Page 237)
FunctionTrendControl (Page 309)
OnlineTableControl (Page 347)
OnlineTrendControl (Page 359)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

StatusbarVisible

Description
Specifies whether the status bar of the control is displayed.
Access in runtime Read and write

Syntax
Object.StatusbarVisible[=BOOLEAN]

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 977
VB scripting
1.5 VBS object model

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• FunctionTrendControl
• OnlineTableControl
• OnlineTrendControl
• TrendRulerControl
• UserArchiveControl

BOOLEAN
Optional.
TRUE if the status bar is displayed.
FALSE if the status bar is not displayed.

See also
AlarmControl (Page 237)
FunctionTrendControl (Page 309)
OnlineTableControl (Page 347)
OnlineTrendControl (Page 359)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

StatuslineFont

Description
No access in runtime.

StepBackColor

Description
Specifies the background color of the step.
Access in runtime Read and write

Syntax
Object.StepBackColor[=Color]

WinCC Engineering V18 – Programming reference

978 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Object
Required. An object of the type "ScreenItem" with the following format:
• S7GraphOverview
You have no access in runtime with the following format:

Color
Optional. A value or a constant that specifies the background color of the step.

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
S7GraphOverview (Page 402)

StepFont

Description
Specifies the font color of the step.
Access in runtime Read and write

Syntax
Object.StepFont[=Font]

Object
Required. An object of the type "ScreenItem" with the following format:
• S7GraphOverview

Font
Optional. A value or a constant that specifies the font.

See also
S7GraphOverview (Page 402)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 979
VB scripting
1.5 VBS object model

StepSeconds

Description
Specifies the step interval in seconds after actuating the "Forward" or "Backward" button.
Access in runtime: Read and write

Syntax
Object.StepSeconds[=Int32]

Object
Required. A "ScreenItem" object with the following characteristics:
• MediaPlayer

Int32
Optional. A value or a constant that specifies the step interval in seconds after actuating the
"Forward" or "Backward" button.

See also
MediaPlayer (Page 342)

StepTextColor

Description
Specifies the text color of the step.
Access in runtime Read and write

Syntax
Object.StepTextColor[=Color]

Object
Required. An object of the type "ScreenItem" with the following format:
• S7GraphOverview
You have no access in runtime with the following format:

Color
Optional. A value or a constant that specifies the background color of the step.

WinCC Engineering V18 – Programming reference

980 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

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
S7GraphOverview (Page 402)

Style

Description
Specifies the line style.
Access in runtime: Read and write

Syntax
Object.Style[=LineStyle]

Object
Required. An object of the type "ScreenItem" with the format:
• CircularArc
• Connector
• EllipticalArc
• Line
• Polyline

LineStyle
Optional. A value or a constant that specifies the line style. Value range from 0 to 4.

Value VB constant Explanation

0 hmiLineStyleSolid Solid line
1 hmiLineStyleDash Dashed line
2 hmiLineStyleDot Dotted line
3 hmiLineStyleDashDot Dash-dot line
4 hmiLineStyleDashDotDot Dash-dot-dot line

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 981
VB scripting
1.5 VBS object model

StyleItem

Description
No access in runtime.

StyleSettings

Description
Specifies the style in which the object is displayed.
Access in runtime Read and write

Syntax
Object.StyleSettings[=WinCCStyle]

Object
Required. An object of the type "ScreenItem" with the following format:
• Button
• RoundButton*
• Window Slider*
*: Read access only

WinCCStyle
Optional. A value or a constant that specifies the style in which the object is displayed.

Value Designation Description

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

Description
No access in runtime.

SupportsS7DiagnosticsInSimpleView

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

982 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

SupportsUserDefinedToolbarButtons

Description
No access in runtime.

SwapFirstWithLastConnection

Description
Specifies that the first and last connection should be swapped.
Access in Runtime: Read and write

Syntax
Object.SwapFirstWithLastConnection[=Boolean]

Object
Required. An object of the type "ScreenItem" with the format:
• Connector

Boolean
Optional. A value or a constant which specifies that the first and last connection are
swapped.

See also
Connector (Page 293)

SwitchOrientation

Description
No access in runtime.

SymbolTableFont

Description
Specifies the font of the symbol table in the PLC code display.
Access in runtime: Read and write

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 983
VB scripting
1.5 VBS object model

Syntax
Object.SymbolTableFont[=Font]

Object
Required. A "ScreenItem" object with the following characteristics:
• PLCCodeViewer

Font
Optional. A value or a constant that specifies the font in the symbol table in the PLC code
display.

See also
PLCCodeViewer (Page 376)

SysDiagBuffButtonVisible

Description
No access in runtime.

1.5.5.13 Properties T

TabIndex

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:
• RT Advanced: No access
• RT Professional: Read

Syntax
Object.TabIndex[=Int32]

Object
Required. An object of the type "ScreenItem" with the following format:
• DiscSpaceView
You have no access in runtime with the following format:
•

WinCC Engineering V18 – Programming reference

984 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Int32
Optional. A value or a constant which specifies the position in the tabulator order.

TabIndexAlpha

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:
• RT Advanced: No access
• RT Professional: Read

Syntax
Object.TabIndexAlpha[=Int32]

Object
Required. An object of the type "ScreenItem" with the following format:
• DiscSpaceView
You have no access in runtime with the following format:
• AlarmControl
• AlarmView
• ApplicationWindow
• Bar
• BatteryView
• Button
• ChannelDiagnose
• CheckBox
• Circle
• CircleSegment
• CircularArc
• Clock
• ComboBox
• Connector
• DateTimeField
• Ellipse
• EllipseSegment

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 985
VB scripting
1.5 VBS object model

• EllipticalArc
• FunctionTrendControl
• Gauge
• GraphicIOField
• GraphicView
• HTMLBrowser
• IOField
• Line
• ListBox
• MediaPlayer
• MultiLineEdit
• OnlineTableControl
• OnlineTrendControl
• OptionGroup
• PLCCodeViewer
• Polygon
• Polyline
• ProtectedAreaNameView
• RangeLabelView
• RangeQualityView
• RecipeView
• Rectangle
• RoundButton
• S7GraphOverview
• ScreenWindow
• Slider
• SmartClientView
• StatusForce
• Switch
• SymbolLibrary
• SymbolicIOField
• SysDiagControl
• TextField
• TrendRulerControl
• TrendView

WinCC Engineering V18 – Programming reference

986 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

• TubeArcObject
• TubeDoubleTeeObject
• TubeTeeObject
• Tubepolyline
• UserArchiveControl
• UserView
• WLanQualityView
• WindowsSlider
• ZoneLabelView
• ZoneQualityView

Int32
Optional. A value or a constant which specifies the position in the tabulator order.

TableBackColor

Description
Specifies the background color of the table cells.
Access in runtime Read and write

Syntax
Object.TableBackColor[=Color]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmView
• RecipeView*
• StatusForce
• TrendView
• UserView
*: Read access only

Color
Optional. A value or constant which determines the background color of the table cells.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 987
VB scripting
1.5 VBS object model

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.

TableColor

Description
Specifies the background color of the table rows in the object.
Access in runtime Read and write

Syntax
Object.TableColor[=Color]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• OnlineTableControl
• TrendRulerControl
• UserArchiveControl

Color
Optional. A value or constant that specifies the background color of the table rows.

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
AlarmControl (Page 237)
OnlineTableControl (Page 347)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

WinCC Engineering V18 – Programming reference

988 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

TableColor2

Description
Specifies the second background color of the table rows in the object.
Also set "UseTableColor2 (Page 1158)" to "TRUE".
Access in runtime Read and write

Syntax
Object.TableColor2[=Color]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• OnlineTableControl
• TrendRulerControl
• UserArchiveControl

Color
Optional. A value or constant that specifies the second background color of the table rows.

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
AlarmControl (Page 237)
OnlineTableControl (Page 347)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

TableColumnsWidthAndOrder

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 989
VB scripting
1.5 VBS object model

TableEvenRowBackColor

Description
No access in runtime.

TableFont

Description
No access in runtime.

TableForeColor

Description
Specifies the text color used in the table cells of the object.
Access in runtime: Read and write

Syntax
Object.TableForeColor[=Color]

Object
Required. An object of the type "ScreenItem" with the format:
• AlarmControl
• AlarmView
• OnlineTableControl
• RecipeView*
• StatusForce
• TrendRulerControl
• UserArchiveControl
• UserView
*: Read access only

Color
Optional. A value or a constant that specifies the text color used in the table cells.

WinCC Engineering V18 – Programming reference

990 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

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.

TableForeColor2

Description
Specifies the second text color used in the table cells of the object.
Also set "UseTableColor2 (Page 1158)" to "TRUE".
Access in runtime Read and write

Syntax
Object.TableForeColor2[=Color]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• OnlineTableControl
• TrendRulerControl
• UserArchiveControl

Color
Optional. A value or a constant that specifies the second font color used in the table cells.

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
AlarmControl (Page 237)
OnlineTableControl (Page 347)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 991
VB scripting
1.5 VBS object model

TrendRulerControl (Page 441)

UserArchiveControl (Page 466)

TableGridLineColor

Description
Specifies the color of the grid lines in the table.
Access in runtime:
• RT Advanced: Read and write
• RT Professional: No access

Syntax
Object.TableGridLineColor[=Color]

Object
Required. An object of the type "ScreenItem" with the format:
• RecipeView*
• TrendView*
• UserView
*: Read access only

You have no access in runtime with the following format:

• StatusForce
• SysDiagControl

Color
Optional. A value or constant which determines the color of the gridlines of the table.

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.

WinCC Engineering V18 – Programming reference

992 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

TableHeaderBackColor

Description
Specifies the background color in the header of the table.
Access in runtime Read and write

Syntax
Object.TableHeaderBackColor[=Color]

Object
Required. A "ScreenItem" object with the following format:
• AlarmView
• RecipeView*
• StatusForce
• TrendView*
• UserView
*: Read access only

Color
Optional. A value or a constant that specifies the background color in the header.

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.

TableHeaderBackFillStyle

Description
No access in runtime.

TableHeaderBorderBackColor

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 993
VB scripting
1.5 VBS object model

TableHeaderBorderColor

Description
No access in runtime.

TableHeaderBorderWidth

Description
No access in runtime.

TableHeaderCornerRadius

Description
No access in runtime.

TableHeaderEdgeStyle

Description
No access in runtime.

TableHeaderFirstGradientColor

Description
No access in runtime.

TableHeaderFirstGradientOffset

Description
No access in runtime.

TableHeaderFont

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

994 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

TableHeaderForeColor

Description
Specifies the text color in the header of the table.
Access in runtime Read and write

Syntax
Object.TableHeaderForeColor[=Color]

Object
Required. A "ScreenItem" object with the following format:
• AlarmView
• RecipeView*
• StatusForce*
• TrendView*
• UserView
*: Read access only

Color
Optional. A value or a constant that specifies the text color in the header.

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.

TableHeaderMiddleGradientColor

Description
No access in runtime.

TableHeaderPaddingBottom

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 995
VB scripting
1.5 VBS object model

TableHeaderPaddingLeft

Description
No access in runtime.

TableHeaderPaddingRight

Description
No access in runtime.

TableHeaderPaddingTop

Description
No access in runtime.

TableHeaderSecondGradientColor

Description
No access in runtime.

TableHeaderSecondGradientOffset

Description
No access in runtime.

Tag4DataRecord

Description
No access in runtime.

Tag4RecipeNumber

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

996 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

TagForExternalTime

Description
No access in runtime.

TagPrefix

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.

Access in Runtime: Read and write

Syntax
Object.TagPrefix[= STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• ScreenWindow

STRING
Optional. A value or a constant that specifies the tag prefix.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 997
VB scripting
1.5 VBS object model

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".
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
ScreenWindow (Page 404)

Tags

Description
Returns an object of type "Tags".
Access during runtime: Read

Syntax
Object.Tags

Object
Necessary. An object of the "HMIRuntime" type.

WinCC Engineering V18 – Programming reference

998 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Example
The following example accesses the tag "Tag1":

'VBS86
Dim objTag
Set objTag = HMIRuntime.Tags("Tag1")

See also
HMIRuntime (Page 209)

TcpPortNr

Description
No access in runtime.

Template

Description
Specifies the template for displaying the window content in the "Print job/Script diagnostic"
object.
Access in Runtime: Read and write

Syntax
Object.Template[=TemplateType]

Object
Required. An object of the type "ScreenItem" with the following format:
• ApplicationWindow

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 1222)":

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 999
VB scripting
1.5 VBS object model

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":
The "Print job" object is supplied by the logging system. The available reports are displayed
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.
• "Job Detail View":
The "Print job" object is supplied by the logging system. The available reports are displayed
in a selection menu. Detailed information is displayed for the selected report.
• "Selected Jobs - Context Menu":
The "Print job" object is supplied by the logging system. The available reports are displayed
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
ApplicationWindow (Page 257)

Text

Description
Specifies the label for the text field.
Access in runtime: Read and write

Syntax
Object.Text[=STRING]

Object
Required. An object of the type "ScreenItem" with the format:
• CheckBox
• ComboBox
• ListBox

WinCC Engineering V18 – Programming reference

1000 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

• MultiLineEdit
• OptionGroup
• RoundButton
• TextField

STRING
Optional. A value or a constant that specifies the labeling.

TextAreaBottomMargin

Description
No access in runtime.

TextAreaLeftMargin

Description
No access in runtime.

TextAreaRightMargin

Description
No access in runtime.

TextAreaTopMargin

Description
No access in runtime.

TextHandles

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1001
VB scripting
1.5 VBS object model

TextList

Description
Returns the text list that supplies the object with values.
Access in runtime
• RT Advanced: No access
• RT Professional: Read

Syntax
Object.TextList[=HmiObjectHandle]

Object
Required. An object of the type "ScreenItem" with the following format:
• SymbolicIOField
You have no access in runtime with the following formats:
• Button

HmiObjectHandle
Optional. A value or a constant that returns the text list that supplies the object with values.

See also
SymbolicIOField (Page 422)
Button (Page 267)

TextOff

Description
Specifies the text that will be displayed in the "Off" status.
Access in runtime Read and write

Syntax
Obje ct.TextOff[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• Button
• Switch*

WinCC Engineering V18 – Programming reference

1002 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

* RT Advanced read access only, RT Professional no access

You have no access in runtime with the following formats:

• 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

Description
Specifies the text that will be displayed in the "On" status.
Access in runtime: Read and write

Syntax
Object.TextOn[=STRING]

Object
Required. An object of the type "ScreenItem" with the format:
• Button
• Switch*
* RT Advanced read access only, RT Professional no access

You have no access in runtime with the following formats:

• 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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1003
VB scripting
1.5 VBS object model

TextOrientation

Description
Specifies the text orientation.
Access in runtime:
• RT Advanced: No access
• RT Professional: Read and write

Syntax
Object.TextOrientation[=TextOrientation]

Object
Required. An object of the type "ScreenItem" with the format:
• Button
• CheckBox
• IOField
• OptionGroup
• RoundButton*
• SymbolicIOField*
• TextField
• WindowSlider*
*: Read access only
You have no access in runtime with the following formats:
• DateTimeField
• Switch

TextOrientation
Optional. A value or a constant that specifies the text orientation.

Value VB constant Explanation

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

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

1004 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

TextualObjectPositions

Description
No access in runtime.

TextualObjectsAutoSize

Description
No access in runtime.

TextualObjectsBorderBackColor

Description
No access in runtime.

TextualObjectsBorderColor

Description
No access in runtime.

TextualObjectsBorderWidth

Description
No access in runtime.

TextualObjectsCornerRadius

Description
No access in runtime.

TextualObjectsEdgeStyle

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1005
VB scripting
1.5 VBS object model

TextualObjectsPaddingBottom

Description
No access in runtime.

TextualObjectsPaddingLeft

Description
No access in runtime.

TextualObjectsPaddingRight

Description
No access in runtime.

TextualObjectsPaddingTop

Description
No access in runtime.

ThumbBackColor

Description
Specifies the background color of the slider.
Access in runtime Read

Syntax
Object.ThumbBackColor[=Color]

Object
Required. An object of the type "ScreenItem" with the format:
• Slider
• WindowSlider

Color
Optional. A value or a constant that specifies the background color of the slider.

WinCC Engineering V18 – Programming reference

1006 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

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
Slider (Page 408)
WindowSlider (Page 482)

ThumbPicture

Description
Specifies a graphic for the slider element in the slider.
Access in runtime: Read

Syntax
Object.ThumbPicture[=HmiObjectHandle]

Object
Required. A "ScreenItem" object with the following characteristics:
• Slider

HmiObjectHandle
Optional. A value or constant that specifies the graphic for the slider element in the slider.

See also
Slider (Page 408)

TickDistance

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1007
VB scripting
1.5 VBS object model

TicksColor

Description
Specifies the color of the hour markers on the face of the "Clock" object.
Access in runtime Read and write

Syntax
Object.TicksColor[=Color]

Object
Required. An object of the type "ScreenItem" with the following format:
• Clock

Color
Optional. A value or a constant that specifies the color of the hour markers.

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
Clock (Page 287)

TickStyle

Description
Specifies how the marks are displayed in the scale.
Also set "ShowTicks" to "TRUE".
Access in runtime:
• RT Advanced: No access
• RT Professional: Read and write

Syntax
Object.TickStyle[=SliderTickStyle]

WinCC Engineering V18 – Programming reference

1008 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Object
Required. An object of the type "ScreenItem" with the format:
• Slider
You have no access in runtime with the following formats:
• Clock

SliderTickStyle
Optional. A value or a constant that specifies how the marks are displayed in the scale.

Value VB constant Explanation

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.

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

Description
No access in runtime.

TimeAxisAdd

Description
Creates a new time axis. The newly created time axis is automatically referenced with
"TimeAxisIndex".
Access in runtime: Read and write

Syntax
Object.TimeAxisAdd[=STRING]

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1009
VB scripting
1.5 VBS object model

Object
Required. An object of the type "ScreenItem" with the format:
• OnlineTrendControl

STRING
Required. A value or a constant that specifies the name of the new time axis with
"TimeAxisName".

TimeAxisAlignment

Description
Specifies the alignment of the time axis.
Access in runtime: Read and write

Syntax
Object.TimeAxisAlignment[=AxisAlignment]

Object
Required. A "ScreenItem" object with the following characteristics:
• OnlineTrendControl

AxisAlignment
Optional. A value or a constant that specifies the alignment.

Value Designation Explanation

0 Bottom The time axis selected is displayed below the trend.
1 Top The time axis selected is displayed above the trend.

See also
OnlineTrendControl (Page 359)

TimeAxisBegin

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

1010 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

TimeAxisBeginTime

Description
Specifies the start time for the display of the time axis referenced with "TimeAxisIndex".
Access in runtime:
• RT Advanced: No access
• RT Professional: Read and write

Syntax
Object.TimeAxisBeginTime[=DateTime]

Object
Required. An object of the type "ScreenItem" with the format:
• OnlineTrendControl
You have no access in runtime with the following format:
• TrendView

DateTime
Optional. A value or a constant that specifies the start time for the display of the specified
trend.

TimeAxisColor

Description
Specifies the color of the time axis referenced with "TimeAxisIndex".
Access in runtime Read and write

Syntax
Object.TimeAxisColor[=Color]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTrendControl

Color
Optional. A value or a constant that specifies the color of the time axis.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1011
VB scripting
1.5 VBS object model

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
OnlineTrendControl (Page 359)

TimeAxisCount

Description
Specifies the number of configured time axes.
Access in runtime Read and write

Syntax
Object.TimeAxisCount[=Int32]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTrendControl

Int32
Optional. A value or a constant that specifies the number of configured time axes.

See also
OnlineTrendControl (Page 359)

TimeAxisCountPoints

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

1012 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

TimeAxisDateFormat

Description
Specifies the date format for displaying the time axis referenced with "TimeAxisIndex".
Access in runtime Read and write

Syntax
Object.TimeAxisDateFormat[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTrendControl

STRING
Optional. A value or a constant that specifies the date format.

See also
OnlineTrendControl (Page 359)

TimeAxisEnd

Description
No access in runtime.

TimeAxisEndTime

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.
Access in runtime: Read and write

Syntax
Object.TimeAxisEndTime[=DateTime]

Object
Required. A "ScreenItem" object with the following format:
• OnlineTrendControl

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1013
VB scripting
1.5 VBS object model

DateTime
Optional A value or a constant that specifies the end time for the display of the specified
trend.

See also
OnlineTrendControl (Page 359)

TimeAxisIndex

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.
Access in runtime Read and write

Syntax
Object.TimeAxisIndex[=Int32]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTrendControl

Int32
Optional. A value or a constant that specifies, with the index, the time axis to be edited.

See also
TimeAxisCount (Page 1012)
OnlineTrendControl (Page 359)

TimeAxisInTrendColor

Description
Specifies whether the color of the time axis referenced with "TimeAxisIndex" corresponds to the
trend color.
Access in runtime Read and write

Syntax
Object.TimeAxisInTrendColor[=BOOLEAN]

WinCC Engineering V18 – Programming reference

1014 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTrendControl

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 1014)
OnlineTrendControl (Page 359)

TimeAxisLabel

Description
Specifies the label text for a time axis referenced with "TimeAxisIndex".
Access in runtime Read and write

Syntax
Object.TimeAxisLabel[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTrendControl

STRING
Optional. A value or a constant that specifies the label text for the referenced time axis.

See also
TimeAxisIndex (Page 1014)
OnlineTrendControl (Page 359)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1015
VB scripting
1.5 VBS object model

TimeAxisMeasurePoints

Description
Specifies the number of measuring points displayed for the time axis referenced with
"TimeAxisIndex".
Access in runtime Read and write

Syntax
Object.TimeAxisMeasurePoints[=Int32]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTrendControl

Int32
Optional. A value or a constant that specifies the number of measurement points.

See also
OnlineTrendControl (Page 359)

TimeAxisMode

Description
No access in runtime.

TimeAxisName

Description
Specifies the name of a time axis referenced with "TimeAxisIndex".
Access in runtime Read and write

Syntax
Object.TimeAxisName[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTrendControl

WinCC Engineering V18 – Programming reference

1016 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

STRING
Optional. A value or a constant that specifies the name of the referenced time axis.

See also
TimeAxisIndex (Page 1014)
OnlineTrendControl (Page 359)

TimeAxisOnline

Description
Specifies that the time axis is updated on an ongoing basis.
Access in runtime: Read and write

Syntax
Object.TimeAxisOnline[=BOOLEAN]

Object
Required. A "ScreenItem" object with the following characteristics:
• OnlineTrendControl

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.

See also
OnlineTrendControl (Page 359)

TimeAxisRange

Description
No access in runtime.

TimeAxisRangeType

Description
Defines the time range setting for the time axis referenced with "TimeAxisIndex".

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1017
VB scripting
1.5 VBS object model

Access in runtime Read and write

Syntax
Object.TimeAxisRangeType[=TimeRangeMode]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTrendControl

TimeRangeMode
Optional. A value or a constant that specifies the settings for the time range.
The following settings are available:

Value Designation Description

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
OnlineTrendControl (Page 359)

TimeAxisRemove

Description
Removes a time axis referenced with its name.
Access in runtime Read and write

Syntax
Object.TimeAxisRemove[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTrendControl

STRING
Optional. A value or a constant that returns the name of the referenced time axis to be
removed.

WinCC Engineering V18 – Programming reference

1018 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

See also
OnlineTrendControl (Page 359)

TimeAxisRename

Description
Specifies the new name of a time axis referenced with "TimeAxisIndex".
Access in runtime Read and write

Syntax
Object.TimeAxisRename[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTrendControl

STRING
Optional. A value or a constant that specifies the new name of the selected time axis.

See also
TimeAxisIndex (Page 1014)
OnlineTrendControl (Page 359)

TimeAxisRepos

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".
Access in runtime Read and write

Syntax
Object.TimeAxisRepos[=Int32]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTrendControl

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1019
VB scripting
1.5 VBS object model

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
TimeAxisIndex (Page 1014)
TimeAxisCount (Page 1012)
OnlineTrendControl (Page 359)

TimeAxisShowDate

Description
Specifies whether the time axis referenced with "TimeAxisIndex" is displayed with date and time.
Access in runtime Read and write

Syntax
Object.TimeAxisShowDate[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTrendControl

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
OnlineTrendControl (Page 359)

TimeAxisSide

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

1020 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

TimeAxisTimeFormat

Description
Specifies the format of the information along the time axis for the selected trend.
Access in runtime Read and write

Syntax
Object.TimeAxisTimeFormat[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTrendControl

STRING
Optional. A value or a constant which defines the format for the time axis.

See also
OnlineTrendControl (Page 359)

TimeAxisTimeRange

Description
No access in runtime.

TimeAxisTimeRangeBase

Description
Specifies the time unit that defines the time range together with the time factor
"TimeAxisTimeRangeFactor".
Access in runtime Read and write

Syntax
Object.TimeAxisTimeRangeBase[=TagLoggingTimeUnit]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTrendControl

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1021
VB scripting
1.5 VBS object model

TagLoggingTimeUnit
Optional. A value or a constant that specifies the time unit.
The following settings are available:

Value Designation
500 500 ms
1000 1 second
60000 1 minute
3600000 1 hour
86400000 1 day

See also
OnlineTrendControl (Page 359)

TimeAxisTimeRangeFactor

Description
Specifies the time factor that together with time unit "TimeAxisTimeRangeBase" determines the
time period.
Access in runtime: Read and write

Syntax
Object.TimeAxisTimeRangeFactor[=Int16]

Object
Required. A "ScreenItem" object with the following characteristics:
• OnlineTrendControl

Int16
Optional. A value or a constant that specifies the time factor.

See also
OnlineTrendControl (Page 359)

TimeAxisTrendWindow

Description
Specifies the trend diagram in which the axis referenced with "TimeAxisIndex" is displayed.
Access in runtime Read and write

WinCC Engineering V18 – Programming reference

1022 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Syntax
Object.TimeAxisTrendWindow[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTrendControl

STRING
Optional. A value or a constant that specifies the name of the trend diagram.

See also
TrendWindowCount (Page 1127)
TimeAxisIndex (Page 1014)
OnlineTrendControl (Page 359)

TimeAxisVisible

Description
Specifies whether the time axis referenced with "TimeAxisIndex" is displayed in the object.
Access in runtime Read and write

Syntax
Object.TimeAxisVisible[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTrendControl

BOOLEAN
Optional.
TRUE if the referenced time axis is shown.
FALSE if the referenced time axis is hidden.

See also
TimeAxisIndex (Page 1014)
OnlineTrendControl (Page 359)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1023
VB scripting
1.5 VBS object model

TimeBase

Description
Specifies the time zone in which the time values are displayed.
Access in runtime Read and write

Syntax
Object.TimeBase[=TimeBase]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• FunctionTrendControl
• OnlineTableControl
• OnlineTrendControl
• UserArchiveControl

TimeBase
Optional. A value or a constant that specifies the time zone.

Value VB constant Explanation

0 hmiTimeBaseLocalTime‐ Local time
zone
1 hmiTimeBaseServerTime‐ Time zone of the server
zone
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
AlarmControl (Page 237)
FunctionTrendControl (Page 309)
OnlineTableControl (Page 347)
OnlineTrendControl (Page 359)
UserArchiveControl (Page 466)

WinCC Engineering V18 – Programming reference

1024 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

TimeColumnActualize

Description
Specifies whether the values of the time column referenced with "TimeColumnIndex" are
updated.
Access in runtime Read and write

Syntax
Object.TimeColumnActualize[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTableControl

BOOLEAN
Optional.
TRUE if the time column is updated.
FALSE if the time column is not updated. This setting is useful for comparing tables.

See also
OnlineTableControl (Page 347)

TimeColumnAdd

Description
Creates a new time column. The newly created time column is automatically referenced with
"TimeColumnIndex".
Access in runtime Read and write

Syntax
Object.TimeColumnAdd[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTableControl

STRING
Required. A value or a constant that specifies the name of the new time column with
"TimeColumnName".

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1025
VB scripting
1.5 VBS object model

See also
TimeColumnIndex (Page 1032)
OnlineTableControl (Page 347)

TimeColumnAlignment

Description
Specifies how the text in the time column referenced with "TimeColumnIndex" is aligned.
Access in runtime Read and write

Syntax
Object.TimeColumnAlignment [=HorizontalAlignment]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTableControl

HorizontalAlignment
Optional. A value or a constant that specifies how the text in the referenced time column is
aligned.

Value VB constant Explanation

0 hmiAlignmentLeft The text is left-justified.
1 hmiAlignmentCentered The text is centered.
2 hmiAlignmentRight The text is right-justified.

See also
OnlineTableControl (Page 347)

TimeColumnBackColor

Description
Specifies the background color of the time column referenced with "TimeColumnIndex".
Also set "UseColumnBackColor (Page 1146)" to "TRUE" and
"TimeColumnUseValueColumnColors (Page 1041)" to "FALSE".
Access in runtime Read and write

WinCC Engineering V18 – Programming reference

1026 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Syntax
Object.TimeColumnBackColor[=Color]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTableControl

Color
Optional. A value or a constant that specifies the background color of the selected time
column.

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
OnlineTableControl (Page 347)

TimeColumnBeginTime

Description
Specifies the start of the time range for the time column referenced with "TimeColumnIndex".
Access in runtime Read and write

Syntax
Object.TimeColumnBeginTime[=DateTime]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTableControl

DateTime
Optional. A value or a constant that specifies the starting time for the selected time column.

See also
OnlineTableControl (Page 347)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1027
VB scripting
1.5 VBS object model

TimeColumnCaption

Description
Specifies the label of the time column referenced with "TimeColumnIndex".
Access in runtime Read and write

Syntax
Object.TimeColumnCaption[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTableControl

STRING
Optional. A value or a constant that specifies the caption of the time column.

See also
OnlineTableControl (Page 347)

TimeColumnCount

Description
Specifies the number of configured time columns.
Access in runtime: Read and write

Syntax
Object.TimeColumnCount[=Int32]

Object
Required. A "ScreenItem" object with the following format:
• OnlineTableControl

Int32
Optional A value or a constant that specifies the number of configured time columns.

See also
OnlineTableControl (Page 347)

WinCC Engineering V18 – Programming reference

1028 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

TimeColumnDateFormat

Description
Specifies the date format for displaying the time column referenced with "TimeColumnIndex".
Access in runtime: Read and write

Syntax
Object.TimeColumnDateFormat[=STRING]

Object
Required. An object of the type "ScreenItem" with the format:
• OnlineTableControl

STRING
Optional. A value or a constant that specifies the date format for displaying the selected time
column.
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

Description
Defines the end of the time range of for a time column referenced with "TimeColumnIndex".
Access in runtime Read and write

Syntax
Object.TimeColumnBeginTime[=DateTime]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTableControl

DateTime
Optional. A value or constant that specifies the end time.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1029
VB scripting
1.5 VBS object model

See also
OnlineTableControl (Page 347)

TimeColumnForeColor

Description
Specifies the font color of the time column referenced with "TimeColumnIndex".
Also set "UseColumnForeColor (Page 1147)" to "TRUE" and
"TimeColumnUseValueColumnColors (Page 1041)" to "FALSE".
Access in runtime Read and write

Syntax
Object.TimeColumnForeColor[=Color]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTableControl

Color
Optional. A value or a constant that specifies the font color of the selected time column.

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
OnlineTableControl (Page 347)

TimeColumnHideText

Description
Specifies whether the content of the time column referenced with "TimeColumnIndex" is
displayed as text.
Access in runtime Read and write

WinCC Engineering V18 – Programming reference

1030 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Syntax
Object.TimeColumnHideText[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTableControl

BOOLEAN
Optional.
TRUE if the content is not displayed as text.
FALSE if the content is displayed as text.

See also
OnlineTableControl (Page 347)

TimeColumnHideTitleText

Description
Specifies whether the header of the time column referenced with "TimeColumnIndex" is
displayed as text.
Access in runtime Read and write

Syntax
Object.TimeColumnHideTitleText[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTableControl

BOOLEAN
Optional.
TRUE if the header is not displayed as text.
FALSE if the header is displayed as text.

See also
OnlineTableControl (Page 347)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1031
VB scripting
1.5 VBS object model

TimeColumnIndex

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.
Access in runtime: Read and write

Syntax
Object.TimeColumnIndex[=Int32]

Object
Required. An object of the type "ScreenItem" with the format:
• OnlineTableControl

Int32
Optional. A value or a constant that specifies, with the index, the time column to be edited.

TimeColumnLength

Description
Specifies the width of the time column referenced with "TimeColumnIndex".
Access in runtime Read and write

Syntax
Object.TimeColumnLength[=Int32]

Object
Required. An object of the type "ScreenItem" with the format:
• OnlineTableControl

Int32
Optional. A value or a constant that specifies the width of the selected time column.

See also
OnlineTableControl (Page 347)

WinCC Engineering V18 – Programming reference

1032 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

TimeColumnMeasurePoints

Description
Specifies the number of measuring points to be displayed in the time column referenced with
"TimeColumnIndex".
Access in runtime Read and write

Syntax
Object.TimeColumnMeasurePoints[=Int32]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTableControl

Int32
Optional. A value or constant that specifies the number of measurement points.

See also
OnlineTableControl (Page 347)

TimeColumnName

Description
Specifies the name of a time column referenced with "TimeColumnIndex".
Access in runtime Read and write

Syntax
Object.TimeColumnName[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTableControl

STRING
Optional. A value or a constant that specifies the name of the referenced time column.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1033
VB scripting
1.5 VBS object model

See also
TimeColumnIndex (Page 1032)
OnlineTableControl (Page 347)

TimeColumnRangeType

Description
Specifies the time range for a time column referenced with "TimeColumnIndex".
Access in runtime Read and write

Syntax
Object.TimeColumnRangeType[=TimeRangeMode]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTableControl

TimeRangeMode
Optional. A value or a constant that specifies the time range for the selected time column.

Value Description Explanation

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
OnlineTableControl (Page 347)

TimeColumnRemove

Description
Removes a time column referenced with its name.
Access in runtime Read and write

Syntax
Object.TimeColumnRemove[=STRING]

WinCC Engineering V18 – Programming reference

1034 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTableControl

STRING
Optional. A value or a constant that returns the name of the referenced time column to be
removed.

See also
OnlineTableControl (Page 347)

TimeColumnRename

Description
Specifies the new name of a time column referenced with "TimeColumnIndex".
Access in runtime Read and write

Syntax
Object.TimeColumnRename[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTableControl

STRING
Optional. A value or a constant that specifies the new name of the selected time column.

See also
TimeColumnIndex (Page 1032)
OnlineTableControl (Page 347)

TimeColumnRepos

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".

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1035
VB scripting
1.5 VBS object model

Access in runtime Read and write

Syntax
Object.TimeColumnRepos[=Int32]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTableControl

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.

See also
TimeColumnIndex (Page 1032)
TimeColumnCount (Page 1028)
OnlineTableControl (Page 347)

TimeColumns

Description
No access in runtime.

TimeColumnShowDate

Description
Specifies whether the time column referenced with "TimeColumnIndex" is displayed with date
and time.
Also set the date format with "TimeColumnDateFormat (Page 1029)".
Access in runtime Read and write

Syntax
Object.TimeColumnShowDate[=BOOLEAN]

WinCC Engineering V18 – Programming reference

1036 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTableControl

BOOLEAN
Optional.
TRUE, if date and time are displayed.
FALSE if only the time is displayed.

See also
OnlineTableControl (Page 347)

TimeColumnShowIcon

Description
Specifies whether the content of the time column referenced with "TimeColumnIndex" is
displayed as an icon.
Access in runtime: Read and write

Syntax
Object. [=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the format:
• OnlineTableControl

BOOLEAN
Optional.
TRUE if the content is displayed as an icon.
FALSE if the content is not displayed as an icon.

TimeColumnShowTitleIcon

Description
Specifies whether the header of the time column referenced with "TimeColumnIndex" is
displayed as an icon.
Access in runtime Read and write

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1037
VB scripting
1.5 VBS object model

Syntax
Object.TimeColumnShowTitleIcon[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTableControl

BOOLEAN
Optional.
TRUE if the header is shown as an icon.
FALSE if the header is not shown as an icon.

See also
OnlineTableControl (Page 347)

TimeColumnSort

Description
Specifies how a time column referenced with "TimeColumnIndex" is sorted.
Access in runtime Read and write

Syntax
Object.TimeColumnSort[=SortMode]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTableControl

SortMode
Optional. A value or a constant that specifies how the time column referenced in
"TimeColumnIndex" is sorted.

Value Description Explanation

0 No No sorting
1 Ascending Ascending order, starting at the lowest value.
2 Descending Descending order, starting at the highest value.

See also
OnlineTableControl (Page 347)

WinCC Engineering V18 – Programming reference

1038 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

TimeColumnSortIndex

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".
Access in runtime: Read and write

Syntax
Object.TimeColumnSortIndex[=Int32]

Object
Required. An object of the type "ScreenItem" with the format:
• OnlineTableControl

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

Description
Specifies the time format for displaying the time column referenced with "TimeColumnIndex".
Access in runtime Read and write

Syntax
Object.TimeColumnTimeFormat[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTableControl

STRING
Optional. A value or a constant that specifies the time format for displaying the selected time
column.

Value Explanation
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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1039
VB scripting
1.5 VBS object model

See also
OnlineTableControl (Page 347)

TimeColumnTimeRangeBase

Description
Specifies the time unit for calculating the time range displayed in the time column referenced
with "TimeColumnIndex".
The time range is calculated with a time unit and a time factor. The time factor is specified in
"TimeColumnTimeRangeFactor (Page 1040)".
Access in runtime Read and write

Syntax
Object.TimeColumnTimeRangeBase[=TagLoggingTimeUnit]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTableControl

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
OnlineTableControl (Page 347)

TimeColumnTimeRangeFactor

Description
Defines the factor for calculating the time range. Only integer factors are valid.
Access in runtime: Read and write

WinCC Engineering V18 – Programming reference

1040 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Syntax
Object.TimeColumnTimeRangeFactor[=Int16]

Object
Required. A "ScreenItem" object with the following format:
• OnlineTableControl

Int16
Optional A value or a constant that specifies the factor to determine the time range.

See also
OnlineTableControl (Page 347)

TimeColumnUseValueColumnColors

Description
Specifies whether the time column referenced with "TimeColumnIndex" is displayed in the
colors of the value column.
Access in runtime Read and write

Syntax
Object.TimeColumnUseValueColumnColors[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTableControl

BOOLEAN
Optional.
TRUE if the selected time column is displayed in the value column colors. The settings in
"TimeColumnBackColor (Page 1026)" and "TimeColumnForeColor (Page 1030)" are disabled.
FALSE if the selected time column is displayed in the colors specified in
"TimeColumnBackColor (Page 1026)" and "TimeColumnForeColor (Page 1030)"

See also
OnlineTableControl (Page 347)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1041
VB scripting
1.5 VBS object model

TimeColumnVisible

Description
Specifies whether the time column referenced with "TimeColumnIndex" is displayed in the table
view.
Access in runtime Read and write

Syntax
Object.TimeColumnVisible[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTableControl

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
TimeColumnIndex (Page 1032)
OnlineTableControl (Page 347)

TimeDisplayMode

Description
No access in runtime.

TimeStamp

Description
Returns the time stamp of the last read access of a tag in local time as DATE.
Access in Runtime: Read

Syntax
Object.TimeStamp

WinCC Engineering V18 – Programming reference

1042 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

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.

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
Set objTag = HMIRuntime.Tags("Tag11")
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
Set objTag = HMIRuntime.Tags("Tag1")
objTag.Read
MsgBox objTag.TimeStamp

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1043
VB scripting
1.5 VBS object model

See also
Tag (Page 229)

TimeStepBase

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.
Access in runtime: Read and write

Syntax
Object.TimeStepBase[=TimeStepBase]

Object
Required. A "ScreenItem" object with the following characteristics:
• OnlineTableControl

TimeStepBase
Optional. A value or a constant that specifies the time unit for the exactness of the time
stamp.

Value Designation Explanation

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.
250 Base250ms Specifies that the time range is the factor of the base with 250 ms.
500 Base500ms Specifies that the time range is the factor of the base with 500 ms.

See also
OnlineTableControl (Page 347)

TimeStepFactor

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.

WinCC Engineering V18 – Programming reference

1044 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Access in runtime: Read and write

Syntax
Object.TimeStepFactor[=Int32]

Object
Required. A "ScreenItem" object with the following characteristics:
• OnlineTableControl

Int32
Optional. A value or a constant that specifies the time factor for the exactness of the time
stamp.

See also
OnlineTableControl (Page 347)

TitleColor

Description
Specifies the background color of the table header.
Access in runtime Read and write

Syntax
Object.TitleColor[=Color]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• OnlineTableControl
• TrendRulerControl
• UserArchiveControl

Color
Optional. A value or a constant that specifies the background color of the table header.

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:

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1045
VB scripting
1.5 VBS object model

RGB (255, 0, 0)
You can also use the VBS color constants such as vbRed and vbGreen.

See also
AlarmControl (Page 237)
OnlineTableControl (Page 347)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

TitleCut

Description
Specifies whether the content of the fields in a title bar is to be shortened if the column is too
narrow.
Access in runtime: Read and write

Syntax
Object.TitleCut[=BOOLEAN]

Object
Required. A "ScreenItem" object with the following format:
• AlarmControl
• OnlineTableControl
• TrendRulerControl
• UserArchiveControl

BOOLEAN
Optional TRUE if the column headers in the title bar are shortened if the column is too
narrow.

See also
AlarmControl (Page 237)
OnlineTableControl (Page 347)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

WinCC Engineering V18 – Programming reference

1046 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

TitleDarkShadowColor

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 1051)" to "1".
Access in runtime Read and write

Syntax
Object.TitleDarkShadowColor[=Color]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• OnlineTableControl
• TrendRulerControl
• UserArchiveControl

Color
Optional. A value or a constant that specifies the color for the dark side of the 3D shading.

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
AlarmControl (Page 237)
OnlineTableControl (Page 347)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

TitleForeColor

Description
Specifies the text color for the table column and row headers of the object.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1047
VB scripting
1.5 VBS object model

Access in Runtime: Read and write

Syntax
Object.TitleForeColor[=Color]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• OnlineTableControl
• TrendRulerControl
• UserArchiveControl

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)
You can also use the VBS color constants such as vbRed and vbGreen.

See also
AlarmControl (Page 237)
OnlineTableControl (Page 347)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

TitleGridLineColor

Description
Specifies the color of the separation lines in the title bar of the table.
Access in runtime Read and write

Syntax
Object.TitleGridLineColor[=Color]

WinCC Engineering V18 – Programming reference

1048 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• OnlineTableControl
• TrendRulerControl
• UserArchiveControl

Color
Optional. A value or a constant that specifies the color of the separation lines in the title bar
of the table.

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
AlarmControl (Page 237)
OnlineTableControl (Page 347)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

TitleLightShadowColor

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 1051)" to "1".
Access in runtime Read and write

Syntax
Object.TitleLightShadowColor[=Color]

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1049
VB scripting
1.5 VBS object model

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• OnlineTableControl
• TrendRulerControl
• UserArchiveControl

Color
Optional. A value or a constant that specifies the color for the light side of the 3D shading.

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
AlarmControl (Page 237)
OnlineTableControl (Page 347)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

TitleSort

Description
Specifies how sorting by column header is triggered.
Access in runtime Read and write

Syntax
Object.TitleSort[=GridSortTrigger]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• OnlineTableControl

WinCC Engineering V18 – Programming reference

1050 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

• TrendRulerControl
• UserArchiveControl

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
AlarmControl (Page 237)
OnlineTableControl (Page 347)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

TitleStyle

Description
Specifies whether to use a shading color for the text in the column headers.
Access in runtime Read and write

Syntax
Object.TitleStyle[=GridHeaderStyle]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• OnlineTableControl
• TrendRulerControl
• UserArchiveControl

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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1051
VB scripting
1.5 VBS object model

See also
AlarmControl (Page 237)
OnlineTableControl (Page 347)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

Toggle

Description
Specifies whether the selected object engages after it has been operated in Runtime.
Access in runtime: Read and write

Syntax
Object.Toggle[=BOOLEAN]

Object
Required. A "ScreenItem" object with the following format:
• Button
• RoundButton*
*: Read access only

BOOLEAN
Optional. TRUE, if the selected object engages after it has been operated in runtime.

Tolerance

Description
Specifies the limit for the storage space display as of which a deviation will be reported.
Access in runtime: Read

Syntax
Object.Tolerance[=Int32]

Object
Required. An object of the type "ScreenItem" with the format:
• DiscSpaceView

WinCC Engineering V18 – Programming reference

1052 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

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
DiskSpaceView (Page 298)

ToleranceColor

Description
Specifies the colors in which the bars of the memory space display are shown as soon as the
tolerance range is exceeded.
Access in runtime Read

Syntax
Object.ToleranceColor[=Color]

Object
Required. An object of the type "ScreenItem" with the following format:
• 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
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
DiskSpaceView (Page 298)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1053
VB scripting
1.5 VBS object model

ToleranceLowerLimit

Description
Sets the low limit for tolerance 1.
Access in runtime: Read and write

Syntax
Object.ToleranceLowerLimit[=DOUBLE]

Object
Required. A "ScreenItem" object with the format:
• Bar

DOUBLE
Optional A value or a constant that specifies the low limit for tolerance 1.

Comments
The following values will be defined via the properties "ToleranceLowerLimit",
"ToleranceLowerLimitColor" and "ToleranceLowerLimitRelative":
• Limit
• Representation upon reaching the limit
• Type of evaluation

See also
Bar (Page 259)

ToleranceLowerLimitColor

Description
Specifies the color for the lower limit "ToleranceLowerLimit"".
The "ToleranceLowerLimitEnabled" property must have the value TRUE if the bar color is to
change once the limit has been reached.
Access in runtime Read and write

Syntax
Object.ToleranceLowerLimitColor[=Color]

WinCC Engineering V18 – Programming reference

1054 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

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
"ToleranceLowerLimit" ".

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
Bar (Page 259)

ToleranceLowerLimitEnabled

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".
Access in runtime: Read and write

Syntax
Object.ToleranceLowerLimitEnabled[=BOOLEAN]

Object
Required. A "ScreenItem" object with the following format:
• Bar

BOOLEAN
Optional TRUE, if the "ToleranceLowerLimit" limit is monitored.

See also
Bar (Page 259)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1055
VB scripting
1.5 VBS object model

ToleranceLowerLimitRelative

Description
Specifies whether the low limit "ToleranceLowerLimit" is evaluated as a percentage or as an
absolute value.
Access in runtime Read and write

Syntax
Object.ToleranceLowerLimitRelative[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• 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.

See also
Bar (Page 259)

ToleranceUpperLimit

Description
Sets the high limit for tolerance 1.
Access in runtime: Read and write

Syntax
Object.ToleranceUpperLimit[=DOUBLE]

Object
Required. A "ScreenItem" object with the format:
• Bar

DOUBLE
Optional A value or a constant that specifies the high limit for tolerance 1.

WinCC Engineering V18 – Programming reference

1056 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Comments
The following values will be specified via the properties "ToleranceUpperLimit",
"ToleranceUpperLimitColor" and "ToleranceUpperLimitRelative":
• Limit
• Representation upon reaching the limit
• Type of evaluation

See also
Bar (Page 259)

ToleranceUpperLimitColor

Description
Specifies the color for the high limit "ToleranceUpperLimit".
Access in runtime Read and write

Syntax
Object.ToleranceUpperLimitColor[=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 upper limit
"ToleranceUpperLimit"".

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
Bar (Page 259)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1057
VB scripting
1.5 VBS object model

ToleranceUpperLimitEnabled

Description
Specifies whether the "ToleranceUpperLimit"" limit is to be monitored.
Access in runtime: Read and write

Syntax
Object.ToleranceUpperLimitEnabled[=BOOLEAN]

Object
Required. A "ScreenItem" object with the following format:
• Bar

BOOLEAN
Optional TRUE, if the "ToleranceUpperLimit" limit is to be monitored.

Comments
The following values will be specified with the properties "ToleranceUpperLimit",",
"ToleranceUpperLimitColor" and "ToleranceUpperLimitRelative":
• Limit
• Representation upon reaching the limit
• Type of evaluation

See also
Bar (Page 259)

ToleranceUpperLimitRelative

Description
Specifies whether the higher limit "ToleranceUpperLimit"" is to be evaluated as a percentage or
as an absolute value.
Access in runtime Read and write

Syntax
Object.ToleranceUpperLimitRelative[=BOOLEAN]

WinCC Engineering V18 – Programming reference

1058 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Object
Required. An object of the type "ScreenItem" with the following format:
• 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 259)

ToolBar_ButtonsHeight

Description
No access in runtime.

ToolBar_ButtonsWidth

Description
No access in runtime.

ToolbarAlignment

Description
Specifies the position of the toolbar.
Access in runtime:
• RT Advanced: No access
• RT Professional: Read and write

Syntax
Object.ToolbarAlignment[=ToolbarPosition]

Object
Required. An object of the type "ScreenItem" with the format:
• AlarmControl
• FunctionTrendControl

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1059
VB scripting
1.5 VBS object model

• OnlineTableControl
• OnlineTrendControl
• TrendRulerControl
• UserArchiveControl
You have no access in runtime with the following format:
• 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

ToolbarBackColor

Description
Specifies the background color of the toolbar.
Also set "ToolbarUseBackColor (Page 1079)" to "TRUE".
Access in runtime Read and write

Syntax
Object.ToolbarBackColor[=Color]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• FunctionTrendControl
• OnlineTableControl
• OnlineTrendControl
• TrendRulerControl
• UserArchiveControl

Color
Optional. A value or a constant that specifies the background color of the toolbar.

WinCC Engineering V18 – Programming reference

1060 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

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
AlarmControl (Page 237)
FunctionTrendControl (Page 309)
OnlineTableControl (Page 347)
OnlineTrendControl (Page 359)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

ToolbarBackgroundColor

Description
No access in runtime.

ToolbarButtonActive

Description
Specifies whether the function linked to the button is activated in runtime. Clicking the button
in Runtime triggers the corresponding function.
Access in runtime Read and write

Syntax
Object.ToolbarButtonActive[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• FunctionTrendControl
• OnlineTableControl
• OnlineTrendControl

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1061
VB scripting
1.5 VBS object model

• TrendRulerControl
• UserArchiveControl

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
AlarmControl (Page 237)
FunctionTrendControl (Page 309)
OnlineTableControl (Page 347)
OnlineTrendControl (Page 359)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

ToolbarButtonAdd

Description
Creates a new user-defined button in the object's toolbar. The newly created button is
automatically referenced with "ToolbarButtonIndex".
Access in runtime Read and write

Syntax
Object.ToolbarButtonAdd[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• FunctionTrendControl
• OnlineTableControl
• OnlineTrendControl
• TrendRulerControl
• UserArchiveControl

WinCC Engineering V18 – Programming reference

1062 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

STRING
Required. A value or a constant that specifies the name of the new button in the toolbar with
"ToolbarButtonName".

See also
ToolbarButtonIndex (Page 1069)
AlarmControl (Page 237)
FunctionTrendControl (Page 309)
OnlineTableControl (Page 347)
OnlineTrendControl (Page 359)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

ToolbarButtonAuthorization

Description
Specifies the authorization for the selected key function. The authorizations are configured in
the user administration.
Access in runtime Read and write

Syntax
Object.ToolbarButtonAuthorization[=Int32]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• FunctionTrendControl
• OnlineTableControl
• OnlineTrendControl
• TrendRulerControl
• UserArchiveControl

Int32
Optional. A value or constant that specifies the authorization for the selected key function.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1063
VB scripting
1.5 VBS object model

See also
UserArchiveControl (Page 466)
TrendRulerControl (Page 441)
FunctionTrendControl (Page 309)
OnlineTableControl (Page 347)
OnlineTrendControl (Page 359)

ToolbarButtonBeginGroup

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.
Access in runtime Read and write

Syntax
Object.ToolbarButtonBeginGroup[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• FunctionTrendControl
• OnlineTableControl
• OnlineTrendControl
• TrendRulerControl
• UserArchiveControl

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
AlarmControl (Page 237)
FunctionTrendControl (Page 309)
OnlineTableControl (Page 347)
OnlineTrendControl (Page 359)

WinCC Engineering V18 – Programming reference

1064 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

TrendRulerControl (Page 441)

UserArchiveControl (Page 466)

ToolbarButtonClick

Description
Clicks a toolbar button. You call the function of the corresponding button using the ID of the
button.
Access in runtime:
• RT Advanced: No access
• RT Professional: Read and write

Syntax
Object.ToolbarButtonClick[=Int32]

Object
Required. An object of the type "ScreenItem" with the format:
• AlarmControl
• FunctionTrendControl
• OnlineTableControl
• OnlineTrendControl
• SysDiagControl*
• TrendRulerControl
• UserArchiveControl
*: Read access only

Int32
Optional. A value or a constant that specifies the ID of the button that is clicked.

ToolbarButtonCount

Description
Specifies the number of configured buttons in the toolbar.
Access in runtime Read and write

Syntax
Object.ToolbarButtonCount[=Int32]

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1065
VB scripting
1.5 VBS object model

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• FunctionTrendControl
• OnlineTableControl
• OnlineTrendControl
• TrendRulerControl
• UserArchiveControl

Int32
Optional. A value or a constant that specifies the number of configured buttons in the toolbar.

See also
AlarmControl (Page 237)
FunctionTrendControl (Page 309)
OnlineTableControl (Page 347)
OnlineTrendControl (Page 359)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

ToolbarButtonEnabled

Description
Enables operation of custom toolbar buttons.
Access in runtime: Read and write

Syntax
Object.ToolbarButtonEnabled[=BOOLEAN]

Object
Required. A "ScreenItem" object with the following format:
• AlarmControl
• FunctionTrendControl
• OnlineTableControl
• OnlineTrendControl
• TrendRulerControl
• UserArchiveControl

WinCC Engineering V18 – Programming reference

1066 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

BOOLEAN
Optional TRUE if operation is enabled for the selected user-defined key in the toolbar.

See also
AlarmControl (Page 237)
FunctionTrendControl (Page 309)
OnlineTableControl (Page 347)
OnlineTrendControl (Page 359)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

ToolbarButtonHeight

Description
No access in runtime.

ToolbarButtonHotKey

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 1080)" to "TRUE".
Access in runtime Read and write

Syntax
Object.ToolbarButtonHotKey[=Int32]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• FunctionTrendControl
• OnlineTableControl
• OnlineTrendControl
• TrendRulerControl
• UserArchiveControl

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1067
VB scripting
1.5 VBS object model

Int32
Optional. A value or a constant that specifies the shortcut for the selected button.

See also
TrendIndex (Page 1100)
AlarmControl (Page 237)
FunctionTrendControl (Page 309)
OnlineTableControl (Page 347)
OnlineTrendControl (Page 359)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

ToolbarButtonID

Description
References a button with its ID. To access the properties of a status bar element, you need to set
""ToolbarButtonID"".
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".
Access in runtime Read and write

Syntax
Object.ToolbarButtonID[=Int32]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• FunctionTrendControl
• OnlineTableControl
• OnlineTrendControl
• TrendRulerControl
• UserArchiveControl

Int32
Optional. A value or a constant that specifies, with the ID, the toolbar buttons to be edited.

WinCC Engineering V18 – Programming reference

1068 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

See also
ToolbarButtonClick (Page 1065)
AlarmControl (Page 237)
FunctionTrendControl (Page 309)
OnlineTableControl (Page 347)
OnlineTrendControl (Page 359)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

ToolbarButtonIndex

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.
Access in runtime Read and write

Syntax
Object.ToolbarButtonIndex[=Int32]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• FunctionTrendControl
• OnlineTableControl
• OnlineTrendControl
• TrendRulerControl
• UserArchiveControl

Int32
Optional. A value or a constant that specifies, with the index, the button to be edited.

See also
ToolbarButtonCount (Page 1065)
AlarmControl (Page 237)
FunctionTrendControl (Page 309)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1069
VB scripting
1.5 VBS object model

OnlineTableControl (Page 347)

OnlineTrendControl (Page 359)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

ToolbarButtonLocked

Description
Specifies whether the locked, pressed state of a user-defined button referenced with
"ToolbarButtonIndex" is displayed.
Access in runtime Read and write

Syntax
Object.ToolbarButtonLocked[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• FunctionTrendControl
• OnlineTableControl
• OnlineTrendControl
• TrendRulerControl
• UserArchiveControl

BOOLEAN
TRUE if the pressed state is displayed for the referenced user-defined button in the toolbar.

See also
AlarmControl (Page 237)
FunctionTrendControl (Page 309)
OnlineTableControl (Page 347)
OnlineTrendControl (Page 359)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

WinCC Engineering V18 – Programming reference

1070 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

ToolbarButtonName

Description
Specifies the name of a user-defined button referenced with "ToolbarButtonIndex".
Access in runtime Read and write

Syntax
Object.ToolbarButtonName[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• FunctionTrendControl
• OnlineTableControl
• OnlineTrendControl
• TrendRulerControl
• UserArchiveControl

STRING
Optional. A value or a constant that specifies the name of the referenced user-defined
button.

See also
ToolbarButtonIndex (Page 1069)
AlarmControl (Page 237)
FunctionTrendControl (Page 309)
OnlineTableControl (Page 347)
OnlineTrendControl (Page 359)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

ToolbarButtonRemove

Description
Removes a user-defined button referenced with its name.
Access in runtime Read and write

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1071
VB scripting
1.5 VBS object model

Syntax
Object.ToolbarButtonRemove[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• FunctionTrendControl
• OnlineTableControl
• OnlineTrendControl
• TrendRulerControl
• UserArchiveControl

STRING
Optional. A value or a constant that specifies the name of the referenced user-defined button
to be removed.

See also
AlarmControl (Page 237)
FunctionTrendControl (Page 309)
OnlineTableControl (Page 347)
OnlineTrendControl (Page 359)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

ToolbarButtonRename

Description
Specifies the new name of a user-defined button referenced with "ToolbarButtonIndex".
Access in runtime Read and write

Syntax
Object.ToolbarButtonRename[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• FunctionTrendControl
• OnlineTableControl

WinCC Engineering V18 – Programming reference

1072 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

• OnlineTrendControl
• TrendRulerControl
• UserArchiveControl

STRING
Optional. A value or a constant that specifies the new name of the selected user-defined
button.

See also
ToolbarButtonIndex (Page 1069)
AlarmControl (Page 237)
FunctionTrendControl (Page 309)
OnlineTableControl (Page 347)
OnlineTrendControl (Page 359)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

ToolbarButtonRepos

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".
Access in runtime Read and write

Syntax
Object.ToolbarButtonRepos[=Int32]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• FunctionTrendControl
• OnlineTableControl
• OnlineTrendControl
• TrendRulerControl
• UserArchiveControl

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1073
VB scripting
1.5 VBS object model

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 1065)
ToolbarButtonIndex (Page 1069)
AlarmControl (Page 237)
FunctionTrendControl (Page 309)
OnlineTableControl (Page 347)
OnlineTrendControl (Page 359)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

ToolbarButtons

Description
No access in runtime.

ToolbarButtonSettings

Description
No access in runtime.

ToolbarButtonsForMigration

Description
No access in runtime.

ToolbarButtonTooltipText

Description
Specifies the tooltip text for the user-defined button in the toolbar.
Access in runtime: Read and write

WinCC Engineering V18 – Programming reference

1074 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Syntax
Object.ToolbarButtonTooltipText[=STRING]

Object
Required. A "ScreenItem" object with the following format:
• AlarmControl
• FunctionTrendControl
• OnlineTableControl
• OnlineTrendControl
• TrendRulerControl
• UserArchiveControl

STRING
Optional A value or a constant that specifies the tooltip text for the selected user-defined
button.

See also
AlarmControl (Page 237)
FunctionTrendControl (Page 309)
OnlineTableControl (Page 347)
OnlineTrendControl (Page 359)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

ToolbarButtonUserDefined

Description
Specifies whether the project engineer has added the toolbar button as new user-defined
button.
Access in runtime: Read and write

Syntax
Object.ToolbarButtonUserDefined[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• FunctionTrendControl

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1075
VB scripting
1.5 VBS object model

• OnlineTableControl
• OnlineTrendControl
• TrendRulerControl
• UserArchiveControl

Boolean
Optional.
TRUE if the toolbar key is user-defined.
FALSE if the toolbar key is specified by the system.

See also
AlarmControl (Page 237)
FunctionTrendControl (Page 309)
OnlineTableControl (Page 347)
OnlineTrendControl (Page 359)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

ToolbarButtonVisible

Description
Specifies whether the button referenced with "ToolbarButtonIndex" is displayed in the toolbar.
Access in runtime Read and write

Syntax
Object.ToolbarButtonVisible[=<BOOLEAN>]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• FunctionTrendControl
• OnlineTableControl
• OnlineTrendControl
• TrendRulerControl
• UserArchiveControl

WinCC Engineering V18 – Programming reference

1076 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

BOOLEAN
Optional.
TRUE if the referenced button is shown.
FALSE if the referenced button is hidden.

See also
ToolbarButtonIndex (Page 1069)
AlarmControl (Page 237)
FunctionTrendControl (Page 309)
OnlineTableControl (Page 347)
OnlineTrendControl (Page 359)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

ToolbarButtonWidth

Description
No access in runtime.

ToolbarEnabled

Description
No access in runtime.

ToolbarHeight

Description
No access in runtime.

ToolbarIconStyle

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1077
VB scripting
1.5 VBS object model

ToolbarLeft

Description
No access in runtime.

ToolbarShowTooltips

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".
Access in runtime Read and write

Syntax
Object.ToolbarShowTooltips[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• FunctionTrendControl
• OnlineTableControl
• OnlineTrendControl
• TrendRulerControl
• UserArchiveControl

BOOLEAN
Optional.
TRUE if the tooltips are shown.
FALSE if the tooltips are not shown.

See also
AlarmControl (Page 237)
FunctionTrendControl (Page 309)
OnlineTableControl (Page 347)
OnlineTrendControl (Page 359)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

WinCC Engineering V18 – Programming reference

1078 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

ToolbarStyle

Description
No access in runtime.

ToolbarTop

Description
No access in runtime.

ToolbarUseBackColor

Description
Specifies whether the background color for the toolbar is shown.
Access in runtime Read and write

Syntax
Object.ToolbarUseBackColor[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• FunctionTrendControl
• OnlineTableControl
• OnlineTrendControl
• TrendRulerControl
• UserArchiveControl

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
AlarmControl (Page 237)
FunctionTrendControl (Page 309)
OnlineTableControl (Page 347)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1079
VB scripting
1.5 VBS object model

OnlineTrendControl (Page 359)

TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

ToolbarUseHotKeys

Description
Specifies whether the hotkeys are activated for buttons in the toolbar. The hot keys are defined
for each button with "ToolbarButtonHotKey (Page 1067)".
Access in runtime Read and write

Syntax
Object.ToolbarUseHotKeys[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• FunctionTrendControl
• OnlineTableControl
• OnlineTrendControl
• TrendRulerControl
• UserArchiveControl

BOOLEAN
Optional. TRUE if the hot keys are activated.

See also
AlarmControl (Page 237)
FunctionTrendControl (Page 309)
OnlineTableControl (Page 347)
OnlineTrendControl (Page 359)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

WinCC Engineering V18 – Programming reference

1080 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

ToolbarVisible

Description
Specifies whether the toolbar of the control is displayed.
Access in runtime Read and write

Syntax
Object.ToolbarVisible[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• FunctionTrendControl
• OnlineTableControl
• OnlineTrendControl
• TrendRulerControl
• UserArchiveControl

BOOLEAN
Optional.
TRUE if the toolbar is displayed.
FALSE if the toolbar is not displayed.

See also
AlarmControl (Page 237)
FunctionTrendControl (Page 309)
OnlineTableControl (Page 347)
OnlineTrendControl (Page 359)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

ToolbarWidth

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1081
VB scripting
1.5 VBS object model

ToolTipText

Description
Specifies the tooltip text.
Access in runtime: Read

Syntax
Object.ToolTipText[=STRING]

ToolTipText
Required. An object of the type "ScreenItem" with the format:
• Bar
• Button
• CheckBox
• Circle
• CircleSegment
• CircularArc
• ComboBox
• Connector
• Ellipse
• EllipseSegment
• EllipticalArc
• GraphicIOField
• GraphicView
• IOField
• Line
• ListBox
• MultiLineEdit
• OptionGroup
• Polygon
• Polyline
• Rectangle
• RoundButton *
• StatusForce *
• Switch *
• SymbolicIOField *

WinCC Engineering V18 – Programming reference

1082 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

• TextField
• TubeArcObject
• TubeDoubleTeeObject
• TubeTeeObject
• Tubepolyline
• WindowSlider *
* Read access only

STRING
Optional. A value or a constant that specifies the tooltip text.

Top

Description
Specifies the value of the Y coordinate.
Access in runtime: Read

Syntax
Object.Top[=Int32]

Object
Required. An object of the type "ScreenItem" with the format:
• AlarmControl
• AlarmView
• Bar
• BatteryView
• Button
• ChannelDiagnose
• CheckBox
• Circle
• CircleSegment
• CircularArc
• Clock
• ComboBox
• Connector
• DateTimeField
• DiscSpaceView

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1083
VB scripting
1.5 VBS object model

• Ellipse
• EllipseSegment
• EllipticalArc
• FunctionTrendControl
• Gauge
• GraphicIOField
• GraphicView
• HTMLBrowser
• IOField
• Line
• ListBox
• MediaPlayer
• MultiLineEdit
• OnlineTableControl
• OnlineTrendControl
• OptionGroup
• PLCCodeViewer
• Polygon
• Polyline
• ProDiagOverview
• ProtectedAreaNameView
• RangeLabelView
• RangeQualityView
• RecipeView *
• Rectangle
• RoundButton *
• S7GraphOverview
• ScreenWindow
• Slider **
• SmartClientView
• StatusForce *
• Switch *
• SymbolLibrary
• SymbolicIOField *
• SysDiagControl *

WinCC Engineering V18 – Programming reference

1084 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

• TextField
• TrendRulerControl
• TrendView *
• TubeArcObject
• TubeDoubleTeeObject
• TubeTeeObject
• Tubepolyline
• UserArchiveControl
• UserView **
• WLanQualityView
• WindowSlider *
• ZoneLabelView
• ZoneQualityView
* Read access only
** RT Professional read access only
You have no access in runtime with the following format:
• ApplicationWindow

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

Description
No access in runtime.

TopOffset

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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1085
VB scripting
1.5 VBS object model

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 738)" and
"VerticalScrollbarPosition (Page 1202) properties for the offset.
Access in Runtime: Read and write

Syntax
Object.TopOffset[=Int32]

Object
Required. An object of the type "ScreenItem" with the following format:
• 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.

See also
ScreenWindow (Page 404)

Total

Description
Specifies the memory capacity.
Access in runtime: Read

Syntax
Object.Total[=DOUBLE]

Object
Required. An object of the type "ScreenItem" with the format:
• DiskSpaceView

DOUBLE
Optional. A value or a constant that specifies the memory capacity.

WinCC Engineering V18 – Programming reference

1086 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

TransitionHeaderFont

Description
Specifies the font in the information area of this PLC code display.
Access in runtime: Read and write

Syntax
Object.TransitionHeaderFont[=Font]

Object
Required. A "ScreenItem" object with the following characteristics:
• PLCCodeViewer

Font
Optional. A value or a constant that specifies the font.

See also
PLCCodeViewer (Page 376)

Transparency

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.
Access in runtime: Read and write

Syntax
Object.Transparency[=Int32]

Object
Required. An object of the type "ScreenItem" with the format:
• Bar
• Button
• CheckBox
• Circle

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1087
VB scripting
1.5 VBS object model

• CircleSegment
• CircularArc
• Clock
• ComboBox
• Connector
• Ellipse
• EllipseSegment
• EllipticalArc
• Gauge
• GraphicIOField
• GraphicView
• IOField
• Line
• ListBox
• MultiLineEdit
• OptionGroup
• Polygon
• Polyline
• Rectangle
• RoundButton *
• Slider *
• SymbolicIOField *
• TextField
• TubeArcObject
• TubeDoubleTeeObject
• 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.

WinCC Engineering V18 – Programming reference

1088 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

TransparentColor

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.
Access in runtime: Read and write

Syntax
Object.TransparentColor[=Color]

Object
Required. An object of the type "ScreenItem" with the format:
• GraphicIOField
• GraphicView

Color
Optional. A value or a constant that specifies the color that will be shown transparent.

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.

TransparentColorDeactivatedPicture

Description
Sets the color of the assigned bitmap object to "transparent" for the "disabled" status.
Access in runtime: Read

Syntax
Object.TransparentColorDeactivatedPicture[=Color]

Object
Required. A "ScreenItem" object with the following format:
• RoundButton

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1089
VB scripting
1.5 VBS object model

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
RoundButton (Page 398)

TransparentColorPictureOff

Description
Specifies which color of the allocated bitmap object will be set to transparent" for the "off" status.
Access in runtime Read and write

Syntax
Object.TransparentColorPictureOff[=Color]

Object
Required. An object of the type "ScreenItem" with the following format:
• 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
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)

WinCC Engineering V18 – Programming reference

1090 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

You can also use the VBS color constants such as vbRed and vbGreen.

TransparentColorPictureOn

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".
Access in runtime Read and write

Syntax
Object.TransparentColorPictureOn[=Color]

Object
Required. An object of the type "ScreenItem" with the following format:
• 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 "on" status.

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.

TrendActualize

Description
Specifies whether the selected trend is updated.
Access in runtime Read and write

Syntax
Object.TrendActualize[=BOOLEAN]

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1091
VB scripting
1.5 VBS object model

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl

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
FunctionTrendControl (Page 309)

TrendAdd

Description
Creates a new trend. The newly created trend is automatically referenced with "TrendIndex".
Access in runtime: Read and write

Syntax
Object.TrendAdd[=STRING]

Object
Required. An object of the type "ScreenItem" with the format:
• FunctionTrendControl
• OnlineTrendControl

STRING
Required. A value or a constant that specifies the name of the new trend with "TrendName".

TrendAutoRangeBeginTagName

Description
Specifies a tag that defines the start value of the data range of the trend. You specify additionally
using the "TrendAutoRangeSource (Page 1095)" property that the data range of the trend is
determined dynamically.
Access in runtime: Read and write

WinCC Engineering V18 – Programming reference

1092 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Syntax
Object.TrendAutoRangeBeginTagName[=STRING]

Object
Required. A "ScreenItem" object with the following characteristics:
• OnlineTrendControl

STRING
Optional. A value or a constant that specifies the tag for the start value.

See also
OnlineTrendControl (Page 359)

TrendAutoRangeBeginValue

Description
Specifies the start value of the data range of the trend. You specify additionally using the
"TrendAutoRangeSource (Page 1095)" property that the data range of the trend is set statically.
Access in runtime: Read and write

Syntax
Object.TrendAutoRangeBeginValue[=DOUBLE]

Object
Required. A "ScreenItem" object with the following characteristics:
• OnlineTrendControl

DOUBLE
Optional. A value or a constant that specifies the start value of the data range of the trend.

See also
OnlineTrendControl (Page 359)

TrendAutoRangeEndTagName

Description
Specifies a tag that defines the end value of the data range of the trend. You specify additionally
using the "TrendAutoRangeSource (Page 1095)" property that the data range of the trend is
determined dynamically.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1093
VB scripting
1.5 VBS object model

Access in runtime: Read and write

Syntax
Object.TrendAutoRangeEndTagName[=STRING]

Object
Required. A "ScreenItem" object with the following characteristics:
• OnlineTrendControl

STRING
Optional. A value or a constant that specifies the tag for the end value.

See also
OnlineTrendControl (Page 359)

TrendAutoRangeEndValue

Description
Specifies the end value of the data range of the trend. You specify additionally using the
"TrendAutoRangeSource (Page 1095)" property that the data range of the trend is set statically.
Access in runtime: Read and write

Syntax
Object.TrendAutoRangeEndValue[=DOUBLE]

Object
Required. A "ScreenItem" object with the following characteristics:
• OnlineTrendControl

DOUBLE
Optional. A value or a constant that specifies the end value of the data range of the trend.

See also
OnlineTrendControl (Page 359)

WinCC Engineering V18 – Programming reference

1094 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

TrendAutoRangeSource

Description
Specifies how the automatic data range of the trend data is determined.
Access in runtime: Read and write

Syntax
Object.TrendAutoRangeSource[=AutorangeSourceType]

Object
Required. An object of the type "ScreenItem" with the format:
• OnlineTrendControl

AutorangeSourceType
Optional. A value or a constant that specifies the type of data range.
The following settings are available:

Value Designation Description

x Adapt automatically Specifies that the displayed value range is automatically adap‐
ted to the current values.
1 Dynamic range Specifies that the low limit and high limit of the displayed
value 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 1092)" and "TrendAu‐
toRangeEndTagName (Page 1093)" properties.
2 Static range Specifies that the displayed value range is defined by the con‐
figuration 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 1093)" and "TrendAutoR‐
angeEndValue (Page 1094)" properties.

TrendBeginTime

Description
Defines the start time of the time range for data transfer to the selected trend.
Access in runtime: Read and write

Syntax
Object.TrendBeginTime[=DateTime]

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1095
VB scripting
1.5 VBS object model

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl

DateTime
Optional. Defines the start time for data supply for the selected trend.

See also
FunctionTrendControl (Page 309)

TrendColor

Description
Specifies the color of the trend line of a referenced trend of the trend view.
Access in Runtime: Read and write

Syntax
Object.TrendColor[=Color]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl
• OnlineTrendControl

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)
You can also use the VBS color constants such as vbRed and vbGreen.

WinCC Engineering V18 – Programming reference

1096 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

See also
TrendIndex (Page 1100)
FunctionTrendControl (Page 309)
OnlineTrendControl (Page 359)

TrendCount

Description
Specifies the number of configured trends.
Access in runtime Read and write

Syntax
Object.TrendCount[=Int32]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl
• OnlineTrendControl

Int32
Optional. A value or a constant that specifies the number of configured trends.

See also
FunctionTrendControl (Page 309)
OnlineTrendControl (Page 359)

TrendEndTime

Description
Defines the end of the time range for data connections of a selected trend.
Access in runtime: Read and write

Syntax
Object.TrendEndTime[=DateTime]

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1097
VB scripting
1.5 VBS object model

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl

DateTime
Optional. Specifies the end time for data supply for the selected trend.

See also
FunctionTrendControl (Page 309)

TrendExtendedColorSet

Description
Specifies whether the point and fill colors of the trend are shown.
Access in runtime Read and write

Syntax
Object.TrendExtendedColorSet[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl
• OnlineTrendControl

BOOLEAN
Optional.
TRUE if the settings in "TrendFillColor (Page 1099)" and "TrendPointColor (Page 1107)" are
effective.
FALSE if the settings for point and fill color are not effective.

See also
FunctionTrendControl (Page 309)
OnlineTrendControl (Page 359)

TrendFill

Description
Specifies whether the area below the trend is shown filled.

WinCC Engineering V18 – Programming reference

1098 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

If "TrendExtendedColorSet (Page 1098)" is set to "FALSE", the trend color is also used as the fill
color.
Access in runtime Read and write

Syntax
Object.TrendFill[=BOOLEAN]

Object
Required. A "ScreenItem" object with the following format:
• FunctionTrendControl
• OnlineTrendControl

BOOLEAN
Optional.
TRUE if the area beneath the trend is filled.
FALSE if the trend is not shown filled.

See also
FunctionTrendControl (Page 309)
OnlineTrendControl (Page 359)

TrendFillColor

Description
Defines the fill color of the trend.
The setting is effective if the properties "TrendFill (Page 1098)" and "TrendExtendedColorSet
(Page 1098)" are also set to "TRUE".
Access in runtime Read and write

Syntax
Object.TrendFillColor[=Color]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl
• OnlineTrendControl

Color
Optional. A value or a constant that specifies the fill color of the selected trend.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1099
VB scripting
1.5 VBS object model

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
FunctionTrendControl (Page 309)
OnlineTrendControl (Page 359)

TrendIndex

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.
Access in runtime Read and write

Syntax
Object.TrendIndex[=Int32]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl
• OnlineTrendControl

Int32
Optional. A value or a constant that specifies, with the index, the trend to be edited.

See also
TrendCount (Page 1097)
FunctionTrendControl (Page 309)
OnlineTrendControl (Page 359)

WinCC Engineering V18 – Programming reference

1100 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

TrendIndicatorColor

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".
Access in runtime Read and write

Syntax
Object.TrendIndicatorColor[=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 of the trend indicator.

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
Bar (Page 259)

TrendLabel

Description
Defines the label text for a trend referenced with "TrendIndex".
Access in runtime: Read and write

Syntax
Object.TrendLabel[=STRING]

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1101
VB scripting
1.5 VBS object model

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl
• OnlineTrendControl

STRING
Optional. A value or a constant that specifies the label text for the referenced trend.

See also
TrendIndex (Page 1100)
FunctionTrendControl (Page 309)
OnlineTrendControl (Page 359)

TrendLineStyle

Example
Specifies which line type is used for display of the trend.
Access in runtime Read and write

Syntax
Object.TrendLineStyle[=LineStyle]

Object
Required. An object of the type "ScreenItem" with the format:
• FunctionTrendControl
• OnlineTrendControl

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.

WinCC Engineering V18 – Programming reference

1102 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

See also
FunctionTrendControl (Page 309)
OnlineTrendControl (Page 359)

TrendLineType

Description
Specifies how the trend is displayed.
Access in runtime Read and write

Syntax
Object.TrendLineType[=TrendLineTypeScada]

Object
Required. An object of the type "ScreenItem" with the format:
• FunctionTrendControl
• OnlineTrendControl

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
FunctionTrendControl (Page 309)
OnlineTrendControl (Page 359)

TrendLineWidth

Description
Specifies the line thickness of the selected trend in pixels.
Access in runtime: Read and write

Syntax
Object.TrendLineWidth[=Int32]

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1103
VB scripting
1.5 VBS object model

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl
• OnlineTrendControl

Int32
Optional. A value or a constant that specifies the line weight of the selected trend in pixels.

See also
FunctionTrendControl (Page 309)
OnlineTrendControl (Page 359)

TrendLowerLimit

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 1105)".
Using the "TrendLowerLimitColoring (Page 1105)" property, specify additionally that the
display of the low limit violation is activated.
Access in runtime Read and write

Syntax
Object.TrendLowerLimit[=DOUBLE]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl
• OnlineTrendControl

DOUBLE
Optional. A value or a constant that specifies the lower limit for a tag displayed in a trend
view.

See also
TrendIndex (Page 1100)
FunctionTrendControl (Page 309)
OnlineTrendControl (Page 359)

WinCC Engineering V18 – Programming reference

1104 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

TrendLowerLimitColor

Description
Specifies the color that marks the trend values that are below the value of "TrendLowerLimit
(Page 1104)".
The setting is effective if the "TrendLowerLimitColoring (Page 1105)" property has the value
"TRUE".
Access in runtime: Read and write

Syntax
Object.TrendLowerLimitColor[=Color]

Object
Required. An object of the type "ScreenItem" with the format:
• FunctionTrendControl
• OnlineTrendControl

Color
Optional. A value or a constant that specifies the color of trend values below the
"TrendLowerLimit (Page 1104)" value.

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.

TrendLowerLimitColoring

Description
Specifies whether "TrendLowerLimitColor" is used to identify tag values which are less than the
value of "TrendLowerLimit".
Access in runtime: Read and write

Syntax
Object.TrendLowerLimitColoring[=BOOLEAN]

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1105
VB scripting
1.5 VBS object model

Object
Required. An object of the type "ScreenItem" with the format:
• FunctionTrendControl
• OnlineTrendControl

BOOLEAN
Optional.
TRUE if the "TrendLowerLimitColor" property is effective.
FALSE if the "TrendLowerLimitColor" property is not effective.

TrendMeasurePoints

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.
Access in runtime: Read and write

Syntax
Object.TrendMeasurePoints[=Int32]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl

Int32
Optional. A value or a constant that specifies the number of measurement points or value
pairs for the selected trend.

See also
FunctionTrendControl (Page 309)

TrendName

Description
Specifies the name of a trend referenced with "TrendIndex".
Access in runtime Read and write

WinCC Engineering V18 – Programming reference

1106 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Syntax
Object.TrendName[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl
• OnlineTrendControl

STRING
Optional. A value or a constant that specifies the name of the referenced trend.

See also
TrendIndex (Page 1100)
FunctionTrendControl (Page 309)
OnlineTrendControl (Page 359)

TrendPointColor

Description
Specifies the color of the dots on the reference trend.
The setting is effective if the "TrendExtendedColorSet (Page 1098)" property has the value
"TRUE".
Access in runtime Read and write

Syntax
Object.TrendPointColor[=Color]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl
• OnlineTrendControl

Color
Optional. A value or a constant that specifies the color of the dots in the referenced trend.

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:

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1107
VB scripting
1.5 VBS object model

RGB (255, 0, 0)
You can also use the VBS color constants such as vbRed and vbGreen.

See also
TrendIndex (Page 1100)
FunctionTrendControl (Page 309)
OnlineTrendControl (Page 359)

TrendPointStyle

Description
Specifies how the trend points are displayed.
Access in runtime Read and write

Syntax
Object.TrendPointStyle[=PointStyle]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl
• OnlineTrendControl

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
FunctionTrendControl (Page 309)
OnlineTrendControl (Page 359)

WinCC Engineering V18 – Programming reference

1108 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

TrendPointWidth

Description
Specifies the dot weight in pixels. You can only define the dot weight for "square" and "circular"
dots.
Access in runtime: Read and write

Syntax
Object.TrendPointWidth[=Int32]

Object
Required. A "ScreenItem" object with the following format:
• FunctionTrendControl
• OnlineTrendControl

Int32
Optional A value or a constant that specifies the dot weight of the selected trend in pixels.

See also
FunctionTrendControl (Page 309)
OnlineTrendControl (Page 359)

TrendProvider

Description
Specifies the data source for a selected trend.
Access in runtime Read and write

Syntax
Object.TrendProvider[=DataSourceType]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl
• OnlineTrendControl

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1109
VB scripting
1.5 VBS object model

DataSourceType
Optional. A value or a constant that specifies the data source for the selected trend.

Value Description Explanation

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
FunctionTrendControl (Page 309)
OnlineTrendControl (Page 359)

TrendProviderCLSID

Description
Specifies the provider CLSID of the data for a trend.
Access in runtime Read and write

Syntax
Object.TrendProviderCLSID[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl
• OnlineTrendControl

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}

WinCC Engineering V18 – Programming reference

1110 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

See also
FunctionTrendControl (Page 309)
OnlineTrendControl (Page 359)

TrendRangeType

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.
Access in runtime Read and write

Syntax
Object.TrendRangeType[=TimeRangeMode]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl

TimeRangeMode
Optional. A value or a constant that specifies the time range during which the selected trend
is supplied with data.

Value Description Explanation

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
FunctionTrendControl (Page 309)

TrendRemove

Description
Removes a trend referenced with its name.
Access in runtime Read and write

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1111
VB scripting
1.5 VBS object model

Syntax
Object.TrendRemove[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl
• OnlineTrendControl

STRING
Optional. A value or a constant that specifies the name of the referenced trend to be
removed.

See also
FunctionTrendControl (Page 309)
OnlineTrendControl (Page 359)

TrendRename

Description
Specifies the new name of a trend referenced with "TrendIndex".
Access in runtime Read and write

Syntax
Object.TrendRename[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl
• OnlineTrendControl

STRING
Optional. A value or a constant that specifies the new name of the selected trend.

See also
TrendIndex (Page 1100)
FunctionTrendControl (Page 309)
OnlineTrendControl (Page 359)

WinCC Engineering V18 – Programming reference

1112 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

TrendRepos

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".
Access in runtime Read and write

Syntax
Object.TrendRepos[=Int32]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl
• OnlineTrendControl

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
TrendIndex (Page 1100)
TrendCount (Page 1097)
FunctionTrendControl (Page 309)
OnlineTrendControl (Page 359)

Trends

Description
No access in runtime.

TrendSelectTagName

Description
Specifies that the dialog for selecting the tag name for the data source of the value axis is
displayed initially in runtime.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1113
VB scripting
1.5 VBS object model

Access in runtime: Read and write

Syntax
Object.TrendSelectTagName[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the format:
• OnlineTrendControl

BOOLEAN
Optional.
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

Description
Specifies that the dialog for selecting the tag name of the data source of the x-axis is displayed
initially in runtime.
Access in runtime Read and write

Syntax
Object.TrendSelectTagNameX[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl

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
TrendIndex (Page 1100)
FunctionTrendControl (Page 309)

WinCC Engineering V18 – Programming reference

1114 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

TrendSelectTagNameY

Description
Specifies that the dialog for selecting the tag name for the data source of the Y axis is displayed
initially in runtime.
Access in runtime Read and write

Syntax
Object.TrendSelectTagNameY[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl

BOOLEAN
Optional. TRUE if the dialog for selecting the tag name of the data source of the Y-axis is
displayed in the screen.

See also
TrendIndex (Page 1100)
FunctionTrendControl (Page 309)

TrendsForPrinting

Description
No access in runtime.

TrendTagName

Description
Specifies the name of the tag that supplies the value axis with data.
Access in runtime: Read and write

Syntax
Object.TrendTagName[=STRING]

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1115
VB scripting
1.5 VBS object model

Object
Required. An object of the type "ScreenItem" with the format:
• OnlineTrendControl

STRING
Optional. A value or a constant that specifies the name of the tag for the value axis.

TrendTagNameX

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.
Access in runtime: Read and write

Syntax
Object.TrendTagNameX[=STRING]

Object
Required. A "ScreenItem" object with the following format:
• FunctionTrendControl

STRING
Optional A value or a constant that specifies the name of the HMI tag or column for the X
axis.

See also
FunctionTrendControl (Page 309)

TrendTagNameY

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.
Access in runtime: Read and write

Syntax
Object.TrendTagNameY[=STRING]

WinCC Engineering V18 – Programming reference

1116 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Object
Required. A "ScreenItem" object with the following format:
• FunctionTrendControl

STRING
Optional A value or a constant that specifies the name of the HMI tag or column for the Y axis.

See also
FunctionTrendControl (Page 309)

TrendTimeAxis

Description
Specifies the time axis to be used for the selected trend.
Access in runtime Read and write

Syntax
Object.TrendTimeAxis[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTrendControl

STRING
Optional. A value or a constant that specifies the time axis for the selected trend.

See also
TimeAxisCount (Page 1012)
OnlineTrendControl (Page 359)

TrendTimeRangeBase

Description
Specifies the time unit for calculating the time range.
Access in runtime Read and write

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1117
VB scripting
1.5 VBS object model

Syntax
Object.TrendTimeRangeBase[=TagLoggingTimeUnit]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl

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
FunctionTrendControl (Page 309)

TrendTimeRangeFactor

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 1111)" property has the value "0".
Access in runtime: Read and write

Syntax
Object.TrendTimeRangeFactor[=Int32]

Object
Required. An object of the type "ScreenItem" with the format:
• FunctionTrendControl

Int32
Optional. A value or a constant that specifies the factor for determining the time span of the
referenced trend.

WinCC Engineering V18 – Programming reference

1118 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

TrendTrendWindow

Description
Defines the trend window for visualizing the trend selected.
Define the available trend windows in the "Trend window" tab.
Access in runtime: Read and write

Syntax
Object.TrendTrendWindow[=STRING]

Object
Required. A "ScreenItem" object with the following format:
• FunctionTrendControl
• OnlineTrendControl

STRING
Optional A value or constant that specifies the name of the trend window for the selected
trend.

See also
FunctionTrendControl (Page 309)
OnlineTrendControl (Page 359)

TrendUncertainColor

Description
Specifies the color for values of uncertain status.
Access in runtime Read and write

Syntax
Object.TrendUncertainColor[=Color]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl
• OnlineTrendControl

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1119
VB scripting
1.5 VBS object model

Color
Optional. A value or a constant that specifies the color of the values of uncertain status in the
selected trend.

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
FunctionTrendControl (Page 309)
OnlineTrendControl (Page 359)

TrendUncertainColoring

Description
Specifies that values of uncertain status are to be highlighted.
Access in runtime Read and write

Syntax
Object.TrendUncertainColoring[=BOOLEAN]
Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl
• OnlineTrendControl

BOOLEAN
Optional.
TRUE if values of uncertain status are highlighted.

See also
FunctionTrendControl (Page 309)
OnlineTrendControl (Page 359)

WinCC Engineering V18 – Programming reference

1120 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

TrendUpperLimit

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 1121)".
Also specify with "TrendUpperLimitColoring (Page 1122)" that limit violation display is
activated.
Access in runtime Read and write

Syntax
Object.TrendUpperLimit[=DOUBLE]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl
• OnlineTrendControl

DOUBLE
Optional. A value or a constant that specifies the higher limit for values in the selected trend.

See also
TrendIndex (Page 1100)
FunctionTrendControl (Page 309)
OnlineTrendControl (Page 359)

TrendUpperLimitColor

Description
Specifies the color that marks trend values which are above the value of "TrendUpperLimit
(Page 1121)".
The setting is effective if "TrendUpperLimitColoring (Page 1122)" has the value "TRUE".
Access in runtime Read and write

Syntax
Object.TrendUpperLimitColor[=Color]

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1121
VB scripting
1.5 VBS object model

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl
• OnlineTrendControl

Color
Optional. A value or a constant that specifies the color of trend values above the
"TrendUpperLimit (Page 1121)" value.

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). The "Red"
color is displayed as follows, for example:
RGB (255, 0, 0)
You can also use the VBS color constants such as vbRed and vbGreen.

See also
TrendIndex (Page 1100)
FunctionTrendControl (Page 309)
OnlineTrendControl (Page 359)

TrendUpperLimitColoring

Description
Specifies whether the selection frame is shown with the color defined by the system.
Access in runtime Read and write

Syntax
Object.TrendUpperLimitColoring[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the format:
• FunctionTrendControl
• OnlineTrendControl

BOOLEAN
Optional.
TRUE if the "TrendUpperLimitColor" property is enabled.

WinCC Engineering V18 – Programming reference

1122 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

FALSE if the "TrendUpperLimitColor" property is disabled.

See also
FunctionTrendControl (Page 309)
OnlineTrendControl (Page 359)

TrendValueAlign

Description
No access in runtime.

TrendValueAxis

Description
Specifies the value axis that is used for the trend selected.
Access in runtime Read and write

Syntax
Object.TrendValueAxis[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTrendControl

STRING
Optional. A value or a constant that specifies the value axis for the selected trend.

See also
ValueAxisCount (Page 1175)
OnlineTrendControl (Page 359)

TrendValueUnit

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".

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1123
VB scripting
1.5 VBS object model

Access in runtime: Read and write

Syntax
Object.TrendValueUnit[=STRING]

Object
Required. A "ScreenItem" object with the following characteristics:
• OnlineTrendControl

STRING
Optional. A value or a constant that specifies the unit for the values of the value axis.

See also
OnlineTrendControl (Page 359)

TrendVisible

Description
Specifies whether the trend referenced with "TrendIndex" is displayed in the object.
Access in runtime Read and write

Syntax
Object.TrendVisible[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl
• OnlineTrendControl

BOOLEAN
Optional.
TRUE, if the referenced trend is displayed.
FALSE, if the referenced trend is not displayed.

See also
TrendIndex (Page 1100)
FunctionTrendControl (Page 309)
OnlineTrendControl (Page 359)

WinCC Engineering V18 – Programming reference

1124 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

TrendWindowAdd

Description
Creates a new trend view. The newly created trend view is automatically referenced with
"TrendWindowIndex".
Access in runtime Read and write

Syntax
Object.TrendWindowAdd[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl
• OnlineTrendControl

STRING
Required. A value or a constant that specifies the name of the new trend view with
"TrendWindowName".

See also
TrendWindowIndex (Page 1131)
FunctionTrendControl (Page 309)
OnlineTrendControl (Page 359)

TrendWindowCoarseGrid

Description
Specifies if the grid lines for the main scale are displayed.
Access in runtime Read and write

Syntax
Object.TrendWindowCoarseGrid[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl
• OnlineTrendControl

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1125
VB scripting
1.5 VBS object model

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
FunctionTrendControl (Page 309)
OnlineTrendControl (Page 359)

TrendWindowCoarseGridColor

Description
Specifies the color of the main grid for the referenced diagram in the object.
Access in runtime: Read and write

Syntax
Object.TrendWindowCoarseGridColor[=Color]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl
• OnlineTrendControl

Color
Optional. A value or a constant that specifies the color of the main grid for the referenced
diagram.

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.

WinCC Engineering V18 – Programming reference

1126 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

See also
TrendWindowIndex (Page 1131)
FunctionTrendControl (Page 309)
OnlineTrendControl (Page 359)

TrendWindowCount

Description
Specifies the number of configured trend diagrams in the trend view.
Access in runtime Read and write

Syntax
Object.TrendWindowCount[=Int32]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl
• OnlineTrendControl

Int32
Optional. A value or a constant that specifies the number of configured trend diagrams in the
trend view.

See also
FunctionTrendControl (Page 309)
OnlineTrendControl (Page 359)

TrendWindowFineGrid

Description
Specifies whether grid lines are displayed for the secondary scaling.
Access in runtime Read and write

Syntax
Object.TrendWindowFineGrid[=BOOLEAN]

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1127
VB scripting
1.5 VBS object model

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl
• OnlineTrendControl

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
FunctionTrendControl (Page 309)
OnlineTrendControl (Page 359)

TrendWindowFineGridColor

Description
Specifies the color of the secondary grid for the referenced diagram in the object.
Access in runtime Read and write

Syntax
Object.TrendWindowFineGridColor[=Color]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl
• OnlineTrendControl

Color
Optional. A value or a constant that specifies the color of the help grid for the referenced
diagram.

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.

WinCC Engineering V18 – Programming reference

1128 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

See also
TrendWindowIndex (Page 1131)
FunctionTrendControl (Page 309)
OnlineTrendControl (Page 359)

TrendWindowForegroundTrendGrid

Description
Specifies whether only the grid lines for the foreground trend are displayed in the selected trend
window.
Access in runtime Read and write

Syntax
Object.TrendWindowForegroundTrendGrid[=BOOLEAN]

Object
Required. A "ScreenItem" object with the following format:
• FunctionTrendControl
• OnlineTrendControl

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
FunctionTrendControl (Page 309)
OnlineTrendControl (Page 359)

TrendWindowGridInTrendColor

Description
Specifies whether the grid lines for the main scaling are displayed in the trend color.
Access in runtime: Read and write

Syntax
Object.TrendWindowGridInTrendColor[=BOOLEAN]

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1129
VB scripting
1.5 VBS object model

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl
• OnlineTrendControl

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 1126)".

See also
FunctionTrendControl (Page 309)

TrendWindowHorizontalGrid

Description
Specifies whether the horizontal grid lines are shown.
Access in runtime: Read and write

Syntax
Object.TrendWindowHorizontalGrid[=BOOLEAN]

Object
• FunctionTrendControl
• OnlineTrendControl

BOOLEAN
TRUE: The horizontal grid lines are displayed.
FALSE: The horizontal grid lines are not displayed.

See also
FunctionTrendControl (Page 309)

WinCC Engineering V18 – Programming reference

1130 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

TrendWindowIndex

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.
Access in runtime Read and write

Syntax
Object.TrendWindowIndex[=Int32]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl
• OnlineTrendControl

Int32
Optional. A value or a constant that specifies, with the index, the trend view to be edited.

See also
TrendWindowCount (Page 1127)
FunctionTrendControl (Page 309)
OnlineTrendControl (Page 359)

TrendWindowName

Description
Specifies the name of a trend view referenced with "TrendWindowIndex".
Access in runtime Read and write

Syntax
Object.TrendWindowName[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl
• OnlineTrendControl

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1131
VB scripting
1.5 VBS object model

STRING
Optional. A value or a constant that specifies the name of the referenced trend view.

See also
TrendWindowIndex (Page 1131)
FunctionTrendControl (Page 309)
OnlineTrendControl (Page 359)

TrendWindowRemove

Description
Removes a trend view referenced with its name.
Access in runtime Read and write

Syntax
Object.TrendWindowRemove[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl
• OnlineTrendControl

STRING
Optional. A value or a constant that specifies the name of the referenced trend view to be
removed.

See also
FunctionTrendControl (Page 309)
OnlineTrendControl (Page 359)

TrendWindowRename

Description
Specifies the new name of a trend view referenced with "TrendWindowIndex".
Access in runtime Read and write

WinCC Engineering V18 – Programming reference

1132 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Syntax
Object.TrendWindowRename[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl
• OnlineTrendControl

STRING
Optional. A value or a constant that specifies the new name of the selected trend view.

See also
TrendWindowIndex (Page 1131)
FunctionTrendControl (Page 309)
OnlineTrendControl (Page 359)

TrendWindowRepos

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".
Access in runtime Read and write

Syntax
Object.TrendWindwRepos[=Int32]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl
• OnlineTrendControl

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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1133
VB scripting
1.5 VBS object model

See also
TrendWindowIndex (Page 1131)
TrendWindowCount (Page 1127)
FunctionTrendControl (Page 309)
OnlineTrendControl (Page 359)

TrendWindowRulerColor

Description
Specifies the color of the ruler.
The setting is effective if the "TrendWindowRulerStyle (Page 1135)" property has the value
"1".
Access in runtime: Read and write

Syntax
Object.TrendWindowRulerColor[=Color]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl
• OnlineTrendControl

Color
Optional. A value or a constant that specifies the color of the ruler.

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
FunctionTrendControl (Page 309)
OnlineTrendControl (Page 359)

WinCC Engineering V18 – Programming reference

1134 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

TrendWindowRulerLayer

Description
Specifies the display layer of the ruler in the trend view.
Access in runtime Read and write

Syntax
Object.TrendWindowRulerLayer[=RulerLayer]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl
• OnlineTrendControl

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
FunctionTrendControl (Page 309)
OnlineTrendControl (Page 359)

TrendWindowRulerStyle

Description
Specifies the appearance of the ruler.
Access in runtime Read and write

Syntax
Object.TrendWindowRulerStyle[=RulerStyle]

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1135
VB scripting
1.5 VBS object model

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl
• OnlineTrendControl

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
FunctionTrendControl (Page 309)
OnlineTrendControl (Page 359)

TrendWindowRulerWidth

Description
Specifies the thickness of the ruler in pixels.
The setting is effective if the "TrendWindowRulerStyle (Page 1135)" property has the value
"1".
Access in runtime: Read and write

Syntax
Object.TrendWindowRulerWidth[=Int32]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl
• OnlineTrendControl

Int32
Optional. A value or a constant that specifies the width of the ruler in pixels.

See also
FunctionTrendControl (Page 309)
OnlineTrendControl (Page 359)

WinCC Engineering V18 – Programming reference

1136 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

TrendWindows

Description
No access in runtime.

TrendWindowSpacePortion

Description
Specifies the range proportion of the referenced diagram in the diagram area of the object.
Access in runtime: Read and write

Syntax
Object.TrendWindowSpacePortion[=Int32]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl
• OnlineTrendControl

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
TrendWindowIndex (Page 1131)
FunctionTrendControl (Page 309)
OnlineTrendControl (Page 359)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1137
VB scripting
1.5 VBS object model

TrendWindowStatisticRulerColor

Description
Specifies the color of the statistics ruler. You specify additionally using the
"TrendWindowStatisticRulerStyle (Page 1138)" property that the statistics ruler can be
configured graphically.
Access in runtime: Read and write

Syntax
Object.TrendWindowStatisticRulerColor[=Color]

Object
Required. A "ScreenItem" object with the following characteristics:
• OnlineTrendControl

Color
Optional. A value or a constant that specifies the color of the statistics ruler.

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)
You can also use the VBS color constants such as vbRed and vbGreen.

See also
OnlineTrendControl (Page 359)

TrendWindowStatisticRulerStyle

Description
Defines the graphical configurability of the lines for specifying the statistics area in the trend
window.
Access in runtime Read and write

Syntax
Object.TrendWindowStatisticRulerStyle[=RulerStyle]

WinCC Engineering V18 – Programming reference

1138 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTrendControl

RulerStyle
Optional. A value or a constant that specifies whether the statistics ruler can be configured
graphically.
The following settings are available:

Value Designation Description

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
OnlineTrendControl (Page 359)

TrendWindowStatisticRulerWidth

Description
Specifies the line width of the statistics ruler. You specify additionally using the
"TrendWindowStatisticRulerStyle (Page 1138)" property that the statistics ruler can be
configured graphically.
Access in runtime: Read and write

Syntax
Object.TrendWindowStatisticRulerWidth[=Int32]

Object
Required. A "ScreenItem" object with the following characteristics:
• OnlineTrendControl

Int32
Optional. A value or a constant that specifies the line width of the statistics ruler.

See also
OnlineTrendControl (Page 359)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1139
VB scripting
1.5 VBS object model

TrendWindowVerticalGrid

Description
Specifies whether the vertical grid lines are displayed.
Access in runtime Read and write

Syntax
Object.TrendWindowVerticalGrid[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl
• OnlineTrendControl

BOOLEAN
Optional.
TRUE if the vertical grid lines are displayed.
FALSE if the vertical grid lines are not displayed.

See also
FunctionTrendControl (Page 309)
OnlineTrendControl (Page 359)

TrendWindowVisible

Description
Specifies whether the trend view referenced with "TrendWindowIndex" is displayed.
Access in runtime: Read and write

Syntax
Object.TrendWindowVisible[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl
• OnlineTrendControl

WinCC Engineering V18 – Programming reference

1140 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

BOOLEAN
Optional.
TRUE if the referenced trend view is displayed.
FALSE if the referenced trend view is not displayed.

See also
TrendWindowIndex (Page 1131)
FunctionTrendControl (Page 309)
OnlineTrendControl (Page 359)

TrendXAxis

Description
Defines the X axis to be used for the referenced trend.
Access in Runtime: Read and write

Syntax
Object.TrendXAxis[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl

STRING
Optional. A value or constant that specifies the name of the X-axis used for the referenced
trend.

See also
TrendIndex (Page 1100)
FunctionTrendControl (Page 309)
OnlineTrendControl (Page 359)

TrendYAxis

Description
Specifies which Y axis is to be used for the referenced trend.
Access in Runtime: Read and write

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1141
VB scripting
1.5 VBS object model

Syntax
Object.TrendYAxis[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl

STRING
Optional. A value or a constant that specifies the name of the Y-axis used for the referenced
trend.

See also
TrendIndex (Page 1100)
FunctionTrendControl (Page 309)
OnlineTrendControl (Page 359)

1.5.5.14 Properties U-W

Unit

Description
Specifies the unit of measurement.
Access in runtime: Read and write

Syntax
Object.Unit[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• Bar
• IOField

STRING
Optional. A value or a constant that specifies the unit of measurement.

See also
Bar (Page 259)
IOField (Page 332)

WinCC Engineering V18 – Programming reference

1142 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

UnitColor

Description
Specifies the text color for the unit of measurement.
Access in runtime Read and write

Syntax
Object.UnitColor[=Color]

Object
Required. An object of the type "ScreenItem" with the following format:
• Gauge

Color
Optional. A value or a constant that specifies the text color for the measurement unit.

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
Gauge (Page 320)

UnitFont

Description
Specifies the font of the unit of measurement.
Access in runtime: Read and write

Syntax
Object.UnitFont[=Font]

Object
Required. A "ScreenItem" object with the following characteristics:
• Gauge

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1143
VB scripting
1.5 VBS object model

Font
Optional. A value or a constant that specifies the font.

See also
Gauge (Page 320)

UnitText

Description
Specifies the text for the unit of measurement.
Access in runtime Read and write

Syntax
Object.UnitText[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• 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 320)

UnitTop

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.
Access in runtime Read and write

WinCC Engineering V18 – Programming reference

1144 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Syntax
Object.UnitTop[=DOUBLE]

Object
Required. An object of the type "ScreenItem" with the following format:
• 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 320)

UnitViewColumnOrder

Description
No access in runtime.

UpdateButtonVisible

Description
No access in runtime.

UpperLimit

Description
Specifies the upper limit for input values.
Access in runtime: Read and write

Syntax
Object.UpperLimit[=DOUBLE]

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1145
VB scripting
1.5 VBS object model

Object
Required. A "ScreenItem" object with the following format:
• IOField

DOUBLE
Optional A value or a constant that specifies the upper limit for input values.

See also
IOField (Page 332)

UseAutoScaling

Description
No access in runtime.

UseButtonFirstGradient

Description
No access in runtime.

UseButtonSecondGradient

Description
No access in runtime.

UseColumnBackColor

Description
Specifies the settings for the background color of the columns.
Access in runtime Read and write

Syntax
Object.UseColumnBackColor[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTableControl

WinCC Engineering V18 – Programming reference

1146 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

BOOLEAN
Optional.
TRUE if the background color configured in "TableColor (Page 988)" is used.
FALSE if the background color configured for the columns in the table view is used.

See also
OnlineTableControl (Page 347)

UseColumnForeColor

Description
Specifies the settings for the font color of the columns.
Access in runtime Read and write

Syntax
Object.UseColumnForeColor[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTableControl

BOOLEAN
Optional.
TRUE if the font color specified with "TableForeColor (Page 990)" is used.
FALSE, if the font color specified for the columns in the table view is used.

See also
OnlineTableControl (Page 347)

UseCurserKeyScroll

Description
No access in runtime.

See also
OnlineTableControl (Page 347)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1147
VB scripting
1.5 VBS object model

Used

Description
Returns the size of the used disk space.
Access in runtime: Read

Syntax
Object.Used[=DOUBLE]

Object
Required. A "ScreenItem" object with the following format:
• DiscSpaceView

DOUBLE
Optional A value or a constant that returns the size of the used disk space.

See also
DiskSpaceView (Page 298)

UseDesignColorSchema

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:
• RT Advanced: No access
• RT Professional: Read and write

Syntax
Object.UseDesignColorSchema[=BOOLEAN]

Object
Required. An object of the "ScreenItem" type with the following format:
• Bar
• Button
• CheckBox
• Circle
• CircleSegment

WinCC Engineering V18 – Programming reference

1148 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

• CircularArc
• Clock
• ComboBox
• Connector
• Ellipse
• EllipseSegment
• EllipticalArc
• Gauge
• GraphicView
• IOField
• Line
• ListBox
• MultiLineEdit
• OptionGroup
• Polygon
• Polyline
• Rectangle
• RoundButton*
• Slider*
• SymbolicIOField*
• TextField
• TubeArcObject
• TubeDoubleTeeObject
• TubeTeeObject
• Tubepolyline
• WindowSlider*
*: Read access only

You have no access in runtime with the following format:

• AlarmView
• DateTimeField
• RecipeView
• StatusForce
• Switch
• SysDiagControl

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1149
VB scripting
1.5 VBS object model

• 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

Description
Specifies whether the object is displayed with global shading. The global shading is specified in
the current design.
Access in runtime: Read

Syntax
Object.UseDesignShadowSettings[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the format:
• Bar
• Button
• CheckBox
• CircleSegment
• CircularArc
• Clock
• ComboBox
• Connector
• EllipseSegment
• EllipticalArc
• Gauge
• GraphicIOField
• GraphicView
• IOField
• Line
• ListBox

WinCC Engineering V18 – Programming reference

1150 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

• MultiLineEdit
• OptionGroup
• Polyline
• RoundButton
• Slider
• SymbolicIOField
• TextField
• TubeArcObject
• TubeDoubleTeeObject
• TubeTeeObject
• Tubepolyline
• WindowSlider
You have no access in runtime with the following format:
• CircleSegment

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 279)
CircleSegment (Page 282)
CircularArc (Page 285)
Ellipse (Page 300)
EllipseSegment (Page 303)
EllipticalArc (Page 306)
GraphicView (Page 327)
Line (Page 336)
Polygon (Page 378)
Polyline (Page 381)
Rectangle (Page 395)
TextField (Page 438)
TubeArcObject (Page 457)
TubeDoubleTeeObject (Page 459)
TubePolyline (Page 461)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1151
VB scripting
1.5 VBS object model

TubeTeeObject (Page 464)

Bar (Page 259)
Button (Page 267)
CheckBox (Page 275)
Clock (Page 287)
ComboBox (Page 290)
Gauge (Page 320)
GraphicIOField (Page 324)
IOField (Page 332)
Listbox (Page 339)
MultiLineEdit (Page 345)
OptionGroup (Page 371)
RoundButton (Page 398)
Slider (Page 408)
SymbolicIOField (Page 422)
WindowSlider (Page 482)

UsedPercent

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.
Access in runtime: Read

Syntax
Object.UsedPercent[=Int32]

Object
Required. A "ScreenItem" object with the following format:
• DiscSpaceView

Int32
Optional A value or a constant that returns the measured values for the used disk space as a
percentage.

See also
DiskSpaceView (Page 298)

WinCC Engineering V18 – Programming reference

1152 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

UseExponentialFormat

Description
Specifies whether the figures are shown exponentially (e.g. "1.00e+000").
Access in runtime: Read and write

Syntax
Object.UseExponentialFormat[=BOOLEAN]

Object
Required. A "ScreenItem" object with the following format:
• Bar

BOOLEAN
Optional TRUE, if the figures are shown exponentially (e.g. "1.00e+000").

See also
Bar (Page 259)

UseFirstGradient

Description
No access in runtime.

UseFlashTransparentColor

Description
Specifies whether the color of the bitmap object of a flashing graphic will be set to ""transparent".
Access in runtime: Read and write

Syntax
Object.UseFlashTransparentColor[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• "GraphicIOField"

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1153
VB scripting
1.5 VBS object model

BOOLEAN
Optional. TRUE, if the color of the bitmap object of a flashing graphic will be set to
"transparent".

See also
GraphicIOField (Page 324)

UseMessageColor

Description
Specifies whether the agreed colors of the message classes are displayed.
Access in runtime Read and write

Syntax
Object.UseMessageColor [=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• 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
AlarmControl (Page 237)

UserData (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.
Access in Runtime: Read and write

WinCC Engineering V18 – Programming reference

1154 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

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.

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

Description
Returns the name of the user who triggered the alarm object.

UseScadaRendererStyle

Description
No access in runtime.

UseSecondGradient

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1155
VB scripting
1.5 VBS object model

UseSelectedTitleColor

Description
Specifies whether a selection color is used for the headers of selected table cells.
Access in runtime Read and write

Syntax
Object.UseSelectedTitleColor[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• OnlineTableControl
• TrendRulerControl
• UserArchiveControl

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
AlarmControl (Page 237)
OnlineTableControl (Page 347)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

UseSourceBackColors

Description
Specifies that the background color of the data source is used.
Access in runtime: Read and write

Syntax
Object.UseSourceBackColors[=BOOLEAN]

WinCC Engineering V18 – Programming reference

1156 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Object
Required. A "ScreenItem" object with the following characteristics:
• TrendRulerControl

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.

See also
TrendRulerControl (Page 441)

UseSourceForeColors

Description
Specifies that the font color of the data source is used.
Access in runtime: Read and write

Syntax
Object.UseSourceForeColors[=BOOLEAN]

Object
Required. A "ScreenItem" object with the following characteristics:
• TrendRulerControl

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
TrendRulerControl (Page 441)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1157
VB scripting
1.5 VBS object model

UseSystemScrollbarWidth

Description
No access in runtime.

UseTableColor2

Description
Specifies whether a second row color is used for the representation of the table.
Access in runtime Read and write

Syntax
Object.UseTableColor2[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• OnlineTableControl
• TrendRulerControl
• UserArchiveControl

BOOLEAN
Optional.
TRUE if the background colors from "TableColor (Page 988)" and "TableColor2 (Page 989)" are
used alternately.
FALSE if the background colors from "TableColor (Page 988)" are used for all rows.

See also
TableColor2 (Page 989)
AlarmControl (Page 237)
OnlineTableControl (Page 347)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

WinCC Engineering V18 – Programming reference

1158 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

UseTableHeaderFirstGradient

Description
No access in runtime.

UseTableHeaderSecondGradient

Description
No access in runtime.

UseTagLimitColors

Description
Specifies whether the violation of the configured high and low limits for the object are
highlighted in color.
Access in runtime Read and write

Syntax
Object.UseTagLimitColors[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• IOField

BOOLEAN
Optional. TRUE if the limits are highlighted in color.

See also
IOField (Page 332)

UseTransparentColor

Description
Specifies whether the color defined with the "TransparentColor" property is shown as
transparent.
Access in runtime: Read and write

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1159
VB scripting
1.5 VBS object model

Syntax
Object.UseTransparentColor[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the format:
• GraphicIOField
• GraphicView

BOOLEAN
Optional. TRUE if the specified color is to be shown as transparent.

See also
GraphicIOField (Page 324)
GraphicView (Page 327)

UseTransparentColorDeactivatedPicture

Description
Specifies if the transparent color defined with the property
"TransparentColorDeactivatedPicture" for the status "disabled" will be used.
Access in runtime: Read

Syntax
Object.UseTransparentColorDeactivatedPicture[=BOOLEAN]

Object
Required. A "ScreenItem" object with the following format:
• RoundButton

BOOLEAN
Optional. TRUE, if the transparent color defined with the property
"TransparentColorDeactivatedPicture" for the status "disabled" is used.

See also
RoundButton (Page 398)

WinCC Engineering V18 – Programming reference

1160 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

UseTransparentColorPictureOff

Description
Specifies if the transparent color defined with the property "TransparentColorPictureOff" for the
"off" status will be used.
Access in runtime: Read and write

Syntax
Object.UseTransparentColorPictureOff[=BOOLEAN]

Object
Required. A "ScreenItem" object with the following format:
• Button
• RoundButton*
*: Read access only

BOOLEAN
Optional. TRUE, if the transparent color defined with the property
"TransparentColorPictureOff" for the "off" status is used.

UseTransparentColorPictureOn

Description
Specifies if the transparent color defined with the property "TransparentColorPictureOn" for the
"on" status will be used.
Access in runtime: Read and write

Syntax
Object.UseTransparentColorPictureOn[=BOOLEAN]

Object
Required. A "ScreenItem" object with the following format:
• Button
• RoundButton*
*: Read access only

BOOLEAN
Optional. TRUE, if the transparent color defined with the property
"TransparentColorPictureOn" for the "on" status is used.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1161
VB scripting
1.5 VBS object model

UseTrendNameAsLabel

Description
Specifies whether the "Name" or "Label" property is used as a designation for the trend in
runtime.
Access in runtime Read and write

Syntax
Object.UseTrendNameAsLabel[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl
• OnlineTrendControl

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
FunctionTrendControl (Page 309)
OnlineTrendControl (Page 359)

UseTwoHandOperation

Description
No access in runtime.

UseUdp

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

1162 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

UV_ColumnWidth_AKZ

Description
No access in runtime.

UV_ColumnWidth_Descriptor

Description
No access in runtime.

UV_ColumnWidth_InstallationDate

Description
No access in runtime.

UV_ColumnWidth_LADDR

Description
No access in runtime.

UV_ColumnWidth_Name

Description
No access in runtime.

UV_ColumnWidth_OKZ

Description
No access in runtime.

UV_ColumnWidth_OperationState

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1163
VB scripting
1.5 VBS object model

UV_ColumnWidth_OrderID

Description
No access in runtime.

UV_ColumnWidth_ProfileID

Description
No access in runtime.

UV_ColumnWidth_Rack

Description
No access in runtime.

UV_ColumnWidth_Slot

Description
No access in runtime.

UV_ColumnWidth_SoftwareRevision

Description
No access in runtime.

UV_ColumnWidth_SpecificProfileData

Description
No access in runtime.

UV_ColumnWidth_State

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

1164 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

UV_ColumnWidth_Station

Description
No access in runtime.

UV_ColumnWidth_SubAddress

Description
No access in runtime.

UV_ColumnWidth_SubSlot

Description
No access in runtime.

UV_ColumnWidth_SubSystem

Description
No access in runtime.

UV_ColumnWidth_Type

Description
No access in runtime.

UV_ShowItem_AKZ

Description
No access in runtime.

UV_ShowItem_Descriptor

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1165
VB scripting
1.5 VBS object model

UV_ShowItem_InstallationDate

Description
No access in runtime.

UV_ShowItem_LADDR

Description
No access in runtime.

UV_ShowItem_Name

Description
No access in runtime.

UV_ShowItem_OKZ

Description
No access in runtime.

UV_ShowItem_OperationState

Description
No access in runtime.

UV_ShowItem_OrderID

Description
No access in runtime.

UV_ShowItem_ProfileID

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

1166 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

UV_ShowItem_Rack

Description
No access in runtime.

UV_ShowItem_Slot

Description
No access in runtime.

UV_ShowItem_SoftwareRevision

Description
No access in runtime.

UV_ShowItem_SpecificProfileData

Description
No access in runtime.

UV_ShowItem_State

Description
No access in runtime.

UV_ShowItem_Station

Description
No access in runtime.

UV_ShowItem_SubAddress

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1167
VB scripting
1.5 VBS object model

UV_ShowItem_SubSlot

Description
No access in runtime.

UV_ShowItem_SubSystem

Description
No access in runtime.

UV_ShowItem_Type

Description
No access in runtime.

Value

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".

WinCC Engineering V18 – Programming reference

1168 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Examples
The following example writes a new value in the "Tag1" tag:

'VBS94
Dim objTag
Set objTag = HMIRuntime.Tags("Tag1")
objTag.Value = 50
objTag.Write

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.Trace "motor1: " & HMIRuntime.DataSet("motor1").Value & vbNewLine
HMIRuntime.DataSet("motor1").Value = 55
HMIRuntime.Trace "motor1: " & HMIRuntime.DataSet("motor1").Value & vbNewLine
HMIRuntime.DataSet.Remove("motor1")

See also
DataItem (Page 203)
Tag (Page 229)
Gauge (Page 320)

ValueAxes

Description
No access in runtime.

ValueAxis1AutoRange

Description
No access in runtime.

ValueAxis1Begin

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1169
VB scripting
1.5 VBS object model

ValueAxis1End

Description
No access in runtime.

ValueAxis1LabelLength

Description
No access in runtime.

ValueAxis1Style

Description
No access in runtime.

ValueAxis2AutoRange

Description
No access in runtime.

ValueAxis2Begin

Description
No access in runtime.

ValueAxis2End

Description
No access in runtime.

ValueAxis2LabelLength

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

1170 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

ValueAxis2Style

Description
No access in runtime.

ValueAxisAdd

Description
Creates a new value axis. The newly created value axis is automatically referenced with
"ValueAxisIndex".
Access in runtime Read and write

Syntax
Object.ValueAxisAdd[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTrendControl

STRING
Required. A value or a constant that specifies the name of the new value axis with
"ValueAxisName".

See also
ValueAxisIndex (Page 1176)
OnlineTrendControl (Page 359)

ValueAxisAlignment

Description
Specifies the alignment of the value axis referenced with "ValueAxisIndex".
Access in runtime Read and write

Syntax
Object.ValueAxisAlignment[=AxisAlignment]

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1171
VB scripting
1.5 VBS object model

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTrendControl

AxisAlignment
Optional. A value or a constant that specifies the alignment of the value axis.

Value Designation Description

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
OnlineTrendControl (Page 359)

ValueAxisAutoPrecisions

Description
Specifies whether the number of decimal places for a value axis referenced with
"ValueAxisIndex" is set automatically.
Access in runtime Read and write

Syntax
Object.ValueAxisAutoPrecisions[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTrendControl

BOOLEAN
Optional.
TRUE if the number of decimal places is automatically determined.
FALSE if the value of "ValueAxisPrecisions" is used.

See also
ValueAxisPrecisions (Page 1179)
ValueAxisIndex (Page 1176)
OnlineTrendControl (Page 359)

WinCC Engineering V18 – Programming reference

1172 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

ValueAxisAutoRange

Description
Specifies whether the value range of a value axis referenced with "ValueAxisIndex" is calculated
automatically.
Access in runtime Read and write

Syntax
Object.ValueAxisAutoRange[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTrendControl

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 1173)
ValueAxisEndValue (Page 1175)
ValueAxisIndex (Page 1176)
OnlineTrendControl (Page 359)

ValueAxisBeginValue

Description
Specifies the lower end of the value range of a value axis referenced with "ValueAxisIndex".
Also set "ValueAxisAutoRange" to "FALSE".
Access in runtime Read and write

Syntax
Object.ValueAxisBeginValue[=DOUBLE]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTrendControl

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1173
VB scripting
1.5 VBS object model

DOUBLE
Optional. A value or a constant that specifies the low limit of the value range of the
referenced value axis.

See also
ValueAxisIndex (Page 1176)
ValueAxisAutoRange (Page 1173)
OnlineTrendControl (Page 359)

ValueAxisColor

Description
Specifies the color of a value axis referenced with "ValueAxisIndex". This property is only
evaluated if the "ValueAxisInTrendColor (Page 1177)" property is set to "FALSE".
Access in runtime Read and write

Syntax
Object.ValueAxisColor[=Color]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTrendControl

Color
Optional. A value or a constant that specifies the color of the value axis.

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
OnlineTrendControl (Page 359)

WinCC Engineering V18 – Programming reference

1174 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

ValueAxisCount

Description
Specifies the number of configured value axes.
Access in runtime Read and write

Syntax
Object.ValueAxisCount[=Int32]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTrendControl

Int32
Optional. A value or a constant that specifies the number of configured value axes.

See also
OnlineTrendControl (Page 359)

ValueAxisEndValue

Description
Specifies the upper end of the value range of a value axis referenced with "ValueAxisIndex".
Also set "ValueAxisAutoRange" to "FALSE".
Access in runtime Read and write

Syntax
Object.ValueAxisEndValue[=DOUBLE]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTrendControl

DOUBLE
Optional. A value or a constant that specifies the high limit of the value range of the
referenced value axis.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1175
VB scripting
1.5 VBS object model

See also
ValueAxisIndex (Page 1176)
ValueAxisAutoRange (Page 1173)
OnlineTrendControl (Page 359)

ValueAxisExponentialFormat

Description
Specifies whether the values of a value axis referenced with "ValueAxisIndex" are displayed in
exponential notation.
Access in runtime Read and write

Syntax
Object.ValueAxisExponentialFormat[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTrendControl

BOOLEAN
Optional.
TRUE if the values are displayed in exponential notation.
FALSE if the values are not displayed in exponential notation.

See also
ValueAxisIndex (Page 1176)
OnlineTrendControl (Page 359)

ValueAxisIndex

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.
Access in runtime Read and write

WinCC Engineering V18 – Programming reference

1176 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Syntax
Object.ValueAxisIndex[=Int32]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTrendControl

Int32
Optional. A value or a constant that specifies, with the index, the value axis to be edited.

See also
ValueAxisCount (Page 1175)
OnlineTrendControl (Page 359)

ValueAxisInTrendColor

Description
Specifies whether the color of the axis referenced with "ValueAxisIndex" corresponds to the
trend color.
Access in runtime Read and write

Syntax
Object.ValueAxisInTrendColor[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTrendControl

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
ValueAxisIndex (Page 1176)
OnlineTrendControl (Page 359)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1177
VB scripting
1.5 VBS object model

ValueAxisLabel

Description
Defines the label text for a value axis referenced with "ValueAxisIndex".
Access in runtime Read and write

Syntax
Object.ValueAxisLabel[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTrendControl

STRING
Optional. A value or a constant that specifies the label text for the referenced value axis.

See also
ValueAxisIndex (Page 1176)
OnlineTrendControl (Page 359)

ValueAxisName

Description
Specifies the name of a value axis referenced with "ValueAxisIndex".
Access in runtime Read and write

Syntax
Object.ValueAxisName[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTrendControl

STRING
Optional. A value or a constant that specifies the name of the referenced value axis.

WinCC Engineering V18 – Programming reference

1178 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

See also
ValueAxisIndex (Page 1176)
OnlineTrendControl (Page 359)

ValueAxisPrecisions

Description
Specifies the number of decimal places for the label of the value axis referenced with
"ValueAxisIndex".
Access in runtime Read and write

Syntax
Object.ValueAxisPrecisions[=Int16]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTrendControl

Int16
Optional. A value or a constant that specifies the number of decimal places.

See also
OnlineTrendControl (Page 359)

ValueAxisRemove

Description
Removes a value axis referenced with its name.
Access in runtime Read and write

Syntax
Object.ValueAxisRemove[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTrendControl

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1179
VB scripting
1.5 VBS object model

STRING
Optional. A value or a constant that specifies the name of the referenced value axis to be
removed.

See also
OnlineTrendControl (Page 359)

ValueAxisRename

Description
Specifies the new name of a value axis referenced with "ValueAxisIndex".
Access in runtime Read and write

Syntax
Object.ValueAxisRename[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTrendControl

STRING
Optional. A value or a constant that specifies the new name of the value axis.

See also
ValueAxisIndex (Page 1176)
OnlineTrendControl (Page 359)

ValueAxisRepos

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".
Access in runtime Read and write

Syntax
Object.ValueAxisRepos[=Int32]

WinCC Engineering V18 – Programming reference

1180 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTrendControl

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
ValueAxisIndex (Page 1176)
ValueAxisCount (Page 1175)
OnlineTrendControl (Page 359)

ValueAxisScalingType

Description
Specifies the type of scaling for the value axis referenced with "ValueAxisIndex".
Access in runtime Read and write

Syntax
Object.ValueAxisScalingType[=AxisScalingType]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTrendControl

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
ValueAxisIndex (Page 1176)
OnlineTrendControl (Page 359)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1181
VB scripting
1.5 VBS object model

ValueAxisTrendWindow

Description
Specifies the trend diagram in which the axis referenced with "ValueAxisIndex" is displayed.
Access in runtime Read and write

Syntax
Object.ValueAxisTrendWindow[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTrendControl

STRING
Optional. A value or a constant that specifies the name of the trend diagram.

See also
TrendWindowCount (Page 1127)
ValueAxisIndex (Page 1176)
OnlineTrendControl (Page 359)

ValueAxisVisible

Description
Specifies whether the value axis referenced with "ValueAxisIndex" is displayed in the object.
Access in runtime Read and write

Syntax
Object.ValueAxisVisible[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTrendControl

BOOLEAN
Optional.
TRUE if the referenced value axis is displayed.
FALSE if the referenced value axis is not displayed.

WinCC Engineering V18 – Programming reference

1182 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

See also
ValueAxisIndex (Page 1176)
OnlineTrendControl (Page 359)

ValueCaption

Description
No access in runtime.

ValueColumnAdd

Description
Creates a new value column. The newly created value column is automatically referenced with
"ValueColumnIndex".
Access in runtime Read and write

Syntax
Object.ValueColumnAdd[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTableControl

STRING
Required. A value or a constant that specifies the name of the new value column with
"ValueColumnName".

See also
ValueColumnIndex (Page 1189)
OnlineTableControl (Page 347)

ValueColumnAlignment

Description
Specifies how the text in the value column referenced with "ValueColumnIndex" is aligned.
Access in runtime Read and write

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1183
VB scripting
1.5 VBS object model

Syntax
Object.ValueColumnAlignment[=HorizontalAlignment]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTableControl

HorizontalAlignment
Optional. A value or a constant that specifies how the text in the referenced value column is
aligned.

Value VB constant Explanation

0 hmiAlignmentLeft The text is left-justified.
1 hmiAlignmentCentered The text is centered.
2 hmiAlignmentRight The text is right-justified.

See also
OnlineTableControl (Page 347)

ValueColumnAutoPrecisions

Description
Specifies whether the number of decimal places for a value axis referenced with
"ValueColumnIndex" is set automatically.
Access in runtime Read and write

Syntax
Object.ValueColumnAutoPrecisions[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTableControl

BOOLEAN
Optional.
TRUE if the number of decimal places is automatically determined.
FALSE if the value of "ValueColumnPrecisions" is used.

WinCC Engineering V18 – Programming reference

1184 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

See also
ValueColumnPrecisions (Page 1190)
ValueColumnIndex (Page 1189)
OnlineTableControl (Page 347)

ValueColumnBackColor

Description
Specifies the background color of the value column referenced with "ValueColumnIndex".
Also set "UseColumnBackColor (Page 1146)" to "TRUE".
Access in runtime Read and write

Syntax
Object.ValueColumnBackColor[=Color]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTableControl

Color
Optional. A value or a constant that specifies the background color.

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
OnlineTableControl (Page 347)

ValueColumnCaption

Description
Specifies the name of the value column referenced with "ValueColumnIndex".
Access in runtime Read and write

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1185
VB scripting
1.5 VBS object model

Syntax
Object.ValueColumnCaption[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTableControl

STRING
Optional. A value or a constant that specifies the name of the value column.

See also
OnlineTableControl (Page 347)

ValueColumnCount

Description
Specifies the number of configured value columns.
Access in runtime Read and write

Syntax
Object.ValueColumnCount[=Int32]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTableControl

Int32
Optional. A value or a constant that specifies the number of configured value columns.

See also
OnlineTableControl (Page 347)

ValueColumnExponentialFormat

Description
Specifies whether the values of a value column referenced with "ValueColumnIndex" are
displayed in exponential notation.
Access in runtime Read and write

WinCC Engineering V18 – Programming reference

1186 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Syntax
Object.ValueColumnExponentialFormat[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTableControl

BOOLEAN
Optional.
TRUE if the values are displayed in exponential notation.
FALSE if the values are not displayed in exponential notation.

See also
ValueColumnIndex (Page 1189)
OnlineTableControl (Page 347)

ValueColumnForeColor

Description
Specifies the font color of the value column referenced with "ValueColumnIndex".
Also set "UseColumnForeColor (Page 1147)" to "TRUE".
Access in runtime Read and write

Syntax
Object.ValueColumnForeColor[=Color]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTableControl

Color
Optional. A value or a constant which specifies the font color.

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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1187
VB scripting
1.5 VBS object model

See also
OnlineTableControl (Page 347)

ValueColumnHideText

Description
Specifies whether the text in the value column referenced with "ValueColumnIndex" is hidden.
Access in runtime Read and write

Syntax
Object.ValueColumnHideText[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTableControl

BOOLEAN
Optional.
TRUE, if the text in the value column is hidden.
FALSE, if the text in the value column is displayed.

See also
OnlineTableControl (Page 347)

ValueColumnHideTitleText

Description
Specifies whether the text in the header of the value column referenced with
"ValueColumnIndex" is hidden.
Access in runtime Read and write

Syntax
Object.ValueColumnHideTitleText[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTableControl

WinCC Engineering V18 – Programming reference

1188 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

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
OnlineTableControl (Page 347)

ValueColumnIndex

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.
Access in runtime Read and write

Syntax
Object.ValueColumnIndex[=Int32]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTableControl

Int32
Optional. A value or a constant that specifies, with the index, the value column to be edited.

See also
ValueColumnCount (Page 1186)
OnlineTableControl (Page 347)

ValueColumnLength

Description
Specifies the width in characters of the value column referenced with "ValueColumnIndex".
Access in runtime Read and write

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1189
VB scripting
1.5 VBS object model

Syntax
Object.ValueColumnLength[=Int32]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTableControl

Int32
Optional. A value or a constant that specifies the number of characters displayed.

See also
OnlineTableControl (Page 347)

ValueColumnName

Description
Specifies the name of a value column referenced with "ValueColumnIndex".
Access in runtime Read and write

Syntax
Object.ValueColumnName[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTableControl

STRING
Optional. A value or a constant that specifies the name of the referenced value column.

See also
ValueColumnIndex (Page 1189)
OnlineTableControl (Page 347)

ValueColumnPrecisions

Description
Specifies the number of decimal places for values in the value column referenced with
"ValueColumnIndex".

WinCC Engineering V18 – Programming reference

1190 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Access in runtime Read and write

Syntax
Object.ValueColumnPrecisions[=Int16]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTableControl

Int16
Optional. A value or constant that specifies the number of decimal places.

See also
OnlineTableControl (Page 347)

ValueColumnProvider

Description
Specifies the data source for the value column referenced with "ValueColumnIndex".
Access in runtime Read and write

Syntax
Object.ValueColumnProvider[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTableControl

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
OnlineTableControl (Page 347)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1191
VB scripting
1.5 VBS object model

ValueColumnProviderCLSID

Description
Specifies the provider CLSID of the data for a value column referenced with "ValueColumnIndex".
Access in runtime Read and write

Syntax
Object.ValueColumnProviderCLSID[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTableControl

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
OnlineTableControl (Page 347)

ValueColumnRemove

Description
Removes a value column referenced with its name.
Access in runtime Read and write

Syntax
Object.ValueColumnRemove[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTableControl

WinCC Engineering V18 – Programming reference

1192 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

STRING
Optional. A value or a constant that specifies the name of the referenced value column to be
removed.

See also
OnlineTableControl (Page 347)

ValueColumnRename

Description
Specifies the new name of a value column referenced with "ValueColumnIndex".
Access in runtime Read and write

Syntax
Object.ValueColumnRename[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTableControl

STRING
Optional. A value or a constant that specifies the new name of the value column.

See also
ValueColumnIndex (Page 1189)
OnlineTableControl (Page 347)

ValueColumnRepos

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".
Access in runtime Read and write

Syntax
Object.ValueColumnRepos[=Int32]

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1193
VB scripting
1.5 VBS object model

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTableControl

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
ValueColumnIndex (Page 1189)
ValueColumnCount (Page 1186)
OnlineTableControl (Page 347)

ValueColumns

Description
No access in runtime.

ValueColumnSelectTagName

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.
Access in runtime Read and write

Syntax
Object.ValueColumnSelectTagName[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTableControl

BOOLEAN
Optional.
TRUE, if the dialog for selecting the tag name for the data source of the value column is
displayed in the screen.
FALSE, if no dialog for selecting the tag name for the data source of the value column is
displayed in the screen.

WinCC Engineering V18 – Programming reference

1194 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

See also
OnlineTableControl (Page 347)

ValueColumnShowIcon

Description
Specifies whether an icon is displayed in the value column referenced with
"ValueColumnIndex".
Access in runtime Read and write

Syntax
Object.ValueColumnShowIcon[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTableControl

BOOLEAN
Optional.
TRUE, if an icon is shown.
FALSE, if no icon is shown.

See also
OnlineTableControl (Page 347)

ValueColumnShowTitleIcon

Description
Specifies whether an icon is displayed in the header of the value column referenced with
"ValueColumnIndex".
Access in runtime Read and write

Syntax
Object.ValueColumnShowTitleIcon[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTableControl

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1195
VB scripting
1.5 VBS object model

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
OnlineTableControl (Page 347)

ValueColumnSort

Description
Specifies the type of sorting for the value column referenced with "ValueColumnIndex".
Access in runtime Read and write

Syntax
Object.ValueColumnSort[=SortMode]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTableControl

SortMode
Optional. A value or a constant that specifies the type of sorting in the current column.

Value Designation Description

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
OnlineTableControl (Page 347)

ValueColumnSortIndex

Description
Specifies the sorting order.
Access in runtime: Read and write

WinCC Engineering V18 – Programming reference

1196 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Syntax
Object.ValueColumnSortIndex[=Int32]

Object
Required. A "ScreenItem" object with the following characteristics:
• OnlineTableControl

Int32
Optional. A value or a constant that specifies the order when sorting.

See also
OnlineTableControl (Page 347)

ValueColumnTagName

Description
Specifies the names of the tags whose values are displayed in the value column referenced with
"ValueColumnIndex".
Access in runtime Read and write

Syntax
Object.ValueColumnTagName[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTableControl

STRING
Optional. A value or a constant that specifies the name of the tag whose values are displayed
in the current column.

See also
OnlineTableControl (Page 347)

ValueColumnTimeColumn

Description
Specifies the associated time column.
Access in runtime: Read and write

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1197
VB scripting
1.5 VBS object model

Syntax
Object.ValueColumnTimeColumn[=STRING]

Object
Required. A "ScreenItem" object with the following characteristics:
• OnlineTableControl

STRING
Optional. A value or a constant that specifies the associated time column.

See also
OnlineTableControl (Page 347)

ValueColumnVisible

Description
Specifies whether the value column referenced with "ValueColumnIndex" is displayed in the
object.
Access in runtime Read and write

Syntax
Object.ValueColumnVisible[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• OnlineTableControl

BOOLEAN
Optional.
TRUE if the referenced value column is displayed.
FALSE if the referenced value column is not displayed.

See also
ValueColumnIndex (Page 1189)
OnlineTableControl (Page 347)

WinCC Engineering V18 – Programming reference

1198 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

ValueColumnWidth

Description
No access in runtime.

ValueTableHeight

Description
No access in runtime.

ValueTableLeft

Description
No access in runtime.

ValueTableTop

Description
No access in runtime.

ValueTableWidth

Description
No access in runtime.

ValueY1HlpLine

Description
No access in runtime.

ValueY2HlpLine

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1199
VB scripting
1.5 VBS object model

VerticalAlignment

Description
Specifies the vertical alignment of the text in the specified object.
Access in runtime: Read and write

Syntax
Object.VerticalAlignment[=VerticalAlignment]

Object
Required. An object of the type "ScreenItem" with the format:
• 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.

Value VB constant Explanation

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 267)
DateTimeField (Page 296)
IOField (Page 332)
OptionGroup (Page 371)
RoundButton (Page 398)
Switch (Page 418)

WinCC Engineering V18 – Programming reference

1200 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

SymbolicIOField (Page 422)

TextField (Page 438)
CheckBox (Page 275)

VerticalGridLines

Description
Specifies whether vertical separation lines are displayed.
Access in runtime Read and write

Syntax
Object.VerticalGridLines[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• AlarmControl
• OnlineTableControl
• TrendRulerControl
• UserArchiveControl

BOOLEAN
Optional.
TRUE if vertical separation lines are displayed.
FALSE if vertical separation lines are not displayed.

See also
AlarmControl (Page 237)
OnlineTableControl (Page 347)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

VerticalPictureAlignment

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1201
VB scripting
1.5 VBS object model

VerticalScrollBarEnabled

Description
No access in runtime.

VerticalScrollbarPosition

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 775)" and "LeftOffset (Page 775)" properties as the
source of this cutout.
Access in Runtime: Read and write

Syntax
Object.VerticalScrollBarPosition[=Int32]

Object
Required. An object of the type "ScreenItem" with the following format:
• 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 1085)
ScreenWindow (Page 404)

VerticalScrolling

Description
No access in runtime.

WinCC Engineering V18 – Programming reference

1202 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

VerticalScrollingEnabled

Description
No access in runtime.

ViewOnly

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.
Access in runtime: Read and write

Syntax
Object.ViewOnly[=BOOLEAN]

Object
Required. A "ScreenItem" object with the following format:
• SmartClientView

BOOLEAN
Optional TRUE, if the Sm@rtClient display is to be used only for remote monitoring.

See also
SmartClientView (Page 412)

ViewType

Description
No access in runtime.

ViewTypeForSaveStream

Description

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1203
VB scripting
1.5 VBS object model

Access in Runtime:
• RT Advanced: Read
• RT Professional: No access

Syntax
Object.ViewTimeForSaveStream[=[!]: AlarmViewBasicMode | Int16 | PasswordViewType]

Object
Required. An object of the type "ScreenItem" with the format:
• RecipeView
You have no access in runtime with the following format:
• AlarmView
• UserView

[!]: AlarmViewBasicMode | Int16 | PasswordViewType:

Optional. tbd tbd tbd tbd are.

Visible

Description
Specifies whether the selected object is visible.
Access in runtime: Read and write

Syntax
Object.Visible[=BOOLEAN]

Object
Required. An object of the type "ScreenItem"" with the format:
• AlarmControl
• AlarmView
• ApplicationWindow
• Bar
• BatteryView
• Button
• ChannelDiagnose
• CheckBox
• CircleSegment

WinCC Engineering V18 – Programming reference

1204 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

• CircularArc
• ComboBox
• Connector
• DateTimeField
• DiscSpaceView
• EllipseSegment
• EllipticalArc
• FunctionTrendControl
• Gauge
• GraphicIOField
• GraphicView
• HTMLBrowser
• IOField
• ListBox
• MediaPlayer
• MultiLineEdit
• OnlineTableControl
• OnlineTrendControl
• OptionGroup
• PLCCodeViewer
• ProDiagOverview
• ProtectedAreaNameView
• RangeLabelView
• RangeQualityView
• RecipeView
• RoundButton
• S7GraphOverview
• ScreenWindow
• SmartClientView
• StatusForce
• Switch
• SymbolLibrary
• SymbolicIOField
• SysDiagControl
• TrendRulerControl

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1205
VB scripting
1.5 VBS object model

• TrendView
• TubeArcObject
• TubeDoubleTeeObject
• TubeTeeObject
• Tubepolyline
• UserArchiveControl
• WLanQualityView
• WindowSlider
• ZoneLabelView
• ZoneQualityView
You have no access in runtime with the following format:
• PdfView

BOOLEAN
Optional. TRUE, if the object is visible.

See also
AlarmControl (Page 237)
AlarmView (Page 251)
ApplicationWindow (Page 257)
Bar (Page 259)
BatteryView (Page 265)
Button (Page 267)
ChannelDiagnose (Page 274)
CheckBox (Page 275)
Circle (Page 279)
CircleSegment (Page 282)
CircularArc (Page 285)
Clock (Page 287)
ComboBox (Page 290)
DateTimeField (Page 296)
DiskSpaceView (Page 298)
Ellipse (Page 300)
EllipseSegment (Page 303)
EllipticalArc (Page 306)
FunctionTrendControl (Page 309)

WinCC Engineering V18 – Programming reference

1206 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Gauge (Page 320)

GraphicIOField (Page 324)
HTMLBrowser (Page 330)
IOField (Page 332)
Line (Page 336)
Listbox (Page 339)
MediaPlayer (Page 342)
MultiLineEdit (Page 345)
OnlineTableControl (Page 347)
OnlineTrendControl (Page 359)
OptionGroup (Page 371)
PLCCodeViewer (Page 376)
Polygon (Page 378)
Polyline (Page 381)
ProtectedAreaNameView (Page 385)
RangeLabelView (Page 386)
RangeQualityView (Page 388)
RecipeView (Page 389)
Rectangle (Page 395)
RoundButton (Page 398)
ScreenWindow (Page 404)
Slider (Page 408)
SmartClientView (Page 412)
StatusForce (Page 414)
Switch (Page 418)
SymbolicIOField (Page 422)
SymbolLibrary (Page 427)
SysDiagControl (Page 429)
TextField (Page 438)
TrendRulerControl (Page 441)
TrendView (Page 451)
TubeArcObject (Page 457)
TubeDoubleTeeObject (Page 459)
TubePolyline (Page 461)
TubeTeeObject (Page 464)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1207
VB scripting
1.5 VBS object model

UserArchiveControl (Page 466)

UserView (Page 478)
WindowSlider (Page 482)
ZoneLabelView (Page 487)
ZoneQualityView (Page 488)
S7GraphOverview (Page 402)
WLanQualityView (Page 485)

VisibleItems

Description
No access in runtime.

Warning

Description
Specifies the percentage of used memory space as of which a warning is to be generated.
Access in runtime: Read

Syntax
Object.Warning[=Int32]

Object
Required. An object of the type "ScreenItem" with the following format:
• 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
DiskSpaceView (Page 298)

WinCC Engineering V18 – Programming reference

1208 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

WarningColor

Description
Specifies the color in which the bar of the memory space view will be shown as soon as the
warning level is reached.
Access in runtime Read

Syntax
Object.WarningColor[=Color]

Object
Required. An object of the type "ScreenItem" with the following format:
• 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
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
DiskSpaceView (Page 298)

WarningLowerLimit

Description
Specifies the lower limit for "WarningLowerLimit".
The "WarningLowerLimitEnable" property must have the value "TRUE" for the limit to be
monitored.
Access in runtime: Read and write

Syntax
Object.WarningLowerLimit[=DOUBLE]

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1209
VB scripting
1.5 VBS object model

Object
Required. A "ScreenItem" object with the following format:
• 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":
• Representation upon reaching the limit
• Type of evaluation

See also
Bar (Page 259)

WarningLowerLimitColor

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.
Access in runtime Read and write

Syntax
Object.WarningLowerLimitColor[=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
"WarningLowerLimit".

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:

WinCC Engineering V18 – Programming reference

1210 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

RGB (255, 0, 0)
You can also use the VBS color constants such as vbRed and vbGreen.
The following values are defined with the "WarningUpperLimit", "WarningUpperLimitColor"
and "WarningUpperLimitRelative" properties:
• Limit
• Representation upon reaching the limit
• Type of evaluation

See also
Bar (Page 259)

WarningLowerLimitEnabled

Description
Specifies whether the "WarningLowerLimit" limit is to be monitored.
Access in runtime: Read and write

Syntax
Object.WarningLowerLimitEnabled[=BOOLEAN]

Object
Required. A "ScreenItem" object with the following format:
• 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
• Representation upon reaching the limit
• Type of evaluation

See also
Bar (Page 259)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1211
VB scripting
1.5 VBS object model

WarningLowerLimitRelative

Description
Specifies whether the low limit "WarningLowerLimit" is evaluated as a percentage or as an
absolute value.
Access in runtime Read and write

Syntax
Object.WarningLowerLimitRelative[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• 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 259)

WarningRangeColor

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.
Access in runtime Read and write

Syntax
Object.WarningRangeColor[=Color]

Object
Required. An object of the type "ScreenItem" with the following format:
• Gauge

Color
Optional. A value or a constant that specifies the color of the warning range.

WinCC Engineering V18 – Programming reference

1212 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

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
Gauge (Page 320)

WarningRangeStart

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.
Access in runtime: Read and write

Syntax
Object.WarningRangeStart[=SINGLE]

Object
Required. A "ScreenItem" object with the following format:
• 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 320)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1213
VB scripting
1.5 VBS object model

WarningRangeVisible

Description
Specifies whether the warning range in the scale of the "Gauge" object will be displayed.
Access in runtime: Read and write

Syntax
Object.WarningRangeVisible[=BOOLEAN]

Object
Required. A "ScreenItem" object with the following format:
• 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 320)

WarningUpperLimit

Description
Specifies the upper warning limit.
The "WarningUpperLimitEnabled"" property must have the value TRUE so that the limit is
monitored.
Access in runtime: Read and write

Syntax
Object.WarningUpperLimit[=DOUBLE]

Object
Required. A "ScreenItem" object with the following format:
• Bar

WinCC Engineering V18 – Programming reference

1214 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

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 259)

WarningUpperLimitColor

Description
Specifies the color for the high warning limit.
The ""WarningUpperLimitEnabled" property must have the value TRUE if the bar color is to
change once the limit has been reached.
Access in runtime
• RT Advanced: Read
• RT Professional: Read and write

Syntax
Object.WarningUpperLimitColor[=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 higher limit.

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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1215
VB scripting
1.5 VBS object model

See also
Bar (Page 259)

WarningUpperLimitEnabled

Description
Specifies whether the higher limit is to be monitored.
Access in runtime:
• RT Advanced: Read
• RT Professional: Read and write

Syntax
Object.WarningUpperLimitEnabled[=BOOLEAN]

Object
Required. A "ScreenItem" object with the following format:
• Bar

BOOLEAN
Optional. TRUE, if the higher limit is monitored.

WarningUpperLimitRelative

Description
Specifies whether the high limit "WarningUpperLimit" is to be evaluated as a percentage or as an
absolute value.
Access in runtime Read and write

Syntax
Object.WarningUpperLimitRelative[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• Bar

BOOLEAN
Optional. TRUE if the low limit "WarningUpperLimit" is to be evaluated as a percentage.

WinCC Engineering V18 – Programming reference

1216 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

See also
Bar (Page 259)

Width

Description
Specifies the width of the object in pixels.
Access in runtime: Read and write
You have read-only access in "Runtime Advanced" and "Panel Runtime" with the following
formats:
• AlarmView
• Bar
• BatteryView
• Button
• CameraControl
• Clock
• DateTimeField
• FunctionTrendControl
• Gauge
• GraphicIOField
• GraphicView
• HTMLBrowser
• IOField
• Line
• MediaPlayer
• PDFView
• PLCCodeViewer
• Polygon
• Polyline
• ProDiagOverview
• ProtectedAreaNameView
• RangeLabelView
• RangeQualityView
• RecipeView
• S7GraphOverview

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1217
VB scripting
1.5 VBS object model

• Slider
• SmartClientView
• StatusForce
• Switch
• SymbolicIOField
• SymbolLibrary
• SysDiagControl
• TextField
• TrendView
• UserView
• WLanQualityView
• ZoneLabelView
• ZoneQualityView

Syntax
Object.Width[=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.

Int32
Optional. A value or a constant that specifies the width of the object in pixels.

See also
AlarmControl (Page 237)
AlarmView (Page 251)
ApplicationWindow (Page 257)
Bar (Page 259)
BatteryView (Page 265)
Button (Page 267)
ChannelDiagnose (Page 274)
CheckBox (Page 275)
Circle (Page 279)
CircleSegment (Page 282)
CircularArc (Page 285)
Clock (Page 287)

WinCC Engineering V18 – Programming reference

1218 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

ComboBox (Page 290)

DateTimeField (Page 296)
DiskSpaceView (Page 298)
Ellipse (Page 300)
EllipseSegment (Page 303)
EllipticalArc (Page 306)
FunctionTrendControl (Page 309)
Gauge (Page 320)
GraphicIOField (Page 324)
GraphicView (Page 327)
HTMLBrowser (Page 330)
IOField (Page 332)
Line (Page 336)
Listbox (Page 339)
MediaPlayer (Page 342)
MultiLineEdit (Page 345)
OnlineTableControl (Page 347)
OnlineTrendControl (Page 359)
OptionGroup (Page 371)
PLCCodeViewer (Page 376)
Polygon (Page 378)
Polyline (Page 381)
ProtectedAreaNameView (Page 385)
RangeLabelView (Page 386)
RangeQualityView (Page 388)
RecipeView (Page 389)
Rectangle (Page 395)
RoundButton (Page 398)
ScreenWindow (Page 404)
Slider (Page 408)
SmartClientView (Page 412)
StatusForce (Page 414)
Switch (Page 418)
SymbolicIOField (Page 422)
SymbolLibrary (Page 427)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1219
VB scripting
1.5 VBS object model

SysDiagControl (Page 429)

TextField (Page 438)
TrendRulerControl (Page 441)
TrendView (Page 451)
TubeArcObject (Page 457)
TubeDoubleTeeObject (Page 459)
TubePolyline (Page 461)
TubeTeeObject (Page 464)
UserArchiveControl (Page 466)
UserView (Page 478)
WindowSlider (Page 482)
WLanQualityView (Page 485)
ZoneLabelView (Page 487)
ZoneQualityView (Page 488)
S7GraphOverview (Page 402)

WindowCloseEnabled

Description
Indicates whether a window can be closed in runtime.
Access in runtime: Read and write

Syntax
Object.WindowCloseEnabled[=BOOLEAN]

Object
Required. A "ScreenItem" object with the following format:
• ApplicationWindow
• ScreenWindow

BOOLEAN
Optional. TRUE, if the window can be closed in runtime.

See also
ApplicationWindow (Page 257)
ScreenWindow (Page 404)

WinCC Engineering V18 – Programming reference

1220 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

WindowMaximizeEnabled

Description
Returns whether the object can be maximized in runtime.
Access in runtime Read and write

Syntax
Object.WindowMaximizeEnabled[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• ApplicationWindow
• Screenwindow

BOOLEAN
Optional.
TRUE if the object can be maximized in runtime.
FALSE if the object cannot be maximized in runtime.

See also
ApplicationWindow (Page 257)
ScreenWindow (Page 404)

WindowMovingEnabled

Description
Returns whether the object can be moved in runtime.
Access in runtime: Read and write

Syntax
Object.WindowMovingEnabled[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• ApplicationWindow
• Screenwindow

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1221
VB scripting
1.5 VBS object model

BOOLEAN
Optional.
TRUE if the object can be moved in runtime.
FALSE if the object cannot be moved in runtime.

See also
ApplicationWindow (Page 257)
ScreenWindow (Page 404)

WindowOnTop

Description
Returns whether the object always remains in the foreground in runtime.
Access in runtime: Read and write

Syntax
Object.WindowOnTop[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• ApplicationWindow
• 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
ApplicationWindow (Page 257)
ScreenWindow (Page 404)

WindowsContents

Description
Returns the content of the print job or script diagnostics.
Access in runtime Read and write

WinCC Engineering V18 – Programming reference

1222 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Syntax
Object.WindowsContents[=WindowContent]

Object
Required. An object of the type "ScreenItem" with the following format:
• ApplicationWindow

WindowContent
Optional. A value or a constant that returns the content displayed in the object.

Designation Description
Function An application of the global script is displayed. The templates used for this are defined in the
"Template (Page 999)" 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 999)" property:

See also
ApplicationWindow (Page 257)

WindowSizingEnabled

Description
Indicates whether the size can be changed.
Access in runtime Read and write

Syntax
Object.WindowSizingEnabled[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• ApplicationWindow
• ScreenWindow

BOOLEAN
Optional. TRUE, if the size can be changed.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1223
VB scripting
1.5 VBS object model

See also
ApplicationWindow (Page 257)
ScreenWindow (Page 404)

WindowsStyle

Description
Specifies whether the object is displayed in the general Windows style.
Access in runtime:
• RT Advanced: NoAccess
• RT Professional: Read and write

Syntax
Object.WindowsStyle[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• Button
• WindowSlider
You have no access in runtime with the following format:
• Switch

BOOLEAN
Optional. TRUE, if the object will be displayed in the general Windows style.

See also
Button (Page 267)
WindowSlider (Page 482)
Switch (Page 418)

WindowStartupPosition

Description
Returns the position and the mode of the screen window when an independent screen window
is configured. Set "IndipendentWindow (Page 742)" to "TRUE".
Access in runtime: Read and write

WinCC Engineering V18 – Programming reference

1224 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Syntax
Object.WindowsStartupPosition[=PositionMode]

Object
Required. An object of the type "ScreenItem" with the following format:
• ScreenWindow

PositionMode
Optional. A value or a constant that returns the position and the mode of the screen window.

Designation Description
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
ScreenWindow (Page 404)

1.5.5.15 Properties X-Z

XAxes

Description
No access in runtime.

XAxisAdd

Description
Creates a new X-axis. The newly created X-axis is automatically referenced with "XAxisIndex".
Access in runtime: Read and write

Syntax
Object.XAxisAdd[=STRING]

Object
Required. An object of the type "ScreenItem" with the format:
• FunctionTrendControl

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1225
VB scripting
1.5 VBS object model

STRING
Required. A value or a constant that specifies the name of the new X-axis with "XAxisName".

See also
XAxisIndex (Page 1231)
FunctionTrendControl (Page 309)

XAxisAlignment

Description
Specifies the alignment of the X-axis referenced with "XAxisIndex".
Access in runtime Read and write

Syntax
Object.XAxisAlignment[=AxisAlignment]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl

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
FunctionTrendControl (Page 309)

XAxisAutoPrecisions

Description
Specifies whether the number of decimal places for an X-axis referenced with "XAxisIndex" is set
automatically.
Access in runtime Read and write

WinCC Engineering V18 – Programming reference

1226 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Syntax
Object.XAxisAutoPrecisions[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl

BOOLEAN
Optional.
TRUE if the number of decimal places is automatically determined.
FALSE if the value of "XAxisPrecisions" is used.

See also
XAxisIndex (Page 1231)
FunctionTrendControl (Page 309)

XAxisAutoRange

Description
Specifies whether the value range of an X-axis referenced with "XAxisIndex" is calculated
automatically.
Access in runtime Read and write

Syntax
Object.XAxisAutoRange[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl

BOOLEAN
Optional.
TRUE if the value range is calculated automatically.
FALSE if the value range is specified with "XAxisBeginValue" and "XAxisEndValue".

See also
XAxisIndex (Page 1231)
XAxisEndValue (Page 1230)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1227
VB scripting
1.5 VBS object model

XAxisBeginValue (Page 1228)

FunctionTrendControl (Page 309)

XAxisBeginValue

Description
Specifies the lower end of the value range of an X-axis referenced with "XAxisIndex".
Also set "XAxisAutoRange" to "FALSE".
Access in runtime Read and write

Syntax
Object.XAxisBeginValue[=DOUBLE]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl

DOUBLE
Optional. A value or a constant that specifies the low limit of the value range of the
referenced X-axis.

See also
XAxisAutoRange (Page 1227)
XAxisIndex (Page 1231)
FunctionTrendControl (Page 309)

XAxisColor

Description
Specifies the color of an X-axis referenced with "XAxisIndex".
Also set "XAxisInTrendColor" to "FALSE".
Access in runtime Read and write

Syntax
Object.XAxisColor[=Color]

WinCC Engineering V18 – Programming reference

1228 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl

Color
Optional. A value or a constant that specifies the color of the referenced axis.

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
FunctionTrendControl (Page 309)

XAxisCount

Description
Specifies the number of configured X-axes.
Access in runtime: Read and write

Syntax
Object.XAxisCount[=Int32]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl

Int32
Optional. A value or a constant that specifies the number of configured X-axes.

See also
FunctionTrendControl (Page 309)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1229
VB scripting
1.5 VBS object model

XAxisEndValue

Description
Specifies the upper end of the value range of an X-axis referenced with "XAxisIndex".
Also set "XAxisAutoRange" to "FALSE".
Access in runtime Read and write

Syntax
Object.XAxisEndValue[=DOUBLE]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl

DOUBLE
Optional. A value or a constant that specifies the high limit of the value range of the
referenced X-axis.

See also
XAxisAutoRange (Page 1227)
XAxisIndex (Page 1231)
FunctionTrendControl (Page 309)

XAxisExponentialFormat

Description
Specifies whether the values of an X-axis referenced with "XAxisIndex" are displayed in
exponential notation.
Access in runtime Read and write

Syntax
Object.XAxisExponentialFormat[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl

BOOLEAN
Optional.

WinCC Engineering V18 – Programming reference

1230 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

TRUE if the values are displayed in exponential notation.

FALSE if the values are not displayed in exponential notation.

See also
XAxisIndex (Page 1231)
FunctionTrendControl (Page 309)

XAxisIndex

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.
Access in runtime Read and write

Syntax
Object.XAxisIndex[=Int32]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl

Int32
Optional. A value or a constant that specifies, with the index, the X-axis to be edited.

See also
XAxisCount (Page 1229)
FunctionTrendControl (Page 309)

XAxisInTrendColor

Description
Specifies whether the color of the axis referenced with "XAxisIndex" corresponds to the trend
color.
Access in runtime Read and write

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1231
VB scripting
1.5 VBS object model

Syntax
Object.XAxisInTrendColor[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl

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
XAxisIndex (Page 1231)
FunctionTrendControl (Page 309)

XAxisLabel

Description
Specifies the label text for an X-axis referenced with "XAxisIndex".
Access in runtime Read and write

Syntax
Object.XAxisLabel[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl

STRING
Optional. A value or a constant that specifies the label text for the referenced X-axis.

See also
XAxisIndex (Page 1231)
FunctionTrendControl (Page 309)

WinCC Engineering V18 – Programming reference

1232 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

XAxisName

Description
Specifies the name of an X-axis referenced with "XAxisIndex".
Access in runtime Read and write

Syntax
Object.XAxisName[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl

STRING
Optional. A value or a constant that specifies the name of the referenced X-axis.

See also
XAxisIndex (Page 1231)
FunctionTrendControl (Page 309)

XAxisPrecisions

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".
Access in runtime Read and write

Syntax
Object.XAxisPrecisions[=Int16]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl

Int16
Optional. A value or a constant that specifies the number of decimal places.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1233
VB scripting
1.5 VBS object model

See also
FunctionTrendControl (Page 309)

XAxisRemove

Description
Removes an X-axis referenced with its name.
Access in runtime Read and write

Syntax
Object.XAxisRemove[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl

STRING
Optional. A value or a constant that specifies the name of the referenced X-axis to be
removed.

See also
FunctionTrendControl (Page 309)

XAxisRename

Description
Specifies the new name of an X-axis referenced with "XAxisIndex".
Access in runtime Read and write

Syntax
Object.XAxisRename[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl

STRING
Optional. A value or a constant that specifies the new name of the X-axis.

WinCC Engineering V18 – Programming reference

1234 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

See also
XAxisIndex (Page 1231)
FunctionTrendControl (Page 309)

XAxisRepos

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".
Access in runtime Read and write

Syntax
Object.XAxisRepos[=Int32]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl

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
XAxisIndex (Page 1231)
XAxisCount (Page 1229)
FunctionTrendControl (Page 309)

XAxisScalingType

Description
Specifies the type of scaling for the X-axis referenced with "XAxisIndex".
Access in runtime Read and write

Syntax
Object.XAxisScalingType[=AxisScalingType]

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1235
VB scripting
1.5 VBS object model

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl

AxisScalingType
Optional. A value or a constant that specifies the type of scaling of the referenced X axis.

Value VB constant Designation

0 hmiBarScalingLinear Linear
1 hmiBarScalingLogarithmic Logarithmic
2 hmiBarScalingNegativeLogarithmic Negative logarithmic

See also
XAxisIndex (Page 1231)
FunctionTrendControl (Page 309)

XAxisTrendWindow

Description
Specifies the trend diagram in which the axis referenced with "XAxisIndex" is displayed.
Access in runtime Read and write

Syntax
Object.XAxisTrendWindow[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl

STRING
Optional. A value or a constant that specifies the name of the trend diagram.

See also
XAxisIndex (Page 1231)
FunctionTrendControl (Page 309)

WinCC Engineering V18 – Programming reference

1236 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

XAxisVisible

Description
Specifies whether the X-axis referenced with "XAxisIndex" is displayed in the object.
Access in runtime Read and write

Syntax
Object.XAxisVisible[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl

BOOLEAN
Optional.
TRUE, if the referenced X axis is displayed.
FALSE, if the referenced X axis is not displayed.

See also
XAxisIndex (Page 1231)
FunctionTrendControl (Page 309)

YAxes

Description
No access in runtime.

YAxisAdd

Description
Creates a new Y-axis. The newly created Y-axis is automatically referenced with "YAxisIndex".
Access in runtime: Read and write

Syntax
Object.YAxisAdd[=STRING]

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1237
VB scripting
1.5 VBS object model

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl

STRING
Required. A value or a constant that specifies the name of the new Y-axis with "YAxisName".

See also
YAxisIndex (Page 1243)
FunctionTrendControl (Page 309)

YAxisAlignment

Description
Specifies the alignment of the Y-axis referenced with "YAxisIndex".
Access in runtime Read and write

Syntax
Object.YAxisAlignment[=AxisAlignment]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl

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
FunctionTrendControl (Page 309)

WinCC Engineering V18 – Programming reference

1238 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

YAxisAutoPrecisions

Description
Specifies whether the number of decimal places is specified automatically for a Y-axis referenced
with "YAxisIndex".
Access in runtime Read and write

Syntax
Object.YAxisAutoPrecisions[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl

BOOLEAN
Optional.
TRUE if the number of decimal places is automatically determined.
FALSE if the value of "YAxisPrecisions" is used.

See also
FunctionTrendControl (Page 309)

YAxisAutoRange

Description
Specifies whether the value range of a Y-axis referenced with "YAxisIndex" is calculated
automatically.
Access in runtime Read and write

Syntax
Object.YAxisAutoRange[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl

BOOLEAN
Optional.
TRUE if the value range is calculated automatically.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1239
VB scripting
1.5 VBS object model

FALSE if the value range is specified with "YAxisBeginValue" and "YAxisEndValue".

See also
FunctionTrendControl (Page 309)

YAxisBeginValue

Description
Specifies the lower end of the value range of a Y-axis referenced with "YAxisIndex".
Also set "YAxisAutoRange" to "FALSE".
Access in runtime: Read and write

Syntax
Object.YAxisBeginValue[=DOUBLE]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl

DOUBLE
Optional. A value or a constant that specifies the low limit of the value range of the
referenced Y-axis.

See also
FunctionTrendControl (Page 309)

YAxisColor

Description
Specifies the color of a Y-axis referenced with "YAxisIndex".
Also set "YAxisInTrendColor" to "FALSE".
Access in runtime Read and write

Syntax
Object.YAxisColor[=Color]

WinCC Engineering V18 – Programming reference

1240 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl

Color
Optional. A value or a constant that specifies the color of the referenced axis.

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
FunctionTrendControl (Page 309)

YAxisCount

Description
Specifies the number of configured Y-axes.
Access in runtime Read and write

Syntax
Object.YAxisCount[=Int32]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl

Int32
Optional. A value or a constant that specifies the number of configured Y-axes.

See also
FunctionTrendControl (Page 309)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1241
VB scripting
1.5 VBS object model

YAxisEndValue

Description
Specifies the upper end of the value range of a Y-axis referenced with "YAxisIndex".
Also set "YAxisAutoRange" to "FALSE".
Access in runtime Read and write

Syntax
Object.YAxisEndValue[=DOUBLE]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl

DOUBLE
Optional. A value or a constant that specifies the high limit of the value range of the
referenced Y-axis.

See also
FunctionTrendControl (Page 309)

YAxisExponentialFormat

Description
Specifies whether the values of a Y-axis referenced with "YAxisIndex" are displayed in
exponential notation.
Access in runtime Read and write

Syntax
Object.YAxisExponentialFormat[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl

BOOLEAN
Optional.
TRUE if the values are displayed in exponential notation.
FALSE if the values are not displayed in exponential notation.

WinCC Engineering V18 – Programming reference

1242 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

See also
FunctionTrendControl (Page 309)

YAxisIndex

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.
Access in runtime Read and write

Syntax
Object.YAxisIndex[=Int32]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl

Int32
Optional. A value or a constant that specifies, with the index, the Y-axis to be edited.

See also
FunctionTrendControl (Page 309)

YAxisInTrendColor

Description
Specifies whether the color of the axis referenced with "YAxisIndex" corresponds to the trend
color.
Access in runtime Read and write

Syntax
Object.YAxisInTrendColor[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1243
VB scripting
1.5 VBS object model

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 1243)
FunctionTrendControl (Page 309)

YAxisLabel

Description
Specifies the label text for a Y-axis referenced with "YAxisIndex".
Access in runtime Read and write

Syntax
Object.YAxisLabel[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl

STRING
Optional. A value or a constant that specifies the label text for the referenced Y-axis.

See also
FunctionTrendControl (Page 309)

YAxisName

Description
Specifies the name of a Y-axis referenced with "YAxisIndex".
Access in runtime Read and write

Syntax
Object.YAxisName[=STRING]

WinCC Engineering V18 – Programming reference

1244 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl

STRING
Optional. A value or a constant that specifies the name of the referenced Y-axis.

See also
FunctionTrendControl (Page 309)

YAxisPrecisions

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".
Access in runtime Read and write

Syntax
Object.YAxisPrecisions[=Int16]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl

Int16
Optional. A value or a constant that specifies the number of decimal places.

See also
FunctionTrendControl (Page 309)

YAxisRemove

Description
Removes a Y-axis referenced with its name.
Access in runtime Read and write

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1245
VB scripting
1.5 VBS object model

Syntax
Object.YAxisRemove[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl

STRING
Optional. A value or a constant that specifies the name of the referenced Y-axis to be
removed.

See also
FunctionTrendControl (Page 309)

YAxisRename

Description
Specifies the new name of a Y-axis referenced with "YAxisIndex".
Access in runtime Read and write

Syntax
Object.YAxisRename[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl

STRING
Optional. A value or a constant that specifies the new name of the selected Y-axis.

See also
FunctionTrendControl (Page 309)

YAxisRepos

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".

WinCC Engineering V18 – Programming reference

1246 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Access in runtime
• RT Advanced: Read
• RT Professional: Read and write

Syntax
Object.YAxisRepos[=Int32]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl

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

Description
Specifies the type of scaling for the Y-axis referenced with "YAxisIndex".
Access in runtime
• RT Advanced: Read
• RT Professional: Read and write

Syntax
Object.YAxisScalingType[=AxisScalingType]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl

AxisScalingType
Optional. A value or a constant that specifies the type of scaling of the referenced Y axis.

Value VB constant Designation

0 hmiBarScalingLinear Linear
1 hmiBarScalingLogarithmic Logarithmic
2 hmiBarScalingNegativeLogarithmic Negative logarithmic

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1247
VB scripting
1.5 VBS object model

YAxisTrendWindow

Description
Specifies the trend diagram in which the axis referenced with "YAxisIndex" is displayed.
Access in runtime
• RT Advanced: Read
• RT Professional: Read and write

Syntax
Object.YAxisTrendWindow[=STRING]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl

STRING
Optional. A value or a constant that specifies the name of the trend diagram.

YAxisVisible

Description
Specifies whether the Y-axis referenced with "YAxisIndex" is displayed in the object.
Access in runtime
• RT Advanced: Read
• RT Professional: Read and write

Syntax
Object.YAxisVisible[=BOOLEAN]

Object
Required. An object of the type "ScreenItem" with the following format:
• FunctionTrendControl

BOOLEAN
Optional.
TRUE, if the referenced Y axis is displayed.
FALSE, if the referenced Y axis is not displayed.

WinCC Engineering V18 – Programming reference

1248 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

ZeroPoint

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".
Access in runtime: Read and write

Syntax
Object.ZeroPoint[=Int32]

Object
Required. A "ScreenItem" object with the following format:
• 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 259)

ZoomFactor

Description
Specifies the zoom factor of a screen or screen window.
Access in runtime Read and write

Syntax
Object.ZoomFactor[=Int32]

Object
Required. An object of the type "ScreenItem" with the following format:
• ScreenWindow

Int32
Optional. A value or a constant that specifies the zoom factor for displaying the embedded
graphic.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1249
VB scripting
1.5 VBS object model

See also
ScreenWindow (Page 404)

1.5.6 Methods

1.5.6.1 Methods A-G

Activate

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
• FunctionTrendControl
• HTMLBrowser
• Slider
• GraphicIOField
• SymbolicIOField
• Button
• AlarmControl
• UserView
• UserArchiveControl
• 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.

WinCC Engineering V18 – Programming reference

1250 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Parameters
--

Example

Dim objO
Set objO = HMIRuntime.Screens("Screen_1").ScreenItems("IO-Field_1")
objO.Activate

See also
ScreenItem (Page 219)
Screen (Page 216)
ChannelDiagnose (Page 274)
CheckBox (Page 275)
Circle (Page 279)
CircleSegment (Page 282)
CircularArc (Page 285)
Clock (Page 287)
Connector (Page 293)
DateTimeField (Page 296)
DiskSpaceView (Page 298)
Ellipse (Page 300)
EllipseSegment (Page 303)
EllipticalArc (Page 306)
Gauge (Page 320)
GraphicIOField (Page 324)
GraphicView (Page 327)
HTMLBrowser (Page 330)
IOField (Page 332)
Rectangle (Page 395)
ScriptDiagnostics (Page 406)
Switch (Page 418)
SymbolicIOField (Page 422)
SymbolLibrary (Page 427)
TextField (Page 438)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1251
VB scripting
1.5 VBS object model

TrendView (Page 451)

TubeArcObject (Page 457)
TubeDoubleTeeObject (Page 459)
TubePolyline (Page 461)
TubeTeeObject (Page 464)
UserView (Page 478)
WindowSlider (Page 482)
StatusForce (Page 414)
SmartClientView (Page 412)
Slider (Page 408)
ScreenWindow (Page 404)
RoundButton (Page 398)
Polyline (Page 381)
Polygon (Page 378)
OptionGroup (Page 371)
MultiLineEdit (Page 345)
MediaPlayer (Page 342)
Listbox (Page 339)
Line (Page 336)
Bar (Page 259)
Button (Page 267)
OnlineTrendControl (Page 359)
OnlineTableControl (Page 347)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)
FunctionTrendControl (Page 309)
AlarmView (Page 251)
AlarmControl (Page 237)

ActivateDynamic

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.

WinCC Engineering V18 – Programming reference

1252 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Syntax
Expression.ActivateDynamic (ByVAl Property name As String, ByVal
Cycle name As Cycle)

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
ChannelDiagnose (Page 274)
CheckBox (Page 275)
Circle (Page 279)
CircleSegment (Page 282)
CircularArc (Page 285)
Clock (Page 287)
Connector (Page 293)
DiskSpaceView (Page 298)
Ellipse (Page 300)
EllipseSegment (Page 303)
EllipticalArc (Page 306)
Gauge (Page 320)
GraphicIOField (Page 324)
GraphicView (Page 327)
HTMLBrowser (Page 330)
IOField (Page 332)
Rectangle (Page 395)
ScriptDiagnostics (Page 406)
SymbolicIOField (Page 422)
SymbolLibrary (Page 427)
TextField (Page 438)
TubeArcObject (Page 457)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1253
VB scripting
1.5 VBS object model

TubeDoubleTeeObject (Page 459)

TubePolyline (Page 461)
TubeTeeObject (Page 464)
UserView (Page 478)
WindowSlider (Page 482)
Slider (Page 408)
ScreenWindow (Page 404)
RoundButton (Page 398)
Polyline (Page 381)
Polygon (Page 378)
OptionGroup (Page 371)
MultiLineEdit (Page 345)
MediaPlayer (Page 342)
Listbox (Page 339)
Line (Page 336)
Bar (Page 259)
Button (Page 267)
OnlineTrendControl (Page 359)
OnlineTableControl (Page 347)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)
FunctionTrendControl (Page 309)
AlarmControl (Page 237)

Add

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".

WinCC Engineering V18 – Programming reference

1254 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

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
Set group = HMIRuntime.Tags.CreateTagSet
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".

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1255
VB scripting
1.5 VBS object model

Parameters
VARIANT

Parameters Description
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 206)
OnlineTrendControl (Page 359)

AttachDB method

Description
Executes the "Connect backup" key function of the control.

Syntax
Expression.AttachDB()

Expression
Required. An expression that returns an object of the type "ScreenItem".

Parameters
--

See also
OnlineTrendControl (Page 359)
OnlineTableControl (Page 347)
FunctionTrendControl (Page 309)
AlarmControl (Page 237)

WinCC Engineering V18 – Programming reference

1256 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

CalculateStatistic

Description
Executes the "Calculate statistics" key function of the f(t) trend view and the table view.

Syntax
Expression.CalculateStatistic()

Expression
Required. An expression that returns an object of the type "ScreenItem".

Parameters
--

See also
OnlineTrendControl (Page 359)
OnlineTableControl (Page 347)

CopyRows

Description
Executes the "Copy lines" key function of the control.

Syntax
Expression.CopyRows()

Expression
Required. An expression that returns an object of the type "ScreenItem".

Parameters
--

See also
OnlineTrendControl (Page 359)
OnlineTableControl (Page 347)
UserArchiveControl (Page 466)
AlarmControl (Page 237)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1257
VB scripting
1.5 VBS object model

Create

Description
Creates a new Alarm object.

Syntax
Expression.Create (VARIANT vtApplication)

Expression
Required. An expression which returns an object of type "Alarm".

Parameters
VARIANT

Parameters Description
vtApplication Name of alarm object (optional)

See also
OnlineTrendControl (Page 359)

CreateTagSet

Description
Creates a new TagSet object. This object may be used for optimized multi-tag access.

syntax
Expression.CreateTagSet()

Expression
Necessary. An expression which returns an object of type "TagSet".

Parameters
VARIANT

WinCC Engineering V18 – Programming reference

1258 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Example:
The following example shows how to create a TagSet object.

'VBS168
'Build a Reference to the TagSet Object
Dim group
Set group = HMIRuntime.Tags.CreateTagSet

See also
OnlineTrendControl (Page 359)

CutRows

Description
Executes the "Cut rows" key function of the recipe view.

Syntax
Expression.CutRows()

Expression
Required. An expression that returns an object of the type "ScreenItem".

Parameters
--

See also
OnlineTrendControl (Page 359)
UserArchiveControl (Page 466)

DeactivateDynamic

Description
Deactivates the trigger of the "ActivateDynamic" method used for the specified property in/
during runtime.

Syntax
Expression.DeactivateDynamic(ByVal Property name As String)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1259
VB scripting
1.5 VBS object model

Expression
Required. An expression that returns an object of the type "ScreenItem".

Parameters

Parameters Description
Property name Property, whose trigger is disabled. Use the VBS
name of the property.

See also
ChannelDiagnose (Page 274)
CheckBox (Page 275)
Circle (Page 279)
CircleSegment (Page 282)
CircularArc (Page 285)
Clock (Page 287)
Connector (Page 293)
DiskSpaceView (Page 298)
Ellipse (Page 300)
EllipseSegment (Page 303)
EllipticalArc (Page 306)
Gauge (Page 320)
GraphicIOField (Page 324)
GraphicView (Page 327)
HTMLBrowser (Page 330)
IOField (Page 332)
Rectangle (Page 395)
ScriptDiagnostics (Page 406)
SymbolicIOField (Page 422)
SymbolLibrary (Page 427)
TextField (Page 438)
TubeArcObject (Page 457)
TubeDoubleTeeObject (Page 459)
TubePolyline (Page 461)
TubeTeeObject (Page 464)
UserView (Page 478)

WinCC Engineering V18 – Programming reference

1260 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

WindowSlider (Page 482)

Slider (Page 408)
ScreenWindow (Page 404)
RoundButton (Page 398)
Polyline (Page 381)
Polygon (Page 378)
OptionGroup (Page 371)
MultiLineEdit (Page 345)
MediaPlayer (Page 342)
Listbox (Page 339)
Line (Page 336)
Bar (Page 259)
Button (Page 267)
OnlineTrendControl (Page 359)
OnlineTableControl (Page 347)
TrendRulerControl (Page 441)
FunctionTrendControl (Page 309)
AlarmControl (Page 237)

DeleteRows

Description
Executes the "Delete rows" key function of the recipe view.

Syntax
Expression.DeleteRows()

Expression
Required. An expression that returns an object of the type "ScreenItem".

Parameters
--

See also
OnlineTrendControl (Page 359)
UserArchiveControl (Page 466)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1261
VB scripting
1.5 VBS object model

DetachDB

Description
Executes the "Disconnect backup" key function of the control.

Syntax
Expression.DetachDB()

Expression
Required. An expression that returns an object of the type "ScreenItem".

Parameters
--

See also
OnlineTrendControl (Page 359)
OnlineTableControl (Page 347)
FunctionTrendControl (Page 309)
AlarmControl (Page 237)

Edit

Description
Executes the "Edit" key function of the table view.

Syntax
Expression.Edit()

Expression
Required. An expression that returns an object of the type "ScreenItem".

Parameters
--

WinCC Engineering V18 – Programming reference

1262 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

See also
OnlineTrendControl (Page 359)
OnlineTableControl (Page 347)
AlarmControl (Page 237)

Export

Description
Executes the "Export log" or "Export data" key function of the control.

Syntax
Expression.Export()

Expression
Required. An expression that returns an object of the type "ScreenItem".

Parameters
--

See also
OnlineTrendControl (Page 359)
OnlineTableControl (Page 347)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)
FunctionTrendControl (Page 309)
AlarmControl (Page 237)

GetColumn

Description
Returns the column object of the recipe view designated by name or index as "ICCAxUAColumn"
type.

Syntax
Ausdruck.GetColumn(ByVal vIndex As Variant)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1263
VB scripting
1.5 VBS object model

Expression
Necessary. An expression that returns an object of the "ScreenItem" type.

Parameters
VARIANT

Parameters Description
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
OnlineTrendControl (Page 359)
UserArchiveControl (Page 466)

GetColumnCollection

Description
Returns the list of all column objects of the recipe view as "ICCAxCollection" type.

Syntax
Ausdruck.GetColumnCollection()

WinCC Engineering V18 – Programming reference

1264 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Expression
Necessary. An expression that returns an object of the "ScreenItem" type.

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
OnlineTrendControl (Page 359)
UserArchiveControl (Page 466)

GetHistlistColumnCollection

Description
Returns the list of all column objects of the message view hit list as "ICCAxCollection" type.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1265
VB scripting
1.5 VBS object model

Syntax
Expression.GetHitlisteColumnCollection()

Expression
Necessary. An expression that returns an object of the "ScreenItem" type.

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

'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
OnlineTrendControl (Page 359)
AlarmControl (Page 237)

WinCC Engineering V18 – Programming reference

1266 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

GetHitlistColumn

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
Necessary. An expression that returns an object of the "ScreenItem" type.

Parameters
VARIANT

Parameters Description
vIndex Index or name of hitlist column

Example

'VBS314
Dim ctrl
Dim objHitlistColumn
Set ctrl = ScreenItems("AlarmControl")
Set objHitlistColumn = ctrl.GetHitlistColumn("Date")
objHitlistColumn.Sort = 2
Set objHitlistColumn = ctrl.GetHitlistColumn("AverageComeGo")
objHitlistColumn.Visible = FALSE

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 "HitlistColumn" listing, for example, you write "objHitlistColumn.Visible" instead of
"objHitlistColumn.HitlistColumnVisible".

See also
OnlineTrendControl (Page 359)
AlarmControl (Page 237)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1267
VB scripting
1.5 VBS object model

GetMessageBlock

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
Necessary. An expression that returns an object of the "ScreenItem" type.

Parameters
VARIANT

Parameters Description
vIndex Index or name of message block.

Example

'VBS316
Dim ctrl
Dim objMsgBlock
Set ctrl = ScreenItems("AlarmControl")
Set objMsgBlock = ctrl.GetMessageBlock("Date")
objMsgBlock.Align = 2
Set objMsgBlock = ctrl.GetMessageBlock("Number")
objMsgBlock.LeadingZeros = 4

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 "MessageBlock" listing, for example, you write "objMsgBlock.Align" instead of
"objMsgBlock.MessageBlockAlign".

See also
OnlineTrendControl (Page 359)
AlarmControl (Page 237)

WinCC Engineering V18 – Programming reference

1268 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

GetMessageBlockCollection

Description
Returns the list of all message block objects of the message view as "ICCAxCollection" type.

Syntax
Expression.GetMessageBlockCollection()

Expression
Necessary. An expression that returns an object of the "ScreenItem" type.

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

'VBS317
Dim ctrl
Dim coll
Dim msgblock
Set ctrl = ScreenItems("AlarmControl")
Set coll = ctrl.GetMessageBlockCollection
For Each msgblock In coll
msgblock.Align = 1
msgblock.Length = 12
msgblock.Selected = TRUE
Next

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1269
VB scripting
1.5 VBS object model

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 "MessageBlock" listing, for example, you write "msgblock.Align" instead of
"msgblock.MessageBlockAlign".

See also
OnlineTrendControl (Page 359)
AlarmControl (Page 237)

GetMessageColumn

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
Necessary. An expression that returns an object of the "ScreenItem" type.

Parameters
VARIANT

Parameters Description
vIndex Index or name of column in message list.

Example

'VBS318
Dim ctrl
Dim objMessColumn
Set ctrl = ScreenItems("AlarmControl")
Set objMessColumn = ctrl.GetMessageColumn("Date")
objMessColumn.Visible = FALSE
Set objMessColumn = ctrl.GetMessageColumn("Number")
objMessColumn.Sort = 1

WinCC Engineering V18 – Programming reference

1270 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

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 "MessageColumn" listing, for example, you write "objMessColumn.Visible" instead of
"objMessColumn.MessageColumnVisible".

See also
OnlineTrendControl (Page 359)
AlarmControl (Page 237)

GetMessageColumnCollection

Description
Returns the list of all column objects of the message view as "ICCAxCollection" type.

Syntax
Expression.GetMessageColumnCollection()

Expression
Necessary. An expression that returns an object of the "ScreenItem" type.

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)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1271
VB scripting
1.5 VBS object model

Example

'VBS319
Dim ctrl
Dim coll
Dim msgcol
Set ctrl = ScreenItems("AlarmControl")
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
OnlineTrendControl (Page 359)
AlarmControl (Page 237)

GetOperatorMessage

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
Necessary. An expression that returns an object of the "ScreenItem" type.

Parameters
VARIANT

Parameters Description
vIndex Index or name of operator message

WinCC Engineering V18 – Programming reference

1272 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Example

'VBS320
Dim ctrl
Dim objOpMess
Set ctrl = ScreenItems("AlarmControl")
Set objOpMess = ctrl.GetOperatorMessage(0)
objOpMess.Source1 = "Number"
objOpMess.SourceType1 = 1

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 "OperatorMessage" listing, for example, you write "objOpMess.Source1" instead of
"objOpMess.OperatorMessageSource1".

See also
OnlineTrendControl (Page 359)
AlarmControl (Page 237)

GetOperatorMessageCollection

Description
Returns the list of all operator message objects of the message view as "ICCAxCollection" type.

Syntax
Expression.GetOperatorMessageCollection()

Expression
Necessary. An expression that returns an object of the "ScreenItem" type.

Parameters
--

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1273
VB scripting
1.5 VBS object model

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

'VBS321
Dim ctrl
Dim coll
Dim opmsg
Set ctrl = ScreenItems("AlarmControl")
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
OnlineTrendControl (Page 359)
AlarmControl (Page 237)

GetRow

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.

WinCC Engineering V18 – Programming reference

1274 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Parameters
Long

Parameters Description
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
OnlineTrendControl (Page 359)
OnlineTableControl (Page 347)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)
AlarmControl (Page 237)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1275
VB scripting
1.5 VBS object model

GetRowCollection

Description
Returns the list of all row objects of the table-based controls type "ICCAxDataRowCollection".

Syntax
Expression.GetRowCollection()

Expression
Necessary. An expression that returns an object of the "ScreenItem" type.

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 ctrl = ScreenItems("AlarmControl")
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) & " "
'enumerate and trace out column titles and cell texts
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

WinCC Engineering V18 – Programming reference

1276 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

See also
OnlineTrendControl (Page 359)
OnlineTableControl (Page 347)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)
AlarmControl (Page 237)

GetRulerBlock

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
Necessary. An expression that returns an object of the "ScreenItem" type.

Parameters
VARIANT

Parameters Description
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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1277
VB scripting
1.5 VBS object model

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 "RulerBlock" listing, for example, you write "objRulerBlock.Caption" instead of
"objRulerBlock.BlockCaption".

See also
OnlineTrendControl (Page 359)
TrendRulerControl (Page 441)

GetRulerBlockCollection

Description
Returns the list of all block objects of the evaluation table as "ICCAxCollection" type.

Syntax
Expression.GetRulerBlockCollection()

Expression
Necessary. An expression that returns an object of the "ScreenItem" type.

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)

WinCC Engineering V18 – Programming reference

1278 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Example

'VBS323
Dim ctrl
Dim coll
Dim rulerblock
Set ctrl = ScreenItems("RulerControl")
Set coll = ctrl.GetRulerBlockCollection
For Each rulerblock In coll
rulerblock.Align = 1
rulerblock.Length = 12
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 "RulerBlock" listing, for example, you write "rulerblock.Align" instead of
"rulerblock.RulerBlockAlign".

See also
OnlineTrendControl (Page 359)
TrendRulerControl (Page 441)

GetRulerColumn

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
Necessary. An expression that returns an object of the "ScreenItem" type.

Parameters
VARIANT

Parameters Description
vIndex Index or name of the column of the evaluation

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1279
VB scripting
1.5 VBS object model

Example

'VBS324
Dim ctrl
Dim objRulercol
Set ctrl = ScreenItems("RulerControl")
Set objRulercol = ctrl.GetRulerColumn("Name")
objRulercol.Sort = 0
Set objRulercol = ctrl.GetRulerColumn("ValueY")
objRulercol.Visible = FALSE

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 "RulerColumn" listing, for example, you write "objRulercol.Visible" instead of
"objRulercol.ColumnVisible".

See also
OnlineTrendControl (Page 359)
TrendRulerControl (Page 441)

GetRulerColumnCollection

Description
Returns the list of all column objects of the evaluation table as "ICCAxCollection" type.

Syntax
Expression.GetRulerColumnCollection()

Expression
Necessary. An expression that returns an object of the "ScreenItem" type.

Parameters
--

WinCC Engineering V18 – Programming reference

1280 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

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

'VBS325
Dim ctrl
Dim coll
Dim rulercol
Set ctrl = ScreenItems("RulerControl")
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
OnlineTrendControl (Page 359)
TrendRulerControl (Page 441)

GetRulerData

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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1281
VB scripting
1.5 VBS object model

Parameters

Parameters Description
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
OnlineTrendControl (Page 359)

GetSelectedRow

Description
Returns the selected row object of a table-based control as "ICCAxDataRow" type.

Syntax
Expression.GetSelectedRow()

Expression
Necessary. An expression that returns an object of the "ScreenItem" type.

Parameters
--

WinCC Engineering V18 – Programming reference

1282 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

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
'enumerate and trace out column titles and cell texts
For lCellIndex = 1 To lCellCount
HMIRuntime.trace headingRow.CellText(lCellIndex) & ": "
HMIRuntime.trace selectedRow.CellText(lCellIndex)
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
OnlineTrendControl (Page 359)
OnlineTableControl (Page 347)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)
AlarmControl (Page 237)

GetSelectedRows

Description
Returns the selected row objects of a table-based control as type "ICCAxDataRow" for multiple
selection.

Syntax
Expression.GetSelectedRows()

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1283
VB scripting
1.5 VBS object model

Expression
Necessary. An expression that returns an object of the "ScreenItem" type.

Parameters
--

Example

'VBS359
Dim ctrl
Dim lCellIndex
Dim lCellCount
Dim lRowIndex
Dim lRowCount
Dim headingRow
Dim selectedRow
Dim selectedRows
Set ctrl = ScreenItems("TableControl")
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
'enumerate and trace out column titles and cell texts
For lCellIndex = 1 To lCellCount
HMIRuntime.trace headingRow.CellText(lCellIndex) & ": "
HMIRuntime.trace selectedRow.CellText(lCellIndex)
HMIRuntime.trace vbNewLine
Next
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
OnlineTrendControl (Page 359)
OnlineTableControl (Page 347)
TrendRulerControl (Page 441)

WinCC Engineering V18 – Programming reference

1284 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

UserArchiveControl (Page 466)

AlarmControl (Page 237)

GetStatisticAreaColumn

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
Necessary. An expression that returns an object of the "ScreenItem" type.

Parameters
VARIANT

Parameters Description
vIndex Index or name of column of statistics area window.

Example

'VBS327
Dim ctrl
Dim objStatAreaCol
Set ctrl = ScreenItems("RulerControl")
Set objStatAreaCol = ctrl.GetStatisticAreaColumn("DatasourceY")
objStatAreaCol.Visible = FALSE
Set objStatAreaCol = ctrl.GetStatisticAreaColumn("ValueY(LL)")
objStatAreaCol.Sort = 1

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 "StatisticAreaColumn" listing, for example, you write "objStatAreaCol.Visible" instead of
"objStatAreaCol.ColumnVisible".

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1285
VB scripting
1.5 VBS object model

See also
OnlineTrendControl (Page 359)
TrendRulerControl (Page 441)

GetStatisticAreaColumnCollection

Description
Returns the list of all column objects of the statistic area window of the evaluation table as
"ICCAxCollection" type.

Syntax
Ausdruck.GetStatisticAreaColumnCollection()

Expression
Necessary. An expression that returns an object of the "ScreenItem" type.

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)

WinCC Engineering V18 – Programming reference

1286 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Example

'VBS328
Dim ctrl
Dim coll
Dim statcol
Set ctrl = ScreenItems("RulerControl")
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
OnlineTrendControl (Page 359)
TrendRulerControl (Page 441)

GetStatisticResultColumn

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
Necessary. An expression that returns an object of the "ScreenItem" type.

Parameters
VARIANT

Parameters Description
vIndex Index or name of column of statistics window.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1287
VB scripting
1.5 VBS object model

Example

'VBS329
Dim ctrl
Dim objStatResCol
Set ctrl = ScreenItems("RulerControl")
Set objStatResCol = ctrl.GetStatisticResultColumn("MaxValue")
objStatResCol.Visible = FALSE
Set objStatResCol = ctrl.GetStatisticResultColumn("Average")
objStatResCol.Sort = 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 "StatisticResultColumn" listing, for example, you write "objStatResCol.Visible" instead of
"objStatResCol.ColumnVisible".

See also
OnlineTrendControl (Page 359)
TrendRulerControl (Page 441)

GetStatisticResultColumnCollection

Description
Returns the list of all column objects of the statistic window of the evaluation table as
"ICCAxCollection" type.

Syntax
Ausdruck.GetStatisticResultColumnCollection()

Expression
Necessary. An expression that returns an object of the "ScreenItem" type.

Parameters
--

WinCC Engineering V18 – Programming reference

1288 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

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

'VBS330
Dim ctrl
Dim coll
Dim statcol
Set ctrl = ScreenItems("RulerControl")
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
OnlineTrendControl (Page 359)
TrendRulerControl (Page 441)

GetStatusbarElement

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
Required An expression that returns an object of the "ScreenItem" type.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1289
VB scripting
1.5 VBS object model

Parameters
VARIANT

Parameters Description
vIndex Index or name of status bar element.

Example

'VBS331
Dim ctrl
Dim objStatusBar
Set ctrl = ScreenItems( "Control1" )
Set objStatusBar = ctrl.GetStatusbarElement(1)
objStatusBar.Visible = FALSE
Set objStatusBar = ctrl.GetStatusbarElement(3)
objStatusBar.Width = 10

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 "StatusbarElement" listing, for example, you write "objStatusBar.Visible" instead of
"objStatusBar.StatusbarElementVisible".

See also
OnlineTrendControl (Page 359)
OnlineTableControl (Page 347)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)
FunctionTrendControl (Page 309)
AlarmControl (Page 237)

GetStatusbarElementCollection

Description
Returns the list of all status bar elements of the control as type "ICCAxCollection".

Syntax
Ausdruck.GetStatusbarElementCollection()

WinCC Engineering V18 – Programming reference

1290 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Expression
Required An expression that returns an object of the "ScreenItem" type.

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

'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
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 "StatusbarElement" listing, for example, you write "statelement.Name" instead of
"statelement.StatusbarElementName".

See also
OnlineTrendControl (Page 359)
OnlineTableControl (Page 347)
TrendRulerControl (Page 441)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1291
VB scripting
1.5 VBS object model

UserArchiveControl (Page 466)

FunctionTrendControl (Page 309)
AlarmControl (Page 237)

GetTimeAxis

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

Parameters Description
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

WinCC Engineering V18 – Programming reference

1292 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

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 "TimeAxis" listing, for example, you write "objTimeAx.Visible" instead of
"objTimeAx.TimeAxisVisible".

See also
OnlineTrendControl (Page 359)

GetTimeAxisCollection

Description
Returns a list of all time objects of the f(t) trend view as "ICCAxCollection" type.

Syntax
Expression.GetTimeAxisCollection()

Expression
Necessary. Expression that returns an object of the "ScreenItem" type.

Parameters
--

Features and functions of the ICCAxCollection

The following properties are available for ICCAxCollection:
• Count
• Item
The following functions are available for ICCAxCollection:
• AddItem(vName) As Object
• RemoveItem(vIndex)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1293
VB scripting
1.5 VBS object model

Example

'VBS334
Dim ctrl
Dim objTrendWnd
Dim objTimeAxis1
Dim objTimeAxis2
Dim objTrend
Set ctrl = ScreenItems("OnlineTrendControl")
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
'The format to be used for date and time entries depends on the
'regional settings and language options in the operating system.
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
Set objTrend = ctrl.GetTrendCollection.AddItem("myTrend2")
objTrend.TrendWindow = objTrendWnd.Name
objTrend.TimeAxis = objTimeAxis2.Name

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 "TimeAxis" listing, for example, you write "objTimeAxis1.Label" instead of
"objTimeAxis1.TimeAxisLabel".

See also
OnlineTrendControl (Page 359)

WinCC Engineering V18 – Programming reference

1294 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

GetTimeColumn

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
Necessary. An expression that returns an object of the "ScreenItem" type.

Parameters
VARIANT

Parameters Description
vIndex Index or name of time column.

Example

'VBS335
Dim ctrl
Dim objTimeCol
Set ctrl = ScreenItems("TableControl")
Set objTimeCol = ctrl.GetTimeColumn("Timecolumn1")
objTimeCol.ShowDate = FALSE
Set objTimeCol = ctrl.GetTimeColumn("Timecolumn2")
objTimeCol.Visible = FALSE

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 "TimeColumn" listing, for example, you write "objTimeColumn.ShowDate" instead of
"objTimeColumn.TimeColumnShowDate".

See also
OnlineTrendControl (Page 359)
OnlineTableControl (Page 347)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1295
VB scripting
1.5 VBS object model

GetTimeColumnCollection

Description
Returns the list of all time column objects of the table view as "ICCAxCollection" type.

Syntax
Expression.GetTimeColumnCollection()

Expression
Necessary. Expression that returns an object of the "ScreenItem" type.

Parameters
--

Features and functions of the ICCAxCollection

The following properties are available for ICCAxCollection:
• Count
• Item
The following functions are available for ICCAxCollection:
• AddItem(vName) As Object
• RemoveItem(vIndex)

WinCC Engineering V18 – Programming reference

1296 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Example

'VBS336
Dim ctrl
Dim objTimeCol1
Dim objTimeCol2
Dim coll
Dim timecol
Set ctrl = ScreenItems("TableControl")
Set objTimeCol1 = ctrl.GetTimeColumnCollection.AddItem("TimeColumn2010")
Set objTimeCol2 = ctrl.GetTimeColumnCollection.AddItem("TimeColumn2011")
objTimeCol1.Caption = "2010"
objTimeCol1.RangeType = 1
'The format to be used for date and time entries depends on the
'regional settings and language options in the operating system.
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
OnlineTrendControl (Page 359)
OnlineTableControl (Page 347)

GetToolbarButton

Description
Returns the button function designated by name or index on the control toolbar as
"ICCAxToolbarButton" type.

Syntax
Ausdruck.GetToolbarButton(ByVal vIndex As Variant)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1297
VB scripting
1.5 VBS object model

Expression
Necessary. An expression that returns an object of the "ScreenItem" type.

Parameters
VARIANT

Parameters Description
vIndex Index or name of toolbar button function.

Example

'VBS337
Dim ctrl
Set ctrl = ScreenItems( "Control1" )
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
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 "ToolbarButton" listing, for example, you write "toolbu.Index" instead of
"toolbu.ToolbarButtonIndex".

See also
OnlineTrendControl (Page 359)
OnlineTableControl (Page 347)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)
FunctionTrendControl (Page 309)
AlarmControl (Page 237)

GetToolbarButtonCollection

Description
Returns the list of all button functions of the control toolbar as "ICCAxCollection" type.

WinCC Engineering V18 – Programming reference

1298 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Syntax
Ausdruck.GetToolbarButtonCollection()

Expression
Necessary. An expression that returns an object of the "ScreenItem" type.

Parameters
--

Features and functions of the ICCAxCollection

The following properties are available for the ICCAxCollection:
• Count
• Item
The following methods are available for the ICCAxCollection:
• AddItem(vName) As Object
• RemoveItem(vIndex)

Example

'VBS338
Dim ctrl
Dim coll
Dim toolbu
Set ctrl = ScreenItems( "Control1" )
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
OnlineTrendControl (Page 359)
OnlineTableControl (Page 347)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)
FunctionTrendControl (Page 309)
AlarmControl (Page 237)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1299
VB scripting
1.5 VBS object model

GetTrend

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
Necessary. An expression that returns an object of the "ScreenItem" type.

Parameters
VARIANT

Parameters Description
vIndex Index or name of curve.

Example for Runtime Professional

'VBS339
Dim ctrl
Dim objTrend
Set ctrl = ScreenItems("OnlineTrendControl")
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
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 "Trend" listing, for example, you write "objTrend.PointStyle" instead of
"objTrend.TrendPointStyle".

See also
OnlineTrendControl (Page 359)
FunctionTrendControl (Page 309)

WinCC Engineering V18 – Programming reference

1300 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

GetTrendCollection

Description
Returns the list of all trends of the f(t) or f(x) trend view as "ICCAxCollection" type.

Syntax
Ausdruck.GetTrendCollection()

Expression
Necessary. An expression that returns an object of the "ScreenItem" type.

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 for Runtime Professional

'VBS340
Dim ctrl
Dim objTrendWnd
Dim objTimeAxis
Dim objValAxis
Dim objTrend
Set ctrl = ScreenItems("OnlineTrendControl")
Set objTrendWnd = ctrl.GetTrendWindowCollection.AddItem("myWindow")
Set objTimeAxis = ctrl.GetTimeAxisCollection.AddItem("myTimeAxis")
Set objValAxis = ctrl.GetValueAxisCollection.AddItem("myValueAxis")
objTimeAxis.TrendWindow = objTrendWnd.Name
objValAxis.TrendWindow = objTrendWnd.Name
Set objTrend = ctrl.GetTrendCollection.AddItem("myTrend1")
objTrend.Provider = 1
objTrend.TagName = "Archive\ArchiveTag1"
objTrend.TrendWindow = objTrendWnd.Name
objTrend.TimeAxis = objTimeAxis.Name
objTrend.ValueAxis = objValAxis.Name

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1301
VB scripting
1.5 VBS object model

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 "Trend" listing, for example, you write "objTrend.TagName" instead of
"objTrend.TrendTagName".

See also
OnlineTrendControl (Page 359)
FunctionTrendControl (Page 309)

GetTrendWindow

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
Required An expression that returns an object of the "ScreenItem" type.

Parameters
VARIANT

Parameters Description
vIndex Index or name of curve window.

WinCC Engineering V18 – Programming reference

1302 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Example for Runtime Professional

'VBS341
Dim ctrl
Dim objTrendWnd
Set ctrl = ScreenItems("OnlineTrendControl")
Set objTrendWnd = ctrl.GetTrendWindow(1)
objTrendWnd.Visible = FALSE
Set objTrendWnd = ctrl.GetTrendWindow("trend window 2")
objTrendWnd.VerticalGrid = TRUE
objTrendWnd.FineGrid = TRUE

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 "TrendWindow" listing, for example, you write "objTrendWnd.Visible" instead of
"objTrendWnd.TrendWindowVisible".

See also
OnlineTrendControl (Page 359)
FunctionTrendControl (Page 309)

GetTrendWindowCollection

Description
Returns the list of all trend window objects of the f(t) trend display or the f(x) trend display as
"ICCAxCollection" type.

Syntax
Ausdruck.GetTrendWindowCollection()

Expression
Required. An expression that returns an object of the "ScreenItem" type.

Parameters
--

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1303
VB scripting
1.5 VBS object model

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 for Runtime Professional

'VBS342
Dim ctrl
Dim objTrendWnd
Dim objTimeAxis
Dim objValAxis
Set ctrl = ScreenItems("OnlineTrendControl")
Set objTrendWnd = ctrl.GetTrendWindowCollection.AddItem("myWindow")
Set objTimeAxis = ctrl.GetTimeAxisCollection.AddItem("myTimeAxis")
Set objValAxis = ctrl.GetValueAxisCollection.AddItem("myValueAxis")
objTimeAxis.TrendWindow = objTrendWnd.Name
objValAxis.TrendWindow = objTrendWnd.Name

See also
OnlineTrendControl (Page 359)
FunctionTrendControl (Page 309)

GetValueAxis

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
Necessary. An expression that returns an object of the "ScreenItem" type.

WinCC Engineering V18 – Programming reference

1304 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Parameters
VARIANT

Parameters Description
vIndex Index or name of the value axis

Example

'VBS343
Dim ctrl
Dim objValAxis
Set ctrl = ScreenItems("OnlineTrendControl")
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
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 "ValueAxis" listing, for example, you write "objValueAx.Visible" instead of
"objValueAx.ValueAxisVisible".

See also
OnlineTrendControl (Page 359)

GetValueAxisCollection

Description
Returns the list of all value axis objects of the f(t) trend view as "ICCAxCollection" type.

Syntax
Ausdruck.GetValueAxisCollection()

Expression
Necessary. An expression that returns an object of the "ScreenItem" type.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1305
VB scripting
1.5 VBS object model

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

'VBS344
Dim ctrl
Dim objTrendWnd
Dim objValAxis1
Dim objValAxis2
Dim objTrend
Set ctrl = ScreenItems("OnlineTrendControl")
Set objTrendWnd = ctrl.GetTrendWindowCollection.AddItem("myWindow")
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
Set objTrend = ctrl.GetTrendCollection.AddItem("myTrend1")
objTrend.TrendWindow = objTrendWnd.Name
objTrend.ValueAxis = objValAxis1.Name
Set objTrend = ctrl.GetTrendCollection.AddItem("myTrend2")
objTrend.TrendWindow = objTrendWnd.Name
objTrend.ValueAxis = objValAxis2.Name

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 "ValueAxis" listing, for example, you write "objValueAxis1.Label" instead of
"objValueAxis1.ValueAxisLabel".

See also
OnlineTrendControl (Page 359)

WinCC Engineering V18 – Programming reference

1306 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

GetValueColumn

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
Necessary. Expression that returns an object of the "ScreenItem" type.

Parameters
VARIANT

Parameters Description
vIndex Index or name of the value column of the f(t) trend view.

Example

'VBS345
Dim ctrl
Dim objValueColumn
Set ctrl = ScreenItems("TableControl")
Set objValueColumn = ctrl.GetValueColumn("Valuecolumn1")
objValueColumn.Precisions = 4
Set objValueColumn = ctrl.GetValueColumn(2)
objValueColumn.ExponentialFormat = TRUE

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 "ValueColumn" listing, for example, you write "objValueColumn.Precisions" instead of
"objValueColumn.ValueColumnPrecisions".

See also
OnlineTrendControl (Page 359)
OnlineTableControl (Page 347)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1307
VB scripting
1.5 VBS object model

GetValueColumnCollection

Description
Returns the list of all value column objects of the f(t) trend view as "ICCAxCollection" type.

Syntax
Ausdruck.GetValueColulmnCollection()

Expression
Necessary. An expression that returns an object of the "ScreenItem" type.

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)

WinCC Engineering V18 – Programming reference

1308 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Example

'VBS346
Dim ctrl
Dim objValCol1
Dim objValCol2
Dim coll
Dim valcol
Set ctrl = ScreenItems("TableControl")
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
OnlineTrendControl (Page 359)
OnlineTableControl (Page 347)

GetXAxis

Description
Returns the X axis object of the f(x) trend view designated by name or index as "ICCAxValueAxis"
type.

Syntax
Ausdruck.GetXAxis(ByVal vIndex As Variant)

Expression
Necessary. An expression that returns an object of the "ScreenItem" type.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1309
VB scripting
1.5 VBS object model

Parameters
VARIANT

Parameters Description
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
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 "XAxis" listing, for example, you write "objXAx.Visible" instead of "objXAx.XAxisVisible".

See also
OnlineTrendControl (Page 359)
FunctionTrendControl (Page 309)

GetXAxisCollection

Description
Returns the list of all X axis objects of the f(x) trend view as "ICCAxCollection" type.

Syntax
Ausdruck.GetXAxisCollection()

Expression
Necessary. An expression that returns an object of the "ScreenItem" type.

WinCC Engineering V18 – Programming reference

1310 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

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

'VBS348
Dim ctrl
Dim objXAxis1
Dim objXAxis2
Dim coll
Dim axes
Set ctrl = ScreenItems("FunctionTrendControl")
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
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 "XAxis" listing, for example, you write "objXAxis1.Label" instead of
"objXAxis1.XAxisLabel".

See also
OnlineTrendControl (Page 359)
FunctionTrendControl (Page 309)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1311
VB scripting
1.5 VBS object model

GetYAxis

Description
Returns the Y axis object of the f(x) trend view designated by name or index as "ICCAxValueAxis"
type.

Syntax
Ausdruck.GetYAxis(ByVal vIndex As Variant)

Expression
Necessary. An expression that returns an object of the "ScreenItem" type.

Parameters
VARIANT

Parameters Description
vIndex Index or name of Y axis.

Example

'VBS349
Dim ctrl
Dim objYAx
Set ctrl = ScreenItems("FunctionTrendControl")
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
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 "YAxis" listing, for example, you write "objYAx.Visible" instead of "objYAx.YAxisVisible".

See also
OnlineTrendControl (Page 359)
FunctionTrendControl (Page 309)

WinCC Engineering V18 – Programming reference

1312 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

GetYAxisCollection

Description
Returns the list of all Y axis objects of the f(x) trend view as "ICCAxCollection" type.

Syntax
Ausdruck.GetYAxisCollection()

Expression
Necessary. An expression that returns an object of the "ScreenItem" type.

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

'VBS350
Dim ctrl
Dim objYAxis1
Dim objYAxis2
Dim coll
Dim axes
Set ctrl = ScreenItems("FunctionTrendControl")
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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1313
VB scripting
1.5 VBS object model

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 "YAxis" listing, for example, you write "objYAxis1.Label" instead of
"objYAxis1.YAxisLabel".

See also
OnlineTrendControl (Page 359)
FunctionTrendControl (Page 309)

1.5.6.2 Methods H-R

HideAlarm

Description
Executes the "Hide alarm" button function of the alarm view.

Syntax
Expression.HideAlarm()

Expression
Required. An expression that returns an object of the type "ScreenItem".

Parameter
--

See also
AlarmControl (Page 237)

InsertData

Description
Adds data to the called trend.

WinCC Engineering V18 – Programming reference

1314 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Syntax
Expression.InsertData(dblAxisX As Variant, dblAxisY As Variant)

Expression
Necessary. An expression which returns an object of the "Trend" type.

Parameters

Parameters Description
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

Description
Returns an element from a list.

Syntax
Expression.Item(Index)

Expression
Necessary. An expression which returns a list.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1315
VB scripting
1.5 VBS object model

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 221)
ScreenItem (Page 219)

WinCC Engineering V18 – Programming reference

1316 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

LockAlarm

Description
Executes the "Disable alarm" button function of the alarm view.

Syntax
Expression.LockAlarm()

Expression
Required. An expression that returns an object of the type "ScreenItem".

Parameter
--

See also
AlarmControl (Page 237)

LoopInAlarm

Description
Executes the "Loop in alarm" button function of the alarm view.

Syntax
Expression.LoopInAlarm()

Expression
Required. An expression that returns an object of the type "ScreenItem".

Parameter
--

See also
AlarmControl (Page 237)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1317
VB scripting
1.5 VBS object model

MoveAxis

Description
Executes the "Move axes area" button function of the f(t) and f(x) trend views.

Syntax
Expression.MoveAxis()

Expression
Required. An expression that returns an object of the type "ScreenItem".

Parameter
--

See also
OnlineTrendControl (Page 359)
FunctionTrendControl (Page 309)

MoveToFirst

Description
Executes the "First line" button function of the control.

Syntax
Expression.MoveToFirst()

Expression
Required. An expression that returns an object of the type "ScreenItem".

Parameters
--

See also
OnlineTrendControl (Page 359)
OnlineTableControl (Page 347)
UserArchiveControl (Page 466)

WinCC Engineering V18 – Programming reference

1318 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

MoveToFirstLine

Description
Executes the "First alarm" button function of the alarm view.

Syntax
Expression.MoveToFirstLine()

Expression
Required. An expression that returns an object of the type "ScreenItem".

Parameter
--

See also
AlarmControl (Page 237)

MoveToFirstPage

Description
Executes the "First page" button function of the alarm view.

Syntax
Expression.MoveToFirstPage()

Expression
Required. An expression that returns an object of the type "ScreenItem".

Parameter
--

See also
AlarmControl (Page 237)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1319
VB scripting
1.5 VBS object model

MoveToLast

Description
Executes the "Last data record" button function of the control.

Syntax
Expression.MoveToLast()

Expression
Required. An expression that returns an object of the type "ScreenItem".

Parameters
--

See also
OnlineTrendControl (Page 359)
OnlineTableControl (Page 347)
UserArchiveControl (Page 466)

MoveToLastLine

Description
Executes the "Last alarm" button function of the alarm view.

Syntax
Expression.MoveToLastLine()

Expression
Required. An expression that returns an object of the type "ScreenItem".

Parameters
--

See also
AlarmControl (Page 237)

WinCC Engineering V18 – Programming reference

1320 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

MoveToLastPage

Description
Executes the "Last page" button function of the alarm view.

Syntax
Expression.MoveToLastPage()

Expression
Required. An expression that returns an object of the type "ScreenItem".

Parameter
--

See also
AlarmControl (Page 237)

MoveToNext

Description
Executes the "Next data record" button function of the control.

Syntax
Expression.MoveToNext()

Expression
Required. An expression that returns an object of the type "ScreenItem".

Parameters
--

See also
OnlineTrendControl (Page 359)
OnlineTableControl (Page 347)
UserArchiveControl (Page 466)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1321
VB scripting
1.5 VBS object model

MoveToNextLine

Description
Executes the "Next alarm" button function of the alarm view.

Syntax
Expression.MoveToNextLine()

Expression
Required. An expression that returns an object of the type "ScreenItem".

Parameter
--

See also
AlarmControl (Page 237)

MoveToNextPage

Description
Executes the "Next page" button function of the alarm view.

Syntax
Expression.MoveToNextPage()

Expression
Required. An expression that returns an object of the type "ScreenItem".

Parameter
--

See also
AlarmControl (Page 237)

WinCC Engineering V18 – Programming reference

1322 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

MoveToPrevious

Description
Executes the "Previous data record" button function of the control.

Syntax
Expression.MoveToPrevious()

Expression
Required. An expression that returns an object of the type "ScreenItem".

Parameters
--

See also
OnlineTrendControl (Page 359)
OnlineTableControl (Page 347)
UserArchiveControl (Page 466)

MoveToPreviousLine

Description
Executes the "Previous alarm" button function of the alarm view.

Syntax
Expression.MoveToPreviousLine()

Expression
Required. An expression that returns an object of the type "ScreenItem".

Parameter
--

See also
AlarmControl (Page 237)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1323
VB scripting
1.5 VBS object model

MoveToPreviousPage

Description
Executes the "Previous page" button function of the alarm view.

Syntax
Expression.MoveToPreviousPage()

Expression
Required. An expression that returns an object of the type "ScreenItem".

Parameter
--

See also
AlarmControl (Page 237)

NextColumn

Description
Executes the "Next column" button function of the table view.

Syntax
Expression.NextColumn()

Expression
Required. An expression that returns an object of the type "ScreenItem".

Parameter
--

See also
OnlineTableControl (Page 347)

WinCC Engineering V18 – Programming reference

1324 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

NextTrend

Description
Executes the "Next trend" button function of the f(t) and f(x) trend views.

Syntax
Expression.NextTrend()

Expression
Required. An expression that returns an object of the type "ScreenItem".

Parameters
--

See also
OnlineTrendControl (Page 359)
FunctionTrendControl (Page 309)

OneToOneView

Description
Executes the "Original view" button function of the f(t) and f(x) trend views.

Syntax
Expression.OneToOneView()

Expression
Required. An expression that returns an object of the type "ScreenItem".

Parameters
--

See also
OnlineTrendControl (Page 359)
FunctionTrendControl (Page 309)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1325
VB scripting
1.5 VBS object model

PasteRows

Description
Executes the "Insert rows" button function of the recipe view.

Syntax
Expression.PasteRows()

Expression
Required. An expression that returns an object of the type "ScreenItem".

Parameter
--

See also
UserArchiveControl (Page 466)

PreviousColumn

Description
Executes the "Previous column" button function of the table view.

Syntax
Expression.PreviousColumn()

Expression
Required. An expression that returns an object of the type "ScreenItem".

Parameter
--

See also
OnlineTableControl (Page 347)

WinCC Engineering V18 – Programming reference

1326 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

PreviousTrend

Description
Executes the "Previous trend" button function of the f(t) and f(x) trend views.

Syntax
Expression.PreviousTrend()

Expression
Required. An expression that returns an object of the type "ScreenItem".

Parameters
--

See also
OnlineTrendControl (Page 359)
FunctionTrendControl (Page 309)

Print

Description
Executes the "Print" button function of the control.

Syntax
Expression.Print()

Expression
Required. An expression that returns an object of the type "ScreenItem".

Parameters
--

See also
OnlineTrendControl (Page 359)
OnlineTableControl (Page 347)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1327
VB scripting
1.5 VBS object model

FunctionTrendControl (Page 309)

AlarmControl (Page 237)

QuitHorn

Description
Executes the "Alarm annunciator acknowledgment" button function of the alarm view.

Syntax
Expression.QuitHorn()

Expression
Required. An expression that returns an object of the type "ScreenItem".

Parameter
--

See also
AlarmControl (Page 237)

QuitSelected

Description
Executes the "Single acknowledgment" button function of the alarm view.

Syntax
Expression.QuitSelected()

Expression
Required. An expression that returns an object of the type "ScreenItem".

Parameter
--

See also
AlarmControl (Page 237)

WinCC Engineering V18 – Programming reference

1328 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

QuitVisible

Description
Executes the "Group acknowledgment" button function of the alarm view.

Syntax
Expression.QuitVisible()

Expression
Required. An expression that returns an object of the type "ScreenItem".

Parameter
--

See also
AlarmControl (Page 237)

Read

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 ""

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1329
VB scripting
1.5 VBS object model

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
Name Tag name (unchanged)
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:

Parameters Description
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

WinCC Engineering V18 – Programming reference

1330 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

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
Set objTag = HMIRuntime.Tags("Tagname")
vntValue = objTag.Read(1) 'Read direct
MsgBox vntValue

Reading a tag from the process image

'VBS101
Dim objTag
Dim vntValue
Set objTag = HMIRuntime.Tags("Tagname")
vntValue = objTag.Read 'Read from cache
MsgBox vntValue

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1331
VB scripting
1.5 VBS object model

Description of TagSet Object

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
Necessary. An expression which returns an object of type "TagSet".

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
Set group = HMIRuntime.Tags.CreateTagSet
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

Description
Executes the "Read tags" button function of the recipe view.

WinCC Engineering V18 – Programming reference

1332 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Syntax
Expression.ReadTags()

Expression
Required. An expression that returns an object of the type "ScreenItem".

Parameter
--

See also
UserArchiveControl (Page 466)

Refresh

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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1333
VB scripting
1.5 VBS object model

See also
Screen (Page 216)
HMIRuntime (Page 209)

Remove

Description of TagSet Object

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

Parameters Description
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
Set group = HMIRuntime.Tags.CreateTagSet
group.Add "Motor1"
group.Add "Motor2"
group.Remove "Motor1"

Description of DataSet Object

Deletes the element specified in parameter "Name" from a list.

Syntax
Expression.Remove [Name]

WinCC Engineering V18 – Programming reference

1334 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Expression
Required An expression which returns an object of type "DataSet".

Parameters
VARIANT

Parameters Description
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
HMIRuntime.DataSet.Remove("motor1")

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".

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1335
VB scripting
1.5 VBS object model

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.
When specifying the time information, a short form is also possible. This is described in the
"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".

WinCC Engineering V18 – Programming reference

1336 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

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 214)
DataSet (list) (Page 206)
DataLogs (list) (Page 205)
AlarmLogs (list) (Page 202)

RemoveAll

Description of TagSet Object

Deletes all tags from a TagSet list.

syntax
Expression.RemoveAll

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1337
VB scripting
1.5 VBS object model

Expression
Necessary. An expression which returns an object of type "TagSet".

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
Set group = HMIRuntime.Tags.CreateTagSet
group.Add "Motor1"
group.Add "Motor2"
group.RemoveAll

Description of DataSet Object

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
DataSet (list) (Page 206)

WinCC Engineering V18 – Programming reference

1338 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Restore

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]

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1339
VB scripting
1.5 VBS object model

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.
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 swapped in.
When specifying the time information, a short form is also possible. This is described in the
"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".

WinCC Engineering V18 – Programming reference

1340 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

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
swapped in again, and the return value is output as a trace.

'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
swapped in again, and the return value is output as a trace.

'VBS186
HMIRuntime.Trace "Ret: " & HMIRuntime.Logging.AlarmLogs.Remove("","2004-09-20",-1) &
vbNewLine

See also
Logging (Page 214)
DataLogs (list) (Page 205)
AlarmLogs (list) (Page 202)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1341
VB scripting
1.5 VBS object model

1.5.6.3 Methods S-Z

SelectAll

Description
Selects all rows in a table-based control.

Syntax
Expression.SelectAll()

Expression
Required. An expression that returns an object of the type "ScreenItem".

Parameters
--

See also
OnlineTableControl (Page 347)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)
AlarmControl (Page 237)

SelectedStatisticArea

Description
Executes the "Set statistics range" button function of the table view.

Syntax
Expression.SelectedStatisticArea()

Expression
Required. An expression that returns an object of the type "ScreenItem".

Parameter
--

WinCC Engineering V18 – Programming reference

1342 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

See also
OnlineTableControl (Page 347)

SelectRow

Description
Selects a specific row in a table-based control.

Syntax
Expression.SelectRow ByVal IRow As Long, Optional bExtendSelection
As Boolean

Expression
Required. An expression that returns an object of the type "ScreenItem".

Parameters

Parameters Description
IRow Number of the row to be selected.
bExtendSelection Indicates as an option whether the current selection will be extended. Is only rele‐
vant 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
OnlineTableControl (Page 347)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)
AlarmControl (Page 237)

ServerExport

Description
Executes the "Export log" button function of the recipe view.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1343
VB scripting
1.5 VBS object model

Syntax
Expression.ServerExport()

Expression
Required. An expression that returns an object of the type "ScreenItem".

Parameter
--

See also
UserArchiveControl (Page 466)

ServerImport

Description
Executes the "Import log" button function of the recipe view.

Syntax
Expression.ServerImport()

Expression
Required. An expression that returns an object of the type "ScreenItem".

Parameter
--

See also
UserArchiveControl (Page 466)

SetHTML

Description
Writes a HTML code in the display range of the HTML browser.

Syntax
Epression.SetHTML string

WinCC Engineering V18 – Programming reference

1344 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

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
HTMLBrowser (Page 330)

SetOperationLock

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
Required. An expression that returns an object of the "ScreenItem" type.

Parameters

Parameters Description
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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1345
VB scripting
1.5 VBS object model

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

Description
Executes the "Select columns" button function of the table view.

Syntax
Expression.ShowColumnSelection()

Expression
Required. An expression that returns an object of the type "ScreenItem".

Parameter
--

See also
OnlineTableControl (Page 347)

ShowComment

Description
Executes the "Comment dialog" button function of the alarm view.

Syntax
Expression.ShowComment()

WinCC Engineering V18 – Programming reference

1346 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Expression
Required. An expression that returns an object of the type "ScreenItem".

Parameters
--

See also
AlarmControl (Page 237)

ShowDisplayOptionsDialog

Description
Executes the "Display options dialog" button function of the alarm view.

Syntax
Expression.ShowDisplayOptionsDialog()

Expression
Required. An expression that returns an object of the type "ScreenItem".

Parameter
--

See also
AlarmControl (Page 237)

ShowEmergencyQuitDialog

Description
Executes the "Emergency acknowledgment" button function of the alarm view.

Syntax
Expression.ShowEmergencyQuitDialog()

Expression
Required. An expression that returns an object of the type "ScreenItem".

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1347
VB scripting
1.5 VBS object model

Parameter
--

See also
AlarmControl (Page 237)

ShowHelp

Description
Executes the "Help" button function of the control.

Syntax
Expression.ShowHelp()

Expression
Required. An expression that returns an object of the type "ScreenItem".

Parameters
--

See also
OnlineTrendControl (Page 359)
OnlineTableControl (Page 347)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)
FunctionTrendControl (Page 309)
AlarmControl (Page 237)

ShowHideList

Description
Executes the "List of alarm to hide" button function of the alarm view.

Syntax
Expression.ShowHideList()

WinCC Engineering V18 – Programming reference

1348 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Expression
Required. An expression that returns an object of the type "ScreenItem".

Parameter
--

See also
AlarmControl (Page 237)

ShowHitList

Description
Executes the "Hit list" button function of the alarm view.

Syntax
Expression.ShowHitList()

Expression
Required. An expression that returns an object of the type "ScreenItem".

Parameter
--

See also
AlarmControl (Page 237)

ShowInfoText

Description
Executes the "About dialog" button function of the alarm view.

Syntax
Expression.ShowInfoText()

Expression
Required. An expression that returns an object of the type "ScreenItem".

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1349
VB scripting
1.5 VBS object model

Parameter
--

See also
AlarmControl (Page 237)

ShowLockDialog

Description
Executes the "Lock dialog" button function of the alarm view.

Syntax
Expression.ShowLockDialog()

Expression
Required. An expression that returns an object of the type "ScreenItem".

Parameter
--

See also
AlarmControl (Page 237)

ShowLockList

Description
Executes the "Lock list" button function of the alarm view.

Syntax
Expression.ShowLockList()

Expression
Required. An expression that returns an object of the type "ScreenItem".

Parameter
--

WinCC Engineering V18 – Programming reference

1350 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

See also
AlarmControl (Page 237)

ShowLongTermArchiveList

Description
Executes the "Historical alarm list (long-term)" button function of the alarm view.

Syntax
Expression.ShowLongTermArchiveList()

Expression
Required. An expression that returns an object of the type "ScreenItem".

Parameter
--

See also
AlarmControl (Page 237)

ShowMessageList

Description
Executes the "Alarm list" button function of the alarm view.

Syntax
Expression.ShowMessageList()

Expression
Required. An expression that returns an object of the type "ScreenItem".

Parameter
--

See also
AlarmControl (Page 237)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1351
VB scripting
1.5 VBS object model

ShowPercentageAxis

Description
Executes the "Relative axis" button function of the f(t) trend view.

Syntax
Expression.ShowPercentageAxis()

Expression
Required. An expression that returns an object of the type "ScreenItem".

Parameter
--

See also
OnlineTrendControl (Page 359)

ShowPropertyDialog

Description
Executes the "Configuration dialog" button function of the control.

Syntax
Expression.ShowPropertyDialog()

Expression
Required. An expression that returns an object of the type "ScreenItem".

Parameters
--

See also
OnlineTrendControl (Page 359)
OnlineTableControl (Page 347)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)

WinCC Engineering V18 – Programming reference

1352 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

FunctionTrendControl (Page 309)

AlarmControl (Page 237)

ShowSelectArchive

Description
Executes the "Select data connection" button function of the recipe view.

Syntax
Expression.ShowSelectArchive()

Expression
Required. An expression that returns an object of the type "ScreenItem".

Parameter
--

See also
UserArchiveControl (Page 466)

ShowSelection

Description
Executes the "Selection dialog" button function of the recipe view.

Syntax
Expression.ShowSelection()

Expression
Required. An expression that returns an object of the type "ScreenItem".

Parameter
--

See also
UserArchiveControl (Page 466)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1353
VB scripting
1.5 VBS object model

ShowSelectionDialog

Description
Executes the "Selection dialog" button function of the alarm view.

Syntax
Expression.ShowSelectionDialog()

Expression
Required. An expression that returns an object of the type "ScreenItem".

Parameter
--

See also
AlarmControl (Page 237)

ShowSelectTimeBase

Description
Executes the "Timebase dialog" button function of the recipe view.

Syntax
Expression.ShowSelectTimeBase()

Expression
Required. An expression that returns an object of the type "ScreenItem".

Parameter
--

See also
UserArchiveControl (Page 466)

WinCC Engineering V18 – Programming reference

1354 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

ShowShortTermArchiveList

Description
Executes the "Historical alarm list (short-term)" button function of the alarm view.

Syntax
Expression.ShowShortTermArchiveList()

Expression
Required. An expression that returns an object of the type "ScreenItem".

Parameter
--

See also
AlarmControl (Page 237)

ShowSort

Description
Executes the "Sorting dialog" button function of the recipe view.

Syntax
Expression.ShowSort()

Expression
Required. An expression that returns an object of the type "ScreenItem".

Parameter
--

See also
UserArchiveControl (Page 466)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1355
VB scripting
1.5 VBS object model

ShowSortDialog

Description
Executes the "Sorting dialog" button function of the alarm view.

Syntax
Expression.ShowSortDialog()

Expression
Required. An expression that returns an object of the type "ScreenItem".

Parameter
--

See also
AlarmControl (Page 237)

ShowTagSelection

Description
Executes the "Select data connection" button function of the control.

Syntax
Expression.ShowTagSelection()

Expression
Required. An expression that returns an object of the type "ScreenItem".

Parameters
--

See also
OnlineTrendControl (Page 359)
OnlineTableControl (Page 347)
FunctionTrendControl (Page 309)

WinCC Engineering V18 – Programming reference

1356 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

ShowTimebaseDialog

Description
Executes the "Timebase dialog" button function of the alarm view.

Syntax
Expression.ShowTimebaseDialog()

Expression
Required. An expression that returns an object of the type "ScreenItem".

Parameter
--

See also
AlarmControl (Page 237)

ShowTimeSelection

Description
Executes the "Select time range" button function of the control.

Syntax
Expression.ShowTimeSelection()

Expression
Required. An expression that returns an object of the type "ScreenItem".

Parameters
--

See also
OnlineTrendControl (Page 359)
OnlineTableControl (Page 347)
FunctionTrendControl (Page 309)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1357
VB scripting
1.5 VBS object model

ShowTrendSelection

Description
Executes the "Select trends" button function of the f(t) and f(x) trend views.

Syntax
Expression.ShowTrendSelection()

Expression
Required. An expression that returns an object of the type "ScreenItem".

Parameters
-- -

See also
OnlineTrendControl (Page 359)
OnlineTableControl (Page 347)
FunctionTrendControl (Page 309)

StartStopUpdate

Description
Executes the "Start" or "Stop" button function of the control.

Syntax
Expression.StartStopUpdate()

Expression
Required. An expression that returns an object of the type "ScreenItem".

Parameters
--

See also
OnlineTrendControl (Page 359)
OnlineTableControl (Page 347)
FunctionTrendControl (Page 309)

WinCC Engineering V18 – Programming reference

1358 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Stop

Description
Closes WinCC Runtime.

Syntax
Expression.Stop()

Expression
Required. An expression which returns an object of the type "HMIRuntime".

Parameters
--

See also
HMIRuntime (Page 209)

Trace

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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1359
VB scripting
1.5 VBS object model

Parameters

STRING
The text which is issued as a debug alarm.

Example
In the following example a debug alarm is issued:
'VBS example trace
HMIRuntime.Trace "Customized error message"

See also
HMIRuntime (Page 209)

UnhideAlarm

Description
Executes the "Unhide alarm" button function of the alarm view.

Syntax
Expression.UnhideAlarm()

Expression
Required. An expression that returns an object of the type "ScreenItem".

Parameter
--

See also
AlarmControl (Page 237)

UnlockAlarm

Description
Executes the "Unlock alarm" button function of the alarm view.

Syntax
Expression.UnlockAlarm()

WinCC Engineering V18 – Programming reference

1360 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Expression
Required. An expression that returns an object of the type "ScreenItem".

Parameter
--

See also
AlarmControl (Page 237)

UnselectAll

Description
Removes all selections from the cells of a table-based control.

Syntax
Expression.UnselectAll()

Expression
Required. An expression that returns an object of the type "ScreenItem".

Parameters
--

See also
OnlineTableControl (Page 347)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)
AlarmControl (Page 237)

UnselectRow

Description
Removes the selections from a specific cell of a table-based control.

Syntax
Expression.UnselectRow(ByVal IRow As Long)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1361
VB scripting
1.5 VBS object model

Expression
Required. An expression that returns an object of the "ScreenItem" type.

Parameters
Long

Parameters Description
IRow Number of rows whose selection will be removed.

See also
OnlineTableControl (Page 347)
TrendRulerControl (Page 441)
UserArchiveControl (Page 466)
AlarmControl (Page 237)

Write

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)
Name Tag name (unchanged)
QualityCode Bad Out of Service
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)
Name Tag name (unchanged)
QualityCode Bad Out of Service
Timestamp 0
LastError Write operation error codes
ErrorDescription Error description on LastError

WinCC Engineering V18 – Programming reference

1362 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

syntax
Expression.Write [Value],[Writemode]

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.

Parameters Description
Value (optional) The tag value is specified. The specified value over‐
writes 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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1363
VB scripting
1.5 VBS object model

or

'VBS105
Dim objTag
Set objTag = HMIRuntime.Tags("Var1")
objTag.Write 5
MsgBox objTag.Value

Synchronous writing

'VBS106
Dim objTag
Set objTag = HMIRuntime.Tags("Var1")
objTag.Value = 5
objTag.Write ,1
MsgBox objTag.Value

or

'VBS107
Dim objTag
Set objTag = HMIRuntime.Tags("Var1")
objTag.Write 5, 1
MsgBox objTag.Value

Description of TagSet Object

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
Necessary. An expression which returns an object of type "TagSet".

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.

WinCC Engineering V18 – Programming reference

1364 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Example
The following example shows how tags are included in the TagSet list, how tag values are set and
subsequently written.

'VBS173
Dim group
Set group = HMIRuntime.Tags.CreateTagSet
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

Description
Executes the "Write tags" button function of the recipe view.

Syntax
Expression.WriteTags()

Expression
Required. An expression that returns an object of the type "ScreenItem".

Parameter
--

See also
UserArchiveControl (Page 466)

ZoomArea

Description
Executes the "Zoom area" button function of the f(t) and f(x) trend views.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1365
VB scripting
1.5 VBS object model

Syntax
Expression.ZoomArea()

Expression
Required. An expression that returns an object of the type "ScreenItem".

Parameters
--

See also
OnlineTrendControl (Page 359)
FunctionTrendControl (Page 309)

ZoomInOut

Description
Executes the "Zoom +/-" button function of the f(t) and f(x) trend views.

Syntax
Expression.ZoomInOut()

Expression
Required. An expression that returns an object of the type "ScreenItem".

Parameters
--

See also
OnlineTrendControl (Page 359)
FunctionTrendControl (Page 309)

ZoomInOutTime

Description
Executes the "Zoom time axis +/-" button function of the f(t) trend view.

Syntax
Expression.ZoomInOutTime()

WinCC Engineering V18 – Programming reference

1366 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

Expression
Required. An expression that returns an object of the type "ScreenItem".

Parameter
--

See also
OnlineTrendControl (Page 359)

ZoomInOutValues

Description
Executes the "Zoom value axis +/-" button function of the f(t) trend view.

Syntax
Expression.ZoomInOutValues()

Expression
Required. An expression that returns an object of the type "ScreenItem".

Parameter
--

See also
OnlineTrendControl (Page 359)

ZoomInOutX

Description
Executes the "Zoom X axis +/-" button function of the f(x) trend view.

Syntax
Expression.ZoomInOutX()

Expression
Required. An expression that returns an object of the type "ScreenItem".

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1367
VB scripting
1.5 VBS object model

Parameters
--

See also
FunctionTrendControl (Page 309)

ZoomInOutY

Description
Executes the "Zoom Y axis +/-" button function of the f(x) trend view.

Syntax
Expression.ZoomInOutY()

Expression
Required. An expression that returns an object of the type "ScreenItem".

Parameters
--

See also
FunctionTrendControl (Page 309)

ZoomMove

Description
Executes the "Move trend area" button function of the f(t) and f(x) trend views.

Syntax
Expression.ZoomMove()

Expression
Required. An expression that returns an object of the type "ScreenItem".

Parameters
--

WinCC Engineering V18 – Programming reference

1368 System Manual, 11/2022, Online documentation
 VB scripting
1.5 VBS object model

See also
OnlineTrendControl (Page 359)
FunctionTrendControl (Page 309)

1.5.7 Error Messages from Database Area

Introduction
When databases are accessed, a value is returned after execution. Values starting with "0x8..."
represent an error message. Values not starting with "0x8..." represent a status message.

Status messages
The following status messages are defined:

0x0 OK
0x1 The function has not detected any errors in the parameter assignment or internally. Possible
reasons for this return value include:

When connecting databases:

- No archives could be found in the given time window.
- Archives were found in the given time window but were already connected.

When disconnecting databases:

- No connected archives could be found in the given time window. A check is not made here to
find out if any archives are connected at all.

Error messages
The following error messages are defined:

Error code Error message

0x80047200 WinCC Runtime is not active
0x80047201 Invalid archive type
0x80047202 Invalid low limit
0x80047203 Invalid high limit
0x80047204 Path "CommonArchiving" could not be created
0x80047205 Timeout, please try again
0x80047206 WinCC Runtime was stopped
0x80047207 False signature
At least one database has an invalid signature and could not be connected
0x80047208 Database could not be connected
0x80047209 Cannot copy to "CommonArchiving"
0x8004720A Invalid syntax of database file name
0x8004720B List of databases does not exist
0x8004720C Database is already connected

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1369
VB scripting
1.5 VBS object model

Error code Error message

0x8004720D Database could not be disconnected
0x8004720F Unsigned database connected
At least one database without signature is connected.
0x80047210 Path error:
- Path invalid
- Specified path contains no *.MDF files
- No access authorization for specified path

WinCC Engineering V18 – Programming reference

1370 System Manual, 11/2022, Online documentation
C scripting 2
2.1 System functions

2.1.1 ActivateNextScreen

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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1371
C scripting
2.1 System functions

The saved return value can be processed in the following code.

{
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

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
System function completed without errors.

FALSE
An error has occurred.

WinCC Engineering V18 – Programming reference

1372 System Manual, 11/2022, Online documentation
 C scripting
2.1 System functions

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.
The saved return value can be processed in the following code.

{
BOOL b_error;

//Open previous screen

b_error = ActivatePreviousScreen();

if(b_error)
{
// User defined code if
// function succeeds without error
...
}
else
{
// User defined code in case of error
...
}
...
}

2.1.3 ActivateScreen

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.

Use in the function list

ActivateScreen (Screen name, Object number)

Use in user-defined functions

ActivateScreen Screen_name, Object_number
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1373
C scripting
2.1 System functions

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.
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

2.1.4 ActivateScreenInScreenWindow

Description
Performs a screen change to the specified screen in a specified screen window.

Use in the function list

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

WinCC Engineering V18 – Programming reference

1374 System Manual, 11/2022, Online documentation
 C scripting
2.1 System functions

Use in user-defined functions

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.

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");
...
}

2.1.5 ActivateStartScreen

Description
Opens the configured start screen.
Can only be used in C scripting.

Syntax
BOOL ActivateStartScreen();

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1375
C scripting
2.1 System functions

Return value

TRUE
System function completed without errors.

FALSE
An error has occurred.

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.
The saved return value can be processed in the following code.

{
BOOL b_error;

//Open start screen

b_error = ActivateStartScreen();

if(b_error)
{
// User defined code if
// function succeeds without error
...
}
else
{
// User defined code in case of error
...
}
...
}

2.1.6 ActivateStoredScreen

Description
Opens the screen saved with the StoreScreen system function.
Can only be used in C scripting.

Syntax
BOOL ActivateStoredScreen();

WinCC Engineering V18 – Programming reference

1376 System Manual, 11/2022, Online documentation
 C scripting
2.1 System functions

Return value

TRUE
System function completed without errors.

FALSE
An error has occurred.

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.
The saved return value can be processed in the following code.

{
BOOL b_error;

//Open stored screen

b_error = ActivateStoredScreen();

if(b_error)
{
// User defined code if
// function succeeds without error
...
}
else
{
// User defined code in case of error
...
}
...
}

See also
StoreScreen (Page 1484)

2.1.7 DateToSystemTime

Description
Converts a date-clock time specification in DATE format into the SYSTEMTIME data format.
Can only be used in C scripting.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1377
C scripting
2.1 System functions

Use in the function list

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
System function completed without errors.

FALSE
An error has occurred.

WinCC Engineering V18 – Programming reference

1378 System Manual, 11/2022, Online documentation
 C scripting
2.1 System functions

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.wYear = %d \r\n", st_2.wYear );
printf( "st_2.wMonth = %d \r\n", st_2.wMonth );
printf( "st_2.wDayOfWeek = %d \r\n", st_2.wDayOfWeek );
printf( "st_2.wDay = %d \r\n", st_2.wDay );
printf( "st_2.wHour = %d \r\n", st_2.wHour );
printf( "st_2.wMinute = %d \r\n", st_2.wMinute );
printf( "st_2.wSecond = %d \r\n", st_2.wSecond );
printf( "st_2.wMilliseconds = %d \r\n \r\n \r\n", st_2.wMilliseconds );

2.1.8 DecreaseTag

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. 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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1379
C scripting
2.1 System functions

Use in the function list

DecreaseTag (Tag, Value)

Use in user-defined functions

DecreaseTag Tag, Value
Can be used if the configured device supports user-defined functions. For more information,
refer to "AUTOHOTSPOT".

Parameters

Tag
The tag from which the given value is subtracted.

Value
The value which is subtracted.

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);
...
}

2.1.9 GetLink

Function
Indicates the current tag connection of object properties.

WinCC Engineering V18 – Programming reference

1380 System Manual, 11/2022, Online documentation
 C scripting
2.1 System functions

Syntax
BOOL GetLink(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, LPCTSTR
lpszPropertyName, LPLINKINFO *pLink);

Parameter

lpszPictureName
Screen name

lpszObjectName
Object name

lpszPropertyName
Object property

pLink
Pointer to a structure of the type: LINKINFO

Return value

TRUE
The function has been completed without any errors.

FALSE
An error has occurred.

See also
Structure definition LINKINFO (Page 1539)

2.1.10 GetLinkedTag

Description
Returns the name of the tag which is logically linked to the specified object property.
Can only be used in C scripting.

Syntax
char* GetLinkedTag(ScreenName, Object, NameOfProperty);

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1381
C scripting
2.1 System functions

Parameters

ScreenName
Pointer to the name of the screen.

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
...
}

WinCC Engineering V18 – Programming reference

1382 System Manual, 11/2022, Online documentation
 C scripting
2.1 System functions

2.1.11 GetLocalScreen

Description
Returns a pointer to the screen name.
Can only be used in C scripting.

Syntax
char* GetLocalScreen(ScreenName);

Parameters

ScreenName
Pointer to the name of the screen.

Return value
Pointer to the name of the screen.

Note
The syntax of the transferred call parameter "ScreenName" 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>...

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"

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1383
C scripting
2.1 System functions

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.12 GetLanguageByLocaleID

Description
Determines the current Runtime language.
Can only be used in C scripting.

Syntax
DWORD GetLanguageByLocaleID ();

Return value
Language ID.
The following assignments apply (hexadecimal language code):

Symbolic name Value(hexadeci‐ Abbreviation

mal)
LANG_ARABIC 0x0401
LANG_AFRIKAANS 0x0436
LANG_ALBANIAN 0x041C
LANG_BASQUE 0x042D
LANG_BULGARIAN 0x0402
LANG_BYELORUSSIAN 0x0423

WinCC Engineering V18 – Programming reference

1384 System Manual, 11/2022, Online documentation
 C scripting
2.1 System functions

Symbolic name Value(hexadeci‐ Abbreviation

mal)
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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1385
C scripting
2.1 System functions

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.13 GetParentScreen

Description
The function determines the name of the parent screen from a specified screen path.
Can only be used in C scripting.

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:
<Screen_name>.<Screen_window_name>:<Screen_name>.<Screen_window_name>:<Screen
_name>...

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.

WinCC Engineering V18 – Programming reference

1386 System Manual, 11/2022, Online documentation
 C scripting
2.1 System functions

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.
• "Screen_1", if the system function is called in the "Screen_2" screen.
GetParentScreenwindow returns:
• "Screenwindow_2", if the system function is called in the "Screen_3" screen.
• "Screenwindow_1", if the system function is called in the "Screen_2" screen.

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.

{
char* pszScrName = NULL;
char szScrName[_MAX_PATH+1];

//Get the Parent Screen

pszScrName = GetParentScreen(lpszScreenName);

//Copy the string

if (pszScrName != NULL)
{
strncpy(szScrName,pszScrName,_MAX_PATH);
// print Screen name
printf ("Screen name: %s\r\n", szScrName);
}
...
}

2.1.14 GetParentScreenWindow

Description
The function determines the name of the parent screen window from a transferred screen path.
Can only be used in C scripting.

Syntax
char* GetParentScreenWindow(ScreenName);

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1387
C scripting
2.1 System functions

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
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 window.

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.
• "Screen_1", if the system function is called in the "Screen_2" screen.
GetParentScreenwindow returns:
• "Screenwindow_2", if the system function is called in the "Screen_3" screen.
• "Screenwindow_1", if the system function is called in the "Screen_2" screen.

WinCC Engineering V18 – Programming reference

1388 System Manual, 11/2022, Online documentation
 C scripting
2.1 System functions

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.

{
char* pszScrName = NULL;
char szScrName[_MAX_PATH+1];

//Get the Parent Screen Window

pszScrName = GetParentScreenWindow(lpszScreenName);

//Copy the string

if (pszScrName != NULL)
{
strncpy(szScrName,pszScrName,_MAX_PATH);
// print name of the parent screen window
printf ("Parent screen window: %s\r\n", szScrName);
}
...
}

2.1.15 GetProp

2.1.15.1 GetPropBOOL

Description
Returns the current status of a property of data type "BOOL".
Can only be used in C scripting.

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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1389
C scripting
2.1 System functions

NameOfTheProperty
Name of the object property

Return value

TRUE
System function completed without errors.

FALSE
An error has occurred.

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 of object IOField1 in screen gs_graph_iofield

b_error = GetPropBOOL("gs_graph_iofield","IOField1","Visible");

if(b_error)
{
// User defined code if the
// object is visible
...
}
else
{
// User defined code if the
// object is not visible
...
}
}

A specific code is processed, depending on the return value.

2.1.15.2 GetPropChar

Description
Returns the value of a property of data type "Char".
Can only be used in C scripting.

Syntax
Char* GetPropChar(ScreenName, Object, NameOfTheProperty)

WinCC Engineering V18 – Programming reference

1390 System Manual, 11/2022, Online documentation
 C scripting
2.1 System functions

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
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. Saving the return value to 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 of object IOField1 in screen Screen_1

pszProp = GetPropChar("Screen_1","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);
}
...
}

The saved return value can be processed in the following code.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1391
C scripting
2.1 System functions

2.1.15.3 GetPropDouble

Description
Returns the value of a property of data type "Double".
Can only be used in C scripting.

Syntax
double GetPropDouble(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
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
2. Validation of the return value: Step 3 follows if the value is valid (not NULL).
3. Output of the background color

WinCC Engineering V18 – Programming reference

1392 System Manual, 11/2022, Online documentation
 C scripting
2.1 System functions

{
double szProp = NULL;

//Get the property Backcolor of object Button_1 in screen Screen_1

szProp = GetPropDouble("Screen_1","Button_1","BackColor");

if(szProp != NULL)
{
// print output value
printf ("Background color: %s\r\n", szProp);}
}
...
}

2.1.15.4 GetPropLong

Description
Returns the value of a property of data type "long".
Can only be used in C scripting.

Syntax
long GetPropLong(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
Value of the property in data type "long".

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1393
C scripting
2.1 System functions

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
2. Validation of the return value: Step 3 follows if the value is valid (not NULL).
3. Output

{
long szProp = NULL;

//Get the property CaptionBackColor of object TemperatureField in screen Screen_1

szProp = GetPropLong("Screen_1","TemperatureField","CaptionBackColor");

if(szProp != NULL)
{
// print caption
printf ("Caption of window: %d\r\n", szProp);
}
...
}

The saved return value can be processed in the following code.

2.1.16 GetServerTagPrefix

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.
Can only be used in C scripting.

Syntax
void GetServerTagPrefix(ppszServerPrefix, ppszTagPrefix, ppszWindowPrefix);

WinCC Engineering V18 – Programming reference

1394 System Manual, 11/2022, Online documentation
 C scripting
2.1 System functions

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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1395
C scripting
2.1 System functions

{
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");
//User defined code where the
//user can do something with the returnvalue
...
}
Else
{
printf("The resulting string is too long.");
return;
}
}

WinCC Engineering V18 – Programming reference

1396 System Manual, 11/2022, Online documentation
 C scripting
2.1 System functions

2.1.17 GetTag

2.1.17.1 GetTag functions

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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1397
C scripting
2.1 System functions

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);
...
}

The saved return value can be processed in the following code.

2.1.17.2 GetTagDateTime function

Function
Determines the value of a tag of data type "Date/Time".

Syntax
SYSTEMTIME GetTagDateTime(Tag_Name);

Parameter

Tag_Name
Name of the tag

WinCC Engineering V18 – Programming reference

1398 System Manual, 11/2022, Online documentation
 C scripting
2.1 System functions

Return value
Value of the tag in the data type "Date/Time".

2.1.17.3 GetTagMultiStateQCWait functions

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.
Can only be used in C scripting.

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
System function completed without errors.

FALSE
An error has occurred.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1399
C scripting
2.1 System functions

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);

//User defined code where the

//user can do something with the returnvalue
...
}

The saved return value can be processed in the following code.

See also
Quality codes of HMI tags (Page 1550)
Constants (Page 1555)

WinCC Engineering V18 – Programming reference

1400 System Manual, 11/2022, Online documentation
 C scripting
2.1 System functions

2.1.17.4 GetTagMultiStateWait functions

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.
Can only be used in C scripting.

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
System function completed without errors.

FALSE
An error has occurred.

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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1401
C scripting
2.1 System functions

{
#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);

//User defined code where the

//user can do something with the returnvalue
...
}

The saved return value can be processed in the following code.

See also
Constants (Page 1555)

2.1.17.5 GetTagMultiWait functions

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.
Can only be used in C scripting.

Syntax
BOOL GetTagMultiWait(pFormat,...);

WinCC Engineering V18 – Programming reference

1402 System Manual, 11/2022, Online documentation
 C scripting
2.1 System functions

Parameters

pFormat
Format description for all requested tags along with name and address of the value for each
tag.

Return value

TRUE
System function completed without errors.

FALSE
An error has occurred.

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.17.6 GetTagState functions

Description
The GetTagStateXXX function calculates the value of a tag of the specified data type. It also
returns the status of the tags.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1403
C scripting
2.1 System functions

Can only be used in C scripting.

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, PDWORD Binary tag Bool
lp_dwstate
BYTE GetTagByteState Tag Tag_Name, PDWORD Unsigned 8-bit Byte
lp_dwstate
char* GetTagCharState Tag Tag_Name, PDWORD Text tag 8-bit or text tag 16- String
lp_dwstate bit
double GetTagDoubleState Tag Tag_Name, PDWORD Floating point 64-bit Double
lp_dwstate
DWORD GetTagDWordState Tag Tag_Name, PDWORD Unsigned 32-bit UInteger
lp_dwstate
float GetTagFloatState Tag Tag_Name, PDWORD Floating point 32-bit Float
lp_dwstate
BOOL GetTagRawState Tag Tag_Name, BYTE* Raw data type Raw
pValue, DWORD size,
PDWORD lp_dwstate
signed GetTagSByteState Tag Tag_Name, PDWORD Signed 8-bit Byte
char lp_dwstate
long int GetTagSDWordState Tag Tag_Name, PDWORD Signed 32-bit Integer
lp_dwstate
short int GetTagSWordState Tag Tag_Name, PDWORD Signed 16-bit Short
lp_dwstate
WORD GetTagWordState Tag Tag_Name, PDWORD Unsigned 16-bit UShort
lp_dwstate

Syntax
<Type><FunctionName><(Parameter)>;
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
Pointer to a byte field containing the value of the raw data tags.

WinCC Engineering V18 – Programming reference

1404 System Manual, 11/2022, Online documentation
 C scripting
2.1 System functions

size
Length of the byte field in bytes

Return value
Value of the tags in the specified type.
The system function "GetTagCharState" returns a pointer to a value of the tag of data type
"char".
System function "GetTagRawState" returns TRUE or FALSE:
TRUE: System function completed without errors.
FALSE: An error has occurred.

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)
{
// User defined code if the
// value of the tag is true
...
}
else
{
// User defined code if the
// value of the tag is false
...
}
}

See also
Constants (Page 1555)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1405
C scripting
2.1 System functions

2.1.17.7 GetTagStateQC functions

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.
Can only be used in C scripting.
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,
PDWORD pdwQuality‐
Code
char* GetTagCharStateQC Tag Tag_Name, Text tag 8-bit or text tag 16- String
PDWORD lp_dwstate, bit
PDWORD pdwQuality‐
Code
double GetTagDoubleSta‐ Tag Tag_Name, Floating point 64-bit Double
teQC PDWORD lp_dwstate,
PDWORD pdwQuality‐
Code
DWOR GetTagDWordSta‐ Tag Tag_Name, Unsigned 32-bit UInteger
D teQC PDWORD lp_dwstate,
PDWORD pdwQuality‐
Code
float GetTagFloatStateQC Tag Tag_Name, Floating point 32-bit Float
PDWORD lp_dwstate,
PDWORD pdwQuality‐
Code
BOOL GetTagRawStateQC Tag Tag_Name, BYTE Raw data type Raw
pValue[], DWORD size,
PDWORD lp_dwstate,
PDWORD pdwQuality‐
Code
signed GetTagSByteStateQC Tag Tag_Name, Signed 8-bit Byte
char PDWORD lp_dwstate,
PDWORD pdwQuality‐
Code
long GetTagSDWordSta‐ Tag Tag_Name, Signed 32-bit Integer
int teQC PDWORD lp_dwstate,
PDWORD pdwQuality‐
Code

WinCC Engineering V18 – Programming reference

1406 System Manual, 11/2022, Online documentation
 C scripting
2.1 System functions

Type Function name Parameters PLC data type HMI data type
short GetTagSWordSta‐ Tag Tag_Name, Signed 16-bit Short
int teQC PDWORD lp_dwstate,
PDWORD pdwQuality‐
Code
WORD GetTagWordStateQC Tag Tag_Name, Unsigned 16-bit UShort
PDWORD lp_dwstate,
PDWORD pdwQuality‐
Code

Syntax
<Type><FunctionName><(Parameter)>;
Example: BOOL GetTagBitStateQC(Tag_Name, lp_dwstate, pdwQualityCode);

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.

pdwQualityCode
Pointer on a DWORD in which the quality code of the tag is created after the system function
cycle.

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.
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:
TRUE: System function completed without errors.
FALSE: An error has occurred.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1407
C scripting
2.1 System functions

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;

dwState = 0xFFFFFFFF;

//Get the tag value

//dwstate is the tag state
ok = GetTagBitStateQC("gs_tag_bit",&dwState,&dwQC);

//Create a string which includes the tag value

if (ok)
{
// succeeded, print tag value
printf ("Value at dwState: %x\r\n", dwState);
printf ("Value at dwQC: %x\r\n", dwQC);
...
}
else
{
// failed
printf ( "Error - function failed." );
}
}

See also
Quality codes of HMI tags (Page 1550)
Constants (Page 1555)

2.1.17.8 GetTagStateQCWait functions

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.
Can only be used in C scripting.

WinCC Engineering V18 – Programming reference

1408 System Manual, 11/2022, Online documentation
 C scripting
2.1 System functions

The following table lists the different GetTagStateQCWait functions for reading the tag value:

Type Function name Parameters PLC data type HMI data

type
BOOL GetTagBitStateQCWait Tag Tag_Name, PDWORD Binary tag Bool
lp_dwstate, PDWORD
pdwQualityCode
BYTE GetTagByteStateQCWait Tag Tag_Name, PDWORD Unsigned 8-bit UByte
lp_dwstate, PDWORD
pdwQualityCode
char* GetTagCharStateQC‐ Tag Tag_Name, PDWORD Text tag 8-bit or text tag 16- String
Wait lp_dwstate, PDWORD bit
pdwQualityCode
double GetTagDoubleStateQC‐ Tag Tag_Name, PDWORD Floating point 64-bit Double
Wait lp_dwstate, PDWORD
pdwQualityCode
DWOR GetTagDWordStateQC‐ Tag Tag_Name, PDWORD Unsigned 32-bit UInteger
D Wait lp_dwstate, PDWORD
pdwQualityCode
float GetTagFloatStateQC‐ Tag Tag_Name, PDWORD Floating point 32-bit Float
Wait lp_dwstate, PDWORD
pdwQualityCode
BOOL GetTagRawStateQCWait Tag Tag_Name, BYTE Raw data type Raw
pValue[], DWORD size,
PDWORD lp_dwstate,
PDWORD pdwQuality‐
Code
signed GetTagSByteStateQC‐ Tag Tag_Name, PDWORD Signed 8-bit Byte
char Wait lp_dwstate, PDWORD
pdwQualityCode
long int GetTagSDWordStateQC‐ Tag Tag_Name, PDWORD Signed 32-bit Integer
Wait lp_dwstate, PDWORD
pdwQualityCode
short GetTagSWordStateQC‐ Tag Tag_Name, PDWORD Signed 16-bit Short
int Wait lp_dwstate, PDWORD
pdwQualityCode
WORD GetTagWordStateQC‐ Tag Tag_Name, PDWORD Unsigned 16-bit UShort
Wait lp_dwstate, PDWORD
pdwQualityCode

Syntax
<Type><FunctionName><(Parameter)>;
Example: BOOL GetTagBitStateQC(Tag_Name, lp_dwstate, pdwQualityCode);

Parameters

Tag_Name
Tag name

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1409
C scripting
2.1 System functions

lp_dwstate
Pointer to a DWORD to which the tag status is saved on completion of the system function
cycle.

pdwQualityCode
Pointer on a DWORD in which the quality code of the tag is created after the system function
cycle.

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.
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:
TRUE: System function completed without errors.
FALSE: An error has occurred.

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.
The status and quality code is saved to the dwState and dwQC addresses of the tag.

WinCC Engineering V18 – Programming reference

1410 System Manual, 11/2022, Online documentation
 C scripting
2.1 System functions

A specific code will be executed, depending on the return value in bValue (TRUE/FALSE).

{
DWORD dwState;
DWORD dwQC;
BOOL bValue;

dwState = 0xFFFFFFFF;

//Get the tag value

//dwstate is the tag state
bValue = GetTagBitStateQCWait("gs_tag_bit",&dwState,&dwQC);

//Create a string which includes the tag value

if (bValue)
{
// User defined code if the
// value of the tag is true
...
}
else
{
// User defined code if the
// value of the tag is false
...
}
}

See also
Quality codes of HMI tags (Page 1550)
Constants (Page 1555)

2.1.17.9 GetTagStateWait functions

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.
Can only be used in C scripting.
The following table lists the different GetTagStateWait functions for reading the tag value:

Type Function name Parameters PLC data type HMI data

type
BOOL GetTagBitStateWait Tag Tag_Name, PDWORD Binary tag Bool
lp_dwstate
BYTE GetTagByteStateWait Tag Tag_Name, PDWORD Unsigned 8-bit UByte
lp_dwstate

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1411
C scripting
2.1 System functions

Type Function name Parameters PLC data type HMI data

type
char* GetTagCharStateWait Tag Tag_Name, PDWORD Text tag 8-bit or String
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 GetTagFloatStateWait Tag Tag_Name, PDWORD Floating point 32- Float
lp_dwstate bit
BOOL GetTagRawStateWait Tag Tag_Name, BYTE* pVal‐ Raw data type Raw
ue, DWORD size, PDWORD
lp_dwstate
signed char GetTagSByteStateWait Tag Tag_Name, PDWORD Signed 8-bit Byte
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 GetTagWordStateWait Tag Tag_Name, PDWORD Unsigned 16-bit UShort
lp_dwstate

Syntax
<Type><FunctionName><(Parameter)>
Example: BOOL GetTagBitStateWait(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
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.
The system function "GetTagCharStateWait" returns a pointer to a value of the tag of data
type "char".

WinCC Engineering V18 – Programming reference

1412 System Manual, 11/2022, Online documentation
 C scripting
2.1 System functions

The system function "GetTagRawState" returns TRUE or FALSE:

TRUE: System function completed without errors.
FALSE: An error has occurred.

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.
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 = GetTagBitStateWait("gs_tag_bit",&dwState);

//Create a string which includes the tag value

if (bValue)
{
// User defined code if the
// value of the tag is true
...
}
else
{
// User defined code if the
// value of the tag is false
...
}
}

See also
Constants (Page 1555)

2.1.17.10 GetTagValue functions

Description
Enables the transfer of a value in the form of a variant. Determines the pointer on the results
structure that contains the value.
Can only be used in C scripting.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1413
C scripting
2.1 System functions

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
System function completed without errors.

FALSE
An error has occurred.

Example
The GetTagValue function is used in the following program code to calculate the value in varKey.

WinCC Engineering V18 – Programming reference

1414 System Manual, 11/2022, Online documentation
 C scripting
2.1 System functions

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
printf ( "Error - function failed." );
...
}
}

2.1.17.11 GetTagValueStateQC functions

Description
Enables the transfer of a value in the form of a variant. Determines the pointer on the results
structure that contains the value. It also returns the status and quality code of the tags.
The system function can be used in C scripting only.

Syntax
BOOL GetTagValueStateQC(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_STRUCTEX"

lpdmError
Pointer on the structure that contains the error description.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1415
C scripting
2.1 System functions

Return value

TRUE
System function completed without errors.

FALSE
An error has occurred.

Example
The GetTagValueStateQC function is used in the following program code to calculate the value
in varKey.
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 keyFound (TRUE/FALSE).

{
DM_VARKEY varKey;
DM_VAR_UPDATE_STRUCTEX result;
CMN_ERROR error:
// 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)
{
// User defined code if the
// value of the tag is true
...
}
else
{
// User defined code if the
// value of the tag is false
...
}
}

2.1.17.12 GetTagValueStateQCWait functions

Description
Enables the transfer of a value in the form of a variant. Determines the pointer on the results
structure that contains the value. The value is read explicitly from the AS. It also returns the
status and quality code of the tags.

WinCC Engineering V18 – Programming reference

1416 System Manual, 11/2022, Online documentation
 C scripting
2.1 System functions

Can only be used in C scripting.

Syntax
BOOL GetTagValueStateQCWait(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_STRUCTEX"

lpdmError
Pointer on the structure that contains the error description.

Return value

TRUE
System function completed without errors.

FALSE
An error has occurred.

Example
The following program code uses the function GetTagValueStateQCWait for reading
The status and quality code is saved to the dwState and dwQC addresses of the tag.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1417
C scripting
2.1 System functions

A specific code will be executed, depending on the return value in keyFound (TRUE/FALSE).

{
DM_VARKEY varKey;
DM_VAR_UPDATE_STRUCTEX result;
CMN_ERROR error:
// 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)
{
// User defined code if the
// value of the tag is true
...
}
else
{
// User defined code if the
// value of the tag is false
...
}
}

2.1.17.13 GetTagValueWait functions

Description
Enables the transfer of a value in the form of a variant. Determines the pointer on the results
structure that contains the value. The value is read directly from the AS.
Can only be used in C scripting.

Syntax
BOOL GetTagValueWait(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"

WinCC Engineering V18 – Programming reference

1418 System Manual, 11/2022, Online documentation
 C scripting
2.1 System functions

lpdmError
Pointer on the structure that contains the error description

Return value

TRUE
System function completed without errors.

FALSE
An error has occurred.

Example
The GetTagValueWait 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 = GetTagValueWait(&varKey, &result, &error);

if (keyFound)
{
// succeeded, key found
// print tag value
printf ("Value of varKey: %d\r\n", &varKey);
...
}
else
{
// failed
printf ( "Error - function failed." );
}
...
}

2.1.17.14 GetTagWait functions

Description
The GetTagWaitXXX function calculates the value of a tag of the specified data type. The value
is read explicitly from the AS.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1419
C scripting
2.1 System functions

Can only be used in C scripting.

The following table shows the different GetTagWait functions for reading the tag value:

Type Function name Parameters PLC data type HMI data type
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 GetTagSDWordWait Tag Tag_Name Signed 32-bit Integer
short int GetTagSWordWait Tag Tag_Name Signed 16-bit Short
WORD GetTagWordWait Tag Tag_Name Unsigned 16-bit UShort

Syntax
<Type><FunctionName><(Parameter)>;
Example: BYTE GetTagByteWait(Tag_Name);

Parameters

Tag_Name
Tag name

pValue
Pointer to a byte field containing the value of the raw data tags.

Return value
Value of the tags in the specified type.
System function "GetTagCharWait" returns a pointer to a string that contains the tag value.
System function "GetTagRawWait" returns TRUE or FALSE:
TRUE: System function completed without errors.
FALSE: An error has occurred.

WinCC Engineering V18 – Programming reference

1420 System Manual, 11/2022, Online documentation
 C scripting
2.1 System functions

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);
...
}

The saved return value can be processed in the following code.

2.1.18 IncreaseTag

Description
Adds the given value to the value of the tags.
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. 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.

Use in the function list

IncreaseTag (Tag, Value)

Use in user-defined functions

IncreaseTag Tag, Value
Can be used if the configured device supports user-defined functions. For more information,
refer to "AUTOHOTSPOT".

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1421
C scripting
2.1 System functions

Parameters

Tag
The tag to which the given value is added.

Value
The value that is added.

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
...
BYTE old_value = varX;

//Increase tag
IncreaseTag(varX, value);

//print original value and function result

printf ("User input: %i\r\n, Result of function IncreaseTag: %i\r\n", old_value, varX);
...
}

2.1.19 InquireLanguage

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.
The system function can be used in C scripting only.

Syntax
DWORD* InquireLanguage(PointerToACounter);

Parameters

PointerToACounter
Pointer to the number of language IDs found

WinCC Engineering V18 – Programming reference

1422 System Manual, 11/2022, Online documentation
 C scripting
2.1 System functions

Return value
Pointer to a field containing the established language IDs.
The following assignments apply (hexadecimal language code):

Symbolic name Value(hexadeci‐ Abbreviation

mal)
LANG_ARABIC 0x0401
LANG_AFRIKAANS 0x0436
LANG_ALBANIAN 0x041C
LANG_BASQUE 0x042D
LANG_BULGARIAN 0x0402
LANG_BYELORUSSIAN 0x0423
LANG_CATALAN 0x0403
LANG_CHINESE 0x0404
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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1423
C scripting
2.1 System functions

Symbolic name Value(hexadeci‐ Abbreviation

mal)
LANG_SWEDISH 0x041D SVE
LANG_THAI 0x041E
LANG_TURKISH 0x041F TRK
LANG_UKRAINIAN 0x0422

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++);
}
}

The saved return value can be processed in the following code.

2.1.20 InverseLinearScaling

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.

WinCC Engineering V18 – Programming reference

1424 System Manual, 11/2022, Online documentation
 C scripting
2.1 System functions

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.

Use in the function list

InvertLinearScaling (X, Y, b, a)

Use in user-defined functions

InverseLinearScaling X, Y, b, a
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

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
The value which is subtracted.

a
The value through which is divided.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1425
C scripting
2.1 System functions

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.

2.1.21 InvertBit

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).

Use in the function list

InvertBit (Tag)

Use in user-defined functions

InvertBit Tag
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

Parameters

Tag
The tag whose bit is set.

WinCC Engineering V18 – Programming reference

1426 System Manual, 11/2022, Online documentation
 C scripting
2.1 System functions

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);
...
}

2.1.22 InvertBitInTag

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).

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1427
C scripting
2.1 System functions

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.

Use in the function list

InvertBitInTag (Tag, Bit)

Use in user-defined functions

InvertBitInTag Tag, Bit
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

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.

WinCC Engineering V18 – Programming reference

1428 System Manual, 11/2022, Online documentation
 C scripting
2.1 System functions

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.

'Programming language: VB
Dim myTag
Dim myOutputField
Dim bValue, bSaved, bitposition, strResult

Set myTag = SmartTags("bStatusWord")

Set myOutputField=HMIRuntime.Screens("MyScreen").ScreenItems("objTextField")

'Get current value

bValue=myTag.Value

'Save current value

bSaved=bValue

'Invert Bit in position

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

'Output result old and new value:

strResult="Old Value: "&bSaved &Chr(13)&"New Value: "&bValue
myOutputField.Text=strResult

//Programming language: C
{
BYTE bStatusWord;
BYTE bsaved = bStatusWord;
BYTE bitposition = 2;

//Invert bit in bitposition

InvertBitInTag (bStatusWord, bitposition);
//print current and saved value
printf ("Current value: %d\r\n, Saved value: %d\r\n",bStatusWord, bsaved);
...
}

2.1.23 IsUserAuthorized

Description
Authentication of users.
Can only be used in C scripting.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1429
C scripting
2.1 System functions

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.

WinCC Engineering V18 – Programming reference

1430 System Manual, 11/2022, Online documentation
 C scripting
2.1 System functions

2.1.24 LinearScaling

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.
The inverse of this function is the "InvertLinearScaling" 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.

Use in the function list

LinearScaling (Y, a, X, b)

Use in user-defined functions

LinearScaling Y, a, X, b
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

Parameters

Y
The tag which is assigned the value calculated from the linear equation.

a
The value with which is multiplied.

X
The tag that contains the value used for calculation.

b
The value that is added.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1431
C scripting
2.1 System functions

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);

...
}

The saved return value can be processed in the following code.

2.1.25 ReportJob

Description
A print job or the preview for a print job is started depending on the value of the NameOfMethod
parameter.
Can only be used in C scripting.

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.

WinCC Engineering V18 – Programming reference

1432 System Manual, 11/2022, Online documentation
 C scripting
2.1 System functions

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
{
// User defined code if the
// job is a preview or failed
...
}
}

2.1.26 ResetBit

Description
Sets the value of a "Bool" type tag to 0 (FALSE).

Use in the function list

ResetBit (Tag)

Use in user-defined functions

ResetBit Tag
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1433
C scripting
2.1 System functions

Parameters

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

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.

'Programming language: VB
Dim myTag
Dim myOutputField
Dim bValue, bSaved, strResult

Set myTag = SmartTags("bStatus")

Set myOutputField=HMIRuntime.Screens("MyScreen").ScreenItems("objTextField")

'Set value
bValue=1
myTag.Value=bValue

'Save current value

bSaved=bValue

'Reset Bit
ResetBit 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 = 1;
BOOL bSaved = bStatus;

//Reset bit
ResetBit (bStatus);

//print current and saved value

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

WinCC Engineering V18 – Programming reference

1434 System Manual, 11/2022, Online documentation
 C scripting
2.1 System functions

2.1.27 ResetBitInTag

Description
Sets a bit in the specified tag to 0 (FALSE).
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 "ResetBit" system
function instead.

Use in the function list

ResetBitInTag (Tag, Bit)

Use in user-defined functions

ResetBitInTag Tag, Bit
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1435
C scripting
2.1 System functions

Example
The following program code sets a bit to 0 at the specified bitposition in the bStatusWord tag and
outputs the result along with the original bSaved value.

'Programming language: VB
Dim myTag
Dim myOutputField
Dim bValue, bSaved, bitposition, strResult

Set myTag = SmartTags("bStatusWord")

Set myOutputField=HMIRuntime.Screens("MyScreen").ScreenItems("objTextField")

'Save current value

bValue=myTag.Value
bSaved=bValue

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

'Output result old and new value:

strResult="Old Value: "&bSaved &Chr(13)&"New Value: "&bValue
myOutputField.Text=strResult

//Programming language: C
{

BYTE bSaved;
BYTE bitposition = 2;

bSaved = GetTagByte("bStatusWord");

//Reset bit in bitposition

ResetBitInTag ("bStatusWord", bitposition);

//print current and saved value

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

2.1.28 Set_Focus

Function
Sets the focus on the specified object.

WinCC Engineering V18 – Programming reference

1436 System Manual, 11/2022, Online documentation
 C scripting
2.1 System functions

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
An error has occurred.

2.1.29 SetBit

Description
Sets the value of a "Bool" type tag to 1 (TRUE).

Use in the function list

SetBit (Tag)

Use in user-defined functions

SetBit Tag
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

Parameters

Tag
The BOOL type tag which is set to 1 (TRUE).

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1437
C scripting
2.1 System functions

Example
The following program code sets the value of the Boolean tag bStatus to 1 by means of the SetBit
function 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")

'Set value
bValue=0
myTag.Value=bValue

'Save current value

bSaved=bValue

'Set Bit
SetBit 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;

//Set bit
SetBit (bStatus);

//print current and saved value

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

2.1.30 SetBitInTag

Description
Sets a bit in the given tag to 1 (TRUE).

WinCC Engineering V18 – Programming reference

1438 System Manual, 11/2022, Online documentation
 C scripting
2.1 System functions

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 "SetBit" system function
instead.

Use in the function list

SetBitInTag (Tag, Bit)

Use in user-defined functions

SetBitInTag Tag, Bit
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

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).
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.

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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1439
C scripting
2.1 System functions

Example
The following program code sets a bit to 1 at the specified bitposition in the bStatusWord tag and
outputs the result along with the original bSaved value.

'Programming language: VB
Dim myTag
Dim myOutputField
Dim bValue, bSaved, bitposition, strResult

Set myTag = SmartTags("bStatusWord")

Set myOutputField=HMIRuntime.Screens("MyScreen").ScreenItems("objTextField")

'Save current value

bValue=myTag.Value
bSaved=bValue

'Set Bit in tag

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

'Output result old and new value:

strResult="Old Value: "& bSaved & "New Value: " & bValue
myOutputField.Text=strResult

//Programming language: C
{

BYTE bSaved;
BYTE bitposition = 1;

bSaved = GetTagByte("bStatusWord");

//Reset bit in bitposition

SetBitInTag ("bStatusWord", bitposition);

//print current and saved value

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

2.1.31 SetLanguageByLocaleID

Description
Changes the language setting in Runtime.
Can only be used in C scripting.

WinCC Engineering V18 – Programming reference

1440 System Manual, 11/2022, Online documentation
 C scripting
2.1 System functions

Syntax
BOOL SetLanguageByLocaleID(dwLocaleID);

Parameters

dwLocaleID
Language ID of the language to be set

Return value

TRUE
System function completed without errors.

FALSE
An error has occurred.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1441
C scripting
2.1 System functions

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);
}

The saved return value can be processed in the following code.

See also
GetLanguageByLocaleID (Page 1384)

2.1.32 SetLanguageByName

Description
Changes the language setting in Runtime by the country name of the language to be set.
Can only be used in C scripting.

WinCC Engineering V18 – Programming reference

1442 System Manual, 11/2022, Online documentation
 C scripting
2.1 System functions

Use in the function list

SetLanguageByName (Language))

Syntax
Bool SetLanguageByName(lpszLanguage);

Parameters

lpszLanguage
Pointer to the language abbreviation according to "RFC 1766" format.

Return value

TRUE
System function completed without errors.

FALSE
An error has occurred.

2.1.33 SetLink

Function
Creating a tag connection of object properties

Syntax
BOOL SetLink(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, LPCTSTR
lpszPropertyName, LPLINKINFO *pLink);

Parameter

lpszPictureName
Screen name

lpszObjectName
Object name

lpszPropertyName
Name of the object property

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1443
C scripting
2.1 System functions

pLink
Pointer to a structure of the type: LINKINFO

Return value

TRUE
The function has been completed without any errors.

FALSE
An error has occurred.

See also
Structure definition LINKINFO (Page 1539)

2.1.34 SetProp

2.1.34.1 SetPropBOOL

Description
Sets an object property of data type "BOOL".
Can only be used in C scripting.

Syntax
BOOL SetPropBOOL(ScreenName, Object, NameOfTheProperty, Value)

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

Value
Value assigned to the object property of data type "BOOL".

WinCC Engineering V18 – Programming reference

1444 System Manual, 11/2022, Online documentation
 C scripting
2.1 System functions

Return value

TRUE
System function completed without errors.

FALSE
An error has occurred.

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" );
}
...
}

The saved return value can be processed in the following code.

2.1.34.2 SetPropChar

Description
Sets an object property of data type "char".
Can only be used in C scripting.

Syntax
BOOL SetPropChar(ScreenName, Object, NameOfTheProperty, Value)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1445
C scripting
2.1 System functions

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

Value
Value assigned to the object property of data type "char".

Return value

TRUE
System function completed without errors.

FALSE
An error has occurred.

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" );
}
...
}

The saved return value can be processed in the following code.

WinCC Engineering V18 – Programming reference

1446 System Manual, 11/2022, Online documentation
 C scripting
2.1 System functions

2.1.34.3 SetPropDouble

Description
Sets an object property of data type "Double".
Can only be used in C scripting.

Syntax
BOOL SetPropDouble(ScreenName, Object, NameOfTheProperty, Value)

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

Value
Value assigned to the object property of data type "double".

Return value

TRUE
System function completed without errors.

FALSE
An error has occurred.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1447
C scripting
2.1 System functions

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" );
}
...
}

The saved return value can be processed in the following code.

2.1.34.4 SetPropLong

Description
Sets an object property of data type "long".
Can only be used in C scripting.

Syntax
BOOL SetPropLong(ScreenName, Object, NameOfTheProperty, Value)

Parameters

ScreenName
Screen name

Object
Object name You must set the parameter Object = NULL if the function call relates to a screen
object property.

WinCC Engineering V18 – Programming reference

1448 System Manual, 11/2022, Online documentation
 C scripting
2.1 System functions

NameOfTheProperty
Name of the object property

Value
Value assigned to the object property of data type "long".

Return value

TRUE
System function completed without errors.

FALSE
An error has occurred.

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" );
}
...
}

The saved return value can be processed in the following code.

2.1.35 SetPropertyByConstant

Description
Specifies the value of an object property as a string.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1449
C scripting
2.1 System functions

Use in the function list

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

Use in user-defined functions

SetPropertyByConstant Screen_name, Screen_object, Property_name, Value
Can be used if the configured device supports user-defined functions. For more information,
refer to "AUTOHOTSPOT".
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

...

WinCC Engineering V18 – Programming reference

1450 System Manual, 11/2022, Online documentation
 C scripting
2.1 System functions

{
//Programming language: C
//Name of the picture: Trends
//Name of the f(t) trend view control: Control_1

SetPropertyByConstant ("Trends", "Control_1", "ToolbarButtonClick", "26");

// 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.

'Programming language: VBS

'Name of the picture: Trends

SetPropertyByConstant "Trends", "Trends", "Backcolor", "255"

'User defined code

...

{
//Programming language: C
//Name of the picture: Trends

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

// User defined code

...
}

Alternatively, use the password ZERO or a space string instead of the second parameter
(object).

2.1.36 SetPropertyByProperty

Description
Specifies the value of an object property with another object property.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1451
C scripting
2.1 System functions

Use in the function list

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

Use in user-defined functions

SetPropertyByProperty Screen_name, Screen_object, Property_name, Source_screen_name,
Source_screen_object, Source_property_name
Can be used if the configured device supports user-defined functions. For more information,
refer to "AUTOHOTSPOT".
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
Name of the screen that contains the object.

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

Name of the property that will be changed.

WinCC Engineering V18 – Programming reference

1452 System Manual, 11/2022, Online documentation
 C scripting
2.1 System functions

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".

'Programming language: VBS

'Name of source picture: Trend_1
'Name of target picture: Trend_2
'Name of the f(t) trend view control: Control_1

SetPropertyByProperty "Trend_1", "Control_1", "ToolbarButtonClick", "Trend_2",

"Control_2", "ToolbarButtonClick"

'User defined code

...

{
//Programming language: C
//Name of source picture: Trend_1
//Name of target picture: Trend_2
//Name of the f(t) trend view control: Control_1

SetPropertyByProperty ("Trend_1", "Control_1", "ToolbarButtonClick", "Trend_2",

"Control_2", "ToolbarButtonClick");

// User defined code

...
}

2.1.37 SetPropertyByTag

Description
Specifies the value of an object property with a tag value.

Use in the function list

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

Use in user-defined functions

SetPropertyByTag Screen_name, Screen_object, Property_name, Tag_name
Can be used if the configured device supports user-defined functions. For more information,
refer to "AUTOHOTSPOT".

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1453
C scripting
2.1 System functions

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
Name of the screen that contains the object.

Screen object
Name of the object containing the property to be set with the tag value.

Name of the property

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.

'Programming language: VBS

SetPropertyByTag screenName, objectName, "CaptionText", "HMI_value_1"

'User defined code

...

{
//Programming language: C
SetPropertyByTag (screenName, objectName, "CaptionText", "HMI_value_1");

// User defined code

...
}

WinCC Engineering V18 – Programming reference

1454 System Manual, 11/2022, Online documentation
 C scripting
2.1 System functions

Example
The SetPropertyByTag 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

...

{
//Programming language: C
//Name of the picture: Trends
//Name of the f(t) trend view control: Control_1

SetPropertyByConstant ("Trends", "Control_1", "ToolbarButtonClick", "26");

// User defined code

...
}

2.1.38 SetPropertyByTagIndirect

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.

Use in the function list

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

Use in user-defined functions

SetPropertyByTagIndirect Screen_name, Screen_object, Property_name, Tag_name
Can be used if the configured device supports user-defined functions. For more information,
refer to "AUTOHOTSPOT".
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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1455
C scripting
2.1 System functions

Parameters

Screen name
Name of the screen that contains the object.

Screen object
Name of the object whose property you want to change.

Name of the property

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: .

'Programming language: VBS

SetPropertyByTagIndirect GetParentScreen(screenName), GetParentScreenWindow(screenName),
"ScreenName", "HMI_value_1"

'User defined code

...

{
//Programming language: C
SetPropertyByTagIndirect (GetParentScreen(screenName), GetParentScreenWindow(screenName),
"ScreenName", "HMI_value_1");

// User defined code

...
}

2.1.39 SetTag

2.1.39.1 SetTag functions

Description
The SetTagXXX function calculates the value of a tag of the specified data type.
Can only be used in C scripting.

WinCC Engineering V18 – Programming reference

1456 System Manual, 11/2022, Online documentation
 C scripting
2.1 System functions

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 value
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)>;

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1457
C scripting
2.1 System functions

Example: BOOL SetTagBit(Tag_Name, value);

Parameter

Tag_Name
Tag name

value
Value of the tags in the specified data type.

pValue
Pointer to a byte field containing the value of the raw data tags.

size
Length of the byte field in bytes

Return value

TRUE
System function completed without errors.
However, no check is made to verify that the tag was written without any errors.

FALSE
An error has occurred.

WinCC Engineering V18 – Programming reference

1458 System Manual, 11/2022, Online documentation
 C scripting
2.1 System functions

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;

//Set the tag to true

ok = SetTagBit("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." );
}
...
}

The saved return value can be processed in the following code.

See also
Quality codes of HMI tags (Page 1550)
VariableStateType property (Page 1554)

2.1.39.2 SetTagDateTime

Function
Sets the value of a tag of data type "Date/Time".

Syntax
BOOL SetTagDateTime(Tag_Name, value);

Parameter

Tag_Name
Tag name

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1459
C scripting
2.1 System functions

value
Value of the tag in the data type "Date/Time".

Return value

TRUE
The function itself has been completed without any errors.
However, no check is made to verify that the tag was written without any errors.

FALSE
An error has occurred.

2.1.39.3 SetTagMultiStateWait functions

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 can be used in C scripting only.
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.
For more information, refer to the FAQs on the Internet, entry ID 26712371 (https://
support.industry.siemens.com/cs/us/en/view/26712371).

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
System function completed without errors.
However, no check is made to verify that the tag was written without any errors.

WinCC Engineering V18 – Programming reference

1460 System Manual, 11/2022, Online documentation
 C scripting
2.1 System functions

FALSE
An error has occurred.

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);
...
}

The saved return value can be processed in the following code.

See also
Constants (Page 1555)
Entry 26712371 (https://support.industry.siemens.com/cs/us/en/view/26712371)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1461
C scripting
2.1 System functions

2.1.39.4 SetTagMultiWait functions

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.
Can only be used in C scripting.
For more information, refer to the FAQs on the Internet, entry ID 26712371 (https://
support.industry.siemens.com/cs/us/en/view/26712371).

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
System function completed without errors.
However, no check is made to verify that the tag was written without any errors.

FALSE
An error has occurred.

WinCC Engineering V18 – Programming reference

1462 System Manual, 11/2022, Online documentation
 C scripting
2.1 System functions

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
printf ( "Function has run through.\r\n" );

// Get values and print

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);
}
else
{
// failed
printf ( "Error - function 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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1463
C scripting
2.1 System functions

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,

"Ernie_char", &szVar2Value,
"Ernie_double", &dbVar3Value);

printf("Word %d, String %s, Double %f\r\n",

dwVar1Value, szVar2Value, dbVar3Value);

See also
Entry 26712371 (https://support.industry.siemens.com/cs/us/en/view/26712371)

2.1.39.5 SetTagState functions

Description
Sets the value of a tag of a specified data type. It also returns the status of the tags.
Can only be used in C scripting.
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 int Binary tag Bool
value, PDWORD
lp_dwstate
SetTagByteS‐ Tag Tag_Name, BYTE val‐ Unsigned 8-bit UByte
tate ue, PDWORD lp_dwstate
SetTagChar‐ Tag Tag_Name, LPSTR Text tag 8-bit or text tag 16- String
State value, PDWORD bit
lp_dwstate
SetTagDoubleS‐ Tag Tag_Name, double Floating point 64-bit Double
tate value, PDWORD
lp_dwstate
SetTagDWord‐ Tag Tag_Name, DWORD Unsigned 32-bit UInteger
State value, PDWORD
lp_dwstate
SetTagFloat‐ Tag Tag_Name, float val‐ Floating point 32-bit Float
State ue, PDWORD lp_dwstate
SetTagRaw‐ Tag Tag_Name, BYTE* Raw data type Raw
State pValue, DWORD size,
PDWORD lp_dwstate

WinCC Engineering V18 – Programming reference

1464 System Manual, 11/2022, Online documentation
 C scripting
2.1 System functions

Function name Parameters PLC data type HMI data type

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 int Signed 16-bit Short
State 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
Pointer to a DWORD to which the tag status is saved on completion of the system function
cycle.

pFormat
Format description for all the requested tags along with name and value for each tag.

pValue
Pointer to a byte field containing the value of the raw data tags.

size
Length of the byte field in bytes

Return value

TRUE
System function completed without errors.
However, no check is made to verify that the tag was written without any errors.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1465
C scripting
2.1 System functions

FALSE
An error has occurred.

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.
The saved return value can be processed in the following code.

{
DWORD dwstate;
BOOL ok;

//Load dwState with default values

dwstate = 0xFFFFFFFF;
//Set the value of the tag to TRUE
//dwstate is the tag state
ok = SetTagBitState("gs_tag_bit",TRUE,&dwstate);

//error handling
if(ok)
{
// succeeded
printf ( "Function has run through.\r\n" );
printf ("Status of gs_tag_bit: %d\r\n", dwstate);
}
else
{
// failed
printf ( "Error - function failed." );
}
...
}

See also
Constants (Page 1555)

2.1.39.6 SetTagStateWait functions

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.
Can only be used in C scripting.

WinCC Engineering V18 – Programming reference

1466 System Manual, 11/2022, Online documentation
 C scripting
2.1 System functions

The following table lists the different SetTagStateWait functions for setting the tag value:

Function name Parameters PLC data type HMI data type

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, LPSTR Text tag 8-bit or text tag 16- String
Wait value, PDWORD bit
lp_dwstate
SetTagDoubleSta‐ Tag Tag_Name, double Floating point 64-bit Double
teWait value, PDWORD
lp_dwstate
SetTagDWordState‐ Tag Tag_Name, DWORD Unsigned 32-bit UInteger
Wait value, PDWORD
lp_dwstate
SetTagFloatState‐ Tag Tag_Name, float val‐ Floating point 32-bit Float
Wait ue, PDWORD lp_dwstate
SetTagRawState‐ Tag Tag_Name, BYTE* Raw data type Raw
Wait pValue, DWORD size,
PDWORD lp_dwstate
SetTagSByteState‐ Tag Tag_Name, char val‐ Signed 8-bit Byte
Wait ue, PDWORD lp_dwstate
SetTagSDWordSta‐ Tag Tag_Name, long int Signed 32-bit Integer
teWait value, PDWORD
lp_dwstate
SetTagSWordState‐ Tag Tag_Name, short Signed 16-bit Short
Wait int value, PDWORD
lp_dwstate
SetTagWordState‐ Tag Tag_Name, WORD Unsigned 16-bit UShort
Wait value, PDWORD
lp_dwstate

Syntax
BOOL<FunctionName><(Parameter)>;
Example: BOOL SetTagBitStateWait(Tag_Name, value, lp_dwstate);

Parameters

Tag_Name
Tag name

value
Value of the tags of a specified type.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1467
C scripting
2.1 System functions

lp_dwstate
Pointer to a DWORD to which the tag status is saved on completion of the system function
cycle.

pValue
Pointer to a byte field containing the value of the raw data tags.

size
Length of the byte field in bytes

Return value

TRUE
System function completed without errors.
However, no check is made to verify that the tag was written without any errors.

FALSE
An error has occurred.

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.

WinCC Engineering V18 – Programming reference

1468 System Manual, 11/2022, Online documentation
 C scripting
2.1 System functions

The saved return value can be processed in the following code.

{
DWORD dwstate;
BOOL ok;

//Load dwState with default values

dwstate = 0xFFFFFFFF;
//Set the value of the tag to TRUE
//dwstate is the tag state
ok = SetTagBitStateWait("gs_tag_bit",TRUE,&dwstate);

//error handling
if(ok)
{
// succeeded
printf ( "Function has run through.\r\n" );
printf ("Status of gs_tag_bit: %d\r\n", dwstate);
}
else
{
// failed
printf ( "Error - function failed." );
}
...
}

See also
Constants (Page 1555)

2.1.39.7 SetTagValue functions

Description
Enables the transfer of a value in the form of a variant and sets the pointer to the value of data
type "Variant".
Can only be used in C scripting.

Syntax
BOOL SetTagValue(lpdmVarKey, lpdmValue, dwState, lpdmError);

Parameters

lpdmVarKey
Pointer to a structure of data type "DM_VARKEY"

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1469
C scripting
2.1 System functions

lpdmValue
Pointer to a structure of data type "Variant". Refer to relevant technical references for the
description of data type VARIANT.

lpdmError
Pointer on the structure that contains the error description.

Return value

TRUE
System function completed without errors.
However, no check is made to verify that the tag was written without any errors.

FALSE
An error has occurred.

Example
The SetTagValue function is used in the following program code to transfer the value in varKey.
A specific code will be executed, depending on the return value in keyFound (TRUE/FALSE).

{
// tags for setting the value
DM_VARKEY varKey;
LPVARIANT value;
LPCMN_ERROR error1:

// tags for getting the value

DM_VAR_UPDATE_STRUCT result;
CMN_ERROR error:

BOOL keyFound;

ok = SetTagValue(&varKey, &value, &error1);

if (keyFound)
{
// succeeded, get the new value
GetTagValue(&varKey, &result, &error);
// print tag value
printf ("Value of varKey: %d\r\n", &varKey);
...
}
else
{
// failed
printf ( "Error - function failed." );
...
}
}

WinCC Engineering V18 – Programming reference

1470 System Manual, 11/2022, Online documentation
 C scripting
2.1 System functions

2.1.39.8 SetTagValueWait functions

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.
Can only be used in C scripting.

Syntax
BOOL SetTagValueWait(lpdmVarKey, lpdmValue, dwState, lpdmError);

Parameters

lpdmVarKey
Pointer to a structure of data type "DM_VARKEY"

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
Pointer on the structure that contains the error description.

Return value

TRUE
System function completed without errors.
There is no check to see if the tag was written without any errors.

FALSE
An error has occurred.

Example
The SetTagValueWait function is used in the following program code to transfer the value in
varKey.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1471
C scripting
2.1 System functions

A specific code will be executed, depending on the return value in keyFound (TRUE/FALSE).

{
// tags for setting the value
DM_VARKEY varKey;
LPVARIANT value;
LPCMN_ERROR error1:

// tags for getting the value

DM_VAR_UPDATE_STRUCT result;
CMN_ERROR error:

BOOL keyFound;

ok = SetTagValueWait(&varKey, &value, &error1);

if (keyFound)
{
// succeeded, get the new value
GetTagValueWait(&varKey, &result, &error);
// print tag value
printf ("Value of varKey: %d\r\n", &varKey);
...
}
else
{
// failed
printf ( "Error - function failed." );
...
}
}

2.1.39.9 SetTagWait functions

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.
Can only be used in C scripting.
The following table lists the different SetTagWait functions for setting the tag value:

Function name Parameters PLC data type HMI data type

SetTagBitWait Tag Tag_Name, short int Binary tag Bool
value
SetTagByteWait Tag Tag_Name, BYTE val‐ Unsigned 8-bit UByte
ue
SetTagCharWait Tag Tag_Name, char* Text tag 8-bit or text tag 16- String
value bit
SetTagDouble‐ Tag Tag_Name, double Floating point 64-bit Double
Wait value

WinCC Engineering V18 – Programming reference

1472 System Manual, 11/2022, Online documentation
 C scripting
2.1 System functions

Function name Parameters PLC data type HMI data type

SetTagDWord‐ Tag Tag_Name, DWORD Unsigned 32-bit UInteger
Wait value
SetTagFloat‐ Tag Tag_Name, float val‐ Floating point 32-bit Float
Wait ue
SetTagRawWait Tag Tag_Name, BYTE* Raw data type Raw
pValue, DWORD size
SetTagSByte‐ Tag Tag_Name, char val‐ Signed 8-bit Byte
Wait ue
SetTagSDWord‐ Tag Tag_Name, long int Signed 32-bit Integer
Wait value
SetTagSWord‐ Tag Tag_Name, short int Signed 16-bit Short
Wait 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
Value of the tags of a specified type.

pValue
Pointer to a byte field containing the value of the raw data tags.

size
Length of the byte field in bytes

Return value

TRUE
System function completed without errors.
However, no check is made to verify that the tag was written without any errors.

FALSE
An error has occurred.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1473
C scripting
2.1 System functions

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;

//Set the tag to true

ok = SetTagBitWait("gs_tag_bit", TRUE);
//error handling
if(ok)
{
// succeeded
printf ( "Function has run through.\r\n" );
bvalue = GetTagBitWait("gs_tag_bit");
printf ("Value of gs_tag_bit: %d\r\n", bvalue);
}
else
{
// failed
printf ( "Error - function failed." );
}
...
}

The saved return value can be processed in the following code.

2.1.39.10 SetTag

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.

Use in the function list

SetTag (Tag, Value)

Use in user-defined functions

SetTag Tag, Value
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

WinCC Engineering V18 – Programming reference

1474 System Manual, 11/2022, Online documentation
 C scripting
2.1 System functions

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.

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." );
}
...
}

The saved return value can be processed in the following code.

2.1.39.11 SetTagByProperty

Description
Specifies a tag value with the value of an object property. The change is also logged in the alarm
system.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1475
C scripting
2.1 System functions

Use in the function list

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

Use in user-defined functions

SetTagByProperty Tag_name, Screen_name, Screen_object, Property_name,
With_or_without_operator_event
Can be used if the configured device supports user-defined functions. For more information,
refer to "AUTOHOTSPOT".

Parameters

Tag name
Name of the tag whose value is specified by the object property.

Screen name
Name of the screen that contains the object.

Screen object
Name of the object whose property supplies the tag value.

Name of the property

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);

...
}

WinCC Engineering V18 – Programming reference

1476 System Manual, 11/2022, Online documentation
 C scripting
2.1 System functions

2.1.39.12 SetTagByTagIndirect

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.

Use in the function list

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

Use in user-defined functions

SetTagByTagIndirect Tag_name, Source_tag_name, With_or_without_operator_event
Can be used if the configured device supports user-defined functions. For more information,
refer to "AUTOHOTSPOT".

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.

With or without operator event

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);

...
}

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1477
C scripting
2.1 System functions

2.1.39.13 SetTagIndirect

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.

Use in the function list

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

Use in user-defined functions

SetTagIndirect Tag_name, Value, With_or_without_operator_event
Can be used if the configured device supports user-defined functions. For more information,
refer to "AUTOHOTSPOT".

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.

With or without operator event

0 (hmiWithoutOperatorEvent) = Without operator event
1 (hmiWithOperatorEvent) = With operator event

Example
The following program code writes the value "value" to the tag Tag3.

{
int value;

SetTag ("IndirectWrite", "Tag3");

SetTagIndirect ("IndirectWrite", "value", hmiWithoutOperatorEvent);
...
}

WinCC Engineering V18 – Programming reference

1478 System Manual, 11/2022, Online documentation
 C scripting
2.1 System functions

2.1.39.14 SetTagIndirectByProperty

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.

Use in the function list

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

Use in user-defined functions

SetTagIndirectByProperty Tag_name, Screen_name, Screen_object, Property_name,
With_or_without_operator_event
Can be used if the configured device supports user-defined functions. For more information,
refer to "AUTOHOTSPOT".

Parameters

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

Screen name
Name of the screen that contains the object.

Screen object
Name of the object whose property supplies the value.

Name of the property

Name of the property which supplies the value.

With or without operator event

0 (hmiWithoutOperatorEvent) = Without input alarm
1 (hmiWithOperatorEvent) = With operator input alarm

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1479
C scripting
2.1 System functions

Example
The following program code writes the value of the object property "Background color" to the tag
Tag2.

{
SetTag ("IndirectWrite", "Tag2");
SetTagIndirectByProperty ("IndirectWrite", screenName, objectName, "BackColor",
hmiWithoutOperatorEvent);
...
}

2.1.39.15 SetTagIndirectByTagIndirect

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.

Use in the function list

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

Use in user-defined functions

SetTagIndirectByTagIndirect Tag_name, Source_tag_name, With_or_without_operator_event
Can be used if the configured device supports user-defined functions. For more information,
refer to "AUTOHOTSPOT".

Parameters

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

Tag name
Name of the indirect tag that returns the tag value.

With or without operator event

0 (hmiWithoutOperatorEvent) = Without operator event
1 (hmiWithOperatorEvent) = With operator event

WinCC Engineering V18 – Programming reference

1480 System Manual, 11/2022, Online documentation
 C scripting
2.1 System functions

Example
The following program code writes the value of the tag "Tag4" to the tag "Tag2".

{
SetTag ("IndirectWrite", "Tag2");
SetTag ("IndirectRead", "Tag4");
SetTagIndirectByTagIndirect ("IndirectWrite", "IndirectRead");
...
}

2.1.39.16 SetTagIndirectWithOperatorEvent

Description
Specifies the indirect name for a tag. The change is also logged in the alarm system.

Use in the function list

SetTagIndirectWithOperatorInputAlarm (Tag name (output), LpValue)

Use in user-defined functions

SetTagIndirectWithOperatorEvent
Can be used if the configured device supports user-defined functions. For more information,
refer to "AUTOHOTSPOT".

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.39.17 SetTagWithOperatorEvent

Description
Specifies the value for a tag. The change is also logged in the alarm system.

Use in the function list

SetTagWithOperatorEvent (name of the tag, value)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1481
C scripting
2.1 System functions

Use in user-defined functions

SetTagWithOperatorEvent Tag_name, Value
Can be used if the configured device supports user-defined functions. For more information,
refer to "AUTOHOTSPOT".

Parameters

Name of the tag

Name of the tag whose value is to be set.

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.

'Programming language: VBS

SetTagWithOperatorEvent result, value
...

//Programming language: C
{
SetTagWithOperatorEvent ("result", "value");
...
}

2.1.40 StartProgram

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);

WinCC Engineering V18 – Programming reference

1482 System Manual, 11/2022, Online documentation
 C scripting
2.1 System functions

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;
char* number;

//start the program calc.exe

StartProgram("C:\\Winnt\\system32\\calc.exe",number,hmiShowMinimized,
Wait_for_program_end);
...
}

2.1.41 StopRuntime

Description
Exits the runtime software and thereby the project running on the HMI device.

Use in the function list

StopRuntime (Mode)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1483
C scripting
2.1 System functions

Use in user-defined functions

StopRuntime Mode
Can be used if the configured device supports user-defined functions. For additional
information, refer to "Device dependency".

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)

Example
The following program code shuts down Runtime and the operating system.

//Stop runtime and shutdown

StopRuntime (hmiStopRuntimeAndOperationSystem);

The saved return value can be processed in the following code.

2.1.42 StoreScreen

Description
Saves the current screen. This screen can be opened with the ActivateStoredScreen system
function.
Can only be used in C scripting.

Syntax
BOOL StoreScreen();

Return value

TRUE
System function completed without errors.

WinCC Engineering V18 – Programming reference

1484 System Manual, 11/2022, Online documentation
 C scripting
2.1 System functions

FALSE
An error has occurred.

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 1376)

2.1.43 SystemTimeToDate

Description
Converts a date-clock time specification in SYSTEMTIME format into the DATE data format.
Can only be used in C scripting.

Use in the function list

SystemTimeToDate (value, pointer to time)

Syntax
SystemTimeToDate(Value, PointerToTime);

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1485
C scripting
2.1 System functions

Parameters

Value
Value in SYSTEMTIME data format

Pointer to time
Pointer to the result in the DATE format

Return value

TRUE
System function completed without errors.

FALSE
An error has occurred.

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.wYear = %d \r\n", st_2.wYear );
printf( "st_2.wMonth = %d \r\n", st_2.wMonth );
printf( "st_2.wDayOfWeek = %d \r\n", st_2.wDayOfWeek );
printf( "st_2.wDay = %d \r\n", st_2.wDay );
printf( "st_2.wHour = %d \r\n", st_2.wHour );
printf( "st_2.wMinute = %d \r\n", st_2.wMinute );
printf( "st_2.wSecond = %d \r\n", st_2.wSecond );
printf( "st_2.wMilliseconds = %d \r\n \r\n \r\n", st_2.wMilliseconds );

WinCC Engineering V18 – Programming reference

1486 System Manual, 11/2022, Online documentation
 C scripting
2.1 System functions

2.1.44 TriggerOperatorEvent

Description
The TriggerOperatorEvent system function triggers an operator input alarm.

Syntax
int TriggerOperatorEvent(dwFlags, dwMsgNum, lpszObjectName, dwMyTextID, doValueOld,
doValueNew, pszComment);

Parameters

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. To do so, configure a text list entry in the "C text list" tab of the "Text and graphics
list" editor.

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.
If you are using "FLAG_COMMENT_PARAMETER" (0x001) or "FLAG_COMMENT_DIALOG"
(0x003) for the parameter "dwFlags", enter the value 0 for the parameter "dwMyTextID".
If you are using "FLAG_TEXTID_PARAMETER" (0x100) for the parameter "dwFlags", enter the
ID of the text list entry for the parameter "dwMyTextID". You can configure the text list entry
in the "C text list" tab of the "Text and graphics list" editor.

doValueOld
Old value.

doValueNew
New value.

pszComment
Pointer to the text to be used as comment.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1487
C scripting
2.1 System functions

Return value

0
System function completed without errors.

-101
Editing of the operator input alarm could not be started.

-201
An error has occurred when calling "MSRTGetComment()".

-301
An error has occurred when calling "MSRTCreateMsgInstanceWithComment()".

2.1.45 UA (Recipe)

2.1.45.1 uaArchiveClose

Description
Terminates the connection to the current recipe.
Can only be used in C scripting.

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

WinCC Engineering V18 – Programming reference

1488 System Manual, 11/2022, Online documentation
 C scripting
2.1 System functions

2.1.45.2 uaArchiveDelete

Description
Deletes the data from a recipe. The configured recipe, however, is retained.
Can only be used in C scripting.

Syntax
BOOL uaArchiveDelete (
UAHARCHIVE hArchive,
LPCSTR pszWhere )

Parameters

UAHARCHIVE hArchive
Handle of the recipe. This handle is generated using uaQueryArchive or
uaQueryArchiveByName.

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.45.3 uaArchiveExport

Description:
Exports the current recipe to a log in CSV format.
Can only be used in C scripting.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1489
C scripting
2.1 System functions

Syntax
BOOL uaArchiveExport (
UAHARCHIVE hArchive,
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. When calling the function on a client, the path specified
refers to the server.

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.45.4 uaArchiveGetCount

Description
Reads the number of data records.
Can only be used in C scripting.

Syntax
LONG uaArchiveGetCount(

WinCC Engineering V18 – Programming reference

1490 System Manual, 11/2022, Online documentation
 C scripting
2.1 System functions

UAHARCHIVE hArchive,
LONG * plCount )

Parameters

UAHARCHIVE hArchive
Handle of the recipe. This handle is generated using uaQueryArchive or
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.45.5 uaArchiveGetFieldLength

Description
Reads the length of a field in the current data record.
Can only be used in C scripting.

Syntax
LONG uaArchiveGetFieldLength(
UAHARCHIVE hArchive,
LONG lField )

Parameters

UAHARCHIVE hArchive
Handle of the recipe. This handle is generated using uaQueryArchive or
uaQueryArchiveByName.

LONG lField
Field number, with lField = 1 addressing the first field.

Return value
Length of the current field.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1491
C scripting
2.1 System functions

2.1.45.6 uaArchiveGetFieldName

Description
Reads the name of a field in the current data record.
Can only be used in C scripting.

Syntax
VOID uaArchiveGetFieldName (
UAHARCHIVE hArchive,
LONG lField,
LPCSTR pszName,
LONG cMaxLen )

Parameters

UAHARCHIVE hArchive
Handle of the recipe. This handle is generated using uaQueryArchive or
uaQueryArchiveByName.

LONG lField
Field number, with lField = 1 addressing the first field.

LPCSTR pszName
Field Name

LONG cMaxLen
Maximum length

2.1.45.7 uaArchiveGetFields

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.
Can only be used in C scripting.

Syntax
LONG uaArchiveGetFields (

WinCC Engineering V18 – Programming reference

1492 System Manual, 11/2022, Online documentation
 C scripting
2.1 System functions

UAHARCHIVE hArchive )

Parameters

UAHARCHIVE hArchive
Handle of the recipe. This handle is generated using uaQueryArchive or
uaQueryArchiveByName.

Return value
Number of configured fields.

2.1.45.8 uaArchiveGetFieldType

Description
Reads the type of a field in the current data record.
Can only be used in C scripting.

Syntax
LONG uaArchiveGetFieldType (
UAHARCHIVE hArchive,
LONG lField )

Parameters

UAHARCHIVE hArchive
Handle of the recipe. This handle is generated using uaQueryArchive or
uaQueryArchiveByName.

LONG lField
Field number, with lField = 1 addressing the first field.

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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1493
C scripting
2.1 System functions

2.1.45.9 uaArchiveGetFieldValueDate

Description
Reads the date and time of a field in the current data record.
Can only be used in C scripting.

Syntax
BOOL uaArchiveGetFieldValueDate (
UAHARCHIVE hArchive,
LONG lField,
LPSYSTEMTIME pstDateTime )

Parameters

UAHARCHIVE hArchive
Handle of the recipe. This handle is generated using uaQueryArchive or
uaQueryArchiveByName .

LONG lField
Field number, with lField = 1 addressing the first field.

LPSYSTEMTIME pstDateTime
Pointer to a tag of the type SYSTEMTIME

Return value
TRUE
Successful reading of date and time
FALSE
Error

2.1.45.10 uaArchiveGetFieldValueDouble

Description
Reads the Double value of a field in the current data record.
The system function can be used in C scripting only.
BOOL uaArchiveGetFieldValueDouble (
UAHARCHIVE hArchive,

WinCC Engineering V18 – Programming reference

1494 System Manual, 11/2022, Online documentation
 C scripting
2.1 System functions

LONG lField,
double* pdValue )

Parameters

UAHARCHIVE hArchive
Handle of the recipe. This handle is generated using uaQueryArchive or
uaQueryArchiveByName.

LONG lField
Field number, with lField = 1 addressing the first field.

double* pdValue
Pointer to tag for the current field content.

Return value
TRUE
Successful reading of field value
FALSE
Error

2.1.45.11 uaArchiveGetFieldValueFloat

Description
Reads Float value of a field in the current data record.
Can only be used in C scripting.

Syntax
BOOL uaArchiveGetFieldValueFloat (
UAHARCHIVE hArchive,
LONG lField,
FLOAT* pfValue )

Parameters

UAHARCHIVE hArchive
Handle of the recipe. This handle is generated using uaQueryArchive or
uaQueryArchiveByName.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1495
C scripting
2.1 System functions

LONG lField
Field number, with lField = 1 addressing the first field.

FLOAT* pfValue
Pointer to Float tag for the current field content.

Return value
TRUE
Successful reading of field value
FALSE
Error

2.1.45.12 uaArchiveGetFieldValueLong

Description
Reads the Long Integer value of a field in the current data record.
Can only be used in C scripting.

Syntax
BOOL uaArchiveGetFieldValueLong (
UAHARCHIVE hArchive,
LONG lField,
LONG* pdValue )

Parameters

UAHARCHIVE hArchive
Handle of the recipe. This handle is generated using uaQueryArchive or
uaQueryArchiveByName.

LONG lField
Field number, with lField = 1 addressing the first field.

LONG* pdValue
Pointer to Long tag for the current field content.

Return value
TRUE

WinCC Engineering V18 – Programming reference

1496 System Manual, 11/2022, Online documentation
 C scripting
2.1 System functions

Successful reading of field value

FALSE
Error

2.1.45.13 uaArchiveGetFieldValueString

Description
Reads the string of a field in the current data record.
Can only be used in C scripting.

Syntax
BOOL uaArchiveGetFieldValueString (
UAHARCHIVE hArchive,
LONG lField,
LPSTR pszString,
LONG cMaxLen )

Parameters

UAHARCHIVE hArchive
Handle of the recipe. This handle is generated using uaQueryArchive or
uaQueryArchiveByName.

LONG lField
Field number, with lField = 1 addressing the first field.

LPCSTR pszString
Field value as string.

LONG cMaxLen
Maximum length of the string.

Return value
TRUE
Successful reading of field value
FALSE
Error

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1497
C scripting
2.1 System functions

2.1.45.14 uaArchiveGetFilter

Description
Reads the filter of the current data record. Additional information can be found in the appendix
under "SQL Statements".
Can only be used in C scripting.

Syntax
VOID uaArchiveGetFilter (
UAHARCHIVE hArchive,
LPSTR pszFilter,
LONG cMaxLen )
The system function can be used in C scripting only.

Parameters

UAHARCHIVE hArchive
Handle of the recipe. This handle is generated using uaQueryArchive or
uaQueryArchiveByName.

LPSTR pszFilter
Read filter.

LONG cMaxLen
Maximum length

2.1.45.15 uaArchiveGetID

Description
uaArchiveGetID reads the ID of the recipe.
The recipe ID serves internal purposes and may differ from the number given in the recipe.
Can only be used in C scripting.

Syntax
LONG uaArchiveGetID (
UAHARCHIVE hArchive )

WinCC Engineering V18 – Programming reference

1498 System Manual, 11/2022, Online documentation
 C scripting
2.1 System functions

Parameters

UAHARCHIVE hArchive
Handle of the recipe. This handle is generated using uaQueryArchive or
uaQueryArchiveByName.

Return value
ID of the recipe.

2.1.45.16 uaArchiveGetName

Description
Reads the name of the recipe.
Can only be used in C scripting.

Syntax
VOID uaArchiveGetName (
UAHARCHIVE hArchive,
LPSTR pszName,
LONG cMaxLen )

Parameters

UAHARCHIVE hArchive
Handle of the recipe. This handle is generated using uaQueryArchive or
uaQueryArchiveByName.

LPSTR pszName
Pointer to buffer for recipe name.

LONG cMaxLen
Maximum length

Example
char Filling [40];
uaArchiveGetName( hArchive, bottling, 39 );

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1499
C scripting
2.1 System functions

2.1.45.17 uaArchiveGetSor

Description
uaArchiveGetSort reads the sorting of the recipe.
Can only be used in C scripting.

Syntax
VOID uaArchiveGetSort (
UAHARCHIVE hArchive,
LPSTR pszSort,
LONG cMaxLen )

Parameters

UAHARCHIVE hArchive
Handle of the recipe. This handle is generated using uaQueryArchive or
uaQueryArchiveByName.

LPCSTR pszSort
Sorting

LONG cMaxLen
Maximum length

2.1.45.18 uaArchiveImport

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 (
UAHARCHIVE hArchive,
LPCSTR pszSource,
LONG lType,
LONG lOptions )

WinCC Engineering V18 – Programming reference

1500 System Manual, 11/2022, Online documentation
 C scripting
2.1 System functions

Parameters

UAHARCHIVE hArchive
Handle of the recipe. This handle is generated using uaQueryArchive or
uaQueryArchiveByName.

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.45.19 uaArchiveInsert

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 (
UAHARCHIVE hArchive )

Parameters

UAHARCHIVE hArchive
Handle of the recipe. This handle is generated using uaQueryArchive or
uaQueryArchiveByName.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1501
C scripting
2.1 System functions

Return value
TRUE
Successful insertion of the data record.

2.1.45.20 uaArchiveMoveFirst

Description
Goes to the first data record.
Can only be used in C scripting.

Syntax
BOOL uaArchiveMoveFirst (
UAHARCHIVE hArchive )

Parameters

UAHARCHIVE hArchive
Handle of the recipe. This handle is generated using uaQueryArchive or
uaQueryArchiveByName.

Return value
TRUE
Successful jumping in the recipe
FALSE
Error

2.1.45.21 uaArchiveMoveLast

Description
Goes to the last data record.
Can only be used in C scripting.

Syntax
BOOL uaArchiveMoveLast (
UAHARCHIVE hArchive )

WinCC Engineering V18 – Programming reference

1502 System Manual, 11/2022, Online documentation
 C scripting
2.1 System functions

Parameters

UAHARCHIVE hArchive
Handle of the recipe. This handle is generated using uaQueryArchive or
uaQueryArchiveByName .

Return value
TRUE
Successful jumping in the recipe
FALSE
Error

2.1.45.22 uaArchiveMoveNext

Description
Goes to the next data record.
Can only be used in C scripting.

Syntax
BOOL uaArchiveMoveNext (
UAHARCHIVE hArchive )

Parameters

UAHARCHIVE hArchive
Handle of the recipe. This handle is generated using uaQueryArchive or
uaQueryArchiveByName.

Return value
TRUE
Successful jumping in the recipe
FALSE
Error

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1503
C scripting
2.1 System functions

2.1.45.23 uaArchiveMovePrevious

Description
Goes to the previous data record.
Can only be used in C scripting.

Syntax
BOOL uaArchiveMovePrevious (
UAHARCHIVE hArchive )

Parameters

UAHARCHIVE hArchive
Handle of the recipe. This handle is generated using uaQueryArchive or
uaQueryArchiveByName.

Return value
TRUE
Successful jumping in the recipe
FALSE
Error

2.1.45.24 uaArchiveOpen

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".

Can only be used in C scripting.

WinCC Engineering V18 – Programming reference

1504 System Manual, 11/2022, Online documentation
 C scripting
2.1 System functions

Syntax
BOOL uaArchiveOpen (
UAHARCHIVE hArchive )

Parameters

UAHARCHIVE hArchive
Handle of the recipe. This handle is generated using uaQueryArchive or
uaQueryArchiveByName.

Return value
TRUE
Successful opening of the recipe
FALSE
Error

2.1.45.25 uaArchiveReadTagValues

Description
Reads the current value from the field tag.
Can only be used in C scripting.

Syntax
BOOL uaArchiveReadTagValues (
UAHARCHIVE hArchive,
LONG* pnFields,
LONG cFields,
LONG lOptions )

Parameters

UAHARCHIVE hArchive
Handle of the recipe. This handle is generated using uaQueryArchive or
uaQueryArchiveByName.

LONG* pnFields
Reserved for future applications (NULL)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1505
C scripting
2.1 System functions

LONG cFields
Number of field indices transferred (size of array pnFields).
Reserved for future applications (0)

LONG lOptions
Reserved for future applications (0)
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.45.26 uaArchiveReadTagValuesByName

Description
Reads the tag values in the current data.
Can only be used in C scripting.

Syntax
BOOL uaArchiveReadTagValuesByName (
UAHARCHIVE hArchive,
LPCSTR pszFields,
LONG lOptions )

Parameters

UAHARCHIVE hArchive
Handle of the recipe. This handle is generated using uaQueryArchive or
uaQueryArchiveByName.

LPCSTR pszFields
Reserved for future applications (NULL)

LONG lOptions
Reserved for future applications (0)

WinCC Engineering V18 – Programming reference

1506 System Manual, 11/2022, Online documentation
 C scripting
2.1 System functions

Return value
TRUE
Successful reading in the recipe
FALSE
Error

2.1.45.27 uaArchiveRequery

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(
UAHARCHIVE hArchive )
Can only be used in C scripting.

Parameters

UAHARCHIVE hArchive
Handle of the recipe. This handle is generated using uaQueryArchive or
uaQueryArchiveByName.

Return value
TRUE
Successful requery
FALSE
Error

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1507
C scripting
2.1 System functions

2.1.45.28 uaArchiveSetFieldValueDate

Description
Writes the date and time into a field of the current data record.
Can only be used in C scripting.

Syntax
BOOL uaArchiveSetFieldValueDate (
UAHARCHIVE hArchive,
LONG lField,
LPSYSTEMTIME pstDateTime )

Parameters

UAHARCHIVE hArchive
Handle of the recipe. This handle is generated using uaQueryArchive or
uaQueryArchiveByName.

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.45.29 uaArchiveSetFieldValueDouble

Description
Writes a Double value into a field of the current data record.
Can only be used in C scripting.

WinCC Engineering V18 – Programming reference

1508 System Manual, 11/2022, Online documentation
 C scripting
2.1 System functions

Syntax
BOOL uaArchiveSetFieldValueDouble (
UAHARCHIVE hArchive,
LONG lField,
double dValue )

Parameters

UAHARCHIVE hArchive
Handle of the recipe. This handle is generated using uaQueryArchive or
uaQueryArchiveByName.

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.45.30 uaArchiveSetFieldValueFloat

Description:
Writes a Float value into a field of the current data record.
Can only be used in C scripting.

Syntax
BOOL uaArchiveSetFieldValueFloat (
UAHARCHIVE hArchive,
LONG lField,
float fValue )

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1509
C scripting
2.1 System functions

Parameters:

UAHARCHIVE hArchive
Handle of the recipe. This handle is generated using uaQueryArchive or
uaQueryArchiveByName.

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
Successful writing of field value
FALSE
Error

2.1.45.31 uaArchiveSetFieldValueLong

Description
Writes a Long Integer value into a field of the current data record.
Can only be used in C scripting.

Syntax
BOOL uaArchiveSetFieldValueLong (
UAHARCHIVE hArchive,
LONG lField,
LONG dValue )

Parameters

UAHARCHIVE hArchive
Handle of the recipe. This handle is generated using uaQueryArchive or
uaQueryArchiveByName.

LONG lField
The field number, where lField = 1 is addressing the first configured field. The ID field is
addressed with lField = 0.

WinCC Engineering V18 – Programming reference

1510 System Manual, 11/2022, Online documentation
 C scripting
2.1 System functions

LONG dValue
Field value

Return value
TRUE
Successful writing of field value
FALSE
Error

2.1.45.32 uaArchiveSetFieldValueString

Description
Writes a String into a field of the current data record.
Can only be used in C scripting.

Syntax
BOOL uaArchiveSetFieldValueString (
UAHARCHIVE hArchive,
LONG lField,
LPCSTR pszString )

Parameters

UAHARCHIVE hArchive
Handle of the recipe. This handle is generated using uaQueryArchive or
uaQueryArchiveByName.

LONG lField
The field number, where lField = 1 is addressing the first configured field. The ID field is
addressed with lField = 0 .

LPCSTR pszString
Field value

Return value
TRUE
Successful writing of field value
FALSE

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1511
C scripting
2.1 System functions

Error

2.1.45.33 uaArchiveSetFilter

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".

Can only be used in C scripting.

Syntax
VOID uaArchiveSetFilter (
UAHARCHIVE hArchive,
LPSTR pszFilter )

Parameters

UAHARCHIVE hArchive
Handle of the recipe. This handle is generated using uaQueryArchive or
uaQueryArchiveByName.

LPSTR pszFilter
Filter to be set.

2.1.45.34 uaArchiveSetSort

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".

Can only be used in C scripting.

WinCC Engineering V18 – Programming reference

1512 System Manual, 11/2022, Online documentation
 C scripting
2.1 System functions

Syntax
BOOL uaArchiveSetSort (
UAHARCHIVE hArchive,
LPSTR pszSort )
The system function can be used in C scripting only.

Parameters

UAHARCHIVE hArchive
Handle of the recipe. This handle is generated using uaQueryArchive or
uaQueryArchiveByName.

LPCSTR pszSort
Sorting

Return value
TRUE
Successful setting of the sorting
FALSE
Error

2.1.45.35 uaArchiveUpdate

Description
Updates the open recipe. All data changes of a recipe are transferred to the database. The
configuration of the recipe remains unchanged.
Can only be used in C scripting.

Syntax
BOOL uaArchiveUpdate (
UAHARCHIVE hArchive )

Parameters

UAHARCHIVE hArchive
Handle of the recipe. This handle is generated using uaQueryArchive or
uaQueryArchiveByName.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1513
C scripting
2.1 System functions

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.45.36 uaArchiveWriteTagValues

Description
Writes the values of the current data record into the tags.
Can only be used in C scripting.

Syntax
BOOL uaArchiveWriteTagValues (
UAHARCHIVE hArchive,
LONG* pnFields,
LONG cFields,
LONG lOptions )

Parameters

UAHARCHIVE hArchive
Handle of the recipe. This handle is generated using uaQueryArchive or
uaQueryArchiveByName.

LONG* pnFields
Reserved for future applications (NULL)

LONG cFields
Reserved for future applications (0)

LONG lOptions
Reserved for future applications (0)

Return value
TRUE
Successful reading in the recipe

WinCC Engineering V18 – Programming reference

1514 System Manual, 11/2022, Online documentation
 C scripting
2.1 System functions

FALSE
Error

2.1.45.37 uaArchiveWriteTagValuesByName

Description
Writes the values of the current data record into the tags. The access is based on the names of
the recipe and field.
Can only be used in C scripting.

Syntax
BOOL uaArchiveWriteTagValuesByName (
UAHARCHIVE hArchive,
LPCSTR pszFields,
LONG lOptions )

Parameters

UAHARCHIVE hArchive
Handle of the recipe. This handle is generated using uaQueryArchive or
uaQueryArchiveByName.

LPCSTR pszFields
Reserved for future applications (NULL)

LONG lOptions
Reserved for future applications (0)

Return value
TRUE
Successful reading in the recipe
FALSE
Error

2.1.45.38 uaConnect

Description
Establishes connection to recipes (Runtime).

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1515
C scripting
2.1 System functions

Can only be used in C scripting.

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.45.39 uaDisconnect

Description
If a connection to recipes (Runtime) exists, it will be disconnected.
Can only be used in C scripting.

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

WinCC Engineering V18 – Programming reference

1516 System Manual, 11/2022, Online documentation
 C scripting
2.1 System functions

Error

2.1.45.40 uaGetArchive

Description
Reads the recipe configuration.
Can only be used in C scripting.

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.45.41 uaGetField

Description:
Reads the field configuration.
Can only be used in C scripting.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1517
C scripting
2.1 System functions

Syntax
BOOL uaGetField (
UAHCONFIG hConfig,
long lArchive,
long lField,
UACONFIGFIELD* pField )

Parameters:

UAHCONFIG hConfig,
Configuration handle of the recipe. This handle is generated using uaQueryConfiguration.

long lArchive,
Archive index (0 to (uaGetNumArchives()-1))

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.45.42 uaGetLastError

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.
Can only be used in C scripting.
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:

WinCC Engineering V18 – Programming reference

1518 System Manual, 11/2022, Online documentation
 C scripting
2.1 System functions

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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1519
C scripting
2.1 System functions

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.45.43 uaGetLastHResult

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.
Can only be used in C scripting.

Syntax
LONG uaGetLastHResult()

Return value
Last occurred COM error

WinCC Engineering V18 – Programming reference

1520 System Manual, 11/2022, Online documentation
 C scripting
2.1 System functions

2.1.45.44 uaGetNumArchives

Description
Reads the number of recipes currently configured.
Can only be used in C scripting.

Syntax
LONG uaGetNumArchives (
UAHCONFIG hConfig )

Parameters

UAHCONFIG hConfig
Configuration handle of the recipe. This handle is generated using uaQueryConfiguration.

Return value
Number of recipes currently configured. In case of an error, -1 will be returned.

2.1.45.45 uaGetNumFields

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.
Can only be used in C scripting.

Syntax
LONG uaGetNumFields (
UAHCONFIG hConfig,
long lArchive )

Parameters

UAHCONFIG hConfig,
Configuration handle of the recipe. This handle is generated using uaQueryConfiguration.

long lArchive,
Archive index (0 to (uaGetNumArchives()-1))

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1521
C scripting
2.1 System functions

Return value
Number of configured fields. In case of an error, -1 will be returned.

2.1.45.46 uaQueryArchive

Description
Establishes a connection to the recipe for Runtime operation. UaQueryArchive creates the
handle UAHARCHIVE.
Can only be used in C scripting.

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().

WinCC Engineering V18 – Programming reference

1522 System Manual, 11/2022, Online documentation
 C scripting
2.1 System functions

2.1.45.47 uaQueryArchiveByName

Description
Establishes a connection to the recipe for Runtime operation using the recipe name.
UaQueryArchiveByName creates the UAHARCHIVE handle for the recipe.
Can only be used in C scripting.

Syntax
BOOL uaQueryArchiveByName (
UAHCONNECT hConnect,
LPCSTR pszName,
UAHARCHIVE* phArchive )

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().

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1523
C scripting
2.1 System functions

2.1.45.48 UaQueryConfiguration

Description
Establishes a connection to the recipe for the configuration.
Can only be used in C scripting.

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.45.49 uaReleaseArchive

Description
Releases the connection to the current recipe.
Can only be used in C scripting.

Syntax
BOOL uaReleaseArchive (
UAHARCHIVE hArchive )

Parameters

UAHARCHIVE hArchive
Handle of the recipe. This handle is generated using uaQueryArchive or
uaQueryArchiveByName.

WinCC Engineering V18 – Programming reference

1524 System Manual, 11/2022, Online documentation
 C scripting
2.1 System functions

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.45.50 uaReleaseConfiguration

Description
Releases connection to recipes (configuration).
Can only be used in C scripting.

Syntax
BOOL uaReleaseConfiguration (
UAHCONFIG hConfig,
BOOL bSave )

Parameters

UAHCONFIG hConfig
Configuration handle of the recipe. This handle is generated using uaQueryConfiguration.

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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1525
C scripting
2.2 C-bib

Error

2.2 C-bib

2.2.1 ctype functions

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

Introduction
The c_bib function group contains C functions from the C library and is divided into:
• ctype
• math
• memory
• stdio

WinCC Engineering V18 – Programming reference

1526 System Manual, 11/2022, Online documentation
 C scripting
2.2 C-bib

• 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

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);

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1527
C scripting
2.2 C-bib

• 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.
The functions can be used in C scripts only.

2.2.4 memory functions

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.
The functions can be used in C scripts only.

WinCC Engineering V18 – Programming reference

1528 System Manual, 11/2022, Online documentation
 C scripting
2.2 C-bib

2.2.5 multibyte functions

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.
The functions can be used in C scripts only.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1529
C scripting
2.2 C-bib

2.2.6 stdio functions

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);

WinCC Engineering V18 – Programming reference

1530 System Manual, 11/2022, Online documentation
 C scripting
2.2 C-bib

For a description of the studio functions see the specialist literature on programming
language C.
The functions can be used in C scripts only.

2.2.7 stdlib functions

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.
The functions can be used in C scripts only.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1531
C scripting
2.2 C-bib

2.2.8 string functions

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.
The functions can be used in C scripts only.

2.2.9 time functions

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);

WinCC Engineering V18 – Programming reference

1532 System Manual, 11/2022, Online documentation
 C scripting
2.3 Structure definition

• 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.
The functions can be used in C scripts only.

2.3 Structure definition

2.3.1 Structure definition CCAPErrorExecute

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 divi‐
1 sion 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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1533
C scripting
2.3 Structure definition

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 invalid
5
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

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;

WinCC Engineering V18 – Programming reference

1534 System Manual, 11/2022, Online documentation
 C scripting
2.3 Structure definition

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

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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1535
C scripting
2.3 Structure definition

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

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

WinCC Engineering V18 – Programming reference

1536 System Manual, 11/2022, Online documentation
 C scripting
2.3 Structure definition

2.3.5 Structure definition DM_VAR_UPDATE_STRUCT

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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1537
C scripting
2.3 Structure definition

2.3.6 Structure definition DM_VAR_UPDATE_STRUCTEX

typedef struct {
DM_TYPEREF dmTypeRef;
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.

WinCC Engineering V18 – Programming reference

1538 System Manual, 11/2022, Online documentation
 C scripting
2.3 Structure definition

2.3.7 Structure definition DM_VARKEY

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

typedef struct {
LINKTYPE LinkType;
DWORD dwCycle;
TCHAR szLinkName[256];
}
LINKINFO;

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1539
C scripting
2.3 Structure definition

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

WinCC Engineering V18 – Programming reference

1540 System Manual, 11/2022, Online documentation
 C scripting
2.3 Structure definition

See also
SetLink (Page 1443)
GetLink (Page 1380)

2.3.9 Structure definition MSG_FILTER_STRUCT

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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1541
C scripting
2.3 Structure definition

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

WinCC Engineering V18 – Programming reference

1542 System Manual, 11/2022, Online documentation
 C scripting
2.3 Structure definition

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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1543
C scripting
2.3 Structure definition

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

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.)

WinCC Engineering V18 – Programming reference

1544 System Manual, 11/2022, Online documentation
 C scripting
2.3 Structure definition

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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1545
C scripting
2.3 Structure definition

WinCC Engineering V18 – Programming reference

1546 System Manual, 11/2022, Online documentation
Runtime API 3
3.1 Runtime API

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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1547
Runtime API
3.2 Data management functions

3.2 Data management functions

3.2.1 Basics

3.2.1.1 Overview of structures

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

WinCC Engineering V18 – Programming reference

1548 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

MCP_VARIABLE_PROTOCOL (Page 1617) Tag limit handling

MCP_VARIABLE_SCALES (Page 1620) Tag scaling

See also
VariableStateType property (Page 1554)
Overview of the functions (Page 1549)

3.2.1.2 Overview of the functions

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 1560)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1549
Runtime API
3.2 Data management functions

3.2.1.3 Quality codes of HMI tags

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.

WinCC Engineering V18 – Programming reference

1550 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

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 be 0 1 - - - - - -
useful.
Good (Non-Cascade) - The quality of the value is good. Possible alarm conditions 1 0 - - - - - -
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 S S S S L 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 not 0 0 0 1 1 1 - -
being evaluated, and may be under construction by a config‐
urer. 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 has 1 0 0 0 0 1 - -
(Non-Cas‐ an active Update event.
cade)
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 had 0 0 0 1 0 1 - -
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.
0x10 Bad Sensor failure 0 0 0 1 0 0 - -

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1551
Runtime API
3.2 Data management functions

Code Quality Q Q S S S S L L
(Hex)
0x08 Bad Not Connected - Set if this input is required to be connected and 0 0 0 0 1 0 - -
is not connected.
0x04 Bad Configuration Error - Set if the value is not useful because there 0 0 0 0 0 1 - -
is some inconsistency regarding the parameterization or con‐
figuration, depending on what a specific manufacturer can de‐
tect.
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 un‐ 0 1 0 0 0 0 - -
certain. Used for propagation.
0xE0 Good Initiate Fail Safe (IFS) - The value is from a block that wants its 1 1 1 0 0 0 - -
(Cascade) downstream output block (e.g. AO) to go to Fail Safe.
0xD8 Good Local Override (LO) - The value is from a block that has been 1 1 0 1 1 0 - -
(Cascade) locked out by a local key switch or is a Complex AO/DO with
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 - -
(Cascade) not be selected, due to conditions in or above the block.
0xCC Good Not Invited (NI) - The value is from a block which does not have 1 1 0 0 1 1 - -
(Cascade) a target mode that would use this input.
0xC8 Good Initialization Request (IR) - The value is an initialization value 1 1 0 0 1 0 - -
(Cascade) for a source (back calculation input parameter), because the
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 - -
(Cascade) ue from a source (cascade input, remote-cascade in, and re‐
mote-output in parameters).

WinCC Engineering V18 – Programming reference

1552 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

Code Quality Q Q S S S S L L
(Hex)
0xC0 Good OK - No error or special condition is associated with this value. 1 1 0 0 0 0 - -
(Cascade)
0xA0 Good Initiate fail safe 1 0 1 0 0 0 - -
(Non-Cas‐
cade)
0x98 Good Unacknowledged Critical Alarm - Set if the value is good and 1 0 0 1 1 0 - -
(Non-Cas‐ the block has an unacknowledged Alarm with a priority greater
cade) than or equal to 8.
0x94 Good Unacknowledged Advisory Alarm - Set if the value is good and 1 0 0 1 0 1 - -
(Non-Cas‐ the block has an unacknowledged Alarm with a priority less
cade) than 8.
0x90 Good Unacknowledged Update event - Set if the value is good and 1 0 0 1 0 0 - -
(Non-Cas‐ the block has an unacknowledged Update event.
cade)
0x8C Good Active Critical Alarm - Set if the value is good and the block has 1 0 0 0 1 1 - -
(Non-Cas‐ an active Alarm with a priority greater than or equal to 8.
cade)
0x88 Good Active Advisory Alarm - Set if the value is good and the block 1 0 0 0 1 0 - -
(Non-Cas‐ has an active Alarm with a priority less than 8.
cade)
0xA8 Good Maintenance demanded 1 0 1 0 1 0 - -
(Non-Cas‐
cade)
0xA4 Good Maintenance required 1 0 1 0 0 1 - -
(Non-Cas‐
cade)
0xBC Good Function check - Local override 1 0 1 1 1 1 - -
(Non-Cas‐
cade)
0x80 Good OK - No error or special condition is associated with this value. 1 0 0 0 0 0 - -
(Non-Cas‐
cade)

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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1553
Runtime API
3.2 Data management functions

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
VariableStateType property (Page 1554)
SetTag (Page 1456)
GetTag (Page 1397)

3.2.1.4 VariableStateType property

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

WinCC Engineering V18 – Programming reference

1554 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

See also
Quality codes of HMI tags (Page 1550)
Overview of structures (Page 1548)
Constants (Page 1555)
Conversion routines (Control Center) (Page 1560)
SetTag (Page 1456)
GetTag (Page 1397)

3.2.1.5 Constants

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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1555
Runtime API
3.2 Data management functions

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_ERROR 0x00000400 Substitute value on connection error
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 de‐
leted externally

WinCC Engineering V18 – Programming reference

1556 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1557
Runtime API
3.2 Data management functions

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%
DM_NOTIFY_QUEUE_60_PERCENT 0x00000002 Class Warning : Fill level of application
queue 60%
DM_NOTIFY_QUEUE_70_PERCENT 0x00000003 Class Warning : Fill level of application
queue 70%
DM_NOTIFY_QUEUE_80_PERCENT 0x00000004 Class Warning : Fill level of application
queue 80%
DM_NOTIFY_QUEUE_90_PERCENT 0x00000005 Class Warning : Fill level of application
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

WinCC Engineering V18 – Programming reference

1558 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

Registered messages
DM_OHIOLANGUAGE "WM_OHIOLANGUAGE"

Internal system tag

DM_VAR_CURRENT_LANGUAGE "OHIOCurrentLanguage"

See also
VariableStateType property (Page 1554)

3.2.1.6 Error messages

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 dialog
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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1559
Runtime API
3.2 Data management functions

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 2511)

3.2.1.7 Conversion routines (Control Center)

Overview

No. Conversion routines for the "Signed 8-bit value" data type
0 CharToSignedByte
1 CharToUnsignedByte
2 CharToUnsignedWord
3 CharToUnsignedDword
4 CharToSignedWord

WinCC Engineering V18 – Programming reference

1560 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1561
Runtime API
3.2 Data management functions

14 ByteToExcessDword
> 14 (ByteToUnsignedByte)

No. Conversion routines for the "Signed 16-bit val‐

ue" 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

value" data type
0 WordToUnsignedWord
1 WordToUnsignedByte
2 WordToUnsignedDword
3 WordToSignedByte

WinCC Engineering V18 – Programming reference

1562 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

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 val‐

ue" 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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1563
Runtime API
3.2 Data management functions

26 LongToExcessDword
27 LongToSignedExcessByte
28 LongToSignedExcessWord
29 LongToSignedExcessDword
30 LongToSimaticBCDTimer
31 (LongToSignedDword)
32 (LongToSignedDword)
33 (LongToSignedDword)
34 LongToSimaticTimer
> 34 (LongToSignedDword)

No. Conversion routines for the "Unsigned 32-bit

value" 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)
17 (DwordToUnsignedDword)
18 (DwordToUnsignedDword)
19 DwordToSimaticTimer
> 19 (DwordToUnsignedDword)

No. Conversion routines for the "Floating-point

number 32-bit IEEE 754" data type
0 FloatToFloat
1 FloatToUnsignedByte
2 FloatToUnsignedWord
3 FloatToUnsignedDword
4 FloatToSignedByte

WinCC Engineering V18 – Programming reference

1564 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

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

number 64-bit IEEE 754" data type
0 DoubleToDouble
1 DoubleToUnsignedByte
2 DoubleToUnsignedWord
3 DoubleToUnsignedDword
4 DoubleToSignedByte
5 DoubleToSignedWord

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1565
Runtime API
3.2 Data management functions

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
VariableStateType property (Page 1554)
Overview of the functions (Page 1549)

WinCC Engineering V18 – Programming reference

1566 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

3.2.2 Structures

3.2.2.1 DM_CONNECTION_DATA

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)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1567
Runtime API
3.2 Data management functions

See also
DM_ENUM_CONNECTION_PROC (Page 1794)

3.2.2.2 DM_CONNKEY

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)

WinCC Engineering V18 – Programming reference

1568 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

3.2.2.3 DM_CYCLE_INFO

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

DM_ENUM_CYCLES_PROC (Page 1642) List update cycles (callback)

See also
DM_ENUM_CYCLES_PROC (Page 1642)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1569
Runtime API
3.2 Data management functions

3.2.2.4 DM_DATA_SERVICE

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)

WinCC Engineering V18 – Programming reference

1570 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

See also
DM_DATA_SERVICE_PROC (Page 1670)

3.2.2.5 DM_DIRECTORY_INFO

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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1571
Runtime API
3.2 Data management functions

See also
DMGetProjectDirectory (Page 1659)

3.2.2.6 DM_DLGOPTIONS

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
The parameter is reserved for future development and must be preset to NULL.

lpvUser
Pointer to application-specific data.

Required files
dmclient.h

WinCC Engineering V18 – Programming reference

1572 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

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

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
"Conversion routines" section.

Required files
dmclient.h

API functions

DM_ENUM_FORMATS_PROC (Page 1639) List format conversions (callback)

See also
DM_ENUM_FORMATS_PROC (Page 1639)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1573
Runtime API
3.2 Data management functions

3.2.2.8 DM_MACHINE_TABLE

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)

WinCC Engineering V18 – Programming reference

1574 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

3.2.2.9 DM_PROJECT_INFO

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)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1575
Runtime API
3.2 Data management functions

3.2.2.10 DM_SEND_DATA_STRUCT

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.
(The parameter is reserved for future development)
DM_SD_ALL_CLIENTS To all clients in the project.
(The parameter is reserved for future development)
DM_SD_RELATED_MACHINES To all clients that belong to the same server as the local host
(The parameter is reserved for future development)

WinCC Engineering V18 – Programming reference

1576 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

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.
(The parameter is reserved for future development)

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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1577
Runtime API
3.2 Data management functions

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

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

WinCC Engineering V18 – Programming reference

1578 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

See also
DM_MACHINE_TABLE (Page 1574)
DM_SEND_DATA_STRUCT (Page 1576)

3.2.2.12 DM_SD_TARGET_APP

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
DM_SEND_DATA_STRUCT (Page 1576)

3.2.2.13 DM_TYPEREF

Declaration

typedef struct {
DWORD dwType;
DWORD dwSize;
char szTypeName[MAX_DM_TYPE_NAME + 1];
}
DM_TYPEREF;

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1579
Runtime API
3.2 Data management functions

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_TEXT_16 Text tag, 16-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 iden‐
tify 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

WinCC Engineering V18 – Programming reference

1580 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

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

Declaration

typedef struct {
DM_TYPEREF dmTypeRef;
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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1581
Runtime API
3.2 Data management functions

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_VARSTATE_..._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

WinCC Engineering V18 – Programming reference

1582 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

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

Declaration

typedef struct {
DM_TYPEREF dmTypeRef;
DM_VARKEY dmVarKey;
VARIANT dmValue;
DWORD dwState;
DWORD dwQualityCode;
}
DM_VAR_UPDATE_STRUCTEX;

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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1583
Runtime API
3.2 Data management functions

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_NOT_ESTABLISHED 0x0001 Connection to partner not established

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 conjunction
with DM_VARSTATE_..._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

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 (0x0004) Network module faulty Bad, device failure, 0x0C

WinCC Engineering V18 – Programming reference

1584 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

DM_VARSTATE_NOT_ESTABLISHED (0x0001) Connection to partner not estab‐ Bad, not connected, 0x08
lished
DM_VARSTATE_TIMEOUT (0x2000) Timeout / no feedback from channel Uncertain, last usable value, 0x44
DM_VARSTATE_HANDSHAKE_ERROR Protocol error Bad, no communication (no usable val‐
(0x0002) ue), 0x18
DM_VARSTATE_ADDRESS_ERROR (0x0400) Addressing error in the channel Bad, configuration error, value not ac‐
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 set, 0x56
DM_VARSTATE_MIN_RANGE (0x0040) Low format limit violated Uncertain, engineering unit range viola‐
tion, low limit set, 0x55
DM_VARSTATE_CONVERSION_ERROR Display conversion error Uncertain, engineering unit range viola‐
(0x0080) tion, no limits set, 0x54
DM_VARSTATE_MAX_LIMIT (0x0008) Configured high limit violated Mapping to the Limit-Bit HIGH, 0x01,
logical OR linking with the other tag sta‐
tus, for example good (cascade), ok, re‐
sults in 0xC2
DM_VARSTATE_MIN_LIMIT (0x0010) Configured low limit violated Mapping to the Limit-Bit LOW, 0x02, log‐
ical OR linking with the other tag status,
for example good (cascade), ok, results
in 0xC1
DM_VARSTATE_STARTUP_VALUE (0x0100) Initialization value of tag Uncertain, initial value, 0x4C
DM_VARSTATE_DEFAULT_VALUE (0x0200) Substitute value of tag Uncertain, substitute-set, 0x48

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)
DM_TYPEREF (Page 1579)
DM_VARKEY (Page 1594)
DMGetValueEx (Page 1693)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1585
Runtime API
3.2 Data management functions

3.2.2.16 DM_VARFILTER

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 criterion.
DM_VARFILTER_GROUP 0x00000002 The group name (lpszGroup) is used as the selection cri‐
terion.
DM_VARFILTER_NAME 0x00000004 The tag name (lpszName) is used as the selection crite‐
rion.
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 call‐
back. 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 other
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.

DM_VARTYPE_BIT Binary tag

DM_VARTYPE_SBYTE Signed 8-bit value

WinCC Engineering V18 – Programming reference

1586 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

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_TEXT_16 Text tag, 16-bit character set

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

DMShowVarDatabase (Page 1758) Open tag selection dialog
DMShowVarDatabaseMulti (Page 1763) Open tag selection dialog

See also
DMEnumVariables (Page 1688)
DMShowVarDatabase (Page 1758)
DMShowVarDatabaseMulti (Page 1763)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1587
Runtime API
3.2 Data management functions

3.2.2.17 DM_VARGRP_DATA

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
Pointer to application-specific data.

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)

WinCC Engineering V18 – Programming reference

1588 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

3.2.2.18 DM_VARGRPKEY

Declaration

typedef struct {
CHAR szName[ MAX_DM_VAR_NAME + 1 ];
LPVOID lpvUserData;
}
DM_VARGRPKEY;

Members

szName
Name of the tag group

lpvUserData
Pointer to application-specific data.

Required files
dmclient.h

API functions

DMEnumVarGrpData (Page 1683) List information about a tag group

See also
DMEnumVarGrpData (Page 1683)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1589
Runtime API
3.2 Data management functions

3.2.2.19 DM_VARIABLE_DATA

Declaration

typedef struct {
DM_TYPEREF dmTypeRef;
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[
MAX_DM_CONNECTION_NAME +1];
CHAR szChannel[_MAX_PATH +1];
CHAR szUnit[MAX_DM_UNIT_NAME +1];
}
DM_VARIABLE_DATA;

Members

dmTypeRef
The DM_TYPEREF (Page 1579) structure contains information on the tag type.

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

WinCC Engineering V18 – Programming reference

1590 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

dwFlags
indicates how the substitute value should be used:

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 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
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)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1591
Runtime API
3.2 Data management functions

See also
DM_TYPEREF (Page 1579)
DM_ENUM_VARIABLE_PROC (Page 1678)
DM_VARLIMIT (Page 1597)
DMEnumVarData (Page 1676)

3.2.2.20 DM_VARIABLE_DATA4

Declaration

typedef struct {
DM_TYPEREF dmTypeRef;
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[
MAX_DM_CONNECTION_NAME +1];
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
The DM_TYPEREF (Page 1579) structure contains information on the tag type.

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.

WinCC Engineering V18 – Programming reference

1592 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

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_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 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
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 is displayed in the Parameter column of the properties of a tag in
WinCC.

szGroup
Name of the group to which the tag belongs.

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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1593
Runtime API
3.2 Data management functions

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
"Conversion routines" section.

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)
DM_TYPEREF (Page 1579)
DM_VARLIMIT (Page 1597)
MCP_VARIABLE_SCALES (Page 1620)

3.2.2.21 DM_VARKEY

Declaration

typedef struct {
DWORD dwKeyType;
DWORD dwID;
char szName[ MAX_DM_VAR_NAME + 1 ];
LPVOID lpvUserData;
}
DM_VARKEY;

WinCC Engineering V18 – Programming reference

1594 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

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
Pointer to application-specific data.

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 (Page 1783) List tags in a structured tag (callback)

DM_ENUM_TYPEMEMBERS_PROC (Page 1779) List tags in a structured tag (callback)
DM_ENUM_VAR_PROC (Page 1690) List tag names (callback)
DM_ENUM_VARIABLE_PROC (Page 1678) List information about a tag (callback)
DM_NOTIFY_SELECT_VAR_PROC (Page 1770) Open tag selection dialog (callback)
DMEnumVarData (Page 1676) List information about a tag
DMGetValue (Page 1691) Get tag values
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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1595
Runtime API
3.2 Data management functions

DMSetValueWait (Page 1744) Change tag values with notification

DMSetValueWaitMessage (Page 1749) Change tag values with notification and alarm out‐
put
DMShowVarDatabase (Page 1758) Open tag selection dialog
DMStartVarUpdate (Page 1806) Define update tags

See also
DMStartVarUpdate (Page 1806)
DM_VAR_UPDATE_STRUCT (Page 1581)
DMGetValue (Page 1691)
DMGetValueWait (Page 1704)
DMGetVarInfo (Page 1710)
DMGetVarLimits (Page 1721)
DMGetVarType (Page 1728)
DMSetValue (Page 1734)
DMSetValueMessage (Page 1740)
DMSetValueWait (Page 1744)
DMSetValueWaitMessage (Page 1749)
DMShowVarDatabase (Page 1758)
DMEnumVarData (Page 1676)
DM_ENUM_VAR_PROC (Page 1690)
DM_ENUM_VARIABLE_PROC (Page 1678)
DM_ENUM_TYPEMEMBERS_PROC (Page 1779)
DM_ENUM_TYPEMEMBERS_PROC_EX (Page 1783)
DM_NOTIFY_SELECT_VAR_PROC (Page 1770)
DMStartVarUpdateEx (Page 1809)
DM_VAR_UPDATE_STRUCTEX (Page 1583)
DM_ENUM_VARIABLE_PROC4 (Page 1682)
DMGetValueEx (Page 1693)
DMGetValueWaitEx (Page 1706)
DM_ENUM_TYPEMEMBERS_PROC_EX4 (Page 1786)
MSG_CSDATA_STRUCT_PLUS (Page 2370)

WinCC Engineering V18 – Programming reference

1596 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

3.2.2.22 DM_VARLIMIT

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
DM_VARIABLE_DATA (Page 1590)
DMGetVarLimits (Page 1721)
DM_VARIABLE_DATA4 (Page 1592)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1597
Runtime API
3.2 Data management functions

3.2.2.23 MCP_NEWVARIABLE_DATA

Declaration

typedef struct {
DWORD dwFlags;
char szProjectFile[_MAX_PATH +1];
char szConnection[
MAX_DM_CONNECTION_NAME +3];
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
Name of the group to which the tag belongs.

WinCC Engineering V18 – Programming reference

1598 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

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
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 is displayed in the Parameter column of the properties of a tag in
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)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1599
Runtime API
3.2 Data management functions

3.2.2.24 MCP_NEWVARIABLE_DATA_4

Declaration

typedef struct {
DWORD dwFlags;
char szProjectFile[_MAX_PATH +1];
char szConnection[
MAX_DM_CONNECTION_NAME +3];
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_VARIABLE_SCALES Scaling;
}
MCP_NEWVARIABLE_DATA_4;

Members

dwFlags
dwFlags indicates how the tag should be processed:

MCP_NVAR_FLAG_CREATE 1 Create tag

MCP_NVAR_FLAG_MODIFY 2 Change tag (if not available, then
re-create) (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 runtime
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 specification is
rejected with the error, DM_E_NOT_CONNECTED.

szConnection
Name of the logical connection assigned to the tag.

szVarName
Name of the tag to be processed.

WinCC Engineering V18 – Programming reference

1600 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

szGroupName
Name of the group to which the tag belongs.
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
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 is displayed in the Parameter column of the properties of a tag in
WinCC.

Scaling
MCP_VARIABLE_SCALES (Page 1620) Structure with the description of tag 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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1601
Runtime API
3.2 Data management functions

See also
MCP_VARIABLE_COMMON (Page 1608)
MCP_VARIABLE_LIMITS (Page 1612)
MCP_VARIABLE_PROTOCOL (Page 1617)
GAPICreateNewVariable4 (Page 1772)
MCP_VARIABLE_SCALES (Page 1620)
MCP_NEWVARIABLE_DATA_EX4 (Page 1606)
GAPICreateNewVariableEx4 (Page 1775)

3.2.2.25 MCP_NEWVARIABLE_DATA_5

Declaration

typedef struct {
DWORD dwFlags;
char szProjectFile[_MAX_PATH +1];
char szConnection[
MAX_DM_CONNECTION_NAME +3];
char szVarName[MAX_DM_VAR_NAME +1];
char szGroupName[MAX_DM_GROUP_NAME +1];
MCP_VARIABLE_COMMON Common;
MCP_VARIABLE_PROTOCOL Protocol;
MCP_VARIABLE_LIMITS5 Limits;
char szSpecific[MAX_DM_VAR_SPECIFIC +1];
MCP_VARIABLE_SCALES Scaling;
}
MCP_NEWVARIABLE_DATA_5;

Members

dwFlags
dwFlags indicates how the tag should be processed:

MCP_NVAR_FLAG_CREATE 1 Create tag

MCP_NVAR_FLAG_MODIFY 2 Change tag (if not available, then
re-create) (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 runtime
with DMGetRuntimeProject.

WinCC Engineering V18 – Programming reference

1602 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

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 specification is
rejected with the error, DM_E_NOT_CONNECTED.

szConnection
Name of the logical connection assigned to the tag.

szVarName
Name of the tag to be processed.

szGroupName
Name of the group to which the tag belongs.
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_LIMITS5 (Page 1614) Structure with the limits of the tag.

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 is displayed in the Parameter column of the properties of a tag in
WinCC.

Scaling
MCP_VARIABLE_SCALES (Page 1620) Structure with the description of tag scaling.

Comments
The MCP_NEWVARIABLE_DATA_EX4 (Page 1606) structure has a similar use for extended
functionality.

Required files
dmclient.h

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1603
Runtime API
3.2 Data management functions

API functions

GAPICreateNewVariable5 (Page 1774) Create tag with Creator ID

See also
GAPICreateNewVariable5 (Page 1774)
MCP_VARIABLE_COMMON (Page 1608)
MCP_VARIABLE_LIMITS5 (Page 1614)
MCP_VARIABLE_PROTOCOL (Page 1617)
MCP_NEWVARIABLE_DATA_EX4 (Page 1606)
MCP_VARIABLE_SCALES (Page 1620)

3.2.2.26 MCP_NEWVARIABLE_DATA_EX

Declaration

typedef struct {
DWORD dwFlags;
char szProjectFile[_MAX_PATH +1];
char szConnection[
MAX_DM_CONNECTION_NAME +3];
char szVarName[MAX_DM_VAR_NAME +1];
char szGroupName[MAX_DM_GROUP_NAME +1];
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
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 runtime)
MCP_NVAR_FLAG_TEST 3 Checks for existence of a tag.

The flags must not be ORed.

szProjectFile
Name of the project file, including path and extension.

WinCC Engineering V18 – Programming reference

1604 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

The name of the project file can be determined with DMEnumOpenedProjects or in runtime
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 specification is
rejected with the error, DM_E_NOT_CONNECTED.

szConnection
Name of the logical connection assigned to the tag.

szVarName
Name of the tag to be processed.

szGroupName
Name of the group to which the tag belongs.
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_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
violations are handled by the tag.

Limits
MCP_VARIABLE_LIMITS_EX (Page 1616) Structure with the limits of the tag.

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 is displayed in the Parameter column of the properties of a tag in
WinCC.

Comments
The MCP_NEWVARIABLE_DATA (Page 1598) structure has a similar use.

Required files
dmclient.h

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1605
Runtime API
3.2 Data management functions

API functions

DM_ENUM_TYPEMEMBERS_PROC_EX (Page 1783) List tags in a structured tag (callback)

See also
MCP_NEWVARIABLE_DATA (Page 1598)
DM_ENUM_TYPEMEMBERS_PROC_EX (Page 1783)
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

Declaration

typedef struct {
DWORD dwFlags;
char szProjectFile[_MAX_PATH +1];
char szConnection[
MAX_DM_CONNECTION_NAME +3];
char szVarName[MAX_DM_VAR_NAME +1];
char szGroupName[MAX_DM_GROUP_NAME +1];
MCP_VARIABLE_COMMON_EX Common;
MCP_VARIABLE_PROTOCOL_EX Protocol;
MCP_VARIABLE_LIMITS_EX Limits;
char szSpecific[MAX_DM_VAR_SPECIFIC +1]
MCP_VARIABLE_SCALES Scaling;
}
MCP_NEWVARIABLE_DATA_EX4;

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 Checks for existence of a tag.

The flags must not be ORed.

szProjectFile
Name of the project file, including path and extension.

WinCC Engineering V18 – Programming reference

1606 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

The name of the project file can be determined with DMEnumOpenedProjects or in runtime
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 specification is
rejected with the error, DM_E_NOT_CONNECTED.

szConnection
Name of the logical connection assigned to the tag.

szVarName
Name of the tag to be processed.

szGroupName
Name of the group to which the tag belongs.
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_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
violations are handled by the tag.

Limits
MCP_VARIABLE_LIMITS_EX (Page 1616) Structure with the limits of the tag.

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 is displayed in the Parameter column of the properties of a tag in
WinCC.

Scaling
MCP_VARIABLE_SCALES (Page 1620) Structure with the description of tag scaling.

Comments
The MCP_NEWVARIABLE_DATA_4 (Page 1600) structure has a similar use.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1607
Runtime API
3.2 Data management functions

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)
MCP_NEWVARIABLE_DATA_5 (Page 1602)
DM_ENUM_TYPEMEMBERS_PROC_EX4 (Page 1786)
MCP_VARIABLE_COMMON_EX (Page 1610)
MCP_VARIABLE_LIMITS_EX (Page 1616)
MCP_VARIABLE_PROTOCOL_EX (Page 1619)
MCP_VARIABLE_SCALES (Page 1620)

3.2.2.28 MCP_VARIABLE_COMMON

Declaration

typedef struct {
DWORD dwVarType;
DWORD dwVarLength;
DWORD dwVarProperty;
DWORD dwFormat;
}
MCP_VARIABLE_COMMON;

Members

dwVarType
The type of tag is specified in dwVarType:

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

WinCC Engineering V18 – Programming reference

1608 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

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_TEXT_16 Text tag, 16-bit character set
DM_VARTYPE_RAW Raw data type
DM_VARTYPE_STRUCT Structure tag
DM_VARTYPE_TEXTREF Text reference from text lib

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
Indicates whether this is an internal or external tag:

DM_INTERNAL_VAR Internal tag

DM_EXTERNAL_VAR External tag

dwFormat
Number of the conversion routine to be used. You can find more detailed information in the
"Conversion routines" section.

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
MCP_NEWVARIABLE_DATA (Page 1598)
MCP_NEWVARIABLE_DATA_4 (Page 1600)
MCP_VARIABLE_COMMON_EX (Page 1610)
MCP_NEWVARIABLE_DATA_5 (Page 1602)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1609
Runtime API
3.2 Data management functions

3.2.2.29 MCP_VARIABLE_COMMON_EX

Declaration

typedef struct {
DWORD dwVarType;
DWORD dwCreatorID
DWORD dwVarLength;
DWORD dwVarProperty;
DWORD dwFormat;
DWORD dwOSOffset;
DWORD dwASOffset;
char szStructTypeName
}
MCP_VARIABLE_COMMON_EX;

Members

dwVarType
The type of tag is specified in dwVarType:

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_TEXT_16 Text tag, 16-bit character set
DM_VARTYPE_RAW Raw data type
DM_VARTYPE_STRUCT Structure tag
DM_VARTYPE_TEXTREF Text reference from text lib

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.

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).

WinCC Engineering V18 – Programming reference

1610 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

dwVarProperty
Indicates whether this is an internal or external tag:

DM_INTERNAL_VAR Internal tag

DM_EXTERNAL_VAR External tag

dwFormat
Number of the conversion routine to be used. You can find more detailed information in the
"Conversion routines" section.

dwOSOffset
The parameter is reserved for future development and must be preset to 0.

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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1611
Runtime API
3.2 Data management functions

See also
MCP_NEWVARIABLE_DATA (Page 1598)
MCP_VARIABLE_COMMON (Page 1608)
MCP_NEWVARIABLE_DATA_EX (Page 1604)
MCP_NEWVARIABLE_DATA_EX4 (Page 1606)

3.2.2.30 MCP_VARIABLE_LIMITS

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.

WinCC Engineering V18 – Programming reference

1612 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

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 MCP_NEWVARIABLE_DATA_4 (Page 1600) structures.
The MCP_VARIABLE_LIMITS_EX (Page 1616) structure has a similar use for extended
functionality.

Required files
dmclient.h

See also
MCP_NEWVARIABLE_DATA (Page 1598)
MCP_NEWVARIABLE_DATA_4 (Page 1600)
MCP_VARIABLE_LIMITS_EX (Page 1616)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1613
Runtime API
3.2 Data management functions

3.2.2.31 MCP_VARIABLE_LIMITS5

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
Value of high limit of the tag

varBottomLimit
Value of low limit of the tag

varStartValue
Start value of the tag

varSubstituteValue
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.

WinCC Engineering V18 – Programming reference

1614 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

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
MCP_NEWVARIABLE_DATA_5 (Page 1602)
GAPICreateNewVariable5 (Page 1774)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1615
Runtime API
3.2 Data management functions

3.2.2.32 MCP_VARIABLE_LIMITS_EX

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
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

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.

WinCC Engineering V18 – Programming reference

1616 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

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
MCP_VARIABLE_LIMITS (Page 1612)
MCP_NEWVARIABLE_DATA_EX (Page 1604)
MCP_NEWVARIABLE_DATA_EX4 (Page 1606)

3.2.2.33 MCP_VARIABLE_PROTOCOL

Declaration

typedef struct {
BOOL bTopLimitErr;
BOOL bBottomLimitErr;
BOOL bTransformationErr;
BOOL bWriteErr;
BOOL bWriteErrApplication;
BOOL bWriteErrProzess;
}
MCP_VARIABLE_PROTOCOL;

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1617
Runtime API
3.2 Data management functions

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 MCP_NEWVARIABLE_DATA_4 (Page 1600) structures.
The MCP_VARIABLE_PROTOCOL_EX (Page 1619) structure has a similar use for extended
functionality.

Required files
dmclient.h

See also
MCP_NEWVARIABLE_DATA (Page 1598)
MCP_NEWVARIABLE_DATA_4 (Page 1600)
MCP_VARIABLE_PROTOCOL_EX (Page 1619)
MCP_NEWVARIABLE_DATA_5 (Page 1602)

WinCC Engineering V18 – Programming reference

1618 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

3.2.2.34 MCP_VARIABLE_PROTOCOL_EX

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
MCP_VARIABLE_PROTOCOL (Page 1617)
MCP_NEWVARIABLE_DATA_EX (Page 1604)
MCP_NEWVARIABLE_DATA_EX4 (Page 1606)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1619
Runtime API
3.2 Data management functions

3.2.2.35 MCP_VARIABLE_SCALES

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
MCP_NEWVARIABLE_DATA_4 (Page 1600)
MCP_NEWVARIABLE_DATA_5 (Page 1602)

WinCC Engineering V18 – Programming reference

1620 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

DM_VARIABLE_DATA4 (Page 1592)

MCP_NEWVARIABLE_DATA_EX4 (Page 1606)

3.2.3 General functions

3.2.3.1 DMActivateRTProject

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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1621
Runtime API
3.2 Data management functions

Required files
dmclient.h
dmclient.lib
dmclient.dll

See also
DMGetMachineTable (Page 1652)

3.2.3.2 DMAddNotify

Declaration

BOOL DMAddNotify (
DM_NOTIFY_PROC lpfnNotify,
LPVOID lpvUser,
LPDWORD lpdwNotifyCookie,
LPCMN_ERROR lpdmError);

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.

WinCC Engineering V18 – Programming reference

1622 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1623
Runtime API
3.2 Data management functions

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);
}

memset(&err, 0, sizeof(CMN_ERRORA));
lpvUser = (LPVOID)dwNotifyCookie; //set only for show in notify

WinCC Engineering V18 – Programming reference

1624 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

bRet = DMAddNotifyA(DM_NotifyProcA,
lpvUser,
&dwNotifyCookie,
&err);
if (bRet)
{
printf("\r\nNotify added, Cookie=%08lx!",
dwNotifyCookie);
SetTagDWord("DMdwNotifyCookie",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:

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1625
Runtime API
3.2 Data management functions

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:
switch (dwNotifyCode)
{
case DM_NOTIFY_QUEUE_50_PERCENT:
printf("\r\nDM_NOTIFY_CLASS_WARNING:
DM_NOTIFY_QUEUE_50_PERCENT");
break;
case DM_NOTIFY_QUEUE_60_PERCENT:
printf("\r\nDM_NOTIFY_CLASS_WARNING:
DM_NOTIFY_QUEUE_60_PERCENT");
break;
case DM_NOTIFY_QUEUE_70_PERCENT:
printf("\r\nDM_NOTIFY_CLASS_WARNING:
DM_NOTIFY_QUEUE_70_PERCENT");
break;
case DM_NOTIFY_QUEUE_80_PERCENT:
printf("\r\nDM_NOTIFY_CLASS_WARNING:
DM_NOTIFY_QUEUE_80_PERCENT");
break;
case DM_NOTIFY_QUEUE_90_PERCENT:
printf("\r\nDM_NOTIFY_CLASS_WARNING:
DM_NOTIFY_QUEUE_90_PERCENT");
break;
case DM_NOTIFY_QUEUE_OVERFLOW:
printf("\r\nDM_NOTIFY_CLASS_WARNING:
DM_NOTIFY_QUEUE_OVERFLOW");
break;
case DM_NOTIFY_CYCLES_CHANGED:
printf("\r\nDM_NOTIFY_CLASS_WARNING:
DM_NOTIFY_CYCLES_CHANGED");
bShowParams = TRUE;
break;
case DM_NOTIFY_MACHINES_CHANGED:
printf("\r\nDM_NOTIFY_CLASS_WARNING:
DM_NOTIFY_MACHINES_CHANGED");
bShowParams = TRUE;
break;
case DM_NOTIFY_PROJECT_OPENED:
printf("\r\nDM_NOTIFY_CLASS_WARNING:
DM_NOTIFY_PROJECT_OPENED [%s]",
(LPSTR)lpbyData);
bSpecialActionRemoveNotify = TRUE;

WinCC Engineering V18 – Programming reference

1626 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

break;
case DM_NOTIFY_PROJECT_CLOSED:
printf("\r\nDM_NOTIFY_CLASS_WARNING:
DM_NOTIFY_PROJECT_CLOSE");
bSpecialActionRemoveNotify = TRUE;
break;
case DM_NOTIFY_SYSTEM_LOCALE:
printf("\r\nDM_NOTIFY_CLASS_WARNING:
DM_NOTIFY_SYSTEM_LOCALE [%ld]",
*(DWORD*)lpbyData);
break;
case DM_NOTIFY_DATA_LOCALE:
printf("\r\nDM_NOTIFY_CLASS_WARNING:
DM_NOTIFY_DATA_LOCALE [%ld]",
*(DWORD*)lpbyData);
break;
case DM_NOTIFY_PROJECT_RUNTIME:
printf("\r\nDM_NOTIFY_CLASS_WARNING:
DM_NOTIFY_ROJECT_RUNTIME [%s]",
(LPSTR)lpbyData);
break;
case DM_NOTIFY_PROJECT_EDIT:
printf("\r\nDM_NOTIFY_CLASS_WARNING:
DM_NOTIFY_PROJECT_EDIT [%s]",
(LPSTR)lpbyData);
bSpecialActionRemoveNotify = TRUE;
break;
case DM_NOTIFY_HOTKEY_CHANGE:
printf("\r\nDM_NOTIFY_CLASS_WARNING:
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:
printf("\r\nDM_NOTIFY_CLASS_WARNING:
DM_NOTIFY_BEGIN_PROJECT_EDIT [%s]",
(LPSTR)lpbyData);
bShowParams = TRUE;
bSpecialActionRemoveNotify = TRUE;
break;
default:
printf("\r\nunknown DM_NOTIFY_CLASS_WARNING:
dwNotifyCode[%08lx]", dwNotifyCode);
bShowParams = TRUE;
}

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1627
Runtime API
3.2 Data management functions

break;
case DM_NOTIFY_CLASS_DATA:
switch (dwNotifyCode)
{
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:
dwNotifyCode[%08lx]", dwNotifyCode);
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();
}

WinCC Engineering V18 – Programming reference

1628 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

printf("\r\n#### extra added Notify [%08lx] exit ####\r\n",

(DWORD)lpvUser);
return TRUE;
}

3.2.3.3 DMChangeDataLocale

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
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
Notify applications when language is switched.

FALSE
Error.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1629
Runtime API
3.2 Data management functions

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)
DMEnumOpenedProjects (Page 1656)
DMGetRuntimeProject (Page 1662)

3.2.3.4 DMConnect

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.

WinCC Engineering V18 – Programming reference

1630 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

Declaration

BOOL DMConnect (
LPTSTR lpszAppName,
DM_NOTIFY_PROC lpfnNotify,
LPVOID lpvUser,
LPCMN_ERROR lpdmError );

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
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
Set up connection to data manager.

FALSE
Error.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1631
Runtime API
3.2 Data management functions

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.).

WinCC Engineering V18 – Programming reference

1632 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

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 1948)

3.2.3.5 DM_NOTIFY_PROC

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);

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1633
Runtime API
3.2 Data management functions

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%
DM_NOTIFY_QUEUE_60_PERCENT (0x00000002) Fill level of application queue
60%
DM_NOTIFY_QUEUE_70_PERCENT (0x00000003) Fill level of application queue
70%
DM_NOTIFY_QUEUE_80_PERCENT (0x00000004) Fill level of application queue
80%
DM_NOTIFY_QUEUE_90_PERCENT (0x00000005) Fill level of application queue
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.

WinCC Engineering V18 – Programming reference

1634 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

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
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 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

Use
The project in the runtime mode is disabled.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1635
Runtime API
3.2 Data management functions

Declaration

BOOL DMDeactivateRTProject (
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 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

Use
This function is used by an application to terminate an existing connection to the data manager.

WinCC Engineering V18 – Programming reference

1636 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

Declaration

BOOL DMDisConnect (
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
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

DM_E_NOT_CONNECTED No connection to data manager

Required files
dmclient.h
dmclient.lib
dmclient.dll

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1637
Runtime API
3.2 Data management functions

Related functions

DMConnect (Page 1630) Make connection to the data manager

Examples
Connection to DM (Page 1825) "DM01.cpp"

See also
DMConnect (Page 1630)
Connection to DM (Page 1825)

3.2.3.8 DMEnumNumberFormats

Use
The function lists all format conversions available within FORMAT.DLL .

Declaration

BOOL DMEnumNumberFormats (
LPDWORD lpdwItems,
DM_ENUM_FORMATS_PROC lpfnFormat,
LPVOID lpvUser,
LPCMN_ERROR lpdmError);

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
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.

WinCC Engineering V18 – Programming reference

1638 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

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

DM_E_NOT_CONNECTED No connection to data manager

Required files
dmclient.h
dmclient.lib
dmclient.dll

Related functions

DM_ENUM_FORMATS_PROC (Page 1639) List format conversions (callback)

See also
DM_ENUM_FORMATS_PROC (Page 1639)

3.2.3.9 DM_ENUM_FORMATS_PROC

Description
In order to evaluate the format conversions listed by the system, you must provide a
DM_ENUM_FORMATS_PROC type callback function.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1639
Runtime API
3.2 Data management functions

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
Pointer to application-specific data. This pointer is made available again in the callback
function.

Return value

TRUE
The enumeration is continued.

FALSE
The enumeration is cancelled.

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

Required files
dmclient.h

Related functions

DMEnumNumberFormats (Page 1638) List format conversions

WinCC Engineering V18 – Programming reference

1640 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

See also
DMEnumNumberFormats (Page 1638)
DM_FORMAT_INFO (Page 1573)

3.2.3.10 DMEnumUpdateCycles

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,
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.

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
Pointer to application-specific data. This pointer is not evaluated by the function, but is made
available again in the callback function.

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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1641
Runtime API
3.2 Data management functions

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

DM_E_NOT_CONNECTED No connection to data manager

Required files
dmclient.h
dmclient.lib
dmclient.dll

Related functions

DM_ENUM_CYCLES_PROC (Page 1642) List update cycles (callback)

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

Description
In order to evaluate the update cycles listed by the system, you must provide a
DM_ENUM_CYCLES_PROC type callback function.

WinCC Engineering V18 – Programming reference

1642 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

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
Pointer to application-specific data. This pointer is made available again in the callback
function.

Return value

TRUE
The enumeration is continued.

FALSE
The enumeration is cancelled.

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

Required files
dmclient.h

Related functions

DMEnumUpdateCycles (Page 1641) List update cycles

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1643
Runtime API
3.2 Data management functions

See also
DMEnumUpdateCycles (Page 1641)
DM_CYCLE_INFO (Page 1569)

3.2.3.12 DMExitWinCC

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)

WinCC Engineering V18 – Programming reference

1644 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

3.2.3.13 DMExitWinCCEx

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 re‐
started.

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)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1645
Runtime API
3.2 Data management functions

3.2.3.14 DMFireNotifyData

Declaration

BOOL DMFireNotifyData (
DWORD dwNotifyCookie,
DWORD dwByteCount,
LPBYTE lpbyData,
LPCMN_ERROR lpdmError);

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
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
Notify data sent.

FALSE
Error

WinCC Engineering V18 – Programming reference

1646 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

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
DM_E_PARAM Parameter error

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:
#include "apdefap.h"
void OnClick(char* lpszPictureName,
char* lpszObjectName,
char* lpszPropertyName)
{
DWORD dwNotifyCookie;
CHAR* pszNotifyText;
CMN_ERROR err;
BOOL bRet;

dwNotifyCookie = GetTagDWord("DMdwNotifyCookie");
pszNotifyText = GetTagChar("DMNotifySendText");
memset(&err, 0, sizeof(err));
bRet = FALSE;

bRet = DMFireNotifyData(dwNotifyCookie,
strlen(pszNotifyText)*sizeof(CHAR)+1,

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1647
Runtime API
3.2 Data management functions

(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

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 (
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
Connection established.

FALSE
Error or no connection.

Error messages

DM_E_NOT_CONNECTED No connection to data manager

WinCC Engineering V18 – Programming reference

1648 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

Required files
dmclient.h
dmclient.lib
dmclient.dll

Related functions

DMConnect (Page 1630) Make connection to the data manager

Examples
Connection to DM (Page 1825) "DM01.cpp"

See also
DMConnect (Page 1630)
Connection to DM (Page 1825)

3.2.3.16 DMGetDataLocale

Use
The function returns the ID of the currently selected runtime language.

Declaration

BOOL DMGetDataLocale (
LPDWORD lpdwLocaleID,
LPCMN_ERROR lpdmError);

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
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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1649
Runtime API
3.2 Data management functions

Return value

TRUE
Get language ID.

FALSE
Error.

Error messages

DM_E_NOT_CONNECTED No connection to data manager

Required files
dmclient.h
dmclient.lib
dmclient.dll

3.2.3.17 DMGetHotkey

Use
This function determines the action associated with a hotkey.

Declaration

BOOL DMGetHotKey (
DWORD dwHotKeyAction,
LPDWORD lpdwHotKey,
LPCMN_ERROR lpdmError);

Parameters

dwHotKeyAction
Action

lpdwHotKey
Pointer to the memory location where the hotkey is stored.

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.

WinCC Engineering V18 – Programming reference

1650 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

Return value

TRUE
Get hotkey ID.

FALSE
Error.

Required files
dmclient.h
dmclient.lib
dmclient.dll

3.2.3.18 DMGetMachineInfo

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,
LPCMN_ERROR lpdmError);

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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1651
Runtime API
3.2 Data management functions

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
Get information about the local PC.

FALSE
Error.

Error messages

DM_E_NO_RT_PRJ No project in runtime mode

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

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 (
LPCSTR lpszProjectFile,
LPDM_MACHINE_TABLE lpdmMachineTable,
LPCMN_ERROR lpdmError);

Parameters

lpdwProjectFile
Pointer to the name of the project file, including path and extension.

WinCC Engineering V18 – Programming reference

1652 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

The name of the project file is determined with DMEnumOpenedProjects or with

DMGetRuntimeProject in RT.

lpdmMachineTable
Pointer to the DM_MACHINE_TABLE (Page 1574) structure in which the data from the
computer list is stored.

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
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

Declaration

BOOL DMRemoveNotify (
DWORD dwNotifyCookie,
LPCMN_ERROR lpdmError);

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1653
Runtime API
3.2 Data management functions

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
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 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
DM_E_PARAM Parameter error

Required files
dmclient_exstr.h
dmclient.lib
dmclient.dll

WinCC Engineering V18 – Programming reference

1654 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

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:
#include "apdefap.h"
void OnClick(char* lpszPictureName,
char* lpszObjectName,
char* lpszPropertyName)
{
RemoveNotify ();
}
Project function RemoveNotify:
void RemoveNotify()
{
DWORD dwNotifyCookie = 0L;
CMN_ERRORA err;
BOOL bRet = FALSE;

memset(&err, 0, sizeof(CMN_ERRORA));
dwNotifyCookie = GetTagDWord("DMdwNotifyCookie");

if (dwNotifyCookie)
{
bRet = DMRemoveNotify(dwNotifyCookie, &err);
if (bRet)
{
printf("\r\nNotify [%08lx] removed", dwNotifyCookie);
dwNotifyCookie = 0L;
SetTagDWord("DMdwNotifyCookie",dwNotifyCookie);
}
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!");

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1655
Runtime API
3.2 Data management functions

}
}

3.2.4 Functions for project management

3.2.4.1 DMEnumOpenedProjects

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,
LPCMN_ERROR lpdmError);

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
Pointer to application-specific data. This pointer is not evaluated by the function but provided
again in the callback function.

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
Projects listed.

WinCC Engineering V18 – Programming reference

1656 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

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_ENUM_OPENED_PROJECTS_PROC (Page 1657)
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

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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1657
Runtime API
3.2 Data management functions

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
Pointer to application-specific data. This pointer is made available again in the callback
function.

Return value

TRUE
The enumeration is continued.

FALSE
The enumeration is cancelled.

Comments
Currently, only one project can be open in WinCC. You therefore only get the information for this
one project.

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

Required files
dmclient.h

Related functions

DMEnumOpenedProjects (Page 1656) List projects (open)

WinCC Engineering V18 – Programming reference

1658 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

Examples
Enum open projects "DM01.cpp"

See also
DMEnumOpenedProjects (Page 1656)
DM_PROJECT_INFO (Page 1575)
Enum open projects (Page 1830)

3.2.4.3 DMGetProjectDirectory

Use
Returns the path to the configuration data for the given project that is valid for the application.

Declaration

BOOL DMGetProjectDirectory (
LPCSTR lpszAppName,
LPCSTR lpszProjectFile,
LPDM_DIRECTORY_INFO lpdmDirInfo,
LPCMN_ERROR lpdmError );

Parameters

lpszAppName
Pointer to the name of the application for which the path is to be determined.

lpszProjectFile
Pointer to the name of the project file, including path and extension.
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
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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1659
Runtime API
3.2 Data management functions

Return value

TRUE
Get path information.

FALSE
Error.

Error messages

DM_E_FILE Error with file operation

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

Use
Determines relevant information about the given project, such as paths, data source name,
computer configuration, etc.

Declaration

BOOL DMGetProjectInformation (
LPCSTR lpszProjectFile,
LPDM_PROJECT_INFO lpProjectInfo,
LPCMN_ERROR lpdmError);

WinCC Engineering V18 – Programming reference

1660 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

Parameters

lpszProjectFile
Pointer to the 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.

lpProjectInfo
Pointer to the DM_PROJECT_INFO (Page 1575) structure in which the project information is
stored.

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
Get project information

FALSE
Error

Error messages

DM_E_FILE Error with file operation

Required files
dmclient.h
dmclient.lib
dmclient.dll

Examples
Inquire project informations (Page 1836) "DM01.cpp"
OnTestProjectInfo (Page 1841) "TESTCDoc.cpp"

See also
DM_PROJECT_INFO (Page 1575)
Inquire project informations (Page 1836)
OnTestProjectInfo (Page 1841)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1661
Runtime API
3.2 Data management functions

3.2.4.5 DMGetRuntimeProject

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,
LPCMN_ERROR lpdmError);

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
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
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.

WinCC Engineering V18 – Programming reference

1662 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

Error messages

DM_E_FILE Error with file operation

DM_E_NO_RT_PRJ No project in runtime mode

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

Use
Opens the project specified in lpszProjectFile.

Declaration

BOOL DMOpenProjectDocPlus (
LPSTR lpszProjectFile,
LPCMN_ERROR lpdmError);

Parameters

lpszProjectFile
Pointer to the name of the project file to be opened, including path and extension.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1663
Runtime API
3.2 Data management functions

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.
The name of the project file is determined with DMEnumOpenedProjects or with
DMGetRuntimeProject in RT.

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 opened.

FALSE
Error.

Required files
dmclient.h
dmclient.lib
dmclient.dll

3.2.4.7 DMOpenProjectPlus

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,
LPSTR lpszProjectFile,
DWORD dwBufSize,
LPCMN_ERROR lpdmError );

WinCC Engineering V18 – Programming reference

1664 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

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
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
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_FILE Error with file operation
DM_E_UPDATE Updating project

Required files
dmclient.h

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1665
Runtime API
3.2 Data management functions

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

3.2.5.1 DMClearBlockQueue

Use
Deletes all entries in the notification queue of the application.

Declaration

BOOL DMClearBlockQueue (
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
Notification queue is deleted.

FALSE
Error.

WinCC Engineering V18 – Programming reference

1666 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

Error messages

DM_E_NOT_CONNECTED No connection to data manager

Required files
dmclient.h
dmclient.lib
dmclient.dll

3.2.5.2 DMEnumDataServices

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,
LPCMN_ERROR lpdmError);

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
Pointer to application-specific data. This pointer is not evaluated by the function but provided
again in the callback function.

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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1667
Runtime API
3.2 Data management functions

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

DM_E_NOT_CONNECTED No connection to data manager

Required files
dmclient.h
dmclient.lib
dmclient.dll

Related functions

DM_ENUM_DATA_SERVICE_PROC (Page 1668) List data transport channels (callback)

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

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.

WinCC Engineering V18 – Programming reference

1668 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

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
Pointer to application-specific data. This pointer is made available again in the callback
function.

Return value

TRUE
The enumeration is continued.

FALSE
The enumeration is cancelled.

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

Required files
dmclient.h

Related functions

DMEnumDataServices (Page 1667) List data transport channels

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1669
Runtime API
3.2 Data management functions

See also
DMEnumDataServices (Page 1667)
DM_DATA_SERVICE_PROC (Page 1670)

3.2.5.4 DM_DATA_SERVICE_PROC

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
Pointer to application-specific data. This pointer is made available again in the callback
function.

Return value

TRUE
Depending on the use of the callback function.

WinCC Engineering V18 – Programming reference

1670 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

FALSE
Error

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
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.
In rare cases, the Notify may already be delivered before the function call has returned.

Required files
dmclient.h

Related functions

DMInstallDataService (Page 1672) Install data transport channel

DM_ENUM_DATA_SERVICE_PROC (Page 1668) List data transport channels (callback)

See also
DM_ENUM_DATA_SERVICE_PROC (Page 1668)
DM_DATA_SERVICE (Page 1570)
DMInstallDataService (Page 1672)

3.2.5.5 DMGetNumPendingBlocks

Use
This function is used by an application to determine the entries in its queue.

Declaration

BOOL DMGetNumPendingBlocks (
LONG *plEntries,
LPCMN_ERROR lpdmError);

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1671
Runtime API
3.2 Data management functions

Parameters

plEntries
After successful execution, the function contains the number of data packets in the queue of
the application.

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
Number of entries in queue determined.

FALSE
Error.

DM_E_NOT_CONNECTED No connection to data manager

Required files
dmclient.h
dmclient.lib
dmclient.dll

3.2.5.6 DMInstallDataService

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,
LPCMN_ERROR lpdmError);

WinCC Engineering V18 – Programming reference

1672 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

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.
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.

lpvUser
Pointer to application-specific data. This pointer is not evaluated by the function, but is made
available again in the callback function.

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
Data transport channel installed.

FALSE
Error.

Error messages

DM_E_NOT_CONNECTED No connection to data manager

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)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1673
Runtime API
3.2 Data management functions

See also
DMEnumDataServices (Page 1667)
DM_DATA_SERVICE_PROC (Page 1670)

3.2.5.7 DMSendApplicationData

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,
LPCMN_ERROR lpdmError);

Parameters

lpdmSendData
Pointer to the DM_SEND_DATA_STRUCT (Page 1576) structure.

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
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.

WinCC Engineering V18 – Programming reference

1674 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

Required files
dmclient.h
dmclient.lib
dmclient.dll

See also
DM_SEND_DATA_STRUCT (Page 1576)

3.2.5.8 DMSetBlockQueueSize

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,
LPCMN_ERROR lpdmError);

Parameters

nCount
Maximum number of messages.

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
Size of the queue set.

FALSE
Error.

Comment
The default value for 32-bit platforms is 1000 entries, which is usually sufficient.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1675
Runtime API
3.2 Data management functions

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

DM_E_NOT_CONNECTED No connection to data manager

Required files
dmclient.h
dmclient.lib
dmclient.dll

3.2.6 Functions for processing tags

3.2.6.1 DMEnumVarData

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 (
LPCSTR lpszProjectFile,
LPDM_VARKEY lpdmVarKey,
DWORD dwItems,
DM_ENUM_VARIABLE_PROC lpfnEnum,
LPVOID lpvUser,
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.

WinCC Engineering V18 – Programming reference

1676 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

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
Pointer to application-specific data. This pointer is not evaluated by the function but provided
again in the callback function.

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
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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1677
Runtime API
3.2 Data management functions

Error messages

DM_E_NOT_CONNECTED No connection to data manager

DM_E_INVALID_KEY Tag not found

Required files
dmclient.h
dmclient.lib
dmclient.dll

Related functions

DM_ENUM_VARIABLE_PROC (Page 1678) List information about a tag (callback)

See also
DM_VARKEY (Page 1594)
DM_VARIABLE_DATA (Page 1590)
DM_ENUM_VARIABLE_PROC (Page 1678)

3.2.6.2 DM_ENUM_VARIABLE_PROC

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_VARKEY lpdmVarKey,
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.

WinCC Engineering V18 – Programming reference

1678 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

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
Pointer to application-specific data. This pointer is made available again in the callback
function.

Return value

TRUE
The enumeration is continued.

FALSE
The enumeration is cancelled

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

Required files
dmclient.h

Related functions

DMEnumVarData (Page 1676) List information about a tag

See also
DM_VARKEY (Page 1594)
DM_VARIABLE_DATA (Page 1590)
DMEnumVarData (Page 1676)

3.2.6.3 DMEnumVarData4

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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1679
Runtime API
3.2 Data management functions

Declaration

BOOL DMEnumVarData4 (
LPCSTR lpszProjectFile,
LPDM_VARKEY lpdmVarKey,
DWORD dwItems,
DM_ENUM_VARIABLE_PROC4 lpfnEnum,
LPVOID lpvUser,
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.

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
Pointer to application-specific data. This pointer is not evaluated by the function but provided
again in the callback function.

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
Information on the tag listed.

WinCC Engineering V18 – Programming reference

1680 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

FALSE
Error.

Comment

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_NOT_CONNECTED No connection to data manager

DM_E_INVALID_KEY Tag not found

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
DM_VARKEY (Page 1594)
DM_VARIABLE_DATA4 (Page 1592)
DM_ENUM_VARIABLE_PROC4 (Page 1682)
Enum Data of Tags (Page 1828)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1681
Runtime API
3.2 Data management functions

3.2.6.4 DM_ENUM_VARIABLE_PROC4

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_VARKEY lpdmVarKey,
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
Pointer to application-specific data. This pointer is made available again in the callback
function.

Return value

TRUE
The enumeration is continued.

FALSE
The enumeration is cancelled.

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

WinCC Engineering V18 – Programming reference

1682 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

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
DMEnumVarData4 (Page 1679)
DM_VARKEY (Page 1594)
DM_VARIABLE_DATA4 (Page 1592)
Enum Data of Tags (Page 1828)

3.2.6.5 DMEnumVarGrpData

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 (
LPSTR lpszProjectFile,
LPDM_VARGRPKEY lpdmVarGrpKey,
DWORD dwItems,
DM_ENUM_VARGRP_PROC lpfnEnum,
LPVOID lpvUser,
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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1683
Runtime API
3.2 Data management functions

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
Pointer to application-specific data. This pointer is not evaluated by the function but provided
again in the callback function.

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
Information on the tag group listed.

FALSE
Error.

Error messages

DM_E_NOT_CONNECTED No connection to data manager

DM_E_INVALID_KEY Tag not found

Required files
dmclient.h
dmclient.lib
dmclient.dll

Related functions

DM_ENUM_VARGRP_PROC (Page 1687) List information about a tag group (callback)

Examples
OnTestEnumGroupsAll (Page 1837) "TESTCDoc.cpp"

WinCC Engineering V18 – Programming reference

1684 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

See also
DM_VARGRPKEY (Page 1589)
DM_ENUM_VARGRP_PROC (Page 1687)
OnTestEnumGroupsAll (Page 1837)

3.2.6.6 DMEnumVarGrpDataExStr

Declaration

BOOL DMEnumVarGrpDataExStr (
LPTSTR lpszProjectFile,
DWORD dwFlags,
LPVARIANT lpvdmVarGrpKey,
LPDWORD lpdwVarGrpCount,
DM_ENUM_VARGRP_PROC_EXSTR lpfnEnum,
LPVOID lpvUser,
LPCMN_ERROR lpdmError);

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
Pointer to the name of the project file, including path and extension.
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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1685
Runtime API
3.2 Data management functions

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
Pointer to application-specific data. The function does not evaluate this pointer, but makes it
available again within the callback function.

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
Tag group information enumerated

FALSE
Error

Error messages

DM_E_NOT_CONNECTED No connection to data manager

DM_E_INVALID_KEY Tag not found

Required files
dmclient_exstr.h
dmclient.lib
dmclient.dll

Related functions

DM_ENUM_VARGRP_PROC_EXSTR Enumerate tag group information (callback)

WinCC Engineering V18 – Programming reference

1686 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

3.2.6.7 DM_ENUM_VARGRP_PROC

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
Pointer to application-specific data. This pointer is made available again in the callback
function.

Return value

TRUE
The enumeration is continued.

FALSE
The enumeration is cancelled.

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

Required files
dmclient.h

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1687
Runtime API
3.2 Data management functions

Related functions

DMEnumVarGrpData (Page 1683) List information about a tag group

See also
DMEnumVarGrpData (Page 1683)
DM_VARGRP_DATA (Page 1588)

3.2.6.8 DMEnumVariables

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 (
LPCSTR lpszProjectFile,
LPDM_VARFILTER lpdmVarFilter,
DM_ENUM_VAR_PROC lpfnEnum,
LPVOID lpvUser,
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.

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
Pointer to application-specific data. This pointer is not evaluated by the function but provided
again in the callback function.

WinCC Engineering V18 – Programming reference

1688 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

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
Tag names listed.

FALSE
Error.

Comment

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.

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)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1689
Runtime API
3.2 Data management functions

3.2.6.9 DM_ENUM_VAR_PROC

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) (
LPDM_VARKEY lpdmVarKey,
LPVOID lpvUser

Parameters

lpdmVarKey
Pointer to a DM_VARKEY (Page 1594) type structure with the name of a tag.

lpvUser
Pointer to application-specific data. This pointer is made available again in the callback
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
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

WinCC Engineering V18 – Programming reference

1690 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

Required files
dmclient.h

Related functions

DMEnumVariables (Page 1688) List tag names

See also
DM_VARKEY (Page 1594)
DMEnumVariables (Page 1688)

3.2.6.10 DMGetValue

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 (
LPDM_VARKEY lpdmVarKey,
DWORD dwItems,
LPDM_VAR_UPDATE_STRUCT lpdmvus,
LPCMN_ERROR lpdmError);

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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1691
Runtime API
3.2 Data management functions

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_NOT_CONNECTED No connection to data manager

DM_E_PARAM Invalid parameter
DM_E_OOM Out of memory

Required files
dmclient.h
dmclient.lib
dmclient.dll

Related functions

DMGetValueWait (Page 1704) Get tag values with update

DMSetValue (Page 1734) Change tag values

Examples
Read tag (Page 1864) "DM02.cpp"
OnTestVariablenGetvalue (Page 1848) "TESTCDoc.cpp"

WinCC Engineering V18 – Programming reference

1692 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

See also
DM_VARKEY (Page 1594)
DM_VAR_UPDATE_STRUCT (Page 1581)
DMGetValueWait (Page 1704)
DMSetValue (Page 1734)
Read tag (Page 1864)
OnTestVariablenGetvalue (Page 1848)

3.2.6.11 DMGetValueEx

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.
In contrast to DMGetValue, the quality code is also returned in the
DM_VAR_UPDATE_STRUCTEX structure.

Declaration

BOOL DMGetValueEx (
LPDM_VARKEY lpdmVarKey,
DWORD dwItems,
LPDM_VAR_UPDATE_STRUCTEX lpdmvus,
LPCMN_ERROR lpdmError);

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_STRUCTEX (Page 1583) 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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1693
Runtime API
3.2 Data management functions

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

DM_E_NOT_CONNECTED No connection to data manager

DM_E_PARAM Invalid parameter
DM_E_OOM Out of memory

Required files
dmclient.h
dmclient.lib
dmclient.dll

Related functions

DMGetValueWait (Page 1704) Get tag values with update

DMSetValue (Page 1734) Change tag values

See also
DM_NOTIFY_VARIABLEEX_PROC (Page 1819)
DM_VAR_UPDATE_STRUCTEX (Page 1583)
DM_VARKEY (Page 1594)
DMGetValueWait (Page 1704)
DMSetValue (Page 1734)
DMGetValueWaitEx (Page 1706)

WinCC Engineering V18 – Programming reference

1694 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

3.2.6.12 DMGetValueExStr

Declaration

BOOL DMGetValueExStr (
DWORD dwFlags,
LPVARIANT lpdmVarKey,
LPDM_VAR_UPDATE_STRUCT_EXSTR lpdmvus,
DWORD dwdmvusCount,
LPCMN_ERROR lpdmError);

Description
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.
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.
Therefore, remember to reserve space for these structures.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1695
Runtime API
3.2 Data management functions

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

DM_E_NOT_CONNECTED No connection to data manager

DM_E_PARAM Invalid parameter
DM_E_OOM Out of memory

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":
#include "apdefap.h"
void OnClick(char* lpszPictureName, char* lpszObjectName, char*
lpszPropertyName)
{
#pragma code ("kernel32.dll")
#define CP_ACP 0

WinCC Engineering V18 – Programming reference

1696 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

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(&err, 0, sizeof(err));
memset(dmvus, 0, sizeof(dmvus));
dwVal[0] = 1;
dwVal[1] = 2;
dwVal[2] = 3;

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1697
Runtime API
3.2 Data management functions

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;
hr = SafeArrayPtrOfIndex(parrayKeys, &lInx, &pvElem);
pvElem->vt = VT_LPSTR;
pvElem->u.pbVal = "dwVal_2";
lInx = 2L;
hr = SafeArrayPtrOfIndex(parrayKeys, &lInx, &pvElem);
pvElem->vt = VT_LPSTR;
pvElem->u.pbVal = "dwVal_3";
lInx = 3L;
hr = SafeArrayPtrOfIndex(parrayKeys, &lInx, &pvElem);
pvElem->vt = VT_LPSTR;
pvElem->u.pbVal = "dwVal_4";
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
{

WinCC Engineering V18 – Programming reference

1698 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

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;

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1699
Runtime API
3.2 Data management functions

SafeArrayLock(parrayValues);
lInx = 0L;
hr = SafeArrayPtrOfIndex(parrayValues, &lInx, &pvElem);
pvElem->vt = VT_I4;
pvElem->u.pbVal = dwVal[0];
lInx = 1L;
hr = SafeArrayPtrOfIndex(parrayValues, &lInx, &pvElem);
pvElem->vt = VT_I4;
pvElem->u.pbVal = dwVal[1];
lInx = 2L;
hr = SafeArrayPtrOfIndex(parrayValues, &lInx, &pvElem);
pvElem->vt = VT_I4;
pvElem->u.pbVal = dwVal[2];
lInx = 3L;
hr = SafeArrayPtrOfIndex(parrayValues, &lInx, &pvElem);
pvElem->vt = VT_I4;
pvElem->u.pbVal = dwVal[3];
SafeArrayUnlock(parrayValues);

printf("\r\ncall DMSetValueExStr:");
memset(&err, 0, sizeof(err));
bRet = DMSetValueExStr(&vVarKey, &vdmValue, pdwVarState, &err);

if (bRet == FALSE)
{
printf("\r\n error DMSetValueExStr, 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++)
{
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:");
memset(&err, 0, sizeof(err));
bRet = DMGetValueWaitExStr(&dwTAID, dwFlags, &vVarKey, TRUE, 2000,
DM_NotifyVariableProcExStr_GetValueWait, dwVal, &err);
if (bRet == FALSE)

WinCC Engineering V18 – Programming reference

1700 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

{
printf("\r\n error DMGetValueWaitExStr,
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++)
{
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;
}
dwVal[1] = dwVal[1] + 1;
if (dwVal[1] >= 100)
{
dwVal[1] = dwVal[1] - 100;
}
dwVal[2] = dwVal[2] + 1;
if (dwVal[2] >= 100)
{
dwVal[2] = dwVal[2] - 100;
}
dwVal[3] = dwVal[3] + 1;
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;
hr = SafeArrayPtrOfIndex(parrayValues, &lInx, &pvElem);
pvElem->vt = VT_I4;
pvElem->u.pbVal = dwVal[0];
lInx = 1L;
hr = SafeArrayPtrOfIndex(parrayValues, &lInx, &pvElem);
pvElem->vt = VT_I4;
pvElem->u.pbVal = dwVal[1];
lInx = 2L;
hr = SafeArrayPtrOfIndex(parrayValues, &lInx, &pvElem);
pvElem->vt = VT_I4;

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1701
Runtime API
3.2 Data management functions

pvElem->u.pbVal = dwVal[2];
lInx = 3L;
hr = SafeArrayPtrOfIndex(parrayValues, &lInx, &pvElem);
pvElem->vt = VT_I4;
pvElem->u.pbVal = dwVal[3];
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 ("OleAut32.dll")
//#include "OleAuto.h"
HRESULT VariantChangeType( VARIANTARG FAR* pvargDest, VARIANTARG
FAR* pvarSrc, unsigned short wFlags, VARTYPE vt);
#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 ***");

WinCC Engineering V18 – Programming reference

1702 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

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;
}
if (0 == strcmp((LPCSTR)lpdmvus[i].vdmVarKey.u.pbVal,
"dwVal_2"))
{
pdwVal[1] = lpdmvus[i].vdmValue.u.lVal;
printf("\r\n set dwVal_2=%ld to dwVal[1]", pdwVal[1]);
bRet = TRUE;
}
if (0 == strcmp((LPCSTR)lpdmvus[i].vdmVarKey.u.pbVal,
"dwVal_3"))
{
pdwVal[2] = lpdmvus[i].vdmValue.u.lVal;
printf("\r\n set dwVal_3=%ld to dwVal[2]", pdwVal[2]);
bRet = TRUE;
}
if (0 == strcmp((LPCSTR)lpdmvus[i].vdmVarKey.u.pbVal,
"dwVal_4"))
{
pdwVal[3] = lpdmvus[i].vdmValue.u.lVal;
printf("\r\n set dwVal_4=%ld to dwVal[3]", pdwVal[3]);
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 ***");

for (i = 0; i < dwItems; i++)

{
printf("\r\n VarState[%d] = %ld", i, lpdmVarState[i]);
}

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1703
Runtime API
3.2 Data management functions

printf("\r\n*** DM_CompletitionProc exit ***");

return bRet;
}

3.2.6.13 DMGetValueWait

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.
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,
LPDM_VARKEY lpdmVarKey,
DWORD dwItems,
BOOL fWaitForCompletition,
DWORD dwTimeOut,
DM_NOTIFY_VARIABLE_PROC lpfnVariable,
LPVOID lpvUser,
LPCMN_ERROR lpdmError);

Parameters

pdwTAID
Pointer to a tag that contains the transaction ID assigned by the data manager after a
successful call of the function.

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).

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.

WinCC Engineering V18 – Programming reference

1704 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

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.
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.

lpvUser
Pointer to application-specific data. This pointer is not evaluated by the function but provided
again in the callback function.

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
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)

DMGetValue (Page 1691) Get tag values
DMGetValueWaitEx (Page 1706) Get tag values with update
DMSetValueWait (Page 1744) Change tag values with notification

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1705
Runtime API
3.2 Data management functions

Examples
OnTestVariablenGetvaluewait (Page 1851) "TESTCDoc.cpp"

See also
DM_NOTIFY_VARIABLE_PROC (Page 1808)
DM_VARKEY (Page 1594)
DMGetValue (Page 1691)
DMGetValueEx (Page 1693)
DMSetValueWait (Page 1744)
OnTestVariablenGetvaluewait (Page 1851)
DMGetValueWaitEx (Page 1706)

3.2.6.14 DMGetValueWaitEx

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.
In contrast to DMGetValueEx, this function forces a value-based update of the tag values.

Declaration

BOOL DMGetValueWaitEx (
LPDWORD pdwTAID,
LPDM_VARKEY lpdmVarKey,
DWORD dwItems,
BOOL fWaitForCompletition,
DWORD dwTimeOut,
DM_NOTIFY_VARIABLEEX_PROC lpfnVariable,
LPVOID lpvUser,
LPCMN_ERROR lpdmError);

Parameters

pdwTAID
Pointer to a tag that contains the transaction ID assigned by the data manager after a
successful call of the function.

lpdmVarKey
Pointer to the DM_VARKEY (Page 1594) structure that identifies the tag values to be read.

WinCC Engineering V18 – Programming reference

1706 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

dwItems
Number of passed structures (corresponds to the number of tag values to be read).

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_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.
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.

lpvUser
Pointer to application-specific data. This pointer is not evaluated by the function but provided
again in the callback function.

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
Values determined.

FALSE
Error.

Related functions

DM_NOTIFY_VARIABLEEX_PROC (Page 1819) Get tag values with notification (callback)

DMGetValueEx (Page 1693) Get tag values
DMSetValueWait (Page 1744) Change tag values with notification

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1707
Runtime API
3.2 Data management functions

See also
DM_NOTIFY_VARIABLEEX_PROC (Page 1819)
DMGetValueWait (Page 1704)
DM_VARKEY (Page 1594)
DMGetValueEx (Page 1693)
DMSetValueWait (Page 1744)

3.2.6.15 DMGetValueWaitExStr

Declaration

BOOL DMGetValueWaitExStr (
LPDWORD pdwTAID,
DWORD dwFlags
LPVARIANT lpvdmVarKey,
LPVARIANT lpvCookie,
BOOL fWaitForCompletition,
DWORD dwTimeOut,
DM_NOTIFY_VARIABLE_PROC_EXSTR lpfnVariable,
LPVOID lpvUser,
LPCMN_ERROR lpdmError);

Description
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.
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
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.

WinCC Engineering V18 – Programming reference

1708 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

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.

fWaitForCompletition
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
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 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.
Unread messages could block WinCC notifications or finally block WinCC altogether.
On rare occasions, the notify may be returned before the function call has returned.

lpvUser
Pointer to application-specific data. The function does not evaluate this pointer, but makes it
available again within the callback function.

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
Values have been determined

FALSE
Error

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1709
Runtime API
3.2 Data management functions

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

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 (
LPCSTR lpszProjectFile,
LPDM_VARKEY lpdmVarKey,
DWORD dwItems,
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.

lpdmVarKey
Pointer to the DM_VARKEY (Page 1594) structure to be completed with the tag keys.

dwItems
Number of completed structures.

WinCC Engineering V18 – Programming reference

1710 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

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
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

DM_E_NOT_CONNECTED No connection to data manager

Required files
dmclient.h
dmclient.lib
dmclient.dll

Examples
OnTestVariablenGetVarInfo (Page 1855) "TESTCDoc.cpp"

See also
DM_VARKEY (Page 1594)
OnTestVariablenGetVarInfo (Page 1855)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1711
Runtime API
3.2 Data management functions

3.2.6.17 DMGetVarInfoExStr

Declaration

BOOL DMGetVarInfoExStr (
LPCTSTR lpszProjectFile,
DWORD dwFlags,
LPVARIANT lpvdmVarKeyIn,
LPVARIANT lpvdmVarKeyOut,
LPCMN_ERROR lpdmError);

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
Pointer to the name of the project file, including path and extension.
The name of the project file can be retrieved with DMEnumOpenedProjects, or with
DMGetRuntimeProject in Runtime.

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.

WinCC Engineering V18 – Programming reference

1712 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

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
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
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

DM_E_NOT_CONNECTED No connection to data manager

Required files
dmclient_exstr.h
dmclient.lib
dmclient.dll

Examples
Script sample Button DMGetVarInfoExStr:
#include "apdefap.h"
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,

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1713
Runtime API
3.2 Data management functions

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 SafeArrayPutElement(SAFEARRAY FAR* psa, long FAR*
rgIndices, void FAR* pv );
HRESULT SafeArrayGetElement(SAFEARRAY FAR* psa, long FAR*
rgIndices, void FAR* pv );
HRESULT SafeArrayPtrOfIndex(SAFEARRAY FAR* psa, long FAR*
rgIndices, void HUGEP* FAR* ppvData );
HRESULT SafeArrayLock(SAFEARRAY FAR* psa);
HRESULT SafeArrayUnlock(SAFEARRAY FAR* psa);
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;
memset(&err, 0, sizeof(err));
bRet = FALSE;
szProjectName[0] = 0;
dwFlags = 0;
VariantInit(&vVarkeyIn);
VariantInit(&vVarkeyOut);
VariantInit(&vElem);
parrayIN = NULL;

WinCC Engineering V18 – Programming reference

1714 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

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,
err.dwError1, err.dwError2, err.dwError3,
err.dwError4, err.dwError5, err.szErrorText);
}
dwVarID1 = GetTagDWord("dwVarKeyID_1");
dwVarID2 = GetTagDWord("dwVarKeyID_2");
dwVarID3 = GetTagDWord("dwVarKeyID_3");
dwVarID4 = GetTagDWord("dwVarKeyID_4");
strncpy(szVarNam1, GetTagChar("szVarKeyName_1"), 256);
strncpy(szVarNam2, GetTagChar("szVarKeyName_2"), 256);
strncpy(szVarNam3, GetTagChar("szVarKeyName_3"), 256);
strncpy(szVarNam4, GetTagChar("szVarKeyName_4"), 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)", dwVarID2, szVarNam2);
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->vt = VT_LPSTR;
pvElem->u.pbVal = szVarNam2;
SafeArrayUnlock(parrayIN);
if (hr)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1715
Runtime API
3.2 Data management functions

{
printf("\r\nerror SafeArrayPutElement: hr = %08lx", hr);
}
VariantClear(&vElem);
vElem.vt = VT_I4;
vElem.u.lVal = dwVarID3;
lInx = 2;
hr = SafeArrayPutElement(parrayIN, &lInx, &vElem);
vElem.vt = VT_I4;
vElem.u.lVal = dwVarID4;
lInx = 3;
hr = SafeArrayPutElement(parrayIN, &lInx, &vElem);

memset(&err, 0, sizeof(err));
bRet = DMGetVarInfoExStr(szProjectName, dwFlags, &vVarkeyIn,
&vVarkeyOut, &err);
if (!bRet)
{
printf("\r\n error DMGetVarInfoExStr[%s],
err=%ld,%ld,%ld,%ld,%ld,[%s]", szProjectName,
err.dwError1, err.dwError2, err.dwError3,
err.dwError4, err.dwError5, err.szErrorText);
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
{

WinCC Engineering V18 – Programming reference

1716 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

dwVarID1 = vElem.u.lVal;
}
SetTagDWord("dwVarKeyID_1",dwVarID1);
lInx = 1;
SafeArrayGetElement(parrayOUT, &lInx, &vElem);
if (vElem.vt != VT_I4)
{
printf("\r\n vVarKeyOut[%ld].vt = [%ld] != VT_I4",
lInx, vElem.vt);
dwVarID2 = 0L;
}
else
{
dwVarID2 = vElem.u.lVal;
}
SetTagDWord("dwVarKeyID_2",dwVarID2);
lInx = 2;
SafeArrayGetElement(parrayOUT, &lInx, &vElem);
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;
SafeArrayGetElement(parrayOUT, &lInx, &vElem);
if (vElem.vt != VT_BSTR)
{
printf("\r\n vVarKeyOut[%ld].vt = [%ld] != VT_BSTR",
lInx, vElem.vt);
strcpy(szVarNam4, "error!!!");
}
else
{
nRet = WideCharToMultiByte(CP_ACP, 0L,
(WCHAR*)vElem.u.bstrVal, -1,
szVarNam4, 256, NULL, NULL);
}
SetTagChar("szVarKeyName_4",szVarNam4);
printf("\r\n get vVarkeyOut:");
printf("\r\n dwVarID1=%ld, szVarNam1=[%s] (delivered
ID)", dwVarID1, szVarNam1);
printf("\r\n dwVarID2=%ld, szVarNam2=[%s] (delivered
ID)", dwVarID2, szVarNam2);

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1717
Runtime API
3.2 Data management functions

printf("\r\n dwVarID3=%ld, szVarNam3=[%s] (delivered

name VT_BSTR)", dwVarID3, szVarNam3);
printf("\r\n dwVarID4=%ld, szVarNam4=[%s] (delivered
name VT_BSTR)", dwVarID4, szVarNam4);
}
}
printf("\r\n set flag DM_FLAG_RETURN_PROPVARIANT_VT_LPSTR and
repeat DMGetVarInfoExStr");
dwFlags = DM_FLAG_RETURN_PROPVARIANT_VT_LPSTR;
memset(&err, 0, sizeof(err));
hr = VariantClear(&vVarkeyOut);
if (hr)
{
printf("\r\nerror VariantClear(vVarKeyOut: hr = %08lx", hr);
}
bRet = DMGetVarInfoExStr(szProjectName, dwFlags, &vVarkeyIn,
&vVarkeyOut, &err);
if (!bRet)
{
printf("\r\n error DMGetVarInfoExStr[%s],
err=%ld,%ld,%ld,%ld,%ld,[%s]", szProjectName,
err.dwError1, err.dwError2, err.dwError3,
err.dwError4, err.dwError5, err.szErrorText);
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

WinCC Engineering V18 – Programming reference

1718 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

{
dwVarID1 = vElem.u.lVal;
}
SetTagDWord("dwVarKeyID_1",dwVarID1);
lInx = 1;
SafeArrayGetElement(parrayOUT, &lInx, &vElem);
if (vElem.vt != VT_I4)
{
printf("\r\n vVarKeyOut[%ld].vt = [%ld] != VT_I4",
lInx, vElem.vt);
dwVarID2 = 0L;
}
else
{
dwVarID2 = vElem.u.lVal;
}
SetTagDWord("dwVarKeyID_2",dwVarID2);

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);
strcpy(szVarNam3, "error!!!");
}
else
{
strncpy(szVarNam3, (LPSTR)pvElem->u.pbVal, 255);
szVarNam3[255] = 0;
}
SetTagChar("szVarKeyName_3",szVarNam3);
lInx = 3;
SafeArrayPtrOfIndex(parrayOUT, &lInx, &pvElem);
if (pvElem->vt != VT_LPSTR)
{
printf("\r\n vVarKeyOut[%ld].vt = [%ld] != VT_LPSTR",
lInx, pvElem->vt);
strcpy(szVarNam4, "error!!!");
}
else
{
strncpy(szVarNam4, (LPSTR)pvElem->u.pbVal, 255);
szVarNam4[255] = 0;
}
SetTagChar("szVarKeyName_4",szVarNam4);
SafeArrayUnlock(parrayOUT);

printf("\r\n get vVarkeyOut:");

printf("\r\n dwVarID1=%ld, szVarNam1=[%s] (delivered
ID)", dwVarID1, szVarNam1);

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1719
Runtime API
3.2 Data management functions

printf("\r\n dwVarID2=%ld, szVarNam2=[%s] (delivered

ID)", dwVarID2, szVarNam2);
printf("\r\n dwVarID3=%ld, szVarNam3=[%s] (delivered
name VT_LPSTR)", dwVarID3, szVarNam3);
printf("\r\n dwVarID4=%ld, szVarNam4=[%s] (delivered
name 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");
dwFlags = DM_FLAG_RETURN_PROPVARIANT_VT_LPSTR;
memset(&err, 0, sizeof(err));
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;
bRet = DMGetVarInfoExStr(szProjectName, dwFlags, &vVarkeyIn,
&vVarkeyOut, &err);
if (!bRet)
{

WinCC Engineering V18 – Programming reference

1720 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

printf("\r\n error DMGetVarInfoExStr[%s],

err=%ld,%ld,%ld,%ld,%ld,[%s]", szProjectName,
err.dwError1, err.dwError2, err.dwError3,
err.dwError4, err.dwError5, err.szErrorText);
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
{
if (vVarkeyOut.vt != VT_LPSTR)
{
printf("\r\n vVarKeyOut.vt = [%ld] != VT_LPSTR",
vVarkeyOut.vt);
strcpy(szVarNam1, "error!!!");
}
else
{
strncpy(szVarNam1, (LPSTR)vVarkeyOut.u.pbVal, 255);
szVarNam1[255] = 0;
}
SetTagChar("szVarKeyName_1",szVarNam1);
}
}

printf("\r\n########## exit Test with DMGetVarInfoExStr

##########\r\n");

3.2.6.18 DMGetVarLimits

Use
DMGetVarLimits determines the limits for the specified tag, within which write operations are
possible with DMSetValue functions.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1721
Runtime API
3.2 Data management functions

Declaration

BOOL DMGetVarLimits (
LPCSTR lpszProjectFile,
LPDM_VARKEY lpdmVarKey,
DWORD dwItems,
LPDM_VARLIMIT lpdmVarLimit,
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.

lpdmVarKey
Pointer to a DM_VARKEY (Page 1594) type structure for specification of the tags.

dwItems
Number of completed structures.

lpdmVarLimit
Pointer to the DM_VARLIMIT (Page 1597) type structure in which the limits are is stored.

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
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.

WinCC Engineering V18 – Programming reference

1722 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

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_NOT_CONNECTED No connection to data manager
DM_E_INVALID_KEY Tag not found
DM_E_INVALID_TYPE Invalid tag type

Required files
dmclient.h
dmclient.lib
dmclient.dll

Examples
OnTestVariablenGetvarlimits (Page 1856) "TESTCDoc.cpp"

See also
DM_VARKEY (Page 1594)
DM_VARLIMIT (Page 1597)
OnTestVariablenGetvarlimits (Page 1856)

3.2.6.19 DMGetVarLimitsExStr

Declaration

BOOL DMGetVarLimitsExStr (
LPCTSTR lpszProjectFile,
LPVARIANT lpvdmVarKey,
LPDM_VARLIMIT lpdmVarLimit,
LPCMN_ERROR lpdmError );

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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1723
Runtime API
3.2 Data management functions

Parameters

lpszProjectFile
Pointer to the name of the project file, including path and extension.
The name of the project file can be retrieved with DMEnumOpenedProjects, or with
DMGetRuntimeProject in Runtime.

lpvdmVarKey
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.

lpdmVarLimit
Pointer to structures of the DM_VARLIMIT type to store the limit values.

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
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_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_NOT_CONNECTED No connection to data manager

WinCC Engineering V18 – Programming reference

1724 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

DM_E_INVALID_KEY Tag not found

DM_E_INVALID_TYPE Invalid tag type

Required files
dmclient_exstr.h
dmclient.lib
dmclient.dll

Examples
Script sample Button DMGetVarLimitsExStr:
#include "apdefap.h"
void OnClick(char* lpszPictureName, char* lpszObjectName, char*
lpszPropertyName)
{
#pragma code ("OleAut32.dll")
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);
#pragma code()

VARIANT vdmVarkey;
VARIANT* pvElem;
VARIANT vElem;
HRESULT hr;
CHAR szProjectName[256];
CMN_ERROR err;
BOOL bRet;
CHAR szVarNam1[256], szVarNam2[256], szVarNam3[256], szVarNam4[265];
SAFEARRAY* parray;
long lInx;
int nRet;
DM_VARLIMIT dmLimits[4];
int i;

memset(&err, 0, sizeof(err));
bRet = FALSE;
szProjectName[0] = 0;
VariantInit(&vElem);
VariantInit(&vdmVarkey);
parray = NULL;
nRet = 0;
i = 0;

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1725
Runtime API
3.2 Data management functions

printf("\r\n\r\n########## enter Test with DMGetVarLimitsExStr

##########");

bRet = DMGetRuntimeProject(szProjectName, 256, &err);

if (!bRet)
{
printf("\r\n error DMGetRuntimeProject =>[%s],
err=%ld,%ld,%ld,%ld,%ld,[%s]", szProjectName,
err.dwError1, err.dwError2, err.dwError3, err.dwError4,
err.dwError5, err.szErrorText);
}

strncpy(szVarNam1, GetTagChar("szVarKeyName_1"), 256);

strncpy(szVarNam2, GetTagChar("szVarKeyName_2"), 256);
strncpy(szVarNam3, GetTagChar("szVarKeyName_3"), 256);
strncpy(szVarNam4, GetTagChar("szVarKeyName_4"), 256);
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);
pvElem->vt = VT_LPSTR;
pvElem->u.pbVal = szVarNam1;
lInx = 1;
hr = SafeArrayPtrOfIndex(parray, &lInx, &pvElem);
pvElem->vt = VT_LPSTR;
pvElem->u.pbVal = szVarNam2;
lInx = 2;
hr = SafeArrayPtrOfIndex(parray, &lInx, &pvElem);
pvElem->vt = VT_LPSTR;
pvElem->u.pbVal = szVarNam3;
lInx = 3;
hr = SafeArrayPtrOfIndex(parray, &lInx, &pvElem);
pvElem->vt = VT_LPSTR;
pvElem->u.pbVal = szVarNam4;
SafeArrayUnlock(parray);

memset(&err, 0, sizeof(err));
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,%ld,[%s]", szProjectName,
err.dwError1, err.dwError2, err.dwError3, err.dwError4,
err.dwError5, err.szErrorText);
bRet = TRUE; //clear error flag, the defect data is set to
VT_EMPTY
}

WinCC Engineering V18 – Programming reference

1726 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

else
{
printf("\r\n DMGetVarLimitsExStr return OK");
}
if (bRet)
{
for (i = 0; i < 4; i++)
{
VariantClear(&vElem);
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);
}
VariantClear(&vElem);
hr = VariantChangeType((VARIANTARG*)&vElem,
(VARIANTARG*)&dmLimits[i].dmMinRange, 0, VT_R8);
if ((0L == hr) && (VT_R8 == vElem.vt) && (VT_EMPTY !=
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);
}
VariantClear(&vElem);
hr = VariantChangeType((VARIANTARG*)&vElem,
(VARIANTARG*)&dmLimits[i].dmMaxLimit, 0, VT_R8);
if ((0L == hr) && (VT_R8 == vElem.vt) && (VT_EMPTY !=
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);
}
VariantClear(&vElem);

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1727
Runtime API
3.2 Data management functions

hr = VariantChangeType((VARIANTARG*)&vElem,
(VARIANTARG*)&dmLimits[i].dmMinLimit, 0, VT_R8);
if ((0L == hr) && (VT_R8 == vElem.vt) && (VT_EMPTY !=
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

Use
DMGetVarType determines the type reference for the passed tags.

Declaration

BOOL DMGetVarType (
LPCSTR lpszProjectFile,
LPDM_VARKEY lpdmVarKey,
DWORD dwItems,
LPDM_TYPEREF lpdmTypeRef,
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.

WinCC Engineering V18 – Programming reference

1728 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

lpdmVarKey
Pointer to the DM_VARKEY (Page 1594) structure with which the tag keys determined for the
type.

dwItems
Number of completed structures.

lpdmTypeRef
Pointer to the list of DM_TYPEREF (Page 1579) structures for returning the details about the
tag type.

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
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

DM_E_NOT_CONNECTED No connection to data manager

DM_E_INVALID_KEY Tag not found

Required files
dmclient.h
dmclient.lib
dmclient.dll

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1729
Runtime API
3.2 Data management functions

Examples
OnTestVariablenGetvartype (Page 1857) "TESTCDoc.cpp"

See also
DM_VARKEY (Page 1594)
DM_TYPEREF (Page 1579)
OnTestVariablenGetvartype (Page 1857)

3.2.6.21 DMGetVarTypeExStr

Declaration

BOOL DMGetVarTypeExStr (
LPCTSTR lpszProjectFile,
LPVARIANT lpvdmVarKey,
LPDM_TYPEREF_EXSTR lpdmTypeRef,
LPCMN_ERROR lpdmError);

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
Pointer to the name of the project file, including path and extension.
The name of the project file can be retrieved with DMEnumOpenedProjects, or with
DMGetRuntimeProject in Runtime.

lpvdmVarKey
Pointer to VARIANT with VT_ARRAY | VT_VARIANT for passing the tag list.
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.

lpdmTypeRef
Pointer to the list of DM_TYPEREF_EXSTR structures that return tag type information.

WinCC Engineering V18 – Programming reference

1730 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

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
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
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

DM_E_NOT_CONNECTED No connection to data manager

DM_E_INVALID_KEY Tag not found

Required files
dmclient_exstr.h
dmclient.lib
dmclient.dll

Examples
Script sample Button DMGetVarTypeExStr:
#include "apdefap.h"
void OnClick(char* lpszPictureName, char* lpszObjectName, char*
lpszPropertyName)
{
#pragma code ("OleAut32.dll")

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1731
Runtime API
3.2 Data management functions

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);
#pragma code()

VARIANT vdmVarkey;
VARIANT* pvElem;
HRESULT hr;
CHAR szProjectName[256];
CMN_ERROR err;
BOOL bRet;
CHAR szVarNam1[256], szVarNam2[256], szVarNam3[256], szVarNam4[256];
SAFEARRAY* parray;
long lInx;
int nRet;
DM_TYPEREF_EXSTR dmTypeRef[4];
CHAR szTypeName[4][256];
int i;

memset(&err, 0, sizeof(err));
memset(dmTypeRef, 0, sizeof(DM_TYPEREF_EXSTR)*4);
szTypeName[0][0] = 0;
szTypeName[1][0] = 0;
szTypeName[2][0] = 0;
szTypeName[3][0] = 0;
bRet = FALSE;
szProjectName[0] = 0;
VariantInit(&vdmVarkey);
parray = NULL;
nRet = 0;
i = 0;

printf("\r\n\r\n########## enter Test with DMGetVarTypeExStr

##########");

bRet = DMGetRuntimeProject(szProjectName, 256, &err);

if (!bRet)
{
printf("\r\n error DMGetRuntimeProject =>[%s],
err=%ld,%ld,%ld,%ld,%ld,[%s]", szProjectName,
err.dwError1, err.dwError2, err.dwError3, err.dwError4,
err.dwError5, err.szErrorText);
}

strncpy(szVarNam1, GetTagChar("szVarKeyName_1"), 256);

strncpy(szVarNam2, GetTagChar("szVarKeyName_2"), 256);
strncpy(szVarNam3, GetTagChar("szVarKeyName_3"), 256);
strncpy(szVarNam4, GetTagChar("szVarKeyName_4"), 256);
printf("\r\n set the vdmVarkey with names in VT_LPSTR:");

WinCC Engineering V18 – Programming reference

1732 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

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);
pvElem->vt = VT_LPSTR;
pvElem->u.pbVal = szVarNam1;
lInx = 1;
hr = SafeArrayPtrOfIndex(parray, &lInx, &pvElem);
pvElem->vt = VT_LPSTR;
pvElem->u.pbVal = szVarNam2;
lInx = 2;
hr = SafeArrayPtrOfIndex(parray, &lInx, &pvElem);
pvElem->vt = VT_LPSTR;
pvElem->u.pbVal = szVarNam3;
lInx = 3;
hr = SafeArrayPtrOfIndex(parray, &lInx, &pvElem);
pvElem->vt = VT_LPSTR;
pvElem->u.pbVal = szVarNam4;
SafeArrayUnlock(parray);

printf("\r\n call DMGetVarTypeExStr with NULL for names");

memset(&err, 0, sizeof(err));
bRet = DMGetVarTypeExStr(szProjectName, &vdmVarkey, dmTypeRef,
&err);
if (!bRet)
{
printf("\r\n error DMGetVarTypeExStr[%s],
err=%ld,%ld,%ld,%ld,%ld,[%s]", szProjectName,
err.dwError1, err.dwError2, err.dwError3, err.dwError4,
err.dwError5, err.szErrorText);
}
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);

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1733
Runtime API
3.2 Data management functions

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");
memset(&err, 0, sizeof(err));
bRet = DMGetVarTypeExStr(szProjectName, &vdmVarkey, dmTypeRef,
&err);
if (!bRet)
{
printf("\r\n error DMGetVarTypeExStr[%s],
err=%ld,%ld,%ld,%ld,%ld,[%s]", szProjectName,
err.dwError1, err.dwError2, err.dwError3, err.dwError4,
err.dwError5, err.szErrorText);
}
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);
printf(", dwNameCharCount=[%ld]",
dmTypeRef[i].dwNameCharCount);
printf("}");
}
}
printf("\r\n########## exit Test with DMGetVarTypeExStr
##########\r\n");

3.2.6.22 DMSetValue

Use
The function changes the values of the tags described by lpdmVarKey to the values specified in
lpdmValue.

WinCC Engineering V18 – Programming reference

1734 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

Changes are made to the tags asynchronously, according to the motto "fire and forget".

Declaration

BOOL DMSetValue (
LPDM_VARKEY lpdmVarKey,
DWORD dwItems,
LPVARIANT lpdmValue,
LPDWORD lpdmVarState,
LPCMN_ERROR lpdmError);

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_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_VARSTATE_..._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 channel
DM_VARSTATE_INVALID_KEY (0x0800) Tag not found / not available
DM_VARSTATE_ACCESS_FAULT (0x1000) Access to tag not permitted

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1735
Runtime API
3.2 Data management functions

DM_VARSTATE_TIMEOUT (0x2000) Timeout / no feedback from channel

DM_VARSTATE_SERVERDOWN (0x4000) Server is down

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
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_MAX_LIMIT High limit of tag violated

DM_E_MIN_LIMIT Low limit of tag violated
DM_E_MAX_RANGE High limit of format conversion violated
DM_E_MIN_RANGE Low limit of format conversion violated
DM_E_ACCESS_FAULT Prohibited write access to a tag
DM_E_NOT_CONNECTED No connection to data manager
DM_E_PARAM Invalid parameter
DM_E_OOM Out of memory

Required files
dmclient.h
dmclient.lib

WinCC Engineering V18 – Programming reference

1736 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

dmclient.dll

Related functions

DMGetValue (Page 1691) Get 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

Examples
Write tag (Page 1869) "DM02.cpp"
OnTestVariablenSetvalue (Page 1859) "TESTCDoc.cpp"

See also
DM_VARKEY (Page 1594)
DMGetValue (Page 1691)
DMGetValueEx (Page 1693)
DMSetValueMessage (Page 1740)
DMSetValueWait (Page 1744)
DMSetValueWaitMessage (Page 1749)
Write tag (Page 1869)
OnTestVariablenSetvalue (Page 1859)

3.2.6.23 DMSetValueExStr

Declaration

BOOL DMSetValueExStr (
LPVARIANT lpvdmVarKey,
LPVARIANT lpvdmValue,
LPDWORD lpdmVarState,
LPCMN_ERROR lpdmError);

Description
This function changes the values of the tags described by lpvdmVarKey to obtain the values
specified in lpvdmValue.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1737
Runtime API
3.2 Data management functions

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.
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.
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
Pointer to the first of the new values for the tags to be changed.

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_NOT_ESTABLISHED (0x0001) Connection to partner not established

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) Conversion error display (in connec‐
tion with DM_VARSTATE_..._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

WinCC Engineering V18 – Programming reference

1738 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

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
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_MAX_LIMIT High limit of tag violated

DM_E_MIN_LIMIT Low limit of tag violated
DM_E_MAX_RANGE High limit of format conversion violated
DM_E_MIN_RANGE Low limit of format conversion violated
DM_E_ACCESS_FAULT Prohibited write access to a tag
DM_E_NOT_CONNECTED No connection to data manager
DM_E_PARAM Invalid parameter
DM_E_OOM Out of memory

Required files
dmclient_exstr.h
dmclient.lib
dmclient.dll

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1739
Runtime API
3.2 Data management functions

Related functions

DMGetValueExStr Get tag values

DMSetValueMessageExStr Change tag values with alarm output
DMSetValueWaitExStr Change tag values with notification
DMSetValueWaitMessageExStr Change tag values with notification and alarm out‐
put

Examples
You can find samples on the DMGetValueExStr page.

3.2.6.24 DMSetValueMessage

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 (
LPDM_VARKEY lpdmVarKey,
LPVARIANT lpdmValue,
DWORD fFlags,
LPSTR lpszMessage,
LPCMN_ERROR lpdmError);

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.

WinCC Engineering V18 – Programming reference

1740 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

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
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
Tag changed.

FALSE
Error.

Comment
You can find more information about changing tag values at the DMSetValue function.

Error messages

DM_E_NOT_CONNECTED No connection to data manager

DM_E_PARAM Invalid parameter
DM_E_OOM Out of memory

Required files
dmclient.h
dmclient.lib
dmclient.dll

Related functions

DMSetValue (Page 1734) Change tag values

DMSetValueWait (Page 1744) Change tag values with notification
DMSetValueWaitMessage (Page 1749) Change tag values with notification and alarm out‐
put

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1741
Runtime API
3.2 Data management functions

See also
DM_VARKEY (Page 1594)
DMSetValue (Page 1734)
DMSetValueWait (Page 1744)
DMSetValueWaitMessage (Page 1749)

3.2.6.25 DMSetValueMessageExStr

Declaration

BOOL DMSetValueMessageExStr (
LPVARIANT lpvdmVarKey,
LPVARIANT lpvdmValue,
DWORD fFlags,
LPTSTR lpszMessage,
LPCMN_ERROR lpdmError);

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.
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.
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
Pointer to the new value of the tag to be changed.

WinCC Engineering V18 – Programming reference

1742 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

fFlags
fFlags specifies how to process the alarm text:

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
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
Tags have been changed

FALSE
Error

Comment
For more information on changing the values of tags refer to the DMSetValueExStr function.

Error messages

DM_E_NOT_CONNECTED No connection to data manager

DM_E_PARAM Invalid parameter
DM_E_OOM Out of memory

Required files
dmclient_exstr.h
dmclient.lib
dmclient.dll

Related functions

DMSetValueExStr Change tag values

DMSetValueWaitExStr Change tag values with notification
DMSetValueWaitMessageExStr Change tag values with notification and alarm out‐
put

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1743
Runtime API
3.2 Data management functions

3.2.6.26 DMSetValueWait

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,
LPDM_VARKEY lpdmVarKey,
DWORD dwItems,
LPVARIANT lpdmValue,
DWORD dwTimeOut,
DM_COMPLETITION_PROC lpfnCompletition,
LPVOID lpvUser,
LPCMN_ERROR lpdmError);

Parameters

pdwTAID
Pointer to a tag that contains the transaction ID assigned by the data manager after a
successful call of the function.

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.

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.
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.

WinCC Engineering V18 – Programming reference

1744 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

In rare cases, the Notify may already be delivered before the function call has returned.

lpvUser
Pointer to application-specific data. This pointer is not evaluated by the function but provided
again in the callback function.

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
Tags changed.

FALSE
The error which occurred can be identified by means of the error structures.

Comment
You can find more information about changing tag values at the DMSetValue function.

Error messages

DM_E_NOT_CONNECTED No connection to data manager

DM_E_PARAM Invalid parameter

Required files
dmclient.h
dmclient.lib
dmclient.dll

Related functions

DMSetValue (Page 1734) Change tag values

DMSetValueMessage (Page 1740) Change tag values with alarm output
DMSetValueWaitMessage (Page 1749) Change tag values with notification and alarm out‐
put
DM_COMPLETITION_PROC (Page 1754) Change tag values (callback)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1745
Runtime API
3.2 Data management functions

Examples
OnTestVariablenSetvaluewait (Page 1860) "TESTCDoc.cpp"

See also
DM_VARKEY (Page 1594)
DMGetValueWait (Page 1704)
DMGetValueWaitEx (Page 1706)
DMSetValue (Page 1734)
DMSetValueMessage (Page 1740)
DMSetValueWaitMessage (Page 1749)
DM_COMPLETITION_PROC (Page 1754)
OnTestVariablenSetvaluewait (Page 1860)

3.2.6.27 DMSetValueWaitExStr

Declaration (

BOOL DMSetValueWaitExStr (
LPDWORD pdwTAID,
LPVARIANT lpvdmVarKey,
DWORD dwItems,
LPVARIANT lpvdmValue,
LPDWORD lpdwState,
DWORD dwTimeOut,
DM_COMPLETITION_PROC lpfnCompletition,
LPVOID lpvUser,
LPCMN_ERROR lpdmError);

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.

WinCC Engineering V18 – Programming reference

1746 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

Parameters

pdwTAID
Pointer to a tag that contains the transaction ID assigned by the data manager after a
successful call of the function.

lpvdmVarKey
Pointer to VARIANT with VT_ARRAY | VT_VARIANT for passing on the tag list or single
VARIANT if 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.
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
Pointer to the first of the new values for the tags to be changed.

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_NOT_ESTABLISHED (0x0001) Connection to partner not established

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) Conversion error display (in connec‐
tion with DM_VARSTATE_..._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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1747
Runtime API
3.2 Data management functions

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

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.

lpfnCompletition
Pointer to the callback function which is called either after all requested tags have been
updated or after the waiting time has expired.
If a program requests a notify routine, it has to clear its message queue at regular intervals.
Unread messages could block WinCC notifications or finally block WinCC altogether.
On rare occasions, the notify may be returned before the function call has returned.

lpvUser
Pointer to application-specific data. The function does not evaluate this pointer, but makes it
available again within the callback function.

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
Tags have been changed

FALSE
The error which occurred can be identified by means of the error structures.

Comment
For more information on changing the values of tags refer to the DMSetValueExStr function.

Error messages

DM_E_NOT_CONNECTED No connection to data manager

DM_E_PARAM Invalid parameter

Required files
dmclient_exstr.h

WinCC Engineering V18 – Programming reference

1748 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

dmclient.lib
dmclient.dll

Related functions

DMSetValueExStr Change tag values

DMSetValueMessageExStr Change tag values with alarm output
DMSetValueWaitMessageExStr Change tag values with notification and alarm out‐
put
DM_COMPLETITION_PROC Change tag values (callback)

Examples
You can find samples on the DMGetValueExStr page.

3.2.6.28 DMSetValueWaitMessage

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,
LPDM_VARKEY lpdmVarKey,
LPVARIANT lpdmValue,
DWORD dwTimeOut,
DM_COMPLETITION_PROC lpfnCompletition,
DWORD fFlags,
LPSTR lpszMessage,
LPVOID lpvUser,
LPCMN_ERROR lpdmError);

Parameters

pdwTAID
Pointer to a tag that contains the transaction ID assigned by the data manager after a
successful call of the function.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1749
Runtime API
3.2 Data management functions

lpdmVarKey
Pointer to the DM_VARKEY (Page 1594) structure that identifies the tag to be changed.

lpdmValue
Pointer to the new value of the tag to be changed.

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.
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.

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
Alarm text that is output.

lpvUser
Pointer to application-specific data. This pointer is not evaluated by the function but provided
again in the callback function.

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
Tags changed.

FALSE
Error.

Comment
You can find more information about changing tag values at the DMSetValue function.

WinCC Engineering V18 – Programming reference

1750 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

Error messages

DM_E_NOT_CONNECTED No connection to data manager

DM_E_PARAM Invalid parameter
DM_E_OOM Out of memory

Required files
dmclient.h
dmclient.lib
dmclient.dll

Related functions

DM_COMPLETITION_PROC (Page 1754) Change tag values (callback)

DMSetValue (Page 1734) Change tag values
DMSetValueMessage (Page 1740) Change tag values with alarm output
DMSetValueWait (Page 1744) Change tag values with notification

See also
DM_VARKEY (Page 1594)
DMSetValue (Page 1734)
DMSetValueMessage (Page 1740)
DMSetValueWait (Page 1744)
OnTestVariablenSetvaluewait (Page 1860)
DM_COMPLETITION_PROC (Page 1754)

3.2.6.29 DMSetValueWaitMessageExStr

Declaration

BOOL DMSetValueWaitMessageExStr (
LPDWORD pdwTAID,
LPVARIANT lpvdmVarKey,
LPVARIANT lpvdmValue,
DWORD dwTimeOut,
DM_COMPLETITION_PROC lpfnCompletition,
DWORD fFlags,
LPTSTR lpszMessage,
LPVOID lpvUser,
LPCMN_ERROR lpdmError);

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1751
Runtime API
3.2 Data management functions

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
Pointer to a tag that contains the transaction ID assigned by the data manager after a
successful call of the function.

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.
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.
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" ).

lpvdmValue
Pointer to the new value of the tag to be changed.

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.

lpfnCompletition
Pointer to the callback function which is called either after all requested tags have been
updated or after the waiting time has expired.
If a program requests a notify routine, it has to clear its message queue at regular intervals.
Unread messages could block WinCC notifications or finally block WinCC altogether.
On rare occasions, the notify may be returned before the function call has returned.

WinCC Engineering V18 – Programming reference

1752 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

fFlags
fFlags specifies how to process the alarm text:

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.

lpvUser
Pointer to application-specific data. This pointer is not evaluated by the function but provided
again in the callback function.

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
Tags have been changed

FALSE
Error

Comment
For more information on changing the values of tags refer to the DMSetValueExStr function.

Error messages

DM_E_NOT_CONNECTED No connection to data manager

DM_E_PARAM Invalid parameter
DM_E_OOM Out of memory

Required files
dmclient_exstr.h
dmclient.lib
dmclient.dll

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1753
Runtime API
3.2 Data management functions

Related functions

DM_COMPLETITION_PROC Change tag values (callback)

DMSetValueExStr Change tag values
DMSetValueMessageExStr Change tag values with alarm output
DMSetValueWaitExStr Change tag values with notification

3.2.6.30 DM_COMPLETITION_PROC

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,
LPDWORD lpdmVarState,
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_NOT_ESTABLISHED (0x0001) Connection to partner not established

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_VARSTATE_..._RANGE)

WinCC Engineering V18 – Programming reference

1754 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

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

dwItems
Number of tag changes, the status of which is passed in lpdmVarState.

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
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.

Required files
dmclient.h

Related functions

DMSetValueWait (Page 1744) Change tag values with notification

DMSetValueWaitMessage (Page 1749) Change tag values with notification and alarm out‐
put

See also
DMSetValueWait (Page 1744)
DMSetValueWaitMessage (Page 1749)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1755
Runtime API
3.2 Data management functions

3.2.6.31 DMShowVarPropertiesExStr

Declaration

BOOL DMShowVarPropertiesExStr (
LPCTSTR lpszProjectFile,
HWND hwndParent,
LPCTSTR lpszVariableName,
DWORD dwVariableID,
LPCMN_ERROR lpdmError);

Description
This function opens the dialog box for editing the properties of tags.

Parameters

lpszProjectFile
Pointer to the name of the project file, including path and extension.
The name of the project file can be retrieved with DMEnumOpenedProjects, or with
DMGetRuntimeProject in Runtime.

hwndParent
Handle to the window that is used as the parent window for the dialog.

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
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
Close the dialog with "OK".

WinCC Engineering V18 – Programming reference

1756 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

FALSE
Error or close dialog with "Cancel"

Error messages

DM_E_NOT_CONNECTED No connection to data manager

DM_E_INVALID_KEY Tag not found
DM_E_CANCEL User has selected "Cancel" in a dialog
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:
#include "apdefap.h"
void OnClick(char* lpszPictureName, char* lpszObjectName, char*
lpszPropertyName)
{
BOOL bRet = FALSE;
CHAR szProjectName[256];
CHAR szVariableName[256];
DWORD dwVariableID;
CMN_ERROR err;
HWND hwndParent;

szProjectName[0] = 0;
szVariableName[0] = 0;
dwVariableID = 0L;
memset(&err, 0, sizeof(err));
hwndParent = NULL;

printf("\r\n\r\n########## enter Test with DMShowVarDatabaseExStr

##########");

bRet = DMGetRuntimeProject(szProjectName, 256, &err);

if (!bRet)
{
printf("\r\n error DMGetRuntimeProject =>[%s],
err=%ld,%ld,%ld,%ld,%ld,[%s]", szProjectName,
err.dwError1, err.dwError2, err.dwError3, err.dwError4,
err.dwError5, err.szErrorText);
}

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1757
Runtime API
3.2 Data management functions

memset(&err, 0, sizeof(err));

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]",
err.dwError1, err.dwError2, err.dwError3, err.dwError4,
err.dwError5, err.szErrorText);
}
else
{
printf("\r\n DMShowVarPropertiesExStr OK!");
}

strncpy(szVariableName, GetTagChar("szVarKeyName_1"), 255);

szVariableName[255] = 0;

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]",
err.dwError1, err.dwError2, err.dwError3, err.dwError4,
err.dwError5, err.szErrorText);
}
else
{
printf("\r\n DMShowVarPropertiesExStr OK!");
}

printf("\r\n########## exit Test with DMShowVarProperitesExStr

##########\r\n");
}

3.2.6.32 DMShowVarDatabase

Use
This function opens the tag selection dialog for the project specified. Only one tag is selected,
in contrast to the ShowVarDatabaseMulti function.

WinCC Engineering V18 – Programming reference

1758 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

Declaration

BOOL DMShowVarDatabase (
LPCSTR lpszProjectFile,
HWND hwndParent,
LPDM_DLGOPTIONS lpdmOptions,
LPDM_VARFILTER lpdmFilter,
LPDM_VARKEY lpdmVarKey,
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.

hwndParent
Handle to the window that is used as the parent window for the dialog.

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
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
Close the dialog with "OK".

FALSE
Error or close dialog with "Cancel".

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1759
Runtime API
3.2 Data management functions

Error messages

DM_E_NOT_CONNECTED No connection to data manager

DM_E_INV_PRJ Specified project not found / loaded

Required files
dmclient.h
dmclient.lib
dmclient.dll

Related functions

DMShowVarDatabaseMulti (Page 1763) Open tag selection dialog

See also
DM_VARKEY (Page 1594)
DM_VARFILTER (Page 1586)
DM_DLGOPTIONS (Page 1572)
DMShowVarDatabaseMulti (Page 1763)

3.2.6.33 DMShowVarDatabaseExStr

Declaration

BOOL DMShowVarDatabaseExStr (
LPCTSTR lpszProjectFile,
HWND hwndParent,
LPDM_DLGOPTIONS lpdmOptions,
LPDM_VARFILTER lpdmFilter,
LPTSTR* lppszVariableName,
LPDWORD lpdwVarNameCharCount,
LPDWORD lpdwVariableID,
LPCMN_ERROR lpdmError);

Description
This function opens the tag selection dialog for the project specified. In contrast to
ShowVarDatabaseMultiExStr, only one tag can be selected.

WinCC Engineering V18 – Programming reference

1760 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

Parameters

lpszProjectFile
Pointer to the name of the project file, including path and extension.
The name of the project file can be retrieved with DMEnumOpenedProjects, or with
DMGetRuntimeProject in Runtime.

hwndParent
Handle to the window that is used as the parent window for the dialog.

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
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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1761
Runtime API
3.2 Data management functions

Return value

TRUE
Close the dialog with "OK".

FALSE
Error or close dialog with "Cancel".

Error messages

DM_E_NOT_CONNECTED No connection to data manager

DM_E_INV_PRJ Specified project not found / loaded
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:
#include "apdefap.h"
void OnClick(char* lpszPictureName, char* lpszObjectName, char*
lpszPropertyName)
{
BOOL bRet = FALSE;
CMN_ERROR err;
CHAR szProjectName[256];
HWND hwndParent;
CHAR szVariableName[256];
LPSTR pszVariableName;
DWORD dwVarNamCharCount = 256;
DWORD dwVarID = 0L;

szProjectName[0] = 0;
szVariableName[0] = 0;
hwndParent = NULL;
pszVariableName= szVariableName;

WinCC Engineering V18 – Programming reference

1762 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

memset(&err, 0, sizeof(err));

printf("\r\n\r\n########## enter Test with DMShowVarDatabaseExStr

##########");

bRet = DMGetRuntimeProject(szProjectName, 256, &err);

if (!bRet)
{
printf("\r\n error DMGetRuntimeProject =>[%s],
err=%ld,%ld,%ld,%ld,%ld,[%s]", szProjectName,
err.dwError1, err.dwError2, err.dwError3, err.dwError4,
err.dwError5, err.szErrorText);
}

bRet = DMShowVarDatabaseExStr(szProjectName, hwndParent, NULL, NULL,

&pszVariableName, &dwVarNamCharCount,
&dwVarID, &err);
if (!bRet)
{
printf("\r\n error DMShowVarDatabaseExStr:
err=%ld,%ld,%ld,%ld,%ld,[%s]",
err.dwError1, err.dwError2, err.dwError3, err.dwError4,
err.dwError5, err.szErrorText);
}
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

Use
This function opens the tag selection dialog for the project specified. Several tags can be
selected, in contrast to ShowVarDatabase.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1763
Runtime API
3.2 Data management functions

Declaration

BOOL DMShowVarDatabaseMulti (
LPCSTR lpszProjectFile,
HWND hwndParent,
LPDM_DLGOPTIONS lpdmOptions,
LPDM_VARFILTER lpdmFilter,
LPDWORD lpdwItems,
DM_NOTIFY_SELECT_VAR_PROC lpfnVariables,
LPVOID lpvUser,
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.

hwndParent
Handle to the window that is used as the parent window for the dialog.

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
Pointer to application-specific data. This pointer is not evaluated by the function but provided
again in the callback function.

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.

WinCC Engineering V18 – Programming reference

1764 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

Return value

TRUE
Close the dialog with "OK".

FALSE
Error or close dialog with "Cancel".

Error messages

DM_E_NOT_CONNECTED No connection to data manager

DM_E_INV_PRJ Specified project not found / loaded

Required files
dmclient.h
dmclient.lib
dmclient.dll

Related functions

DMShowVarDatabase (Page 1758) Open tag selection dialog

DM_NOTIFY_SELECT_VAR_PROC (Page 1770) Open tag selection dialog (callback)

See also
DM_VARFILTER (Page 1586)
DMShowVarDatabase (Page 1758)
DM_DLGOPTIONS (Page 1572)
DM_NOTIFY_SELECT_VAR_PROC (Page 1770)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1765
Runtime API
3.2 Data management functions

3.2.6.35 DMShowVarDatabaseMultiExStr

Declaration

BOOL DMShowVarDatabaseMultiExStr (
LPCTSTR lpszProjectFile,
HWND hwndParent,
LPDM_DLGOPTIONS lpdmOptions,
LPDM_VARFILTER lpdmFilter,
LPDWORD lpdwItems,
DM_NOTIFY_SELECT_VAR_PROC_EXSTR lpfnVariables,
LPVOID lpvUser,
LPCMN_ERROR lpdmError);

Description
This function opens the tag selection dialog for the project specified. In contrast to
ShowVarDatabaseExStr, multiple tags can be selected.

Parameters

lpszProjectFile
Pointer to the name of the project file, including path and extension.
The name of the project file can be retrieved with DMEnumOpenedProjects, or with
DMGetRuntimeProject in Runtime.

hwndParent
Handle to the window that is used as the parent window for the dialog.

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.

WinCC Engineering V18 – Programming reference

1766 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

lpvUser
Pointer to application-specific data. The function does not evaluate this pointer, but makes it
available again within the callback function.

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
Close the dialog with "OK".

FALSE
Error or close dialog with "Cancel".

Error messages

DM_E_NOT_CONNECTED No connection to data manager

DM_E_INV_PRJ Specified project not found / loaded

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:
#include "apdefap.h"
void OnClick(char* lpszPictureName, char* lpszObjectName, char*
lpszPropertyName)
{
extern BOOL DM_NotifySelectVarProcA(LPCSTR lpszVariableName, DWORD
dwVariableID, LPVOID lpvUser);

BOOL bRet = FALSE;

CMN_ERROR err;
CHAR szProjectName[256];

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1767
Runtime API
3.2 Data management functions

HWND hwndParent;
DWORD dwItems;
DWORD dwInxDecr;

szProjectName[0] = 0;
hwndParent = NULL;
memset(&err, 0, sizeof(err));
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 ##########");

bRet = DMGetRuntimeProject(szProjectName, 256, &err);

if (!bRet)
{
printf("\r\n error DMGetRuntimeProject =>[%s],
err=%ld,%ld,%ld,%ld,%ld,[%s]", szProjectName,
err.dwError1, err.dwError2, err.dwError3, err.dwError4,
err.dwError5, err.szErrorText);
}

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]",
err.dwError1, err.dwError2, err.dwError3, err.dwError4,
err.dwError5, err.szErrorText);
}
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;

WinCC Engineering V18 – Programming reference

1768 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

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(3 == *pdwInxDecr )
{
SetTagChar("szVarKeyName_3",lpszVariableName);
SetTagDWord("dwVarKeyID_3",dwVariableID);
printf("\r\n save in szVarKeyName_3 and
dwVarKeyID_3");
}
if(2 == *pdwInxDecr )
{
SetTagChar("szVarKeyName_2",lpszVariableName);
SetTagDWord("dwVarKeyID_2",dwVariableID);
printf("\r\n save in szVarKeyName_2 and
dwVarKeyID_2");
}
if(1 == *pdwInxDecr )
{
SetTagChar("szVarKeyName_1",lpszVariableName);
SetTagDWord("dwVarKeyID_1",dwVariableID);
printf("\r\n save in szVarKeyName_1 and
dwVarKeyID_1");
}
}
if (pdwInxDecr && (0L < *pdwInxDecr))
{
*pdwInxDecr = *pdwInxDecr - 1L;
printf("\r\n Inx=%ld", *pdwInxDecr);
}

printf("\r\n#### DM_NotifySelectVarProc exit ####\r\n");

return bRet;
}

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1769
Runtime API
3.2 Data management functions

3.2.6.36 DM_NOTIFY_SELECT_VAR_PROC

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) (
LPDM_VARKEY lpdmVarKey,
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
Pointer to application-specific data. This pointer is made available again in the callback
function.

Return value

TRUE
The enumeration is continued.

FALSE
The enumeration is cancelled.

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

WinCC Engineering V18 – Programming reference

1770 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

Required files
dmclient.h

Related functions

DMShowVarDatabaseMulti (Page 1763) Open tag selection dialog

See also
DM_VARKEY (Page 1594)
DMShowVarDatabaseMulti (Page 1763)

3.2.6.37 GAPICreateNewVariable

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,
LPCMN_ERROR lpdmError);

Parameters

pData
Pointer to the MCP_NEWVARIABLE_DATA (Page 1598) structure with the data of the tag.

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
Tag created.
When checked: Tag does not yet exist.

FALSE
Error.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1771
Runtime API
3.2 Data management functions

When checked with Errorcode1 = DM_E_ALREADY_EXIST: Tag exists

Comment
There are more advanced functions.

GAPICreateNewVariable4
GAPICreateNewVariableEx4
GAPICreateNewVariable5

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

GAPICreateNewVariable4 (Page 1772) Create tag

GAPICreateNewVariableEx4 (Page 1775) Create tag with Creator ID
GAPICreateNewVariable5 (Page 1774) Create tag with Creator ID

See also
MCP_NEWVARIABLE_DATA (Page 1598)
GAPICreateNewVariable4 (Page 1772)
GAPICreateNewVariable5 (Page 1774)
GAPICreateNewVariableEx4 (Page 1775)

3.2.6.38 GAPICreateNewVariable4

Use
Creates a new tag or check whether a tag exists. This function can only be used for temporary
$ tags.
This function differs from GAPICreateNewVariable due to the additional specification of
scaling information.

WinCC Engineering V18 – Programming reference

1772 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

Declaration

BOOL GAPICreateNewVariable4 (
LPMCP_NEWVARIABLE_DATA_4 pData,
LPCMN_ERROR lpdmError);

Parameters

pData
Pointer to the MCP_NEWVARIABLE_DATA_4 (Page 1600) structure with the data of the tag.

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
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.

GAPICreateNewVariableEx4 Create tag with Creator ID

GAPICreateNewVariable5 Create tag with Creator ID

Error messages

DM_E_NOT_CONNECTED No connection to data manager

DM_E_ALREADY_EXIST Object to be created already exists

Required files
dmclient.h
dmclient.lib
dmclient.dll

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1773
Runtime API
3.2 Data management functions

Related functions

GAPICreateNewVariable (Page 1771) Create tag

GAPICreateNewVariableEx4 (Page 1775) Create tag with Creator ID
GAPICreateNewVariable5 (Page 1774) Create tag with Creator ID

See also
GAPICreateNewVariable (Page 1771)
MCP_NEWVARIABLE_DATA_4 (Page 1600)
GAPICreateNewVariable5 (Page 1774)
GAPICreateNewVariableEx4 (Page 1775)

3.2.6.39 GAPICreateNewVariable5

Use
Creates a new tag or check whether a tag exists. This function can only be used for temporary
$ 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,
LPMCP_NEWVARIABLE_DATA_5 pData,
LPCMN_ERROR lpdmError);

Parameters

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.

pData
Pointer to the MCP_NEWVARIABLE_DATA_5 (Page 1602) structure with the data of the tag.

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.

WinCC Engineering V18 – Programming reference

1774 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

Return value

TRUE
Tag created.
When checked: Tag does not yet exist.

FALSE
Error.
When checked with Errorcode1 = DM_E_ALREADY_EXIST: Tag exists.

Error messages

DM_E_NOT_CONNECTED No connection to data manager

DM_E_ALREADY_EXIST Object to be created already exists

Required files
dmclient.h
dmclient.lib
dmclient.dll

Related functions

GAPICreateNewVariable (Page 1771) Create tag

GAPICreateNewVariable4 (Page 1772) Create tag
GAPICreateNewVariableEx4 (Page 1775) Create tag with Creator ID

See also
GAPICreateNewVariable (Page 1771)
GAPICreateNewVariable4 (Page 1772)
MCP_NEWVARIABLE_DATA_5 (Page 1602)
GAPICreateNewVariableEx4 (Page 1775)
MCP_VARIABLE_LIMITS5 (Page 1614)

3.2.6.40 GAPICreateNewVariableEx4

Use
Creates a new tag or check whether a tag exists. This function can only be used for temporary
$ tags.
This function differs from GAPICreateNewVariable4 due to the specification of the creator ID.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1775
Runtime API
3.2 Data management functions

Declaration

BOOL GAPICreateNewVariableEx4 (
DWORD dwCreatorID,
LPMCP_NEWVARIABLE_DATA_4 pData,
LPCMN_ERROR lpdmError);

Parameters

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.

pData
Pointer to the MCP_NEWVARIABLE_DATA_4 (Page 1600) structure with the data of the tag.

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
Tag created.
When checked: Tag does not yet exist.

FALSE
Error.
When checked with Errorcode1 = DM_E_ALREADY_EXIST: Tag exists.

Comment
There is an advanced function.

GAPICreateNewVariable5

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

WinCC Engineering V18 – Programming reference

1776 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

dmclient.lib
dmclient.dll

Related functions

GAPICreateNewVariable (Page 1771) Create tag

GAPICreateNewVariable4 (Page 1772) Create tag
GAPICreateNewVariable5 (Page 1774) Create tag with Creator ID

See also
GAPICreateNewVariable (Page 1771)
GAPICreateNewVariable4 (Page 1772)
MCP_NEWVARIABLE_DATA_4 (Page 1600)
GAPICreateNewVariable5 (Page 1774)

3.2.7 Functions for processing structured tags

3.2.7.1 GAPIEnumTypeMembers

Use
The function returns the names of the tags belonging to a structured tag.

Declaration

BOOL GAPIEnumTypeMembers (
LPCSTR lpszProjectFile,
LPCSTR lpszTypeName,
DM_ENUM_TYPEMEMBERS_PROC lpfnCallback,
LPVOID lpvUser,
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 runtime.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1777
Runtime API
3.2 Data management functions

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 specification is
rejected with the error, DM_E_NOT_CONNECTED.

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
Pointer to application-specific data. This pointer is not evaluated by the function but provided
again in the callback function.

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
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 (Page 1780) List tags in a structured tag
GAPIEnumTypeMembersEx4 List tags in a structured tag
(Page 1785)

WinCC Engineering V18 – Programming reference

1778 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

See also
DM_ENUM_TYPEMEMBERS_PROC (Page 1779)
GAPIEnumTypeMembersEx (Page 1780)
GAPIEnumTypeMembersEx4 (Page 1785)

3.2.7.2 DM_ENUM_TYPEMEMBERS_PROC

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
Pointer to application-specific data. This pointer is made available again in the callback
function.

Return value

TRUE
The enumeration is continued.

FALSE
The enumeration is cancelled.

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
• ODK functions from the same DLL
• Enumerations that call other enumerations

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1779
Runtime API
3.2 Data management functions

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

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 (
LPCSTR lpszProjectFile,
LPCSTR lpszTypeName,
DM_ENUM_TYPEMEMBERS_PROC_EX lpfnCallback,
LPVOID lpvUser,
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 runtime.
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 specification is
rejected with the error, DM_E_NOT_CONNECTED.

WinCC Engineering V18 – Programming reference

1780 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

lpszTypeName
Name of a type of structured tag whose tags are to be listed.
Only local tags can be enumerated on clients.

lpfnCallback
Pointer to your callback function that is called for every tag.

lpvUser
Pointer to application-specific data. This pointer is not evaluated by the function but provided
again in the callback function.

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
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

DM_ENUM_TYPEMEMBERS_PROC_EX List tags in a structured tag (callback)

(Page 1783)
GAPIEnumTypeMembers (Page 1777) List tags in a structured tag
GAPIEnumTypeMembersEx4 (Page 1785) List tags in a structured tag

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1781
Runtime API
3.2 Data management functions

See also
GAPIEnumTypeMembers (Page 1777)
DM_ENUM_TYPEMEMBERS_PROC_EX (Page 1783)
GAPIEnumTypeMembersEx4 (Page 1785)

3.2.7.4 GAPIEnumTypeMembersExStr

Declaration

BOOL GAPIEnumTypeMembersExStr (
LPCTSTR lpszProjectFile,
LPCTSTR lpszTypeName,
DM_ENUM_TYPEMEMBERS_PROC_EXSTR lpfnCallback,
LPVOID lpvUser,
LPCMN_ERROR lpdmError);

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
Pointer to the name of the project file, including path and extension.
The name of the project file can be retrieved with DMEnumOpenedProjects, or with
DMGetRuntimeProject in Runtime.
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.

WinCC Engineering V18 – Programming reference

1782 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

lpvUser
Pointer to application-specific data. The function does not evaluate this pointer, but makes it
available again within the callback function.

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
Tags of a structured tag have been enumerated

FALSE
Error

Required files
dmclient_exstr.h
dmclient.lib
dmclient.dll

Related functions

DM_ENUM_TYPEMEMBERS_PROC_EXSTR List tags in a structured tag (callback)

GAPIEnumTypeMembersEx4 List tags in a structured tag

3.2.7.5 DM_ENUM_TYPEMEMBERS_PROC_EX

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) (
LPDM_VARKEY lpdmVarKey,
LPMCP_NEWVARIABLE_DATA_EX lpdmVarDataEx,
LPVOID lpvUser );

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1783
Runtime API
3.2 Data management functions

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
Pointer to application-specific data. This pointer is made available again in the callback
function.

Return value

TRUE
The enumeration is continued.

FALSE
The enumeration is cancelled.

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

Required files
dmclient.h

Related functions

GAPIEnumTypeMembersEx List tags in a structured tag

(Page 1780)

See also
GAPIEnumTypeMembersEx (Page 1780)
MCP_NEWVARIABLE_DATA_EX (Page 1604)

WinCC Engineering V18 – Programming reference

1784 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

3.2.7.6 GAPIEnumTypeMembersEx4

Use
The function returns a complete description, including all the predefined values of tags
belonging to a structured tag.

Declaration

BOOL GAPIEnumTypeMembersEx4 (
LPCSTR lpszProjectFile,
LPCSTR lpszTypeName,
DM_ENUM_TYPEMEMBERS_PROC_EX4 lpfnCallback,
LPVOID lpvUser,
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 runtime.
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 specification is
rejected (DM_E_NOT_CONNECTED).

lpszTypeName
Name of a type of structured tag whose tags are to be listed.
Only local tags can be enumerated on clients.

lpfnCallback
Pointer to your callback function that is called for every tag.

lpvUser
Pointer to application-specific data. This pointer is not evaluated by the function but provided
again in the callback function.

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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1785
Runtime API
3.2 Data management functions

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)
GAPIEnumTypeMembers (Page 1777) List tags in a structured tag

See also
GAPIEnumTypeMembers (Page 1777)
GAPIEnumTypeMembersEx (Page 1780)
DM_ENUM_TYPEMEMBERS_PROC_EX4 (Page 1786)

3.2.7.7 DM_ENUM_TYPEMEMBERS_PROC_EX4

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) (
LPDM_VARKEY lpdmVarKey,
LPMCP_NEWVARIABLE_DATA_EX4 lpdmVarDataEx,
LPVOID lpvUser );

WinCC Engineering V18 – Programming reference

1786 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

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
Pointer to application-specific data. This pointer is made available again in the callback
function.

Return value

TRUE
The enumeration is continued.

FALSE
The enumeration is cancelled.

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

Required files
dmclient.h

Related functions

GAPIEnumTypeMembersEx4 List tags in a structured tag

(Page 1785)

See also
GAPIEnumTypeMembersEx4 (Page 1785)
DM_VARKEY (Page 1594)
MCP_NEWVARIABLE_DATA_EX4 (Page 1606)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1787
Runtime API
3.2 Data management functions

3.2.7.8 GAPIEnumTypes

Use
This function lists the names and ID numbers of the configured structured tag types.

Declaration

BOOL GAPIEnumTypes (
LPCSTR lpszProjectFile,
DM_ENUM_TYPES_PROC lpfnCallback,
LPVOID lpvUser,
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 runtime.
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 specification is
rejected with the error, DM_E_NOT_CONNECTED.

lpfnCallback
Pointer to your callback function, which receives the data of the tag types.

lpvUser
Pointer to application-specific data. This pointer is not evaluated by the function but provided
again in the callback function.

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
Types of structured tags listed.

FALSE
Error.

WinCC Engineering V18 – Programming reference

1788 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

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

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) (
LPCSTR lpszTypeName,
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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1789
Runtime API
3.2 Data management functions

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.

lpvUser
Pointer to application-specific data. This pointer is made available again in the callback
function.

Return value

TRUE
The enumeration is continued.

FALSE
The enumeration is cancelled.

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

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)

WinCC Engineering V18 – Programming reference

1790 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

3.2.8 Functions for processing connections

3.2.8.1 DMEnumConnectionData

Use
The function determines the information about a configured logical connection.

Declaration

BOOL DMEnumConnectionData (
LPCSTR lpszProjectFile,
LPDM_CONNKEY lpdmConnKey,
DWORD dwItems,
DM_ENUM_CONNECTION_PROC lpfnCallback,
LPVOID lpvUser,
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 runtime.

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
Pointer to application-specific data. This pointer is not evaluated by the function but provided
again in the callback function.

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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1791
Runtime API
3.2 Data management functions

Return value

TRUE
Data listed.

FALSE
Error.

Error messages

DM_E_NOT_CONNECTED No connection to data manager

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)
DM_ENUM_CONNECTION_PROC (Page 1794)
Enumerate all connections (Page 1834)
OnTestEnumConnectionDataAll (Page 1839)

WinCC Engineering V18 – Programming reference

1792 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

3.2.8.2 DMEnumConnectionDataExStr

Declaration

BOOL DMEnumConnectionDataExStr (
LPCTSTR lpszProjectFile,
DM_ENUM_CONNECTION_PROC_EXSTR lpfnCallback,
LPVOID lpvUser,
LPDWORD lpdwConnectionCount,
LPCMN_ERROR lpdmError);

Description
This function is used to determine all configured logical connections.

Parameters

lpszProjectFile
Pointer to the name of the project file, including path and extension.
The name of the project file can be retrieved with DMEnumOpenedProjects, or with
DMGetRuntimeProject in Runtime.

lpfnCallback
Pointer to your callback function which receives the data of the logical connection.

lpvUser
Pointer to application-specific data. The function does not evaluate this pointer, but makes it
available again within the callback function.

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
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
Data have been enumerated

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1793
Runtime API
3.2 Data management functions

FALSE
Error

Error messages

DM_E_NOT_CONNECTED No connection to data manager

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

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
Pointer to application-specific data. This pointer is made available again in the callback
function.

WinCC Engineering V18 – Programming reference

1794 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

Return value

TRUE
The enumeration is continued.

FALSE
The enumeration is cancelled.

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

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)
DMEnumConnectionData (Page 1791)
Enumerate all connections (Page 1834)

3.2.9 Functions for the work platform

3.2.9.1 DMGetOSVersion

Use
Determines the operating system used on the PC.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1795
Runtime API
3.2 Data management functions

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 0x060 Windows Vista 32-bit
01
DM_OS_VISTA_SP1_32 0x060 Windows Vista 32-bit Service Pack 1
11
DM_OS_VISTA_SP2_32 0x060 Windows Vista 32-bit Service Pack 2
21
DM_OS_VISTA_64 0x960 Windows Vista 64-bit
01
DM_OS_VISTA_SP1_64 0x960 Windows Vista 64-bit Service Pack 1
11
DM_OS_VISTA_SP2_64 0x960 Windows Vista 64-bit Service Pack 2
21
DM_OS_S2008_32 0x060 Windows Server 2008 32-bit
03
DM_OS_S2008_SP1_32 0x060 Windows Server 2008 32-bit Service Pack 1
13
DM_OS_S2008_SP2_32 0x060 Windows Server 2008 32-bit Service Pack 2
23
DM_OS_S2008_64 0x960 Windows Server 2008 64-bit
03
DM_OS_S2008_SP1_64 0x960 Windows Server 2008 64-bit Service Pack 1
13
DM_OS_S2008_SP2_64 0x960 Windows Server 2008 64-bit Service Pack 2
23
DM_OS_W7_32 0x061 Windows 7 32-bit
01

WinCC Engineering V18 – Programming reference

1796 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

DM_OS_W7_SP1_32 0x061 Windows 7 32-bit Service Pack 1

11
DM_OS_W7_64 0x961 Windows 7 64-bit
01
DM_OS_W7_SP1_64 0x961 Windows 7 64-bit Service Pack 1
11
DM_OS_S2008R2_32 0x061 Windows Server 2008 R2 (32-bit)
03
DM_OS_S2008R2_SP1_32 0x061 Windows Server 2008 R2 32-bit Service Pack 1
13
DM_OS_S2008R2_64 0x961 Windows Server 2008 R2 (64-bit)
03
DM_OS_S2008R2_SP1_64 0x961 Windows Server 2008 R2 64-bit Service Pack 1
13
DM_OS_W8_32 0x062 Windows 8 (32-bit)
01
DM_OS_W8_64 0x962 Windows 8 (64-bit)
01
DM_OS_S2012_32 0x062 Windows Server 2012 32-bit
03
DM_OS_S2012_64 0x962 Windows Server 2012 64-bit
03
DM_OS_W81_32 0x063 Windows 8.1 (32-bit)
01
DM_OS_W81_64 0x963 Windows 8.1 (64-bit)
01
DM_OS_S2012R2_32 0x063 Windows Server 2012 R2 (32-bit)
03
DM_OS_S2012R2_64 0x963 Windows Server 2012 R2 (64-bit)
03
DM_OS_W10_64 0x964 Windows 10 (64-bit)
01
DM_OS_S2016_64 0x964 Windows Server 2016 64-bit
03

Required files
dmclient.h
dmclient.lib
dmclient.dll

3.2.9.2 DMGetSystemLocale

Use
Gets the code of the currently used configuration language.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1797
Runtime API
3.2 Data management functions

Declaration

BOOL DMGetSystemLocale (
LPDWORD lpdwLocaleID,
LPCMN_ERROR lpdmError);

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
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
Currently used configuration language determined.

FALSE
Error

Error messages

DM_E_NOT_CONNECTED No connection to data manager

Required files
dmclient.h
dmclient.lib
dmclient.dll

Examples
OnTestSystemLocale (Page 1845) "TESTCDoc.cpp"

WinCC Engineering V18 – Programming reference

1798 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

See also
OnTestSystemLocale (Page 1845)

3.2.9.3 DMSetLanguage

Use
Switches the configuration language.

Declaration

BOOL DMSetLanguage (
DWORD dwLocaleID,
LPCMN_ERROR lpdmError );

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
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
Language switched.

FALSE
Error.

Error messages

DM_E_NOT_SUPPORTED Requested service unavailable

Required files
dmclient.h

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1799
Runtime API
3.2 Data management functions

dmclient.lib
dmclient.dll

3.2.9.4 DMShowLanguageDialog

Use
The function opens a dialog box for selecting the language.

Declaration

BOOL DMShowLanguageDialog (
HWND hwndParent,
DWORD dwFlags,
DWORD dwSetLocaleIDs[],
UINT uSetIDArraySize,
LPDWORD lpdwGetLocaleID,
LPCMN_ERROR lpdmError);

Parameters

hwndParent
Handle to the window that is used as the parent window for the dialog.

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 dis‐
played, 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.

WinCC Engineering V18 – Programming reference

1800 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

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
Close the dialog with "OK".

FALSE
Error or close dialog with "Cancel".

Error messages

DM_E_CANCEL User has selected "Cancel" in a dialog

Required files
dmclient.h
dmclient.lib
dmclient.dll

3.2.10 Functions for updating tags

3.2.10.1 DMBeginStartVarUpdate

Use
Trigger an update request. A transaction ID for identifying transaction is assigned with this
function.

Declaration

BOOL DMBeginStartVarUpdate (
LPDWORD pdwTAID
LPCMN_ERROR lpdmError )

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1801
Runtime API
3.2 Data management functions

Parameters

pdwTAID
Pointer to a tag that contains the transaction ID assigned by the data manager after a
successful call of the function.

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
Transaction ID assigned.

FALSE
Error.

Error messages

DM_E_NOT_CONNECTED No connection to data manager

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)
DMStartVarUpdate (Page 1806)
DMStartVarUpdateEx (Page 1809)
DMStopVarUpdate (Page 1821)
DMSuspendVarUpdate (Page 1823)

WinCC Engineering V18 – Programming reference

1802 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

3.2.10.2 DMEndStartVarUpdate

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,
LPCMN_ERROR lpdmError );

Parameters

dwTAID
dwTAID contains the transaction ID assigned with the call of the DMBeginStartVarUpdate
function.

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
Update started.

FALSE
Error.

Error messages

DM_E_NOT_CONNECTED No connection to data manager

DM_E_INVALID_TAID Invalid transaction ID

Required files
dmclient.h

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1803
Runtime API
3.2 Data management functions

Related functions

DMBeginStartVarUpdate (Page 1801) Trigger an update request

DMStartVarUpdate (Page 1806) Define update tags

Examples
OnTestVariablenEndstartvarupdate (Page 1847) "TESTCDoc.cpp"

See also
OnTestVariablenEndstartvarupdate (Page 1847)
DMBeginStartVarUpdate (Page 1801)
DMStartVarUpdate (Page 1806)

3.2.10.3 DMResumeVarUpdate

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,
LPCMN_ERROR lpdmError);

Parameters

dwTAID
dwTAID contains the transaction ID assigned with the call of the DMBeginStartVarUpdate
function.

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.

WinCC Engineering V18 – Programming reference

1804 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

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

DM_E_NOT_CONNECTED No connection to data manager

DM_E_INVALID_TAID Invalid transaction ID

Required files
dmclient.h
dmclient.lib
dmclient.dll

Related functions

DMBeginStartVarUpdate (Page 1801) Trigger an update request

DMSuspendVarUpdate (Page 1823) Stop updating of tags

Examples
OnTestVariablenResumevarupdate (Page 1858) "TESTCDoc.cpp"

See also
DMBeginStartVarUpdate (Page 1801)
DMSuspendVarUpdate (Page 1823)
OnTestVariablenResumevarupdate (Page 1858)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1805
Runtime API
3.2 Data management functions

3.2.10.4 DMStartVarUpdate

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,
LPDM_VARKEY lpdmVarKey,
DWORD dwItems,
DWORD dwCycle,
DM_NOTIFY_VARIABLE_PROC lpfnVariable,
LPVOID lpvUser,
LPCMN_ERROR lpdmError);

Parameters

dwTAID
dwTAID contains the transaction ID assigned with the call of the DMBeginStartVarUpdate
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

WinCC Engineering V18 – Programming reference

1806 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

"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
"User cycle 2" (e.g. 3000) Index: 12
"User cycle 3" (e.g. 4000) Index: 13
"User cycle 4" (e.g. 5000) Index: 14
"User cycle 5" (e.g. 10000) Index: 15

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.
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 notification may already be delivered before the function call returns.

lpvUser
Pointer to application-specific data. This pointer is not evaluated by the function but provided
again in the callback function.

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
Update tags specified.

FALSE
Error.

Required files
dmclient.h
dmclient.lib
dmclient.dll

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1807
Runtime API
3.2 Data management functions

Related functions

DMBeginStartVarUpdate (Page 1801) Trigger an update request

DM_NOTIFY_VARIABLE_PROC (Page 1808) Specify update tags (callback)

See also
DMEndStartVarUpdate (Page 1803)
DM_VARKEY (Page 1594)
DMBeginStartVarUpdate (Page 1801)
DM_NOTIFY_VARIABLE_PROC (Page 1808)

3.2.10.5 DM_NOTIFY_VARIABLE_PROC

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,
LPDM_VAR_UPDATE_STRUCT 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_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
Pointer to application-specific data. This pointer is made available again in the callback
function.

WinCC Engineering V18 – Programming reference

1808 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

Return value
The return values depend on your implementation

Comment

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
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.
In rare cases, the Notify may already be delivered before the function call has returned.

Required files
dmclient.h

Related functions

DMGetValueWait (Page 1704) Get tag values with update

DMStartVarUpdate (Page 1806) Define update tags

See also
DMStartVarUpdate (Page 1806)
DM_VAR_UPDATE_STRUCT (Page 1581)
DMGetValueWait (Page 1704)

3.2.10.6 DMStartVarUpdateEx

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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1809
Runtime API
3.2 Data management functions

Declaration

BOOL DMStartVarUpdateEx (
DWORD dwTAID,
LPDM_VARKEY lpdmVarKey,
DWORD dwItems,
DWORD dwCycle,
DM_NOTIFY_VARIABLEEX_PROC lpfnVariable,
LPVOID lpvUser,
LPCMN_ERROR lpdmError);

Parameters

dwTAID
dwTAID contains the transaction ID assigned with the call of the DMBeginStartVarUpdate
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.

"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
"User cycle 2" (e.g. 3000) Index: 12
"User cycle 3" (e.g. 4000) Index: 13
"User cycle 4" (e.g. 5000) Index: 14
"User cycle 5" (e.g. 10000) Index: 15

WinCC Engineering V18 – Programming reference

1810 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

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.
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.

lpvUser
Pointer to application-specific data. This pointer is not evaluated by the function but provided
again in the callback function.

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
Update tags specified.

FALSE
Error.

Required files
dmclient.h
dmclient.lib
dmclient.dll

Related functions

DMBeginStartVarUpdate (Page 1801) Trigger an update request

DM_NOTIFY_VARIABLEEX_PROC (Page 1819) Specify update tags (callback)

See also
DM_VARKEY (Page 1594)
DMBeginStartVarUpdate (Page 1801)
DM_NOTIFY_VARIABLEEX_PROC (Page 1819)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1811
Runtime API
3.2 Data management functions

3.2.10.7 DMStartVarUpdateExStr

Declaration

BOOL DMStartVarUpdateExStr (
DWORD dwTAID,
DWORD dwFlags,
LPVARIANT lpvdmVarKey,
LPVARIANT lpvCookie,
DWORD dwCycle,
DM_NOTIFY_VARIABLE_PROC_EXSTR lpfnVariable,
LPVOID lpvUser,
LPCMN_ERROR lpdmError);

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
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 VARIANT with VT_ARRAY | VT_VARIANT for passing on the tag list that identifies the
tags to be changed.
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.
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" ).

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.

WinCC Engineering V18 – Programming reference

1812 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

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.

"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
"User cycle 2" (e.g. 3000) Index: 12
"User cycle 3" (e.g. 4000) Index: 13
"User cycle 4" (e.g. 5000) Index: 14
"User cycle 5" (e.g. 10000) Index: 15

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.
If a program requests a notify routine, it has to clear its message queue at regular intervals.
Unread messages could block WinCC notifications or finally block WinCC altogether.

lpvUser
Pointer to application-specific data. The function does not evaluate this pointer, but makes it
available again within the callback function.

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
Update tags have been specified

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1813
Runtime API
3.2 Data management functions

FALSE
Error

Required files
dmclient_exstr.h
dmclient.lib
dmclient.dll

Related functions

DMBeginStartVarUpdate Trigger an update request

Examples
Script sample "Button DMStartVarUpdateExStr":
#include "apdefap.h"
void OnClick(char* lpszPictureName, char* lpszObjectName, char*
lpszPropertyName)
{
#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);
#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;

WinCC Engineering V18 – Programming reference

1814 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

memset(&err, 0, sizeof(err));
bRet = FALSE;
parrayKeys = NULL;
lInx = 0L;
dwFlags = DM_FLAG_RETURN_PROPVARIANT_VT_LPSTR;
//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;
hr = SafeArrayPtrOfIndex(parrayKeys, &lInx, &pvElem);
pvElem->vt = VT_LPSTR;
pvElem->u.pbVal = "dwVal_1";
lInx = 1L;
hr = SafeArrayPtrOfIndex(parrayKeys, &lInx, &pvElem);
pvElem->vt = VT_LPSTR;
pvElem->u.pbVal = "dwVal_2";
lInx = 2L;
hr = SafeArrayPtrOfIndex(parrayKeys, &lInx, &pvElem);
pvElem->vt = VT_LPSTR;
pvElem->u.pbVal = "dwVal_3";
lInx = 3L;
hr = SafeArrayPtrOfIndex(parrayKeys, &lInx, &pvElem);
pvElem->vt = VT_LPSTR;
pvElem->u.pbVal = "dwVal_4";
SafeArrayUnlock(parrayKeys);

bRet = DMBeginStartVarUpdate(&dwTAID, &err);

if (FALSE == bRet)
{
printf("\r\n error DMBeginStartVarUpdate,
err=%ld,%ld,%ld,%ld,%ld,[%s]",

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1815
Runtime API
3.2 Data management functions

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);

memset(&err, 0, sizeof(err));
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,
err.dwError4, err.dwError5, err.szErrorText);
}
else
{
printf("\r\n DMStartVarUpdateExStr (dwTAID=%ld) OK.",
dwTAID);
}

memset(&err, 0, sizeof(err));
bRet = DMEndStartVarUpdate(dwTAID, &err);
if (FALSE == bRet)
{
printf("\r\n error DMEndStartVarUpdate (dwTAID=%ld):
err=%ld,%ld,%ld,%ld,%ld,[%s]",
dwTAID, err.dwError1, err.dwError2, err.dwError3,
err.dwError4, err.dwError5, err.szErrorText);
}
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);

WinCC Engineering V18 – Programming reference

1816 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

Script sample "Project-Function DM_NotifyVariableProcExStr_VarUpdate":

#pragma code ("OleAut32.dll")

//#include "OleAuto.h"
HRESULT VariantChangeType( VARIANTARG FAR* pvargDest, VARIANTARG
FAR* pvarSrc, unsigned short wFlags, VARTYPE vt);
#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);

for (i = 0; i < dwItems; i++)

{
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);

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1817
Runtime API
3.2 Data management functions

printf(", dwNameCharCount=[%ld]",
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":

#include "apdefap.h"
void OnClick(char* lpszPictureName, char* lpszObjectName, char*
lpszPropertyName)
{
DWORD dwTAID;
CMN_ERROR err;
BOOL bRet;

dwTAID = GetTagDWord("dwUpdTAID");
memset(&err, 0, sizeof(err));
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",
dwTAID, err.dwError1, err.dwError2, err.dwError3,
err.dwError4, err.dwError5, err.szErrorText);
memset(&err, 0, sizeof(err));
bRet = DMStopAllUpdates(&err);
if (FALSE == bRet)
{
printf("\r\n!!! error DMStopAllUpdates (dwTAID=%ld):
err=%ld,%ld,%ld,%ld,%ld,[%s] !!!\r\n",
dwTAID, err.dwError1, err.dwError2, err.dwError3,
err.dwError4, err.dwError5,
err.szErrorText);
}
else
{
printf("\r\n DMStopAllUpdates OK.");
}

WinCC Engineering V18 – Programming reference

1818 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

}
else
{
printf("\r\n DMStopVarUpdate (dwTAID=%ld) OK.", dwTAID);
}
}

dwTAID = 0L;

SetTagDWord("dwUpdTAID",dwTAID);
}

3.2.10.8 DM_NOTIFY_VARIABLEEX_PROC

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
Pointer to application-specific data. This pointer is made available again in the callback
function.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1819
Runtime API
3.2 Data management functions

Return value
The return values depend on your implementation

Comment

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
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.
In rare cases, the Notify may already be delivered before the function call has returned.

Required files
dmclient.h

Related functions

DMGetValueWaitEx (Page 1706) Get tag values with update

DMStartVarUpdateEx (Page 1809) Define update tags

See also
DMStartVarUpdateEx (Page 1809)
DM_VAR_UPDATE_STRUCTEX (Page 1583)
DMGetValueWaitEx (Page 1706)

3.2.10.9 DMStopAllUpdates

Use
Stops all tag updates requested by the application. This function should be preferably called after
closing the corresponding module.

WinCC Engineering V18 – Programming reference

1820 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

Declaration

BOOL DMStopAllUpdates (
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
Updating of tags stopped.

FALSE
Error.

Error messages

DM_E_NOT_CONNECTED No connection to data manager

Required files
dmclient.h
dmclient.lib
dmclient.dll

Examples
OnTestVariablenStopallupdates (Page 1861) "TESTCDoc.cpp"

See also
OnTestVariablenStopallupdates (Page 1861)

3.2.10.10 DMStopVarUpdate

Use
Stops the updating of tags for a specific transaction.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1821
Runtime API
3.2 Data management functions

Declaration

BOOL DMStopVarUpdate (
DWORD dwTAID,
LPCMN_ERROR lpdmError);

Parameters

dwTAID
dwTAID contains the transaction ID assigned with the call of the DMBeginStartVarUpdate
function.

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
Updating of tags stopped.

FALSE
Error.

Error messages

DM_E_NOT_CONNECTED No connection to data manager

DM_E_INVALID_TAID Invalid transaction ID

Required files
dmclient.h
dmclient.lib
dmclient.dll

Related functions

DMBeginStartVarUpdate (Page 1801) Trigger an update request

Examples
OnTestVariablenStopvarupdate (Page 1861) "TESTCDoc.cpp"

WinCC Engineering V18 – Programming reference

1822 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

See also
OnTestVariablenStopvarupdate (Page 1861)
DMBeginStartVarUpdate (Page 1801)

3.2.10.11 DMSuspendVarUpdate

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,
LPCMN_ERROR lpdmError);

Parameters

dwTAID
dwTAID contains the transaction ID assigned with the call of the DMBeginStartVarUpdate
function.

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
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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1823
Runtime API
3.2 Data management functions

Error messages

DM_E_NOT_CONNECTED No connection to data manager

DM_E_INVALID_TAID Invalid transaction ID

Required files
dmclient.h
dmclient.lib
dmclient.dll

Related functions

DMBeginStartVarUpdate (Page 1801) Trigger an update request

DMResumeVarUpdate (Page 1804) Continue updating of tags

Examples
OnTestVariablenSuspendvarupdate (Page 1862) "TESTCDoc.cpp"

See also
DMResumeVarUpdate (Page 1804)
DMBeginStartVarUpdate (Page 1801)
OnTestVariablenSuspendvarupdate (Page 1862)

WinCC Engineering V18 – Programming reference

1824 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

3.2.11 Examples

3.2.11.1 Connection to DM

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
{
memset(&Error, 0,sizeof(CMN_ERROR));
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);
}

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1825
Runtime API
3.2 Data management functions

else // already connected

{
_sntprintf_s(szText,_countof(szText), _TRUNCATE, _T("DMGetConnectionState: OK"));
}
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];
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
{
memset(&Error, 0,sizeof(CMN_ERROR));
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);
//printf("%s\r\n",szText);
}
else // already connected
{
_sntprintf_s(szText,_countof(szText), _TRUNCATE, _T("DMGetConnectionState: OK"));
ODKTrace(szText);
}
return(ret);
}

// =====================================================================
// Function: MyDMDisConnect(void) ODK DM CS
// =====================================================================
BOOL MyDMDisConnect(void)
{

WinCC Engineering V18 – Programming reference

1826 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

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"),
Error.dwError1, Error.dwError2, Error.szErrorText);
}
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);
//printf("%s\r\n",szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("********************"));
ODKTrace(szText);
return(TRUE);
}

//{{ODK_EXAMPLE}(END)}

See also
DMConnect (Page 1630)
DMDisconnect (Page 1636)
DMGetConnectionState (Page 1648)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1827
Runtime API
3.2 Data management functions

3.2.11.2 Enum Data of Tags

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"),
Error.dwError1, Error.dwError2, Error.szErrorText);
ODKTrace(szText);

WinCC Engineering V18 – Programming reference

1828 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

}
}
//{{ODK_EXAMPLE}(END)}

See also
DMEnumVarData4 (Page 1679)
DM_ENUM_VARIABLE_PROC4 (Page 1682)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1829
Runtime API
3.2 Data management functions

3.2.11.3 Enum open projects

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];
VOID* pvUser = AfxGetApp();
memset(&Error, 0, sizeof(CMN_ERROR));
ret = MyDMConnect();
if(TRUE == ret)
{
ret = DMEnumOpenedProjects(&dwItems, MyDMEnumOpenProjectsCallback, pvUser, &Error);
if(FALSE == ret)

WinCC Engineering V18 – Programming reference

1830 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in
DMEnumOpenedProjects: E1= 0x%08lx ; E2= 0x%08lx ; %s"), %s",
Error.dwError1, Error.dwError2, Error.szErrorText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("DMEnumOpenedProjects"));
}
ODKTrace(szText);
}
return(ret);
}
//{{ODK_EXAMPLE}(END)}

See also
DMEnumOpenedProjects (Page 1656)
DM_ENUM_OPENED_PROJECTS_PROC (Page 1657)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1831
Runtime API
3.2 Data management functions

3.2.11.4 Enumerate all structured types

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()
{
// #define PROJ_PATH "C:\\siemens\\odk\\samples\\projects\\demo\\odk.mcp"
CMN_ERROR Error;
BOOL ret = FALSE;
TCHAR szText[255];
TCHAR szProjectFile[255];
VOID* pvUser = NULL;
ret = FALSE;
memset(&Error,0,sizeof(CMN_ERROR));
ret = MyDMGetConnectionState(); //check the connection state to DM
if(FALSE != ret)
{
MyDMEnumOpenedProjects(); // open the DM and set the g_szProjectFile
_tcsncpy_s(szProjectFile, _countof(szProjectFile), /*PROJ_PATH*/g_szProjectFile,
_TRUNCATE);
memset(&Error,0,sizeof(CMN_ERROR));
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"),

WinCC Engineering V18 – Programming reference

1832 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

Error.dwError1, Error.dwError2, Error.szErrorText);

}
else
{
_sntprintf_s(szText,_countof(szText), _TRUNCATE, _T("DMEnumTypes"));
}
ODKTrace(szText);
}
}
//{{ODK_EXAMPLE}(END)}

See also
GAPIEnumTypes (Page 1788)
DM_ENUM_TYPES_PROC (Page 1789)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1833
Runtime API
3.2 Data management functions

3.2.11.5 Enumerate all connections

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()
{
// #define PROJ_PATH "C:\\siemens\\odk\\samples\\projects\\demo\\odk.mcp"
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)
{
MyDMEnumOpenedProjects(); // open the DM and set the g_szProjectFile
_tcsncpy_s(szProjectFile, _countof(szProjectFile), /*PROJ_PATH*/g_szProjectFile,
_TRUNCATE);
ret = DMEnumConnectionData(szProjectFile,

WinCC Engineering V18 – Programming reference

1834 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

&ConnKey,
dwItems,
MyDMEnumConnectionCallback,
NULL,
&Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in
DMEnumConnectionData: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("DMEnumConnectionData"));
}
ODKTrace(szText);
}
}
//{{ODK_EXAMPLE}(END)}

See also
DMEnumConnectionData (Page 1791)
DM_ENUM_CONNECTION_PROC (Page 1794)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1835
Runtime API
3.2 Data management functions

3.2.11.6 Inquire project informations

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)
{
// #define PROJ_PATH "C:\\siemens\\odk\\samples\\projects\\demo\\odk.mcp"
CMN_ERROR Error;
BOOL ret = FALSE;
TCHAR szText[255];
TCHAR szProjectFile[_MAX_PATH +1];
VOID* pvUser = AfxGetApp();
DM_PROJECT_INFO Info;
memset(&Error, 0, sizeof(CMN_ERROR));
memset(&Info, 0, sizeof(DM_PROJECT_INFO));
ret = MyDMGetConnectionState(); //check the connection state
if(FALSE != ret)
{
MyDMEnumOpenedProjects(); // open the DM and set the g_szProjectFile
_tcsncpy_s(szProjectFile, _countof(szProjectFile), /*PROJ_PATH*/g_szProjectFile,
_TRUNCATE);
ret = DMGetProjectInformation(szProjectFile, &Info, &Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in
DMGetProjectInformation: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
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);

WinCC Engineering V18 – Programming reference

1836 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

}
}
}
//{{ODK_EXAMPLE}(END)}

See also
DMGetProjectInformation (Page 1660)

3.2.11.7 OnTestDeactivateRuntimeProject

Example

//{{ODK_EXAMPLE}OnTestDeactivateRuntimeProject (MCP)}
//{{FUNCTION}DMDeactivateRTProject (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestDeactivateRuntimeProject()
{
CCmnError cmnError;
if(!::DMDeactivateRTProject(cmnError))
{
cmnError.Show(__T("DMDeactivateRTProject failed\n"));
}
}
//{{ODK_EXAMPLE}(END)}

3.2.11.8 OnTestEnumGroupsAll

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"));
}
}
//{{ODK_EXAMPLE}(END)}

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1837
Runtime API
3.2 Data management functions

See also
DMEnumVarGrpData (Page 1683)

3.2.11.9 OnTestEnumVariables

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"));
}
}
//{{ODK_EXAMPLE}(END)}

See also
DMEnumVariables (Page 1688)

WinCC Engineering V18 – Programming reference

1838 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

3.2.11.10 OnTestEnumConnectionDataAll

Example

//{{ODK_EXAMPLE}OnTestEnumConnectionDataAll (MCP)}
//{{FUNCTION}DMEnumConnectionData (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestEnumConnectionDataAll()
{
CCmnError Error;
memset(&Error,0,sizeof(CCmnError));
if( !::DMEnumConnectionData( m_strProject, NULL, 0, EnumConnectionDataProc, this,
&Error))
{
Error.Show(__T("DMEnumConnectionData failed\n"));
}
}
//{{ODK_EXAMPLE}(END)}

See also
DMEnumConnectionData (Page 1791)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1839
Runtime API
3.2 Data management functions

3.2.11.11 OnTestMachines

Example

//{{ODK_EXAMPLE}OnTestMachines (MCP)}
//{{FUNCTION}DMGetMachineTable (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestMachines()
{
CMN_ERROR Error;
memset(&Error,0,sizeof(CMN_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( "Computer : %s, Type : %s, Site : %s" ),
dmMachineTable.tm[i].szMachineName,
dmMachineTable.tm[i].fServer ? _T( "Server" ) : _T( "Client or ES" ),
dmMachineTable.tm[i].fLocal ? _T( "local" ) : _T( "remote" ));
PutStr( strData);
}
}
}
//{{ODK_EXAMPLE}(END)}

See also
DMGetMachineTable (Page 1652)

WinCC Engineering V18 – Programming reference

1840 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

3.2.11.12 OnTestProjectInfo

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);
}
}
//{{ODK_EXAMPLE}(END)}

See also
DMGetProjectInformation (Page 1660)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1841
Runtime API
3.2 Data management functions

3.2.11.13 OnTestProjectPaths

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));
memset(&Error,0,sizeof(CCmnError));
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);
}
}
//{{ODK_EXAMPLE}(END)}

See also
DMGetProjectDirectory (Page 1659)

WinCC Engineering V18 – Programming reference

1842 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

3.2.11.14 OnTestOpenProject

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;
memset(&Error,0,sizeof(CCmnError));
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;
}
}
//{{ODK_EXAMPLE}(END)}

See also
DMOpenProjectPlus (Page 1664)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1843
Runtime API
3.2 Data management functions

3.2.11.15 OnTestOpenProjects

Example

//{{ODK_EXAMPLE}OnTestOpenProjects (MCP)}
//{{FUNCTION}DMEnumOpenedProjects (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestOpenProjects()
{
CCmnError Error;
memset(&Error,0,sizeof(CCmnError));
if(!DMEnumOpenedProjects(NULL, OpenProjectsProc, this, &Error))
{
Error.Show(__TEXT("DMEnumOpenedProjects failed\n"));
}
}
//{{ODK_EXAMPLE}(END)}

See also
DMEnumOpenedProjects (Page 1656)

3.2.11.16 OnTestRuntimeProject

Example

//{{ODK_EXAMPLE}OnTestRuntimeProject (MCP)}
//{{FUNCTION}DMGetRuntimeProject (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestRuntimeProject()
{
CCmnError Error;
memset(&Error,0,sizeof(CCmnError));
TCHAR szBuffer[_MAX_PATH + 1];
if(!DMGetRuntimeProject(szBuffer, NELEM(szBuffer), &Error))
{
Error.Show(__TEXT("DMGetRuntimeProject failed\n"));
}
else
{
PutStr(szBuffer);
}
}
//{{ODK_EXAMPLE}(END)}

See also
DMGetRuntimeProject (Page 1662)

WinCC Engineering V18 – Programming reference

1844 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

3.2.11.17 OnTestSystemLocale

Example

//{{ODK_EXAMPLE}OnTestSystemLocale (MCP)}
//{{FUNCTION}DMGetSystemLocale (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestSystemLocale()
{
CCmnError Error;
memset(&Error,0,sizeof(CCmnError));
DWORD dwLocaleID = 0;
if(!DMGetSystemLocale(&dwLocaleID, &Error))
{
Error.Show(__TEXT("DMGetSystemLocale failed\n"));
}
else
{
CString strData;
strData.Format(_T("Systemlocale : %08X"), dwLocaleID);
PutStr(strData);
}
}
//{{ODK_EXAMPLE}(END)}

See also
DMGetSystemLocale (Page 1797)

3.2.11.18 OnTestUpdateCycles

Example

//{{ODK_EXAMPLE}OnTestUpdateCycles (MCP)}
//{{FUNCTION}DMEnumUpdateCycles (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestUpdateCycles()
{
DWORD dwNumCalls = 0;
CCmnError Error;
memset(&Error,0,sizeof(CCmnError));
if( !DMEnumUpdateCycles(m_strProject, &dwNumCalls,
EnumCyclesProc, this, &Error))
{
Error.Show(__TEXT("DMEnumUpdateCycles failed\n"));
}
}
//{{ODK_EXAMPLE}(END)}

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1845
Runtime API
3.2 Data management functions

See also
DMEnumUpdateCycles (Page 1641)

3.2.11.19 OnTestVariablenBeginstartvarupdate

Example

//{{ODK_EXAMPLE}OnTestVariblenBeginstartvarupdate (MCP)}
//{{FUNCTION}DMBeginStartVarUpdate (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestVariablenBeginstartvarupdate()
{
CCmnError Error;
memset(&Error,0,sizeof(CCmnError));
if(!DMBeginStartVarUpdate(&m_dwTAID, &Error))
{
Error.Show(_T("DMBeginStartVarUpdate failed\n"));
}
else
{
CString strData;
strData.Format(_T("DMBeginStartVarUpdate: TAID:%lu."), m_dwTAID);
}
}
//{{ODK_EXAMPLE}(END)}

See also
DMBeginStartVarUpdate (Page 1801)

WinCC Engineering V18 – Programming reference

1846 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

3.2.11.20 OnTestVariablenEndstartvarupdate

Example

//{{ODK_EXAMPLE}OnTestVariablenEndstartvarupdate (MCP)}
//{{FUNCTION}DMEndStartVarUpdate (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestVariablenEndstartvarupdate()
{
CCmnError Error;
memset(&Error,0,sizeof(CCmnError));
if( !DMEndStartVarUpdate(m_dwTAID, &Error))
{
Error.Show(_T("DMEndStartVarUpdate failed\n"));
}
else
{
CString strData;
strData.Format(_T("DMEndStartVarUpdate: TAID:%lu."), m_dwTAID);
}
}
//{{ODK_EXAMPLE}(END)}

See also
DMEndStartVarUpdate (Page 1803)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1847
Runtime API
3.2 Data management functions

3.2.11.21 OnTestVariablenGetvalue

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.szName,
lpdmvus2->dmVarKey.dwID);
}
break;
case DM_VARTYPE_BYTE:
strData.Format(_T("GetValue: Variable: %s\t( ID = %d ):\tWert = %u"),
lpdmvus2->dmVarKey.szName,
lpdmvus2->dmVarKey.dwID,
lpdmvus2->dmValue.bVal);
break;
case DM_VARTYPE_SBYTE:

WinCC Engineering V18 – Programming reference

1848 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

strData.Format(_T("GetValue: Variable: %s\t( ID = %d ):\tWert = %d"),

lpdmvus2->dmVarKey.szName,
lpdmvus2->dmVarKey.dwID,
lpdmvus2->dmValue.bVal);
break;
case DM_VARTYPE_WORD:
strData.Format(_T("GetValue: Variable: %s\t( ID = %d ):\tWert = %u"),
lpdmvus2->dmVarKey.szName,
lpdmvus2->dmVarKey.dwID,
lpdmvus2->dmValue.iVal);
break;
case DM_VARTYPE_SWORD:
strData.Format(_T("GetValue: Variable: %s\t( ID = %d ):\tWert = %d"),
lpdmvus2->dmVarKey.szName,
lpdmvus2->dmVarKey.dwID,
lpdmvus2->dmValue.iVal);
break;
case DM_VARTYPE_DWORD:
strData.Format(_T("GetValue: Variable: %s\t( ID = %d ):\tWert = %u"),
lpdmvus2->dmVarKey.szName,
lpdmvus2->dmVarKey.dwID,
lpdmvus2->dmValue.lVal);
break;
case DM_VARTYPE_SDWORD:
strData.Format(_T("GetValue: Variable: %s\t( ID = %d ):\tWert = %d"),
lpdmvus2->dmVarKey.szName,
lpdmvus2->dmVarKey.dwID,
lpdmvus2->dmValue.lVal);
break;
case DM_VARTYPE_FLOAT:
strData.Format(_T("GetValue: Variable: %s\t( ID = %d ):\tWert = %f"),
lpdmvus2->dmVarKey.szName,
lpdmvus2->dmVarKey.dwID,
lpdmvus2->dmValue.fltVal);
break;
case DM_VARTYPE_DOUBLE:
strData.Format(_T("GetValue: Variable: %s\t( ID = %d ):\tWert = %f"),
lpdmvus2->dmVarKey.szName,
lpdmvus2->dmVarKey.dwID,
lpdmvus2->dmValue.dblVal);
break;
case DM_VARTYPE_TEXT_8:
strData.Format(_T("GetValue: Variable: %s\t( ID = %d ):\tWert = %s"),
lpdmvus2->dmVarKey.szName,
lpdmvus2->dmVarKey.dwID,
lpdmvus2->dmValue.bstrVal);
break;
/*
case DM_VARTYPE_TEXT_16:
strData.Format(_T("GetValue: Variable: %s\t( ID = %d ):\tWert = %s"),
lpdmvus2->dmVarKey.szName,
lpdmvus2->dmVarKey.dwID,
lpdmvus2->dmValue.bstrVal);
break;
*/
default:

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1849
Runtime API
3.2 Data management functions

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;
}
//{{ODK_EXAMPLE}(END)}

See also
DMGetValue (Page 1691)

WinCC Engineering V18 – Programming reference

1850 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

3.2.11.22 OnTestVariablenGetvaluewait

Example

//{{ODK_EXAMPLE}OnTestVariablenGetvaluewait (MCP)}
//{{FUNCTION}DMGetValueWait (MCP)}
//{{FUNCTION}(END)}
//-----< Notification-Callback for GetValueWait >-----------------------------
BOOL GetValueWaitNotify(DWORD dwTAID,
LPDM_VAR_UPDATE_STRUCT lpdmvus,
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: Tag: %s\t( ID = %d ):\tValue = TRUE,
State=%04x"),
lpdmvus2->dmVarKey.szName,
lpdmvus2->dmVarKey.dwID,
lpdmvus2->dwState);
}
else
{
strData.Format(_T("GetValueWait: Tag: %s\t( ID = %d ):\tValue = FALSE,
State=%04x"),
lpdmvus2->dmVarKey.szName,
lpdmvus2->dmVarKey.dwID,
lpdmvus2->dwState);
}
break;
case DM_VARTYPE_BYTE:
strData.Format(_T("GetValueWait: Tag: %s\t( ID = %d ):\tValue = %u, State=%04x"),
lpdmvus2->dmVarKey.szName,
lpdmvus2->dmVarKey.dwID,
lpdmvus2->dmValue.bVal,
lpdmvus2->dwState);
break;
case DM_VARTYPE_SBYTE:
strData.Format(_T("GetValueWait: Tag: %s\t( ID = %d ):\tValue = %d, State=%04x"),
lpdmvus2->dmVarKey.szName,
lpdmvus2->dmVarKey.dwID,
lpdmvus2->dmValue.bVal,
lpdmvus2->dwState);
break;
case DM_VARTYPE_WORD:

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1851
Runtime API
3.2 Data management functions

strData.Format(_T("GetValueWait: Tag: %s\t( ID = %d ):\tValue = %u, Status=%04x"),

lpdmvus2->dmVarKey.szName,
lpdmvus2->dmVarKey.dwID,
lpdmvus2->dmValue.iVal,
lpdmvus2->dwState);
break;
case DM_VARTYPE_SWORD:
strData.Format(_T("GetValueWait: Tag: %s\t( ID = %d ):\tValue = %d, State=%04x"),
lpdmvus2->dmVarKey.szName,
lpdmvus2->dmVarKey.dwID,
lpdmvus2->dmValue.iVal,
lpdmvus2->dwState);
break;
case DM_VARTYPE_DWORD:
strData.Format(_T("GetValueWait: Tag: %s\t( ID = %d ):\tValue = %u, State=%04x"),
lpdmvus2->dmVarKey.szName,
lpdmvus2->dmVarKey.dwID,
lpdmvus2->dmValue.lVal,
lpdmvus2->dwState);
break;
case DM_VARTYPE_SDWORD:
strData.Format(_T("GetValueWait: Tag: %s\t( ID = %d ):\tValue = %d, State=%04x"),
lpdmvus2->dmVarKey.szName,
lpdmvus2->dmVarKey.dwID,
lpdmvus2->dmValue.lVal,
lpdmvus2->dwState);
break;
case DM_VARTYPE_FLOAT:
strData.Format(_T("GetValueWait: Tag: %s\t( ID = %d ):\tValue = %f, State=%04x"),
lpdmvus2->dmVarKey.szName,
lpdmvus2->dmVarKey.dwID,
lpdmvus2->dmValue.fltVal,
lpdmvus2->dwState);
break;
case DM_VARTYPE_DOUBLE:
strData.Format(_T("GetValueWait: Tag: %s\t( ID = %d ):\tValue = %f, State=%04x"),
lpdmvus2->dmVarKey.szName,
lpdmvus2->dmVarKey.dwID,
lpdmvus2->dmValue.dblVal,
lpdmvus2->dwState);
break;
case DM_VARTYPE_TEXT_8:
strData.Format(_T("GetValueWait: Tag: %s\t( ID = %d ):\tValue = %s, State=%04x"),
lpdmvus2->dmVarKey.szName,
lpdmvus2->dmVarKey.dwID,
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:raw data\nValues:%02x %02x %02x %02x\n"),

WinCC Engineering V18 – Programming reference

1852 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

lpdmvus2->dmVarKey.szName,
pArray[0],
pArray[1],
pArray[2],
pArray[3]);
SafeArrayUnaccessData(lpdmvus2->dmValue.parray);
}
else
{
strData.Format(_T("SafeArrayAccessData failed\n"));
}
break;
}
default:
strData.Format(_T("GetValueWait: Unknonw data type !"));
}
pDoc->PutStr(strData);
}
return(TRUE);
}

//-----< OnTestVariablenGetvaluewait >------------------------------------------

void CTestCliDoc::OnTestVariablenGetvaluewait()
{
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);
DWORD dwTAID = 5;
DWORD dwTimeOut = 5000;
CCmnError Error;
memset(&Error,0,sizeof(CCmnError));
if(!DMGetValueWait(&dwTAID,
lpdmVarKey,
nNum,
FALSE,
dwTimeOut,
GetValueWaitNotify,
this,
&Error))
{
Error.Show(_T("DMGetValueWait (FALSE) failed\n"));
}
delete []lpdmVarKey;
delete []lpdmvus;
}

//-----< OnTestVariablenGetvaluewait >------------------------------------------

void CTestCliDoc::OnTestVariablenGetvaluewaitTrue()
{
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);
DWORD dwTAID = 5;
DWORD dwTimeOut = 5000;

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1853
Runtime API
3.2 Data management functions

CCmnError Error;
memset(&Error,0,sizeof(CCmnError));
if( !DMGetValueWait(&dwTAID,
lpdmVarKey,
nNum,
TRUE,
dwTimeOut,
GetValueWaitNotify,
this,
&Error))
{
Error.Show(_T("DMGetValueWait (TRUE) failed\n"));
}
delete []lpdmVarKey;
delete []lpdmvus;
}
//{{ODK_EXAMPLE}(END)}

See also
DMGetValueWait (Page 1704)

WinCC Engineering V18 – Programming reference

1854 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

3.2.11.23 OnTestVariablenGetVarInfo

Example

//{{ODK_EXAMPLE}OnTestVariblenGetVarInfo (MCP)}
//{{FUNCTION}DMGetVarInfo (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestVariablenGetVarInfo()
{
int nNum = GetVarCount();
LPDM_VARKEY lpdmVarKey = GetVarKeys();
CCmnError Error;
memset(&Error,0,sizeof(CCmnError));
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);
}
}
delete []lpdmVarKey;
}
//{{ODK_EXAMPLE}(END)}

See also
DMGetVarInfo (Page 1710)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1855
Runtime API
3.2 Data management functions

3.2.11.24 OnTestVariablenGetvarlimits

Example

//{{ODK_EXAMPLE}OnTestVariblenGetvarlimits (MCP)}
//{{FUNCTION}DMGetVarLimits (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestVariablenGetvarlimits()
{
int nNum = GetVarCount();
LPDM_VARLIMIT lpdmVarLimit = new DM_VARLIMIT[nNum];
memset(lpdmVarLimit, 0, sizeof(DM_VARLIMIT) * nNum);
LPDM_VARKEY lpdmVarKey = GetVarKeys();
CCmnError Error;
memset(&Error,0,sizeof(CCmnError));
if(!::DMGetVarLimits(m_strProject, lpdmVarKey, nNum,
lpdmVarLimit, &Error))
{
Error.Show(__T("DMGetVarLimits failed\n"));
}
else
{
CString strData;
for(int i=0; i<nnum; i++)
{
strData.Format(_T("DMGetVarLimits: Var:%s, MaxRange:%lf, MinRange:%lf,
MinLimit:%lf, MaxLimit:%lf."),
lpdmVarKey[i].szName,
lpdmVarLimit[i].dmMaxRange.dblVal,
lpdmVarLimit[i].dmMinRange.dblVal,
lpdmVarLimit[i].dmMaxLimit.dblVal,
lpdmVarLimit[i].dmMinLimit.dblVal);
PutStr(strData);
}
}
delete []lpdmVarLimit;
delete []lpdmVarKey;
}
//{{ODK_EXAMPLE}(END)}

See also
DMGetVarLimits (Page 1721)

WinCC Engineering V18 – Programming reference

1856 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

3.2.11.25 OnTestVariablenGetvartype

Example

//{{ODK_EXAMPLE}OnTestVariblenGetvartype (MCP)}
//{{FUNCTION}DMGetVarType (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestVariablenGetvartype()
{
int nNum = GetVarCount();
LPDM_TYPEREF lpdmTypeRef = new DM_TYPEREF[nNum];
memset(lpdmTypeRef, 0, sizeof(DM_TYPEREF) * nNum);
LPDM_VARKEY lpdmVarKey = GetVarKeys();
CCmnError Error;
memset(&Error,0,sizeof(CCmnError));
if(!::DMGetVarType(m_strProject, lpdmVarKey, nNum,
lpdmTypeRef, &Error))
{
Error.Show(_T("DMGetVarType failed\n"));
}
else
{
CString strData;
for(int i=0; i<nnum; i++)
{
strData.Format(_T("DMGetVarType: Var:%s, Size:%lu, Name:%s."),
lpdmVarKey[i].szName,
lpdmVarKey[i].dwID);
PutStr(strData);
}
}
delete []lpdmVarKey;
}
//{{ODK_EXAMPLE}(END)}

See also
DMGetVarType (Page 1728)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1857
Runtime API
3.2 Data management functions

3.2.11.26 OnTestVariablenResumevarupdate

Example

//{{ODK_EXAMPLE}OnTestVariblenResumevarupdate (MCP)}
//{{FUNCTION}DMResumeVarUpdate (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestVariablenResumevarupdate()
{
CCmnError Error;
memset(&Error,0,sizeof(CCmnError));
if(!DMResumeVarUpdate(m_dwTAID, &Error))
{
Error.Show(_T("DMResumeVarUpdate failed.\n"));
}
else
{
CString strData;
strData.Format(_T("DMResumeVarUpdate ok."));
}
}
//{{ODK_EXAMPLE}(END)}

See also
DMResumeVarUpdate (Page 1804)

WinCC Engineering V18 – Programming reference

1858 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

3.2.11.27 OnTestVariablenSetvalue

Example

//{{ODK_EXAMPLE}OnTestVariablenSetvalue (MCP)}
//{{FUNCTION}DMSetValue (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestVariablenSetvalue()
{
int nNum = GetVarCount();
LPDM_VARKEY lpdmVarKey = GetVarKeys();
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 []lpdmVarKey;
delete []lpdmVarState;
}
//{{ODK_EXAMPLE}(END)}

See also
DMSetValue (Page 1734)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1859
Runtime API
3.2 Data management functions

3.2.11.28 OnTestVariablenSetvaluewait

Example

//{{ODK_EXAMPLE}OnTestVariablenSetvaluewait (MCP)}
//{{FUNCTION}DMSetValueWait (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestVariablenSetvaluewait()
{
int nNum = GetVarCount();
LPDM_VARKEY lpdmVarKey = GetVarKeys();
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 []lpdmVarKey;
delete []lpdmVarState;
}
//{{ODK_EXAMPLE}(END)}

See also
DMSetValueWaitMessage (Page 1749)
DMSetValueWait (Page 1744)

WinCC Engineering V18 – Programming reference

1860 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

3.2.11.29 OnTestVariablenStopallupdates

Example

//{{ODK_EXAMPLE}OnTestVariablenStopallupdates (MCP)}
//{{FUNCTION}DMStopAllUpdates (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestVariablenStopallupdates()
{
CCmnError Error;
memset(&Error,0,sizeof(CCmnError));
if(!DMStopAllUpdates(&Error))
{
Error.Show(_T("DMStopAllUpdates failed\n"));
}
else
{
CString strData;
strData.Format(_T("DMStopAllUpdates ok."));
}
}
//{{ODK_EXAMPLE}(END)}

See also
DMStopAllUpdates (Page 1820)

3.2.11.30 OnTestVariablenStopvarupdate

Example

//{{ODK_EXAMPLE}OnTestVariablenStopvarupdate (MCP)}
//{{FUNCTION}DMStopVarUpdate (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestVariablenStopvarupdate()
{
CCmnError Error;
memset(&Error,0,sizeof(CCmnError));
if( !DMStopVarUpdate(m_dwTAID, &Error))
{
Error.Show(_T("DMStopVarUpdate failed\n"));
}
else
{
CString strData;
strData.Format(_T("DMStopVarUpdate: TAID:%lu."), m_dwTAID);
}
}
//{{ODK_EXAMPLE}(END)}

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1861
Runtime API
3.2 Data management functions

See also
DMStopVarUpdate (Page 1821)

3.2.11.31 OnTestVariablenSuspendvarupdate

Example

//{{ODK_EXAMPLE}OnTestVariablenSuspendvarupdate (MCP)}
//{{FUNCTION}DMSuspendVarUpdate (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestVariablenSuspendvarupdate()
{
CCmnError Error;
memset(&Error,0,sizeof(CCmnError));
if(!DMSuspendVarUpdate(m_dwTAID, &Error))
{
Error.Show(_T("DMSuspendVarUpdate failed\n"));
}
else
{
CString strData;
strData.Format(_T("DMSuspendVarUpdate ok."));
}
}
//{{ODK_EXAMPLE}(END)}

See also
DMSuspendVarUpdate (Page 1823)

3.2.11.32 OnTestWinCCShutdown

Example

//{{ODK_EXAMPLE}OnTestWinCCShutdown (MCP)}
//{{FUNCTION}DMExitWinCC (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestWinCCShutdown()
{
DMExitWinCC();
}
//{{ODK_EXAMPLE}(END)}

See also
DMExitWinCC (Page 1644)

WinCC Engineering V18 – Programming reference

1862 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

3.2.11.33 Open project by means of dialog

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"),
Error.dwError1, Error.dwError2, Error.szErrorText);
}
else
{
_sntprintf_s(szText,_countof(szText), _TRUNCATE, _T("DMOpenProject (%s)"),
szProjFile);
}
ODKTrace(szText);
}
}
//{{ODK_EXAMPLE}(END)}

See also
DMOpenProjectPlus (Page 1664)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1863
Runtime API
3.2 Data management functions

3.2.11.34 Read tag

Example

// =====================================================================
// =====================================================================
// short : Modul with examples to DataManager-API
// RUNTIME
// SC: PO = Projekt opened PG= Projekt closed
// *********************************************************************
#include "stdafx.h" // if MFC classes
//#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}DMGetRuntimeProject (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.

WinCC Engineering V18 – Programming reference

1864 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

"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);

memset(&Error,0,sizeof(Error));
ret = MyDMGetConnectionState();
if(FALSE != ret)
{
memset(&Error,0,sizeof(Error));
// 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;
}
memset(&Error,0,sizeof(Error));
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
{
sprintf(szText, "Index=%d Name=%s ID=%d Value=%d",

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1865
Runtime API
3.2 Data management functions

iOut, VarUp[iOut].dmVarKey.szName,
VarUp[iOut].dmVarKey.dwID,
VarUp[iOut].dmValue.bVal);
break;
}
case DM_VARTYPE_SBYTE: //vt = 2 VT_I2 = 2
{
sprintf(szText, "Index=%d Name=%s ID=%d Value=%d",
iOut, VarUp[iOut].dmVarKey.szName,
VarUp[iOut].dmVarKey.dwID,
VarUp[iOut].dmValue.iVal);
break;
}
case DM_VARTYPE_WORD: //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.lVal);
break;
}
case DM_VARTYPE_SWORD: //vt = 2 VT_I2 = 2
{
sprintf(szText, "Index=%d Name=%s ID=%d Value=%d",
iOut, VarUp[iOut].dmVarKey.szName,
VarUp[iOut].dmVarKey.dwID,
VarUp[iOut].dmValue.iVal);
break;
}
case DM_VARTYPE_DWORD: //vt = 5 VT_R8 = 5
{
sprintf(szText, "Index=%d Name=%s ID=%d Value=%d",
iOut, VarUp[iOut].dmVarKey.szName,
VarUp[iOut].dmVarKey.dwID,
VarUp[iOut].dmValue.dblVal);
break;
}
case DM_VARTYPE_SDWORD: //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.lVal);
break;
}
case DM_VARTYPE_FLOAT: //vt = 4 VT_R4 = 4
{
sprintf(szText, "Index=%d Name=%s ID=%d Value=%f",
iOut, VarUp[iOut].dmVarKey.szName,
VarUp[iOut].dmVarKey.dwID,
VarUp[iOut].dmValue.fltVal);
break;
}
case DM_VARTYPE_DOUBLE: //vt = 5 VT_R8 = 5
{
sprintf(szText, "Index=%d Name=%s ID=%d Value=%f",

WinCC Engineering V18 – Programming reference

1866 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

iOut, VarUp[iOut].dmVarKey.szName,
VarUp[iOut].dmVarKey.dwID,
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",
iOut, VarUp[iOut].dmVarKey.szName,
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",
iOut, VarUp[iOut].dmVarKey.szName,
VarUp[iOut].dmVarKey.dwID,BstrValue);
break;
}
default:
break;
}// end switch case
ODKTrace(szText);
//printf("%s\r\n",szText);

VariantClear( &VarUp[iOut].dmValue );
}//end for
}
else
{
sprintf(szText, "Error in DMGetValue: E1= 0x%08lx ; E2= 0x%08lx ; %s",
Error.dwError1, Error.dwError2, Error.szErrorText);
ODKTrace(szText);
//printf("%s\r\n",szText);
}
}
else
{
sprintf(szText, "Error in DMGetRuntimeProject: E1= 0x%08lx ; E2= 0x%08lx ; %s",
Error.dwError1, Error.dwError2, Error.szErrorText);
ODKTrace(szText);
//printf("%s\r\n",szText);
}
}
else
{
sprintf(szText, "Error in MyDMGetConnectionState: E1= 0x%08lx ; E2= 0x%08lx ; %s",
Error.dwError1, Error.dwError2, Error.szErrorText);
ODKTrace(szText);
//printf("%s\r\n",szText);

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1867
Runtime API
3.2 Data management functions

}
}
//{{ODK_EXAMPLE}(END)}

See also
DMGetRuntimeProject (Page 1662)
DMGetValue (Page 1691)

WinCC Engineering V18 – Programming reference

1868 System Manual, 11/2022, Online documentation
 Runtime API
3.2 Data management functions

3.2.11.35 Write tag

Example

//{{ODK_EXAMPLE}Write tag (MCP)}

//{{FUNCTION}DMGetRuntimeProject (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(&Error, 0, sizeof(CMN_ERROR));
memset(&VarUp, 0, sizeof(DM_VAR_UPDATE_STRUCT) * nNum);
memset(&VarKey,0, sizeof(DM_VARKEY) * nNum);
ret = MyDMGetConnectionState();
if(FALSE != ret)
{
// RunTime project
ret = DMGetRuntimeProject(szProjFile, dwSize, &Error);
if(FALSE != ret)
{
// read tag

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1869
Runtime API
3.2 Data management functions

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].vt = VT_I4;
VarVal[3].lVal = 89;
//"VAR_5_SWORD",
VarVal[4].vt = VT_I2;
VarVal[4].iVal = -89;
//"VAR_6_DWORD",
VarVal[5].vt = VT_R8;
VarVal[5].dblVal = 1200;
//"VAR_7_SDWORD",
VarVal[6].vt = VT_I4;
VarVal[6].lVal = -1200;
//"VAR_8_FLOAT",
VarVal[7].vt = VT_R4;
VarVal[7].fltVal = (float)3.789;
//"VAR_9_DOUBLE",
VarVal[8].vt = VT_R8;
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
memset(&Error,0,sizeof(CMN_ERROR));

WinCC Engineering V18 – Programming reference

1870 System Manual, 11/2022, Online documentation
 Runtime API
3.3 Functions of the graphic system

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"),
Error.dwError1, Error.dwError2, Error.szErrorText);
ODKTrace(szText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("write Value to WinCC"));
ODKTrace(szText);
}
SysFreeString(bstrText1);
SysFreeString(bstrText2);
}
}
}
//{{ODK_EXAMPLE}(END)}

See also
DMGetRuntimeProject (Page 1662)
DMSetValue (Page 1734)

3.3 Functions of the graphic system

3.3.1 Basics

3.3.1.1 Overview of the functions

Overview

PDLRTShowApp (Page 1911) Display graphic system

PDLRT_CALLBACK (Page 1912) Callback function of the runtime functions
PDLRTClosePicture (Page 1899) Close screen
PDLRTDisableClosePicture Disable close screen function
(Page 1901)
PDLRTEnableClosePicture Enable close screen function
(Page 1903)
PDLRTGetCursorKeys Query cursor control keys
(Page 1914)
PDLRTGetDefPropEx (Page 1922) Query default values of object properties
PDLRTGetPropEx (Page 1925) Query default values of object properties

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1871
Runtime API
3.3 Functions of the graphic system

PDLRTGetFocus (Page 1916) Query input focus

PDLRTGetLink (Page 1932) Query link between object property and tag
PDLRTGotoPicture (Page 1904) Query screen memory
PDLRTInquireFreeArea Determine free area of a window
(Page 1906)
PDLRTOpenPicture (Page 1907) Root screen switch in Runtime
PDLRTPictureNavigation Enable and disable screen navigation
(Page 1910)
PDLRTSetCursorKeys (Page 1918) Define cursor control keys
PDLRTSetFocus (Page 1920) Define input focus
PDLRTSetLink (Page 1934) Define link between object property and tag
PDLRTSetMultiLink (Page 1936) Define link between object property and tag (multiple tags)
PDLRTSetPropEx (Page 1928) Define object property

3.3.1.2 Overview of structures

Overview

FOCUSINFO (Page 1899) Input focus data

LINKINFO (Page 1895) Linking of object properties and tags
MULTILINK (Page 1897) Linking of object properties and tags
MULTILINKINFO Linking of object properties and tags
(Page 1898)

3.3.1.3 Error messages

Overview
The following error messages can be returned by the API functions in the CMN_ERROR error
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

WinCC Engineering V18 – Programming reference

1872 System Manual, 11/2022, Online documentation
 Runtime API
3.3 Functions of the graphic system

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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1873
Runtime API
3.3 Functions of the graphic system

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

3.3.1.4 Constants

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

WinCC Engineering V18 – Programming reference

1874 System Manual, 11/2022, Online documentation
 Runtime API
3.3 Functions of the graphic system

"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)

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 X Current Value X Polygon
"ActualPointTop" VT_I4 Current Value Y Current Value Y Polygon
"AdaptBorder" VT_BOOL Adapt Border Adapt Border Button, static text, I/O
field, text list, check box,
radio box
"AdaptPicture" VT_BOOL Adapt Picture Adapt Picture Screen window
"AdaptSize" VT_BOOL Adapt Size Adapt Size Screen window
"AlarmHigh" VT_R8 Limit AH Limit AH Bar
"AlarmLow" VT_R8 Limit AL Limit AL Bar
"Alignment" VT_BOOL Alignment Alignment Bar
"AlignmentLeft" VT_I4 X Alignment X Alignment Button, static text, I/O
field, group display, text
list, check box, radio box

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1875
Runtime API
3.3 Functions of the graphic system

"AlignmentTop" VT_I4 Y Alignment Y Alignment Button, static text, I/O

field, group display, text
list, check box, radio box
"Analog" VT_BOOL Analog Analog DAClockCtrl
"AngleAlpha" VT_I4 Alpha Alpha 3D bar
"AngleBeta" VT_I4 Beta Beta 3D bar
"AngleMax" VT_R8 AngleMax AngleMax WinCC Gauge Control,
"AngleMin" VT_R8 AngleMin AngleMin WinCC Gauge Control,
"Application" VT_BSTR WindowContent WindowContent Print job/Script diagnos‐
tics
"Assignments" VT_BSTR Assignments Assignments Text list
"AssumeOnExit" VT_BOOL Apply on Exit Apply on Exit I/O field, text list
"AssumeOnFull" VT_BOOL Apply on Full Apply on Complete I/O field
Entry
"Autoscroll" VT_BOOL AutoScroll AutoScroll WinCC Alarm Control (be‐
fore WinCC V7),
"AutoSize" VT_I4 AutoSize AutoSize PButtonCtrl
"Average" VT_BOOL Average Value Average Value Bar
"Axe" VT_I4 Display Axis Display axis 3D bar
"AxisSection" VT_R8 Axis Section Axis Section Bar
"BackBorderWidth" VT_I4 3D Border 3D Border Weight Button, group display,
Weight round button, slider ob‐
ject
"BackColor" VT_I4 Background Col‐ Background Color Button, ellipse, ellipse
or segment, circle, circle
segment, polygon, rec‐
tangle, rounded rectan‐
gle, static text, 3D bar, I/O
field, bar, graphic object,
group display, text list,
check box, radio box,
round button, slider ob‐
ject
"BackColor" VT_UI4 BackColor BackColor DAClockCtrl, WinCC
Gauge Control, PBut‐
tonCtrl, SliderCtrl,
"BackColor2" VT_I4 Bar Color Bar Color Bar
"BackColor3" VT_I4 Bar Background Bar Background Bar
Color Color
"BackColorBottom" VT_I4 Low Limit Back‐ Low Limit Back‐ Slider object
ground Color ground Color
"BackColorTop" VT_I4 High Limit Back‐ High Limit Back‐ Slider object
ground Color ground Color

WinCC Engineering V18 – Programming reference

1876 System Manual, 11/2022, Online documentation
 Runtime API
3.3 Functions of the graphic system

"BackFlashColorOff" VT_I4 Flashing Back‐ Flashing Back‐ Button, ellipse, ellipse

ground Color Off ground Color Off segment, circle, circle
segment, polygon, rec‐
tangle, rounded rectan‐
gle, static text, I/O field,
bar, graphic object, text
list, check box, radio box,
round button, slider ob‐
ject
"BackFlashColorOn" VT_I4 Flashing Back‐ Flashing Back‐ Button, ellipse, ellipse
ground Color On ground Color On segment, circle, circle
segment, polygon, rec‐
tangle, rounded rectan‐
gle, static text, I/O field,
bar, graphic object, text
list, check box, radio box,
round button, slider ob‐
ject
"Background" VT_BOOL Background Background 3D bar
"BackgroundPicture" VT_USER‐ BackgroundPic‐ BackgroundPicture WinCC Gauge Control,
DEFINED ture
"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
"BasePicReferenced" VT_BOOL Basic Picture Ref‐ Basic Picture Refer‐ Status display
erenced enced
"BasePicTransColor" VT_I4 Basic Picture Basic Picture Trans‐ Status display
Transparent Col‐ parent Color
or
"BasePicture" VT_BSTR Basic Picture Basic Picture Status display
"BasePicUseTransColor" VT_BOOL Basic Picture Basic Picture Trans‐ Status display
Transparent Col‐ parent 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 BevelColorDown BevelColorDown SliderCtrl
"BevelColorUp" VT_UI4 BevelColorUp BevelColorUp SliderCtrl
"BevelOuter" VT_I4 BevelOuter BevelOuter WinCC Gauge Control,
"BevelWidth" VT_I4 BevelWidth BevelWidth WinCC Gauge Control,
"BitNumber" VT_I4 Bit number Status display

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1877
Runtime API
3.3 Functions of the graphic system

"BorderBackColor" VT_I4 Border Back‐ Border Back‐ Button, ellipse, elliptical

ground Color, ground Color, Line arc, ellipse segment, cir‐
Line Background Background Color cle, circular arc, circle seg‐
Color ment, line, polygon, poly‐
line, rectangle, rounded
rectangle, static text, I/O
field, bar, graphic object,
text list, check box, radio
box, round button, slider
object
"BorderColor" VT_I4 Border Color, Border Color, Line Button, ellipse, elliptical
Line Background Background Color arc, ellipse segment, cir‐
Color cle, circular arc, circle seg‐
ment, line, polygon, poly‐
line, rectangle, rounded
rectangle, static text, 3-D
bar, I/O field, bar, graphic
object, text list, status dis‐
play, check box, radio
box, round button, slider
object
"BorderColorBottom" VT_I4 3D Shadow Color 3D Shadow Color Button, round button
"BorderColorTop" VT_I4 3D Border Color 3D Border Color Button, round button
"BorderEndStyle" VT_UI4 Line End Style Line End Style Line, polyline
"BorderFlashColorOff" VT_I4 Flashing Border Flashing Border Button, ellipse, elliptical
Color Off, Flash‐ Color Off, Flashing arc, ellipse segment, cir‐
ing Line Color Off Line Color Off cle, circular arc, circle seg‐
ment, line, polygon, poly‐
line, rectangle, rounded
rectangle, static text, I/O
field, bar, graphic object,
text list, check box, radio
box, slider object
"BorderFlashColorOn" VT_I4 Flashing Border Flashing Border Button, ellipse, elliptical
Color On, Flash‐ Color On, Flashing arc, ellipse segment, cir‐
ing Line Color On Line Color On cle, circular arc, circle seg‐
ment, line, polygon, poly‐
line, rectangle, rounded
rectangle, static text, I/O
field, bar, graphic object,
text list, check box, radio
box, round button, slider
object
"BorderStyle" VT_UI4 Line Style Line Style 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, I/O field, graphic ob‐
ject, text list, status dis‐
play, check box, radio
box, round button, slider
object

WinCC Engineering V18 – Programming reference

1878 System Manual, 11/2022, Online documentation
 Runtime API
3.3 Functions of the graphic system

"BorderWidth" VT_I4 Line Weight Line Weight 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, I/O field, bar, graphic
object, text list, status dis‐
play, check box, radio
box, round button, slider
object
"BorderWidth" VT_I4 BorderWidth BorderWidth WinCC Gauge Control,
"BoxAlignment" VT_BOOL Box Alignment Box Alignment Check box, radio box
"BoxCount" VT_I4 Number of Boxes Number of Boxes Check box, radio box
"BoxType" VT_I4 Field Type Field Type I/O field, text list
"Button1Width" VT_I4 Button 1 Width Button 1 Width Group display
"Button2Width" VT_I4 Button 2 Width Button 2 Width Group display
(Error: Button 1
Width 2)
"Button3Width" VT_I4 Button 3 Width Button 3 Width Group display
(Error: Button 1
Width 3)
"Button4Width" VT_I4 Button 4 Width Button 4 Width Group display
"ButtonColor" VT_I4 Button Color Button Color Slider object
"ButtonCommand" VT_I4 ButtonCom‐ ButtonCommand WinCC Alarm Control (be‐
mand fore WinCC V7),
"Caption" VT_BOOL Title Title Print job/Script diagnos‐
tics, screen window
"Caption" VT_BSTR Caption Caption WinCC Gauge Control,
PButtonCtrl, SliderCtrl,
"CaptionColor" VT_UI4 CaptionColor CaptionColor WinCC Gauge Control,
"CaptionFont" VT_USER‐ CaptionFont CaptionFont WinCC Gauge Control,
DEFINED
"CaptionOffset" VT_R8 CaptionOffset CaptionOffset WinCC Gauge Control,
"CellCut" VT_BOOL CellCut CellCut WinCC Alarm Control (be‐
fore WinCC V7),
"CenterColor" VT_UI4 CenterColor CenterColor WinCC Gauge Control,
"CenterScale" VT_R4 CenterScale CenterScale WinCC Gauge Control,
"CheckAlarmHigh" VT_BOOL Monitoring AH Monitoring AH Bar
"CheckAlarmLow" VT_BOOL Monitoring AL Monitoring AL Bar
"CheckLimitHigh4" VT_BOOL Monitoring RH4 Monitoring RH4 Bar
"CheckLimitHigh5" VT_BOOL Monitoring RH5 Monitoring RH5 Bar
"CheckLimitLow4" VT_BOOL Monitoring RL4 Monitoring RL4 Bar
"CheckLimitLow5" VT_BOOL Monitoring RL5 Monitoring RL5 Bar
"CheckToleranceHigh" VT_BOOL Monitoring TH Monitoring TH Bar
"CheckToleranceLow" VT_BOOL Monitoring TL Monitoring TL Bar
"CheckWarningHigh" VT_BOOL Monitoring WH Monitoring WH Bar
"CheckWarningLow" VT_BOOL Monitoring WL Monitoring WL Bar

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1879
Runtime API
3.3 Functions of the graphic system

"ClearOnError" VT_BOOL Clear on Invalid Clear on Invalid In‐ I/O field

Input put
"ClearOnNew" VT_BOOL Clear on New In‐ Clear on New Input I/O field
put
"CloseButton" VT_BOOL Can be Closed Can be Closed Print job/Script diagnos‐
tics, screen window
"CollectValue" VT_UI4 Group Value Group Value Group display
"ColMove" VT_BOOL ColMove ColMove WinCC Alarm Control (be‐
fore WinCC V7),
"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_BOOL Change Color Change Color Bar
"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
"ColorToleranceHigh" VT_I4 Bar Color TH Bar Color TH Bar
"ColorToleranceLow" VT_I4 Bar Color TL Bar Color TL Bar
"ColorTop" VT_I4 High Limit Color High Limit Color Slider object
"ColorWarningHigh" VT_I4 Bar Color WH Bar Color WH Bar
"ColorWarningLow" VT_I4 Bar Color WL Bar Color WL Bar
"ColTitle" VT_BOOL ColTitle ColTitle WinCC Alarm Control (be‐
fore WinCC V7),
"ColWidth" VT_BOOL ColWidth ColWidth WinCC Alarm Control (be‐
fore WinCC V7),
"CursorControl" VT_BOOL Cursor Control Cursor Control I/O field, text list
"CursorMode" VT_BOOL CursorMode CursorMode WinCC Alarm Control (be‐
fore WinCC V7), CCAxA‐
larmControl
"Danger" VT_R4 Danger Danger WinCC Gauge Control,
"DangerColor" VT_UI4 DangerColor DangerColor WinCC Gauge Control,
"DataFormat" VT_I4 Data Format Data Format I/O field
"DataLanguage" VT_I4 Configured Lan‐ Configured Lan‐ Button, static text, check
guages guages box, radio box
"Delta" VT_R4 Delta Delta WinCC Gauge Control,
"Direction" VT_I4 Bar Alignment Bar Alignment 3D bar, slider object, bar
"EditAtOnce" VT_BOOL Immediate Input Immediate Input I/O field, text list
"EndAngle" VT_I4 End Angle End Angle Elliptical arc, ellipse seg‐
ment, circular arc, circle
segment
"Exponent" VT_BOOL Exponent Dis‐ Exponent Display Bar
play
"ExtendedOperation" VT_BOOL Extended Opera‐ Extended Opera‐ Slider object
tion tion

WinCC Engineering V18 – Programming reference

1880 System Manual, 11/2022, Online documentation
 Runtime API
3.3 Functions of the graphic system

"FillColor" VT_I4 Fill Pattern Color Fill Pattern Color Button, ellipse, ellipse
segment, circle, circle
segment, polygon, rec‐
tangle, rounded rectan‐
gle, static text, I/O field,
bar, graphic object, text
list, check box, radio box,
round button, slider ob‐
ject
"Filling" VT_BOOL Dynamic Filling Dynamic Filling Button, ellipse, ellipse
segment, circle, circle
segment, polygon, rec‐
tangle, rounded rectan‐
gle, static text, graphic
object, check box, radio
box, round button
"FillingIndex" VT_I4 Fill Level Fill Level Button, ellipse, ellipse
segment, circle, circle
segment, polygon, rec‐
tangle, rounded rectan‐
gle, static text, graphic
object, check box, radio
box, round button, slider
object
"FillStyle" VT_UI4 Fill Pattern Fill Pattern Button, ellipse, ellipse
segment, circle, circle
segment, polygon, rec‐
tangle, rounded rectan‐
gle, static text, I/O field,
bar, graphic object, text
list, check box, radio box,
round button, slider ob‐
ject
"FillStyle2" VT_UI4 Bar Pattern Bar Pattern Bar
"FlashBackColor" VT_BOOL Flashing Back‐ Flashing Back‐ Button, ellipse, ellipse
ground Active ground Active segment, circle, circle
segment, polygon, rec‐
tangle, rounded rectan‐
gle, static text, I/O field,
bar, graphic object, text
list, check box, radio box,
round button, slider ob‐
ject
"FlashBorderColor" VT_BOOL Flashing Line Ac‐ Flashing Line Ac‐ Button, ellipse, elliptical
tive tive arc, ellipse segment, cir‐
cle, circular arc, circle seg‐
ment, line, polygon, poly‐
line, rectangle, rounded
rectangle, static text, I/O
field, bar, graphic object,
text list, check box, radio
box, round button, slider
object
"FlashFlashPicture" VT_BOOL Flashing Flash Flashing Flash Pic‐ Status display
Picture Active ture Active

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1881
Runtime API
3.3 Functions of the graphic system

"FlashForeColor" VT_BOOL Flashing Text Ac‐ Flashing Text Ac‐ Button, static text, I/O
tive tive field, text list, check box,
radio box
"FlashPicReferenced" VT_BOOL Flash Picture Ref‐ Flash Picture Refer‐ Status display
erenced enced
"FlashPicTransColor" VT_I4 Basic Picture Basic Picture Trans‐ Status display
Transparent Col‐ parent Color
or
"FlashPicture" VT_BSTR Flash Picture Flash Picture Status display
"FlashPicUseTransCol‐ Flash Picture Flash Picture Trans‐ Status display
or" Transparent Col‐ parent Color On
or On
"FlashRate" VT_I4 Flash Frequency Flash Frequency Group display
"FlashRateBackColor" VT_I4 Background Background Flash Button, ellipse, ellipse
Flash Frequency Frequency segment, circle, circle
segment, polygon, rec‐
tangle, rounded rectan‐
gle, static text, I/O field,
bar, graphic object, text
list, check box, radio box,
round button, slider ob‐
ject
"FlashRateBorderColor" VT_I4 Line Flash Fre‐ Background Flash Button, ellipse, elliptical
quency Frequency arc, ellipse segment, cir‐
cle, circular arc, circle seg‐
ment, line, polygon, poly‐
line, rectangle, rounded
rectangle, static text, I/O
field, bar, graphic object,
text list, check box, radio
box, round button, slider
object
"FlashRateFlashPic" VT_I4 Flash Picture Flash Picture Flash Status display
Flash Frequency Frequency
"FlashRateForeColor" VT_I4 Text Flash Fre‐ Text Flash Frequen‐ Button, static text, I/O
quency cy field, text list, check box,
radio box
"Font" VT_USER‐ Font Font DAClockCtrl, PButtonCtrl,
DEFINED SliderCtrl
"FontBold" VT_BOOL Bold Bold Button, static text, I/O
field, bar, group display,
text list, check box, radio
box
"FontBold" VT_BOOL FontBold FontBold PButtonCtrl
"FontItalic" VT_BOOL Italic Italic Button, static text, I/O
field, group display, text
list, check box, radio box
"FontItalic" VT_BOOL FontItalic FontItalic PButtonCtrl
"FontName" VT_BSTR Font Font Button, static text, I/O
field, group display, text
list, check box, radio box
"FontName" VT_BSTR FontName FontName PButtonCtrl

WinCC Engineering V18 – Programming reference

1882 System Manual, 11/2022, Online documentation
 Runtime API
3.3 Functions of the graphic system

"FontPosition" VT_USER‐ FontPosition FontPosition SliderCtrl

DEFINED
"FontSize" VT_I4 Font Size Font Size Button, static text, I/O
field, group display, text
list, check box, radio box
"FontSize" VT_BSTR FontSize Font Size PButtonCtrl
"FontStrikeThru" VT_BOOL FontStrikeThru FontStrikeThru PButtonCtrl
"FontUnderline" VT_BOOL Underline Underline Button, static text, I/O
field, group display, text
list, check box, radio box
"FontUnderline" VT_BOOL FontUnderline FontUnderline PButtonCtrl
"ForeColor" VT_I4 Font Color Font Color Button, static text, I/O
field, group display, text
list, check box, radio box
"ForeColor" VT_UI4 ForeColor ForeColor DAClockCtrl, PButtonCtrl,
SliderCtrl
"ForeFlashColorOff" VT_I4 Flashing Text Flashing Text Color Button, static text, I/O
Color Off Off field, group display, text
list, check box, radio box
"ForeFlashColorOn" VT_I4 Flashing Text Flashing Text Color Button, static text, I/O
Color On On field, group display, text
list, check box, radio box
"FrameColor" VT_UI4 Border Color Border color WinCC Gauge Control,
"FrameColorDown" VT_UI4 FrameColor‐ FrameColorDown PButtonCtrl
Down
"FrameColorUp" VT_UI4 FrameColorUp FrameColorUp PButtonCtrl
"FramePicture" VT_USER‐ FramePicture FramePicture WinCC Gauge Control,
DEFINED
"FrameScale" VT_R4 FrameScale FrameScale WinCC Gauge Control,
"FrameSize" FrameSize FrameSize PButtonCtrl
"FrameWidth" VT_I4 FrameWidth FrameWidth PButtonCtrl
"Freeze" VT_BOOL Freeze Freeze WTVctrlCtrl
"GridLineHorz" VT_BOOL GridLineHorz GridLineHorz WinCC Alarm Control (be‐
fore WinCC V7),
"GridLineVert" VT_BOOL GridLineVert GridLineVert WinCC Alarm Control (be‐
fore WinCC V7),

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1883
Runtime API
3.3 Functions of the graphic system

"Height" VT_I4 Height Height 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, I/O field, bar, graphic
object, group display,
text list, status display,
check box, radio box,
round button, slider ob‐
ject, DAClockCtrl, WinCC
Gauge Control, WinCC
Alarm Control (before
WinCC V7), PButtonCtrl,
SliderCtrl, WTVctrlCtrl,
"Height" VT_I4 Window Height Window Height Print job/Script diagnos‐
tics, screen window
"HiddenInput" VT_BOOL Hidden Input Hidden Input I/O field
"Hotkey" VT_UI4 Hot Key Hot Key Button
"HourNeedleHeight" VT_I4 HourNeedle‐ HourNeedleHeight DAClockCtrl
Height
"HourNeedleWidth" VT_I4 HourNeedle‐ HourNeedleWidth DAClockCtrl
Width
"Hysteresis" VT_BOOL Hysteresis Hysteresis Bar
"HysteresisRange" VT_R8 Hysteresis Range Hysteresis Range Bar
"Index" VT_I4 Index Index Polygon, polyline, status
display, check box, radio
box
"InnerBevelOffset" VT_I4 InnerBevelOffset InnerBevelOffset SliderCtrl
"InnerBevelStyle" VT_I4 InnerBevelStyle InnerBevelStyle SliderCtrl
"InnerBevelWidth" VT_I4 InnerBevelWidth InnerBevelWidth SliderCtrl
"ItemBorderBackColor" VT_I4 Dividing Back‐ Dividing Back‐ Text list
ground Color ground Color
"ItemBorderColor" VT_I4 Dividing Line Dividing Line Color Text list
Color
"ItemBorderStyle" VT_UI4 Dividing Line Dividing Line Style Text list
Style

WinCC Engineering V18 – Programming reference

1884 System Manual, 11/2022, Online documentation
 Runtime API
3.3 Functions of the graphic system

3.3.1.6 List of object properties (L-Z) (Graphics Designer)

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
"LanguageSwitch" VT_BOOL Language Switch Language Text list
switching
"Layer" VT_I4 Layer Layer Button, ellipse, elliptical arc,
ellipse segment, circle, circu‐
lar arc, circle segment, line,
polygon, polyline, rectangle,
rounded rectangle, static
text, 3-D bar, print job/script
diagnostics, screen window,
I/O field, bar, graphic object,
group display, text list, status
display, check box, radio box,
round button, slider object,
WinCC Gauge Control, WinCC
Alarm Control (before WinCC
V7), PButtonCtrl, SliderCtrl,
WTVctrlCtrl,
"Layer00Checked" VT_BOOL Monitoring 0 Monitoring 0 3D bar
"Layer01Checked" VT_BOOL Monitoring 1 Monitoring 1 3D bar
"Layer02Checked" VT_BOOL Monitoring 2 Monitoring 2 3D bar
"Layer03Checked" VT_BOOL Monitoring 3 Monitoring 3 3D bar
"Layer04Checked" VT_BOOL Monitoring 4 Monitoring 4 3D bar
"Layer05Checked" VT_BOOL Monitoring 5 Monitoring 5 3D bar
"Layer06Checked" VT_BOOL Monitoring 6 Monitoring 6 3D bar
"Layer07Checked" VT_BOOL Monitoring 7 Monitoring 7 3D bar
"Layer08Checked" VT_BOOL Monitoring 8 Monitoring 8 3D bar
"Layer09Checked" VT_BOOL Monitoring 9 Monitoring 9 3D bar
"Layer10Checked" VT_BOOL Monitoring 10 Monitoring 10 3D bar
"Layer00Color" VT_I4 Bar Color 0 Bar Color 0 3D bar
"Layer01Color" VT_I4 Bar Color 1 Bar Color 1 3D bar
"Layer02Color" VT_I4 Bar Color 2 Bar Color 2 3D bar
"Layer03Color" VT_I4 Bar Color 3 Bar Color 3 3D bar

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1885
Runtime API
3.3 Functions of the graphic system

"Layer04Color" VT_I4 Bar Color 4 Bar Color 4 3D bar

"Layer05Color" VT_I4 Bar Color 5 Bar Color 5 3D bar
"Layer06Color" VT_I4 Bar Color 6 Bar Color 6 3D bar
"Layer07Color" VT_I4 Bar Color 7 Bar Color 7 3D bar
"Layer08Color" VT_I4 Bar Color 8 Bar Color 8 3D bar
"Layer09Color" VT_I4 Bar Color 9 Bar Color 9 3D bar
"Layer10Color" VT_I4 Bar Color 10 Bar Color 10 3D bar
"Layer00Value" VT_R8 Limit 0 Limit 0 3D bar
"Layer01Value" VT_R8 Limit 1 Limit 1 3D bar
"Layer02Value" VT_R8 Limit 2 Limit 2 3D bar
"Layer03Value" VT_R8 Limit 3 Limit 3 3D bar
"Layer04Value" VT_R8 Limit 4 Limit 4 3D bar
"Layer05Value" VT_R8 Limit 5 Limit 5 3D bar
"Layer06Value" VT_R8 Limit 6 Limit 6 3D bar
"Layer07Value" VT_R8 Limit 7 Limit 7 3D bar
"Layer08Value" VT_R8 Limit 8 Limit 8 3D bar
"Layer09Value" VT_R8 Limit 9 Limit 9 3D bar
"Layer10Value" VT_R8 Limit 10 Limit 10 3D bar
"Left" VT_I4 X position X position Button, ellipse, elliptical arc,
ellipse segment, circle, circu‐
lar arc, circle segment, line,
polygon, polyline, rectangle,
rounded rectangle, static
text, 3-D bar, print job/script
diagnostics, screen window,
I/O field, bar, graphic object,
group display, text list, status
display, check box, radio box,
round button, slider object,
WinCC Gauge Control, WinCC
Alarm Control (before WinCC
V7), PButtonCtrl, SliderCtrl,
WTVctrlCtrl,
"LeftComma" VT_I4 Digits to the Left Digits to the Left Bar
of the Decimal of the Decimal
Point 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 High limit value High limit IO field
"LimitMin" VT_R8 Low limit value Low limit IO field
"LineFont" VT_BOOL LineFont LineFont WinCC Alarm Control (before
WinCC V7),
"LineHeight" VT_BOOL LineHeight LineHeight WinCC Alarm Control (before
WinCC V7),

WinCC Engineering V18 – Programming reference

1886 System Manual, 11/2022, Online documentation
 Runtime API
3.3 Functions of the graphic system

"LineTitle" VT_BOOL LineTitle LineTitle WinCC Alarm Control (before

WinCC V7),
"ListType" VT_I4 List Type List Type Text list
"LockBackColor" VT_I4 Lock Background Lock Background Group display
Color Color
"LockStatus" VT_BOOL Lock Display Lock Display Group display
"LockText" VT_BOOL Lock Display Text Lock Display Text Group display
"LockTextColor" VT_I4 Lock Font Color Lock Font Color Group display
"LongStrokesBold" VT_BOOL Long Axis Sec‐ Long Axis Sec‐ Bar
tion tion
"LongStrokesOnly" VT_BOOL Only Long Axis Only Long Axis Bar
Section Section
"LongStrokesSize" VT_UI4 Length of Axis Length of Axis Bar
Section Section
"LongStrokesTex‐ VT_UI4 Label Each Label Each Bar
tEach"
"Marker" VT_BOOL Limit Marker Limit Marker Bar
"Max" VT_R8 Maximum Value Maximum Value 3D bar, slider object, bar
"MaximizeButton" VT_BOOL Can be Maxi‐ Can be Maxi‐ Print job/Script diagnostics,
mized mized screen window
"MCGUBackColor‐ VT_I4 Went Out Unac‐ Outgoing Unac‐ Group display
Off" knowledge- knowledged-
Background Col‐ Background Col‐
or Off or Off
"MCGUBackColor‐ VT_I4 Went Out Unac‐ Outgoing Unac‐ Group display
On" knowledge- knowledged-
Background Col‐ Background Col‐
or On or On
"MCGUBackFlash" VT_BOOL Went Out Unac‐ Outgoing Unac‐ Group display
knowledge - knowledged -
Background Background
Flashing Flashing
"MCGUTextColor‐ VT_I4 Went Out Unac‐ Incoming - Back‐ Group display
Off" knowledge- Text ground Color Off
Color Off
"MCGUTextColor‐ VT_I4 Went Out Unac‐ Incoming - Back‐ Group display
On" knowledge- Text ground Color On
Color On
"MCGUTextFlash" VT_BOOL Went Out Unac‐ Outgoing Unac‐ Group display
knowledge - Text knowledged -
Flashing Background
Flashing
"MCKOBackColor‐ VT_I4 Came In - Back‐ Incoming - Back‐ Group display
Off" ground Color Off ground Color Off
"MCKOBackColor‐ VT_I4 Came In - Back‐ Incoming - Back‐ Group display
On" ground Color On ground Color On
"MCKOBackFlash" VT_BOOL Came In - Back‐ Incoming - Back‐ Group display
ground Flashing ground Flashing
"MCKOTextColor‐ VT_I4 Came In - Text Incoming - Text Group display
Off" Color Off Color Off

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1887
Runtime API
3.3 Functions of the graphic system

"MCKOTextColor‐ VT_I4 Came In - Text Incoming - Text Group display

On" Color On Color On
"MCKOTextFlash" VT_BOOL Came In - Text Incoming - Text Group display
Flashing Flashing
"MCKQBackColor‐ VT_I4 Came In Ac‐ Incoming Ac‐ Group display
Off" knowledge - knowledge -
Background Col‐ Background Col‐
or Off or Off
"MCKQBackColor‐ VT_I4 Came In Ac‐ Incoming Ac‐ Group display
On" knowledge - knowledge -
Background Col‐ Background Col‐
or On or On
"MCKQBackFlash" VT_BOOL Came In Ac‐ Incoming Ac‐ Group display
knowledge - knowledge -
Background Background
Flashing Flashing
"MCKQTextColor‐ VT_I4 Came In Ac‐ Incoming Ac‐ Group display
Off" knowledge - Text knowledge - Text
Color Off Color Off
"MCKQTextColor‐ VT_I4 Came In Ac‐ Incoming Ac‐ Group display
On" knowledge - Text knowledge - Text
Color On Color On
"MCKQTextFlash" VT_BOOL Came In Ac‐ Incoming Ac‐ Group display
knowledge - Text knowledge - Text
Flashing Flashing
"MCText" VT_BOOL Display Text Display Text Group display
"MessageClass" VT_I4 Message Type Message Type Group display
"Min" VT_R8 Minimum Value Minimum Value Group display
"MinuteNeedle‐ VT_I4 MinuteNeedle‐ MinuteNeedle‐ Group display
Height" Height Height
"MinuteNeedle‐ VT_I4 MinuteNeedle‐ MinuteNeedle‐ Group display
Width" Width Width
"Moveable" VT_BOOL Moveable Moveable Print job/Script diagnostics,
screen window
"NeedleColor" VT_UI4 NeedleColor NeedleColor WinCC Gauge Control,
"NormalColor" VT_UI4 NormalColor NormalColor WinCC Gauge Control,
"NumberLines" VT_I4 Number of visi‐ Number of visi‐ Text list, check box, radio box,
ble Lines ble Lines

WinCC Engineering V18 – Programming reference

1888 System Manual, 11/2022, Online documentation
 Runtime API
3.3 Functions of the graphic system

"ObjectName" VT_BSTR Object Name Object name Button, ellipse, elliptical arc,
ellipse segment, circle, circu‐
lar arc, circle segment, line,
polygon, polyline, rectangle,
rounded rectangle, static
text, 3-D bar, print job/script
diagnostics, I/O field, bar,
graphic object, group display,
text list, status display, check
box, radio box, round button,
slider object, DAClockCtrl,
WinCC Gauge Control, WinCC
Alarm Control (before WinCC
V7), PButtonCtrl, SliderCtrl,
WTVctrlCtrl,
"OffsetLeft" VT_I4 Picture Offset X Picture Offset X Screen window
"OffsetTop" VT_I4 Picture Offset Y Picture Offset Y Screen window
"OnTop" VT_BOOL Foreground Foreground Print job/Script diagnostics,
screen window
"Operation" VT_BOOL Operator-Con‐ Operator-Con‐ Button, ellipse, elliptical arc,
trol Enable trol Enable ellipse segment, circle, circu‐
lar arc, circle segment, line,
polygon, polyline, rectangle,
rounded rectangle, static
text, 3-D bar, I/O field, bar,
graphic object, group display,
text list, status display, check
box, radio box, round button,
slider object, DAClockCtrl,
WinCC Gauge Control, WinCC
Alarm Control (before WinCC
V7), PButtonCtrl, SliderCtrl,
WTVctrlCtrl,
"OperationMes‐ VT_BOOL Operator Input Operator Input I/O field, text list, check box,
sage" Message Message radio box, slider object
"OperationReport" VT_BOOL Operator Ac‐ Operator Ac‐ I/O field, text list, slider object
tions Report tions Report
"Orientation" VT_BOOL Text Orientation Text Orientation Static text, I/O field, text list,
check box, radio box
"OuterBevelOffset" VT_I4 OuterBevelOffset OuterBevelOffset SliderCtrl
"OuterBevelStyle" VT_I4 OuterBevelStyle OuterBevelStyle SliderCtrl
"OuterBevelWidth" VT_I4 OuterBevelWidth OuterBevelWidth SliderCtrl
"Outline" VT_BOOL 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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1889
Runtime API
3.3 Functions of the graphic system

"PasswordLevel" VT_UI4 User Level Password Button, ellipse, elliptical arc,

ellipse segment, circle, circu‐
lar arc, circle segment, line,
polygon, polyline, rectangle,
rounded rectangle, static
text, 3-D bar, I/O field, bar,
graphic object, group display,
text list, status display, check
box, radio box, round button,
slider object
"PicDeactRefer‐ VT_BOOL Picture Deact. Picture Deact. Round button
enced" Referenced Referenced
"PicDeactTranspar‐ VT_I4 Picture Deact. Picture Deact. Round button
ent" Transparent Col‐ Transparent Col‐
or or
"PicDeactUseTrans‐ VT_BOOL Picture Deact. Picture Deact. Round button
Color" Transparent Col‐ Transparent Col‐
or On or On
"PicDownRefer‐ VT_BOOL Picture On Refer‐ Picture On Refer‐ Round button
enced" enced enced
"PicDownTranspar‐ VT_I4 Picture On Trans‐ Picture On Trans‐ Round button
ent" parent Color parent Color
"PicDownUseTrans‐ VT_BOOL Picture On Trans‐ Picture On Trans‐ Round button
Color" parent Color On parent Color On
"PicReferenced" VT_BOOL Picture Refer‐ Picture Refer‐ Graphic object
enced enced
"PicTransColor" VT_I4 Picture Transpar‐ Picture Transpar‐ Graphic object
ent Color ent Color
"Picture" VT_USER‐ Picture Picture DAClockCtrl
DEFINED
"PictureBack" VT_USER‐ PictureBack PictureBack SliderCtrl
DEFINED
"PictureDeactiva‐ VT_BSTR Picture Status Picture Status Round button
ted" Deactivated Deactivated
"PictureDown" VT_BSTR Picture Status On Picture Status On Button, round button
"PictureName" VT_BSTR Picture Name Screen name Screen window, graphic ob‐
ject
"PictureSelected" VT_USER‐ PictureSelected PictureSelected PButtonCtrl
DEFINED
"PictureUnselec‐ VT_USER‐ Picture Unselec‐ Picture Unselec‐ PButtonCtrl
ted" DEFINED ted ted
"PictureThumb" VT_USER‐ PictureThumb PictureThumb SliderCtrl
DEFINED
"PictureUp" VT_BSTR Picture Status Off Picture Status Off Button, round button
"PicUpReferenced" VT_BOOL Picture Off Refer‐ Picture Off Refer‐ Round button
enced enced
"PicUpTransparent" VT_I4 Picture Off Trans‐ Picture Off Trans‐ Round button
parent Color parent Color
"PicUpUseTransCol‐ VT_BOOL Picture Off Trans‐ Picture Off Trans‐ Round button
or" parent Color On parent Color On

WinCC Engineering V18 – Programming reference

1890 System Manual, 11/2022, Online documentation
 Runtime API
3.3 Functions of the graphic system

"PicUseTransColor" VT_BOOL Picture Transpar‐ Transparent Col‐ Graphic object

ent Color On or On
"PointCount" VT_I4 Number of Cor‐ Number of Cor‐ Polygon, polyline
ners ners
"Position" VT_I4 Positions Positions SliderCtrl
"PredefinedAngles" VT_I4 Angle Settings Angle Settings 3D bar
"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 Boxes Selected Boxes Check box, radio box
"ProjectPath" VT_BSTR ProjectPath ProjectPath WinCC Alarm Control (before
WinCC V7),
"Radius" VT_I4 Radius Radius Circle, circular arc, circle seg‐
ment, round button
"RadiusHeight" VT_I4 Y radius Y radius Ellipse, Elliptical arc, ellipse
segment
"RadiusWidth" VT_I4 X radius X radius Ellipse, Elliptical arc, ellipse
segment
"RangeMax" VT_I4 RangeMax RangeMax SliderCtrl
"RangeMin" VT_I4 RangeMin RangeMin SliderCtrl
"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
"RefreshTimerPer‐ VT_I4 RefreshTimer‐ RefreshTimer‐ WTVctrlCtrl
iod" Period Period
"Relevant" VT_BOOL Group Relevant Group Relevant Group display
"RightComma" VT_I4 Digits to the Digits to the Bar
Right of the Dec‐ Right of the Dec‐
imal Point imal Point
"RotationAngle" VT_I4 Rotation Angle Rotation Angle Line, polygon, polyline
"RoundCorner‐ VT_I4 Corner Radius Y Corner Radius Y Rounded rectangle
Height"
"RoundCorner‐ VT_I4 Corner Radius X Corner Radius X Rounded rectangle
Width"
"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 SecondNeedle‐ SecondNeedle‐ DAClockCtrl
Height" Height Height
"SecondNeedle‐ VT_I4 SecondNeedle‐ SecondNeedle‐ DAClockCtrl
Width" Width Width
"SelBGColor" VT_I4 Selection Back‐ Selection Back‐ Text list
ground Color ground Color

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1891
Runtime API
3.3 Functions of the graphic system

"SelectionMode" VT_I2 SelectionMode SelectionMode WinCC Alarm Control (before

WinCC V7),
"SelTextColor" VT_I4 Selection Font Selection Font Text list
Color Color
"ServerName" VT_BSTR Server Name Server Name DAClockCtrl, WinCC Gauge
Control, WinCC Alarm Control
(before WinCC V7), PBut‐
tonCtrl, SliderCtrl,
WTVctrlCtrl,
"SignificantMask" VT_UI4 Bit Pattern Bit Pattern Group display
Group Display Group Display
"Sizeable" VT_BOOL Sizeable Sizeable Print job/Script diagnostics,
screen window
"ShowBar" VT_BOOL ShowBar ShowBar SliderCtrl
"ShowDanger" VT_BOOL ShowDanger ShowDanger WinCC Gauge Control,
"ShowDecimal‐ VT_BOOL ShowDecimal‐ ShowDecimal‐ WinCC Gauge Control,
Point" Point Point
"ShowNormal" VT_BOOL ShowNormal ShowNormal WinCC Gauge Control,
"ShowPeak" VT_BOOL ShowPeak ShowPeak WinCC Gauge Control,
"ShowPosition" VT_BOOL ShowPosition ShowPosition SliderCtrl
"ShowThumb" VT_BOOL ShowThumb ShowThumb SliderCtrl
"StartAngle" VT_I4 Start Angle Start Angle Elliptical arc, ellipse segment,
circular arc, circle segment
"Template" VT_BSTR Template Template Print job/Script diagnostics
"TemplateName" VT_BSTR TemplateName TemplateName WinCC Alarm Control (before
WinCC V7),
"Text" VT_BSTR Text Text Button, static text, check box,
radio box
"ThumbBackColor" VT_UI4 ThumbBackColor ThumbBackColor SliderCtrl
"TicColor" VT_UI4 TicColor TicColor WinCC Gauge Control,
"TicFont" VT_USER‐ TicFont TicFont WinCC Gauge Control,
DEFINED
"Ticks" VT_BOOL Ticks Ticks DAClockCtrl
"TicksColor" VT_UI4 TicksColor TicksColor DAClockCtrl
"TickStyle" VT_I4 TickStyle TickStyle SliderCtrl
"TicOffset" VT_R8 TicOffset TicOffset WinCC Gauge Control,
"TicTextColor" VT_UI4 TicTextColor TicTextColor WinCC Gauge Control,
"TicTextOffset" VT_R8 TicTextOffset TicTextOffset WinCC Gauge Control,
"TicWidth" VT_R8 TicWidth TicWidth WinCC Gauge Control,
"TitleCut" VT_BOOL TitleCut TitleCut WinCC Alarm Control (before
WinCC V7),
"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

WinCC Engineering V18 – Programming reference

1892 System Manual, 11/2022, Online documentation
 Runtime API
3.3 Functions of the graphic system

"ToolTipText" VT_BSTR Tooltip Text Tooltip Text Button, ellipse, elliptical arc,
ellipse segment, circle, circu‐
lar arc, circle segment, line,
polygon, polyline, rectangle,
rounded rectangle, static
text, 3-D bar, I/O field, bar,
graphic object, group display,
text list, status display, check
box, radio box, round button,
slider object, DAClockCtrl,
WinCC Gauge Control, WinCC
Alarm Control (before WinCC
V7), PButtonCtrl, SliderCtrl,
WTVctrlCtrl,
"Top" VT_I4 Y position Y position Button, ellipse, elliptical arc,
ellipse segment, circle, circu‐
lar arc, circle segment, line,
polygon, polyline, rectangle,
rounded rectangle, static
text, 3-D bar, print job/script
diagnostics, screen window,
I/O field, bar, graphic object,
group display, text list, status
display, check box, radio box,
round button, slider object,
DAClockCtrl, WinCC Gauge
Control, WinCC Alarm Control
(before WinCC V7), PBut‐
tonCtrl, SliderCtrl,
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"
"TypeWarningHigh" VT_BOOL Type WH Type WH Bar
"TypeWarningLow" VT_UI4 Type WL Type WL Bar
"UnitColor" VT_USER‐ UnitColor UnitColor WinCC Gauge Control,
DEFINED
"UnitFont" VT_BSTR UnitFont UnitFont WinCC Gauge Control,
"UnitText" VT_BSTR UnitText UnitText WinCC Gauge Control,
"UnitOffset" VT_R8 UnitOffset UnitOffset WinCC Gauge Control,
"UnselBGColor" VT_I4 List Background List Background Text list
Color Color

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1893
Runtime API
3.3 Functions of the graphic system

"UnselTextColor" VT_I4 List Font Color List Font Color Text list
"UpdateCycle" VT_I4 Update Cycle Update Cycle Screen window
"UseRefreshTimer" VT_BOOL UseRefreshTimer UseRefreshTimer WTVctrlCtrl
"UserValue1" VT_UI4 User Value 1 User Value 1 Group display
"UserValue2" VT_UI4 User Value 2 User Value 2 Group display
"UserValue3" VT_UI4 User Value 3 User Value 3 Group display
"UserValue4" VT_UI4 User Value 4 User Value 4 Group display
"Value" VT_R4 Value Value WinCC Gauge Control,
"ValueMax" VT_R4 ValueMax ValueMax WinCC Gauge Control,
"ValueMin" VT_R4 ValueMin ValueMin WinCC Gauge Control,
"VideoEnabled" VT_BOOL VideoEnabled VideoEnabled WTVctrlCtrl
"VideoSource" VT_I2 VideoSource VideoSource WTVctrlCtrl
"Visible" VT_BOOL Display Display All objects (incl. screen)
"Warning" VT_R4 Warning Warning WinCC Gauge Control,
"WarningColor" VT_UI4 WarningColor WarningColor WinCC Gauge Control,
"WarningHigh" VT_R8 Limit WH Limit WH Bar
"WarningLow" VT_R8 Limit WL Limit WL Bar
"Width" VT_I4 Width Width All objects except: Application
window, screen window
"WindowBorder" VT_BOOL Border Border Application window, screen
window, print job/script diag‐
nostics
"WindowsStyle" VT_BOOL Windows Style Windows Style Button, Slider object
"WindowType" VT_I2 WindowType WindowType WinCC Alarm Control (before
WinCC V7),
"WinTVInforma‐ VT_BSTR WinTVInforma‐ WTVctrlCtrl
tion" tion
"WithAxes" VT_BOOL WithAxes WithAxes SliderCtrl
"WithLabels" VT_BOOL WithLabels WithLabels SliderCtrl
"ZeroPoint" VT_UI4 Zero Point Zero Point 3-D bar, bar
"ZeroPointValue" VT_R8 Zero Point Value Zero Point Value 3-D bar, bar
Zoom VT_I4 Scaling Factor Scaling Factor Screen window

3.3.1.7 API calls to OCXs

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.

WinCC Engineering V18 – Programming reference

1894 System Manual, 11/2022, Online documentation
 Runtime API
3.3 Functions of the graphic system

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 Structures

3.3.2.1 LINKINFO

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
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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1895
Runtime API
3.3 Functions of the graphic system

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.

"On change" Index: 0

"250ms" Index: 1
: :
"User cycle 5" Index: 15
"Window cycle" Index: 235
"Screen cycle" Index: 255

szLinkName
Name of the tag connection

Required files
pdlrtapi.h
trigger.h

API functions

PDLRTGetLink (Page 1932) Query link between object property and tag
PDLRTSetLink (Page 1934) Define link between object property and tag

See also
PDLRTGetLink (Page 1932)
PDLRTSetLink (Page 1934)

WinCC Engineering V18 – Programming reference

1896 System Manual, 11/2022, Online documentation
 Runtime API
3.3 Functions of the graphic system

3.3.2.2 MULTILINK

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 1898) type with
information about the link between an object property and a tag.

Required files
pdlrtapi.h

API functions

PDLRTSetMultiLink (Page 1936) Define link between object property and tag (multiple tags)

See also
PDLRTSetMultiLink (Page 1936)
MULTILINKINFO (Page 1898)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1897
Runtime API
3.3 Functions of the graphic system

3.3.2.3 MULTILINKINFO

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.

"On change" Index: 0

"250ms" Index: 1
: :
"User cycle 5" Index: 15

pszLinkName
Pointer to name of the connection

Comments
The MULTILINKINFO structure is part of the MULTILINK (Page 1897) structure.

Required files
pdlrtapi.h

WinCC Engineering V18 – Programming reference

1898 System Manual, 11/2022, Online documentation
 Runtime API
3.3 Functions of the graphic system

See also
MULTILINK (Page 1897)

3.3.2.4 FOCUSINFO

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

PDLRTGetFocus (Page 1916) Query input focus

See also
PDLRTGetFocus (Page 1916)

3.3.3 General functions

3.3.3.1 PDLRTClosePicture

Use
Closes a screen in runtime mode.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1899
Runtime API
3.3 Functions of the graphic system

Declaration

BOOL PDLRTClosePicture(
ADRMODE adrMode,
LPCSTR lpszPictureName,
LPCSTR lpszWName,
PDLRT_CALLBACK pfn,
LPVOID pvUser,
PCMN_ERROR pError );

Parameters

adrMode
The parameter is reserved for future development and must be preset to 0.

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
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
Screen closed.

WinCC Engineering V18 – Programming reference

1900 System Manual, 11/2022, Online documentation
 Runtime API
3.3 Functions of the graphic system

FALSE
Error.

Required files
pdlrtapi.h
pdlrt_s.lib
pdlrtapi.dll

Related functions

PDLRT_CALLBACK (Page 1912) Callback function of the runtime functions

See also
PDLRT_CALLBACK (Page 1912)
Overview of the functions (Page 1871)

3.3.3.2 PDLRTDisableClosePicture

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,
LPCSTR lpszPictureName,
PDLRT_CALLBACK pfn,
LPVOID pvUser,
PCMN_ERROR pError );

Parameters

adrMode
The parameter is reserved for future development and must be preset to 0.

lpszPictureName
Pointer to the configured name of the screen, without path or extension.
The entry is case-sensitive.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1901
Runtime API
3.3 Functions of the graphic system

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
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

PDLRT_CALLBACK (Page 1912) Callback function of the runtime functions

See also
PDLRT_CALLBACK (Page 1912)
Overview of the functions (Page 1871)

WinCC Engineering V18 – Programming reference

1902 System Manual, 11/2022, Online documentation
 Runtime API
3.3 Functions of the graphic system

3.3.3.3 PDLRTEnableClosePicture

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,
LPCSTR lpszPictureName,
PDLRT_CALLBACK pfn,
LPVOID pvUser,
PCMN_ERROR pError );

Parameters

adrMode
The parameter is reserved for future development and must be preset to 0.

lpszPictureName
Pointer to the configured name of the screen, without path or extension.
The entry is case-sensitive.

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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1903
Runtime API
3.3 Functions of the graphic system

pError
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
Function successfully completed.

FALSE
Error.

Required files
pdlrtapi.h
pdlrt_s.lib
pdlrtapi.dll

Related functions

PDLRT_CALLBACK (Page 1912) Callback function of the runtime functions

See also
PDLRT_CALLBACK (Page 1912)
Overview of the functions (Page 1871)

3.3.3.4 PDLRTGotoPicture

Use
Loads the specified screen.

Declaration

BOOL PDLRTGotoPicture (
PDLRTGotoPict nextPict,
PCMN_ERROR pError );

WinCC Engineering V18 – Programming reference

1904 System Manual, 11/2022, Online documentation
 Runtime API
3.3 Functions of the graphic system

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
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
Screen loaded.

FALSE
Error.

Error messages

PDLRT_NO_PIC Screen not selected

Required files
pdlrtapi.h
pdlrt_s.lib
pdlrtapi.dll

Related functions

PDLRTPictureNavigation (Page 1910) Enable and disable screen navigation

See also
PDLRTPictureNavigation (Page 1910)
Overview of the functions (Page 1871)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1905
Runtime API
3.3 Functions of the graphic system

3.3.3.5 PDLRTInquireFreeArea

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,
PCMN_ERROR pError );

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
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.

WinCC Engineering V18 – Programming reference

1906 System Manual, 11/2022, Online documentation
 Runtime API
3.3 Functions of the graphic system

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
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
Window area is free.

FALSE
Error.

Required files
pdlrtapi.h
pdlrt_s.lib
pdlrtapi.dll

Related functions

PDLRT_CALLBACK (Page 1912) Callback function of the runtime functions

See also
PDLRT_CALLBACK (Page 1912)
Overview of the functions (Page 1871)

3.3.3.6 PDLRTOpenPicture

Use
The function performs a start screen change in the runtime.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1907
Runtime API
3.3 Functions of the graphic system

Declaration

BOOL PDLRTOpenPicture(
ADRMODE adrMode,
LPCSTR lpszPictureName,
LPCSTR lpszWName,
LPCSTR lpszPictureFileName,
DWORD dwWinStyle,
LONG lxPos,
LONG lyPos,
LONG lWitdh,
LONG lHeight,
PDLRT_CALLBACK pfn,
LPVOID pvUser,
PCMN_ERROR pError );

Parameters

adrMode
Pointer to the configured name of the screen, without path or extension.
The entry is case-sensitive.

lpszWName
This parameter must be currently supplied with the screen name.

lpszPictureFileName
This parameter must be currently supplied with the screen name.

dwWinStyle
The parameter is reserved for future development and must be preset to 0.

lxPos
The parameter is reserved for future development and must be preset to 0.

lyPos
The parameter is reserved for future development and must be preset to 0.

lWidth
The parameter is reserved for future development and must be preset to 0.

lHeigth
The parameter is reserved for future development and must be preset to 0.

pfn
Pointer to your callback function. This is called to notify you about the success or failure of
the request.

WinCC Engineering V18 – Programming reference

1908 System Manual, 11/2022, Online documentation
 Runtime API
3.3 Functions of the graphic system

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
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
Start screen change performed.

FALSE
Error.

Error messages

PDLRT_PICTURE_ALREADY_OPEN Screen is already open

PDLRT_NO_PIC Screen not selected
PDLRT_BAD_OLE_CONVERSION Error in conversion through OLE automation

Required files
pdlrtapi.h
pdlrt_s.lib
pdlrtapi.dll

Related functions

PDLRT_CALLBACK (Page 1912) Callback function of the runtime functions

See also
PDLRT_CALLBACK (Page 1912)
Overview of the functions (Page 1871)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1909
Runtime API
3.3 Functions of the graphic system

3.3.3.7 PDLRTPictureNavigation

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,
PCMN_ERROR pError );

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
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
Function successfully completed.

FALSE
Error.
Cause: Screen navigation was already switched on or off.

Required files
pdlrtapi.h
pdlrt_s.lib
pdlrtapi.dll

WinCC Engineering V18 – Programming reference

1910 System Manual, 11/2022, Online documentation
 Runtime API
3.3 Functions of the graphic system

Related functions

PDLRTGotoPicture (Page 1904) Load specified screen

See also
PDLRTGotoPicture (Page 1904)
Overview of the functions (Page 1871)

3.3.3.8 PDLRTShowApp

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,
PCMN_ERROR pError );

Parameters

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
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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1911
Runtime API
3.3 Functions of the graphic system

Return value

TRUE
Runtime window in foreground.

FALSE
Error.

Required files
pdlrtapi.h
pdlrt_s.lib
pdlrtapi.dll

Related functions

PDLRT_CALLBACK (Page 1912) Callback function

See also
PDLRT_CALLBACK (Page 1912)
Overview of the functions (Page 1871)

3.3.3.9 PDLRT_CALLBACK

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,
PCMN_ERROR pError );

Parameters

pvUser
Pointer to application-specific data. This pointer is made available as a parameter of the API
function and returned again here unchanged.

WinCC Engineering V18 – Programming reference

1912 System Manual, 11/2022, Online documentation
 Runtime API
3.3 Functions of the graphic system

pError
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
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.
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.
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.
It makes sense to use a separate callback for each API function.

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 callback may already be delivered before the function call has returned.

Required files
pdlrtapi.h

See also
PDLRTClosePicture (Page 1899)
PDLRTDisableClosePicture (Page 1901)
PDLRTEnableClosePicture (Page 1903)
PDLRTInquireFreeArea (Page 1906)
PDLRTOpenPicture (Page 1907)
PDLRTShowApp (Page 1911)
PDLRTSetLink (Page 1934)
PDLRTSetMultiLink (Page 1936)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1913
Runtime API
3.3 Functions of the graphic system

PDLRTGetLink (Page 1932)

PDLRTSetPropEx (Page 1928)
PDLRTGetPropEx (Page 1925)
PDLRTGetDefPropEx (Page 1922)
PDLRTSetFocus (Page 1920)
PDLRTSetCursorKeys (Page 1918)
PDLRTGetFocus (Page 1916)
PDLRTGetCursorKeys (Page 1914)
Overview of the functions (Page 1871)

3.3.4 Functions for affecting the runtime cursor

3.3.4.1 PDLRTGetCursorKeys

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,
PCMN_ERROR pError );

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.

WinCC Engineering V18 – Programming reference

1914 System Manual, 11/2022, Online documentation
 Runtime API
3.3 Functions of the graphic system

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
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
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
Cursor control keys determined.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1915
Runtime API
3.3 Functions of the graphic system

FALSE
Error.

Required files
pdlrtapi.h
pdlrt_s.lib
pdlrtapi.dll

Related functions

PDLRTSetCursorKeys (Page 1918) Set cursor control keys

PDLRT_CALLBACK (Page 1912) Callback function

See also
PDLRTSetCursorKeys (Page 1918)
PDLRT_CALLBACK (Page 1912)
Overview of the functions (Page 1871)

3.3.4.2 PDLRTGetFocus

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,
PCMN_ERROR pError );

WinCC Engineering V18 – Programming reference

1916 System Manual, 11/2022, Online documentation
 Runtime API
3.3 Functions of the graphic system

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

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 value can be ORed.

pFocusInfo
Pointer to the FOCUSINFO (Page 1899) structure in which the results are stored.

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
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
Input focus determined.

FALSE
Error.

Required files
pdlrtapi.h
pdlrt_s.lib
pdlrtapi.dll

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1917
Runtime API
3.3 Functions of the graphic system

Related functions

PDLRTSetFocus (Page 1920) Set input focus

PDLRT_CALLBACK (Page 1912) Callback function

See also
FOCUSINFO (Page 1899)
PDLRTSetFocus (Page 1920)
PDLRT_CALLBACK (Page 1912)
Overview of the functions (Page 1871)

3.3.4.3 PDLRTSetCursorKeys

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,
PCMN_ERROR pError );

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.

WinCC Engineering V18 – Programming reference

1918 System Manual, 11/2022, Online documentation
 Runtime API
3.3 Functions of the graphic system

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
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
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
Cursor control keys defined.

FALSE
Error.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1919
Runtime API
3.3 Functions of the graphic system

Required files
pdlrtapi.h
pdlrt_s.lib
pdlrtapi.dll

Related functions

PDLRTGetCursorKeys (Page 1914) Query cursor control keys

PDLRT_CALLBACK (Page 1912) Callback function

See also
PDLRTGetCursorKeys (Page 1914)
PDLRT_CALLBACK (Page 1912)
Overview of the functions (Page 1871)

3.3.4.4 PDLRTSetFocus

Use
The function is used to set the input focus. The object is determined by lpszPictureName and
lpszObjectName.

Declaration

BOOL PDLRTSetFocus (
ADRMODE adrMode,
LPCSTR lpszPictureName,
LPCSTR lpszObjectName,
PDLRT_CALLBACK pfn,
LPVOID pvUser,
PCMN_ERROR pError );

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

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 value can be ORed.

WinCC Engineering V18 – Programming reference

1920 System Manual, 11/2022, Online documentation
 Runtime API
3.3 Functions of the graphic system

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
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
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
Input focus set

FALSE
Error

Error messages

PDLRT_NO_PIC Screen not selected

PDLRT_NO_OBJ Cannot find object

Required files
pdlrtapi.h
pdlrt_s.lib
pdlrtapi.dll

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1921
Runtime API
3.3 Functions of the graphic system

Related functions

PDLRTGetFocus (Page 1916) Query input focus

PDLRT_CALLBACK (Page 1912) Callback function

See also
PDLRTGetFocus (Page 1916)
PDLRT_CALLBACK (Page 1912)
Overview of the functions (Page 1871)

3.3.5 Functions for processing object properties

3.3.5.1 PDLRTGetDefPropEx

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 lpszPictureName,
LPCSTR lpszObjectName,
LPCSTR lpszPropName,
VARTYPE vt,
LPVOID pvProp,
PDLRT_CALLBACK pfn,
LPVOID pvUser,
DWORD dwFlags,
LPVOID pData,
PCMN_ERROR pError );

WinCC Engineering V18 – Programming reference

1922 System Manual, 11/2022, Online documentation
 Runtime API
3.3 Functions of the graphic system

Parameters

adrMode
The adrMode parameter is used to set the addressing mode of the screen to be edited.

PDLRT_AM_DEFAULT 0 The addressing of screen and object is relative

PDLRT_AM_PICTABS 0 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 value can be ORed.

lpszPictureName
Pointer to the configured name of the screen according to addressing mode defined by
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
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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1923
Runtime API
3.3 Functions of the graphic system

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.

dwFlags
The parameter is reserved for future development and must be preset to 0.

pData
The parameter is reserved for future development and must be preset to NULL.

pError
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
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

PDLRT_BAD_OLE_CONVERSION Error in conversion through OLE automation

Required files
pdlrtapi.h
pdlrt_s.lib
pdlrtapi.dll

WinCC Engineering V18 – Programming reference

1924 System Manual, 11/2022, Online documentation
 Runtime API
3.3 Functions of the graphic system

Related functions

PDLRT_CALLBACK (Page 1912) Callback function

See also
PDLRT_CALLBACK (Page 1912)
Overview of the functions (Page 1871)

3.3.5.2 PDLRTGetPropEx

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,
LPCSTR lpszPictureName,
LPCSTR lpszObjectName,
LPCSTR lpszPropName,
VARTYPE vt,
LPVOID pvProp,
PDLRT_CALLBACK pfn,
LPVOID pvUser,
DWORD dwFlags,
LPVOID pData,
PCMN_ERROR pError );

Parameters

adrMode
The adrMode parameter is used to set the addressing mode of the screen to be edited.

PDLRT_AM_DEFAULT 0 The addressing of screen and object is relative

PDLRT_AM_PICTABS 0 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 value can be ORed.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1925
Runtime API
3.3 Functions of the graphic system

lpszPictureName
Pointer to the configured name of the screen according to addressing mode defined by
adrMode. The entry is case-sensitive.

lpszObjectName
Pointer to the configured name of the object according to addressing mode defined by
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
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.

dwFlags
The parameter is reserved for future development and must be preset to 0.

WinCC Engineering V18 – Programming reference

1926 System Manual, 11/2022, Online documentation
 Runtime API
3.3 Functions of the graphic system

pData
The parameter is reserved for future development and must be preset to NULL.

pError
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
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

PDLRT_NO_PIC Screen not selected

PDLRT_BAD_OLE_CONVERSION Error in conversion through OLE automation
PDLRT_NO_PROP Cannot find property

Required files
pdlrtapi.h
pdlrt_s.lib
pdlrtapi.dll

Related functions

PDLRTSetPropEx (Page 1928) Set property

PDLRT_CALLBACK (Page 1912) Callback function

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1927
Runtime API
3.3 Functions of the graphic system

See also
PDLRT_CALLBACK (Page 1912)
PDLRTSetPropEx (Page 1928)
Overview of the functions (Page 1871)

3.3.5.3 PDLRTSetPropEx

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,
LPCSTR lpszPictureName,
LPCSTR lpszObjectName,
LPCSTR lpszPropName,
VARTYPE vt,
LPVOID pvProp,
PDLRT_CALLBACK pfn,
LPVOID pvUser,
DWORD dwFlags,
LPVOID pData,
PCMN_ERROR pError );

Parameters

adrMode
The adrMode parameter is used to set the addressing mode of the screen to be edited.

PDLRT_AM_DEFAULT 0 The addressing of screen and object is relative

PDLRT_AM_PICTABS 0 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 value can be ORed.

lpszPictureName
Pointer to the configured name of the screen according to addressing mode defined by
adrMode. The entry is case-sensitive.

WinCC Engineering V18 – Programming reference

1928 System Manual, 11/2022, Online documentation
 Runtime API
3.3 Functions of the graphic system

lpszObjectName
Pointer to the configured object name according to addressing mode defined by 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 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*
VT_xxxx pvProp must point to a buffer

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 is made available again in the callback function.

dwFlags
The parameter is reserved for future development and must be preset to 0.

pData
The parameter is reserved for future development and must be preset to ZERO.

pError
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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1929
Runtime API
3.3 Functions of the graphic system

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_NO_PIC Screen not selected

PDLRT_PICTURE_NOT_LOADED Cannot load screen file
PDLRT_FAILURE_PARAM Wrong parameter
PDLRT_NO_OBJ Cannot find object
PDLRT_NO_PROP Cannot find property
PDLRT_BAD_OLE_CONVERSION Error in conversion through OLE automation

Required files
pdlrtapi.h
pdlrt_s.lib
pdlrtapi.dll

Related functions

PDLRTGetPropEx (Page 1925) Query property

PDLRT_CALLBACK (Page 1912) Callback function

WinCC Engineering V18 – Programming reference

1930 System Manual, 11/2022, Online documentation
 Runtime API
3.3 Functions of the graphic system

Example

#pragma code("pdlrtapi.dll")

#include "apdefap.h"

#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
PDLRT_CALLBACK (Page 1912)
PDLRTGetPropEx (Page 1925)
Overview of the functions (Page 1871)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1931
Runtime API
3.3 Functions of the graphic system

3.3.6 Functions for processing dynamics

3.3.6.1 PDLRTGetLink

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,
LPCSTR lpszPictureName,
LPCSTR lpszObjectName,
LPCSTR lpszPropName,
LPLINKINFO pLink,
PDLRT_CALLBACK pfn,
LPVOID pvUser,
PCMN_ERROR pError );

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

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 value can be ORed.

lpszPictureName
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.

lpszPropName
Pointer on the name of the object property.

pLink
Pointer to the LINKINFO (Page 1895) structure in which the link information is stored.

WinCC Engineering V18 – Programming reference

1932 System Manual, 11/2022, Online documentation
 Runtime API
3.3 Functions of the graphic system

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
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
Link determined.

FALSE
Error.

Error messages

PDLRT_NO_LINK Property has no dynamics

Required files
pdlrtapi.h
pdlrt_s.lib
pdlrtapi.dll

Related functions

PDLRTSetLink (Page 1934) Define link between object property and tag
PDLRT_CALLBACK (Page 1912) Callback function

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1933
Runtime API
3.3 Functions of the graphic system

See also
PDLRTSetLink (Page 1934)
PDLRT_CALLBACK (Page 1912)
LINKINFO (Page 1895)
Overview of the functions (Page 1871)

3.3.6.2 PDLRTSetLink

Use
Set a link between a property and a tag.

Declaration

BOOL PDLRTSetLink (
ADRMODE adrMode,
LPCSTR lpszPictureName,
LPCSTR lpszObjectName,
LPCSTR lpszPropName,
LPLINKINFO pLink,
PDLRT_CALLBACK pfn,
LPVOID pvUser,
PCMN_ERROR pError );

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

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 value can be ORed.

lpszPictureName
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.

lpszPropName
Pointer on the name of the object property.

WinCC Engineering V18 – Programming reference

1934 System Manual, 11/2022, Online documentation
 Runtime API
3.3 Functions of the graphic system

pLink
Pointer to the LINKINFO (Page 1895) 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
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
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
Link set

FALSE
Error

Error messages

PDLRT_FAILURE_PARAM Wrong parameter

PDLRT_NO_PIC Screen not selected
PDLRT_NO_OBJ Cannot find object
PDLRT_LINK_NOT_SET Cannot link property

Required files
pdlrtapi.h
pdlrt_s.lib
pdlrtapi.dll

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1935
Runtime API
3.3 Functions of the graphic system

Related functions

PDLRTGetLink (Page 1932) Determine link between object property and tag
PDLRTSetMultiLink (Page 1936) Define link between object property and tag (multiple tags)
PDLRT_CALLBACK (Page 1912) Callback function

See also
PDLRTGetLink (Page 1932)
PDLRTSetMultiLink (Page 1936)
PDLRT_CALLBACK (Page 1912)
LINKINFO (Page 1895)
Overview of the functions (Page 1871)

3.3.6.3 PDLRTSetMultiLink

Use
Set multiple links between a property and a tag.

Declaration

BOOL PDLRTSetMultiLink (
ADRMODE adrMode,
LPCSTR lpszPictureName,
LPMULTILINK pMultiLink,
PDLRT_CALLBACK pfn,
LPVOID pvUser,
PCMN_ERROR pError );

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

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 value can be ORed.

lpszPictureName
Pointer to the configured name of the screen according to addressing mode defined by
adrMode without extension. The entry is case-sensitive.

WinCC Engineering V18 – Programming reference

1936 System Manual, 11/2022, Online documentation
 Runtime API
3.3 Functions of the graphic system

pMultiLink
Pointer to the MULTILINK (Page 1897) structure in which a field with link information is
stored.

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.

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_FAILURE_PARAM Wrong parameter

PDLRT_NO_PIC Screen not selected
PDLRT_NO_OBJ Cannot find object
PDLRT_LINK_NOT_SET Cannot link property

Required files
pdlrtapi.h
pdlrt_s.lib
pdlrtapi.dll

Related functions

PDLRTSetLink (Page 1934) Define link between object property and tag
PDLRT_CALLBACK (Page 1912) Callback function

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1937
Runtime API
3.4 Scripting functions

See also
PDLRTSetLink (Page 1934)
PDLRT_CALLBACK (Page 1912)
MULTILINK (Page 1897)
Overview of the functions (Page 1871)

3.4 Scripting functions

3.4.1 Basics

3.4.1.1 Overview of the functions

Overview

AP_RT_PROC (Page 1953) Notification of runtime functions

APActive (Page 1965) Activate action
APCompile (Page 1956) Compile source code
APCompileEx (Page 1958) Compile source code
APConnect (Page 1948) Logon application
APDisconnect (Page 1950) Logoff application
APEndAct (Page 1967) Logon action in the application control
APFreeResultStruct (Page 1968) Free action result memory
APInactive (Page 1969) Deactivate actions
APSetLanguage (Page 1952) Set language for error texts
APStart (Page 1971) Start action
APTransact (Page 1974) Logon actions for processing
GSCGenCompile (Page 1961) Compile action
GSCGenCompileUserFunctions Compile user functions
(Page 1962)
GSCGenGetActionStream (Page 1964) Determine action stream

3.4.1.2 Overview of structures

Overview

AP_ACT_KEY (Page 1943) Action identification

AP_ACT_RESULT_STRUCT (Page 1945) Action result
CREATE_USER_HEADER_FILE (Page 1946) Create header file of user functions

WinCC Engineering V18 – Programming reference

1938 System Manual, 11/2022, Online documentation
 Runtime API
3.4 Scripting functions

GENERATE_COMPILE (Page 1947) Generate action

GET_ACTION_STREAM (Page 1947) Determine action stream

3.4.1.3 Error messages

Overview
The following error messages can be returned by the API functions in the CMN_ERROR error
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 ac‐
tion 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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1939
Runtime API
3.4 Scripting functions

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 can‐
celled.
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. Mod‐
ule 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 action
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.

WinCC Engineering V18 – Programming reference

1940 System Manual, 11/2022, Online documentation
 Runtime API
3.4 Scripting functions

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

3.4.1.4 Constants

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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1941
Runtime API
3.4 Scripting functions

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_04 4 Reflects cycle time of 2 s in the Control Center
AP_TRIG_CYCLE_05 5 Reflects cycle time of s in the Control Center
AP_TRIG_CYCLE_06 6 Reflects cycle time of 10 s in the Control Center
AP_TRIG_CYCLE_07 7 Reflects cycle time of 1 min in the Control Center
AP_TRIG_CYCLE_08 8 Reflects cycle time of 5 min in the Control Center
AP_TRIG_CYCLE_09 9 Reflects cycle time of 10 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
AP_TRIG_CYCLE_12 12 Reflects cycle time of "User defined 2" in the Control Center
AP_TRIG_CYCLE_13 13 Reflects cycle time of "User defined 3" in the Control Center
AP_TRIG_CYCLE_14 14 Reflects cycle time of "User defined 4" in the Control Center
AP_TRIG_CYCLE_15 15 Reflects cycle time of "User defined 5" in the Control Center

WinCC Engineering V18 – Programming reference

1942 System Manual, 11/2022, Online documentation
 Runtime API
3.4 Scripting functions

3.4.2 Structures

3.4.2.1 AP_ACT_KEY

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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1943
Runtime API
3.4 Scripting functions

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
Pointer to application-specific data. This pointer is not evaluated by the function but provided
again in the callback function.

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

APActive (Page 1965) Activate action

APInactive (Page 1969) Deactivate actions

WinCC Engineering V18 – Programming reference

1944 System Manual, 11/2022, Online documentation
 Runtime API
3.4 Scripting functions

APStart (Page 1971) Start action

APTransact (Page 1974) Logon actions for processing

See also
APActive (Page 1965)
APInactive (Page 1969)
APStart (Page 1971)
APTransact (Page 1974)

3.4.2.2 AP_ACT_RESULT_STRUCT

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
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.

dwreserved
The parameter is reserved for future development and must be preset to 0.

Required files
ap_def.h

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1945
Runtime API
3.4 Scripting functions

API functions

APFreeResultStruct (Page 1968) Free action result memory

APStart (Page 1971) Start action

See also
APFreeResultStruct (Page 1968)
APStart (Page 1971)

3.4.2.3 CREATE_USER_HEADER_FILE

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 1962) Compile user functions

WinCC Engineering V18 – Programming reference

1946 System Manual, 11/2022, Online documentation
 Runtime API
3.4 Scripting functions

See also
GSCGenCompileUserFunctions (Page 1962)

3.4.2.4 GENERATE_COMPILE

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 1961) Compile action

See also
GSCGenCompile (Page 1961)

3.4.2.5 GET_ACTION_STREAM

Declaration

typedef struct {
char* pszPathName;
DWORD dwType;
} GET_ACTION_STREAM, *LPGET_ACTION_STREAM ;

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1947
Runtime API
3.4 Scripting functions

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 1964) Determine action stream

See also
GSCGenGetActionStream (Page 1964)

3.4.3 General functions

3.4.3.1 APConnect

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 )

WinCC Engineering V18 – Programming reference

1948 System Manual, 11/2022, Online documentation
 Runtime API
3.4 Scripting functions

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
messages could block WinCC notifications or finally block WinCC altogether.

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
Pointer to application-specific data. This pointer is not evaluated by the function but provided
again in the callback function.
If lpvUser is not used, it must be assigned with NULL.

pError
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
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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1949
Runtime API
3.4 Scripting functions

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 1950) Disconnect connection to action control
APTransact (Page 1974) Logon action for processing
AP_RT_PROC (Page 1953) Callback function

Examples
Establish connection to script programming (Page 1976) "AP01.cpp"

See also
DMConnect (Page 1630)
APTransact (Page 1974)
AP_RT_PROC (Page 1953)
APDisconnect (Page 1950)
Establish connection to script programming (Page 1976)
Overview of the functions (Page 1938)

3.4.3.2 APDisconnect

Description
The function logs off an application in the action control.

WinCC Engineering V18 – Programming reference

1950 System Manual, 11/2022, Online documentation
 Runtime API
3.4 Scripting functions

Declaration

BOOL APDisconnect (
AP_RT_PROC fpAppBack,
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
messages could block WinCC notifications or finally block WinCC altogether.

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
Pointer to application-specific data. This pointer is not evaluated by the function but provided
again in the callback function.

pError
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
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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1951
Runtime API
3.4 Scripting functions

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 1948) Set up connection to action control

APTransact (Page 1974) Logon action for processing
AP_RT_PROC (Page 1953) Callback function

Examples
Establish connection to script programming (Page 1976) "AP01.cpp"

See also
APTransact (Page 1974)
APConnect (Page 1948)
AP_RT_PROC (Page 1953)
Establish connection to script programming (Page 1976)
Overview of the functions (Page 1938)

3.4.3.3 APSetLanguage

Description
The language in which the error texts are to be output is set with this function.

WinCC Engineering V18 – Programming reference

1952 System Manual, 11/2022, Online documentation
 Runtime API
3.4 Scripting functions

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
Overview of the functions (Page 1938)

3.4.3.4 AP_RT_PROC

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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1953
Runtime API
3.4 Scripting functions

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.

WinCC Engineering V18 – Programming reference

1954 System Manual, 11/2022, Online documentation
 Runtime API
3.4 Scripting functions

lpvUser
Pointer to application-specific data. This pointer is not evaluated by the function but provided
again in the callback function.

Return value

TRUE
Function successful

FALSE
Error

Comment

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 callback may already be delivered before the function call has returned.

Required files
ap_def.h

Related functions

APActive (Page 1965) Activate action

APConnect (Page 1948) Logon application
APDisconnect (Page 1950) Logoff application
APEndAct (Page 1967) Logon action in the application control
APInactive (Page 1969) Deactivate actions
APStart (Page 1971) Start action
APTransact (Page 1974) Logon actions for processing

Examples
Establish connection to script programming (Page 1976) "AP01.cpp"

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1955
Runtime API
3.4 Scripting functions

See also
APConnect (Page 1948)
APDisconnect (Page 1950)
APActive (Page 1965)
APEndAct (Page 1967)
APInactive (Page 1969)
APStart (Page 1971)
APTransact (Page 1974)
Establish connection to script programming (Page 1976)
Overview of the functions (Page 1938)

3.4.4 Functions for processing Source Code

3.4.4.1 APCompile

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.

WinCC Engineering V18 – Programming reference

1956 System Manual, 11/2022, Online documentation
 Runtime API
3.4 Scripting functions

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
Pointer to application-specific data. This pointer is not evaluated by the function but provided
again in the Callback-Funktion.

pError
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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1957
Runtime API
3.4 Scripting functions

Return value

TRUE
Source code compiled successfully

FALSE
Error

Required files
ap_def.h
apcli_S.lib
apclient.dll

Related functions

APCompileEx (Page 1958) Compile source code

APFreePCode Free source code memory

See also
APCompileEx (Page 1958)
Overview of the functions (Page 1938)

3.4.4.2 APCompileEx

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.

WinCC Engineering V18 – Programming reference

1958 System Manual, 11/2022, Online documentation
 Runtime API
3.4 Scripting functions

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
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.

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.

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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1959
Runtime API
3.4 Scripting functions

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
Pointer to application-specific data. This pointer is not evaluated by the function but provided
again in the Callback-Funktion.

pError
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
Source code compiled successfully

WinCC Engineering V18 – Programming reference

1960 System Manual, 11/2022, Online documentation
 Runtime API
3.4 Scripting functions

FALSE
Error

Required files
ap_def.h
apcli_S.lib
apclient.dll

Related functions

APCompile (Page 1956) Compile source code

APFreePCode Free source code memory

See also
APCompile (Page 1956)
Overview of the functions (Page 1938)

3.4.4.3 GSCGenCompile

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 1947) structure.

hWndParent
Handle to the window in which the status outputs are to be made.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1961
Runtime API
3.4 Scripting functions

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
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
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 1947)
Overview of the functions (Page 1938)

3.4.4.4 GSCGenCompileUserFunctions

Description
The function recompiles all special user functions.

WinCC Engineering V18 – Programming reference

1962 System Manual, 11/2022, Online documentation
 Runtime API
3.4 Scripting functions

Declaration

BOOL GSCGenCompileUserFunctions (
LPCREATE_USER_HEADER_FILE pGenCUHF,
HWND hWndParent,
LPCMN_ERROR lpdmError)

Parameters

pGenCUHF
Pointer to the CREATE_USER_HEADER_FILE (Page 1946) structure.

hWndParent
Handle to the window in which the status outputs are to be made.

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
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 1946)
Overview of the functions (Page 1938)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1963
Runtime API
3.4 Scripting functions

3.4.5 Functions for processing actions

3.4.5.1 GSCGenGetActionStream

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,
LPCMN_ERROR lpdmError)

Parameters

pGenGAS
Pointer to structure of the GET_ACTION_STREAM (Page 1947) 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
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
Pointer to the action stream.

Required files
capigsc.h
gscgr_s.lib
gscgen.dll

See also
GET_ACTION_STREAM (Page 1947)
Overview of the functions (Page 1938)

WinCC Engineering V18 – Programming reference

1964 System Manual, 11/2022, Online documentation
 Runtime API
3.4 Scripting functions

3.4.6 Functions of the action programming

3.4.6.1 APActive

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,
AP_RT_PROC fpAppBack,
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 1943).

fpAppBack
Your callback function for the asynchronous call. The call is performed synchronously when
using NULL.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1965
Runtime API
3.4 Scripting functions

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.

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
Pointer to application-specific data. This pointer is not evaluated by the function but provided
again in the callback function.

pError
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
Action activated

FALSE
Error.

Required files
ap_def.h
apcli_S.lib
apclient.dll

Related functions

APInactive (Page 1969) Deactivate actions

APTransact (Page 1974) Logon action for processing
AP_RT_PROC (Page 1953) Callback function

See also
AP_RT_PROC (Page 1953)
AP_ACT_KEY (Page 1943)
APInactive (Page 1969)
APTransact (Page 1974)
Overview of the functions (Page 1938)

WinCC Engineering V18 – Programming reference

1966 System Manual, 11/2022, Online documentation
 Runtime API
3.4 Scripting functions

3.4.6.2 APEndAct

Description
The action logged on for processing is logged off in the action control.

Declaration

BOOL APEndAct (
AP_RT_PROC fpAppBack,
PDWORD pdwOrderId,
const PDWORD pdwOrderEnd,
LPCVOID lpvUser,
PCMN_ERROR pError )

Parameters

fpAppBack
Your callback function for the asynchronous call. The call is performed synchronously when
using NULL.
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.

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.

pdwOrderEnd
Job number of the transaction which is to be ended.

lpvUser
Pointer to application-specific data. This pointer is not evaluated by the function but provided
again in the callback function.

pError
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
Action logged off

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1967
Runtime API
3.4 Scripting functions

FALSE
Error.

Required files
ap_def.h
apcli_S.lib
apclient.dll

Related functions

APTransact (Page 1974) Logon action for processing

AP_RT_PROC (Page 1953) Callback function

See also
AP_RT_PROC (Page 1953)
APTransact (Page 1974)
Overview of the functions (Page 1938)

3.4.6.3 APFreeResultStruct

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 1945) type.

dwItems
Number of structures AP_ACT_RESULT_STRUCT.

WinCC Engineering V18 – Programming reference

1968 System Manual, 11/2022, Online documentation
 Runtime API
3.4 Scripting functions

Return value

TRUE
Free memory.

FALSE
Error.

Required files
ap_def.h
apcli_S.lib
apclient.dll

Related functions

APStart (Page 1971) Processing of action started

See also
APStart (Page 1971)
AP_ACT_RESULT_STRUCT (Page 1945)
Overview of the functions (Page 1938)

3.4.6.4 APInactive

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,
const DWORD dwItems,
AP_RT_PROC fpAppBack,
PDWORD pdwOrderId,
LPCVOID lpvUser,
PCMN_ERROR pError )

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1969
Runtime API
3.4 Scripting functions

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 1943).

fpAppBack
Your callback function for the asynchronous call. The call is performed synchronously when
using NULL.
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.

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
Pointer to application-specific data. This pointer is not evaluated by the function but provided
again in the callback function.

pError
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
Action deactivated

WinCC Engineering V18 – Programming reference

1970 System Manual, 11/2022, Online documentation
 Runtime API
3.4 Scripting functions

FALSE
Error.

Required files
ap_def.h
apcli_S.lib
apclient.dll

Related functions

APActive (Page 1965) Activate actions

APTransact (Page 1974) Logon action for processing
AP_RT_PROC (Page 1953) Callback function

See also
AP_RT_PROC (Page 1953)
APActive (Page 1965)
AP_ACT_KEY (Page 1943)
APTransact (Page 1974)
Overview of the functions (Page 1938)

3.4.6.5 APStart

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,
const DWORD dwItems,
AP_RT_PROC fpAppBack,
AP_RT_PROC fpAppResult,
PDWORD pdwOrderId,
PAP_ACT_RESULT_STRUCT *lpapars,
LPCVOID lpUser,
PCMN_ERROR pError )

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1971
Runtime API
3.4 Scripting functions

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 1943).

fpAppBack
Your callback function for the asynchronous call. The call is performed synchronously when
using NULL.
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.

fAppResult
Your callback function for cyclic action results. The structures of the AP_ACT_RESULT_STRUCT
(Page 1945) type are supplied in the callback function. In synchronous call lpapars is assigned
with the result.

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.

lpapars
Pointer to the action result in synchronous call. An array of structures of the
AP_ACT_RESULT_STRUCT (Page 1945) 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

WinCC Engineering V18 – Programming reference

1972 System Manual, 11/2022, Online documentation
 Runtime API
3.4 Scripting functions

lpvUser
Pointer to application-specific data. This pointer is not evaluated by the function but provided
again in the callback function.

pError
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
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 1968) Free memory

AP_RT_PROC (Page 1953) Callback function

See also
AP_RT_PROC (Page 1953)
APFreeResultStruct (Page 1968)
AP_ACT_KEY (Page 1943)
AP_ACT_RESULT_STRUCT (Page 1945)
Overview of the functions (Page 1938)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1973
Runtime API
3.4 Scripting functions

3.4.6.6 APTransact

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

WinCC Engineering V18 – Programming reference

1974 System Manual, 11/2022, Online documentation
 Runtime API
3.4 Scripting functions

Examples
Auto-Hotspot "DM01.cpp"

See also
APConnect (Page 1948)
APDisconnect (Page 1950)
AP_RT_PROC (Page 1953)
APActive (Page 1965)
APEndAct (Page 1967)
APInactive (Page 1969)
AP_ACT_KEY (Page 1943)
Overview of the functions (Page 1938)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1975
Runtime API
3.4 Scripting functions

3.4.7 Examples

3.4.7.1 Establish connection to script programming

Overview

WinCC Engineering V18 – Programming reference

1976 System Manual, 11/2022, Online documentation
 Runtime API
3.4 Scripting functions

// =====================================================================
// 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
memset(&Error, 0, sizeof(CMN_ERROR));
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"),
Error.dwError1, Error.dwError2, Error.szErrorText);
}
else
{

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1977
Runtime API
3.5 Functions of the user administration

_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;
memset(&Error, 0, sizeof(CMN_ERROR));
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"),
Error.dwError1, Error.dwError2, Error.szErrorText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("APDisconnect"));
}
ODKTrace(szText);
}
// --------------------------------------------------------------------
//{{ODK_EXAMPLE}(END)}

See also
APConnect (Page 1948)
APDisconnect (Page 1950)
AP_RT_PROC (Page 1953)

3.5 Functions of the user administration

3.5.1 Basics

3.5.1.1 Overview of the functions

Overview

PWGEN_ENUM_GROUPS_CALLBACK (Page 2000) List user groups (callback)

PWGEN_ENUM_LEVELS_CALLBACK (Page 2006) List authorization levels (callback)
PWGEN_ENUM_USERS_CALLBACK (Page 1995) List users (callback)

WinCC Engineering V18 – Programming reference

1978 System Manual, 11/2022, Online documentation
 Runtime API
3.5 Functions of the user administration

PWGENAddGroup (Page 1997) Create user group

PWGENAddPermLevel (Page 2001) Create authorization level
PWGENAddUser (Page 1986) Create user
PWGENAddUserEx (Page 1988) Create user
PWGENChangePassword (Page 1990) Change password
PWGENCheckPermission (Page 2002) Verify user authorizations of a user
PWGENCheckUser (Page 1991) Check user
PWGENConnect (Page 1983) Establish connection to the database.
PWGENDeletePermLevel (Page 2004) Delete authorization level
PWGENDeleteUser (Page 1992) Delete user/delete user group
PWGENDisconnect (Page 1985) Terminate connection to the database
PWGENEnumGroups (Page 1998) List user groups
PWGENEnumPermLevels (Page 2005) List authorization levels
PWGENEnumUsers (Page 1994) List users
PWGENReadUserPerm (Page 2008) Determine user authorizations
PWRTCheckPermission (Page 2009) Check area authorization
PWRTCheckPermissionOnPicture (Page 2010) Check authorization level
PWRTGetCurrentUser (Page 2014) Determine login name
PWRTGetLoginPriority (Page 2015) GetLoginPriority
PWRTIsLoggedInByCard (Page 2016) Login via chip card
PWRTLogin (Page 2017) Login via dialog
PWRTLogout (Page 2019) Logout
PWRTLogoutEx (Page 2020) Logout
PWRTPermissionLevelDialog (Page 2011) Select authorization level
PWRTPermissionLevelDialogEx (Page 2012) Select authorization level
PWRTPermissionToString (Page 2013) Determine authorization level for text description
PWRTSilentLogin (Page 2021) Login
PWRTSilentLoginEx (Page 2022) Login

3.5.1.2 Overview of structures

Overview

PWGEN_GROUPINFO (Page 1981) User group information

PWGEN_LEVELINFO (Page 1982) Authorization level information
PWGEN_USERINFO (Page 1983) User information

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1979
Runtime API
3.5 Functions of the user administration

3.5.1.3 Error messages

Overview
The following error messages can be returned by the API functions in the CMN_ERROR error
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 executed.
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.

WinCC Engineering V18 – Programming reference

1980 System Manual, 11/2022, Online documentation
 Runtime API
3.5 Functions of the user administration

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.

3.5.1.4 Constants

String and array sizes

MAX_LOGIN 25
MAX_PASS 25
MAX_LEVEL 70

3.5.2 Structures

3.5.2.1 PWGEN_GROUPINFO

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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1981
Runtime API
3.5 Functions of the user administration

Required files
usegenap.h

API functions

PWGEN_ENUM_GROUPS_CALLBACK (Page 2000) List user groups

See also
PWGEN_ENUM_GROUPS_CALLBACK (Page 2000)

3.5.2.2 PWGEN_LEVELINFO

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 (Page 2006) List authorization levels

See also
PWGEN_ENUM_LEVELS_CALLBACK (Page 2006)

WinCC Engineering V18 – Programming reference

1982 System Manual, 11/2022, Online documentation
 Runtime API
3.5 Functions of the user administration

3.5.2.3 PWGEN_USERINFO

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 (Page 1995) List users

See also
PWGEN_ENUM_USERS_CALLBACK (Page 1995)

3.5.3 General functions

3.5.3.1 PWGENConnect

Description
The function connects to the database of the currently open project.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1983
Runtime API
3.5 Functions of the user administration

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
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
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

WinCC Engineering V18 – Programming reference

1984 System Manual, 11/2022, Online documentation
 Runtime API
3.5 Functions of the user administration

Related functions

PWGENDisconnect (Page 1985) Terminate connection to the database

See also
PWGENDisconnect (Page 1985)
Overview of the functions (Page 1978)

3.5.3.2 PWGENDisconnect

Description
The connection to the database of the currently open project is terminated.

Declaration

BOOL PWGENDisconnect (
LPCMN_ERROR err)

Parameters

err
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
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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1985
Runtime API
3.5 Functions of the user administration

Error messages

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.

Required files
usegenap.h
usegen.lib
usegen.dll

Related functions

PWGENConnect (Page 1983) Make connection to the database.

See also
PWGENConnect (Page 1983)
Overview of the functions (Page 1978)

3.5.4 Functions for processing users

3.5.4.1 PWGENAddUser

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 )

WinCC Engineering V18 – Programming reference

1986 System Manual, 11/2022, Online documentation
 Runtime API
3.5 Functions of the user administration

Parameters

username
Login name of the user

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
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
Users created

FALSE
Error

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_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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1987
Runtime API
3.5 Functions of the user administration

Related functions

PWGENAddUserEx (Page 1988) Creating users

See also
PWGENAddUserEx (Page 1988)
Overview of the functions (Page 1978)

3.5.4.2 PWGENAddUserEx

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,
int expiration_time,
BOOL copy_group_permissions,
LPCMN_ERROR error )

Parameters

username
Login name of the user

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.

copy_group_permissions
If copy_group_permission = TRUE, the user authorizations of the group to the newly created
user will be transferred.

WinCC Engineering V18 – Programming reference

1988 System Manual, 11/2022, Online documentation
 Runtime API
3.5 Functions of the user administration

error
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
Users created

FALSE
Error

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_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

PWGENAddUser (Page 1986) Creating users

See also
PWGENAddUser (Page 1986)
Overview of the functions (Page 1978)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1989
Runtime API
3.5 Functions of the user administration

3.5.4.3 PWGENChangePassword

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
Login name of the user

oldpassword
Old password of the user

newpassword
New password of the user

error
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
Password changed

FALSE
Error

Error messages

PWGEN_API_INVALID_PARAM A function parameter is incorrect or missing.

PWGEN_API_NO_PASSWORD No or no valid password.
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.

WinCC Engineering V18 – Programming reference

1990 System Manual, 11/2022, Online documentation
 Runtime API
3.5 Functions of the user administration

PWGEN_API_NO_MEMORY Not enough memory.

PWGEN_API_I_ENUM Error in enumeration.
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
Overview of the functions (Page 1978)

3.5.4.4 PWGENCheckUser

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
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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1991
Runtime API
3.5 Functions of the user administration

Return value

TRUE
User exists and the password is correct.

FALSE
Error

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_I_ENUM Error in enumeration.
PWGEN_API_NO_USER Cannot find user.
PWGEN_API_NO_PASSWORD No or no valid password.

Required files
usegenap.h
usegen.lib
usegen.dll

See also
Overview of the functions (Page 1978)

3.5.4.5 PWGENDeleteUser

Description
The specified user or user group is deleted, including the authorization data.

Declaration

BOOL PWGENDeleteUser (
LPCTSTR username,
BOOL is_user,
LPCMN_ERROR error )

WinCC Engineering V18 – Programming reference

1992 System Manual, 11/2022, Online documentation
 Runtime API
3.5 Functions of the user administration

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
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
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_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_I_ENUM Error in enumeration.
PWGEN_API_I_DELETE Error deleting data.
PWGEN_API_NO_USER Cannot find user.
PWGEN_API_NO_GROUP Cannot find user group.
PWGEN_API_EXIST_USER The selected user already exists.
PWGEN_API_NO_MEMORY Not enough memory.

Required files
usegenap.h

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1993
Runtime API
3.5 Functions of the user administration

usegen.lib
usegen.dll

See also
Overview of the functions (Page 1978)

3.5.4.6 PWGENEnumUsers

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
Pointer to application-specific data. This pointer is not evaluated by the function but provided
again in the callback function.

error
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
Users listed

WinCC Engineering V18 – Programming reference

1994 System Manual, 11/2022, Online documentation
 Runtime API
3.5 Functions of the user administration

FALSE
Error

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_I_ENUM Error in enumeration.
PWGEN_API_NO_MEMORY Not enough memory.

Required files
usegenap.h
usegen.lib
usegen.dll

Related functions

PWGEN_ENUM_USERS_CALLBACK (Page 1995) List users (callback)

See also
PWGEN_ENUM_USERS_CALLBACK (Page 1995)
Overview of the functions (Page 1978)

3.5.4.7 PWGEN_ENUM_USERS_CALLBACK

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);

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1995
Runtime API
3.5 Functions of the user administration

Parameters

lpUserInfo
Pointer to a PWGEN_USERINFO (Page 1983) type structure with the data of a user.

lpUser
Pointer to application-specific data. This pointer is made available again in the callback
function.

Return value

TRUE
Users listed

FALSE
Error

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

Required files
usegenap.h

Related functions

PWGENEnumUsers (Page 1994) List users

See also
PWGENEnumUsers (Page 1994)
PWGEN_USERINFO (Page 1983)
Overview of the functions (Page 1978)

WinCC Engineering V18 – Programming reference

1996 System Manual, 11/2022, Online documentation
 Runtime API
3.5 Functions of the user administration

3.5.5 Functions for processing user groups

3.5.5.1 PWGENAddGroup

Description
The function creates a new user group, including an empty user authorization matrix.

Declaration

BOOL PWGENAddGroup (
LPCTSTR username,
int expiration_time,
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
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
User group created

FALSE
User group already exists

Comment
Use the PWGENDeleteUser function to delete an existing user group.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1997
Runtime API
3.5 Functions of the user administration

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_I_ENUM Error in enumeration.
PWGEN_API_EXIST_GROUP The selected user group already exists.
PWGEN_API_MAX_GROUP The maximum number of user groups has been reached (~ 10).
PWGEN_API_NO_MEMORY Not enough memory.
PWGEN_API_I_CREATE Error creating new data.

Required files
usegenap.h
usegen.lib
usegen.dll

Related functions

PWGENDeleteUser (Page 1992) Creating users

See also
PWGENDeleteUser (Page 1992)
Overview of the functions (Page 1978)

3.5.5.2 PWGENEnumGroups

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 )

WinCC Engineering V18 – Programming reference

1998 System Manual, 11/2022, Online documentation
 Runtime API
3.5 Functions of the user administration

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
Pointer to application-specific data. This pointer is not evaluated by the function but provided
again in the callback function.

error
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
User groups listed

FALSE
Error

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_I_ENUM Error in enumeration.
PWGEN_API_NO_MEMORY Not enough memory.

Required files
usegenap.h
usegen.lib
usegen.dll

Related functions

PWGEN_ENUM_GROUPS_CALLBACK (Page 2000) List user groups (callback)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 1999
Runtime API
3.5 Functions of the user administration

See also
PWGEN_ENUM_GROUPS_CALLBACK (Page 2000)
Overview of the functions (Page 1978)

3.5.5.3 PWGEN_ENUM_GROUPS_CALLBACK

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 1981) type structure with the data of a user group.

lpUser
Pointer to application-specific data. This pointer is made available again in the callback
function.

Return value

TRUE
User groups listed

FALSE
Error

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

WinCC Engineering V18 – Programming reference

2000 System Manual, 11/2022, Online documentation
 Runtime API
3.5 Functions of the user administration

Required files
usegenap.h

Related functions

PWGENEnumGroups (Page 1998) List user groups

See also
PWGENEnumGroups (Page 1998)
PWGEN_GROUPINFO (Page 1981)
Overview of the functions (Page 1978)

3.5.6 Functions for processing authorizations

3.5.6.1 PWGENAddPermLevel

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
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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2001
Runtime API
3.5 Functions of the user administration

Return value

TRUE
Authorization level created

FALSE
Error

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_I_ENUM Error in enumeration.
PWGEN_API_NO_MEMORY Not enough memory.
PWGEN_API_MAX_LEVEL The maximum number of authorization levels has been reached
(1000).
PWGEN_API_EXIST_LEVEL The selected authorization level already exists.
PWGEN_API_I_CREATE Error creating new data.

Required files
usegenap.h
usegen.lib
usegen.dll

See also
Overview of the functions (Page 1978)

3.5.6.2 PWGENCheckPermission

Description
The function checks whether the user has the operator authorizations for the specified
authorization level.

WinCC Engineering V18 – Programming reference

2002 System Manual, 11/2022, Online documentation
 Runtime API
3.5 Functions of the user administration

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
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
The operator authorization for the authorization level of the user is available.

FALSE
Error

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_I_ENUM Error in enumeration.
PWGEN_API_NO_MEMORY Not enough memory.
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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2003
Runtime API
3.5 Functions of the user administration

usegen.dll

See also
Overview of the functions (Page 1978)

3.5.6.3 PWGENDeletePermLevel

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
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
Authorization level deleted

FALSE
Error

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_I_ENUM Error in enumeration.
PWGEN_API_NO_MEMORY Not enough memory.

WinCC Engineering V18 – Programming reference

2004 System Manual, 11/2022, Online documentation
 Runtime API
3.5 Functions of the user administration

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
Overview of the functions (Page 1978)

3.5.6.4 PWGENEnumPermLevels

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
Pointer to application-specific data. This pointer is not evaluated by the function but provided
again in the callback function.

error
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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2005
Runtime API
3.5 Functions of the user administration

Return value

TRUE
Authorization levels listed

FALSE
Error

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_I_ENUM Error in enumeration.
PWGEN_API_NO_MEMORY Not enough memory.

Required files
usegenap.h
usegen.lib
usegen.dll

Related functions

PWGEN_ENUM_LEVELS_CALLBACK (Page 2006) List authorizations (callback)

See also
PWGEN_ENUM_LEVELS_CALLBACK (Page 2006)
Overview of the functions (Page 1978)

3.5.6.5 PWGEN_ENUM_LEVELS_CALLBACK

Description
In order to evaluate the authorization levels listed by the system, you must provide a
PWGEN_ENUM_LEVELS_CALLBACK type callback function.

WinCC Engineering V18 – Programming reference

2006 System Manual, 11/2022, Online documentation
 Runtime API
3.5 Functions of the user administration

Declaration

BOOL ( * PWGEN_ENUM_LEVELS_CALLBACK) (
LPWGEN_LEVELINFO lpLevelInfo,
PVOID lpUser);

Parameters

lpLevelInfo
Pointer to a PWGEN_LEVELINFO (Page 1982) type structure with the data of the authorization
level.

lpUser
Pointer to application-specific data. This pointer is made available again in the callback
function.

Return value

TRUE
Authorization levels listed

FALSE
Error

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

Required files
usegenap.h

Related functions

PWGENEnumPermLevels (Page 2005) List authorization levels

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2007
Runtime API
3.5 Functions of the user administration

See also
PWGENEnumPermLevels (Page 2005)
PWGEN_LEVELINFO (Page 1982)
Overview of the functions (Page 1978)

3.5.6.6 PWGENReadUserPerm

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.

WinCC Engineering V18 – Programming reference

2008 System Manual, 11/2022, Online documentation
 Runtime API
3.5 Functions of the user administration

Return value

TRUE
Operator authorizations determined

FALSE
Error

Required files
usegenap.h
usegen.lib
usegen.dll

See also
Overview of the functions (Page 1978)

3.5.6.7 PWRTCheckPermission

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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2009
Runtime API
3.5 Functions of the user administration

FALSE
Authorization not granted

Required files
pwrt_api.h
pass_s.lib
useadmin.dll

Examples
PWRT check permission (Page 2024) "PWRTBunch.cpp"

See also
PWRT check permission (Page 2024)
Overview of the functions (Page 1978)

3.5.6.8 PWRTCheckPermissionOnPicture

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.

WinCC Engineering V18 – Programming reference

2010 System Manual, 11/2022, Online documentation
 Runtime API
3.5 Functions of the user administration

lperr
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
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 2025) "PWRTBunch.cpp"

See also
Checks admission of a certain level for a screen (Page 2025)
Overview of the functions (Page 1978)

3.5.6.9 PWRTPermissionLevelDialog

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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2011
Runtime API
3.5 Functions of the user administration

Related functions

PWRTPermissionLevelDialogEx (Page 2012) Select authorization for via dialog

Examples
Authorization level query through a dialog with specifying a possible error (Page 2027)
"PWRTBunch.cpp"

See also
Authorization level query through a dialog with specifying a possible error (Page 2027)
PWRTPermissionLevelDialogEx (Page 2012)
PWRTPermissionToString (Page 2013)
Overview of the functions (Page 1978)

3.5.6.10 PWRTPermissionLevelDialogEx

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
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
0-999 Authorization level
-1: Dialog closed with Cancel.

WinCC Engineering V18 – Programming reference

2012 System Manual, 11/2022, Online documentation
 Runtime API
3.5 Functions of the user administration

Required files
pwrt_api.h
pass_s.lib
useadmin.dll

Example
Authorization level query through a dialog with specifying a possible error (Page 2027)
"PWRTBunch.cpp"

See also
PWRTPermissionLevelDialog (Page 2011)
Authorization level query through a dialog with specifying a possible error (Page 2027)
Overview of the functions (Page 1978)

3.5.6.11 PWRTPermissionToString

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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2013
Runtime API
3.5 Functions of the user administration

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 2011) Select authorization level

Examples
Gets a string associated with the permission number (Page 2026). "PWRTBunch.cpp"

See also
PWRTPermissionLevelDialog (Page 2011)
Gets a string associated with the permission number (Page 2026)
Overview of the functions (Page 1978)

3.5.7 Functions for logon, logoff

3.5.7.1 PWRTGetCurrentUser

Description
Determines the user name of the current logged-on user.

Declaration

BOOL PWRTGetCurrentUser (
LPTSTR dest,
int bufsize )

WinCC Engineering V18 – Programming reference

2014 System Manual, 11/2022, Online documentation
 Runtime API
3.5 Functions of the user administration

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 2028) "PWRTBunch.cpp"

See also
Return the name of the current user (Page 2028)
Overview of the functions (Page 1978)

3.5.7.2 PWRTGetLoginPriority

Description
Logon check without dialog.

Declaration

LONG PWRTGetLoginPriority (
)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2015
Runtime API
3.5 Functions of the user administration

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 2029) "PWRTBunch.cpp"

See also
Queries the current logon priority (Page 2029)
Overview of the functions (Page 1978)

3.5.7.3 PWRTIsLoggedInByCard

Description
Determines whether the user is logged on via smart card.

Declaration

BOOL PWRTIsLoggedInByCard (
)

Parameters
None

WinCC Engineering V18 – Programming reference

2016 System Manual, 11/2022, Online documentation
 Runtime API
3.5 Functions of the user administration

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 2029) "PWRTBunch.cpp"

See also
Checks if the user has been logged on by card (Page 2029)
Overview of the functions (Page 1978)

3.5.7.4 PWRTLogin

Description
Displays the logon dialog and loads the user data into the shared memory when logon is
successful.

Declaration

BOOL PWRTLogin (
TCHAR monitor )

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2017
Runtime API
3.5 Functions of the user administration

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 2021) Logon

Examples
PWRT login - dialog provided by WinCC itself (Page 2031) "PWRTBunch.cpp"

See also
PWRTSilentLogin (Page 2021)
PWRT login - dialog provided by WinCC itself (Page 2031)
PWRTSilentLoginEx (Page 2022)
Overview of the functions (Page 1978)

WinCC Engineering V18 – Programming reference

2018 System Manual, 11/2022, Online documentation
 Runtime API
3.5 Functions of the user administration

3.5.7.5 PWRTLogout

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 2020) Log off user with priority level

Examples
PWRT logoff (Page 2032) "PWRTBunch.cpp"

See also
PWRT logoff (Page 2032)
PWRTLogoutEx (Page 2020)
Overview of the functions (Page 1978)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2019
Runtime API
3.5 Functions of the user administration

3.5.7.6 PWRTLogoutEx

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 2019) User logoff

Examples
Silent logoff with priority level (Page 2033) "PWRTBunch.cpp"

WinCC Engineering V18 – Programming reference

2020 System Manual, 11/2022, Online documentation
 Runtime API
3.5 Functions of the user administration

See also
Silent logoff with priority level (Page 2033)
PWRTLogout (Page 2019)
Overview of the functions (Page 1978)

3.5.7.7 PWRTSilentLogin

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
Password of the user

Return value

TRUE
Login successful

FALSE
Login rejected

Comment
If no valid smart card is connected when the function is executed, the login is rejected.

Required files
pwrt_api.h
pass_s.lib

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2021
Runtime API
3.5 Functions of the user administration

useadmin.dll

Related functions

PWRTLogin (Page 2017) Login via dialog

PWRTSilentLoginEx (Page 2022) Login with priority level

Examples
Logon without using a dialog (Page 2034) "PWRTBunch.cpp"

See also
PWRTLogin (Page 2017)
PWRTSilentLoginEx (Page 2022)
Logon without using a dialog (Page 2034)
Overview of the functions (Page 1978)

3.5.7.8 PWRTSilentLoginEx

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
Password of the user

nLevel
Priority level of the user

WinCC Engineering V18 – Programming reference

2022 System Manual, 11/2022, Online documentation
 Runtime API
3.5 Functions of the user administration

Return value

TRUE
Login successful

FALSE
Login rejected

Comment
If no valid smart card is connected when the function is executed, the login is rejected.

Required files
pwrt_api.h
pass_s.lib
useadmin.dll

Related functions

PWRTLogin (Page 2017) Login via dialog

PWRTSilentLogin (Page 2021) Login without dialog

Examples
Silent logon with priority level (Page 2035) "PWRTBunch.cpp"

See also
PWRTSilentLogin (Page 2021)
Silent logon with priority level (Page 2035)
PWRTLogin (Page 2017)
Overview of the functions (Page 1978)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2023
Runtime API
3.5 Functions of the user administration

3.5.8 Examples

3.5.8.1 PWRT check permission

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);
m_pView->Print(csOut, FSIZE_SUBMARK);
m_pView->Print("\n");
}
}
}

WinCC Engineering V18 – Programming reference

2024 System Manual, 11/2022, Online documentation
 Runtime API
3.5 Functions of the user administration

//{{ODK_EXAMPLE}(END)}

See also
PWRTCheckPermission (Page 2009)

3.5.8.2 Checks admission of a certain level for a screen

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);
m_pView->Print("Access approved:\n", FSIZE_PARAMMARK, FALSE, TRUE);
m_pView->Print(csOut, FSIZE_SUBMARK);
m_pView->Print("\n");
}
else
{
m_pView->PrintError(&err, "PWRTCheckPermissionOnPicture");
m_pView->PrintError("Access denied", "PWRTCheckPermissionOnPicture");
}
}
//{{ODK_EXAMPLE}(END)}

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2025
Runtime API
3.5 Functions of the user administration

See also
PWRTCheckPermissionOnPicture (Page 2010)

3.5.8.3 Gets a string associated with the permission number

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);
m_pView->Print("\n");
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);
m_pView->Print(csOut, FSIZE_SUBMARK);
m_pView->Print("\n");
}
}
//{{ODK_EXAMPLE}(END)}

See also
PWRTPermissionToString (Page 2013)

WinCC Engineering V18 – Programming reference

2026 System Manual, 11/2022, Online documentation
 Runtime API
3.5 Functions of the user administration

3.5.8.4 Authorization level query through a dialog with specifying a possible error

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);
m_pView->Print(csOut, FSIZE_SUBMARK);
m_pView->Print("\n");
}
}
//{{ODK_EXAMPLE}(END)}

See also
PWRTPermissionLevelDialog (Page 2011)
PWRTPermissionLevelDialogEx (Page 2012)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2027
Runtime API
3.5 Functions of the user administration

3.5.8.5 Return the name of the current user

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);
m_pView->Print("\n");
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);
m_pView->Print(csOut, FSIZE_SUBMARK);
m_pView->Print("\n");
}
//{{ODK_EXAMPLE}(END)}

See also
PWRTGetCurrentUser (Page 2014)

WinCC Engineering V18 – Programming reference

2028 System Manual, 11/2022, Online documentation
 Runtime API
3.5 Functions of the user administration

3.5.8.6 Queries the current logon priority

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]);
m_pView->Print(csOut, FSIZE_SUBMARK);
m_pView->Print("\n");
}
}
//{{ODK_EXAMPLE}(END)}

See also
PWRTGetLoginPriority (Page 2015)

3.5.8.7 Checks if the user has been logged on by card

Overview

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2029
Runtime API
3.5 Functions of the user administration

//{{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()"));
}
}
//{{ODK_EXAMPLE}(END)}

See also
PWRTIsLoggedInByCard (Page 2016)

WinCC Engineering V18 – Programming reference

2030 System Manual, 11/2022, Online documentation
 Runtime API
3.5 Functions of the user administration

3.5.8.8 PWRT login - dialog provided by WinCC itself

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("ERROR: ", FSIZE_FUNCMARK, TRUE);
m_pView->Print("PWRTLogin.\n", FSIZE_PARAMMARK, FALSE, TRUE);
m_pView->Print("General function failure.\n", FSIZE_SUBMARK);
m_pView->Print("\n");
return;
}
m_pView->Print("PWRTLogin\n", FSIZE_FUNCMARK, TRUE);
m_pView->Print("Logging on...\n", FSIZE_PARAMMARK, FALSE, TRUE);
m_pView->Print("\n");
}
//{{ODK_EXAMPLE}(END)}

See also
PWRTLogin (Page 2017)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2031
Runtime API
3.5 Functions of the user administration

3.5.8.9 PWRT logoff

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("ERROR: ", FSIZE_FUNCMARK, TRUE);
m_pView->Print("PWRTLogout.\n", FSIZE_PARAMMARK, FALSE, TRUE);
m_pView->Print("General function failure.\n", FSIZE_SUBMARK);
m_pView->Print("\n");
return;
}
m_pView->Print("PWRTLogout\n", FSIZE_FUNCMARK, TRUE);
m_pView->Print("Logging out...\n", FSIZE_PARAMMARK, FALSE, TRUE);
m_pView->Print("\n");
}
//{{ODK_EXAMPLE}(END)}

See also
PWRTLogout (Page 2019)

WinCC Engineering V18 – Programming reference

2032 System Manual, 11/2022, Online documentation
 Runtime API
3.5 Functions of the user administration

3.5.8.10 Silent logoff with priority level

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);
m_pView->Print(csOut, FSIZE_SUBMARK);
m_pView->Print("\n");
}
}
//{{ODK_EXAMPLE}(END)}

See also
PWRTLogoutEx (Page 2020)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2033
Runtime API
3.5 Functions of the user administration

3.5.8.11 Logon without using a dialog

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);
m_pView->Print("Access approved:\n", FSIZE_PARAMMARK, FALSE, TRUE);
}
}
//{{ODK_EXAMPLE}(END)}

See also
PWRTSilentLogin (Page 2021)

WinCC Engineering V18 – Programming reference

2034 System Manual, 11/2022, Online documentation
 Runtime API
3.5 Functions of the user administration

3.5.8.12 Silent logon with priority level

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);
m_pView->Print("Access approved:\n", FSIZE_PARAMMARK, FALSE, TRUE);
csOut.Format("Priority level = %ld\n", l_PriorityLevel.m_lNumber);
m_pView->Print(csOut, FSIZE_SUBMARK);
m_pView->Print("\n");
}
}
//{{ODK_EXAMPLE}(END)}

See also
PWRTSilentLoginEx (Page 2022)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2035
Runtime API
3.6 Functions of the text system

3.6 Functions of the text system

3.6.1 Basics

3.6.1.1 Overview of the functions

Declaration

TXT_ENUM_INFOTEXTS_PROC (Page 2048) List info texts (callback)

TXT_ENUM_LANGUAGES_PROC (Page 2055) List configured languages (callback)
TXTCloseProject (Page 2039) Close text library
TXTEnumInfoText (Page 2046) List info texts
TXTEnumLanguages (Page 2054) List configured languages
TXTGetFont (Page 2057) Determine character set of a language
TXTGetMaxTextID (Page 2041) Determine text ID (maximum)
TXTOpenProject (Page 2042) Open text library
TXTRTConnect (Page 2043) Keep connection to text server
TXTRTDisconnect (Page 2044) Connection to the text server released
TXTRTGetInfoText (Page 2050) Read info texts
TXTRTGetInfoTextMC (Page 2052) Read info texts from text server
TXTRTGetLanguageID (Page 2060) Determine activated language
TXTRTSetLanguage (Page 2061) Language switch for error message texts
TXTShowLanguagesDialog (Page 2058) Display languages (installed)
TXTUpdateRuntime (Page 2049) Update info texts in runtime

3.6.1.2 Error messages

Overview
The following error messages can be returned by the API functions in the CMN_ERROR error
structure:

TXT_SYS_ERROR (value: 0x10000000) If this bit is set in dwError1 of er‐

ror structure CMN_ERROR, then
dwError2 contains the system er‐
ror 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.

WinCC Engineering V18 – Programming reference

2036 System Manual, 11/2022, Online documentation
 Runtime API
3.6 Functions of the text system

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_LANGUAGE_NOT_FOUND (value: 0x00000006) The specified language could 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 cre‐
ated.
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_RUNNING (value: 0x00000020) TEXTBIB.EXE already running;
opening not allowed
TXT_TABLES_ALREADY_EXIST (value: 0x00000021) Database tables already exist.
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_SERVICE_WIN‐ (value: 0x00000002) Error while creating the service
DOW window
TXT_RT_KEY_NOT_FOUND (value: 0x00000003) TextID not found
TXT_RT_NO_READ_ACCESS (value: 0x00000004) Read access to the memory map‐
ped file denied
TXT_RT_NO_LANGUAGE_FOUND (value: 0x00000005) No language 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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2037
Runtime API
3.6 Functions of the text system

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_NOMCDEFAULTSERVER (value: 0x00000015) This is not a multiclient project,
but "@default" was given as a
server prefix.

3.6.1.3 Language codes

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_AFRIKAANS 0x0436
LANG_ALBANIAN 0x041C
LANG_BASQUE 0x042D
LANG_BULGARIAN 0x0402
LANG_BELARUSIAN 0x0423
LANG_CATALAN 0x0403
LANG_CHINESE 0x0804
LANG_CROATIAN 0x041A
LANG_CZECH 0x0405
LANG_DANISH 0x0406
LANG_DUTCH 0x0413
LANG_ENGLISH 0x0409
LANG_ESTONIAN 0x0425
LANG_FAEROESE 0x0438
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_INDONESIAN 0x0421
LANG_ITALIAN 0x0410
LANG_JAPANESE 0x0411
LANG_KOREAN 0x0412
LANG_LATVIAN 0x0426

WinCC Engineering V18 – Programming reference

2038 System Manual, 11/2022, Online documentation
 Runtime API
3.6 Functions of the text system

LANG_LITHUANIAN 0x0427
LANG_NORWEGIAN 0x0414
LANG_POLISH 0x0415
LANG_PORTUGUESE 0x0416
LANG_ROMANIAN 0x0418
LANG_RUSSIAN 0x0419
LANG_SLOVAK 0x041B
LANG_SLOVENIAN 0x0424
LANG_SPANISH 0x040A
LANG_SWEDISH 0x041D
LANG_THAI 0x041E
LANG_TURKISH 0x041F
LANG_UKRAINIAN 0x0422

Here, the upper 4 bytes (0x04..) designate the language as SUBLANG_DEFAULT language

3.6.2 General functions

3.6.2.1 TXTCloseProject

Description
Closes the project database upon successful execution.

Declaration

BOOL TXTCloseProject (
LPCTSTR lpszProjectFile,
LPCMN_ERROR lpdmError );

Parameters

lpszProjectFile
Pointer to the name of the project file including path and extension.

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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2039
Runtime API
3.6 Functions of the text system

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
The call may 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

TXT_DISCONNECT Error logging off of the database

Required files
text_cs.h
text_cs.lib
text_cs.dll

Related functions

TXTOpenProject (Page 2042) Opens the text library

Examples
Get infotext (Page 2063) "TX01.cpp"
Enumerate infotexts (Page 2065) "TX01.cpp"

See also
TXTOpenProject (Page 2042)
Get infotext (Page 2063)

WinCC Engineering V18 – Programming reference

2040 System Manual, 11/2022, Online documentation
 Runtime API
3.6 Functions of the text system

Enumerate infotexts (Page 2065)

Overview of the functions (Page 2036)

3.6.2.2 TXTGetMaxTextID

Description
Records the highest text ID that is kept in the DLL.

Declaration

BOOL TXTGetMaxTextID (
LPLONG lplMaxTextID,
LPCMN_ERROR lpdmError );

Parameters

lplMaxTextID
Pointer to the buffer in which the text ID should be stored.

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
Maximum text ID determined

FALSE
Error

Required files
text_cs.h
text_cs.lib
text_cs.dll

See also
Overview of the functions (Page 2036)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2041
Runtime API
3.6 Functions of the text system

3.6.2.3 TXTOpenProject

Description
Opens the database upon successful execution.

Declaration

BOOL TXTOpenProject (
LPCTSTR lpszProjectFile,
LPCTSTR lpszDSNName,
BOOL fExclusive,
LPCMN_ERROR lpdmError );

Parameters

lpszProjectFile
Pointer to the name of the project file including path and extension.

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
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
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.

WinCC Engineering V18 – Programming reference

2042 System Manual, 11/2022, Online documentation
 Runtime API
3.6 Functions of the text system

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 2039) Closes the text library

Examples
Get infotext (Page 2063) "TX01.cpp"
Enumerate infotexts (Page 2065) "TX01.cpp"

See also
TXTCloseProject (Page 2039)
Get infotext (Page 2063)
Enumerate infotexts (Page 2065)
Overview of the functions (Page 2036)

3.6.2.4 TXTRTConnect

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 ( );

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2043
Runtime API
3.6 Functions of the text system

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 2044) Connection to the text server released

See also
TXTRTDisconnect (Page 2044)
Overview of the functions (Page 2036)

3.6.2.5 TXTRTDisconnect

Description
Closes a connection to the text server that was made with TXTRTConnect.

Declaration

BOOL TXTRTDisconnect ( );

WinCC Engineering V18 – Programming reference

2044 System Manual, 11/2022, Online documentation
 Runtime API
3.6 Functions of the text system

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
The call may 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.

Required files
text_rt.h
text_rt.lib
text_rt.dll

Related functions

TXTRTConnect (Page 2043) Keep connection to text server

See also
TXTRTConnect (Page 2043)
Overview of the functions (Page 2036)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2045
Runtime API
3.6 Functions of the text system

3.6.3 Functions for processing infotext

3.6.3.1 TXTEnumInfoText

Description
Lists all infotext that meets the filter criterion in lpszFilter.

Declaration

BOOL TXTEnumInfoText (
LPCTSTR lpszProjectFile,
DWORD dwLocale,
LPDWORD lpdwItems,
LPCTSTR lpszFilter,
TXT_ENUM_INFOTEXTS_PROC lpfnEnum,
LPVOID lpvUser,
LPCMN_ERROR lpdmError );

Parameters

lpszProjectFile
Pointer to the name of the project file including path and extension.

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
Pointer to application-specific data. This pointer is not evaluated by the function but provided
again in the callback function.

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.

WinCC Engineering V18 – Programming reference

2046 System Manual, 11/2022, Online documentation
 Runtime API
3.6 Functions of the text system

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
TXT_WRONG_PROJECT Wrong project name

Required files
text_cs.h
text_cs.lib
text_cs.dll

Related functions

TXT_ENUM_INFOTEXTS_PROC (Page 2048) List infotext (callback)

Examples
Enumerate infotexts (Page 2065) "TX01.cpp"

See also
TXT_ENUM_INFOTEXTS_PROC (Page 2048)
Enumerate infotexts (Page 2065)
Overview of the functions (Page 2036)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2047
Runtime API
3.6 Functions of the text system

3.6.3.2 TXT_ENUM_INFOTEXTS_PROC

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
Pointer to application-specific data. This pointer is made available again in the callback
function.

Return value

TRUE
The enumeration is continued

FALSE
The enumeration is cancelled

Comment

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

WinCC Engineering V18 – Programming reference

2048 System Manual, 11/2022, Online documentation
 Runtime API
3.6 Functions of the text system

Required files
text_cs.h
text_cs.lib
text_cs.dll

Related functions

TXTEnumInfoText (Page 2046) List infotext

Examples
Enumerate infotexts (Page 2065) "TX01.cpp"

See also
TXTEnumInfoText (Page 2046)
Enumerate infotexts (Page 2065)
Overview of the functions (Page 2036)

3.6.3.3 TXTUpdateRuntime

Description
The text from the text library are reloaded in runtime.

Declaration

BOOL TXTUpdateRuntime (
LPCTSTR lpszProjectFile,
HWND hwndParent,
LPCMN_ERROR lpdmError );

Parameters

lpszProjectFile
Pointer to the name of the project file including path and extension.

hwndParent
Handle to the parent window

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2049
Runtime API
3.6 Functions of the text system

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
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
Overview of the functions (Page 2036)

3.6.3.4 TXTRTGetInfoText

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,
LPCMN_ERROR lpdmError );

WinCC Engineering V18 – Programming reference

2050 System Manual, 11/2022, Online documentation
 Runtime API
3.6 Functions of the text system

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
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
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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2051
Runtime API
3.6 Functions of the text system

Examples
Get infotext (Page 2063) "TX01.cpp"

See also
Get infotext (Page 2063)
Overview of the functions (Page 2036)

3.6.3.5 TXTRTGetInfoTextMC

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,
LPCMN_ERROR lpdmError );

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
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.

WinCC Engineering V18 – Programming reference

2052 System Manual, 11/2022, Online documentation
 Runtime API
3.6 Functions of the text system

Return value

TRUE
Infotext determined

FALSE
Error

Comment
This function only works with multiclient projects

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
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
Overview of the functions (Page 2036)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2053
Runtime API
3.6 Functions of the text system

3.6.4 Functions for processing languages

3.6.4.1 TXTEnumLanguages

Description
Calls the passed callback function for all configured languages.

Declaration

BOOL TXTEnumLanguages (
LPCTSTR lpszProjectFile,
LPDWORD lpdwItems,
TXT_ENUM_LANGUAGES_PROC lpfnEnum,
LPVOID lpvUser,
LPCMN_ERROR lpdmError );

Parameters

lpszProjectFile
Pointer to the name of the project file including path and extension.

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
Pointer to application-specific data. This pointer is not evaluated by the function but provided
again in the callback function.

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
Configured languages listed

FALSE
Error

WinCC Engineering V18 – Programming reference

2054 System Manual, 11/2022, Online documentation
 Runtime API
3.6 Functions of the text system

Error messages

TXT_CALLBACK Callback returns FALSE

TXT_NO_CONNECT The database is not yet open.
TXT_WRONG_PROJECT Wrong project name

Required files
text_cs.h
text_cs.lib
text_cs.dll

Related functions

TXT_ENUM_LANGUAGES_PROC (Page 2055) List configured languages (callback)

Examples
Enumerate infotexts (Page 2065) "TX01.cpp"

See also
TXT_ENUM_LANGUAGES_PROC (Page 2055)
Enumerate infotexts (Page 2065)
Overview of the functions (Page 2036)

3.6.4.2 TXT_ENUM_LANGUAGES_PROC

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 );

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2055
Runtime API
3.6 Functions of the text system

Parameters

dwLocaleID
Language code

lpszName
Pointer to the name of the language.

lpvUser
Pointer to application-specific data. This pointer is made available again in the callback
function.

Return value

TRUE
The enumeration is continued.

FALSE
The enumeration is cancelled.

Comment

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

Required files
text_cs.h

Related functions

TXTEnumLanguages (Page 2054) List configured languages

Examples
Enumerate infotexts (Page 2065) "TX01.cpp"

WinCC Engineering V18 – Programming reference

2056 System Manual, 11/2022, Online documentation
 Runtime API
3.6 Functions of the text system

See also
TXTEnumLanguages (Page 2054)
Enumerate infotexts (Page 2065)
Overview of the functions (Page 2036)

3.6.4.3 TXTGetFont

Description
Upon successful execution, fills the LOGFONT structure passed in lplf with the font set for the
desired language.

Declaration

BOOL TXTGetFont (
LPCTSTR lpszProjectFile,
DWORD dwLocale,
LPLOGFONT lplf,
LPCMN_ERROR lpdmError );

Parameters

lpszProjectFile
Pointer to the name of the project file including path and extension.

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
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
Character set determined

FALSE
Error

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2057
Runtime API
3.6 Functions of the text system

Error messages

TXT_NO_CONNECT The database is not yet open.

TXT_NO_LANGUAGE Invalid language specified
TXT_LANGUAGE_NOT_FOUND The specified language could not be found.
TXT_WRONG_PROJECT Wrong project name

Required files
text_cs.h
text_cs.lib
text_cs.dll

See also
Overview of the functions (Page 2036)

3.6.4.4 TXTShowLanguagesDialog

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.

WinCC Engineering V18 – Programming reference

2058 System Manual, 11/2022, Online documentation
 Runtime API
3.6 Functions of the text system

Declaration

BOOL TXTShowLanguagesDialog (
LPCTSTR lpszProjectFile,
HWND hwndParent,
LPDWORD lpdwLocale,
LPLOGFONT lplf,
LPCMN_ERROR lpdmError );

Parameters

lpszProjectFile
Pointer to the name of the project file including path and extension.

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
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
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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2059
Runtime API
3.6 Functions of the text system

Error messages

TXT_CALLBACK Callback returns FALSE

TXT_NO_CONNECT The database is not yet open.
TXT_WRONG_PROJECT Wrong project name

Required files
text_cs.h
text_cs.lib
text_cs.dll

See also
Overview of the functions (Page 2036)

3.6.4.5 TXTRTGetLanguageID

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,
LPCMN_ERROR lpdmError );

Parameters

lpchLanguageID
Pointer to a buffer, in which the primary language ID should be stored.

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
Activated language determined

WinCC Engineering V18 – Programming reference

2060 System Manual, 11/2022, Online documentation
 Runtime API
3.6 Functions of the text system

FALSE
Error

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_RT_NO_LANGUAGE_FOUND No language found

Required files
text_rt.h
text_rt.lib
text_rt.dll

See also
Overview of the functions (Page 2036)

3.6.4.6 TXTRTSetLanguage

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,
LPCMN_ERROR lpdmError );

Parameters

dwLocaleID
Language code of the language to be set.

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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2061
Runtime API
3.6 Functions of the text system

Return value

TRUE
Language of error messages switched

Required files
text_rt.h
text_rt.lib
text_rt.dll

See also
Overview of the functions (Page 2036)

WinCC Engineering V18 – Programming reference

2062 System Manual, 11/2022, Online documentation
 Runtime API
3.6 Functions of the text system

3.6.5 Examples

3.6.5.1 Get infotext

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)
{
memset(&Error, 0, sizeof(CMN_ERROR));
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"),
Error.dwError1, Error.dwError2, Error.szErrorText);
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);
memset(&Error, 0, sizeof(CMN_ERROR));
ret = TXTGetInfoText(g_szProjectFile, dwTextID, dwLocale, szText, &dwSize,
&Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in
TXTNewInfoText: E1= 0x%08lx ; E2= 0x%08lx ; %s"),

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2063
Runtime API
3.6 Functions of the text system

Error.dwError1, Error.dwError2, Error.szErrorText);

}
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);
memset(&Error, 0, sizeof(CMN_ERROR));
ret = TXTSetInfoText(g_szProjectFile, NULL, dwTextID, dwLocale, szText, &Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in
TXTSetInfoText: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("TXTSetInfoText"));
}
ODKTrace(szText);
memset(&Error, 0, sizeof(CMN_ERROR));
ret = TXTCloseProject(g_szProjectFile, &Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in
TXTCloseProject: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("TXTCloseProject"));

ODKTrace(szText);
}
}
}
}
//{{ODK_EXAMPLE}(END)}

See also
TXTCloseProject (Page 2039)
TXTOpenProject (Page 2042)
TXTRTGetInfoText (Page 2050)

WinCC Engineering V18 – Programming reference

2064 System Manual, 11/2022, Online documentation
 Runtime API
3.6 Functions of the text system

3.6.5.2 Enumerate infotexts

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)
{
memset(&Error, 0, sizeof(CMN_ERROR));

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2065
Runtime API
3.6 Functions of the text system

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"),
Error.dwError1, Error.dwError2, Error.szErrorText);
ODKTrace(szText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("TXTOpenProject"));
ODKTrace(szText);
dwItems = 0;
memset(&Error, 0, sizeof(CMN_ERROR));
ret = TXTEnumLanguages(g_szProjectFile, &dwItems, MyTXTEnumLanguagesCallback,
&dwUser, &Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in
TXTOpenProject: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
ODKTrace(szText);
}
dwItems = 0;
memset(&Error, 0, sizeof(CMN_ERROR));
ret = TXTEnumInfoText(g_szProjectFile, dwLocale, &dwItems, szFilter,
MyTXTEnumInfotextsCallback, &dwUser, &Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in
TXTEnumInfoText: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
ODKTrace(szText);
}
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("TXTEnumInfoText:
NItems=%d ; LANG=%x ; Filter=%s "),
dwItems, dwLocale, szFilter);
ODKTrace(szText);
memset(&Error, 0, sizeof(CMN_ERROR));
ret = TXTCloseProject(g_szProjectFile, &Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in
TXTCloseProject: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
ODKTrace(szText);
}
}
}
}
//{{ODK_EXAMPLE}(END)}

WinCC Engineering V18 – Programming reference

2066 System Manual, 11/2022, Online documentation
 Runtime API
3.7 Report system functions

See also
TXTCloseProject (Page 2039)
TXTOpenProject (Page 2042)
TXTEnumInfoText (Page 2046)
TXT_ENUM_INFOTEXTS_PROC (Page 2048)
TXT_ENUM_LANGUAGES_PROC (Page 2055)
TXTEnumLanguages (Page 2054)

3.7 Report system functions

3.7.1 Basics

3.7.1.1 Overview of the functions

Overview

RPJAttach (Page 2079) Establish connection

RPJCallJobMethod (Page 2102) Call print job method
RPJCreateJob (Page 2089) Create a print job
RPJCreatePropertyHandle (Page 2092) Create handle of a print job property
RPJDeleteJob (Page 2090) Delete print job
RPJDeletePropertyHandle (Page 2093) Delete handle of a print job property
RPJDetach (Page 2080) Disconnect connection
RPJGetJobMethodAt (Page 2103) Determine name of print job method
RPJGetJobNameAt (Page 2095) Determine name of print job
RPJGetJobPropertyAt (Page 2105) Determine name of print job properties
RPJGetJobProps (Page 2107) Determine print job properties
RPJGetNumJobMethods (Page 2104) Determine number of print job methods
RPJGetNumJobProperties (Page 2108) Determine number of print job properties
RPJGetNumJobs (Page 2096) Determine number of print jobs
RPJGetNumProjectProperties (Page 2082) Determine number of properties in the project
RPJGetProjectPropertyAt (Page 2083) Determine property name and type in the project
using an index
RPJGetProjectProperty (Page 2084) Determine value of the property in the project
RPJGetProperty (Page 2109) Determine print job property
RPJJobLock (Page 2097) Lock print job against other accesses
RPJJobUnlockAll (Page 2100) Remove all print job locks
RPJJobUnlock (Page 2099) Remove a print job lock
RPJMemFree (Page 2081) Free memory

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2067
Runtime API
3.7 Report system functions

RPJProjectLock (Page 2085) Lock access to the print job list in the project
RPJProjectUnlockAll (Page 2088) Remove all print job list locks in the project
RPJProjectUnlock (Page 2087) Remove a print job list lock in the project
RPJPropertyClear (Page 2112) Delete handle of a print job property
RPJSetProperty (Page 2113) Specify print job properties

3.7.1.2 Constants

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

WinCC Engineering V18 – Programming reference

2068 System Manual, 11/2022, Online documentation
 Runtime API
3.7 Report system functions

• 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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2069
Runtime API
3.7 Report system functions

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

3.7.1.3 Error messages

Overview
The following error messages can be returned by the API functions in the CMN_ERROR error
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

WinCC Engineering V18 – Programming reference

2070 System Manual, 11/2022, Online documentation
 Runtime API
3.7 Report system functions

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

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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2071
Runtime API
3.7 Report system functions

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
"FontUnderline" 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
"FontUnderline" VT_I4
"Orientation" VT_I4
"AlignmentLeft" VT_I4
"AlignmentTop" VT_I4

WinCC Engineering V18 – Programming reference

2072 System Manual, 11/2022, Online documentation
 Runtime API
3.7 Report system functions

"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
"RadiusHeight" VT_I4

Properties for "polygons":

"Polyline" VT_BSTR
"PointCount" VT_I4
"Index" VT_I4
"ActualPointLeft" VT_I4
"ActualPointTop" VT_I4

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2073
Runtime API
3.7 Report system functions

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
"RadiusHeight" 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
"FontUnderline" VT_I4
"Orientation" VT_I4
"Text" VT_BSTR
"AlignmentLeft" VT_I4
"AlignmentTop" VT_I4
"WordWrap" VT_I4
"ForeColor" VT_I4

WinCC Engineering V18 – Programming reference

2074 System Manual, 11/2022, Online documentation
 Runtime API
3.7 Report system functions

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
"FontUnderline" VT_I4
"AlignmentLeft" VT_I4
"AlignmentTop" VT_I4
"WordWrap" VT_I4
"ForeColor" VT_I4
"OutFormat" VT_BSTR

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2075
Runtime API
3.7 Report system functions

"DataType" VT_I4
"Calculation" VT_VARIANT

3.7.1.5 General procedure for processing print job properties (Report Designer)

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.

WinCC Engineering V18 – Programming reference

2076 System Manual, 11/2022, Online documentation
 Runtime API
3.7 Report system functions

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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2077
Runtime API
3.7 Report system functions

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");
}
}

WinCC Engineering V18 – Programming reference

2078 System Manual, 11/2022, Online documentation
 Runtime API
3.7 Report system functions

3.7.2 Functions for establishing connections

3.7.2.1 RPJAttach

Description
This function is used to established and initialized a connection to RPJAPI.DLL.

Declaration

BOOL RPJAttach (
CMN_ERROR* pcmnerror );

Parameters

pcmnerror
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
Connection established.

FALSE
Error

Required files
rpjapi.h
rpjapi.lib
rpjapi.dll

Related functions

RPJDetach (Page 2080) Terminate connection

See also
RPJDetach (Page 2080)
Overview of the functions (Page 2067)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2079
Runtime API
3.7 Report system functions

3.7.2.2 RPJDetach

Description
This function is used to close an established connection to RPJAPI.DLL.

Declaration

BOOL RPJDetach (
CMN_ERROR* pcmnerror );

Parameters

pcmnerror
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
Connection is closed again.

FALSE
Error

Comment

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 the program to crash.

Required files
rpjapi.h
rpjapi.lib
rpjapi.dll

Related functions

RPJAttach (Page 2079) Establish connection

WinCC Engineering V18 – Programming reference

2080 System Manual, 11/2022, Online documentation
 Runtime API
3.7 Report system functions

See also
RPJAttach (Page 2079)
Overview of the functions (Page 2067)

3.7.2.3 RPJMemFree

Description
This function is used to close an established connection to RPJAPI.DLL and release the allocated
memory.

Declaration

BOOL RPJMemFree (
const PVOID pvMemBlock,
CMN_ERROR* pcmnerror );

Parameters

pvMemBlock
Pointer to a released memory area that was previously allocated by a RPJ function.
If pvMemBlock = NULL, nothing happens.

pcmnerror
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
The memory was released.

FALSE
Error

Required files
rpjapi.h
rpjapi.lib
rpjapi.dll

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2081
Runtime API
3.7 Report system functions

See also
Overview of the functions (Page 2067)

3.7.3 Functions for processing project properties

3.7.3.1 RPJGetNumProjectProperties

Description
The function determines the number of properties for the project.

Declaration

BOOL RPJGetNumProjectProperties (
LPCSTR pszReserved,
DWORD* pdwNumProperties
CMN_ERROR* pcmnerror );

Parameters

pszReserved
The parameter is reserved for future development.

pdwNumProperties
Pointer to a DWORD tag, in which the number of properties is returned.

pcmnerror
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
The number of properties was determined.

FALSE
Error

Required files
rpjapi.h

WinCC Engineering V18 – Programming reference

2082 System Manual, 11/2022, Online documentation
 Runtime API
3.7 Report system functions

rpjapi.lib
rpjapi.dll

See also
Overview of the functions (Page 2067)

3.7.3.2 RPJGetProjectPropertyAt

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,
CMN_ERROR* pcmnerror );

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
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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2083
Runtime API
3.7 Report system functions

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
Overview of the functions (Page 2067)

3.7.3.3 RPJGetProjectProperty

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,
CMN_ERROR* pcmnerror );

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.

WinCC Engineering V18 – Programming reference

2084 System Manual, 11/2022, Online documentation
 Runtime API
3.7 Report system functions

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
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
The value of property was determined.

FALSE
Error

Required files
rpjapi.h
rpjapi.lib
rpjapi.dll

See also
Overview of the functions (Page 2067)

3.7.3.4 RPJProjectLock

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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2085
Runtime API
3.7 Report system functions

Declaration

BOOL RPJProjectLock (
LPCSTR pszProjectName,
BOOL fWriteLock,
BOOL fDoNotWait,
LPCSTR pszLockerNameNew,
LPSTR* ppszLockerNameCur,
CMN_ERROR* pcmnerror );

Parameters

pszProjectName
Pointer to the name of the project, consisting of the path, project name, and extension.

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
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
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.

WinCC Engineering V18 – Programming reference

2086 System Manual, 11/2022, Online documentation
 Runtime API
3.7 Report system functions

Required files
rpjapi.h
rpjapi.lib
rpjapi.dll

Related functions

RPJProjectUnlock (Page 2087) Removing a lock

RPJProjectUnlockAll (Page 2088) Removing all locks

See also
RPJProjectUnlock (Page 2087)
RPJProjectUnlockAll (Page 2088)
Overview of the functions (Page 2067)

3.7.3.5 RPJProjectUnlock

Description
The lock of a print job list is removed.

Declaration

BOOL RPJProjectUnlock (
LPCSTR pszProjectName,
CMN_ERROR* pcmnerror );

Parameters

pszProjectName
Pointer to the name of the project file consisting of the path, project name and extension.

pcmnerror
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
The lock of the print job list was removed.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2087
Runtime API
3.7 Report system functions

FALSE
An access conflict has occurred.

Required files
rpjapi.h
rpjapi.lib
rpjapi.dll

Related functions

RPJProjectLock (Page 2085) Creating a lock

RPJProjectUnlockAll (Page 2088) Removing all locks

See also
RPJProjectLock (Page 2085)
RPJProjectUnlockAll (Page 2088)
Overview of the functions (Page 2067)

3.7.3.6 RPJProjectUnlockAll

Description
All locks of a print job list are removed.

Declaration

BOOL RPJProjectUnlockAll (
LPCSTR pszProjectName,
CMN_ERROR* pcmnerror );

Parameters

pszProjectName
Pointer to the name of the project file consisting of the path, project name and extension.

pcmnerror
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.

WinCC Engineering V18 – Programming reference

2088 System Manual, 11/2022, Online documentation
 Runtime API
3.7 Report system functions

Return value

TRUE
All locks of the print job list were removed.

FALSE
An access conflict has occurred.

Required files
rpjapi.h
rpjapi.lib
rpjapi.dll

Related functions

RPJProjectLock (Page 2085) Creating a lock

RPJProjectUnlock (Page 2087) Removing a lock

See also
RPJProjectLock (Page 2085)
RPJProjectUnlock (Page 2087)
Overview of the functions (Page 2067)

3.7.4 Functions for processing print jobs

3.7.4.1 RPJCreateJob

Description
Creates a new print job.

Declaration

BOOL RPJCreateJob (
LPCSTR pszProjectName,
LPCSTR pszJobName,
CMN_ERROR* pcmnerror );

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2089
Runtime API
3.7 Report system functions

Parameters

pszProjectName
Pointer to the name of the project file consisting of the path, project name and extension.

pszJobName
Pointer to the name of the print job to be created.

pcmnerror
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
Print job created.

FALSE
Error

Required files
rpjapi.h
rpjapi.lib
rpjapi.dll

Related functions

RPJDeleteJob (Page 2090) Delete print job

See also
RPJDeleteJob (Page 2090)
Overview of the functions (Page 2067)

3.7.4.2 RPJDeleteJob

Description
A print job specified by pszJobName is deleted.

WinCC Engineering V18 – Programming reference

2090 System Manual, 11/2022, Online documentation
 Runtime API
3.7 Report system functions

Declaration

BOOL RPJDeleteJob (
LPCSTR pszProjectName,
LPCSTR pszJobName,
CMN_ERROR* pcmnerror );

Parameters

pszProjectName
Pointer to the name of the project file consisting of the path, project name and extension.

pszJobName
Pointer to the name of the print job to be deleted.

pcmnerror
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
Print job deleted.

FALSE
Error

Required files
rpjapi.h
rpjapi.lib
rpjapi.dll

Related functions

RPJCreateJob (Page 2089) Create a print job

See also
RPJCreateJob (Page 2089)
Overview of the functions (Page 2067)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2091
Runtime API
3.7 Report system functions

3.7.4.3 RPJCreatePropertyHandle

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 (
LPCSTR pszProjectName,
CMN_ERROR* pcmnerror );

Parameters

pszProjectName
Pointer to the name of the project file consisting of the path, project name and extension.

pcmnerror
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
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 2093) Delete handle

RPJPropertyClear (Page 2112) Initialize memory area
RPJGetJobProps (Page 2107) Determine print job properties

WinCC Engineering V18 – Programming reference

2092 System Manual, 11/2022, Online documentation
 Runtime API
3.7 Report system functions

RPJGetProperty (Page 2109) Determine print job property

RPJSetProperty (Page 2113) Specify print job properties

Examples
Show print job preview (Page 2131) "RD02.cpp"
Modify print job properties (Page 2126) "RD02.cpp"
Get print job names (Page 2120) "RD02.cpp"
Get print job method name (Page 2117) "RD02.cpp"
Get print job properties (Page 2123) "RD02.cpp"

See also
Get print job method name (Page 2117)
Get print job names (Page 2120)
Get print job properties (Page 2123)
Modify print job properties (Page 2126)
Show print job preview (Page 2131)
RPJDeletePropertyHandle (Page 2093)
RPJGetProperty (Page 2109)
RPJGetJobProps (Page 2107)
RPJSetProperty (Page 2113)
RPJPropertyClear (Page 2112)
Overview of the functions (Page 2067)

3.7.4.4 RPJDeletePropertyHandle

Description
Each handle created with RPJCreatePropertyHandle, is deleted with this function when it is no
longer needed.

Declaration

BOOL RPJDeletePropertyHandle (
HPROPERTIES hproperties,
CMN_ERROR* pcmnerror );

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2093
Runtime API
3.7 Report system functions

Parameters

hproperties
The handle of the print job property is created by the RPJCreatePropertyHandle function.

pcmnerror
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
Handle deleted

FALSE
Error

Required files
rpjapi.h
rpjapi.lib
rpjapi.dll

Related functions

RPJCreatePropertyHandle (Page 2092) Create handle

Examples
Show print job preview (Page 2131) "RD02.cpp"
Modify print job properties (Page 2126) "RD02.cpp"
Get print job names (Page 2120) "RD02.cpp"
Get print job method name (Page 2117) "RD02.cpp"
Get print job properties (Page 2123) "RD02.cpp"

See also
RPJCreatePropertyHandle (Page 2092)
Get print job method name (Page 2117)
Get print job names (Page 2120)
Get print job properties (Page 2123)
Modify print job properties (Page 2126)

WinCC Engineering V18 – Programming reference

2094 System Manual, 11/2022, Online documentation
 Runtime API
3.7 Report system functions

Show print job preview (Page 2131)

Overview of the functions (Page 2067)

3.7.4.5 RPJGetJobNameAt

Description
Determines the name of a print job specified by dwJobIndex.

Declaration

BOOL RPJGetJobNameAt (
LPCSTR pszProjectName,
DWORD dwJobIndex,
LPSTR pszBuffer,
DWORD dwCharMax,
CMN_ERROR* pcmnerror );

Parameters

PszProjectName
Pointer to the name of the project file consisting of the path, project name and extension.

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
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
Name of the print job determined.

FALSE
Error

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2095
Runtime API
3.7 Report system functions

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
Get print job names (Page 2120) "RD02.cpp"

See also
Get print job names (Page 2120)
Overview of the functions (Page 2067)

3.7.4.6 RPJGetNumJobs

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 (
LPCSTR pszProjectName,
DWORD* pdwNumJobs,
CMN_ERROR* pcmnerror );

Parameters

pszProjectName
Pointer to the name of the project file consisting of the path, project name and extension.

pdwNumJobs
Pointer to the location where the number of print jobs should be stored.

WinCC Engineering V18 – Programming reference

2096 System Manual, 11/2022, Online documentation
 Runtime API
3.7 Report system functions

pcmnerror
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
Number of print jobs determined.

FALSE
Error

Required files
rpjapi.h
rpjapi.lib
rpjapi.dll

Examples
Get print job names (Page 2120) "RD02.cpp"

See also
Get print job names (Page 2120)
Overview of the functions (Page 2067)

3.7.4.7 RPJJobLock

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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2097
Runtime API
3.7 Report system functions

Declaration

BOOL RPJJobLock (
LPCSTR pszProjectName,
LPCSTR pszJobName,
BOOL fWriteLock,
BOOL fDoNotWait,
LPCSTR pszLockerNameNew,
LPSTR* ppszLockerNameCur,
CMN_ERROR* pcmnerror );

Parameters

pszProjectName
Pointer to the name of the project, consisting of the path, project name, and extension.

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
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
Print job is locked.

WinCC Engineering V18 – Programming reference

2098 System Manual, 11/2022, Online documentation
 Runtime API
3.7 Report system functions

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 2099) Removing a lock

RPJJobUnlockAll (Page 2100) Removing all locks

See also
RPJJobUnlockAll (Page 2100)
RPJJobUnlock (Page 2099)
Overview of the functions (Page 2067)

3.7.4.8 RPJJobUnlock

Description
The lock of a print job is removed.

Declaration

BOOL RPJJobUnlock (
LPCSTR pszProjectName,
LPCSTR pszJobName,
CMN_ERROR* pcmnerror );

Parameters

pszProjectName
Pointer to the name of the project file consisting of the path, project name and extension.

pszJobName
Pointer to the name of the print job.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2099
Runtime API
3.7 Report system functions

pcmnerror
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
The lock of the print job was removed.

FALSE
An access conflict has occurred.

Required files
rpjapi.h
rpjapi.lib
rpjapi.dll

Related functions

RPJJobLock (Page 2097) Creating a lock

RPJJobUnlockAll (Page 2100) Removing all locks

See also
RPJJobUnlockAll (Page 2100)
RPJJobLock (Page 2097)
Overview of the functions (Page 2067)

3.7.4.9 RPJJobUnlockAll

Description
All locks of a print job are removed.

Declaration

BOOL RPJJobUnlockAll (
LPCSTR pszProjectName,
LPCSTR pszJobName,
CMN_ERROR* pcmnerror );

WinCC Engineering V18 – Programming reference

2100 System Manual, 11/2022, Online documentation
 Runtime API
3.7 Report system functions

Parameters

pszProjectName
Pointer to the name of the project file consisting of the path, project name and extension.

pszJobName
Pointer to the name of the print job.

pcmnerror
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
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 2097) Creating a lock

RPJJobUnlock (Page 2099) Removing a lock

See also
RPJJobUnlock (Page 2099)
RPJJobLock (Page 2097)
Overview of the functions (Page 2067)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2101
Runtime API
3.7 Report system functions

3.7.5 Functions for processing print job methods

3.7.5.1 RPJCallJobMethod

Description
This function allows you to specify a specific job method. Currently, there are two methods:
PrintJob and PreviewJob.

Declaration

RPJCallJobMethod (
HPROPERTIES hproperties,
LPCSTR pszMethodName
CMN_ERROR* pcmnerror );

Parameters

hproperties
The handle of the print job property is created by the RPJCreatePropertyHandle function.

pszMethodName
Pointer to the name of the job method to be used.

pcmnerror
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
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

WinCC Engineering V18 – Programming reference

2102 System Manual, 11/2022, Online documentation
 Runtime API
3.7 Report system functions

rpjapi.lib
rpjapi.dll

Examples
Show print job preview (Page 2131) "RD02.cpp"

See also
Show print job preview (Page 2131)
Overview of the functions (Page 2067)

3.7.5.2 RPJGetJobMethodAt

Description
The function determines the name of the printing method specified in dwMethodIndex.

Declaration

BOOL RPJGetJobMethodAt (
DWORD dwMethodIndex,
LPSTR pszBuffer,
DWORD dwCharMax,
CMN_ERROR* pcmnerror );

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
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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2103
Runtime API
3.7 Report system functions

Return value

TRUE
Name of the print job method determined

FALSE
Error

Required files
rpjapi.h
rpjapi.lib
rpjapi.dll

Examples
Get print job method name (Page 2117) "RD02.cpp"

See also
Get print job method name (Page 2117)
Overview of the functions (Page 2067)

3.7.5.3 RPJGetNumJobMethods

Description
The function determines how many print job methods are currently available.

Declaration

BOOL RPJGetNumJobMethods (
DWORD* pdwNumMethods,
CMN_ERROR* pcmnerror );

Parameters

pdwNumMethods
Pointer to the location where the number of print job methods should be stored.

pcmnerror
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.

WinCC Engineering V18 – Programming reference

2104 System Manual, 11/2022, Online documentation
 Runtime API
3.7 Report system functions

Return value

TRUE
Number of print job methods determined

FALSE
Error

Required files
rpjapi.h
rpjapi.lib
rpjapi.dll

Examples
Get print job method name (Page 2117) "RD02.cpp"

See also
Get print job method name (Page 2117)
Overview of the functions (Page 2067)

3.7.6 Functions for processing print job methods

3.7.6.1 RPJGetJobPropertyAt

Description
Determines the name and type of job property specified in dwPropindex.

Declaration

BOOL RPJGetJobPropertyAt (
DWORD dwPropIndex,
LPSTR pszBuffer,
DWORD dwCharMax,
DWORD* pdwPropType,
CMN_ERROR* pcmnerror );

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2105
Runtime API
3.7 Report system functions

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
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
Name of the print job property determined

FALSE
Error

Required files
rpjapi.h
rpjapi.lib
rpjapi.dll

Examples
Get print job properties (Page 2123) "RD02.cpp"

See also
Get print job properties (Page 2123)
Overview of the functions (Page 2067)

WinCC Engineering V18 – Programming reference

2106 System Manual, 11/2022, Online documentation
 Runtime API
3.7 Report system functions

3.7.6.2 RPJGetJobProps

Description
The function determines the properties of a print job and stores it in the internal hProps buffer.

Declaration

BOOL RPJGetJobProps (
HPROPERTIES hproperties,
LPCSTR pszJobName,
CMN_ERROR* pcmnerror );

Parameters

hproperties
The handle of the print job property is created by the RPJCreatePropertyHandle function.

pszJobName
Pointer to the name of the print job.

pcmnerror
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.

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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2107
Runtime API
3.7 Report system functions

Related functions

RPJCreatePropertyHandle (Page 2092) Create handle

RPJGetProperty (Page 2109) Determine print job property
RPJSetProperty (Page 2113) Specify print job properties

Examples
Show print job preview (Page 2131) "RD02.cpp"
Modify print job properties (Page 2126) "RD02.cpp"

See also
RPJGetProperty (Page 2109)
RPJSetProperty (Page 2113)
Modify print job properties (Page 2126)
Show print job preview (Page 2131)
RPJCreatePropertyHandle (Page 2092)
Overview of the functions (Page 2067)

3.7.6.3 RPJGetNumJobProperties

Description
Determines the number of available print job properties.

Declaration

BOOL RPJGetNumJobProperties (
DWORD* pdwNumProperties,
CMN_ERROR* pcmnerror );

Parameters

pdwNumProperties
Pointer to the location where the number of print job properties should be stored.

pcmnerror
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.

WinCC Engineering V18 – Programming reference

2108 System Manual, 11/2022, Online documentation
 Runtime API
3.7 Report system functions

Return value

TRUE
Number of print job properties determined

FALSE
Error

Required files
rpjapi.h
rpjapi.lib
rpjapi.dll

Examples
Get print job properties (Page 2123) "RD02.cpp"

See also
Get print job properties (Page 2123)
Overview of the functions (Page 2067)

3.7.6.4 RPJGetProperty

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 (
HPROPERTIES hproperties,
LPCSTR pszPropName,
PVOID pvPropValue,
VARTYPE vtPropType,
DWORD dwBufferSize,
CMN_ERROR* pcmnerror );

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2109
Runtime API
3.7 Report system functions

Parameters

hproperties
The handle of the print job property is created by the RPJCreatePropertyHandle function.

pszPropName
Pointer to the name of the print job property:

AbsoluteSelectionFrom
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.
RelativeSelectionCount
RelativeSelectionRange
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

WinCC Engineering V18 – Programming reference

2110 System Manual, 11/2022, Online documentation
 Runtime API
3.7 Report system functions

LayoutName VT_LPSTR / VT_LPWSTR

PrinterName VT_LPSTR / VT_LPWSTR
PrinterName2 VT_LPSTR / VT_LPWSTR
PrinterName3 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
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
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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2111
Runtime API
3.7 Report system functions

rpjapi.dll

Related functions

RPJCreatePropertyHandle (Page 2092) Create handle

RPJGetJobProps (Page 2107) Determine print job properties
RPJSetProperty (Page 2113) Specify print job properties

Examples
Modify print job properties (Page 2126) "RD02.cpp"

See also
RPJGetJobProps (Page 2107)
RPJSetProperty (Page 2113)
RPJCreatePropertyHandle (Page 2092)
Modify print job properties (Page 2126)
Overview of the functions (Page 2067)

3.7.6.5 RPJPropertyClear

Description
This function is useful if you want to initialize a memory area referenced by a handle without
deleting the handle.

Declaration

BOOL RPJPropertyClear (
HPROPERTIES hproperties,
CMN_ERROR* pcmnerror );

Parameters

hproperties
The handle of the print job property is created by the RPJCreatePropertyHandle function.

pcmnerror
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.

WinCC Engineering V18 – Programming reference

2112 System Manual, 11/2022, Online documentation
 Runtime API
3.7 Report system functions

Return value

TRUE
Memory initialized.

FALSE
Error

Required files
rpjapi.h
rpjapi.lib
rpjapi.dll

Related functions

RPJCreatePropertyHandle (Page 2092) Create handle

See also
RPJCreatePropertyHandle (Page 2092)
Overview of the functions (Page 2067)

3.7.6.6 RPJSetProperty

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 (
HPROPERTIES hproperties,
LPCSTR pszPropName,
PVOID pvPropValue,
VARTYPE vtPropType,
DWORD dwReserved,
CMN_ERROR* pcmnerror );

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2113
Runtime API
3.7 Report system functions

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:

AbsoluteSelectionFrom
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.
RelativeSelectionCount
RelativeSelectionRange
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

WinCC Engineering V18 – Programming reference

2114 System Manual, 11/2022, Online documentation
 Runtime API
3.7 Report system functions

JobName VT_LPSTR / VT_LPWSTR

LayoutName VT_LPSTR / VT_LPWSTR
PrinterName VT_LPSTR / VT_LPWSTR
PrinterName2 VT_LPSTR / VT_LPWSTR
PrinterName3 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
The parameter is reserved for future expansions.

pcmnerror
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
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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2115
Runtime API
3.7 Report system functions

Related functions

RPJCreatePropertyHandle (Page 2092) Create handle

RPJGetJobProps (Page 2107) Determine print job properties
RPJGetProperty (Page 2109) Determine print job property

Examples
Modify print job properties (Page 2126) "RD02.cpp"

See also
RPJGetJobProps (Page 2107)
RPJGetProperty (Page 2109)
RPJCreatePropertyHandle (Page 2092)
Modify print job properties (Page 2126)
Overview of the functions (Page 2067)

WinCC Engineering V18 – Programming reference

2116 System Manual, 11/2022, Online documentation
 Runtime API
3.7 Report system functions

3.7.7 Examples

3.7.7.1 Get print job method name

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)
{
// #define PROJ_PATH "C:\\siemens\\odk\\samples\\projects\\demo\\odk.mcp"
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);
MyDMEnumOpenedProjects(); // open the DM and set the g_szProjectFile
memset(&Error, 0, sizeof(CMN_ERROR));
ret = RPJAttach(&Error);
if (FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in RPJAttach: E1=
0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
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
memset(&Error, 0, sizeof(CMN_ERROR));
hProp = RPJCreatePropertyHandle (/*PROJ_PATH*/g_szProjectFile, &Error);
if(NULL == hProp)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2117
Runtime API
3.7 Report system functions

{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in
RPJCreatePropertyHandle: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
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"),
Error.dwError1, Error.dwError2, Error.szErrorText);
}
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);
}
memset(&Error,0,sizeof(CMN_ERROR));
ret = RPJGetNumJobMethods(&d, &Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in RPJGetNumJobMethods:
E1= 0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
ODKTrace(szText);
}
else
{
for (i = 0; i < d; i++)
{
memset(&Error,0,sizeof(CMN_ERROR));
ret = RPJGetJobMethodAt(i, buf, dwBufsize, &Error);
if (ret == FALSE)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in
RPJDeletePropertyHandle: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" %d
PrintJobMethod=%s"),i+1,buf);
}
ODKTrace(szText);
}
}
memset(&Error,0,sizeof(CMN_ERROR));
ret = RPJDeletePropertyHandle(hProp, &Error);

WinCC Engineering V18 – Programming reference

2118 System Manual, 11/2022, Online documentation
 Runtime API
3.7 Report system functions

if (FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in
RPJDeletePropertyHandle: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("RPJDeletePropertyHandle"));
}
ODKTrace(szText);
memset(&Error,0,sizeof(CMN_ERROR));
ret = RPJDetach(&Error);
if (FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in RPJDetach: E1=
0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("RPJDetach"));
}
ODKTrace(szText);
}
//{{ODK_EXAMPLE}(END)}

See also
RPJCreatePropertyHandle (Page 2092)
RPJDeletePropertyHandle (Page 2093)
RPJGetJobMethodAt (Page 2103)
RPJGetNumJobMethods (Page 2104)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2119
Runtime API
3.7 Report system functions

3.7.7.2 Get print job names

Example

//{{ODK_EXAMPLE}Get print job names (RPT)}

//{{FUNCTION}RPJCreatePropertyHandle (RPT)}
//{{FUNCTION}RPJDeletePropertyHandle (RPT)}
//{{FUNCTION}RPJGetNumJobs (RPT)}
//{{FUNCTION}RPJGetJobNameAt (RPT)}
//{{FUNCTION}(END)}
// =====================================================================
// Function: MyRPJGetJobNameAt( void ) ODK RD RT
// =====================================================================
// : Get all print job names (Enum) !
// =====================================================================
void MyRPJGetJobNameAt(void)
{
// #define PROJ_PATH "C:\\siemens\\odk\\samples\\projects\\demo\\odk.mcp"
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 = 500;
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("--------------------"));
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("MyRPJGetJobNameAt:"));
ODKTrace(szText);
MyDMEnumOpenedProjects(); // open the DM and set the g_szProjectFile
memset(&Error, 0, sizeof(CMN_ERROR));
ret = RPJAttach(&Error);
if (FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in RPJAttach: E1=
0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
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
memset(&Error, 0, sizeof(CMN_ERROR));
hProp = RPJCreatePropertyHandle (/*PROJ_PATH*/g_szProjectFile, &Error);
if(NULL == hProp)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in
RPJCreatePropertyHandle: E1= 0x%08lx ; E2= 0x%08lx ; %s"),

WinCC Engineering V18 – Programming reference

2120 System Manual, 11/2022, Online documentation
 Runtime API
3.7 Report system functions

Error.dwError1, Error.dwError2, Error.szErrorText);

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"),
Error.dwError1, Error.dwError2, Error.szErrorText);
}
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);
}
memset(&Error,0,sizeof(CMN_ERROR));
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"),
Error.dwError1, Error.dwError2, Error.szErrorText);
ODKTrace(szText);
}
else
{
for (i = 0; i < d; i++)
{
memset(&Error,0,sizeof(CMN_ERROR));
ret = FALSE;
ret = RPJGetJobNameAt(/*PROJ_PATH*/g_szProjectFile, i, buf, dwBufsize, &Error);
if (ret == FALSE)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in
RPJDeletePropertyHandle: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" %d
PrintJobName=%s"),i+1, buf);
}
ODKTrace(szText);
}
}
memset(&Error,0,sizeof(CMN_ERROR));
ret = FALSE;
ret = RPJDeletePropertyHandle(hProp, &Error);
if (ret == FALSE)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2121
Runtime API
3.7 Report system functions

{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in
RPJDeletePropertyHandle: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("RPJDeletePropertyHandle"));
}
ODKTrace(szText);
memset(&Error,0,sizeof(CMN_ERROR));
ret = RPJDetach(&Error);
if (FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in RPJDetach: E1=
0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("RPJDetach"));
}
ODKTrace(szText);
}
//{{ODK_EXAMPLE}(END)}

See also
RPJCreatePropertyHandle (Page 2092)
RPJDeletePropertyHandle (Page 2093)
RPJGetJobNameAt (Page 2095)
RPJGetNumJobs (Page 2096)

WinCC Engineering V18 – Programming reference

2122 System Manual, 11/2022, Online documentation
 Runtime API
3.7 Report system functions

3.7.7.3 Get print job properties

Example

//{{ODK_EXAMPLE}Get print job properties (RPT)}

//{{FUNCTION}RPJCreatePropertyHandle (RPT)}
//{{FUNCTION}RPJDeletePropertyHandle (RPT)}
//{{FUNCTION}RPJGetNumJobProperties (RPT)}
//{{FUNCTION}RPJGetJobPropertyAt (RPT)}
//{{FUNCTION}(END)}
// =====================================================================
// Function: MyRPJGetJobPropertyAt( void ) ODK RD RT
// =====================================================================
// : Inquire print job properties (Enum) !
// =====================================================================
void MyRPJGetJobPropertyAt(void)
{
// #define PROJ_PATH "C:\\siemens\\odk\\samples\\projects\\demo\\odk.mcp"
BOOL ret = FALSE;
CMN_ERROR Error;
HPROPERTIES hProp = NULL;
TCHAR jobname[255];
TCHAR szText[255];
DWORD d = 0L;
DWORD f = 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("MyRPJGetJobPropertyAt:"));
ODKTrace(szText);
MyDMEnumOpenedProjects(); // open the DM and set the g_szProjectFile
memset(&Error, 0, sizeof(CMN_ERROR));
ret = RPJAttach(&Error);
if (FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in RPJAttach: E1=
0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
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
memset(&Error, 0, sizeof(CMN_ERROR));
hProp = RPJCreatePropertyHandle (/*PROJ_PATH*/g_szProjectFile, &Error);
if(NULL == hProp)
{

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2123
Runtime API
3.7 Report system functions

_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in

RPJCreatePropertyHandle: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
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"),
Error.dwError1, Error.dwError2, Error.szErrorText);
}
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);
}
memset(&Error,0,sizeof(CMN_ERROR));
ret = RPJGetNumJobProperties(&d, &Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in
RPJGetNumJobProperties: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
ODKTrace(szText);
}
else
{
for (i = 0; i < d; i++)
{
memset(&Error,0,sizeof(CMN_ERROR));
ret = RPJGetJobPropertyAt(i, buf, dwBufsize, &f, &Error);
if (FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in
RPJGetJobPropertyAt: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" %d
PrintJobProperty=%s"),i+1, buf);
}
ODKTrace(szText);
}
}
memset(&Error,0,sizeof(CMN_ERROR));
ret = RPJDeletePropertyHandle(hProp, &Error);
if (FALSE == ret)

WinCC Engineering V18 – Programming reference

2124 System Manual, 11/2022, Online documentation
 Runtime API
3.7 Report system functions

{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in
RPJDeletePropertyHandle: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("RPJDeletePropertyHandle"));
}
ODKTrace(szText);
memset(&Error,0,sizeof(CMN_ERROR));
ret = RPJDetach(&Error);
if (FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in RPJDetach: E1=
0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("RPJDetach"));
}
ODKTrace(szText);
}
//{{ODK_EXAMPLE}(END)}

See also
RPJCreatePropertyHandle (Page 2092)
RPJDeletePropertyHandle (Page 2093)
RPJGetJobPropertyAt (Page 2105)
RPJGetNumJobProperties (Page 2108)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2125
Runtime API
3.7 Report system functions

3.7.7.4 Modify print job properties

Example

//{{ODK_EXAMPLE}Modify print job properties (RPT)}

//{{FUNCTION}RPJCreatePropertyHandle (RPT)}
//{{FUNCTION}RPJDeletePropertyHandle (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)
{
// #define PROJ_PATH "C:\\siemens\\odk\\samples\\projects\\demo\\odk.mcp"
BOOL ret = FALSE;
CMN_ERROR Error;
TCHAR szText[255];
HPROPERTIES hProp = NULL;
SYSTEMTIME st;
LPVOID ptr;
DWORD typ;
TCHAR jobname[200];
TCHAR propname[200];
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("--------------------"));
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("MyModifyPrintJob:"));
ODKTrace(szText);
MyDMEnumOpenedProjects(); // open the DM and set the g_szProjectFile
memset(&Error, 0, sizeof(CMN_ERROR));
ret = RPJAttach(&Error);
if (FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in RPJAttach: E1=
0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
ODKTrace(szText);
return;
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("RPJAttach"));
ODKTrace(szText);
}
// read properties
memset(&Error, 0, sizeof(CMN_ERROR));
hProp = RPJCreatePropertyHandle (/*PROJ_PATH*/g_szProjectFile, &Error);
if(NULL == hProp)
{

WinCC Engineering V18 – Programming reference

2126 System Manual, 11/2022, Online documentation
 Runtime API
3.7 Report system functions

_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in

RPJCreatePropertyHandle: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
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"),
Error.dwError1, Error.dwError2, Error.szErrorText);
}
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);
}
_tcsncpy_s(jobname, _countof(jobname), _T("ODK_PRINTJOB"), _TRUNCATE);
memset(&Error, 0, sizeof(CMN_ERROR));
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"),
Error.dwError1, Error.dwError2, Error.szErrorText);
ODKTrace(szText);
ret = RPJDeletePropertyHandle (hProp, &Error);
if(ret == FALSE)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in
RPJDeletePropertyHandle: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("RPJDeletePropertyHandle"));
}
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"),
Error.dwError1, Error.dwError2, Error.szErrorText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("RPJDetach"));
}

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2127
Runtime API
3.7 Report system functions

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;
memset(&Error,0,sizeof(CMN_ERROR));
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"),
Error.dwError1, Error.dwError2, Error.szErrorText);
}
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;
memset(&Error,0,sizeof(CMN_ERROR));
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"),
Error.dwError1, Error.dwError2, Error.szErrorText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" RPJSetProperty"));
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("
Jobname=%s ;Propname=%s"),jobname,propname);

WinCC Engineering V18 – Programming reference

2128 System Manual, 11/2022, Online documentation
 Runtime API
3.7 Report system functions

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);
memset(&Error,0,sizeof(CMN_ERROR));
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"),
Error.dwError1, Error.dwError2, Error.szErrorText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" RPJSetJobProps"));
}
ODKTrace(szText);
memset(&Error,0,sizeof(CMN_ERROR));
ret = RPJDeletePropertyHandle (hProp, &Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in
RPJDeletePropertyHandle: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("RPJDeletePropertyHandle"));
}
ODKTrace(szText);
memset(&Error,0,sizeof(CMN_ERROR));
ret = RPJDetach(&Error);
if (FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in RPJDetach: E1=
0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE,
_T("RPJDeletePropertyHandle")); }
ODKTrace(szText);
}
//{{ODK_EXAMPLE}(END)}

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2129
Runtime API
3.7 Report system functions

See also
RPJCreatePropertyHandle (Page 2092)
RPJDeletePropertyHandle (Page 2093)
RPJGetJobProps (Page 2107)
RPJGetProperty (Page 2109)
RPJSetProperty (Page 2113)

WinCC Engineering V18 – Programming reference

2130 System Manual, 11/2022, Online documentation
 Runtime API
3.7 Report system functions

3.7.7.5 Show print job preview

Example

// =====================================================================
// =====================================================================
// : Modul with examples of Report Designer
// *********************************************************************
// Copyright (C) 1995-99 SIEMENS AG, A&D PT1 D2 All rights reserved
// *********************************************************************
#include "stdafx.h" // if MFC classes
#include "RD02.h"
#include "DM01.h"

//{{ODK_EXAMPLE}Show print job preview (RPT)}

//{{FUNCTION}RPJCreatePropertyHandle (RPT)}
//{{FUNCTION}RPJDeletePropertyHandle (RPT)}
//{{FUNCTION}RPJGetJobProps (RPT)}
//{{FUNCTION}RPJCallJobMethod (RPT)}
//{{FUNCTION}(END)}
// =====================================================================
// Function: MyShowPrintJobPreview( void ) ODK RD RT
// =====================================================================
// : Show print job preview
// =====================================================================
void MyShowPrintJobPreview(void)
{
// #define PROJ_PATH "C:\\siemens\\odk\\samples\\projects\\demo\\odk.mcp"
BOOL ret = FALSE;
TCHAR szText[255];
CMN_ERROR Error;
HPROPERTIES hProp = NULL;
TCHAR jobname[200];
TCHAR methode[200];
_tcsncpy_s(jobname, _countof(jobname), _T("ODK_PRINTJOB"), _TRUNCATE); // print job
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("--------------------"));
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("MyShowPrintJobPreview:"));
ODKTrace(szText);
MyDMEnumOpenedProjects(); // open the DM and set the g_szProjectFile
memset(&Error, 0, sizeof(CMN_ERROR));
ret = RPJAttach(&Error);
if (FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in RPJAttach: E1=
0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
ODKTrace(szText);
return;
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("RPJAttach"));
ODKTrace(szText);

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2131
Runtime API
3.7 Report system functions

}
memset(&Error, 0, sizeof(CMN_ERROR));
hProp = RPJCreatePropertyHandle (/*PROJ_PATH*/g_szProjectFile, &Error);
if(NULL == hProp)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in
RPJCreatePropertyHandle: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
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"),
Error.dwError1, Error.dwError2, Error.szErrorText);
}
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);
}
memset(&Error, 0, sizeof(CMN_ERROR));
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"),
Error.dwError1, Error.dwError2, Error.szErrorText);
ODKTrace(szText);
ret = RPJDeletePropertyHandle (hProp, &Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in
RPJDeletePropertyHandle: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("RPJDeletePropertyHandle"));
}
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"),
Error.dwError1, Error.dwError2, Error.szErrorText);
}

WinCC Engineering V18 – Programming reference

2132 System Manual, 11/2022, Online documentation
 Runtime API
3.7 Report system functions

else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("RPJDetach"));
}
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);
memset(&Error, 0, sizeof(CMN_ERROR));
ret = RPJCallJobMethod (hProp, methode, &Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in RPJGetJobProps: E1=
0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" RPJCallJobMethod"));
}
ODKTrace(szText);
memset(&Error, 0, sizeof(CMN_ERROR));
ret = RPJDeletePropertyHandle (hProp, &Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in
RPJDeletePropertyHandle: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("RPJDeletePropertyHandle"));
}
ODKTrace(szText);
memset(&Error, 0, sizeof(CMN_ERROR));
ret = RPJDetach(&Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in RPJDetach: E1=
0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("RPJDetach"));
}
ODKTrace(szText);
}
//{{ODK_EXAMPLE}(END)}

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2133
Runtime API
3.8 Tag and log functions

See also
RPJCreatePropertyHandle (Page 2092)
RPJDeletePropertyHandle (Page 2093)
RPJCallJobMethod (Page 2102)
RPJGetJobProps (Page 2107)

3.8 Tag and log functions

3.8.1 Basics

3.8.1.1 Overview of the functions

Overview

TLG_ENUM_ARCHIV_CALLBACK (Page 2208) List logs (callback)

TLG_ENUM_PROJECT_NAME_CALLBACK List projects (callback)
(Page 2199)
TLG_ENUM_TIME_NAME_CALLBACK (Page 2245) List time objects (callback)
TLG_ENUM_VARIABLE_NAME_CALLBACK List tags (callback)
(Page 2201)
TLG_ENUMBACKUP_ENTRIES (Page 2252) List backups (callback)
TLG_ENUMTABLES (Page 2215) List logs (callback)
TLG_ENUMTIMES_CALLBACK (Page 2248) List time objects (callback)
TLG_ENUMVARIABLES (Page 2204) List tags (callback)
TLG_GETARCHIVDATA_CALLBACK (Page 2220) Read out data of a log (callback)
TLGChangeLanguage (Page 2190) Language switching
TLGCloseProject (Page 2194) Close project
TLGCloseWindow (Page 2235) Close print job/script diagnostics
TLGConnect (Page 2191) Establish connection to Tag Logging RT
TLGCSConnectEx (Page 2188) Establish connection to Tag Logging CS
TLGCSConnect (Page 2186) Establish connection to Tag Logging CS
TLGDisconnect (Page 2193) Terminate connection to Tag Logging RT
TLGDrawCurvesInDC (Page 2236) Show trends
TLGEnumArchives (Page 2207) List logs
TLGEnumArchivsEx (Page 2212) List logs
TLGEnumArchivs (Page 2210) List logs
TLGEnumArchivsSel (Page 2213) List logs
TLGEnumBackupEntries (Page 2250) List backups
TLGEnumProject (Page 2198) List projects

WinCC Engineering V18 – Programming reference

2134 System Manual, 11/2022, Online documentation
 Runtime API
3.8 Tag and log functions

TLGEnumTime (Page 2244) List time objects

TLGEnumTimes (Page 2246) List time objects
TLGEnumVariablesEx (Page 2202) List tags
TLGEnumVariables (Page 2200) List tags
TLGExport (Page 2253) Export log
TLGFreeMemory (Page 2217) Free memory
TLGGetArchivDataEx (Page 2222) Read out data of a log
TLGGetArchivData (Page 2218) Read out data of a log
TLGGetBackupSize (Page 2255) Determine size of an exported data record
TLGGetClosestTimeEx (Page 2226) Determine logging time
TLGGetClosestTime (Page 2224) Determine logging time
TLGInsertArchivData (Page 2228) Insert data in a log
TLGInsertTemplateItem (Page 2238) Write entries to trend window templates, write en‐
tries to table window templates
TLGLockArchiv (Page 2231) Enable log, lock log
TLGLockVariable (Page 2232) Enable tag, lock tag
TLGOpenProject (Page 2195) Open project
TLGPressToolbarButton (Page 2239) Activate buttons in the toolbar
TLGReadArchiv (Page 2234) Read log parameters
TLGReadTime (Page 2249) Determine time object parameters
TLGReadVariable (Page 2205) Determine tag parameters
TLGSetRulerWindowVisible (Page 2241) Also display reading line window
TLGShowWindow (Page 2242) Display print job/script diagnostics

3.8.1.2 Overview of structures

Overview

TLG_ARCHIV_STR (Page 2147) Log parameters

TLG_ARCHIVDATARAW (Page 2150) Log data
TLG_BACKUP_TABLE_INFO (Page 2153) Information on export table
TLG_CURVESCALEX (Page 2155) Scaling of the x-axis
TLG_CURVESCALEY (Page 2160) Scaling of the y-axis
TLG_GETARCHIVDATA (Page 2164) Log data of process value logs, log data of com‐
pressed logs
TLG_IO_BACKUP_SELECT (Page 2165) Selection criteria for backup functions
TLG_PROT_CURVE_INFOS (Page 2166) Report structure of trends
TLG_TABLE_INFO (Page 2169) Report structure of tables
TLG_SCAL_STR (Page 2168) Tag limits
TLG_TABLESCALE (Page 2170) Table column (properties)
TLG_TEMPLATEITEM_INFO (Page 2173) Trend (properties) Table column (properties)
TLG_TIME_STR (Page 2175) Time object
TLG_TIMEDATA (Page 2176) Time object

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2135
Runtime API
3.8 Tag and log functions

TLG_TPLITEM_CURVE (Page 2177) Trend (properties)

TLG_TPLITEM_INFO (Page 2178) Trend (properties) Table column (properties)
TLG_TPLITEM_TABLE (Page 2179) Table column (properties)
TLG_VAR_STR (Page 2180) Tag (properties)
TLG_VARIABLE_INFO (Page 2185) Tag

3.8.1.3 Error messages

Overview
The following error messages can be returned by the API functions in the CMN_ERROR error
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

WinCC Engineering V18 – Programming reference

2136 System Manual, 11/2022, Online documentation
 Runtime API
3.8 Tag and log functions

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
(WinCC V6.2 and higher)
TLG_API_EXPORT_NO_WRITE 0x10000032 Export file was not written
(WinCC V6.2 and higher)
TLG_API_CORRUPT_DATA 0x10000033 Data unusable/defective
(WinCC V6.2 and higher)
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

3.8.1.4 Constants

Runtime window

TLG_CURVE_WINDOW 0x00000001 Trend window

TLG_TABLE_WINDOW 0x00000002 Table window
TLG_CTRL_WINDOW 0x00000004 TLGRT control window

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2137
Runtime API
3.8 Tag and log functions

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

WinCC Engineering V18 – Programming reference

2138 System Manual, 11/2022, Online documentation
 Runtime API
3.8 Tag and log functions

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 ta‐
ble window template
TLG_MAX_TEMPLATEITEM_NAME 32 Maximum length of the name of a trend or ta‐
ble 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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2139
Runtime API
3.8 Tag and log functions

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

WinCC Engineering V18 – Programming reference

2140 System Manual, 11/2022, Online documentation
 Runtime API
3.8 Tag and log functions

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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2141
Runtime API
3.8 Tag and log functions

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 nor‐
mal 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

WinCC Engineering V18 – Programming reference

2142 System Manual, 11/2022, Online documentation
 Runtime API
3.8 Tag and log functions

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/ limi‐

ENUM_TLG_TAG_ definition tations
FIELDINDEX
ENUM_TLG_TAG_E 0 VT_TLG_TAG_ENU VT_I4 Set internally (val‐
NUMTYPE MTYPE ue >= 8), cannot
be changed
ENUM_TLG_TAG_V 1 VT_TLG_TAG_VER‐ VT_I4 Set internally (val‐
ERSION SION ue >= 1), cannot
be changed
ENUM_TLG_TAG_C 2 VT_TLG_TAG_CRE‐ VT_I4
REATORID ATORID
ENUM_TLG_TAG_N 3 VT_TLG_TAG_NAM VT_BSTR Required for Create
AME E
ENUM_TLG_TAG_A 4 VT_TLG_TAG_AR‐ VT_BSTR Required for Create
RCHIVNAME CHIVNAME
ENUM_TLG_TAG_T 5 VT_TLG_TAG_TYPE VT_I4 Required for Create
YPE

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2143
Runtime API
3.8 Tag and log functions

Definition in Field index Associated type Type Comments/ limi‐

ENUM_TLG_TAG_ definition tations
FIELDINDEX
ENUM_TLG_TAG_ 6 VT_TLG_TAG_WRIT VT_BSTR
WRITEBACKNAME EBACKNAME
ENUM_TLG_TAG_C 7 VT_TLG_TAG_COM VT_BSTR
OMMENT MENT
ENUM_TLG_TAG_A 8 VT_TLG_TAG_ARC‐ VT_I4
RCTYPE TYPE
ENUM_TLG_TAG_S 9 VT_TLG_TAG_SUP‐ VT_I4
UPPLYTYPE PLYTYPE
ENUM_TLG_TAG_L 10 VT_TLG_TAG_LOC VT_I4
OCKED KED
ENUM_TLG_TAG_S 11 VT_TLG_TAG_SCA VT_BSTR Required for Create
CANTIME NTIME
NUM_TLG_TAG_AR 12 VT_TLG_TAG_ARC‐ VT_BSTR Required for Create
CTIME TIME
ENUM_TLG_TAG_A 13 VT_TLG_TAG_ARC‐ VT_I4 Required for Create
RCFACTOR FACTOR
ENUM_TLG_TAG_V 14 VT_TLG_TAG_VAR‐ VT_I4
ARCOUNTFOR‐ COUNTFORWARD
WARD
ENUM_TLG_TAG_V 15 VT_TLG_TAG_VAR‐ VT_I4
ARCOUNTBACK‐ COUNTBACKWARD
WARD
ENUM_TLG_TAG_S 16 VT_TLG_TAG_SA‐ VT_I4
AVEBYFAULT VEBYFAULT
ENUM_TLG_TAG_A 17 VT_TLG_TAG_ARC‐ VT_I4 Required for Create
RCTRIGGER TRIGGER
ENUM_TLG_TAG_S 18 VT_TLG_TAG_STAT VT_BSTR
TATETEXTHIGH ETEXTHIGH
ENUM_TLG_TAG_S 19 VT_TLG_TAG_STAT VT_BSTR
TATETEXTLOW ETEXTLOW
ENUM_TLG_TAG_V 20 VT_TLG_TAG_VAR‐ VT_I4
ARPRO PRO
ENUM_TLG_TAG_F 21 VT_TLG_TAG_FUN VT_BSTR
UNCVALPRO CVALPRO
ENUM_TLG_TAG_D 22 VT_TLG_TAG_DLLV VT_BSTR
LLVARPRO ARPRO
ENUM_TLG_TAG_F 23 VT_TLG_TAG_FUN VT_BSTR
UNCSTARTEVENT CSTARTEVENT
ENUM_TLG_TAG_D 24 VT_TLG_TAG_DLLS VT_BSTR
LLSTARTEVENT TARTEVENT
ENUM_TLG_TAG_F 25 VT_TLG_TAG_FUN VT_BSTR
UNCSTOPEVENT CSTOPEVENT
ENUM_TLG_TAG_D 26 VT_TLG_TAG_DLLS VT_BSTR
LLSTOPEVENT TOPEVENT
ENUM_TLG_TAG_F 27 VT_TLG_TAG_FUN VT_BSTR
UNCDYNAMIC CDYNAMIC

WinCC Engineering V18 – Programming reference

2144 System Manual, 11/2022, Online documentation
 Runtime API
3.8 Tag and log functions

Definition in Field index Associated type Type Comments/ limi‐

ENUM_TLG_TAG_ definition tations
FIELDINDEX
ENUM_TLG_TAG_D 28 VT_TLG_TAG_DLLD VT_BSTR
LLDYNAMIC YNAMIC
ENUM_TLG_TAG_U 29 VT_TLG_TAG_UNI‐ VT_BSTR
NITDIRECT TDIRECT
ENUM_TLG_TAG_N 30 VT_TLG_TAG_NAM VT_BSTR
AMEUNITSTRUCT EUNITSTRUCT
ENUM_TLG_TAG_U 31 VT_TLG_TAG_UNI‐ VT_I4
NITINDEX TINDEX
ENUM_TLG_TAG_V 32 VT_TLG_TAG_VAR‐ VT_R8
ARUPPER UPPER
ENUM_TLG_TAG_V 33 VT_TLG_TAG_VAR‐ VT_R8
ARLOWER LOWER
ENUM_TLG_TAG_A 34 VT_TLG_TAG_AR‐ VT_R8
RCUPPER CUPPER
ENUM_TLG_TAG_A 35 VT_TLG_TAG_AR‐ VT_R8
RCLOWER CLOWER
ENUM_TLG_TAG_N 36 VT_TLG_TAG_NAM VT_BSTR
AMESCALE ESCALE
ENUM_TLG_TAG_N 37 VT_TLG_TAG_NAM VT_BSTR
AMESOURCEARC ESOURCEARC
ENUM_TLG_TAG_N 38 VT_TLG_TAG_NAM VT_BSTR
AMESOURCEVAR ESOURCEVAR
ENUM_TLG_TAG_N 39 VT_TLG_TAG_NAM VT_BSTR
AMERAWVAR ERAWVAR
ENUM_TLG_TAG_C 40 VT_TLG_TAG_CON VT_BSTR
ONVDLL VDLL
ENUM_TLG_TAG_P 41 VT_TLG_TAG_PRO VT_BSTR Required for Create
ROCVARNAME CVARNAME
ENUM_TLG_TAG_T 42 VT_TLG_TAG_TIME VT_BSTR Set internally (new
IMEMODIFY MODIFY time stamp for Cre‐
ate and Modify),
cannot be changed
ENUM_TLG_TAG_A 43 VT_TLG_TAG_AR‐ VT_I4
RCONCHANGE CONCHANGE
ENUM_TLG_TAG_A 44 VT_TLG_TAG_AR‐ VT_R8
RCONHYSTERESE CONHYSTERESE
ENUM_TLG_TAG_F 45 VT_TLG_TAG_FLA VT_I4
LAGS GS
ENUM_TLG_TAG_A 46 VT_TLG_TAG_ALIA VT_BSTR
LIAS S
ENUM_TLG_TAG_V 47 VT_TLG_TAG_VAR‐ VT_BSTR
ARSTARTEVENT STARTEVENT
ENUM_TLG_TAG_V 48 VT_TLG_TAG_VAR‐ VT_BSTR
ARSTOPEVENT STOPEVENT

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2145
Runtime API
3.8 Tag and log functions

Definition in Field index Associated type Type Comments/ limi‐

ENUM_TLG_TAG_ definition tations
FIELDINDEX
ENUM_TLG_TAG_P 49 VT_TLG_TAG_PRE‐ VT_BSTR
RECISION CISION
ENUM_TLG_TAG_T 50 VT_TLG_TAG_TAG‐ VT_I4 Set internally, can‐
AGID ID 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_LONGTERM_DISA‐ 1
BLE
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.

WinCC Engineering V18 – Programming reference

2146 System Manual, 11/2022, Online documentation
 Runtime API
3.8 Tag and log functions

3.8.2 Structures

3.8.2.1 TLG_ARCHIV_STR

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[
PDE_DB_ARC_ACTIONNAME_MAX_LENGHT+1];
TCHAR szCompressTime[
PDE_DB_TIMENAME_MAX_LENGHT+1];
DWORD dwSourceProcess;
TCHAR szRawDatVar[
PDE_DB_VAR_NAME_MAX_LENGHT+1];
TCHAR szSendAct[
PDE_DB_ARC_ACTIONNAME_MAX_LENGHT+1];
TCHAR szRecAct[
PDE_DB_ARC_ACTIONNAME_MAX_LENGHT+1];
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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2147
Runtime API
3.8 Tag and log functions

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%
TLG_FILL_MESSAGE_60 Filling level message at 60%
TLG_FILL_MESSAGE_70 Filling level message at 70%
TLG_FILL_MESSAGE_80 Filling level message at 80%
TLG_FILL_MESSAGE_90 Filling level message at 90%
TLG_FILL_MESSAGE_100 Filling level message at 100%

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

WinCC Engineering V18 – Programming reference

2148 System Manual, 11/2022, Online documentation
 Runtime API
3.8 Tag and log functions

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
The parameter is reserved for future development and must be preset to 0.

szSendAct
The parameter is reserved for future development and must be preset to 0.

szRecAct
The parameter is reserved for future development and must be preset to 0.

dwRecItems
The parameter is reserved for future development and must be preset to 0.

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

TLGReadArchiv (Page 2234) Read log parameters

See also
TLGReadArchiv (Page 2234)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2149
Runtime API
3.8 Tag and log functions

3.8.2.2 TLG_ARCHIVDATARAW

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

WinCC Engineering V18 – Programming reference

2150 System Manual, 11/2022, Online documentation
 Runtime API
3.8 Tag and log functions

data manager status flags (HighWord)

DM_VARSTATE_NOT_ESTABLISHED 0x0001 Connection to partner not established
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 connection with MAX/MIN_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 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 viola‐
(0x0020) tion, high limit set, 0x56
DM_VARSTATE_MIN_RANGE Low format limit violated Uncertain, engineering unit range viola‐
(0x0040) tion, low limit set, 0x55
DM_VARSTATE_CONVERSION_ERROR Display conversion error Uncertain, engineering unit range viola‐
(0x0080) tion, 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 Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2151
Runtime API
3.8 Tag and log functions

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

TLGGetArchivDataEx (Page 2222) Read out data of a log

See also
TLGGetArchivDataEx (Page 2222)

WinCC Engineering V18 – Programming reference

2152 System Manual, 11/2022, Online documentation
 Runtime API
3.8 Tag and log functions

3.8.2.3 TLG_BACKUP_TABLE_INFO

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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2153
Runtime API
3.8 Tag and log functions

dwUserData
Application-specific data

Required files
pdertdef.h

API functions

TLG_ENUMBACKUP_ENTRIES (Page 2252) List backups (callback)

See also
TLG_ENUMBACKUP_ENTRIES (Page 2252)

WinCC Engineering V18 – Programming reference

2154 System Manual, 11/2022, Online documentation
 Runtime API
3.8 Tag and log functions

3.8.2.4 TLG_CURVESCALEX

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 doLimitUpper2;
double doLimitUpper3;
double doLimitLower1;
double doLimitLower2;
double doLimitLower3;
double doDisplayRangeFrom;
double doDisplayRangeTo;
double doLimitRangeFrom;
double doLimitRangeTo;
COLORREF crColor;
COLORREF crColorTimeOverlapped;
COLORREF crColorTimeJump;
COLORREF crColorLimitUpper1;
COLORREF crColorLimitUpper2;
COLORREF crColorLimitUpper3;
COLORREF crColorLimitLower1;
COLORREF crColorLimitLower2;
COLORREF crColorLimitLower3;
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;

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2155
Runtime API
3.8 Tag and log functions

Members
dwDataTyp
dwDataTyp determines which data type the trend is based on:

TLG_DATATYP_TIMERANGE 0x00000001 for time 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_USERARCHIV 0x00000002 irrelevant for trends:
The data originate from a data-controlled user log. The values specified
in doFrom and doTo are valid.
TLG_DATATYP_BLOCKDATA 0x00000004 Data is set by TLGSetTemplateData:
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
The parameter is reserved for future development and must be preset to 0.

dwAxisLocation
The parameter is reserved for future development and must be preset to 0.

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
The parameter is reserved for future development and must be preset to 0.

fGridLinesFine
The parameter is reserved for future development and must be preset to 0.

fGridLinesBigVisible
The parameter is reserved for future development and must be preset to 0.

fGridLinesFineVisible
The parameter is reserved for future development and must be preset to 0.

WinCC Engineering V18 – Programming reference

2156 System Manual, 11/2022, Online documentation
 Runtime API
3.8 Tag and log functions

fPercent
The parameter is reserved for future development and must be preset to 0.

fLimitRange
The parameter is reserved for future development and must be preset to 0.

fSubstitute
The parameter is reserved for future development and must be preset to 0.

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.
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.

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
The parameter is reserved for future development and must be preset to 0.

doGridFine
The parameter is reserved for future development and must be preset to 0.

doShowDigits
Number of decimal places

doLimitUpper1
The parameter is reserved for future development and must be preset to 0.

doLimitUpper2
The parameter is reserved for future development and must be preset to 0.

doLimitUpper3
The parameter is reserved for future development and must be preset to 0.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2157
Runtime API
3.8 Tag and log functions

doLimitLower1
The parameter is reserved for future development and must be preset to 0.

doLimitLower2
The parameter is reserved for future development and must be preset to 0.

doLimitLower3
The parameter is reserved for future development and must be preset to 0.

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
The parameter is reserved for future development and must be preset to 0.

doLimitRangeTo
The parameter is reserved for future development and must be preset to 0.

crColor
The Windows-specific 32-bit value crColor determines the color in which the trend is to be
displayed.

crColorTimeOverlapped
The parameter is reserved for future expansions.

crColorTimeJump
The parameter is reserved for future expansions.

crColorLimitUpper1
The parameter is reserved for future expansions.

crColorLimitUpper2
The parameter is reserved for future expansions.

crColorLimitUpper3
The parameter is reserved for future expansions.

crColorLimitLower1
The parameter is reserved for future expansions.

crColorLimitLower2
The parameter is reserved for future expansions.

WinCC Engineering V18 – Programming reference

2158 System Manual, 11/2022, Online documentation
 Runtime API
3.8 Tag and log functions

crColorLimitLower3
The parameter is reserved for future expansions.

szSelectSQL
The parameter is reserved for future development and must be preset to NULL.

szText;
Labeling of the x-axis

szFunction
The parameter is reserved for future development and must be preset to NULL.

szDLL
The parameter is reserved for future development and must be preset to NULL.

Comment
TLG_CURVESCALEX is used by the TLG_TPLITEM_CURVE (Page 2177) structure.

Required files
pdertdef.h

See also
TLG_TPLITEM_CURVE (Page 2177)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2159
Runtime API
3.8 Tag and log functions

3.8.2.5 TLG_CURVESCALEY

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 doLimitUpper1;
double doLimitUpper2;
double doLimitUpper3;
double doLimitLower1;
double doLimitLower2;
double doLimitLower3;
double doDisplayRangeFrom;
double doDisplayRangeTo;
double doLimitRangeFrom;
double doLimitRangeTo;
COLORREF crColor;
COLORREF crColorTimeOverlapped;
COLORREF crColorTimeJump;
COLORREF crColorLimitUpper1;
COLORREF crColorLimitUpper2;
COLORREF crColorLimitUpper3;
COLORREF crColorLimitLower1;
COLORREF crColorLimitLower2;
COLORREF crColorLimitLower3;
TCHAR szSelectSQL[ TLG_MAX_SQL_SELECT ];
TCHAR szText[ TLG_MAX_STD_TEXT_NAME ];
}
TLG_CURVESCALEY;

WinCC Engineering V18 – Programming reference

2160 System Manual, 11/2022, Online documentation
 Runtime API
3.8 Tag and log functions

Members

dwDataTyp
The data type (time/user/block data) has no significance here.

dwRangeTyp
The parameter is reserved for future development and must be preset to 0.

dwAxisLocation
The parameter is reserved for future development and must be preset to 0.

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
The parameter is reserved for future development and must be preset to 0.

fLimitRange
The parameter is reserved for future development and must be preset to 0.

fSubstitute
The parameter is reserved for future development and must be preset to 0.

stFrom
The parameter is reserved for future development.

stTo
The parameter is reserved for future development.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2161
Runtime API
3.8 Tag and log functions

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
The parameter is reserved for future development and must be preset to 0.

doLimitUpper2
The parameter is reserved for future development and must be preset to 0.

doLimitUpper3
The parameter is reserved for future development and must be preset to 0.

doLimitLower1
The parameter is reserved for future development and must be preset to 0.

doLimitLower2
The parameter is reserved for future development and must be preset to 0.

doLimitLower3
The parameter is reserved for future development and must be preset to 0.

doDisplayRangeFrom
Determines the value from which the display range begins.

doDisplayRangeTo
Determines the value up to which the display range extends.

doLimitRangeFrom
The parameter is reserved for future development and must be preset to 0.

doLimitRangeTo
The parameter is reserved for future development and must be preset to 0.

WinCC Engineering V18 – Programming reference

2162 System Manual, 11/2022, Online documentation
 Runtime API
3.8 Tag and log functions

crColor
The Windows-specific 32-bit value crColor determines the color in which the trend is to be
displayed.

crColorTimeOverlapped
The parameter is reserved for future development.

crColorTimeJump
The parameter is reserved for future development.

crColorLimitUpper1
The parameter is reserved for future development.

crColorLimitUpper2
The parameter is reserved for future development.

crColorLimitUpper3
The parameter is reserved for future development.

crColorLimitLower1
The parameter is reserved for future development.

crColorLimitLower2
The parameter is reserved for future development.

crColorLimitLower3
The parameter is reserved for future development.

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 TLG_TPLITEM_CURVE (Page 2177) structure.

Required files
pdertdef.h

See also
TLG_TPLITEM_CURVE (Page 2177)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2163
Runtime API
3.8 Tag and log functions

3.8.2.6 TLG_GETARCHIVDATA

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
The parameter is reserved for future development and must be preset to 0.

Required files
pdertdef.h

API functions

TLG_GETARCHIVDATA_CALLBACK (Page 2220) Read out data of a log (callback)

See also
TLG_GETARCHIVDATA_CALLBACK (Page 2220)

WinCC Engineering V18 – Programming reference

2164 System Manual, 11/2022, Online documentation
 Runtime API
3.8 Tag and log functions

3.8.2.7 TLG_IO_BACKUP_SELECT

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
The parameter is reserved for future development and must be preset to NULL.

Required files
pdertdef.h

API functions

TLGGetBackupSize (Page 2255) Determine size of an exported data record

TLGExport (Page 2253) Export log data

See also
TLGGetBackupSize (Page 2255)
TLGExport (Page 2253)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2165
Runtime API
3.8 Tag and log functions

3.8.2.8 TLG_PROT_CURVE_INFOS

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.

WinCC Engineering V18 – Programming reference

2166 System Manual, 11/2022, Online documentation
 Runtime API
3.8 Tag and log functions

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 2170)
and TLG_TPLITEM_INFO (Page 2178).

Required files
pdertdef.h

API functions

TLGDrawCurvesInDC (Page 2236) Show trends

See also
TLGDrawCurvesInDC (Page 2236)
TLG_TABLESCALE (Page 2170)
TLG_TPLITEM_INFO (Page 2178)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2167
Runtime API
3.8 Tag and log functions

3.8.2.9 TLG_SCAL_STR

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
The parameter is reserved for future development and must be preset to 0.

doScalArcUpper
The parameter is reserved for future development and must be preset to 0.

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 2180) structure and is
provided for later upgrades.

Required files
pde_def.h

See also
TLG_VAR_STR (Page 2180)

WinCC Engineering V18 – Programming reference

2168 System Manual, 11/2022, Online documentation
 Runtime API
3.8 Tag and log functions

3.8.2.10 TLG_TABLE_INFO

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

TLG_ENUMTABLES (Page 2215) List logs (callback)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2169
Runtime API
3.8 Tag and log functions

See also
TLG_ENUMTABLES (Page 2215)

3.8.2.11 TLG_TABLESCALE

Declaration

typedef struct {
BOOL fActualize;
BOOL fVisible;
BOOL fModify;
BOOL fCommon;
DWORD dwDataTyp;
SYSTEMTIME stFrom;
SYSTEMTIME stTo;
double doFrom;
double doTo;
double doShowDigits;
double doLimitUpper1;
double doLimitUpper2;
double doLimitUpper3;
double doLimitLower1;
double doLimitLower2;
double doLimitLower3;
OLORREF crColor;
COLORREF crColorTimeOverlapped;
COLORREF crColorTimeJump;
COLORREF crColorLimitUpper1;
COLORREF crColorLimitUpper2;
COLORREF crColorLimitUpper3;
COLORREF crColorLimitLower1;
COLORREF crColorLimitLower2;
COLORREF crColorLimitLower3;
TCHAR szSelectSQL[ TLG_MAX_SQL_SELECT ];
}
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.

WinCC Engineering V18 – Programming reference

2170 System Manual, 11/2022, Online documentation
 Runtime API
3.8 Tag and log functions

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
The parameter is reserved for future development and must be preset to 0.

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
function must be used and not GetSystemTime. There is generally a considerable time
difference between these two functions.

doFrom
The parameter is reserved for future development and must be preset to 0.

doTo
The parameter is reserved for future development and must be preset to 0.

doShowDigits
Number of decimal places to be output.

doLimitUpper1
The parameter is reserved for future development and must be preset to 0.

doLimitUpper2
The parameter is reserved for future development and must be preset to 0.

dpoLimitUper3
The parameter is reserved for future development and must be preset to 0.

doLimitLower1
The parameter is reserved for future development and must be preset to 0.

doLimitLower2
The parameter is reserved for future development and must be preset to 0.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2171
Runtime API
3.8 Tag and log functions

doLimitLower3
The parameter is reserved for future development and must be preset to 0.

crColor
The Windows-specific 32-bit value crColor defines the color used in the table column.

crColorTimeOverlapped
The parameter is reserved for future development.

crColorTimeJump
The parameter is reserved for future development.

crColorLimitUpper1
The parameter is reserved for future development.

crColorLimitUpper2
The parameter is reserved for future development.

crColorLimitUpper3
The parameter is reserved for future development.

crColorLimitLower1
The parameter is reserved for future development.

crColorLimitLower2
The parameter is reserved for future development.

crColorLimitLower3
The parameter is reserved for future development.

szSelectSQL
The parameter is reserved for later upgrades and must be defaulted with ZERO.

Comment
TLG_TABLESCALE is used by the TLG_TEMPLATEITEM_INFO (Page 2173) structure.

Required files
pdertdef.h

See also
TLG_PROT_CURVE_INFOS (Page 2166)
TLG_TPLITEM_INFO (Page 2178)

WinCC Engineering V18 – Programming reference

2172 System Manual, 11/2022, Online documentation
 Runtime API
3.8 Tag and log functions

TLG_TEMPLATEITEM_INFO (Page 2173)

TLG_TPLITEM_TABLE (Page 2179)

3.8.2.12 TLG_TEMPLATEITEM_INFO

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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2173
Runtime API
3.8 Tag and log functions

dwWriteAccessLevel
In the enumeration of trends or columns dwWriteAccesLevel contains the user authorization
level for write access.

dwArchivTyp
dwArchivTyp identifies the log type:

TLG_ARCTYP_USER User log

TLG_ARCTYP_PROCESS Process value log
TLG_ARCTYP_COMPRESS Compressed log

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 2178) type with the properties of a trend or
column template.

Required files
pdertdef.h

API functions

TLG_TABLESCALE (Page 2170) Table column (properties) (structure)

WinCC Engineering V18 – Programming reference

2174 System Manual, 11/2022, Online documentation
 Runtime API
3.8 Tag and log functions

See also
TLG_TPLITEM_INFO (Page 2178)
TLG_TABLESCALE (Page 2170)
TLGInsertTemplateItem (Page 2238)

3.8.2.13 TLG_TIME_STR

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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2175
Runtime API
3.8 Tag and log functions

API functions

TLGReadTime (Page 2249) Determine time object parameter

See also
TLGReadTime (Page 2249)

3.8.2.14 TLG_TIMEDATA

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

TLG_ENUMTIMES_CALLBACK (Page 2248) List time objects (callback)

WinCC Engineering V18 – Programming reference

2176 System Manual, 11/2022, Online documentation
 Runtime API
3.8 Tag and log functions

See also
TLG_ENUMTIMES_CALLBACK (Page 2248)

3.8.2.15 TLG_TPLITEM_CURVE

Declaration

typedef struct {
TLG_CURVESCALEX csx;
TLG_CURVESCALEY csy;
}
TLG_TPLITEM_CURVE;

Members

csx
The TLG_CURVESCALEX (Page 2155) structure contains the data for scaling the X-axis of a
trend.

csy
The TLG_CURVESCALEY (Page 2160) structure contains the data for scaling the Y-axis of a
trend.

Description
TLG_TPLITEM_CURVE is used by the TLG_TPLITEM_INFO (Page 2178) structure.

Required files
pdertdef.h

See also
TLG_TPLITEM_INFO (Page 2178)
TLG_CURVESCALEX (Page 2155)
TLG_CURVESCALEY (Page 2160)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2177
Runtime API
3.8 Tag and log functions

3.8.2.16 TLG_TPLITEM_INFO

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 2177) structure.

tplTable
The properties of a column are read from the TLG_TPLITEM_TABLE (Page 2179) structure.

Comment
TLG_TPLITEM_INFO is used by the TLG_TEMPLATEITEM_INFO (Page 2173) 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_PROT_CURVE_INFOS (Page 2166)
TLG_TABLESCALE (Page 2170)
TLG_TEMPLATEITEM_INFO (Page 2173)
TLG_TPLITEM_CURVE (Page 2177)
TLG_TPLITEM_TABLE (Page 2179)

WinCC Engineering V18 – Programming reference

2178 System Manual, 11/2022, Online documentation
 Runtime API
3.8 Tag and log functions

3.8.2.17 TLG_TPLITEM_TABLE

Declaration

typedef struct {
TLG_TABLESCALE ts;
}
TLG_TPLITEM_TABLE;

Members

ts
TLG_TABLESCALE (Page 2170) with the properties of a table column.

Description
TLG_TPLITEM_TABLE is used by the TLG_TPLITEM_INFO (Page 2178) structure.
For organizational reasons, TLG_TABLESCALE cannot be used directly in the
TLG_TPLITEM_INFO structure.

Required files
pdertdef.h

See also
TLG_TPLITEM_INFO (Page 2178)
TLG_TABLESCALE (Page 2170)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2179
Runtime API
3.8 Tag and log functions

3.8.2.18 TLG_VAR_STR

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).

WinCC Engineering V18 – Programming reference

2180 System Manual, 11/2022, Online documentation
 Runtime API
3.8 Tag and log functions

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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2181
Runtime API
3.8 Tag and log functions

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.
The parameter is relevant for the cyclic-selective, cyclic-continuous logging of analog and
binary tags.

dwValueFlow
Identifies the number of flow values
The parameter is relevant for the cyclic-selective, cyclic-continuous logging of analog and
binary tags.

dwValueFollow
Identifies the number of return values.
The parameter is relevant for the cyclic-selective, cyclic-continuous logging of analog and
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
invalid value Error message TLG_API_INVALID_PARAM

If dwVarType = TLG_VAR_TYP_COMPRESS, TLG_SAVE_LAST_VALUE is always set internally.

WinCC Engineering V18 – Programming reference

2182 System Manual, 11/2022, Online documentation
 Runtime API
3.8 Tag and log functions

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.
invalid value Error message TLG_API_INVALID_PARAM

If dwVarType = TLG_VAR_TYP_ANALOG, 0L is always set internally (irrelevant).

szTextHighSignal
Text for signal state 1.
The parameter is relevant for the cyclic-selective, cyclic-continuous logging of binary tags.

szTextLowSignal
Text for the signal state 0.
The parameter is relevant for the cyclic-selective, cyclic-continuous logging of binary tags.

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
invalid value Error message TLG_API_INVALID_PARAM

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.
The parameter is relevant for the cyclic-selective, cyclic-continuous logging of analog and
binary tags and only relevant ifdwValProcess = TLG_VAL_DLL.

szDLLValProcess
Name of the DLL
The parameter is relevant for the cyclic-selective, cyclic-continuous logging of analog and
binary tags and only relevant if dwValProcess = TLG_VAL_DLL.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2183
Runtime API
3.8 Tag and log functions

szFuncStartEvent
Name of the action or the DLL function which specifies the start event.
The parameter is relevant for the cyclic-selective, cyclic-continuous logging of analog and
binary tags.

szDLLStartEvent
Name of the DLL.
The parameter is relevant for the cyclic-selective, cyclic-continuous logging of analog and
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.
The parameter is relevant for the cyclic-selective, cyclic-continuous logging of analog and
binary tags.

szDLLDynamic
Name of the DLL
The parameter is relevant for the cyclic-selective, cyclic-continuous logging of analog and
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
The parameter is reserved for future development and must be preset to 0.

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.

WinCC Engineering V18 – Programming reference

2184 System Manual, 11/2022, Online documentation
 Runtime API
3.8 Tag and log functions

szRawdataName
Name of the raw data tag
The parameter is relevant for process-controlled tags.

szRawConvDLLName
Name of the normalization DLL
The parameter is relevant for process-controlled tags.

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
The parameter is relevant for process-controlled tags.

ScaleStruct
TLG_SCAL_STR (Page 2168) Structure with the limits of the tag.

RecordStruct
The parameter is reserved for future development.

Required files
pde_def.h

API functions

TLGReadVariable (Page 2205) Determine tag parameter

See also
TLGReadVariable (Page 2205)
TLG_SCAL_STR (Page 2168)

3.8.2.19 TLG_VARIABLE_INFO

Declaration

typedef struct {
DWORD dwVariableTyp;
TCHAR szVariableName[ _MAX_PATH + 1 ];
}
TLG_VARIABLE_INFO;

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2185
Runtime API
3.8 Tag and log functions

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

TLG_ENUMVARIABLES (Page 2204) List tags (callback)

See also
TLG_ENUMVARIABLES (Page 2204)

3.8.3 General functions

3.8.3.1 TLGCSConnect

Description
The function establishes a connection with the WinCC project database.

Declaration

BOOL TLGCSConnect (
HWND hwndParent,
LPCMN_ERROR lpError );

WinCC Engineering V18 – Programming reference

2186 System Manual, 11/2022, Online documentation
 Runtime API
3.8 Tag and log functions

Parameters

hwndParent
Window handle of the parent window

lpError
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
Connection established

FALSE
Error

Required files
pdecscli.h
pdecscli.lib
pdecscli.dll

Related functions

TLGCSConnectEx (Page 2188) Set up connection to project database

TLGCSDisConnect (Page 2189) Set up connection to project database

Examples
Enum all acquisition and logging times (Page 2260) "TL01.cpp"
Read parameters of time object (Page 2274) "TL01.cpp"
Enum logs (Page 2263) "TL01.cpp"
Read log (Page 2270) "TL01.cpp"

See also
TLGCSConnectEx (Page 2188)
Enum logs (Page 2263)
TLGOpenProject (Page 2195)
Read parameters of time object (Page 2274)
Enum all acquisition and logging times (Page 2260)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2187
Runtime API
3.8 Tag and log functions

Read log (Page 2270)

TLGCSDisConnect (Page 2189)

3.8.3.2 TLGCSConnectEx

Description
The function establishes a connection with the WinCC project database.

Declaration

BOOL TLGCSConnectEx (
HWND hwndParent,
DWORD dwMode,
LPCMN_ERROR lpError );

Parameters

hwndParent
The parameter is reserved for later upgrades and must be defaulted with ZERO.

dwMode
The parameter is reserved for future development.

lpError
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
Connection established

FALSE
Error

Required files
pdecscli.h
pdecscli.lib
pdecscli.dll

WinCC Engineering V18 – Programming reference

2188 System Manual, 11/2022, Online documentation
 Runtime API
3.8 Tag and log functions

Related functions

TLGCSConnect (Page 2186) Set up connection to project database

See also
TLGCSConnect (Page 2186)
TLGOpenProject (Page 2195)

3.8.3.3 TLGCSDisConnect

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 (
LPCMN_ERROR lpError );

Parameters

lpError
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
Connection terminated.

FALSE
Error

Required files
pdecscli.h

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2189
Runtime API
3.8 Tag and log functions

pdecscli.lib
pdecscli.dll

Related functions

TLGCSConnect (Page 2186) Set up connection to project database

Examples
Enum all acquisition and logging times (Page 2260) "TL01.cpp"
Read parameters of time object (Page 2274) "TL01.cpp"
Enum logs (Page 2263) "TL01.cpp"
Read log (Page 2270) "TL01.cpp"

See also
TLGCSConnect (Page 2186)
Enum all acquisition and logging times (Page 2260)
Enum logs (Page 2263)
Read log (Page 2270)
Read parameters of time object (Page 2274)

3.8.3.4 TLGChangeLanguage

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

WinCC Engineering V18 – Programming reference

2190 System Manual, 11/2022, Online documentation
 Runtime API
3.8 Tag and log functions

lpError
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
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

Description
The function initializes the log system and establishes a connection with the Tag Logging
Runtime.

Declaration

BOOL TLGConnect (
HWND hwndParent,
PCMN_ERROR lpError );

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2191
Runtime API
3.8 Tag and log functions

Parameters

hwndParent
The parameter is reserved for future development and must be preset to NULL.

lpError
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
Connection established

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

TLG_API_NO_CONNECTION No connection established with an activated project

TLG_API_NO_INTERFACE Access to lower level COM interfaces failed

Required files
pdertcli.h
pde_glob.h
pdertcli.lib
pdertcli.dll

Related functions

TLGDisconnect (Page 2193) Terminate connection

Examples
Enumerate logs (Page 2268) "TL02.cpp"

WinCC Engineering V18 – Programming reference

2192 System Manual, 11/2022, Online documentation
 Runtime API
3.8 Tag and log functions

See also
Enumerate logs (Page 2268)
TLGDisconnect (Page 2193)
Edit curve template - Example 1 (Page 2257)

3.8.3.6 TLGDisconnect

Description
An existing connection to the Tag Logging Runtime is disconnected with this function.

Declaration

BOOL TLGDisconnect (
PCMN_ERROR lpError );

Parameters

lpError
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
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

TLG_API_NO_CONNECTION No connection established with an activated project

TLG_API_NO_INTERFACE Access to lower level COM interfaces failed

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2193
Runtime API
3.8 Tag and log functions

Required files
pdertcli.h
pde_glob.h
pdertcli.lib
pdertcli.dll

Related functions

TLGConnect (Page 2191) Establish connection

Examples
Enumerate logs (Page 2268) "TL02.cpp"

See also
Enumerate logs (Page 2268)
TLGConnect (Page 2191)
Edit curve template - Example 1 (Page 2257)
Enum all acquisition and logging times (Page 2260)

3.8.4 Project management functions

3.8.4.1 TLGCloseProject

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 );

WinCC Engineering V18 – Programming reference

2194 System Manual, 11/2022, Online documentation
 Runtime API
3.8 Tag and log functions

Parameters

hProject
Handle of a project opened with TLGOpenProject.

lpoes
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 closed

FALSE
Error

Required files
pdecscli.h
pdecscli.lib
pdecscli.dll

Examples
Read parameters of time object (Page 2274) "TL01.cpp"
Enum logs (Page 2263) "TL01.cpp"
Read log (Page 2270) "TL01.cpp"

See also
Read parameters of time object (Page 2274)
Enum logs (Page 2263)
Read log (Page 2270)

3.8.4.2 TLGOpenProject

Description
Establishes a connection with the WinCC project database.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2195
Runtime API
3.8 Tag and log functions

Declaration

BOOL TLGOpenProject (
HANDLE* lphProject,
LPTSTR lpszProjectName,
HWND hwndParent,
LPCMN_ERROR lpoes );

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
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 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.

WinCC Engineering V18 – Programming reference

2196 System Manual, 11/2022, Online documentation
 Runtime API
3.8 Tag and log functions

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
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

TLGCSConnect (Page 2186) Set up connection to project database

TLGCSConnectEx (Page 2188) Set up connection to project database
TLGEnumProject (Page 2198) List projects

Examples
Read parameters of time object (Page 2274) "TL01.cpp"
Enum logs (Page 2263) "TL01.cpp"
Read log (Page 2270) "TL01.cpp"
Enum tags of a log (Page 2266) "TL02.cpp"

See also
TLGEnumProject (Page 2198)
TLGCSConnect (Page 2186)
TLGCSConnectEx (Page 2188)
Read parameters of time object (Page 2274)
Enum logs (Page 2263)
Read log (Page 2270)
Enum tags of a log (Page 2266)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2197
Runtime API
3.8 Tag and log functions

3.8.4.3 TLGEnumProject

Description
The function determines the names of the open projects.

Declaration

BOOL TLGEnumProject (
TLG_ENUM_PROJECT_NAME_CALLBACK lpCallbackFunc,
PVOID lpUser,
LPCMN_ERROR lpoes );

Parameters

lpCallbackFunc
Pointer to your callback function which is called for every open project.

lpUser
Pointer to application-specific data. This pointer is not evaluated by the function but provided
again in the callback function.

lpoes
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
Projects listed

FALSE
Error

Required files
pdecscli.h
pdecscli.lib
pdecscli.dll

WinCC Engineering V18 – Programming reference

2198 System Manual, 11/2022, Online documentation
 Runtime API
3.8 Tag and log functions

Related functions

TLG_ENUM_PROJECT_NAME_CALLBACK List projects (callback)

(Page 2199)

See also
TLG_ENUM_PROJECT_NAME_CALLBACK (Page 2199)
TLGOpenProject (Page 2195)

3.8.4.4 TLG_ENUM_PROJECT_NAME_CALLBACK

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
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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2199
Runtime API
3.8 Tag and log functions

Required files
pdecscli.h

Related functions

TLGEnumProject (Page 2198) List projects

See also
TLGEnumProject (Page 2198)

3.8.5 Functions for processing tags

3.8.5.1 TLGEnumVariables

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,
LPCMN_ERROR lpoes );

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
Pointer to application-specific data. This pointer is not evaluated by the function but provided
again in the callback function.

WinCC Engineering V18 – Programming reference

2200 System Manual, 11/2022, Online documentation
 Runtime API
3.8 Tag and log functions

lpoes
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
Log tags listed

FALSE
Error

Required files
pdecscli.h
pdecscli.lib
pdecscli.dll

Related functions

TLG_ENUM_VARIABLE_NAME_CALLBACK List tags (callback)

(Page 2201)

See also
TLG_ENUM_VARIABLE_NAME_CALLBACK (Page 2201)
TLGReadVariable (Page 2205)

3.8.5.2 TLG_ENUM_VARIABLE_NAME_CALLBACK

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 );

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2201
Runtime API
3.8 Tag and log functions

Parameters

lpszName
The lpszName pointer refers to the name of the first tag.

lpUser
Pointer to application-specific data. This pointer is made available again in the callback
function.

Return value

TRUE
The enumeration is continued.

FALSE
The enumeration is cancelled.

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

Required files
pdecscli.h

Related functions

TLGEnumVariables (Page 2200) List tags

See also
TLGEnumVariables (Page 2200)

3.8.5.3 TLGEnumVariablesEx

Description
The function determines all the tag names of a log.

WinCC Engineering V18 – Programming reference

2202 System Manual, 11/2022, Online documentation
 Runtime API
3.8 Tag and log functions

Declaration

BOOL TLGEnumVariablesEx (
LPCTSTR lpszArchiveName,
TLG_ENUMVARIABLES lpfnCallback,
LPVOID lpUser,
PCMN_ERROR lpError );

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
Pointer to application-specific data. This pointer is not evaluated by the function but provided
again in the callback function.

lpError
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
Tags listed

FALSE
Error

Error messages

TLG_API_ERR_SUPPLY An error has occurred

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

Required files
pdecscli.h
pdecscli.lib
pdecscli.dll

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2203
Runtime API
3.8 Tag and log functions

pdertcli.h
pdertcli.lib
pdertcli.dll

Related functions

TLG_ENUMVARIABLES (Page 2204) List tags (callback)

Examples
Enum tags of a log (Page 2266) "TL02.cpp"

See also
TLG_ENUMVARIABLES (Page 2204)
Enum tags of a log (Page 2266)

3.8.5.4 TLG_ENUMVARIABLES

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 2185) type with the data of a tag.

lpUser
Pointer to application-specific data. This pointer is made available again in the callback
function.

WinCC Engineering V18 – Programming reference

2204 System Manual, 11/2022, Online documentation
 Runtime API
3.8 Tag and log functions

Return value

TRUE
The enumeration is continued.

FALSE
The enumeration is cancelled.

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

Required files
pdertcli.h
pde_glob.h
pdertdef.h

Related functions

TLGEnumVariablesEx (Page 2202) List tags

Examples
Enum tags of a log (Page 2266) "TL02.cpp"

See also
TLGEnumVariablesEx (Page 2202)
TLG_VARIABLE_INFO (Page 2185)
Enum tags of a log (Page 2266)
TLGEnumArchivsEx (Page 2212)

3.8.5.5 TLGReadVariable

Description
Read the parameters of a tag

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2205
Runtime API
3.8 Tag and log functions

Declaration

BOOL TLGReadVariable (
HANDLE hProject,
LPTSTR lpszArchivName,
LPTSTR lpszVariableName,
PTLG_VAR_STR lpVariable,
LPCMN_ERROR lpoes );

Parameters

hProject
Handle of the project in which the tag to be processed is located.

lpszArchivName
Pointer to the name of the log

lpszVariableName
Pointer to the name of a tag of the log

lpVariable
Address of the TLG_VAR_STR (Page 2180) structure from which the data of the tag are read
out.

lpoes
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
Parameters read

FALSE
Error

Required files
pdecscli.h
pdecscli.lib
pdecscli.dll

WinCC Engineering V18 – Programming reference

2206 System Manual, 11/2022, Online documentation
 Runtime API
3.8 Tag and log functions

Related functions

TLGEnumVariables (Page 2200) List tags

TLGReadVariable6 Determine tag parameter

Examples
Read log (Page 2270) "TL01.cpp"

See also
TLG_VAR_STR (Page 2180)
TLGEnumVariables (Page 2200)
Read log (Page 2270)

3.8.6 Functions for processing logs

3.8.6.1 TLGEnumArchives

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,
LPCMN_ERROR lpoes );

Parameters

hProject
Handle of the project in which the logs are located.

lpCallbackFunc
Pointer to your callback function which is called for every log.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2207
Runtime API
3.8 Tag and log functions

lpUser
Pointer to application-specific data. This pointer is not evaluated by the function but provided
again in the callback function.

lpoes
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
Logs listed

FALSE
Error

Required files
pdecscli.h
pdecscli.lib
pdecscli.dll

Related functions

TLGReadArchiv (Page 2234) Read log parameters

TLG_ENUM_ARCHIV_CALLBACK (Page 2208) List logs (callback)

Examples
Enum logs (Page 2263) "TL01.cpp"

See also
TLG_ENUM_ARCHIV_CALLBACK (Page 2208)
Enum logs (Page 2263)
TLGReadArchiv (Page 2234)

3.8.6.2 TLG_ENUM_ARCHIV_CALLBACK

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.

WinCC Engineering V18 – Programming reference

2208 System Manual, 11/2022, Online documentation
 Runtime API
3.8 Tag and log functions

Declaration

BOOL ( * TLG_ENUM_ARCHIV_CALLBACK) (
LPTSTR lpszName,
PVOID lpUser );

Parameters

lpszName
The lpszName pointer refers to the name of the log.

lpUser
Pointer to application-specific data. This pointer is made available again in the callback
function.

Return value

TRUE
The enumeration is continued.

FALSE
The enumeration is cancelled.

Comment

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

Required files
pdecscli.h

Related functions

TLGEnumArchives (Page 2207) List logs

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2209
Runtime API
3.8 Tag and log functions

Examples
Enum logs (Page 2263) "TL01.cpp"

See also
TLGEnumArchives (Page 2207)
Enum logs (Page 2263)

3.8.6.3 TLGEnumArchivs

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,
PCMN_ERROR lpError );

Parameters

dwArchivTyp
dwArchivTyp identifies the log type:

TLG_ARCTYP_USER User log

TLG_ARCTYP_PROCESS Process value log
TLG_ARCTYP_COMPRESS Compressed log
NULL All logs are enumerated.

lpfnCallback
Pointer to your callback function which is called for every log.

lpUser
Pointer to application-specific data. This pointer is not evaluated by the function but provided
again in the callback function.

WinCC Engineering V18 – Programming reference

2210 System Manual, 11/2022, Online documentation
 Runtime API
3.8 Tag and log functions

lpError
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
Logs listed

FALSE
Error

Error messages

TLG_API_ERR_SUPPLY An error has occurred

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
pdertdef.h
pdertcli.lib
pdertcli.dll

Related functions

TLGEnumArchivsEx (Page 2212) List logs

TLGEnumArchivsSel (Page 2213) List logs
TLG_ENUMTABLES (Page 2215) List logs (callback)

Examples
Enumerate logs (Page 2268) "TL02.cpp"

See also
TLGEnumArchivsEx (Page 2212)
TLGEnumArchivsSel (Page 2213)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2211
Runtime API
3.8 Tag and log functions

TLG_ENUMTABLES (Page 2215)

Enumerate logs (Page 2268)

3.8.6.4 TLGEnumArchivsEx

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).
The information of a log is provided in structures of the TLG_TABLE_INFO type with the
callback function. Unlike TLGEnumArchivs not the table name of the log but the "pure" log
name is transferred.

Declaration

BOOL TLGEnumArchivsEx (
DWORD dwArchivTyp,
TLG_ENUMTABLES lpfnCallback,
LPVOID lpUser,
PCMN_ERROR lpError );

Parameters

dwArchivTyp
dwArchivTyp identifies the log type:

TLG_ARCTYP_U_USER User log

TLG_ARCTYP_PROCESS Process value log
TLG_ARCTYP_COMPRESS Compressed log
NULL All logs are enumerated.

lpfnCallback
Pointer to your callback function which is called for every log.

lpUser
Pointer to application-specific data. This pointer is not evaluated by the function but provided
again in the callback function.

lpError
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.

WinCC Engineering V18 – Programming reference

2212 System Manual, 11/2022, Online documentation
 Runtime API
3.8 Tag and log functions

Return value

TRUE
Logs are listed

FALSE
Error

Error messages

TLG_API_ERR_SUPPLY An error has occurred

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

Required files
pdertcli.h
pde_glob.h
pdertdef.h
pdertcli.lib
pdertcli.dll

Related functions

TLG_ENUMTABLES (Page 2215) List logs (callback)

TLGEnumArchivs (Page 2210) List logs
TLGEnumArchivsSel (Page 2213) List logs

See also
TLGEnumArchivsSel (Page 2213)
TLGEnumArchivs (Page 2210)
TLG_ENUMTABLES (Page 2215)

3.8.6.5 TLGEnumArchivsSel

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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2213
Runtime API
3.8 Tag and log functions

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". All tags of the log are
enumerated. This form is required for example in TLGBackup.

Declaration

BOOL TLGEnumArchivsSel (
DWORD dwArchivTyp,
DWORD dwSaveTyp,
TLG_ENUMTABLES lpfnCallback,
LPVOID lpUser,
PCMN_ERROR lpError );

Parameters

dwArchivTyp
dwArchivTyp identifies the log type:

TLG_ARCTYP_USER User log

TLG_ARCTYP_PROCESS Process value log
TLG_ARCTYP_COMPRESS Compressed log
NULL All logs are enumerated.

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
Pointer to your callback function which is called for every log.

lpUser
Pointer to application-specific data. This pointer is not evaluated by the function but provided
again in the callback function.

lpError
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.

WinCC Engineering V18 – Programming reference

2214 System Manual, 11/2022, Online documentation
 Runtime API
3.8 Tag and log functions

Return value

TRUE
The logs are listed.

FALSE
Error

Error messages

TLG_API_ERR_SUPPLY An error has occurred

TLG_API_INVALID_PARAM invalid or 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

Required files
pdertcli.h
pde_glob.h
pdertdef.h
pdertcli.lib
pdertcli.dll

Related functions

TLG_ENUMTABLES (Page 2215) List logs (callback)

TLGEnumArchivs (Page 2210) List logs

See also
TLGEnumArchivsEx (Page 2212)
TLGEnumArchivs (Page 2210)
TLG_ENUMTABLES (Page 2215)
TLG_TABLE_INFO (Page 2169)

3.8.6.6 TLG_ENUMTABLES

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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2215
Runtime API
3.8 Tag and log functions

Declaration

BOOL TLG_ENUMTABLES (
LPTSTR lpTableName,
PTLG_TABLE_INFO lpti,
PVOID lpUser );

Parameters

lpTableName
Pointer to the name of the log

lpti
Information about the database table is contained in the TLG_TABLE_INFO (Page 2169)
structure.

lpUser
Pointer to application-specific data. This pointer is made available again in the callback
function.

Return value

TRUE
The enumeration is continued.

FALSE
The enumeration is cancelled.

Comment

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

Required files
pdertcli.h
pde_glob.h
pdertdef.h

WinCC Engineering V18 – Programming reference

2216 System Manual, 11/2022, Online documentation
 Runtime API
3.8 Tag and log functions

pdertcli.lib
pdertcli.dll

Related functions

TLGEnumArchivs (Page 2210) List logs

TLGEnumArchivsSel (Page 2213) List logs

Examples
Enumerate archives "TL02.cpp"

See also
TLGEnumArchivs (Page 2210)
TLGEnumArchivsSel (Page 2213)
TLG_TABLE_INFO (Page 2169)
TLGEnumArchivsEx (Page 2212)

3.8.6.7 TLGFreeMemory

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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2217
Runtime API
3.8 Tag and log functions

Return value

TRUE
Memory is freed

FALSE
Error

Note
The pointer must be initialized before calling TLGGetArchivDataEx() with NULL and checked
before calling TLGFreeMemory() for not equal to NULL.

Required files
pdertcli.h
pdertcli.lib
pdertcli.dll

Related functions

TLGGetArchivDataEx (Page 2222) Read out data of a log

See also
TLGGetArchivDataEx (Page 2222)

3.8.6.8 TLGGetArchivData

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.

WinCC Engineering V18 – Programming reference

2218 System Manual, 11/2022, Online documentation
 Runtime API
3.8 Tag and log functions

Declaration

BOOL TLGGetArchivData (
LPTSTR lpszArchivName,
LPTSTR lpszVarName,
SYSTEMTIME stStart,
SYSTEMTIME stStop,
TLG_GETARCHIVDATA_CALLBACK lpfnCallback,
PVOID lpUser,
DWORD dwFlags,
PCMN_ERROR lpError );

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
Pointer to application-specific data. This pointer is not evaluated by the function but provided
again in the callback function.

dwFlags
The parameter is reserved for future development and must be preset to 0.

lpError
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
Log data determined

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2219
Runtime API
3.8 Tag and log functions

FALSE
Error

Error messages

TLG_API_ERR_SUPPLY An error has occurred

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_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

TLG_GETARCHIVDATA_CALLBACK Read out data of a log (callback)

(Page 2220)
TLGGetArchivDataEx (Page 2222) Read out data of a log

See also
TLG_GETARCHIVDATA_CALLBACK (Page 2220)
TLGGetArchivDataEx (Page 2222)

3.8.6.9 TLG_GETARCHIVDATA_CALLBACK

Description
In order to evaluate the log data listed by the system, you must provide a callback function of the
TLG_GETARCHIVDATA_CALLBACK type.

WinCC Engineering V18 – Programming reference

2220 System Manual, 11/2022, Online documentation
 Runtime API
3.8 Tag and log functions

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
Pointer to application-specific data. This pointer is made available again in the callback
function.

Return value

TRUE
The enumeration is continued.

FALSE
The enumeration is cancelled.

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
• Enumerations that call other enumerations

Required files
pdertcli.h
pde_glob.h
pdertdef.h

Related functions

TLGGetArchivData (Page 2218) Read out data of a log

TLG_GETARCHIVDATA (Page 2164) Log data of process value logs (structure) Log data of compressed
logs (structure)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2221
Runtime API
3.8 Tag and log functions

See also
TLGGetArchivData (Page 2218)
TLG_GETARCHIVDATA (Page 2164)

3.8.6.10 TLGGetArchivDataEx

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,
PCMN_ERROR lpError );

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.

WinCC Engineering V18 – Programming reference

2222 System Manual, 11/2022, Online documentation
 Runtime API
3.8 Tag and log 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 2150) type.

Note
The assigned memory must be freed again by TLGFreeMemory.
The pointer must be initialized before calling TLGGetArchivDataEx() with NULL and checked
before calling TLGFreeMemory() for not equal to NULL.

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
The parameter is reserved for future development and must be preset to 0.

lpError
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
Log data determined

FALSE
Error

Note
The memory assigned by TLGGetArchivDataEx in ppTlgData must be freed again by
TLGFreeMemory.
The pointer must be initialized before calling TLGGetArchivDataEx() with NULL and checked
before calling TLGFreeMemory() for not equal to NULL.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2223
Runtime API
3.8 Tag and log functions

Error messages

TLG_API_ERR_SUPPLY An error has occurred

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_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

TLGGetArchivData (Page 2218) Read out data of a log

TLGFreeMemory (Page 2217) Free memory

See also
TLGFreeMemory (Page 2217)
TLGGetArchivData (Page 2218)
TLG_ARCHIVDATARAW (Page 2150)

3.8.6.11 TLGGetClosestTime

Description
The function determines the adjacent logging times at a given time.

WinCC Engineering V18 – Programming reference

2224 System Manual, 11/2022, Online documentation
 Runtime API
3.8 Tag and log functions

Declaration

BOOL TLGGetClosestTime (
LPCTSTR lpszArchivName,
LPCTSTR lpszVarName,
SYSTEMTIME* pstTime,
BOOL bPrevious,
PCMN_ERROR lpError );

Parameters

lpszArchivName
Pointer to the name of the log

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
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
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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2225
Runtime API
3.8 Tag and log functions

Error messages

TLG_API_INVALID_PARAM invalid/wrong parameter supply

TLG_API_ERR_SUPPLY An error has occurred
TLG_API_NO_INTERFACE Access to lower level COM interfaces failed
TLG_API_NO_CONNECTION No connection established with an activated
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 2226) Determine logging time

See also
TLGGetClosestTimeEx (Page 2226)

3.8.6.12 TLGGetClosestTimeEx

Description
The function determines the adjacent logging times at a given time.

Declaration

BOOL TLGGetClosestTimeEx (
LPCTSTR lpszArchivName,
LPCTSTR lpszVarName,
SYSTEMTIME* pstTime,
BOOL bPrevious,
BOOL bIgnoreInvalid,
PCMN_ERROR lpError );

WinCC Engineering V18 – Programming reference

2226 System Manual, 11/2022, Online documentation
 Runtime API
3.8 Tag and log functions

Parameters

lpszArchivName
Pointer to the name of the log

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 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
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
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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2227
Runtime API
3.8 Tag and log functions

Error messages

TLG_API_INVALID_PARAM invalid/wrong parameter supply

TLG_API_ERR_SUPPLY An error has occurred
TLG_API_NO_INTERFACE Access to lower level COM interfaces failed
TLG_API_NO_CONNECTION No connection established with an activated 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

TLGGetClosestTime (Page 2224) Determine logging time

See also
TLGGetClosestTime (Page 2224)

3.8.6.13 TLGInsertArchivData

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.

WinCC Engineering V18 – Programming reference

2228 System Manual, 11/2022, Online documentation
 Runtime API
3.8 Tag and log functions

Declaration

BOOL TLGInsertArchivData (
LPCTSTR lpszArchivName,
LPCTSTR lpszVarName,
PTLG_ARCHIVDATARAW pTlgData,
DWORD dwNumberOfData,
DWORD dwFlags,
PCMN_ERROR lpError );

Parameters

lpszArchivName
Pointer to the name of the log

lpszVarName
Pointer to the name of the tag

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 chrono‐
logically, the older values are rejected without error messages.
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 together
with the "TLG_API_FLG_FAST_INSERT" flag.
TLG_API_FLG_DETAILED_ERRORCODES If this flag is set, detailed error codes are output.

lpError
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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2229
Runtime API
3.8 Tag and log functions

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 (with‐

flag) out 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

WinCC Engineering V18 – Programming reference

2230 System Manual, 11/2022, Online documentation
 Runtime API
3.8 Tag and log functions

Error messages

TLG_API_INVALID_PARAM invalid/wrong parameter supply

TLG_API_ERR_SUPPLY An error has occurred
TLG_API_NO_INTERFACE Access to lower level COM interfaces failed
TLG_API_NO_CONNECTION No connection established with an activated project
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

3.8.6.14 TLGLockArchiv

Description
Locks or frees a complete log. New data are not logged if a log is locked.

Declaration

BOOL TLGLockArchiv (
HWND hwnd,
LPTSTR lpszArchivName,
BOOL fLocked,
PCMN_ERROR lpError );

Parameters

hwnd
Window handle of the PDE runtime window

lpszArchivName
Pointer to the name of the log

fLocked

TRUE: Lock log

FALSE: Free log

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2231
Runtime API
3.8 Tag and log functions

lpError
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
Log locked/freed

FALSE
Error

Error messages

TLG_API_INVALID_PARAM invalid/wrong parameter supply

TLG_API_ERR_SUPPLY An error has occurred
TLG_API_NO_INTERFACE Access to lower level COM interfaces failed
TLG_API_NO_CONNECTION No connection established with an activated project
TLG_API_NO_ARCHIV_EXIST No log available
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
pdertcli.lib
pdertcli.dll

3.8.6.15 TLGLockVariable

Description
Locks or frees a tag. A locked tag is no longer updated and no longer logged.

WinCC Engineering V18 – Programming reference

2232 System Manual, 11/2022, Online documentation
 Runtime API
3.8 Tag and log functions

Declaration

BOOL TLGLockVariable (
HWND hwnd,
LPTSTR lpszArchivName,
LPTSTR lpszVarName,
BOOL fLocked,
PCMN_ERROR lpError );

Parameters

hwnd
Window handle of the PDE runtime window

lpszArchivName
Pointer to the name of the log
To select a certain server the "ServerPrefix::" can be prefixed to the log name.

lpszVarName
Pointer to the name of the tag

fLocked

TRUE: Lock tag

FALSE: Free tag

lpError
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
Tag freed / locked

FALSE
Error

Error messages

TLG_API_INVALID_PARAM invalid/wrong parameter supply

TLG_API_ERR_SUPPLY An error has occurred
TLG_API_NO_INTERFACE Access to lower level COM interfaces failed
TLG_API_NO_CONNECTION No connection established with an activated project
TLG_API_NO_ARCHIV_EXIST No log available

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2233
Runtime API
3.8 Tag and log functions

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
pdertcli.lib
pdertcli.dll

3.8.6.16 TLGReadArchiv

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,
LPTSTR lpszArchivName,
PTLG_ARCHIV_STR lpArchiv,
LPCMN_ERROR lpoes );

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 2147) structure in which the paraneters of the log are
to be saved.

lpoes
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.

WinCC Engineering V18 – Programming reference

2234 System Manual, 11/2022, Online documentation
 Runtime API
3.8 Tag and log functions

Return value

TRUE
Log contents read

FALSE
Error

Required files
pdecscli.h
pdecscli.lib
pdecscli.dll

Related functions

TLGEnumArchives (Page 2207) List logs

TLGReadArchiv6 Read log parameters

Examples
Read log (Page 2270)"TL01.cpp"

See also
TLGEnumArchives (Page 2207)
Read log (Page 2270)
TLG_ARCHIV_STR (Page 2147)

3.8.7 Functions for trend and table views

3.8.7.1 TLGCloseWindow

Description
An application window is closed with the function.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2235
Runtime API
3.8 Tag and log functions

Declaration

BOOL TLGCloseWindow (
HWND hwnd,
PCMN_ERROR lpError );

Parameters

hwnd
Handle to the parent window of the application to be closed.

lpError
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
Application window closed

FALSE
Error

Error messages

TLG_API_ERR_SUPPLY An error has occurred

TLG_API_INVALID_PARAM invalid/wrong parameter supply

Required files
pdertcli.h
pde_glob.h
pdertcli.lib
pdertcli.dll

3.8.7.2 TLGDrawCurvesInDC

Description
Trends can be shown in an application window with this function.

WinCC Engineering V18 – Programming reference

2236 System Manual, 11/2022, Online documentation
 Runtime API
3.8 Tag and log functions

Declaration

BOOL TLGDrawCurvesInDC (
HDC hDC,
PRECT lprect,
PTLG_PROT_CURVE_INFOS lpci,
DWORD dwNumberOfCurves,
LPCMN_ERROR lpError );

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 2166) 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
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
Trends shown

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_NOT_SUPPORTED This function is not supported

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2237
Runtime API
3.8 Tag and log functions

Required files
pdertcli.h
pde_glob.h
pdertdef.h
pdertcli.lib
pdertcli.dll

See also
TLG_PROT_CURVE_INFOS (Page 2166)

3.8.7.3 TLGInsertTemplateItem

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,
LPCMN_ERROR lpError );

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 2173) type with the data of the
trend or table template to be added.

lpError
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.

WinCC Engineering V18 – Programming reference

2238 System Manual, 11/2022, Online documentation
 Runtime API
3.8 Tag and log functions

Return value

TRUE
Window template extended

FALSE
Error

Error messages

TLG_API_ERR_SUPPLY An error has occurred

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_NOT_SUPPORTED This function is not supported

Required files
pdertcli.h
pde_glob.h
pdertdef.h
pdertcli.lib
pdertcli.dll

Examples
Edit curve template - Example 1 (Page 2257) "TL02.cpp"

See also
TLG_TEMPLATEITEM_INFO (Page 2173)
Edit curve template - Example 1 (Page 2257)

3.8.7.4 TLGPressToolbarButton

Description
You can trigger functions linked with the toolbar buttons with this function.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2239
Runtime API
3.8 Tag and log functions

Declaration

BOOL TLGPressToolbarButton (
LPTSTR lpszTemplate,
DWORD dwButtonID,
PCMN_ERROR lpError );

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
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.

WinCC Engineering V18 – Programming reference

2240 System Manual, 11/2022, Online documentation
 Runtime API
3.8 Tag and log functions

Error messages

TLG_API_INVALID_PARAM invalid/wrong parameter supply

IDS_API_ERROR_WINDOW_NOT_FOUND Button ( window ) could not be found
TLG_API_NO_CONNECTION No connection established with an activated
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

Description
The data window of the read line is shown or hidden with this function.

Declaration

BOOL TLGSetRulerWindowVisible (
LPTSTR lpszTemplateName,
BOOL bShowRulerWindow,
LPCMN_ERROR lpError );

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
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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2241
Runtime API
3.8 Tag and log functions

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

TLG_API_ERR_SUPPLY An error has occurred

IDS_API_ERROR_WINDOW_NOT_FOUND Button ( window ) could not be found
TLG_API_INVALID_PARAM invalid/wrong parameter supply

Required files
pdertcli.h
pde_glob.h
pdertdef.h
pdertcli.lib
pdertcli.dll

3.8.7.6 TLGShowWindow

Description
The function influences the display form of the window.

Declaration

BOOL TLGShowWindow (
HWND hwnd,
DWORD dwFlags,
PCMN_ERROR lpError );

WinCC Engineering V18 – Programming reference

2242 System Manual, 11/2022, Online documentation
 Runtime API
3.8 Tag and log functions

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
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
Application window shown

FALSE
Error

Error messages

TLG_API_ERR_SUPPLY An error has occurred

TLG_API_INVALID_PARAM invalid/wrong parameter supply

Required files
pdertcli.h
pde_glob.h
pdertdef.h
pdertcli.lib
pdertcli.dll
WinUser.h

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2243
Runtime API
3.8 Tag and log functions

3.8.8 Functions for processing time systems

3.8.8.1 TLGEnumTime

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,
LPCMN_ERROR lpoes );

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
Pointer to application-specific data. This pointer is not evaluated by the function but provided
again in the callback function.

lpoes
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
Time objects listed

FALSE
Error

Required files
pdecscli.h

WinCC Engineering V18 – Programming reference

2244 System Manual, 11/2022, Online documentation
 Runtime API
3.8 Tag and log functions

pdecscli.lib
pdecscli.dll

Related functions

TLG_ENUM_TIME_NAME_CALLBACK (Page 2245) List time objects (callback)

Examples
Enum all acquisition and logging times (Page 2260) "TL01.cpp"

See also
TLG_ENUM_TIME_NAME_CALLBACK (Page 2245)
Enum all acquisition and logging times (Page 2260)

3.8.8.2 TLG_ENUM_TIME_NAME_CALLBACK

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
Pointer to application-specific data. This pointer is made available again in the callback
function.

Return value

TRUE
The enumeration is continued.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2245
Runtime API
3.8 Tag and log functions

FALSE
The enumeration is cancelled.

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

Required files
pdecscli.h

Related functions

TLGEnumTime (Page 2244) List time objects

Examples
Enum all acquisition and logging times (Page 2260) "TL01.cpp"

See also
Enum all acquisition and logging times (Page 2260)
TLGEnumTime (Page 2244)

3.8.8.3 TLGEnumTimes

Description
Enumerates all detection and logging times.

Declaration

BOOL TLGEnumTimes(
TLG_ENUMTIMES_CALLBACK lpfnCallback,
LPVOID lpUser,
PCMN_ERROR lpError );

WinCC Engineering V18 – Programming reference

2246 System Manual, 11/2022, Online documentation
 Runtime API
3.8 Tag and log functions

Parameters

lpfnCallback
Pointer to your callback function

lpUser
Pointer to application-specific data. This pointer is not evaluated by the function but provided
again in the callback function.

lpError
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
Time objects listed

FALSE
Error

Error messages

TLG_API_INVALID_PARAM invalid/wrong parameter supply

TLG_API_ERR_SUPPLY An error has occurred
TLG_API_NO_INTERFACE Access to lower level COM interfaces failed
TLG_API_NO_CONNECTION No connection established with an activated
project

Required files
pdertcli.h
pde_glob.h
pdertdef.h
pdertcli.lib
pdertcli.dll

Related functions

TLG_ENUMTIMES_CALLBACK (Page 2248) List time objects (callback)

See also
TLG_ENUMTIMES_CALLBACK (Page 2248)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2247
Runtime API
3.8 Tag and log functions

3.8.8.4 TLG_ENUMTIMES_CALLBACK

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 2176)
structure per time object. The lpTime pointer refers to the beginning of the first element.

lpUser
Pointer to application-specific data. This pointer is made available again in the callback
function.

Return value

TRUE
The enumeration is continued.

FALSE
The enumeration is cancelled.

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

Required files
pdertcli.h
pde_glob.h

WinCC Engineering V18 – Programming reference

2248 System Manual, 11/2022, Online documentation
 Runtime API
3.8 Tag and log functions

pdertdef.h

Related functions

TLGEnumTimes (Page 2246) List time objects

See also
TLGEnumTimes (Page 2246)
TLG_TIMEDATA (Page 2176)

3.8.8.5 TLGReadTime

Description
Read the parameters of an already created time object

Declaration

BOOL TLGReadTime (
HANDLE hProject,
LPTSTR lpszTimeName,
PTLG_TIME_STR lpTime,
LPCMN_ERROR lpoes );

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 2175) structure with the data of the time object.

lpoes
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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2249
Runtime API
3.8 Tag and log functions

Return value

TRUE
Parameters of the time object read

FALSE
Error

Required files
pdecscli.h
pdecscli.lib
pdecscli.dll

Examples
Read parameters of time object (Page 2274) "TL01.cpp"

See also
TLG_TIME_STR (Page 2175)
Read parameters of time object (Page 2274)

3.8.9 Functions for saving and restoring

3.8.9.1 TLGEnumBackupEntries

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 (
LPTSTR lpszArchivName,
TLG_ENUMBACKUP_ENTRIES lpfnCallback,
LPVOID lpUser,
PCMN_ERROR lpError );

WinCC Engineering V18 – Programming reference

2250 System Manual, 11/2022, Online documentation
 Runtime API
3.8 Tag and log functions

Parameters

lpszArchivName
Pointer to the name of the log

lpfnCallback
Pointer to your callback function which is called for every existing backuo.

lpUser
Pointer to application-specific data. This pointer is not evaluated by the function but provided
again in the callback function.

lpError
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
Backups listed

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_NOT_SUPPORTED This function is not supported

Required files
pdertcli.h
pde_glob.h
pdertdef.h
pdertcli.lib
pdertcli.dll

Related functions

TLG_ENUMBACKUP_ENTRIES (Page 2252) List backups (callback)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2251
Runtime API
3.8 Tag and log functions

See also
TLG_ENUMBACKUP_ENTRIES (Page 2252)

3.8.9.2 TLG_ENUMBACKUP_ENTRIES

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 2153) structure per backup. The lpbti pointer refers to the beginning of the first
element.

lpUser
Pointer to application-specific data. This pointer is made available again in the callback
function.

Return value

TRUE
The enumeration is continued.

FALSE
The enumeration is cancelled.

WinCC Engineering V18 – Programming reference

2252 System Manual, 11/2022, Online documentation
 Runtime API
3.8 Tag and log functions

Comment

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

Required files
pdertcli.h
pde_glob.h
pdertdef.h

Related functions

TLGEnumBackupEntries (Page 2250) List backups

See also
TLGEnumBackupEntries (Page 2250)
TLG_BACKUP_TABLE_INFO (Page 2153)

3.8.9.3 TLGExport

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 lpszArchivName,
LPTSTR lpszFileName,
PTLG_IO_BACKUP_SELECT lpibs,
DWORD dwJobFlags,
DWORD dwFormatFlags,
PCMN_ERROR lpError );

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2253
Runtime API
3.8 Tag and log functions

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 2165) 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
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
Log data exported

FALSE
Error

Comment
This function is only useful for sequential logs, circular logs and compressed logs.

Error messages

TLG_API_ERR_SUPPLY An error has occurred

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

WinCC Engineering V18 – Programming reference

2254 System Manual, 11/2022, Online documentation
 Runtime API
3.8 Tag and log functions

Required files
pdertcli.h
pde_glob.h
pdertdef.h
pdertcli.lib
pdertcli.dll

See also
TLG_IO_BACKUP_SELECT (Page 2165)

3.8.9.4 TLGGetBackupSize

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 (
LPTSTR lpszArchivName,
DWORD* lpdwSizeOfTable,
PTLG_IO_BACKUP_SELECT lpibs,
DWORD dwJobFlags,
DWORD dwFormatFlags,
PCMN_ERROR lpError );

Parameters

lpszArchivName
Pointer to the name of the log

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 2165) for the selection
parameters.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2255
Runtime API
3.8 Tag and log functions

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
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
Size of data determined

FALSE
Error

Error messages

TLG_API_ERR_SUPPLY An error has occurred

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_NOT_SUPPORTED This function is not supported

Required files
pdertcli.h
pde_glob.h
pdertdef.h
pdertcli.lib
pdertcli.dll

See also
TLG_IO_BACKUP_SELECT (Page 2165)

WinCC Engineering V18 – Programming reference

2256 System Manual, 11/2022, Online documentation
 Runtime API
3.8 Tag and log functions

3.8.10 Examples

3.8.10.1 Edit curve template - Example 1

Example

// =====================================================================
// =====================================================================
// : Modul with examples to TagLogging-API
// *********************************************************************
// Copyright (C) 1995/96 SIEMENS AG, AUT 913 All rights reserved
// *********************************************************************
#include "stdafx.h" // if MFC classes
//#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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2257
Runtime API
3.8 Tag and log functions

// scripts
BOOL ret = FALSE;
CMN_ERROR Error;
TCHAR szText[255];
HWND hwndParent = NULL;
TLG_TEMPLATEITEM_INFO TemplateItem;
memset(&Error,0,sizeof(CMN_ERROR));
ret = TLGConnect(hwndParent, &Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in
TLGInsertTemplateItem: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
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;
memset(&Error,0,sizeof(CMN_ERROR));
ret = TLGInsertTemplateItem(TemplateItem.szTemplateName, &TemplateItem, &Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in
TLGInsertTemplateItem: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
}
else
{
_sntprintf_s(szText,_countof(szText), _TRUNCATE, _T("InsertItem:
TemplateItemName= %s "), TemplateItem.szTemplateItemName);

WinCC Engineering V18 – Programming reference

2258 System Manual, 11/2022, Online documentation
 Runtime API
3.8 Tag and log functions

}
ODKTrace(szText);
// Disconnect
memset(&Error,0,sizeof(CMN_ERROR));
ret = TLGDisconnect(&Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in TLGDisconnect:
E1= 0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
ODKTrace(szText);
}
}
}
//{{ODK_EXAMPLE}(END)}

See also
TLGInsertTemplateItem (Page 2238)
TLGConnect (Page 2191)
TLGDisconnect (Page 2193)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2259
Runtime API
3.8 Tag and log functions

3.8.10.2 Enum all acquisition and logging times

Example

/ =====================================================================
// =====================================================================
// : Modul with examples to TagLogging-API
// *********************************************************************
// Copyright (C) 1995/96 SIEMENS AG, AUT 913 All rights reserved
// *********************************************************************
#include "stdafx.h" // if MFC classes
#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);
//printf("%s\r\n",szText);
return TRUE;
}

void MyTLGEnumTime(void)
{
// #define PROJ_PATH "C:\\siemens\\odk\\samples\\projects\\demo\\odk.mcp"
BOOL ret = FALSE;
TCHAR szText[255];
HANDLE hProject;
CMN_ERROR Error;
PVOID pUser = NULL;
sprintf(szText, "TLGEnumTime");
ODKTrace(szText);
//printf("%s\r\n",szText);
MyDMEnumOpenedProjects(); // open the DM and set the g_szProjectFile
memset(&Error,0,sizeof(CMN_ERROR));
ret = TLGCSConnect(NULL, &Error);
if (FALSE == ret)

WinCC Engineering V18 – Programming reference

2260 System Manual, 11/2022, Online documentation
 Runtime API
3.8 Tag and log functions

{
sprintf(szText, "Error in TLGCSConnect: E1= 0x%08lx ; E2= 0x%08lx ; %s",
Error.dwError1, Error.dwError2, Error.szErrorText);
ODKTrace(szText);
//printf("%s\r\n",szText);
}
else
{
sprintf(szText, " TLGCSConnect");
ODKTrace(szText);
//printf("%s\r\n",szText);
memset(&Error,0,sizeof(CMN_ERROR));
ret = TLGOpenProject(&hProject, /*PROJ_PATH*/g_szProjectFile, NULL, &Error);
if (FALSE == ret)
{
sprintf(szText, "Error in TLGOpenProject: E1= 0x%08lx ; E2= 0x%08lx ; %s",
Error.dwError1, Error.dwError2, Error.szErrorText);
ODKTrace(szText);
//printf("%s\r\n",szText);
}
else //TLGOpenProject OK
{
sprintf(szText, " TLGOpenProject");
ODKTrace(szText);
//printf("%s\r\n",szText);
// read projected archiving times
memset(&Error,0,sizeof(CMN_ERROR));
ret = TLGEnumTime(hProject, MyTLGEnumTimeNameCallback, pUser, &Error);
if (FALSE == ret)
{
sprintf(szText, "Error in TLGEnumTime: E1= 0x%08lx ; E2= 0x%08lx ; %s",
Error.dwError1, Error.dwError2, Error.szErrorText);
}
else
{
sprintf(szText, " TLGEnumTime");
}
ODKTrace(szText);
//printf("%s\r\n",szText);
//TLGCloseProject();
memset(&Error,0,sizeof(CMN_ERROR));
ret = TLGCloseProject(hProject, &Error);
if(FALSE == ret)
{
sprintf(szText, "Error in TLGCloseProject: E1= 0x%08lx ; E2= 0x%08lx ; %s",
Error.dwError1, Error.dwError2, Error.szErrorText);
}
else
{
sprintf(szText, " TLGCloseProject");
}
ODKTrace(szText);
//printf("%s\r\n",szText);
}
// Disconnect
memset(&Error,0,sizeof(CMN_ERROR));

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2261
Runtime API
3.8 Tag and log functions

ret = TLGCSDisConnect(&Error);
if (FALSE == ret)
{
sprintf(szText, "Error in TLGCSDisConnect: E1= 0x%08lx ; E2= 0x%08lx ; %s",
Error.dwError1, Error.dwError2, Error.szErrorText);
}
else
{
sprintf(szText, " TLGCSDisConnect");
}
ODKTrace(szText);
//printf("%s\r\n",szText);
}
}
//{{ODK_EXAMPLE}(END)}

See also
TLGCSConnect (Page 2186)
TLG_ENUM_TIME_NAME_CALLBACK (Page 2245)
TLGEnumTime (Page 2244)
TLGDisconnect (Page 2193)
TLGCSDisConnect (Page 2189)

WinCC Engineering V18 – Programming reference

2262 System Manual, 11/2022, Online documentation
 Runtime API
3.8 Tag and log functions

3.8.10.3 Enum logs

Example

//{{ODK_EXAMPLE}Enum archives (TLG)}

//{{FUNCTION}TLGCSConnect (TLG)}
//{{FUNCTION}TLGCSDisConnect (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)
{
// #define PROJ_PATH "C:\\siemens\\odk\\samples\\projects\\demo\\odk.mcp"
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);
MyDMEnumOpenedProjects(); // open the DM and set the g_szProjectFile
//TLGConnect
memset(&Error,0,sizeof(CMN_ERROR));
ret = TLGCSConnect(NULL, &Error);
if (FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in TLGCSConnect: E1=
0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
ODKTrace(szText);
}
else
{
//TLGOpenProject
memset(&Error,0,sizeof(CMN_ERROR));
ret = TLGOpenProject(&hProject, /*PROJ_PATH*/g_szProjectFile, NULL, &Error);
if (FALSE == ret)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2263
Runtime API
3.8 Tag and log functions

{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in
TLGOpenProject: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
ODKTrace(szText);
}
else
{
// TLGEnumArchives
memset(&Error,0,sizeof(CMN_ERROR));
ret = TLGEnumArchives(hProject, MyTLGEnumArchivCallback, pUser, &Error);
if (FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in
TLGEnumArchives: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" TLGEnumArchives"));
}
ODKTrace(szText);
}
//CloseProject
memset(&Error,0,sizeof(CMN_ERROR));
ret = TLGCloseProject(hProject,&Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in TLGCloseProject:
E1= 0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" TLGCloseProject"));
}
ODKTrace(szText);
}
// Disconnect
memset(&Error,0,sizeof(CMN_ERROR));
ret = TLGCSDisConnect(&Error);
if (FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in TLGCSDisConnect: E1=
0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" TLGCSDisConnect"));
}
ODKTrace(szText);
}
//{{ODK_EXAMPLE}(END)}

WinCC Engineering V18 – Programming reference

2264 System Manual, 11/2022, Online documentation
 Runtime API
3.8 Tag and log functions

See also
TLGCSConnect (Page 2186)
TLGOpenProject (Page 2195)
TLGCloseProject (Page 2194)
TLGEnumArchives (Page 2207)
TLG_ENUM_ARCHIV_CALLBACK (Page 2208)
TLGCSDisConnect (Page 2189)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2265
Runtime API
3.8 Tag and log functions

3.8.10.4 Enum tags of a log

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;
TCHAR szArchivName[255];
HWND hwndParent = NULL;
VOID* pUser = NULL;
_tcsncpy_s(szArchivName, _countof(szArchivName), _T("PLSMWA"), _TRUNCATE);
memset(&Error,0,sizeof(CMN_ERROR));
ret = TLGConnect(hwndParent, &Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in TLGConnect: E1=
0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
ODKTrace(szText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("TLGConnect"));
ODKTrace(szText);

// Info
memset(&Error,0,sizeof(CMN_ERROR));
ret = TLGEnumVariablesEx (szArchivName, MyTLGEnumVariablesExCallback,
pUser, &Error );

WinCC Engineering V18 – Programming reference

2266 System Manual, 11/2022, Online documentation
 Runtime API
3.8 Tag and log functions

if (FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in
TLGEnumVariablesEx: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("TLGEnumVariablesEx: OK"));
}
ODKTrace(szText);

memset(&Error,0,sizeof(CMN_ERROR));
ret = TLGDisconnect(&Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in TLGDisconnect:
E1= 0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
ODKTrace(szText);
}
}
}
//{{ODK_EXAMPLE}(END)}

See also
TLGOpenProject (Page 2195)
TLGEnumVariablesEx (Page 2202)
TLG_ENUMVARIABLES (Page 2204)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2267
Runtime API
3.8 Tag and log functions

3.8.10.5 Enumerate logs

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];
HWND hwndParent = NULL;
memset(&Error,0,sizeof(CMN_ERROR));
ret = TLGConnect(hwndParent, &Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in TLGConnect: E1=
0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
ODKTrace(szText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("TLGConnect"));

WinCC Engineering V18 – Programming reference

2268 System Manual, 11/2022, Online documentation
 Runtime API
3.8 Tag and log functions

ODKTrace(szText);

memset(&Error,0,sizeof(CMN_ERROR));
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"),
Error.dwError1, Error.dwError2, Error.szErrorText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("TLGEnumArchivs: OK"));
}
ODKTrace(szText);
memset(&Error,0,sizeof(CMN_ERROR));
ret = TLGDisconnect(&Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in TLGDisconnect:
E1= 0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
ODKTrace(szText);
}
}
}
//{{ODK_EXAMPLE}(END)}

See also
TLGConnect (Page 2191)
TLGDisconnect (Page 2193)
TLGEnumArchivs (Page 2210)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2269
Runtime API
3.8 Tag and log functions

3.8.10.6 Read log

Example

//{{ODK_EXAMPLE}Read archive (TLG)}

//{{FUNCTION}TLGCSConnect (TLG)}
//{{FUNCTION}TLGCSDisConnect (TLG)}
//{{FUNCTION}TLGOpenProject (TLG)}
//{{FUNCTION}TLGCloseProject (TLG)}
//{{FUNCTION}TLGReadArchiv (TLG)}
//{{FUNCTION}TLGReadVariable (TLG)}
//{{FUNCTION}(END)}
// =====================================================================
// Function: TLGReadArchiv(void) ODK TL CS
// =====================================================================
// : Read archive
// :
// =====================================================================
void MyTLGReadArchiv(void)
{
// #define PROJ_PATH "C:\\siemens\\odk\\samples\\projects\\demo\\odk.mcp"
BOOL ret = FALSE;
CMN_ERROR Error;
HANDLE hProject;
//PVOID pUser = NULL;
TCHAR szText[255];
TCHAR szArchivName[255];
TCHAR szVarName[255];
TLG_ARCHIV_STR TLGArchivStruct;
TLG_VAR_STR TLGVarStruct;
_tcsncpy_s(szArchivName, _countof(szArchivName), _T("PLSMWA"), _TRUNCATE);
_tcsncpy_s(szVarName, _countof(szVarName), _T("X"), _TRUNCATE);
MyDMEnumOpenedProjects(); // open the DM and set the g_szProjectFile
memset(&Error,0,sizeof(CMN_ERROR));
ret = TLGCSConnect(NULL, &Error);
if (FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in TLGCSConnect: E1=
0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
ODKTrace(szText);
}
else
{
memset(&Error,0,sizeof(CMN_ERROR));
ret = TLGOpenProject(&hProject, /*PROJ_PATH*/g_szProjectFile, NULL, &Error);
if (FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in TLGOpenProject:
E1= 0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
ODKTrace(szText);
}
else

WinCC Engineering V18 – Programming reference

2270 System Manual, 11/2022, Online documentation
 Runtime API
3.8 Tag and log functions

{
// read
memset(&TLGArchivStruct,0,sizeof(TLG_ARCHIV_STR));
memset(&Error,0,sizeof(CMN_ERROR));
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"),
Error.dwError1, Error.dwError2, Error.szErrorText);
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));
memset(&Error,0,sizeof(CMN_ERROR));
ret = TLGReadVariable(hProject, szArchivName, szVarName, &TLGVarStruct, &Error);
if (FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in
TLGReadVariable: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
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);

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2271
Runtime API
3.8 Tag and log functions

_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
memset(&Error,0,sizeof(CMN_ERROR));
ret = TLGCloseProject(hProject,&Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in TLGCloseProject:
E1= 0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" TLGCloseProject"));
}
ODKTrace(szText);
}
// Disconnect
memset(&Error,0,sizeof(CMN_ERROR));
ret = TLGCSDisConnect(&Error);
if (FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in TLGCSDisConnect: E1=
0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" TLGCSDisConnect"));
}
ODKTrace(szText);
}

WinCC Engineering V18 – Programming reference

2272 System Manual, 11/2022, Online documentation
 Runtime API
3.8 Tag and log functions

//{{ODK_EXAMPLE}(END)}

See also
TLGOpenProject (Page 2195)
TLGCloseProject (Page 2194)
TLGCSConnect (Page 2186)
TLGReadVariable (Page 2205)
TLGReadArchiv (Page 2234)
TLGCSDisConnect (Page 2189)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2273
Runtime API
3.8 Tag and log functions

3.8.10.7 Read parameters of time object

Example

//{{ODK_EXAMPLE}Read parameters of time object (TLG)}

//{{FUNCTION}TLGCSConnect (TLG)}
//{{FUNCTION}TLGCSDisConnect (TLG)}
//{{FUNCTION}TLGReadTime (TLG)}
//{{FUNCTION}TLGOpenProject (TLG)}
//{{FUNCTION}TLGCloseProject (TLG)}
//{{FUNCTION}(END)}
// =====================================================================
// Function: TLGReadTime(void) ODK TL CS
// =====================================================================
// : Reads the parameters of an already existing time object.
// :
// =====================================================================
void MyTLGReadTime(void)
{
// #define PROJ_PATH "C:\\siemens\\odk\\samples\\projects\\demo\\odk.mcp"
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);
MyDMEnumOpenedProjects(); // open the DM and set the g_szProjectFile
memset(&Error,0,sizeof(CMN_ERROR));
ret = TLGCSConnect(NULL, &Error);
if (FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in TLGCSConnect: E1=
0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
ODKTrace(szText);
}
else
{
memset(&Error,0,sizeof(CMN_ERROR));
ret = TLGOpenProject(&hProject, /*PROJ_PATH*/g_szProjectFile, NULL, &Error);
if (FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in TLGOpenProject:
E1= 0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
ODKTrace(szText);
}
else
{
// read properties of selected time
memset(&Error,0,sizeof(CMN_ERROR));
memset(&TLGTimeStruct, 0, sizeof(TLG_TIME_STR));

WinCC Engineering V18 – Programming reference

2274 System Manual, 11/2022, Online documentation
 Runtime API
3.8 Tag and log functions

_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"),
Error.dwError1, Error.dwError2, Error.szErrorText);
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
memset(&Error, 0, sizeof(CMN_ERROR));
ret = TLGSaveProject(hProject , &Error);
if (FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in
TLGSaveProject: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" TLGSaveProject"));
}
ODKTrace(szText);
//TLGCloseProject();
memset(&Error, 0, sizeof(CMN_ERROR));
ret = TLGCloseProject(hProject, &Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in
TLGCloseProject: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" TLGCloseProject"));
}
ODKTrace(szText);
}
// Disconnect
memset(&Error,0,sizeof(CMN_ERROR));
ret = TLGCSDisConnect(&Error);
if (FALSE == ret)
{

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2275
Runtime API
3.9 Recipe functions

_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in TLGCSDisConnect:

E1= 0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" TLGCSDisConnect"));
}
ODKTrace(szText);
}
}
//{{ODK_EXAMPLE}(END)}

See also
TLGOpenProject (Page 2195)
TLGCloseProject (Page 2194)
TLGCSConnect (Page 2186)
TLGReadTime (Page 2249)
TLGCSDisConnect (Page 2189)

3.9 Recipe functions

3.9.1 Basics

3.9.1.1 Overview of the functions

Overview

uaSetLocalEvents (Page 2291) Sets the local events.

uaArchiveClose (Page 2302) Close connection to current user archive
uaArchiveDelete (Page 2303) Delete data records in the user archive
uaArchiveExport (Page 2304) Export user archive
uaArchiveGetCount (Page 2315) Read the number of data records
uaArchiveGetFieldLength (Page 2324) Read the current field length
uaArchiveGetFieldName (Page 2325) Read the current field name
uaArchiveGetFields (Page 2326) Determine number of fields
uaArchiveGetFieldType (Page 2327) Read the current field type
uaArchiveGetFieldValueDate (Page 2328) Read date and time from current data field
uaArchiveGetFieldValueDouble (Page 2329) Read double value from current data field
uaArchiveGetFieldValueLong (Page 2331) Read long value from current data field

WinCC Engineering V18 – Programming reference

2276 System Manual, 11/2022, Online documentation
 Runtime API
3.9 Recipe functions

uaArchiveGetFieldValueString (Page 2332) Read string from current data field

uaArchiveGetFilter (Page 2317) Read filter setting
uaArchiveGetID (Page 2306) Read ID of the current data field
uaArchiveGetName (Page 2307) Read name of archive
uaArchiveGetSort (Page 2308) Read sorting of the current data field
uaArchiveImport (Page 2309) Import user archive
uaArchiveInsert (Page 2318) Insert data record into user archive
uaArchiveMoveFirst (Page 2319) Move to first data record
uaArchiveMoveLast (Page 2320) Move to last data record
uaArchiveMoveNext (Page 2321) Move to next data record
uaArchiveMovePrevious (Page 2322) Move to previous data record
uaArchiveOpen (Page 2310) Create connection to current user archive
uaArchiveReadTagValuesByName (Page 2345) Read tag values based on the name
uaArchiveReadTagValues (Page 2344) Read tag values
uaArchiveRequery (Page 2339) Reload to current user archive
uaArchiveSetFieldValueDate (Page 2333) Write date and time to current data field
uaArchiveSetFieldValueDouble (Page 2334) Write double value to current data field
uaArchiveSetFieldValueLong (Page 2335) Write long value to current data field
uaArchiveSetFieldValueString (Page 2337) Write string to current data field
uaArchiveSetFilter (Page 2340) Set filter
uaArchiveSetSort (Page 2342) Set up sorting criterion
uaArchiveUpdate (Page 2311) Update data record into user archive
uaArchiveWriteTagValuesByName (Page 2348) Write data record to tag based on the name
uaArchiveWriteTagValues (Page 2346) Write data record to tag
uaConnect (Page 2292) Establish connection to a user archive (runtime).
uaDisconnect (Page 2293) Close connection to user archive
uaGetArchive (Page 2312) Read archive configuration
uaGetField (Page 2338) Read field configuration
uaGetLastError (Page 2287) Query last error in user archive
uaGetNumArchives (Page 2314) Find number of configured user archives
uaGetNumFields (Page 2323) Determine number of fields
uaIsActive (Page 2289) Query whether an archive is open in runtime
uaOpenArchives (Page 2314) Query how many user archives are open in runtime
uaOpenViews (Page 2343) Query how many user archive views are open in
runtime
uaQueryArchiveByName (Page 2296) Set up connection to user archive based on the
name (runtime)
uaQueryArchive (Page 2294) Set up connection to user archive (runtime)
UaQueryConfiguration (Page 2298) Query connection to the configuration
uaReleaseArchive (Page 2299) Close connection to user archive (runtime)
uaReleaseConfiguration (Page 2301) Close connection to the configuration

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2277
Runtime API
3.9 Recipe functions

See also
uaUsers (Page 2290)

3.9.1.2 Structure of recipes

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.

WinCC Engineering V18 – Programming reference

2278 System Manual, 11/2022, Online documentation
 Runtime API
3.9 Recipe functions

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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2279
Runtime API
3.9 Recipe functions

3.9.1.3 Dependencies in call sequence of API functions

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 UAHARCH‐
IVE
UAQueryArchiveBy‐ Handle UAHARCH‐
Name ---> IVE
Required by:
UAArchiveOpen ---
>
Required for UAArchiveDelete
UAArchiveExport
UAArchiveGetCount
UAArchiveGetFieldLength
UAArchiveGetFields
UAArchiveGetFieldType
UAArchiveGetFieldValueDate
UAArchiveGetFieldValueDouble
UAArchiveGetFieldValueFloat
UAArchiveGetFieldValueLong
UAArchiveGetFieldValueString
UAArchiveGetFieldName
UAArchiveGetFilter
UAArchiveGetID
UAArchiveGetName
UAArchiveGetSort

WinCC Engineering V18 – Programming reference

2280 System Manual, 11/2022, Online documentation
 Runtime API
3.9 Recipe functions

UAArchiveImport
UAArchiveInsert
UAArchiveMoveFirst
UAArchiveMoveLast
UAArchiveMoveNext
UAArchiveMovePrevious
UAArchiveReadTagValues
UAArchiveReadTagValuesByName
UAArchiveRequery
UAArchiveSetFieldValueDate
UAArchiveSetFieldValueDouble
UAArchiveSetFieldValueFloat
UAArchiveSetFieldValueLong
UAArchiveSetFieldValueString
UAArchiveSetFilter
UAArchiveSetSort
UAArchiveUpdate
UAArchiveWriteTagValues
UAArchiveWriteTagValuesByName
<--- UAArchiveClose
<---
UAReleaseArchive
<--- UADisconnect

3.9.1.4 Error messages

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 inva‐
lid.
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).

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2281
Runtime API
3.9 Recipe functions

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.

3.9.1.5 Constants

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 also
created

WinCC Engineering V18 – Programming reference

2282 System Manual, 11/2022, Online documentation
 Runtime API
3.9 Recipe functions

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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2283
Runtime API
3.9 Recipe functions

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 Structures

3.9.2.1 uaCONFIGARCHIVE

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

WinCC Engineering V18 – Programming reference

2284 System Manual, 11/2022, Online documentation
 Runtime API
3.9 Recipe functions

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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2285
Runtime API
3.9 Recipe functions

3.9.2.2 uaCONFIGFIELD

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

WinCC Engineering V18 – Programming reference

2286 System Manual, 11/2022, Online documentation
 Runtime API
3.9 Recipe functions

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 General functions

3.9.3.1 uaGetLastError

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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2287
Runtime API
3.9 Recipe functions

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 fil‐
ter/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 ar‐
chive 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.

WinCC Engineering V18 – Programming reference

2288 System Manual, 11/2022, Online documentation
 Runtime API
3.9 Recipe functions

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

Description
Check that no recipe is in use in an active Runtime.

Declaration

BOOL uaIsActive (
UAHCONNECT hConnect )

Parameters

hConnect
Handle on recipe in Runtime. This handle is generated using uaConnect.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2289
Runtime API
3.9 Recipe functions

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 2292) Generate handle

See also
uaConnect (Page 2292)

3.9.3.3 uaUsers

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 (
UAHCONNECT hConnect )

Parameters

hConnect
Handle on recipe in Runtime. This handle is generated using uaConnect.

Return value
Number of active connections

WinCC Engineering V18 – Programming reference

2290 System Manual, 11/2022, Online documentation
 Runtime API
3.9 Recipe functions

Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll

Related functions

uaConnect (Page 2292) Generate handle

See also
uaConnect (Page 2292)

3.9.3.4 uaSetLocalEvents

Description
Sets local events.

Declaration

void uaSetLocalEvents (
UAHCONNECT hConnect
BOOL bLocalEvents )

Parameters

hConnect
Handle on recipe in Runtime. This handle is generated using uaConnect.

bLocalEvents
Local Event

Return value
No return value

Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2291
Runtime API
3.9 Recipe functions

Related functions

uaConnect (Page 2292) Generate handle

See also
uaConnect (Page 2292)

3.9.4 Functions for generating connections

3.9.4.1 uaConnect

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

WinCC Engineering V18 – Programming reference

2292 System Manual, 11/2022, Online documentation
 Runtime API
3.9 Recipe functions

Comments
The supplied handle is required for the functions uaDisconnect, uaIsActive, uaUsers,
uaOpenViews, uaOpenArchives, uaQueryArchive and uaQueryArchiveByName.

Related functions

uaDisconnect (Page 2293) Terminate connection

See also
uaIsActive (Page 2289)
uaUsers (Page 2290)
uaSetLocalEvents (Page 2291)
uaDisconnect (Page 2293)
uaQueryArchive (Page 2294)
uaQueryArchiveByName (Page 2296)
uaOpenArchives (Page 2314)
uaOpenViews (Page 2343)
Overview of the functions (Page 2276)

3.9.4.2 uaDisconnect

Description
When a connection is made to a recipe in Runtime, the connection is terminated.

Declaration

BOOL uaDisconnect (
UAHCONNECT hConnect )

Parameters

hConnect
Handle on recipe in Runtime. This handle is generated using uaConnect.

Return value

TRUE
Connection terminated.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2293
Runtime API
3.9 Recipe functions

FALSE
Error

Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll

Related functions

uaConnect (Page 2292) Generate handle

See also
uaConnect (Page 2292)
Overview of the functions (Page 2276)

3.9.4.3 uaQueryArchive

Description
Makes a connection to a recipe. uaQueryArchive generates the handle phArchive.

Declaration

BOOL uaQueryArchive (
UAHCONNECT hConnect,
LONG lArchive,
UAHARCHIVE* phArchive )

Parameters

hConnect
Handle on recipe in Runtime. This handle is generated using uaConnect.

lArchive
ID of the archive to be connected.

phArchive
Pointer to the connected recipe handle.

WinCC Engineering V18 – Programming reference

2294 System Manual, 11/2022, Online documentation
 Runtime API
3.9 Recipe functions

Return value

TRUE
Connection established

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

uaConnect (Page 2292) Generate handle

See also
uaConnect (Page 2292)
uaReleaseArchive (Page 2299)
uaArchiveClose (Page 2302)
uaArchiveDelete (Page 2303)
uaArchiveExport (Page 2304)
uaArchiveGetID (Page 2306)
uaArchiveGetName (Page 2307)
uaArchiveGetSort (Page 2308)
uaArchiveImport (Page 2309)
uaArchiveOpen (Page 2310)
uaArchiveUpdate (Page 2311)
uaArchiveGetCount (Page 2315)
uaArchiveGetFilter (Page 2317)
uaArchiveInsert (Page 2318)
uaArchiveMoveFirst (Page 2319)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2295
Runtime API
3.9 Recipe functions

uaArchiveMoveLast (Page 2320)

uaArchiveMoveNext (Page 2321)
uaArchiveMovePrevious (Page 2322)
uaArchiveGetFieldLength (Page 2324)
uaArchiveGetFields (Page 2326)
uaArchiveGetFieldType (Page 2327)
uaArchiveGetFieldName (Page 2325)
uaArchiveGetFieldValueDate (Page 2328)
uaArchiveGetFieldValueDouble (Page 2329)
uaArchiveGetFieldValueLong (Page 2331)
uaArchiveSetFieldValueDate (Page 2333)
uaArchiveSetFieldValueDouble (Page 2334)
uaArchiveSetFieldValueLong (Page 2335)
uaArchiveSetFieldValueString (Page 2337)
uaArchiveRequery (Page 2339)
uaArchiveSetFilter (Page 2340)
uaArchiveSetSort (Page 2342)
uaArchiveReadTagValues (Page 2344)
uaArchiveReadTagValuesByName (Page 2345)
uaArchiveWriteTagValues (Page 2346)
uaArchiveWriteTagValuesByName (Page 2348)
Overview of the functions (Page 2276)

3.9.4.4 uaQueryArchiveByName

Description
Makes a connection to a recipe by name. uaQueryArchiveByName generates the handle
phArchive.

Declaration

BOOL uaQueryArchiveByName (
UAHCONNECT hConnect,
LPCSTR pszName,
UAHARCHIVE* phArchive )

WinCC Engineering V18 – Programming reference

2296 System Manual, 11/2022, Online documentation
 Runtime API
3.9 Recipe functions

Parameters

hConnect
Handle on recipe in Runtime. This handle is generated using uaConnect.

pszName
Recipe name.

phArchive
Pointer to the connected recipe handle.

Return value

TRUE
Connection established

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

uaConnect (Page 2292) Generate handle

See also
uaConnect (Page 2292)
uaReleaseArchive (Page 2299)
uaArchiveClose (Page 2302)
uaArchiveDelete (Page 2303)
uaArchiveExport (Page 2304)
uaArchiveGetID (Page 2306)
uaArchiveGetName (Page 2307)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2297
Runtime API
3.9 Recipe functions

uaArchiveGetSort (Page 2308)

uaArchiveImport (Page 2309)
uaArchiveOpen (Page 2310)
uaArchiveUpdate (Page 2311)
uaArchiveGetCount (Page 2315)
uaArchiveGetFilter (Page 2317)
uaArchiveInsert (Page 2318)
uaArchiveMoveFirst (Page 2319)
uaArchiveMoveLast (Page 2320)
uaArchiveMoveNext (Page 2321)
uaArchiveMovePrevious (Page 2322)
uaArchiveGetFieldLength (Page 2324)
uaArchiveGetFields (Page 2326)
uaArchiveGetFieldType (Page 2327)
uaArchiveGetFieldName (Page 2325)
uaArchiveGetFieldValueDate (Page 2328)
uaArchiveGetFieldValueDouble (Page 2329)
uaArchiveGetFieldValueLong (Page 2331)
uaArchiveSetFieldValueDate (Page 2333)
uaArchiveSetFieldValueDouble (Page 2334)
uaArchiveSetFieldValueLong (Page 2335)
uaArchiveSetFieldValueString (Page 2337)
uaArchiveRequery (Page 2339)
uaArchiveSetFilter (Page 2340)
uaArchiveSetSort (Page 2342)
uaArchiveReadTagValues (Page 2344)
uaArchiveReadTagValuesByName (Page 2345)
uaArchiveWriteTagValues (Page 2346)
uaArchiveWriteTagValuesByName (Page 2348)
Overview of the functions (Page 2276)

3.9.4.5 UaQueryConfiguration

Description
Generates the connection to a recipe for the configuration.

WinCC Engineering V18 – Programming reference

2298 System Manual, 11/2022, Online documentation
 Runtime API
3.9 Recipe functions

Declaration

BOOL uaQueryConfiguration (
UAHCONFIG* phConfig )

Parameters

phConfig
Pointer to receptor handle.

Return value

TRUE
Connection established

FALSE
Error

Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll

See also
uaReleaseConfiguration (Page 2301)
uaGetArchive (Page 2312)
uaGetNumArchives (Page 2314)
uaGetNumFields (Page 2323)
uaGetField (Page 2338)
Overview of the functions (Page 2276)

3.9.4.6 uaReleaseArchive

Description
Breaks off the connection to the currently connected recipe.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2299
Runtime API
3.9 Recipe functions

Declaration

BOOL uaReleaseArchive (
UAHARCHIVE hArchive )

Parameters

hArchive
Handle on recipe. This handle is generated using uaQueryArchive or uaQueryArchiveByName.

Return value

TRUE
Connection terminated.

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 2294) Generate handle

uaQueryArchiveByName (Page 2296) Generate handle

See also
uaQueryArchive (Page 2294)
uaQueryArchiveByName (Page 2296)
Overview of the functions (Page 2276)

WinCC Engineering V18 – Programming reference

2300 System Manual, 11/2022, Online documentation
 Runtime API
3.9 Recipe functions

3.9.4.7 uaReleaseConfiguration

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
Connection terminated.

FALSE
Error

Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2301
Runtime API
3.9 Recipe functions

Related functions

UaQueryConfiguration (Page 2298) Generate handle

See also
UaQueryConfiguration (Page 2298)
Overview of the functions (Page 2276)

3.9.5 Functions for recipe processing

3.9.5.1 uaArchiveClose

Description
Closes an open recipe.

Declaration

BOOL uaArchiveClose (
UAHARCHIVE hArchive )

Parameters

hArchive
Handle on recipe. This handle is generated using uaQueryArchive or uaQueryArchiveByName.

Return value

TRUE
Recipe closed.

FALSE
Error

Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll

WinCC Engineering V18 – Programming reference

2302 System Manual, 11/2022, Online documentation
 Runtime API
3.9 Recipe functions

Related functions

uaQueryArchive (Page 2294) Generate handle

uaQueryArchiveByName (Page 2296) Generate handle
uaArchiveOpen (Page 2310) Open recipe

See also
uaQueryArchive (Page 2294)
uaQueryArchiveByName (Page 2296)
uaArchiveOpen (Page 2310)
Overview of the functions (Page 2276)

3.9.5.2 uaArchiveDelete

Description
Deletes data from a recipe. The configured recipe remains selected.

Declaration

BOOL uaArchiveDelete (
UAHARCHIVE hArchive,
LPCSTR pszWhere )

Parameters

hArchive
Handle on recipe. This handle is generated using uaQueryArchive or uaQueryArchiveByName.

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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2303
Runtime API
3.9 Recipe functions

FALSE
Error

Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll

Related functions

uaQueryArchive (Page 2294) Generate handle

uaQueryArchiveByName (Page 2296) Generate handle

See also
uaQueryArchive (Page 2294)
uaQueryArchiveByName (Page 2296)
Overview of the functions (Page 2276)

3.9.5.3 uaArchiveExport

Description
Exports data from a recipe to CSV file.

Declaration

BOOL uaArchiveExport (
UAHARCHIVE hArchive,
LPCSTR pszDestination,
LONG lType,
LONG lOptions )

Parameters

hArchive
Handle on recipe. This handle is generated using uaQueryArchive or uaQueryArchiveByName.

WinCC Engineering V18 – Programming reference

2304 System Manual, 11/2022, Online documentation
 Runtime API
3.9 Recipe functions

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
The parameter is reserved for future development and must be preset to 0.

Return value

TRUE
Data exported.

FALSE
Error

Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll

Related functions

uaQueryArchive (Page 2294) Generate handle

uaQueryArchiveByName (Page 2296) Generate handle
uaArchiveImport (Page 2309) Import data

See also
uaArchiveImport (Page 2309)
uaQueryArchive (Page 2294)
uaQueryArchiveByName (Page 2296)
Overview of the functions (Page 2276)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2305
Runtime API
3.9 Recipe functions

3.9.5.4 uaArchiveGetID

Description
Reads the recipe ID

Return Value:
"ID" of the user archive

Declaration

LONG uaArchiveGetID (
UAHARCHIVE hArchive )

Parameters

hArchive
Handle on recipe. This handle is generated using uaQueryArchive or uaQueryArchiveByName.

Return value
ID of the recipe

Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll

Related functions

uaQueryArchive (Page 2294) Generate handle

uaQueryArchiveByName (Page 2296) Generate handle

See also
uaQueryArchive (Page 2294)
uaQueryArchiveByName (Page 2296)
Overview of the functions (Page 2276)

WinCC Engineering V18 – Programming reference

2306 System Manual, 11/2022, Online documentation
 Runtime API
3.9 Recipe functions

3.9.5.5 uaArchiveGetName

Description
Reads the recipe name.

Declaration

VOID uaArchiveGetName (
UAHARCHIVE hArchive,
LPSTR pszName,
LONG cMaxLen )

Parameters

hArchive
Handle on recipe. This handle is generated using uaQueryArchive or uaQueryArchiveByName.

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

uaQueryArchive (Page 2294) Generate handle

uaQueryArchiveByName (Page 2296) Generate handle

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2307
Runtime API
3.9 Recipe functions

Example

char tank [40];

uaArchiveGetName( hArchive, tank, 39 );

See also
uaQueryArchive (Page 2294)
uaQueryArchiveByName (Page 2296)
Overview of the functions (Page 2276)

3.9.5.6 uaArchiveGetSort

Description
Reads the recipe sort parameters.

Declaration

VOID uaArchiveGetSort (
UAHARCHIVE hArchive,
LPSTR pszSort,
LONG cMaxLen )

Parameters

hArchive
Handle on recipe. This handle is generated using uaQueryArchive or uaQueryArchiveByName.

pszSort
Sort parameters as SQL statement.

cMaxLen
Maximum Length

Return value
No return value

Required files
ccuacapi.h

WinCC Engineering V18 – Programming reference

2308 System Manual, 11/2022, Online documentation
 Runtime API
3.9 Recipe functions

ccuacapi.lib
ccuacapi.dll

Related functions

uaQueryArchive (Page 2294) Generate handle

uaQueryArchiveByName (Page 2296) Generate handle

See also
uaQueryArchive (Page 2294)
uaQueryArchiveByName (Page 2296)
Overview of the functions (Page 2276)

3.9.5.7 uaArchiveImport

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 (
UAHARCHIVE hArchive,
LPCSTR pszSource,
LONG lType,
LONG lOptions )

Parameters

hArchive
Handle on recipe. This handle is generated using uaQueryArchive or uaQueryArchiveByName.

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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2309
Runtime API
3.9 Recipe functions

lOptions
The parameter is reserved for future development and must be preset to 0.

Return value

TRUE
Data imported.

FALSE
Error

Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll

Related functions

uaQueryArchive (Page 2294) Generate handle

uaQueryArchiveByName (Page 2296) Generate handle
uaArchiveExport (Page 2304) Export files.

See also
uaArchiveExport (Page 2304)
uaQueryArchive (Page 2294)
uaQueryArchiveByName (Page 2296)
Overview of the functions (Page 2276)

3.9.5.8 uaArchiveOpen

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 (
UAHARCHIVE hArchive )

WinCC Engineering V18 – Programming reference

2310 System Manual, 11/2022, Online documentation
 Runtime API
3.9 Recipe functions

Parameters

hArchive
Handle on recipe. This handle is generated using uaQueryArchive or uaQueryArchiveByName.

Return value

TRUE
Recipe open.

FALSE
Error

Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll

Related functions

uaQueryArchive (Page 2294) Generate handle

uaQueryArchiveByName (Page 2296) Generate handle
uaArchiveClose (Page 2302) Close recipe

See also
uaArchiveClose (Page 2302)
uaQueryArchive (Page 2294)
uaQueryArchiveByName (Page 2296)
Overview of the functions (Page 2276)

3.9.5.9 uaArchiveUpdate

Description
Updates an open recipe. All changed recipe data will be applied in the database. The recipe
structure remains unchanged.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2311
Runtime API
3.9 Recipe functions

Declaration

BOOL uaArchiveUpdate (
U AHARCHIVE hArchive )

Parameters

hArchive
Handle on recipe. This handle is generated using uaQueryArchive or uaQueryArchiveByName.

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

uaQueryArchive (Page 2294) Generate handle

uaQueryArchiveByName (Page 2296) Generate handle

See also
uaQueryArchive (Page 2294)
uaQueryArchiveByName (Page 2296)
Overview of the functions (Page 2276)

3.9.5.10 uaGetArchive

Description
Reads the recipe configuration.

WinCC Engineering V18 – Programming reference

2312 System Manual, 11/2022, Online documentation
 Runtime API
3.9 Recipe functions

Declaration

BOOL uaGetArchive (
UAHCONFIG hConfig,
Long lArchive,
UACONFIGARCHIVE* pArchive )

Parameters

hArchive
Handle on recipe. This handle is generated using uaQueryConfiguration.

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

UaQueryConfiguration (Page 2298) Generate handle

See also
UaQueryConfiguration (Page 2298)
Overview of the functions (Page 2276)
uaCONFIGARCHIVE (Page 2284)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2313
Runtime API
3.9 Recipe functions

3.9.5.11 uaGetNumArchives

Description
Reads the number of recipes currently configured.

Declaration

LONG uaGetNumArchives (
UAHCONFIG hConfig )

Parameters

hConfig
Handle on recipe. This handle is generated using uaQueryConfiguration.

Return value
Number of recipes configured. If an error occurs -1 is output.

Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll

Related functions

UaQueryConfiguration (Page 2298) Generate handle

See also
UaQueryConfiguration (Page 2298)
Overview of the functions (Page 2276)

3.9.5.12 uaOpenArchives

Description
Communicates the number of recipes in the open Runtime.

WinCC Engineering V18 – Programming reference

2314 System Manual, 11/2022, Online documentation
 Runtime API
3.9 Recipe functions

Declaration

LONG uaOpenArchives (
UAHCONNECT hConnect )

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

uaConnect (Page 2292) Generate handle

See also
uaConnect (Page 2292)
Overview of the functions (Page 2276)

3.9.6 Functions for recipe element processing

3.9.6.1 uaArchiveGetCount

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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2315
Runtime API
3.9 Recipe functions

Declaration

LONG uaArchiveGetCount(
UAHARCHIVE hArchive,
LONG* plCount )

Parameters

hArchive
Handle on recipe. This handle is generated using uaQueryArchive or uaQueryArchiveByName.

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

uaQueryArchive (Page 2294) Generate handle

uaQueryArchiveByName (Page 2296) Generate handle

See also
uaQueryArchive (Page 2294)
uaQueryArchiveByName (Page 2296)
Overview of the functions (Page 2276)

WinCC Engineering V18 – Programming reference

2316 System Manual, 11/2022, Online documentation
 Runtime API
3.9 Recipe functions

3.9.6.2 uaArchiveGetFilter

Description
Reads the selection criteria for the current data record.

Declaration

VOID uaArchiveGetFilter (
UAHARCHIVE hArchive,
LPSTR pszFilter,
LONG cMaxLen )

Parameters

hArchive
Handle on recipe. This handle is generated using uaQueryArchive or uaQueryArchiveByName.

pszFilter
Selection parameters as SQL statement.

cMaxLen
Maximum Length

Return value
No return value

Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll

Related functions

uaQueryArchive (Page 2294) Generate handle

uaQueryArchiveByName (Page 2296) Generate handle

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2317
Runtime API
3.9 Recipe functions

See also
uaQueryArchive (Page 2294)
uaQueryArchiveByName (Page 2296)
Overview of the functions (Page 2276)

3.9.6.3 uaArchiveInsert

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 (
UAHARCHIVE hArchive )

Parameters

hArchive
Handle on recipe. This handle is generated using uaQueryArchive or uaQueryArchiveByName.

Return value

TRUE
Data record inserted.

FALSE
Error

Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll

WinCC Engineering V18 – Programming reference

2318 System Manual, 11/2022, Online documentation
 Runtime API
3.9 Recipe functions

Related functions

uaQueryArchive (Page 2294) Generate handle

uaQueryArchiveByName (Page 2296) Generate handle

See also
uaQueryArchive (Page 2294)
uaQueryArchiveByName (Page 2296)
Overview of the functions (Page 2276)

3.9.6.4 uaArchiveMoveFirst

Description
Goes to the first data record.

Declaration

BOOL uaArchiveMoveFirst (
UAHARCHIVE hArchive )

Parameters

hArchive
Handle on recipe. This handle is generated using uaQueryArchive or uaQueryArchiveByName.

Return value

TRUE
Successful jump.

FALSE
Error

Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2319
Runtime API
3.9 Recipe functions

Related functions

uaQueryArchive (Page 2294) Generate handle

uaQueryArchiveByName (Page 2296) Generate handle

See also
uaQueryArchive (Page 2294)
uaQueryArchiveByName (Page 2296)
Overview of the functions (Page 2276)

3.9.6.5 uaArchiveMoveLast

Description
Goes to the last data record.

Declaration

BOOL uaArchiveMoveLast (
UAHARCHIVE hArchive )

Parameters

hArchive
Handle on recipe. This handle is generated using uaQueryArchive or uaQueryArchiveByName.

Return value

TRUE
Successful jump.

FALSE
Error

Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll

WinCC Engineering V18 – Programming reference

2320 System Manual, 11/2022, Online documentation
 Runtime API
3.9 Recipe functions

Related functions

uaQueryArchive (Page 2294) Generate handle

uaQueryArchiveByName (Page 2296) Generate handle

See also
uaQueryArchive (Page 2294)
uaQueryArchiveByName (Page 2296)
Overview of the functions (Page 2276)

3.9.6.6 uaArchiveMoveNext

Description
Goes to the next data record.

Declaration

BOOL uaArchiveMoveNext (
UAHARCHIVE hArchive )

Parameters

hArchive
Handle on recipe. This handle is generated using uaQueryArchive or uaQueryArchiveByName.

Return value

TRUE
Successful jump.

FALSE
Error

Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2321
Runtime API
3.9 Recipe functions

Related functions

uaQueryArchive (Page 2294) Generate handle

uaQueryArchiveByName (Page 2296) Generate handle

See also
uaQueryArchive (Page 2294)
uaQueryArchiveByName (Page 2296)
Overview of the functions (Page 2276)

3.9.6.7 uaArchiveMovePrevious

Description
Goes to the previous data record.

Declaration

BOOL uaArchiveMovePrevious (
UAHARCHIVE hArchive )

Parameters

hArchive
Handle on recipe. This handle is generated using uaQueryArchive or uaQueryArchiveByName.

Return value

TRUE
Successful jump.

FALSE
Error

Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll

WinCC Engineering V18 – Programming reference

2322 System Manual, 11/2022, Online documentation
 Runtime API
3.9 Recipe functions

Related functions

uaQueryArchive (Page 2294) Generate handle

uaQueryArchiveByName (Page 2296) Generate handle

See also
uaQueryArchive (Page 2294)
uaQueryArchiveByName (Page 2296)
Overview of the functions (Page 2276)

3.9.6.8 uaGetNumFields

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
Handle on recipe. This handle is generated using uaQueryConfiguration.

lArchive
Recipe index. Value: 0... uaGetNumArchives() -1

Return value
Number of the configured fields. If an error occurs -1 is output.

Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2323
Runtime API
3.9 Recipe functions

Related functions

UaQueryConfiguration (Page 2298) Generate handle

See also
UaQueryConfiguration (Page 2298)
Overview of the functions (Page 2276)

3.9.7 Functions for field processing

3.9.7.1 uaArchiveGetFieldLength

Description
Reads the length of a field in the current data record.

Declaration

LONG uaArchiveGetFieldLength(
UAHARCHIVE hArchive,
LONG lField )

Parameters

hArchive
Handle on recipe. This handle is generated using uaQueryArchive or uaQueryArchiveByName.

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

WinCC Engineering V18 – Programming reference

2324 System Manual, 11/2022, Online documentation
 Runtime API
3.9 Recipe functions

Related functions

uaQueryArchive (Page 2294) Generate handle

uaQueryArchiveByName (Page 2296) Generate handle

See also
uaQueryArchive (Page 2294)
uaQueryArchiveByName (Page 2296)
Overview of the functions (Page 2276)

3.9.7.2 uaArchiveGetFieldName

Description
Reads the name of a field in the current data record.

Declaration

VOID uaArchiveGetFieldName (
UAHARCHIVE hArchive,
LONG lField,
LPCSTR pszName,
LONG cMaxLen )

Parameters

hArchive
Handle on recipe. This handle is generated using uaQueryArchive or uaQueryArchiveByName.

lField
The field number, where iField = 1 addresses the first configured field. lField = 0 addresses the
"ID" field.

pszName
Field Name

cMaxLen
Maximum Length

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2325
Runtime API
3.9 Recipe functions

Return value

TRUE
Name read.

FALSE
Error

Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll

Related functions

uaQueryArchive (Page 2294) Generate handle

uaQueryArchiveByName (Page 2296) Generate handle

See also
uaQueryArchive (Page 2294)
uaQueryArchiveByName (Page 2296)
Overview of the functions (Page 2276)

3.9.7.3 uaArchiveGetFields

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 (
UAHARCHIVE hArchive )

WinCC Engineering V18 – Programming reference

2326 System Manual, 11/2022, Online documentation
 Runtime API
3.9 Recipe functions

Parameters

hArchive
Handle on recipe. This handle is generated using uaQueryArchive or uaQueryArchiveByName.

Return value
Number of the configured fields.

Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll

Related functions

uaQueryArchive (Page 2294) Generate handle

uaQueryArchiveByName (Page 2296) Generate handle

See also
uaQueryArchive (Page 2294)
uaQueryArchiveByName (Page 2296)
Overview of the functions (Page 2276)

3.9.7.4 uaArchiveGetFieldType

Description
Reads the type of a field in the current data record.

Declaration

LONG uaArchiveGetFieldType (
UAHARCHIVE hArchive,
LONG lField )

Parameters

hArchive
Handle on recipe. This handle is generated using uaQueryArchive or uaQueryArchiveByName.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2327
Runtime API
3.9 Recipe functions

lField
The field number, where iField = 1 addresses the first configured field. lField = 0 addresses 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

uaQueryArchive (Page 2294) Generate handle

uaQueryArchiveByName (Page 2296) Generate handle

See also
uaQueryArchive (Page 2294)
uaQueryArchiveByName (Page 2296)
Overview of the functions (Page 2276)

3.9.7.5 uaArchiveGetFieldValueDate

Description
Reads the date and time of a field in the current data record.

Declaration

BOOL uaArchiveGetFieldValueDate (
UAHARCHIVE hArchive,
LONG lField,
LPSYSTEMTIME pstDateTime )

WinCC Engineering V18 – Programming reference

2328 System Manual, 11/2022, Online documentation
 Runtime API
3.9 Recipe functions

Parameters

hArchive
Handle on recipe. This handle is generated using uaQueryArchive or uaQueryArchiveByName.

lField
The field number, where iField = 1 addresses the first configured field. lField = 0 addresses 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

uaQueryArchive (Page 2294) Generate handle

uaQueryArchiveByName (Page 2296) Generate handle

See also
uaQueryArchive (Page 2294)
uaQueryArchiveByName (Page 2296)
Overview of the functions (Page 2276)

3.9.7.6 uaArchiveGetFieldValueDouble

Description
Reads a value of the Double data type from a field in the current data record.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2329
Runtime API
3.9 Recipe functions

Declaration

BOOL uaArchiveGetFieldValueDouble (
UAHARCHIVE hArchive,
LONG lField,
double* pdValue )

Parameters

hArchive
Handle on recipe. This handle is generated using uaQueryArchive or uaQueryArchiveByName.

lField
The field number, where iField = 1 addresses the first configured field. lField = 0 addresses 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

uaQueryArchive (Page 2294) Generate handle

uaQueryArchiveByName (Page 2296) Generate handle

See also
uaQueryArchive (Page 2294)
uaQueryArchiveByName (Page 2296)
Overview of the functions (Page 2276)

WinCC Engineering V18 – Programming reference

2330 System Manual, 11/2022, Online documentation
 Runtime API
3.9 Recipe functions

3.9.7.7 uaArchiveGetFieldValueLong

Description
Reads a value of the Long data type from a field in the current data record.

Declaration

BOOL uaArchiveGetFieldValueLong (
UAHARCHIVE hArchive,
LONG lField,
LONG* pdValue )

Parameters

hArchive
Handle on recipe. This handle is generated using uaQueryArchive or uaQueryArchiveByName.

lField
The field number, where iField = 1 addresses the first configured field. lField = 0 addresses 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

uaQueryArchive (Page 2294) Generate handle

uaQueryArchiveByName (Page 2296) Generate handle

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2331
Runtime API
3.9 Recipe functions

See also
uaQueryArchive (Page 2294)
uaQueryArchiveByName (Page 2296)
Overview of the functions (Page 2276)

3.9.7.8 uaArchiveGetFieldValueString

Description
Reads a value of the String data type from a field in the current data record.

Declaration

BOOL uaArchiveGetFieldValueString (
UAHARCHIVE hArchive,
LONG lField,
LPSTR pszString,
LONG cMaxLen )

Parameters

hArchive
Handle on recipe. This handle is generated using uaQueryArchive or uaQueryArchiveByName.

lField
The field number, where iField = 1 addresses the first configured field. lField = 0 addresses the
"ID" field.

pszString
Pointer to the tag for the field value.

pdValue
Maximum length of the string.

Return value

TRUE
Value read.

FALSE
Error

WinCC Engineering V18 – Programming reference

2332 System Manual, 11/2022, Online documentation
 Runtime API
3.9 Recipe functions

Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll

Related functions

uaQueryArchive (Page 2294) Generate handle

uaQueryArchiveByName (Page 2296) Generate handle

See also
uaQueryArchive (Page 2294)
uaQueryArchiveByName (Page 2296)
Overview of the functions (Page 2276)

3.9.7.9 uaArchiveSetFieldValueDate

Description
Writes the date and time into a field of the current data record.

Declaration

BOOL uaArchiveSetFieldValueDate (
UAHARCHIVE hArchive,
LONG lField,
LPSYSTEMTIME pstDateTime )

Parameters

hArchive
Handle on recipe. This handle is generated using uaQueryArchive or uaQueryArchiveByName.

lField
The field number, where iField = 1 addresses the first configured field. lField = 0 addresses the
"ID" field.

pstDateTime
Date and Time.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2333
Runtime API
3.9 Recipe functions

Return value

TRUE
Value written.

FALSE
Error

Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll

Related functions

uaQueryArchive (Page 2294) Generate handle

uaQueryArchiveByName (Page 2296) Generate handle

See also
uaQueryArchive (Page 2294)
uaQueryArchiveByName (Page 2296)
Overview of the functions (Page 2276)

3.9.7.10 uaArchiveSetFieldValueDouble

Description
Writes a value from the Double data type from a field in the current data record.

Declaration

BOOL uaArchiveSetFieldValueDouble (
UAHARCHIVE hArchive,
LONG lField,
double dValue )

Parameters

hArchive
Handle on recipe. This handle is generated using uaQueryArchive or uaQueryArchiveByName.

WinCC Engineering V18 – Programming reference

2334 System Manual, 11/2022, Online documentation
 Runtime API
3.9 Recipe functions

lField
The field number, where iField = 1 addresses the first configured field. lField = 0 addresses 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

uaQueryArchive (Page 2294) Generate handle

uaQueryArchiveByName (Page 2296) Generate handle

See also
uaQueryArchive (Page 2294)
uaQueryArchiveByName (Page 2296)
Overview of the functions (Page 2276)

3.9.7.11 uaArchiveSetFieldValueLong

Description
Writes a value from the Long data type from a field in the current data record.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2335
Runtime API
3.9 Recipe functions

Declaration

BOOL uaArchiveSetFieldValueLong (
UAHARCHIVE hArchive,
LONG lField,
LONG dValue )

Parameters

hArchive
Handle on recipe. This handle is generated using uaQueryArchive or uaQueryArchiveByName.

lField
The field number, where iField = 1 addresses the first configured field. lField = 0 addresses 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

uaQueryArchive (Page 2294) Generate handle

uaQueryArchiveByName (Page 2296) Generate handle

See also
uaQueryArchive (Page 2294)
uaQueryArchiveByName (Page 2296)
Overview of the functions (Page 2276)

WinCC Engineering V18 – Programming reference

2336 System Manual, 11/2022, Online documentation
 Runtime API
3.9 Recipe functions

3.9.7.12 uaArchiveSetFieldValueString

Description
Writes a value from the String data type from a field in the current data record.

Declaration

BOOL uaArchiveSetFieldValueString (
UAHARCHIVE hArchive,
LONG lField,
LPCSTR pszString )

Parameters

hArchive
Handle on recipe. This handle is generated using uaQueryArchive or uaQueryArchiveByName.

lField
The field number, where iField = 1 addresses the first configured field. lField = 0 addresses 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

uaQueryArchive (Page 2294) Generate handle

uaQueryArchiveByName (Page 2296) Generate handle

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2337
Runtime API
3.9 Recipe functions

See also
uaQueryArchive (Page 2294)
uaQueryArchiveByName (Page 2296)
Overview of the functions (Page 2276)

3.9.7.13 uaGetField

Description
Reads the field configuration.

Declaration

BOOL uaGetField (
UAHCONFIG hConfig,
Long lArchive,
Long lField,
UACONFIGFIELD* pField )

Parameters

hConfig
Handle on recipe. This handle is generated using uaQueryConfiguration.

lArchive
Recipe index. Value: 0... uaGetNumArchives() -1

lField
The field number, where iField = 1 addresses the first configured field. lField = 0 addresses the
"ID" field.

pField
Point on the configuration data buffer.

Return value

TRUE
Configuration read.

FALSE
Error

WinCC Engineering V18 – Programming reference

2338 System Manual, 11/2022, Online documentation
 Runtime API
3.9 Recipe functions

Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll

Related functions

UaQueryConfiguration (Page 2298) Generate handle

See also
UaQueryConfiguration (Page 2298)
Overview of the functions (Page 2276)
uaCONFIGFIELD (Page 2286)

3.9.8 Filter and sort functions.

3.9.8.1 uaArchiveRequery

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(
UAHARCHIVE hArchive )

Parameters

hArchive
Handle on recipe. This handle is generated using uaQueryArchive or uaQueryArchiveByName.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2339
Runtime API
3.9 Recipe functions

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

uaQueryArchive (Page 2294) Generate handle

uaQueryArchiveByName (Page 2296) Generate handle

See also
uaQueryArchive (Page 2294)
uaQueryArchiveByName (Page 2296)
Overview of the functions (Page 2276)

3.9.8.2 uaArchiveSetFilter

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.

WinCC Engineering V18 – Programming reference

2340 System Manual, 11/2022, Online documentation
 Runtime API
3.9 Recipe functions

Declaration

VOID uaArchiveSetFilter (
UAHARCHIVE hArchive,
LPSTR pszFilter )

Parameters

hArchive
Handle on recipe. This handle is generated using uaQueryArchive or uaQueryArchiveByName.

pszFilter
Selection parameters as SQL parameters.

Return value

TRUE
Selection parameters changed.

FALSE
Error

Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll

Related functions

uaQueryArchive (Page 2294) Generate handle

uaQueryArchiveByName (Page 2296) Generate handle

See also
uaQueryArchive (Page 2294)
uaQueryArchiveByName (Page 2296)
Overview of the functions (Page 2276)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2341
Runtime API
3.9 Recipe functions

3.9.8.3 uaArchiveSetSort

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 (
UAHARCHIVE hArchive,
LPSTR pszSort )

Parameters

hArchive
Handle on recipe. This handle is generated using uaQueryArchive or uaQueryArchiveByName.

pszSort
Sort parameters as SQL statement.

Return value

TRUE
Sort successful.

FALSE
Error

Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll

Related functions

uaQueryArchive (Page 2294) Generate handle

uaQueryArchiveByName (Page 2296) Generate handle

WinCC Engineering V18 – Programming reference

2342 System Manual, 11/2022, Online documentation
 Runtime API
3.9 Recipe functions

See also
uaQueryArchive (Page 2294)
uaQueryArchiveByName (Page 2296)
Overview of the functions (Page 2276)

3.9.9 Functions for recipe view processing

3.9.9.1 uaOpenViews

Description
Gives the number of recipes in the open Runtime view.

Declaration

LONG uaOpenViews (
UAHCONNECT hConnect )

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

uaConnect (Page 2292) Generate handle

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2343
Runtime API
3.9 Recipe functions

See also
uaConnect (Page 2292)
Overview of the functions (Page 2276)

3.9.10 Functions for variables processing

3.9.10.1 uaArchiveReadTagValues

Description
Reads the current value from the field tag.

Declaration

BOOL uaArchiveReadTagValues (
UAHARCHIVE hArchive,
LONG* pnFields,
LONG cFields,
LONG lOptions )

Parameters

hArchive
Handle on recipe. This handle is generated using uaQueryArchive or uaQueryArchiveByName.

pnFields
The parameter is reserved for future development and must be preset to 0.

cFields
The parameter is reserved for future development and must be preset to 0.

lOptions
The parameter is reserved for future development and must be preset to 0.

Return value

TRUE
Data read.

FALSE
Error

WinCC Engineering V18 – Programming reference

2344 System Manual, 11/2022, Online documentation
 Runtime API
3.9 Recipe functions

Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll

Related functions

uaArchiveWriteTagValues (Page 2346) Writing values

uaQueryArchive (Page 2294) Generate handle
uaQueryArchiveByName (Page 2296) Generate handle

See also
uaQueryArchive (Page 2294)
uaQueryArchiveByName (Page 2296)
uaArchiveWriteTagValues (Page 2346)
Overview of the functions (Page 2276)

3.9.10.2 uaArchiveReadTagValuesByName

Description
Reads the current values from the tags.

Declaration

BOOL uaArchiveReadTagValuesByName (
UAHARCHIVE hArchive,
LPCSTR pszFields,
LONG lOptions )

Parameters

hArchive
Handle on recipe. This handle is generated using uaQueryArchive or uaQueryArchiveByName.

pszFields
The parameter is reserved for future development and must be preset to NULL.

lOptions
The parameter is reserved for future development and must be preset to 0.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2345
Runtime API
3.9 Recipe functions

Return value

TRUE
Data read.

FALSE
Error

Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll

Related functions

uaArchiveWriteTagValuesByName (Page 2348) Reading values

uaQueryArchive (Page 2294) Generate handle
uaQueryArchiveByName (Page 2296) Generate handle

See also
uaQueryArchive (Page 2294)
uaQueryArchiveByName (Page 2296)
uaArchiveWriteTagValuesByName (Page 2348)
Overview of the functions (Page 2276)

3.9.10.3 uaArchiveWriteTagValues

Description
Writes the values of the current data record to the tag.

Declaration

BOOL uaArchiveWriteTagValues (
UAHARCHIVE hArchive,
LONG* pnFields,
LONG cFields,
LONG lOptions )

WinCC Engineering V18 – Programming reference

2346 System Manual, 11/2022, Online documentation
 Runtime API
3.9 Recipe functions

Parameters

hArchive
Handle on recipe. This handle is generated using uaQueryArchive or uaQueryArchiveByName.

pnFields
The parameter is reserved for future development and must be preset to 0.

cFields
The parameter is reserved for future development and must be preset to 0.

lOptions
The parameter is reserved for future development and must be preset to 0.

Return value

TRUE
Data written.

FALSE
Error

Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll

Related functions

uaArchiveReadTagValues (Page 2344) Reading values

uaQueryArchive (Page 2294) Generate handle
uaQueryArchiveByName (Page 2296) Generate handle

See also
uaQueryArchive (Page 2294)
uaQueryArchiveByName (Page 2296)
uaArchiveReadTagValues (Page 2344)
Overview of the functions (Page 2276)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2347
Runtime API
3.9 Recipe functions

3.9.10.4 uaArchiveWriteTagValuesByName

Description
Writes the values of the current data record to the tag.

Declaration

BOOL uaArchiveWriteTagValuesByName (
UAHARCHIVE hArchive,
LPCSTR pszFields,
LONG lOptions )

Parameters

hArchive
Handle on recipe. This handle is generated using uaQueryArchive or uaQueryArchiveByName.

pszFields
The parameter is reserved for future development and must be preset to NULL.

lOptions
The parameter is reserved for future development and must be preset to 0.

Return value

TRUE
Data written.

FALSE
Error

Required files
ccuacapi.h
ccuacapi.lib
ccuacapi.dll

Related functions

uaArchiveReadTagValuesByName (Page 2345) Reading values

uaQueryArchive (Page 2294) Generate handle
uaQueryArchiveByName (Page 2296) Generate handle

WinCC Engineering V18 – Programming reference

2348 System Manual, 11/2022, Online documentation
 Runtime API
3.10 Alarm functions

See also
uaQueryArchive (Page 2294)
uaQueryArchiveByName (Page 2296)
uaArchiveReadTagValuesByName (Page 2345)
Overview of the functions (Page 2276)

3.10 Alarm functions

3.10.1 Basics

3.10.1.1 Overview of the functions

Overview

MSG_SERVICE_NOTIFY_PROC_PLUS (Page 2403) Send and receive service (callback)

MSRTActivateMProtPlus (Page 2409) Pause or continue protocol service
MSRTCheckWinFilterPlus (Page 2451) Check the alarm filter conditions
MSRTCreateMsgInstancePlus (Page 2413) Create alarm
MSRTCreateMsgInstanceWithCommentPlus Create alarm
(Page 2411)
MSRTDialogMsgLockPlus (Page 2417) Set parameters for disabling alarms
MSRTEnumArchivDataPlus (Page 2466) List alarms of a log
MSRTEnumBackupListPlus (Page 2464) List export list entries
MSRTEnumGroupMsgPlus (Page 2446) List alarm group individual alarms
MSRTExportPlus (Page 2465) Export alarms from sequential logs
MSRTGetClassInfoPlus (Page 2421) Query alarm class information
MSRTGetCommentInstancePlus (Page 2457) Query comment text
MSRTGetFilterDataPlus (Page 2450) Query alarm filter conditions
MSRTGetInfotextPlus (Page 2461) Query info text
MSRTGetLastMsgWithCommentPlus (Page 2423) Query last log alarm
MSRTGetMsgActualPlus (Page 2427) Determine number of alarms
MSRTGetMsgCSDataPlus (Page 2428) Query alarm configuration data
MSRTGetMsgPriorityPlus (Page 2437) Query priority of the alarm
MSRTGetMsgQuitPlus (Page 2439) Query alarms that require acknowledgment
MSRTGetSelectedMsgPlus (Page 2440) Determine alarm number
MSRTLoopInAlarmPlus (Page 2442) Loop-in-alarm
MSRTMsgWinCommandPlus (Page 2456) Perform control function in alarm window
MSRTPrintMProtPlus (Page 2410) Print alarm sequence report of pending alarms
MSRTQuitGroupPlus (Page 2449) Acknowledge alarm group

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2349
Runtime API
3.10 Alarm functions

MSRTQuitHornPlus (Page 2402) Acknowledge audible signal device

MSRTResetMsgPlus (Page 2444) Acknowledge alarm
MSRTSetCommentInstancePlus (Page 2459) Specify comment text
MSRTSetInfotextPlus (Page 2462) Specify info text
MSRTSetMsgFilterPlus (Page 2453) Set alarm filter
MSRTSetMsgWinFilterPlus (Page 2455) 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 2420)
MSRTLockGroupPlus (Page 2447)

3.10.1.2 Overview of structures

Overview

MSG_BACKUP_STRUCT_PLUS (Page 2364) Export list

MSG_CLASS_STRUCT_PLUS (Page 2366) Alarm class
MSG_COMMENT_INSTANCE_STRUCT_PLUS Comment
(Page 2368)
MSG_CSDATA_STRUCT_PLUS (Page 2370) Single alarm
MSG_FILTER_STRUCT_PLUS (Page 2375) Alarm filter
MSG_INFOTEXT_STRUCT_PLUS (Page 2382) Info text
MSG_RTCREATE_STRUCT_PLUS (Page 2383) Create an alarm in the runtime system
MSG_RTDATA_INSTANCECOM‐ Single alarm
MENT_STRUCT_PLUS (Page 2388)
MSG_RTDATA_INSTANCE_STRUCT_PLUS Single alarm
(Page 2385)
MSG_RTGROUPENUM_STRUCT_PLUS (Page 2392) Single alarms of an alarm group
MSG_RTGROUPSET_STRUCT_PLUS (Page 2393) Alarm group data
MSG_RTLOCK_STRUCT_PLUS (Page 2394) Alarm lock
MSG_TEXTVAL256_STRUCT_PLUS (Page 2395) Associated text values

3.10.1.3 Error messages

Overview
The following error messages can be returned by the API functions in the CMN_ERROR error
structure:

WinCC Engineering V18 – Programming reference

2350 System Manual, 11/2022, Online documentation
 Runtime API
3.10 Alarm functions

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 (WinCC
V6.0 and higher)
MSG_ERR_NO_MEMORY 0x00001022 Insufficient main memory (WinCC V6.0 and
higher)
MSG_ERR_DB_FAIL 0x00001023 Inconsistent database (WinCC V6.0 and higher)
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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2351
Runtime API
3.10 Alarm functions

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)

3.10.1.4 Constants

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

WinCC Engineering V18 – Programming reference

2352 System Manual, 11/2022, Online documentation
 Runtime API
3.10 Alarm functions

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_MANUAL (value: 0x0000000D) Alarm displayed manually
MSG_STATE_QUIT_SYSTEM (value: 0x00000010) Alarm acknowledged by system
MSG_STATE_QUIT_EMERGENCY (value: 0x00000011) Emergency acknowledgment
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.)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2353
Runtime API
3.10 Alarm functions

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,
available in V7.0 and higher
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_USER (value: 0x00000200) Alarms with unique user name
MSG_RT_FLAG_ONL_COM_COM (value: 0x00000400) Display only comments of incom‐
ing alarm in alarm list
MSG_RT_FLAG_HIDDEN (value: 0x00000800) Alarm hidden

WinCC Engineering V18 – Programming reference

2354 System Manual, 11/2022, Online documentation
 Runtime API
3.10 Alarm functions

MSG_RT_FLAG_TEXT10_EXT (value: 0x00001000) Extended channel diagnostics,

available in V7.0 and higher
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_QUITCOUNTER (value: 0x40000000) Bit for acknowledgment via
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_LOOPINALARM (value: 0x00000080) Alarm has loop-in-alarm.
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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2355
Runtime API
3.10 Alarm functions

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 incom‐
ing 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 acknowl‐

edgment
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

WinCC Engineering V18 – Programming reference

2356 System Manual, 11/2022, Online documentation
 Runtime API
3.10 Alarm functions

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_COMPUTERNAME (value: 0x00010012) Computer 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 constants
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_LOOPINALARM
-MSG_BLOCK_SYSTEM
MSG_MAX_SYSBL_V6 Number of system blocks in V6.0
and higher = MSG_BLOCK_PRIOR‐
ITY - 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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2357
Runtime API
3.10 Alarm functions

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_NOLEADING (value: 0x00000000)

MSGNR_FORMAT_LEADINGZERO (value: 0x00010000)
MSG_BLOCK_FORMAT_RIGHT (value: 0x00020000) Right-justified output
MSG_BLOCK_FORMAT_CENTER (value: 0x00040000) Centered output
MSG_BLOCK_FORMAT_FLASH (value: 0x80000000) Alarm block flashing

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.

WinCC Engineering V18 – Programming reference

2358 System Manual, 11/2022, Online documentation
 Runtime API
3.10 Alarm functions

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" button.
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_UNLOCK_MSG (value: 0x00400000) Display "Lock or release alarm"
button.
MSG_TB_SORTDLG (value: 0x00800000) Display "Sorting dialog" button.
MSG_TB_TIMEBASE (value: 0x01000000) Display "Dialog for timebase" but‐
ton.
MSG_TB_HITLIST (value: 0x02000000) Display "Hit list" button.
MSG_TB_HIDELIST (value: 0x04000000) Display "List of hidden messages"
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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2359
Runtime API
3.10 Alarm functions

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_SWITCHENABLE (value: 0x00000001) Process value switching

MSG_MWWIN_PROCESS (value: 0x00000002) Process alarm window
MSG_MWWIN_ARCHIV_CIRCLE (value: 0x00000004) Circular log
MSG_MWWIN_ARCHIV_LONG (value: 0x00000008) Sequential log
MSG_MWWIN_GRIDLINEHORZ (value: 0x00000010) Grid line horizontal
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_LINEHEIGHTFONT (value: 0x00000100) Adapt font to line height
MSG_MWWIN_COLUMNTITLE (value: 0x00000200) Column label
MSG_MWWIN_COLUMNTITLE2 (value: 0x00000400) 2 title lines
MSG_MWWIN_COLUMNTITLE3 (value: 0x00000800) 3 title lines
MSG_MWWIN_COLUMNWIDTH (value: 0x00001000) Column width adjustable
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_AUTOSCROLLOFF (value: 0x00010000) Auto scroll Off (default setting:
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_ALARM (value: 0x00400000) One click for "Loop-in-alarm"
_DC
MSG_MWWIN_SELECTFOCUS‐ (value: 0x00800000) Selection made with frame in‐
RECT stead of inversion
MSG_MWWIN_OPMSG_HIDE (value: 0x01000000) Operator input alarm when hid‐
ing
MSG_MWWIN_OPMSGUNHIDE (value: 0x02000000) Operating input alarm when dis‐
playing
MSG_MWWIN_INSTANCE_COL‐ (value: 0x08000000) Instance-specific column width
WIDTH

WinCC Engineering V18 – Programming reference

2360 System Manual, 11/2022, Online documentation
 Runtime API
3.10 Alarm functions

MSG_MWWIN_INSTANCEBLOCK‐ (value: 0x10000000) Instance-specific alarm block set‐

INFO tings
MSG_MWWIN_OPMSG_LOCK (value: 0x20000000) Operator input alarm when lock‐
ing
MSG_MWWIN_OPMSG_UNLOCK (value: 0x40000000) Operator input alarm when re‐
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_COUNTER_FROM (value: 0x00008000) Internal alarm counter 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_PRIORITY_FROM (value: 0x00400000) Priority 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)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2361
Runtime API
3.10 Alarm functions

MSG_FILTER_TIME Value: (MSG_FIL‐

TER_TIME_FROM | MSG_FIL‐
TER_TIME_TO)
MSG_FILTER_NR Value: (MSG_FILTER_NR_FROM |
MSG_FILTER_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_PARAM_HSPONLY (value: 0x00000001) Short-term log in main memory

MSG_ARPRO_PARAM_CIRCLE (value: 0x00000002) Circular log
MSG_ARPRO_PARAM_ENDLES (value: 0x00000004) Endless log
MSG_ARPRO_PARAM_RELOAD (value: 0x00000008) Reload after power failure
MSG_ARPRO_PARAM_LINEPRINT (value: 0x00000010) Print linewise (alarm sequence
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

WinCC Engineering V18 – Programming reference

2362 System Manual, 11/2022, Online documentation
 Runtime API
3.10 Alarm functions

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_OVERWRITE (value: 1) Overwrite existing data records
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)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2363
Runtime API
3.10 Alarm functions

3.10.2 Structures

3.10.2.1 MSG_BACKUP_STRUCT_PLUS

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

WinCC Engineering V18 – Programming reference

2364 System Manual, 11/2022, Online documentation
 Runtime API
3.10 Alarm functions

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
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.

Required files
CCMSRTCLIPlus.h

API functions

MSRTEnumBackupListPlus (Page 2464) List entries of an export file

MSRTGetBackupSize Determine size of export file
MSRTRestore Import alarms

See also
MSRTEnumBackupListPlus (Page 2464)
MSRTExportPlus (Page 2465)
Overview of structures (Page 2350)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2365
Runtime API
3.10 Alarm functions

3.10.2.2 MSG_CLASS_STRUCT_PLUS

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 dwCreatorID;
DWORD dwClassTyp;
}
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
Alarm class ID

crStateCome[0] Text color, foreground color

crStateCome[1] Background color

crStateCome
Color for the "incoming" status

crStateGo[0] Text color, foreground color

crStateGo[1] Background color

crStateGo
Color for the "outgoing" status

crStateQuit[0] Text color, foreground color

crStateQuit[1] Background color

WinCC Engineering V18 – Programming reference

2366 System Manual, 11/2022, Online documentation
 Runtime API
3.10 Alarm functions

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

dwCreatorID
CreatorID

dwClassTyp
The parameter is reserved for future development and must be preset to 0.

Required files
CCMSRTCLIPlus.h

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2367
Runtime API
3.10 Alarm functions

API functions

MSRTGetClassInfoPlus (Page 2421) Query alarm class information

See also
MSRTGetClassInfoPlus (Page 2421)
Overview of structures (Page 2350)

3.10.2.3 MSG_COMMENT_INSTANCE_STRUCT_PLUS

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];
WCHAR szInstance[MSG_MAX_INSTANCE+1];
}
MSG_COMMENT_INSTANCE_STRUCT_PLUS;

Members

stTime
Date/time

dwMsgNrLow
Less significant DWORD of 64-bit alarm number.

dwMsgNrHigh
More significant DWORD of 64-bit alarm number, generally set to 0L.

szText
Comment

szUser
User name

szComputerName
Computer name

WinCC Engineering V18 – Programming reference

2368 System Manual, 11/2022, Online documentation
 Runtime API
3.10 Alarm functions

szApplicationName
Application name

szInstance
Instance name

Comment
An alarm-specific comment is assigned to an alarm in the archive. This assignment is dependent
on the alarm number and the date/time of the alarm.
If a current time is needed for the passing of a SYSTEMTIME parameter, the GetLocalTime
function must be used and not GetSystemTime. There is generally a considerable time
difference between these two functions.

Required files
CCMSRTCLIPlus.h

API functions

MSRTGetCommentInstancePlus (Page 2457) Query comment text

MSRTSetCommentInstancePlus (Page 2459) Specify comment text

See also
MSRTSetCommentInstancePlus (Page 2459)
MSRTGetCommentInstancePlus (Page 2457)
Overview of structures (Page 2350)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2369
Runtime API
3.10 Alarm functions

3.10.2.4 MSG_CSDATA_STRUCT_PLUS

Declaration

typedef struct {
DWORD dwMsgNrLow;
DWORD dwMsgNrHigh;
DWORD dwStatus;
WORD wClass;
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
Less significant DWORD of 64-bit alarm number.

dwMsgNrHigh
More significant DWORD of 64-bit alarm number (generally set to 0L).

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.

WinCC Engineering V18 – Programming reference

2370 System Manual, 11/2022, Online documentation
 Runtime API
3.10 Alarm functions

wClass
Alarm class

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 is 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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2371
Runtime API
3.10 Alarm functions

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 2428) Query alarm configuration data

See also
MSRTGetMsgCSDataPlus (Page 2428)
DM_VARKEY (Page 1594)
Overview of structures (Page 2350)

3.10.2.5 MSG_CSDATA_EX_STRUCT_PLUS

Declaration

typedef struct {
DWORD dwMsgNrLow;
DWORD dwMsgNrHigh;
DWORD dwStatus;
WORD dwClass;
DWORD dwTextID[MSG_MAX_TB];
DWORD lpstrQuitVar;
WORD dwQuitBit;
DWORD lpstrStateVar;
WORD dwStateBit;
DWORD lpstrMsgVar;
WORD dwMsgBit;
WORD dwAGNr;
WORD dwAGSubNr;
DWORD dwGroupID;
DWORD dwPriority;
DWORD dwHidingMask;
}
MSG_CSDATA_STRUCT_PLUS;

WinCC Engineering V18 – Programming reference

2372 System Manual, 11/2022, Online documentation
 Runtime API
3.10 Alarm functions

Members

dwMsgNrLow
Less significant DWORD of 64-bit alarm number.

dwMsgNrHigh
More significant DWORD of 64-bit alarm number (generally set to 0L).

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

dwTextID
Reference to the text blocks

lpstrQuitVar
Acknowledgment tag (with server prefix, if not local).

dwQuitBit
Bit of acknowledgment tag

lpstrStateVar
Alarm status as tag (with server prefix, if not local).

dwStateBit
dwStateBit is used to specify which bits of lpstrStateVar define the alarm status.
If dwStateBit = 1 and lpstrStateVar is of data type "8 Bit unsigned", then Bit 1 of lpstrStateVar
specifies the incoming/outgoing status, and bit 5 specifies the need for acknowledgment.
If dwStateBit = 2 and lpstrStateVar is a word tag, then Bit 2 of lpstrStateVar specifies the
incoming/outgoing status, and bit 10 specifies the need for acknowledgment.

lpstrMsgVar
Alarm tag (with server prefix, if not local).

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2373
Runtime API
3.10 Alarm functions

dwMsgBit
Alarm tag bit

dwAGNr
PLC number

dwAGSubNr
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

MSRTGetMsgCSDataExPlus (Page 2432) Query configuration data of alarms from the speci‐
fied alarm server
MSG_CSDATA_EX_CALLBACK_PROC_PLUS Callback function for evaluation of configuration
(Page 2434) data

WinCC Engineering V18 – Programming reference

2374 System Manual, 11/2022, Online documentation
 Runtime API
3.10 Alarm functions

3.10.2.6 MSG_FILTER_STRUCT_PLUS

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];
WCHAR szInstance[MSG_MAX_INSTANCE+1];
}
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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2375
Runtime API
3.10 Alarm functions

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.
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.

dwMsgNrLow
dwMsgNrLow Less significant DWORD of 64-bit alarm number. Here, dwMsgNr[0] is the start
number (from) and dwMsgNr[1] is the end number (to).

dwMsgNrHigh
dwMsgHigh More significant DWORD of 64-bit alarm number (generally set to 0L).
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
List of utilized alarm classes in one-dimensional variant array. The alarm type (MsgType) is
not supported here. You determine the IDs of the alarm classes in the engineering system.

dwMsgState
Alarm status bit-coded.
Assign this field, if you use the filter criterion MSG_FILTER_STATE.

WinCC Engineering V18 – Programming reference

2376 System Manual, 11/2022, Online documentation
 Runtime API
3.10 Alarm functions

The following status values are checked using MSRTCheckWinFilter:

MSG_STATE_COME Incoming alarm

MSG_STATE_GO Outgoing alarm
MSG_STATE_QUIT Alarm acknowledged
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 64-bit 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).

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2377
Runtime API
3.10 Alarm functions

dwQuickSelect
The parameter is reserved for future development and must be preset to 0.

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 2451) Check alarm filter conditions

MSRTGetFilterDataPlus (Page 2450) Query alarm filter conditions
MSRTSetMsgFilterPlus (Page 2453) Set alarm filter
MSRTSetMsgWinFilterPlus (Page 2455) Set alarm filter for an alarm window
MSRTGetLastMsgWithCommentPlus (Page 2423) Query last archived alarm
MSRTStartMsgServicePlus (Page 2397) Start service

See also
MSRTGetLastMsgWithCommentPlus (Page 2423)
MSRTSetMsgWinFilterPlus (Page 2455)
MSRTStartMsgServicePlus (Page 2397)
MSRTSetMsgFilterPlus (Page 2453)
MSRTCheckWinFilterPlus (Page 2451)
MSRTGetFilterDataPlus (Page 2450)
Overview of structures (Page 2350)
MSGULONGLONG (Page 2396)

WinCC Engineering V18 – Programming reference

2378 System Manual, 11/2022, Online documentation
 Runtime API
3.10 Alarm functions

3.10.2.7 MSG_HELPTEXTS_STRUCT_PLUS

Declaration

typedef struct {
DWORD dwMsgNrLow;
DWORD dwMsgNrHigh;
DWORD dwLCID;
DWORD dwFlags;
DWORD dwResponseTime;
LPWSTR lpszHelp_Description;
DWORD dwHelp_DescriptionCount;
LPWSTR lpszHelp_Causes;
DWORD dwHelp_CausesCount;
LPWSTR lpszHelp_Action;
DWORD dwHelp_ActionCount;
LPWSTR lpszHelp_Consequence;
DWORD dwHelp_ConsequenceCount;
LPWSTR lpszHelp_Reserved;
DWORD dwHelp_ReservedCount;
}
MSG_HELPTEXTS_STRUCT_PLUS;

Members

dwMsgNrLow
Less significant DWORD of 64-bit alarm number. The number must be specified as an input
parameter.

dwMsgNrHigh
More significant DWORD of 64-bit alarm number (generally set to 0L). The number must be
specified as an input parameter.

dwLCID
The language ID for the language of the help texts of the alarm. The ID must be specified as
an input parameter.

dwFlags
If you have allocated a self-specified buffer, the USERALLOC_xxx flags are not changed and
not taken into account by the function.
If you have not specified a buffer and the buffer was allocated by the function, the
FUNCALLOC_xxx flags are set by the function.
If you have specified a buffer that is too small and the function has truncated the help text,
the TRUNCATE_xxx flags are set.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2379
Runtime API
3.10 Alarm functions

After the function is called and the help texts are processed, the user must release the
allocated buffers again. See also the definition in "MSRTAPI.H"

USERALLOC_HLPDESCRIPTION 0x000000 The user has allocated the buffer for the "Descrip‐
01 tion".
FUNCALLOC_HLPDESCRIPTION 0x000000 The function has allocated the buffer for the "De‐
02 scription".
USERALLOC_HLPCAUSES 0x000000 The user has allocated the buffer for the "Causes".
04
FUNCALLOC_HLPCAUSES 0x000000 The function has allocated the buffer for the "Cau‐
08 ses".
USERALLOC_HLPACTION 0x000000 The user has allocated the buffer for the "Action".
10
FUNCALLOC_HLPACTION 0x000000 The function has allocated the buffer for the "Ac‐
20 tion".
USERALLOC_HLPCONSEQUENCE 0x000000 The user has allocated the buffer for the "Conse‐
40 quence".
FUNCALLOC_HLPCONSEQUENCE 0x000000 The function has allocated the buffer for the "Con‐
80 sequence".
USERALLOC_HLPRESERVED 0x000001 Reserved for future use.
00
FUNCALLOC_HLPRESERVED 0x000002 Reserved for future use.
00
TRUNCATE_HLPDESCRIPTION 0x000100 Buffer for "Description" too small. The text was trun‐
00 cated.
TRUNCATE_HLPCAUSES 0x000200 Buffer for "Causes" too small. The text was truncated.
00
TRUNCATE_HLPACTION 0x000400 Buffer for "Action" too small. The text was truncated.
00
TRUNCATE_HLPCONSEQUENCE 0x000800 Buffer for "Consequence" too small. The text was
00 truncated.

You can OR these constants, provided they do not contradict each other.

dwResponseTime
The response time in seconds in which the alarm must be responded to is returned here.

lpszHelp_Description
Pointer to a text buffer for storage of the help text for "Description".
If "NULL" is set, the function sets the pointer to the internally allocated buffer for
"Description". "dwHelp_DescriptionCount" is set to the internal buffer size.

dwHelp_DescriptionCount
Size of buffer in number of characters.
If "0L" is set, the function sets the buffer size and stores a pointer in "lpszHelp_Description".

lpszHelp_Causes
Pointer to a text buffer for storage of the help text for "Causes".

WinCC Engineering V18 – Programming reference

2380 System Manual, 11/2022, Online documentation
 Runtime API
3.10 Alarm functions

If "NULL" is set, the function sets the pointer to the internally allocated buffer for
"Description". "dwHelp_CausesCount" is set to the internal buffer size.

dwHelp_CausesCount
Size of buffer in number of characters.
If "0L" is set, the function sets the buffer size and stores a pointer in "lpszHelp_Causes".

lpszHelp_Action
Pointer to a text buffer for storage of the help text for "Action".
If "NULL" is set, the function sets the pointer to the internally allocated buffer for
"Description". "dwHelp_ActionCount" is set to the internal buffer size.

dwHelp_Action
Size of buffer in number of characters.
If "0L" is set, the function sets the buffer size and stores a pointer in "lpszHelp_Action".

lpszHelp_Consequence
Pointer to a text buffer for storage of the help text for "Consequnce".
If "NULL" is set, the function sets the pointer to the internally allocated buffer for
"Description". "dwHelp_ConsequenceCount" is set to the internal buffer size.

dwHelp_ConsequenceCount
Size of buffer in number of characters.
If "0L" is set, the function sets the buffer size and stores a pointer in "lpszHelp_Consequence".

lpszHelp_Reserved
Reserved for future use.

dwHelp_Reserved
Reserved for future use.

Comment
By means of this structure, your application can use API functions to determine the configured
help texts for the specified language of a single message.

Required files
CCMSRTCLIPlus.h

API functions

MSRTGetMsgHelptextsPlus (Page 2436) Query configured help texts of an alarm

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2381
Runtime API
3.10 Alarm functions

3.10.2.8 MSG_INFOTEXT_STRUCT_PLUS

Declaration

typedef struct {
DWORD dwMsgNrLow;
DWORD dwMsgNrHigh;
WCHAR szText[MSG_MAX_TB_CONTENT+1];
}
MSG_INFOTEXT_STRUCT_PLUS;

Members

dwMsgNrLow
Less significant DWORD of 64-bit alarm number.

dwMsgNrHigh
More significant DWORD of 64-bit alarm number, generally set to 0L.

szText
Info text

Required files
CCMSRTCLIPlus.h

API functions

MSRTGetInfotextPlus (Page 2461) Query info text

MSRTSetInfotextPlus (Page 2462) Specify info text

See also
MSRTGetInfotextPlus (Page 2461)
MSRTSetInfotextPlus (Page 2462)
Overview of structures (Page 2350)

WinCC Engineering V18 – Programming reference

2382 System Manual, 11/2022, Online documentation
 Runtime API
3.10 Alarm functions

3.10.2.9 MSG_RTCREATE_STRUCT_PLUS

Declaration

typedef struct {
DWORD dwMsgState;
DWORD dwMsgNrLow;
DWORD dwMsgNrHigh;
DWORD dwFlags;
SYSTEMTIME stMsgTime;
double dPValue[MSG_MAX_PVALUE];
WORD wPValueUsed;
MSG_TEXTVAL256_STRUCT_PLUS mtTextValueW[MSG_MAX_PVALUE]
WORD wTextValueUsed;
}
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
Less significant DWORD of 64-bit alarm number.

dwMsgNrHigh
More significant DWORD of 64-bit alarm number (generally set to 0L).

dwFlags
Setting for time base. "MSG_TIMESTAMP_LOCAL" is valid by default. With
"MSG_TIMESTAMP_UTC" you can individually switch the function being used in each case
to "UTC".

MSG_TIMESTAMP_LOCAL Switches the time base to "LOCALTIME".

MSG_TIMESTAMP_UTC Switches the time base to "UTC".

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2383
Runtime API
3.10 Alarm functions

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.
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.

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 2395) type with the associated text
values.

wTextValueUsed
Text 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.

Required files
CCMSRTCLIPlus.h

API functions

MSRTCreateMsgInstanceWithCommentPlus Create alarm

(Page 2411)

See also
MSG_TEXTVAL256_STRUCT_PLUS (Page 2395)
Overview of structures (Page 2350)
MSRTCreateMsgInstanceWithCommentPlus (Page 2411)
MSRTCreateMsgPlus (Page 2415)

WinCC Engineering V18 – Programming reference

2384 System Manual, 11/2022, Online documentation
 Runtime API
3.10 Alarm functions

3.10.2.10 MSG_RTDATA_INSTANCE_STRUCT_PLUS

Declaration

typedef struct {
DWORD dwMsgState;
DWORD dwMsgNrLow;
DWORD dwMsgNrHigh;
SYSTEMTIME stMsgTime;
DWORD dwTimeDiff;
ULONGLONG ullCounter;
DWORD dwFlags;
WORD wPValueUsed;
WORD wTextValueUsed;
double dPValue[MSG_MAX_PVALUE];
MSG_TEXTVAL256_STRUCT_PLUS mtTextValue[MSG_MAX_PVALUE]
TCHAR szInstance[MSG_MAX_INSTANCE+1];
}
MSG_RTDATA_INSTANCE_STRUCT_PLUS;

Members

dwMsgState
Alarm status in compliance with the constants in the "m_global.h" file:
The statuses listed will only be used internally by the system and can only by set by the API
using MSRTCreateMsgInstancePlus.

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

dwMsgNrLow
Less significant DWORD of 64-bit alarm number.

dwMsgNrHigh
More significant DWORD of 64-bit alarm number (generally set to 0L).

stMsgTime
Date and time for coming-in or going-out of an alarm.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2385
Runtime API
3.10 Alarm functions

dwTimeDiff
Duration coming in or going out, telegram time in seconds.

ullCounter
Internal 64-bit 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 value
10.
MSG_RT_FLAG_TEXTREF1 0x10000000 Bit for text reference 1.
MSG_RT_FLAG_TEXTREF2 0x20000000 Bit for text reference 2.
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

WinCC Engineering V18 – Programming reference

2386 System Manual, 11/2022, Online documentation
 Runtime API
3.10 Alarm functions

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

Flags for setting the time base

MSG_TIMESTAMP_LOCAL Switches the time base to "LOCALTIME".
MSG_TIMESTAMP_UTC Switches the time base to "UTC".
"MSG_TIMESTAMP_LOCAL" is valid by default.

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.

wTextValueUsed
Text values used, bit-coded.
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.

dPValue
Process values.

mtTextValue
Structure of the MSG_TEXTVAL256_STRUCT_PLUS (Page 2395) type with the associated text
values.

szInstance
Instance name. If szInstance is not provided (empty string), a normal alarm is created

Required files
CCMSRTCLIPlus.h

API functions

MSRTCreateMsgInstancePlus (Page 2413) Create alarm

MSG_SERVICE_NOTIFY_PROC_PLUS (Page 2403) Send and receive service (callback)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2387
Runtime API
3.10 Alarm functions

See also
MSRTCreateMsgInstancePlus (Page 2413)
MSG_TEXTVAL256_STRUCT_PLUS (Page 2395)
MSGULONGLONG (Page 2396)

3.10.2.11 MSG_RTDATA_INSTANCECOMMENT_STRUCT_PLUS

Declaration

typedef struct {
DWORD dwMsgState;
DWORD dwMsgNrLow;
DWORD dwMsgNrHigh;
SYSTEMTIME stMsgTime;
DWORD dwTimeDiff;
DWORD ullCounter;
DWORD dwFlags;
WORD wPValueUsed;
WORD wTextValueUsed;
double dPValue[MSG_MAX_PVALUE];
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
Alarm status in compliance with the constants in the "m_global.h" file:
The statuses listed will only be used internally by the system and can only by set by the API
using MSRTCreateMsgInstanceWithCommentPlus.

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

WinCC Engineering V18 – Programming reference

2388 System Manual, 11/2022, Online documentation
 Runtime API
3.10 Alarm functions

MSG_STATE_HIDE_MANUAL Alarm hidden manually

MSG_STATE_UNHIDE_MANUAL Alarm displayed manually

dwMsgNrLow
Less significant DWORD of 64-bit alarm number.

dwMsgNrHigh
More significant DWORD of 64-bit alarm number (generally set to 0L).

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 64-bit 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 value
10.
MSG_RT_FLAG_TEXTREF1 0x10000000 Bit for text reference 1.
MSG_RT_FLAG_TEXTREF2 0x20000000 Bit for text reference 2.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2389
Runtime API
3.10 Alarm functions

Flags for alarms in the alarm view

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 Archive
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
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

Flags for setting the time base

MSG_TIMESTAMP_LOCAL Switches the time base to "LOCALTIME".
MSG_TIMESTAMP_UTC Switches the time base to "UTC".
"MSG_TIMESTAMP_LOCAL" is valid by default.

With the MSRTCreateMsgInstanceWithCommentPlus function, flags cannot be sent to the

alarm server. Flags are ignored.

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.

wTextValueUsed
Text values used, bit-coded.
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.

dPValue
Process values.

mtTextValue
Structure of the MSG_TEXTVAL256_STRUCT_PLUS (Page 2395) type with the associated text
values.

WinCC Engineering V18 – Programming reference

2390 System Manual, 11/2022, Online documentation
 Runtime API
3.10 Alarm functions

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.

Required files
CCMSRTCLIPlus.h

API functions

MSRTCreateMsgInstanceWithCommentPlus Create alarm

(Page 2411)
MSRTGetLastMsgWithCommentPlus (Page 2423) Query last archived alarm
MSG_SERVICE_NOTIFY_PROC_PLUS (Page 2403) Callback function

See also
MSRTCreateMsgInstanceWithCommentPlus (Page 2411)
MSRTGetLastMsgWithCommentPlus (Page 2423)
MSG_SERVICE_NOTIFY_PROC_PLUS (Page 2403)
MSRTGetSelectedMsgPlus (Page 2440)
MSRTCheckWinFilterPlus (Page 2451)
Overview of structures (Page 2350)
MSGULONGLONG (Page 2396)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2391
Runtime API
3.10 Alarm functions

3.10.2.12 MSG_RTGROUPENUM_STRUCT_PLUS

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 2446) List alarm group single alarms

MSG_SERVICE_NOTIFY_PROC_PLUS (Page 2403) Callback function

WinCC Engineering V18 – Programming reference

2392 System Manual, 11/2022, Online documentation
 Runtime API
3.10 Alarm functions

See also
MSG_SERVICE_NOTIFY_PROC_PLUS (Page 2403)
MSRTEnumGroupMsgPlus (Page 2446)
Overview of structures (Page 2350)

3.10.2.13 MSG_RTGROUPSET_STRUCT_PLUS

Declaration

typedef struct {
BOOL fIDUsed;
DWORD dwID;
WCHAR szName[MSG_MAX_TEXTLEN+1];
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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2393
Runtime API
3.10 Alarm functions

API functions

MSRTLockGroupPlus (Page 2447) Lock alarm group

MSRTEnumGroupMsgPlus (Page 2446) List single alarms of an alarm group
MSRTQuitGroupPlus (Page 2449) Acknowledge alarm group

See also
MSRTEnumGroupMsgPlus (Page 2446)
MSRTLockGroupPlus (Page 2447)
MSRTQuitGroupPlus (Page 2449)
Overview of structures (Page 2350)

3.10.2.14 MSG_RTLOCK_STRUCT_PLUS

Declaration

typedef struct {
WCHAR szName[MSG_MAX_TEXTLEN+1];
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

WinCC Engineering V18 – Programming reference

2394 System Manual, 11/2022, Online documentation
 Runtime API
3.10 Alarm functions

dwMsgLock
Locked single alarms

Required files
CCMSRTCLIPlus.h

API functions

MSG_SERVICE_NOTIFY_PROC_PLUS (Page 2403) Callback function

See also
MSG_SERVICE_NOTIFY_PROC_PLUS (Page 2403)
Overview of structures (Page 2350)

3.10.2.15 MSG_TEXTVAL256_STRUCT_PLUS

Declaration

typedef struct {
WCHAR szText[MSG_MAX_TEXTVAL256+1];
}
MSG_TEXTVAL256_STRUCT_PLUS;

Comment
The structure is used within the following structures:
• MSG_RTCREATE_STRUCT_PLUS (Page 2383)
• MSG_RTDATA_INSTANCE_STRUCT_PLUS (Page 2385)
• MSG_RTDATA_INSTANCECOMMENT_STRUCT_PLUS (Page 2388)

Members

szText
Text

Required files
CCMSRTCLIPlus.h

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2395
Runtime API
3.10 Alarm functions

API functions

MSRTCreateMsgInstanceWithCommentPlus (Page 2411) Create alarm

MSRTGetLastMsgWithCommentPlus (Page 2423) Query last pending alarm
MSG_SERVICE_NOTIFY_PROC_PLUS (Page 2403) Send and receive service (callback)

3.10.2.16 MSGULONGLONG

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
Less significant DWORD of 64-bit value. The two parameters dwLow and dwHigh combined
produce the 64-bit alarm number.

dwHigh
More significant DWORD of 64-bit value. The two parameters dwLow and dwHigh combined
produce the 64-bit alarm number.

dwdw.Low
see dwLow

dwdw.dwHigh
see dwHigh

ull
unsigned 64-bit value

WinCC Engineering V18 – Programming reference

2396 System Manual, 11/2022, Online documentation
 Runtime API
3.10 Alarm functions

cy
CURRENCY for COLEVariant handling

Required files
CCMSRTCLIPlus.h

API functions

MSG_FILTER_STRUCT_PLUS (Page 2375)

MSG_RTDATA_INSTANCE_STRUCT_PLUS (Page 2385)
MSG__RTDATA_INSTANCECOMMENT_STRUCT_PLUS (Page 2388)

3.10.3 General functions

3.10.3.1 MSRTStartMsgServicePlus

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
After successful call of the function, this parameter contains the service ID that is needed by
many functions.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2397
Runtime API
3.10 Alarm functions

lpszServer
Pointer to the symbolic name of the alarm server without server delimiter ::
If an empty string, NULL or "@default" is specified, the default server set will be used.
If an incorrect server name is specified, the configured standard server is used or the
MSG_ERR_API_SERVICE error is returned.

dwFlags
The parameter is reserved for later enhancements and must be preset to 0L.

dwFilterCount
Number of message filters in the pointer list lppMsgFilterPlus

lppMsgFilter
Pointer to a list of pointers to alarm filter structuresMSG_FILTER_STRUCT_PLUS (Page 2375).
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
MSG_TIMESTAMP_LOCAL Time base "LOCALTIME"
MSG_TIMESTAMP_UTC Time base "UTC"

lpfnNotifyProcPlus
Pointer to your callback function of type MSG_SERVICE_NOTIFY_PROCPlus for transfer of
alarms by the service.
With lpfnNotifyProcPlus = NULL the service will not return any notifications.

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.
In rare cases, the Notify may already be delivered before the function call has returned.

lpvUserNotify
Pointer to application-specific data. This pointer is not evaluated by the function but provided
again in the callback function.

WinCC Engineering V18 – Programming reference

2398 System Manual, 11/2022, Online documentation
 Runtime API
3.10 Alarm functions

lpfnTAIDProcPlus
Callback function for transfer of the status of execution of asynchronous functions.
The calls are marked with the respective TAIDs (TransactionIDs), which are allocated by the
respective asynchronous function calls. These enable assignment of the feedback messages.

lpvUserTAID
Pointer to application-specific data. This pointer is not evaluated by the function but provided
again in the callback function.

lpError
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
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

MSG_SERVICE_NOTIFY_PROC_PLUS (Page 2403) Callback function (data)
MSG_TAID_COMPLETION_PROC_PLUS (Page 2406) Callback function, asynchronous feedback messag‐
es with TAID

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2399
Runtime API
3.10 Alarm functions

See also
MSRTCreateMsgInstanceWithCommentPlus (Page 2411)
MSRTCreateMsgInstancePlus (Page 2413)
MSRTExportPlus (Page 2465)
MSRTEnumBackupListPlus (Page 2464)
MSRTGetInfotextPlus (Page 2461)
MSRTSetInfotextPlus (Page 2462)
MSRTGetClassInfoPlus (Page 2421)
MSRTSetMsgFilterPlus (Page 2453)
MSG_FILTER_STRUCT_PLUS (Page 2375)
MSRTGetMsgCSDataPlus (Page 2428)
MSRTCheckWinFilterPlus (Page 2451)
MSRTGetMsgPriorityPlus (Page 2437)
MSRTGetMsgQuitPlus (Page 2439)
MSRTGetSelectedMsgPlus (Page 2440)
MSRTResetMsgPlus (Page 2444)
MSRTLoopInAlarmPlus (Page 2442)
MSRTGetFilterDataPlus (Page 2450)
MSRTEnumArchivDataPlus (Page 2466)
MSRTStopMsgServicePlus (Page 2400)
MSRTSetCommentInstancePlus (Page 2459)
MSG_SERVICE_NOTIFY_PROC_PLUS (Page 2403)
MSRTQuitHornPlus (Page 2402)
MSRTGetCommentInstancePlus (Page 2457)
MSRTEnumGroupMsgPlus (Page 2446)
MSRTLockGroupPlus (Page 2447)
MSRTGetMsgActualPlus (Page 2427)
Overview of the functions (Page 2349)
MSRTGetMsgHelptextsPlus (Page 2436)

3.10.3.2 MSRTStopMsgServicePlus

Description
Stops the service for sending and receiving messages

WinCC Engineering V18 – Programming reference

2400 System Manual, 11/2022, Online documentation
 Runtime API
3.10 Alarm functions

Declaration

BOOL MSRTStopMsgServicePlus (
DWORD dwServiceID,
LPCMN_ERRORW lpError );

Parameters

dwServiceID
Identification number of the send and receive service, as returned when
MSRTStartMsgServicePlus is called.

lpError
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
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

MSG_ERR_RT_NOINIT Alarm system not initialized

Required files
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2401
Runtime API
3.10 Alarm functions

Related functions

MSRTStartMsgServicePlus (Page 2397) Start service

See also
MSRTEnumBackupListPlus (Page 2464)
MSRTStartMsgServicePlus (Page 2397)
Overview of the functions (Page 2349)

3.10.3.3 MSRTQuitHornPlus

Description
Class-specific central horn acknowledgement.

Declaration

BOOL MSRTQuitHornPlus(
DWORD dwServiceID,
LPDWORD lpdwTAID,
LPCMN_ERRORW lpError );

Parameters

dwServiceID
Identification number of the send and receive service, as returned when
MSRTStartMsgServicePlus is called.

lpdwTAID
Pointer to a DWORD in which the TAID (TransactionID) for asynchronous status feedback
message can be stored. If NULL is transferred, no MSG_TAID_COMPLETION_PROC_PLUS Notify
is called for this call.

lpError
Pointer to the data of the extended error message in the CMN_ERRORW structure. When an
error occurs, the system writes error information into this structure.

Return value

TRUE
Alarm acknowledged.

WinCC Engineering V18 – Programming reference

2402 System Manual, 11/2022, Online documentation
 Runtime API
3.10 Alarm functions

FALSE
Error

Error messages

MSG_ERR_API_PARAM Parameter invalid

Required files
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll

Related functions

MSRTStartMsgServicePlus (Page 2397) Start service

See also
MSRTStartMsgServicePlus (Page 2397)
Overview of the functions (Page 2349)

3.10.3.4 MSG_SERVICE_NOTIFY_PROC_PLUS

Description
Your callback function for send/receive service.
Enumeration functions of the alarm system run 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);

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2403
Runtime API
3.10 Alarm functions

Parameters

dwNotify
The notification type is specified by the constants in the "MSRTAPI.h" file:

General notifications lpbyData points to structure

MSG_NOTIFY_CONNECT Connection established -
MSG_NOTIFY_DISCONNECT Connection terminated -
MSG_NOTIFY_RESTART New alarm system runtime data -
MSG_NOTIFY_SHUTDOWN The alarm system will be stopped -
MSG_NOTIFY_MSGENUM Enumeration of the alarm list MSG_RTDATA_INSTANCE_STRUCT_PLUS (in blocks)
MSG_NOTIFY_ARCHIVENUM Enumeration of log alarm(s) MSG_RTDATA_INSTANCE_STRUCT_PLUS (in blocks)
MSG_NOTIFY_ARCHIVENU‐ Enumeration of log alarm(s) with MSG_RTDATA_INSTANCE_STRUCT_PLUS (in blocks)
MINST instances
MSG_NOTIFY_LOCKENUM Enumeration of locks MSG_RTGROUPENUM_STRUCT_PLUS (in blocks)
MSG_NOTIFY_WINENUM Alarm windows enumeration MSG_WIN_STRUCT_PLUS (in blocks)
MSG_NOTIFY_BACKUPENUM Enumeration of export list MSG_BACKUP_STRUCT_PLUS (in blocks)
MSG_NOTIFY_ARCDAYENUM Enumeration of day list MSG_ARCHIVDAY_STRUCT_PLUS
MSG_NOTIFY_ENUMMAX Enumeration was stopped at max‐ -
imum amount
MSG_NOTIFY_LANGUAGESET Language switched -

Single alarms lpbyData points to structure

MSG_NOTIFY_MSGADD New alarm added MSG_RTDATA_INSTANCE_STRUCT_PLUS (in blocks)
MSG_NOTIFY_MSGDELETE Alarm deleted MSG_RTDATA_INSTANCE_STRUCT_PLUS (in blocks)
MSG_NOTIFY_MSGMODIFY Alarm changed MSG_RTDATA_INSTANCE_STRUCT_PLUS (in blocks)
MSG_NOTIFY_MSGCOUNT Current number of alarms MSG_RTDATA_INSTANCE_STRUCT_PLUS (in blocks)

Alarm groups lpbyData points to structure

MSG_NOTIFY_GROUPENUM Enumeration of single alarms in an MSG_RTGROUPENUM_STRUCT_PLUS (in blocks)
alarm group

Locks of alarms lpbyData points to structure

MSG_NOTIFY_LOCKMODIFY Locks set, changed, deleted MSG_RTGROUPENUM_STRUCT_PLUS (in blocks)

Log alarms lpbyData points to structure

MSG_NOTIFY_ARCHIVADD Log alarm(s) added MSG_RTDATA_INSTANCE_STRUCT_PLUS (in blocks)
MSG_NOTIFY_ARCHIVDELETE Log alarm(s) deleted MSG_RTDATA_INSTANCE_STRUCT_PLUS (in blocks)

WinCC Engineering V18 – Programming reference

2404 System Manual, 11/2022, Online documentation
 Runtime API
3.10 Alarm functions

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 2385)
Alarm groups Single alarm data in structures of type
• MSG_RTGROUPENUM_STRUCT_PLUS (Page 2392)
Locks Lock data in structures of type
• MSG_RTLOCK_STRUCT_PLUS (Page 2394)
Log alarms Log data in structures of type
• MSG_RTDATA_INSTANCE_STRUCT_PLUS (Page 2385)

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
Pointer to application-specific data. This pointer is made available again in the callback
function.

Return value

TRUE
Notification was recognized and processed.

FALSE
Error

Comment

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
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.
In rare cases, the Notify may already be delivered before the function call has returned.

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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2405
Runtime API
3.10 Alarm functions

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

MSRTStartMsgServicePlus (Page 2397) Start service

See also
MSG_RTDATA_INSTANCE_STRUCT_PLUS (Page 2385)
MSG_RTGROUPENUM_STRUCT_PLUS (Page 2392)
MSG_RTLOCK_STRUCT_PLUS (Page 2394)
MSG_RTDATA_INSTANCECOMMENT_STRUCT_PLUS (Page 2388)
MSRTStartMsgServicePlus (Page 2397)
MSG_TEXTVAL256_STRUCT_PLUS (Page 2395)
MSRTEnumGroupMsgPlus (Page 2446)
Overview of the functions (Page 2349)

3.10.3.5 MSG_TAID_COMPLETION_PROC_PLUS

Description
Your callback function for feedback about the asynchronous execution status.
Enumeration functions of the alarm system run asynchronously. As a result, you must
synchronize the calls using semaphores. The TAID_COMPLETION_PROC described here
simplifies synchronization between the asynchronous functions.

Declaration

BOOL ( * MSG_TAID_COMPLETITION_PROC_PLUS) (
DWORD dwTAID,
DWORD dwTAIDNotify,
Variant* pvTAIDError,
LPVOID lpvUserTAID);

WinCC Engineering V18 – Programming reference

2406 System Manual, 11/2022, Online documentation
 Runtime API
3.10 Alarm functions

Parameters

dwTAID
The TAID (TransactionID) for assignment to a called asynchronous function.

dwTAIDNotify
State and status of the asynchronous function

Log alarms Value Description

MSG_TAIDCOMPLETION_NOTIFY_SUCCEEDED 0x00000000 Function completed without error
MSG_TAIDCOMPLETION_NOTIFY_INFO_RUN 0x00000001 Info: Function still running, additional notifies will fol‐
low
MSG_TAIDCOMPLETION_NOTIFY_INFO_READY 0x00000002 Info: Function is ready and completed
MSG_TAIDCOMPLETION_NOTIFY_WARN‐ 0x00000010 Warning: Function still running, but partial errors have
ING_RUN occurred
MSG_TAIDCOMPLETION_NOTIFY_WARN‐ 0x00000020 Warning: Function is ready and completed, but partial
ING_READY errors have occurred
MSG_TAIDCOMPLETION_NOTIFY_ERROR 0x00000100 Error: The function was aborted with error
MSG_TAIDCOMPLETION_NOTIFY_FATALERROR 0x00000200 Error: Fatal error, the server might have larger prob‐
lems, and further errors are likely to occur as a result

pvTAIDError
Pointer to a VARIANT. Generally of the type VT_BSTR which contains the TAID message about
the status.

lpvUserTAID
Pointer to application-specific data. This pointer is made available again within the callback
function.

Return value

TRUE
Notification was recognized and processed.

FALSE
Error

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2407
Runtime API
3.10 Alarm functions

Comment

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
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.
In rare cases, the Notify may already be delivered before the function call has returned.

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

MSRTStartMsgServicePlus (Page 2397) Start service

See also
MSRTStartMsgServicePlus (Page 2397)

3.10.3.6 MSRTWebClientPlus

Description
Initializes the DLL for a WebClient

Declaration

VOID WINAPI MSRTWebClientPlus(

LPCWSTR pszProjectPath,
DWORD dwDataLocale);

WinCC Engineering V18 – Programming reference

2408 System Manual, 11/2022, Online documentation
 Runtime API
3.10 Alarm functions

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

3.10.4.1 MSRTActivateMProtPlus

Description
Pause or continue report service for output of an alarm sequence report.

Declaration

BOOL MSRTActivateMProtPlus(
BOOL fActive,
LPCMN_ERROR lpError );

Parameters

fActive
Establishes how the report service should be handled:

TRUE Continue report service

FALSE Pause report service

lpError
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
Function successfully completed.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2409
Runtime API
3.10 Alarm functions

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

Description
Prints currently pending alarms of the alarm sequence report, even when a page is not yet full.

Declaration

BOOL MSRTPrintMProtPlus(
DWORD* pdwLines,
LPCMN_ERRORW lpError );

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
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
Current pending alarms printed.

FALSE
Error

WinCC Engineering V18 – Programming reference

2410 System Manual, 11/2022, Online documentation
 Runtime API
3.10 Alarm functions

Error messages

MSG_ERR_NOPROT Alarm sequence report inactive

Required files
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll

3.10.5 Functions for alarm processing

3.10.5.1 MSRTCreateMsgInstanceWithCommentPlus

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,
LPCMN_ERRORW lpError );

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

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2411
Runtime API
3.10 Alarm functions

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 2413) Create instance alarm

MSRTStartMsgServicePlus (Page 2397) Start service

See also
MSG_RTDATA_INSTANCECOMMENT_STRUCT_PLUS (Page 2388)
MSRTStartMsgServicePlus (Page 2397)
MSRTCreateMsgInstancePlus (Page 2413)

WinCC Engineering V18 – Programming reference

2412 System Manual, 11/2022, Online documentation
 Runtime API
3.10 Alarm functions

MSRTSetCommentInstancePlus (Page 2459)

MSG_TEXTVAL256_STRUCT_PLUS (Page 2395)
MSG_RTCREATE_STRUCT_PLUS (Page 2383)

3.10.5.2 MSRTCreateMsgInstancePlus

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,
LPCMN_ERRORW lpError );

Parameters

dwServiceID
ID of the installed service

lpMsgCreatePlus
Pointer to Createstruct to create the alarm
Use different time stamps for different messages.

lpdwTAID
Pointer to the TransactionID for asynchronous processing feedback

lpError
Pointer to the extended error structure

Return value

TRUE
Function successful

FALSE
Error

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2413
Runtime API
3.10 Alarm functions

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 Parameter invalid

MSG_ERR_API_SERVICE dwServiceID invalid

Required files
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll

Related functions

MSRTCreateMsgInstanceWithCommentPlus Create instance alarm with comments

(Page 2411)
MSRTStartMsgServicePlus (Page 2397) Start service

See also
MSRTCreateMsgInstanceWithCommentPlus (Page 2411)
MSRTStartMsgServicePlus (Page 2397)
MSG_RTDATA_INSTANCE_STRUCT_PLUS (Page 2385)
MSRTSetCommentInstancePlus (Page 2459)

WinCC Engineering V18 – Programming reference

2414 System Manual, 11/2022, Online documentation
 Runtime API
3.10 Alarm functions

3.10.5.3 MSRTCreateMsgPlus

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,
LPCMN_ERRORW lpError );

Parameters

dwServiceID
ID of the installed service

lpMsgCreatePlus
Pointer to Createstruct to create the alarm
Use different time stamps for different messages.

IpdwTAID
Pointer to the TransactionID for asynchronous processing

lpError
Pointer to the extended error structure

Return value

TRUE
Function successful

FALSE
Error

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2415
Runtime API
3.10 Alarm functions

Comment
The Create functions work asynchronously. As a result, you may have to synchronize the calls
using semaphores.

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 Parameter invalid

MSG_ERR_API_SERVICE dwServiceID invalid

Required files
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll

Related functions

MSRTCreateMsgInstanceWithCommentPlus Create instance alarm

(Page 2411)
MSRTCreateMsgInstancePlus (Page 2413) Create instance alarm with comments
MSRTStartMsgServicePlus (Page 2397) Start service

See also
MSRTCreateMsgInstanceWithCommentPlus (Page 2411)
MSRTCreateMsgInstancePlus (Page 2413)
MSRTStartMsgServicePlus (Page 2397)
MSG_RTCREATE_STRUCT_PLUS (Page 2383)

WinCC Engineering V18 – Programming reference

2416 System Manual, 11/2022, Online documentation
 Runtime API
3.10 Alarm functions

3.10.5.4 MSRTDialogMsgLockPlus

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,
LPCMN_ERRORW lpError );

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2417
Runtime API
3.10 Alarm functions

Parameters

hwndParent
Parent window, that contains the dialog.

lpError
Pointer to the data of the extended error message in the CMN_ERRORW structure. When an
error occurs, the system writes error information into this structure.

Return value

TRUE
Dialog successfully closed.

FALSE
Error or the dialog was canceled.

Error messages

MSG_ERR_API_PARAM Parameter invalid

Required files
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll

3.10.5.5 MSRTEnumArchivInstancePlus

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,
LPCMN_ERRORW lpError );

WinCC Engineering V18 – Programming reference

2418 System Manual, 11/2022, Online documentation
 Runtime API
3.10 Alarm functions

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.6 MSRTEnumLockedMsgPlus

Description
Enumerates all the locked alarms.
Enumeration functions work asynchronously. As a result, you must synchronize the calls
using semaphores.

Declaration

BOOL WINAPI MSRTEnumLockedMsgPlus(

DWORD dwServiceID,
LPDWORD lpdwTAID,
LPCMN_ERRORW lpError);

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2419
Runtime API
3.10 Alarm functions

Parameters

dwServiceID
ID of the installed service

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

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.
Enumeration functions work asynchronously. As a result, you must synchronize the calls
using semaphores.

Declaration

BOOL MSRTEnumMsgRTData(
DWORD dwServiceID,
LPDWORD pdwTAID
LPCMN_ERRORW lpError );

Parameters

dwServiceID
Identification number of the send and receive service, as returned when
MSRTStartMsgServicePlus is called.

WinCC Engineering V18 – Programming reference

2420 System Manual, 11/2022, Online documentation
 Runtime API
3.10 Alarm functions

lpdwTAID
Pointer to the TransactionID for asynchronous processing.

lpError
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
Alarms enumerated

FALSE
Error.

Error messages

MSG_ERR_API_PARAM Parameter invalid

MSG_ERR_API_SERVICE dwServiceID invalid

Required files
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll

Related functions

MSRTStartMsgServicePlus (Page 2397) Start service

See also
MSRTStartMsgServicePlus (Page 2397)

3.10.5.8 MSRTGetClassInfoPlus

Description
Get information about an alarm class.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2421
Runtime API
3.10 Alarm functions

Declaration

BOOL WINAPI MSRTGetClassInfoPlus(

DWORD dwServiceID,
LPCWSTR lpszServer,
DWORD dwMsgNrLow,
DWORD dwMsgNrHigh,
LPMSG_CLASS_STRUCT_PLUS lpClassPlus,
LPCMN_ERRORW lpError );

Parameters

dwServiceID
ID of the Service - service whose server is to be connected

lpszServer
Server prefix without ::
If an empty string or NULL is input the default server set will be used.

dwMsgNrLow
Alarm number of the lower DWORD

dwMsgNrHigh
Alarm number of the upper DWORD WinCC

lpClassPlus
Pointer that includes the information

lpError
Pointer that includes the extended error message

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.

WinCC Engineering V18 – Programming reference

2422 System Manual, 11/2022, Online documentation
 Runtime API
3.10 Alarm functions

Error messages

MSG_ERR_RT_NOINIT Alarm Logging RT is not initialized

MSG_ERR_API_PARAM Invalid parameter
MSG_ERR_MSG_NOEXIST Alarm does not exist

Required files
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll

Related functions

MSRTStartMsgServicePlus (Page 2397) Start service

See also
MSG_CLASS_STRUCT_PLUS (Page 2366)
MSRTStartMsgServicePlus (Page 2397)

3.10.5.9 MSRTGetLastMsgWithCommentPlus

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,
DWORD dwFilterCount,
LPMSG_RTDATA_INSTANCECOMMENT_STRUCT_PLUS lpMsg,
LPCMN_ERRORW lpError );

Parameters

lpszServer
Server prefix without '::'. If an empty string or NULL is input the default server set will be used.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2423
Runtime API
3.10 Alarm functions

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
Pointer to the data of the extended error message in the CMN_ERROR structure.

Return value

TRUE
Alarm queried.

FALSE
Error.

Error messages

MSG_ERR_API_PARAM Invalid parameter

MSG_ERR_RT_NOTCONNECTED Connection not made

Required files
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll

Related functions

MSRTGetMsgAttributesPlus (Page 2425) Querying the attributes of a message

WinCC Engineering V18 – Programming reference

2424 System Manual, 11/2022, Online documentation
 Runtime API
3.10 Alarm functions

See also
MSG_FILTER_STRUCT_PLUS (Page 2375)
MSG_RTDATA_INSTANCECOMMENT_STRUCT_PLUS (Page 2388)
MSG_TEXTVAL256_STRUCT_PLUS (Page 2395)

3.10.5.10 MSRTGetMsgAttributesPlus

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,
LPCMN_ERRORW lpError );

Parameters

lpszServer
Server prefix without ::
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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2425
Runtime API
3.10 Alarm functions

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
Pointer to the data of the extended error message in the CMN_ERROR structure.

Return value

TRUE
Message data queried.

FALSE
Error.

WinCC Engineering V18 – Programming reference

2426 System Manual, 11/2022, Online documentation
 Runtime API
3.10 Alarm functions

Error messages

MSG_ERR_API_PARAM Invalid parameter

MSG_ERR_RT_NOTCONNECTED Connection not made

Required files
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll

Related functions

MSRTGetLastMsgWithCommentPlus (Page 2423) Query last alarm

See also
MSG_FILTER_STRUCT_PLUS (Page 2375)

3.10.5.11 MSRTGetMsgActualPlus

Description
The function states the number of currently pending alarms in the alarm list.

Declaration

BOOL MSRTGetMsgActualPlus (
LPDWORD lpdwCount,
LPCMN_ERRORW lpError );

Parameters

lpdwCount
Pointer to a buffer in which the number of currently pending alarms is stored.

lpError
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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2427
Runtime API
3.10 Alarm functions

Return value

TRUE
Number stated.

FALSE
Error

Comment
The MSRTGetMsgActualPlus 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 MSRTGetMsgActualPlus is slowed.

Error messages

MSG_ERR_RT_NOINIT Alarm system not initialized

Required files
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll

Related functions

MSRTStartMsgServicePlus (Page 2397) Start service

See also
MSRTStartMsgServicePlus (Page 2397)

3.10.5.12 MSRTGetMsgCSDataPlus

Description
Query the configured data for an alarm.

WinCC Engineering V18 – Programming reference

2428 System Manual, 11/2022, Online documentation
 Runtime API
3.10 Alarm functions

Declaration

BOOL MSRTGetMsgCSDataPlus (
DWORD dwServiceNr,
LPCWSTR lpszServer,
DWORD dwMsgNrLow,
DWORD dwMsgNrHigh,
LPMSG_CSDATA_STRUCT_PLUS lpmCSDataPlus,
LPCMN_ERRORW lpError );

Parameters

dwServiceID
Identification number of the send and receive service, as returned when
MSRTStartMsgServicePlus is called.

lpszServer
Server prefix without ::
If an empty string or NULL is input the default server set will be used.

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 2370) structure.

lpError
Pointer to the data of the extended error message in the CMN_ERROR structure. The system
writes error information to this structure if an error occurs.

Return value

TRUE
Configuration data queried.

FALSE
Error

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2429
Runtime API
3.10 Alarm functions

Comment
The MSRTGetMsgCSDataPlus 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 MSRTGetMsgCSDataPlus is slowed.

Error messages

MSG_ERR_RT_NOINIT Alarm system not initialized

MSG_ERR_API_PARAM Parameter invalid
MSG_ERR_MSG_NOEXIST Alarm does not exist

Required files
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll

WinCC Engineering V18 – Programming reference

2430 System Manual, 11/2022, Online documentation
 Runtime API
3.10 Alarm functions

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.h"
#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

MSRTStartMsgServicePlus (Page 2397) Start service

See also
MSG_CSDATA_STRUCT_PLUS (Page 2370)
MSRTStartMsgServicePlus (Page 2397)
MSGULONGLONG (Page 2396)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2431
Runtime API
3.10 Alarm functions

3.10.5.13 MSRTGetMsgCSDataExPlus

Description
Query configuration data of an alarm from the specified alarm server. The function returns the
tag names including the server prefixes in the MSG_CSDATA_EX_STRUCT_PLUS structure.

Declaration

BOOL MSRTGetMsgCSDataExPlus (
DWORD dwServiceNr,
LPCWSTR lpszServer,
DWORD lpdwMsgNrLow,
DWORD lpdwMsgNrHigh,
DWORD dwMsgNrCount,
MSG_CSDATA_EX_CALLBACK_PROC_PLUS lpfnCSDataCallbackPlus,
LPVOID lpvUser,
LPCMN_ERRORW lpError );

Parameters

dwServiceID
Identification number of the send and receive service, as returned when
MSRTStartMsgServicePlus is called.

lpszServer
Pointer to the symbolic name of the alarm server without server delimiter ::
The alarm server specified here is only used when dwServiceID is supplied with 0L. If an
empty string or NULL is specified, the default server set will be used.

lpdwMsgNrLow
Pointer to DWORD list with less significant DWORD of 64-bit alarm numbers.

lpdwMsgNrHigh
Pointer to DWORD list with more significant DWORD of 64-bit alarm numbers (generally
occupied with 0L).

dwMsgNrCount
Number of alarm numbers in the list

lpfnCSDataCallbackPlus
Your callback function that receives the configuration data of the alarms.

lpvUser
Pointer to application-specific data. This pointer is not evaluated by the function but rather
provided again in the callback function.

WinCC Engineering V18 – Programming reference

2432 System Manual, 11/2022, Online documentation
 Runtime API
3.10 Alarm functions

lpError
Pointer to the data of the extended error message in the CMN_ERROR structure. The system
writes error information to this structure if an error occurs.

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 performance by performing a
MSRTStartMsgServicePlus beforehand and retaining it for all calls. In this case only the first call
of MSRTGetMsgCSDataPlus is slowed.

Error messages

MSG_ERR_RT_NOINIT Alarm system not initialized

MSG_ERR_API_PARAM Parameter invalid
MSG_ERR_MSG_NOEXIST Alarm does not exist

Required files
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2433
Runtime API
3.10 Alarm functions

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.h"
#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

MSG_CSDATA_EX_CALLBACK_PROC_PLUS Callback function

(Page 2434)
MSG_CSDATA_EX_STRUCT_PLUS (Page 2372) Structure of the configuration data

3.10.5.14 MSG_CSDATA_EX_CALLBACK_PROC_PLUS

Description
In order to evaluate the configuration data of alarms listed by the system, you must provide a
callback function of type MSG_CSDATA_EX_CALLBACK_PROC_PLUS

WinCC Engineering V18 – Programming reference

2434 System Manual, 11/2022, Online documentation
 Runtime API
3.10 Alarm functions

Declaration

BOOL ( * MSG_CSDATA_EX_CALLBACK_PROC_PLUS) (
DWORD dwIndex,
LPMSG_CSDATA_EX_STRUCT_PLUS lpmCSDataExPlus,
LPVOID lpvUser );

Parameters

dwIndex
Identification number of the send and receive service, as returned when
MSRTStartMsgServicePlus is called.

lpmsgCSDataExPlus
Pointer to a structure of type MSG_CSDATA_EX_STRUCT_PLUS (Page 2372) with the
configuration data of the alarm.

lpvUser
Pointer to application-specific data. This pointer is not evaluated by the function but rather
provided again in the callback function.

Comment
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 an alarm loop is accessed, for example: GetMessage
• Enumerations that call other enumerations
If a program registers a Notify routine, it must clear its alarm queue at regular intervals.
Unread messages could block WinCC notifications or finally block WinCC altogether.
The pointers to the tag names in the structure do not have to be enabled. That automatically
happens internally after return of the callback. Therefore, the pointers themselves cannot
be copied because they are invalid after the callback or end of function. If needed, the tag
names must be copied as a string.

Return value

TRUE
The enumeration is continued.

FALSE
The enumeration is discontinued.

Required files
CCMSRTCLIPlus.h

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2435
Runtime API
3.10 Alarm functions

Related functions

MSRTGetMsgCSDataExPlus (Page 2432) Query configuration data of alarms

3.10.5.15 MSRTGetMsgHelptextsPlus

Description
The function determines the configured help texts of an alarm from the specified alarm server.

Declaration

BOOL MSRTGetMsgHelptextsPlus(
DWORD dwServiceID;
LPCWSTR lpszServer,
LPMSG_HELPTEXTS_STRUCT_PLUS lpHelptexts,
LPCMN_ERROR lpError );

Parameters

dwServiceID
Service ID of "MSRTStartMsgServicePlus" or "0L".
When the service ID is specified, this ID has precedence and the corresponding alarm server
of the associated "MSRTStartMsgServicePlus" is used.

lpszServer
Pointer to the symbolic name of the alarm server without server delimiter "::", "NULL" or
empty string.
The alarm server specified here is only used when "dwServiceID" is supplied with "0L".

lpHelptexts
Pointer to a structure of type MSG_HELPTEXTS_STRUCT_PLUS (Page 2379), in which the help
texts "ResponseTime", "Description", "Causes", "Action", "Consequence" are returned.

lpError
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
The configured help texts were queried.

WinCC Engineering V18 – Programming reference

2436 System Manual, 11/2022, Online documentation
 Runtime API
3.10 Alarm functions

FALSE
Error

Comment
The MSRTGetMsgHelptextsPlus 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 MSRTGetMsgPriorityPlus is slowed.
You have the option of specifying your own fixed or allocated text buffer for each help
text in which the help texts are stored. "lpszHelp_xxx" and "dwHelp_xxx" then both have
to be specified. If "NULL" is specified for "lpszHelp_xxx" "and/or "0L" for "dwHelp_xxx", the
"MSRTGetMsgHelptextsPlus" function itself allocates the text buffers and also enters this in
the "lpHelptexts" structure. After call up, this can be evaluated using the "dwFlags"

Error messages

MSG_ERR_API_PARAM Invalid parameter

MSG_ERR_MSG_NOEXIST Runtime not initialized
MSG_ERR_RT_NOINIT Alarm does not exist

Required files
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll

Related functions

MSRTStartMsgServicePlus (Page 2397) Start service

3.10.5.16 MSRTGetMsgPriorityPlus

Description
Query the priority of the given alarm.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2437
Runtime API
3.10 Alarm functions

Declaration

BOOL MSRTGetMsgPriorityPlus (
DWORD dwServiceID,
LPCWSTR lpszServer,
DWORD dwMsgNrLow,
DWORD dwMsgNrHigh,
long* plPriority,
LPCMN_ERRORW lpError );

Parameters

dwServiceID
Identification number of the send and receive service, as returned when
MSRTStartMsgService is called.

lpszServer
Server prefix without ::
If an empty string or NULL is input the default server set will be used.

dwMsgNrLow
dwMsgNrLow Number of the first alarm

dwMsgNrHigh
dwMsgHigh Number of the last alarm

plPriority
Pointer to a tag of the long data type, in which the priority is stored.
This parameter must not be NULL!

lpError
Pointer to the data of the extended error message in the CMN_ERRORW structure. When an
error occurs, the system writes error information into this structure.

Return value

TRUE
Priority queried.

FALSE
Error

WinCC Engineering V18 – Programming reference

2438 System Manual, 11/2022, Online documentation
 Runtime API
3.10 Alarm functions

Comment
The MSRTGetMsgPriorityPlus 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 MSRTGetMsgPriorityPlus is slowed.

Error messages

MSG_ERR_RT_NOINIT Alarm system not initialized

MSG_ERR_API_PARAM Parameter invalid
MSG_ERR_MSG_NOEXIST Alarm does not exist

Required files
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll

Related functions

MSRTStartMsgServicePlus (Page 2397) Start service

See also
MSRTStartMsgServicePlus (Page 2397)

3.10.5.17 MSRTGetMsgQuitPlus

Description
Query the number of alarms that require acknowledgement.

Declaration

BOOL MSRTGetMsgQuitPlus(
LPDWORD lpdwCount,
LPCMN_ERRORW lpError );

Parameters

lpdwCount
Pointer for the number of alarms that require acknowledgement

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2439
Runtime API
3.10 Alarm functions

lpError
Pointer to the data of the extended error message in the CMN_ERRORW structure. When an
error occurs, the system writes error information into this structure.

Return value

TRUE
Number stated.

FALSE
Error

Comment
The MSRTGetMsgPriorityPlus 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 MSRTGetMsgPriorityPlus is slowed.

Error messages

MSG_ERR_RT_NOINIT Alarm system not initialized

Required files
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll

Related functions

MSRTStartMsgServicePlus (Page 2397) Start service

See also
MSRTStartMsgServicePlus (Page 2397)

3.10.5.18 MSRTGetSelectedMsgPlus

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.

WinCC Engineering V18 – Programming reference

2440 System Manual, 11/2022, Online documentation
 Runtime API
3.10 Alarm functions

In individual or multiple-station 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,
LPCMN_ERROR lpError );

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 2388)
type, in which the alarm number is returned.

lpError
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
Data queried.

FALSE
Error

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2441
Runtime API
3.10 Alarm functions

Comment
The MSRTGetMsgPriorityPlus 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 MSRTGetMsgPriorityPlus is slowed.

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

MSG_ERR_API_PARAM Invalid parameter

Required files
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll

Related functions

MSRTStartMsgServicePlus (Page 2397) Start service

Examples
Get selected Msg "MS02.cpp"

See also
MSG_RTDATA_INSTANCECOMMENT_STRUCT_PLUS (Page 2388)
MSRTStartMsgServicePlus (Page 2397)

3.10.5.19 MSRTLoopInAlarmPlus

Description
API function for loop-in-alarm The alarm number is decisive.

WinCC Engineering V18 – Programming reference

2442 System Manual, 11/2022, Online documentation
 Runtime API
3.10 Alarm functions

Declaration

BOOL MSRTLoopInAlarmPlus(
DWORD dwServiceID,
LPCWSTR lpszServer,
DWORD dwMsgNrLow,
DWORD dwMsgNrHigh,
LPCMN_ERRORW lpError );

Parameters

dwServiceID
ID of the Service - service whose server is to be connected

lpszServer
Server prefix without ::
If an empty string or NULL is input the default server set will be used.

dwMsgNrLow
Alarm number of the lower DWORD

dwMsgNrHigh
Alarm number of the upper DWORD WinCC

lpError
Pointer that includes the extended error message

Return value

TRUE
Function successful

FALSE
Error

Error messages

MSG_ERR_API_PARAM Invalid parameter

MSG_ERR_MSG_NOEXIST Alarm does not exist

Required files
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2443
Runtime API
3.10 Alarm functions

CCMSRTCLIPlus.dll

Related functions

MSRTStartMsgServicePlus (Page 2397) Start service

See also
MSRTStartMsgServicePlus (Page 2397)

3.10.5.20 MSRTResetMsgPlus

Description
The stated alarm will be acknowledged.

Declaration

BOOL MSRTResetMsgPlus(
DWORD dwServiceID,
DWORD dwMsgNrLow,
DWORD dwMsgNrHigh,
LPDWORD lpdwTAID
LPCMN_ERRORW lpError );

Parameters

dwServiceID
Identification number of the send and receive service, as returned when
MSRTStartMsgService is called.

dwMsgNrLow
dwMsgNrLow Number of the first alarm

dwMsgNrHigh
dwMsgHigh Number of the last alarm
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
Pointer to the TransactionID for asynchronous processing.

WinCC Engineering V18 – Programming reference

2444 System Manual, 11/2022, Online documentation
 Runtime API
3.10 Alarm functions

lpError
Pointer to the data of the extended error message in the CMN_ERRORW structure. When an
error occurs, the system writes error information to this structure.

Return value

TRUE
Alarm acknowledged.

FALSE
Error

Comment

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_RT_NOINIT Alarm system not initialized

MSG_ERR_API_PARAM Parameter invalid
MSG_ERR_MSG_NOEXIST Alarm does not exist
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

MSRTStartMsgServicePlus (Page 2397) Start service

See also
MSRTStartMsgServicePlus (Page 2397)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2445
Runtime API
3.10 Alarm functions

3.10.6 Functions for alarm group processing

3.10.6.1 MSRTEnumGroupMsgPlus

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,
LPCMN_ERRORW lpError );

Parameters

dwServiceID
ID of the Service - service

lpmGroupPlus
Pointer to the alarm group info

IpdwTAID
Pointer to the TransactionID for asynchronous processing feedback

lpError
Pointer that includes the extended error message

Return value

TRUE
Function successful

FALSE
Error

WinCC Engineering V18 – Programming reference

2446 System Manual, 11/2022, Online documentation
 Runtime API
3.10 Alarm functions

Required files
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll

Related functions

MSG_SERVICE_NOTIFY_PROC_PLUS (Page 2403) Callback function

MSRTStartMsgServicePlus (Page 2397) Start service
MSG_RTGROUPENUM_STRUCT_PLUS (Page 2392) Single alarms of an alarm group

See also
MSG_RTGROUPSET_STRUCT_PLUS (Page 2393)
MSRTStartMsgServicePlus (Page 2397)
MSG_SERVICE_NOTIFY_PROC_PLUS (Page 2403)
MSG_RTGROUPENUM_STRUCT_PLUS (Page 2392)

3.10.6.2 MSRTLockGroupPlus

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
LPCMN_ERRORW lpError );

Parameters

dwServiceID
ID of the service returned with the call of MSRTStartMsgServicePlus.

lpmGroupPlus
Pointer to the MSG_RTGROUPSET_STRUCT_PLUS (Page 2393) structure with information on
the alarm groups.
Lock: dwData != 0; enable: dwData = 0

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2447
Runtime API
3.10 Alarm functions

pdwTAID
Pointer to the transaction ID for asynchronous processing feedback message

lpError
Pointer to the data of the extended error message in the CMN_ERRORW structure. When an
error occurs, the system writes error information into this structure.

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

MSG_ERR_RT_NOINIT Alarm system not initialized

MSG_ERR_API_PARAM Parameter invalid
MSG_ERR_API_SERVICE dwServiceID invalid

Required files
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll

Related functions

MSRTStartMsgServicePlus (Page 2397) Start service

See also
MSG_RTGROUPSET_STRUCT_PLUS (Page 2393)
MSRTStartMsgServicePlus (Page 2397)
Overview of the functions (Page 2349)

WinCC Engineering V18 – Programming reference

2448 System Manual, 11/2022, Online documentation
 Runtime API
3.10 Alarm functions

3.10.6.3 MSRTQuitGroupPlus

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
LPCMN_ERRORW lpError );

Parameters

dwServiceID
ID of the service returned with the call of MSRTStartMsgServicePlus.

lpmGroupPlus
Pointer to a structure of the MSG_RTGROUPSET_STRUCT_PLUS (Page 2393) type with
information of the alarm groups.
Lock: dwData != 0; enable: dwData = 0

pdwTAID
Pointer to the transaction ID for asynchronous processing feedback message

lpError
Pointer to the data of the extended error message in the CMN_ERRORW structure. When an
error occurs, the system writes error information into this structure.

Return value

TRUE
Alarms in the alarm group are acknowledged.

FALSE
Error

Required files
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2449
Runtime API
3.10 Alarm functions

CCMSRTCLIPlus.dll

See also
MSG_RTGROUPSET_STRUCT_PLUS (Page 2393)

3.10.7 Functions for alarm filter processing

3.10.7.1 MSRTGetFilterDataPlus

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,
LPCMN_ERRORW lpError );

Parameters

dwServiceID
ID of the Service - service

lpszName
Alarm view name. You assign the name in the alarm view properties.

lppMsgFilterPlus
Pointer to array filter pointer to filter structures

lpdwFilterCount

lpError
Pointer that includes the extended error message

WinCC Engineering V18 – Programming reference

2450 System Manual, 11/2022, Online documentation
 Runtime API
3.10 Alarm functions

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_PARAM Invalid parameter

MSG_ERR_API_SERVICE dwServiceID invalid
MSG_ERR_API_NODATA No data

Required files
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll

Related functions

MSRTSetMsgFilterPlus (Page 2453) Set alarm filter

MSRTStartMsgServicePlus (Page 2397) Start service

See also
MSG_FILTER_STRUCT_PLUS (Page 2375)
MSRTStartMsgServicePlus (Page 2397)
MSRTSetMsgFilterPlus (Page 2453)

3.10.7.2 MSRTCheckWinFilterPlus

Description
Tests if the stated alarm corresponds to a filter parameter.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2451
Runtime API
3.10 Alarm functions

Declaration

BOOL MSRTCheckWinFilterPlus (
DWORD dwServiceID,
LPCWSTR lpszServer,
LPMSG_RTDATA_INSTANCECOMMENT_STRUCT_PLUS lpMsgRTPlus,
LPMSG_FILTER_STRUCT_PLUS* lppMsgFilter,
DWORD dwFilterCount,
LPWORD lpwReturn,
LPCMN_ERRORW lpError );

Parameters

dwServiceID
ID of the service returned with the call of MSRTStartMsgServicePlus.

lpszServer
Server prefix without ::
If an empty string or NULL is input the default server set will be used.

lpMsgRTPlus
Pointer to a structure of the MSG_RTDATA_INSTANCECOMMENT_STRUCT_PLUS (Page 2388)
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
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
Testing will be performed.

FALSE
Error

WinCC Engineering V18 – Programming reference

2452 System Manual, 11/2022, Online documentation
 Runtime API
3.10 Alarm functions

Error messages

MSG_ERR_API_PARAM Parameter invalid

Required files
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll

Related functions

MSRTStartMsgServicePlus (Page 2397) Start service

See also
MSG_FILTER_STRUCT_PLUS (Page 2375)
MSRTStartMsgServicePlus (Page 2397)
MSG_RTDATA_INSTANCECOMMENT_STRUCT_PLUS (Page 2388)

3.10.7.3 MSRTSetMsgFilterPlus

Description
Resets the filter for the specified service.

Declaration

BOOL WINAPI MSRTSetMsgFilterPlus(

DWORD dwServiceID,
LPMSG_FILTER_STRUCT_PLUS* lppMsgFilterPlus,
DWORD dwFilterCount,
LPCMN_ERRORW lpError );

Parameters

dwServiceID
Identification number of the send and receive service, as returned when
MSRTStartMsgServicePlus is called.

lppMsgFilterPlus
Pointer to ARRAY pointer for filter conditions

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2453
Runtime API
3.10 Alarm functions

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

MSG_ERR_API_PARAM Invalid parameter

MSG_ERR_API_SERVICE dwServiceID invalid

Required files
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll

Related functions

MSRTStartMsgServicePlus Start service

(Page 2397)
MSRTGetFilterDataPlus Read selection criteria of the alarm view
(Page 2450)

See also
MSRTStartMsgServicePlus (Page 2397)
MSG_FILTER_STRUCT_PLUS (Page 2375)
MSRTGetFilterDataPlus (Page 2450)

WinCC Engineering V18 – Programming reference

2454 System Manual, 11/2022, Online documentation
 Runtime API
3.10 Alarm functions

3.10.7.4 MSRTSetMsgWinFilterPlus

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,
DWORD dwFilterCount,
LPCMN_ERRORW lpError );

Parameters

lppMsgFilterPlus
Pointer to a structure of the MSG_FILTER_STRUCT_PLUS (Page 2375) type with the alarm filter
data. The name of the filter structure is the same as the window name.

dwFilterCount
Number of filters

lpError
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
Filter was set

FALSE
Error

Error messages

MSG_ERR_API_PARAM Parameter invalid

MSG_ERR_API_SERVICE dwServiceID invalid

See also
MSG_FILTER_STRUCT_PLUS (Page 2375)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2455
Runtime API
3.10 Alarm functions

3.10.8 Functions for processing alarm view

3.10.8.1 MSRTMsgWinCommandPlus

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,
LPCMN_ERROR lpError );

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
(autoscroll must not be activated)
MSG_TB_MSGNEXT Move to next alarm
(autoscroll must not be activated)

WinCC Engineering V18 – Programming reference

2456 System Manual, 11/2022, Online documentation
 Runtime API
3.10 Alarm functions

MSG_TB_MSGPREV Move to previous alarm

(autoscroll must not be activated)
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
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
Control function executed

FALSE
Error

Comment
All opened alarm views with the specified name execute the control function.

Error messages

MSG_ERR_API_PARAM Parameter invalid

Required files
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll

3.10.9 Functions for processing comments

3.10.9.1 MSRTGetCommentInstancePlus

Description
Gets the comment text for a logged alarm.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2457
Runtime API
3.10 Alarm functions

Declaration

BOOL MSRTGetCommentInstancePlus (
DWORD dwServiceID,
LPMSG_COMMENT_INSTANCE_STRUCT_PLUS lpmCommentPlus,
LPCMN_ERRORW lpError );

Parameters

dwServiceID
Identification number of the send and receive service, as returned when
MSRTStartMsgServicePlus is called.

lpmCommentPlus
Pointer to a MSG_COMMENT_INSTANCE_STRUCT_PLUS (Page 2368) 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
error occurs, the system writes error information into this structure.

Return value

TRUE
Comment text determined.
If no comment exists, the call returns TRUE, but the szText element is empty.

FALSE
Error

Error messages

MSG_ERR_API_PARAM Parameter invalid

MSG_ERR_API_SERVICE dwServiceID invalid

WinCC Engineering V18 – Programming reference

2458 System Manual, 11/2022, Online documentation
 Runtime API
3.10 Alarm functions

Required files
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll

Related functions

MSRTStartMsgServicePlus (Page 2397) Start service

See also
MSRTStartMsgServicePlus (Page 2397)
MSG_COMMENT_INSTANCE_STRUCT_PLUS (Page 2368)

3.10.9.2 MSRTSetCommentInstancePlus

Description
Specifies the comment text for a logged alarm.

Declaration

Bool MSRTSetCommentInstancePlus (
DWORD dwServiceID,
LPMSG_COMMENT_INSTANCE_STRUCT_PLUS lpmCommentPlus,
DWORD* pdwTAID,
LPCMN_ERRORW lpError );

Parameters

dwServiceID
ID of the service returned with the call of MSRTStartMsgServicePlus.

lpmCommentPlus
Pointer to a MSG_COMMENT_INSTANCE_STRUCT_PLUS (Page 2368) 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
Pointer to the transaction ID for asynchronous processing feedback message

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2459
Runtime API
3.10 Alarm functions

lpError
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
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

MSG_ERR_API_PARAM Parameter invalid

MSG_ERR_API_SERVICE dwServiceID invalid

Required files
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll

Related functions

MSRTStartMsgServicePlus (Page 2397) Start service

MSRTCreateMsgInstanceWithCommentPlus Create alarm
(Page 2411)
MSRTCreateMsgInstancePlus (Page 2413) Create alarm

WinCC Engineering V18 – Programming reference

2460 System Manual, 11/2022, Online documentation
 Runtime API
3.10 Alarm functions

See also
MSG_COMMENT_INSTANCE_STRUCT_PLUS (Page 2368)
MSRTStartMsgServicePlus (Page 2397)
MSRTCreateMsgInstanceWithCommentPlus (Page 2411)
MSRTCreateMsgInstancePlus (Page 2413)

3.10.10 Functions for info text processing

3.10.10.1 MSRTGetInfotextPlus

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,
LPCMN_ERRORW lpError );

Parameters

dwServiceID
ID of the Service - service

lpmInfotext
Pointer of the info text structure

lpError
Pointer that includes the extended error message

Return value

TRUE
Function successful

FALSE
Error

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2461
Runtime API
3.10 Alarm functions

Error messages

MSG_ERR_API_PARAM Invalid parameter

MSG_ERR_API_SERVICE dwServiceID invalid

Required files
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll

Related functions

MSRTStartMsgServicePlus (Page 2397) Start service

See also
MSG_INFOTEXT_STRUCT_PLUS (Page 2382)
MSRTStartMsgServicePlus (Page 2397)

3.10.10.2 MSRTSetInfotextPlus

Description
Sets the info text for an alarm.

Declaration

BOOL WINAPI MSRTSetInfotextPlus(

DWORD dwServiceID,
LPMSG_INFOTEXT_STRUCT_PLUS lpmInfotextPlus,
DWORD* lpdwTAID,
LPCMN_ERRORW lpError );

Parameters

dwServiceID
ID of the Service - service

lpmInfotextPlus
Pointer of the info text structure

WinCC Engineering V18 – Programming reference

2462 System Manual, 11/2022, Online documentation
 Runtime API
3.10 Alarm functions

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

MSG_ERR_API_PARAM Invalid parameter

MSG_ERR_API_SERVICE dwServiceID invalid

Required files
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll

Related functions

MSRTStartMsgServicePlus (Page 2397) Start service

See also
MSG_INFOTEXT_STRUCT_PLUS (Page 2382)
MSRTStartMsgServicePlus (Page 2397)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2463
Runtime API
3.10 Alarm functions

3.10.11 Archiving functions

3.10.11.1 MSRTEnumBackupListPlus

Description
Lists the entries of the export file for the sequential archive.

Declaration

BOOL MSRTEnumBackupListPlus (
DWORD dwServiceID,
LPCMN_ERROR lpError );

Parameters

dwServiceID
Identification number of the send and receive service, as returned when
MSRTStartMsgServicePlus is called.

lpError
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
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 2364) structure.

WinCC Engineering V18 – Programming reference

2464 System Manual, 11/2022, Online documentation
 Runtime API
3.10 Alarm functions

Error messages

MSG_ERR_API_PARAM Parameter invalid

MSG_ERR_API_SERVICE dwServiceID invalid

Required files
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll

Related functions

MSRTStartMsgServicePlus (Page 2397) Start service

MSG_SERVICE_NOTIFY_PROC_PLUS (Page 2403) Callback function

See also
MSG_BACKUP_STRUCT_PLUS (Page 2364)
MSRTStartMsgServicePlus (Page 2397)
MSG_SERVICE_NOTIFY_PROC_PLUS (Page 2403)

3.10.11.2 MSRTExportPlus

Description
Exports alarms from the circular log and the related log backup files.

Declaration

BOOL MSRTExportPlus (
DWORD dwServiceID,
LPMSG_BACKUP_STRUCT_PLUS lpMsgBackup,
LPCMN_ERRORW lpError );

Parameters

dwServiceID
Identification number of the send and receive service, as returned when
MSRTStartMsgServicePlus is called.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2465
Runtime API
3.10 Alarm functions

lpMsgBackup
Pointer to a structure of the MSG_BACKUP_STRUCT_PLUS (Page 2364) type.

lpError
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
Alarms exported.

FALSE
Error

Error messages

MSG_ERR_API_PARAM Parameter invalid

MSG_ERR_API_SERVICE dwServiceID invalid

Required files
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll

Related functions

MSRTStartMsgServicePlus (Page 2397) Start service

See also
MSRTStartMsgServicePlus (Page 2397)
MSG_BACKUP_STRUCT_PLUS (Page 2364)

3.10.11.3 MSRTEnumArchivDataPlus

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.

WinCC Engineering V18 – Programming reference

2466 System Manual, 11/2022, Online documentation
 Runtime API
3.10 Alarm functions

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
LPCMN_ERROR lpError );

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
error occurs, the system writes error information into this structure.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2467
Runtime API
3.10 Alarm functions

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

MSG_SERVICE_NOTIFY_PROC_PLUS (Page 2403) Callback function

MSRTStartMsgServicePlus (Page 2397) Start service

See also
MSG_SERVICE_NOTIFY_PROC_PLUS (Page 2403)
MSRTStartMsgServicePlus (Page 2397)
Overview of the functions (Page 2349)

WinCC Engineering V18 – Programming reference

2468 System Manual, 11/2022, Online documentation
 Runtime API
3.11 Functions for displaying the PLC code

3.11 Functions for displaying the PLC code

3.11.1 Display in STEP 7

3.11.1.1 Basics

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 2470)
OpenTIAPortalIECPLByCall (Page 2471)
OpenTIAPortalIECPLByAssignment (Page 2474)
OpenTIAPortalS7GraphByBlock (Page 2476)
Example: Integration in a WinCC function (Page 2478)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2469
Runtime API
3.11 Functions for displaying the PLC code

3.11.1.2 OpenTIAPortalProject

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,
LPCMN_ERROR lpdmError);

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", …);

WinCC Engineering V18 – Programming reference

2470 System Manual, 11/2022, Online documentation
 Runtime API
3.11 Functions for displaying the PLC code

lpszErrorTag
Name of an internal WinCC tag of the String data type. The error information is returned in
lpszErrorTag (Page 2493) when asynchronous functions that do not provide instant results
are called.

lpdmError
Pointer to the data of the extended error message in the CMN_ERROR structure. The system
writes error information to this structure if an error occurs.

Return value

TRUE
The function has been completed without any errors.

FALSE
An error has occurred.

Required files
kopapi.h
kopapi.lib
kopapi.dll

See also
Basics (Page 2469)

3.11.1.3 OpenTIAPortalIECPLByCall

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 lpszTiaPortalProjectPath,
LPCTSTR lpszCpuName,
LPCTSTR lpszContainingBlock,
LPCTSTR lpszCalledBlock,
LPCTSTR lpszPin,
LPCTSTR lpszErrorTag,
LPCMN_ERROR lpdmError);

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2471
Runtime API
3.11 Functions for displaying the PLC code

Parameters

dwFlags
Bit array in which the individual values are ORed bit-by-bit. dwFlags should be 0 by default.
• 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.

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", …);

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".

WinCC Engineering V18 – Programming reference

2472 System Manual, 11/2022, Online documentation
 Runtime API
3.11 Functions for displaying the PLC code

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
Name of an internal WinCC tag of the String data type. The error information is returned in
lpszErrorTag (Page 2493) when asynchronous functions that do not provide instant results
are called.

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
The function has been completed without any errors.

FALSE
An error has occurred.

Required files
kopapi.h
kopapi.lib
kopapi.dll

See also
Basics (Page 2469)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2473
Runtime API
3.11 Functions for displaying the PLC code

3.11.1.4 OpenTIAPortalIECPLByAssignment

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 lpszTiaPortalProjectPath,
LPCTSTR lpszCpuName,
LPCTSTR lpszContainingBlock,
LPCTSTR lpszOperand,
LPCTSTR lpszErrorTag,
LPCMN_ERROR lpdmError);

Parameters

dwFlags
Bit array in which the individual values are ORed bit-by-bit. dwFlags should be 0 by default.
• 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.

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", …);

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.

WinCC Engineering V18 – Programming reference

2474 System Manual, 11/2022, Online documentation
 Runtime API
3.11 Functions for displaying the PLC code

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.

lpszOperand
Name of a local or global operand to which an assignment is made.
Name of the local or global instance that is called in the code block belonging to
lpszContainingBlock.
• 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
Name of an internal WinCC tag of the String data type. The error information is returned in
lpszErrorTag (Page 2493) when asynchronous functions that do not provide instant results
are called.

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
The function has been completed without any errors.

FALSE
An error has occurred.

Required files
kopapi.h
kopapi.lib
kopapi.dll

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2475
Runtime API
3.11 Functions for displaying the PLC code

See also
Basics (Page 2469)

3.11.1.5 OpenTIAPortalS7GraphByBlock

Description
The function is used for the S7 Graph languages and shows a step in a sequencer.

Declaration

BOOL OpenTIAPortalS7GraphByBlock (
DWORD dwFlags,
LPCTSTR lpszTiaPortalProjectPath,
LPCTSTR lpszCpuName,
LPCTSTR lpszBlock,
DWORD dwStepNumber,
LPCTSTR lpszErrorTag,
LPCMN_ERROR lpdmError);

Parameters

dwFlags
Bit array in which the individual values are ORed bit-by-bit. dwFlags should be 0 by default.
• 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 0x00000008L: 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", …);

lpszCpuName
Name of the S7 CPU. The name is identical to the station name displayed in the project tree
in the TIA Portal.

lpszBlock
Instance name of the S7 Graph block to be displayed.

WinCC Engineering V18 – Programming reference

2476 System Manual, 11/2022, Online documentation
 Runtime API
3.11 Functions for displaying the PLC code

dwStepNumber
Number of the step to be displayed
dwStepNumber=0 automatically searches for the active step and enables "Track active step"
mode.

lpszErrorTag
Name of an internal WinCC tag of the String data type. The error information is returned in
lpszErrorTag (Page 2493) when asynchronous functions that do not provide instant results
are called.

lpdmError
Pointer to the data of the extended error message in the CMN_ERROR structure. The system
writes error information to this structure if an error occurs.

Return value

TRUE
The function has been completed without any errors.

FALSE
An error has occurred.

Required files
kopapi.h
kopapi.lib
kopapi.dll

See also
Basics (Page 2469)

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2477
Runtime API
3.11 Functions for displaying the PLC code

3.11.1.6 Example: Integration in a WinCC function

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 = "PLC_Name"; // TODO: read from internal tag
char* pContainingBlock = "Block_IDB"; // TODO: get from current selection
char* pOperand = "OUT"; // 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 2469)

WinCC Engineering V18 – Programming reference

2478 System Manual, 11/2022, Online documentation
 Runtime API
3.11 Functions for displaying the PLC code

3.11.2 Display in the PLC code display

3.11.2.1 Basics

General information
You can use these functions to display the current program status of PLC programs in a PLC code
view.
The screen containing the PLC code view must have been opened via ActivateScreen(), 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 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 it. Example: "Line1.Cell1.Station1". Names that do not contain
special characters must not be put in quotation marks.

See also
OpenViewerIECPLByCall (Page 2482)
OpenViewerIECPLByAssignment (Page 2488)
OpenViewerS7GraphByBlock (Page 2479)

3.11.2.2 OpenViewerS7GraphByBlock

Description
The function displays in the PLC language, S7 Graph, a step called from a sequencer in the PLC
code view.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2479
Runtime API
3.11 Functions for displaying the PLC code

Declaration

BOOL OpenViewerS7GraphByBlock (
DWORD dwFlags,
LPCTSTR lpszServerPrefix,
LPCTSTR lpszPictureName,
LPCTSTR lpszObjectName,
LPCTSTR lpszCpuName,
LPCTSTR lpszBlock,
DWORD dwStepNumber,
LPCMN_ERROR lpdmError);

Parameter

dwFlags
Bit array in which the individual values are ORed bit-by-bit.

Note
To display hierarchical comments, bit 0x4 has to be set.

lpszServerPrefix
The parameter is reserved for later upgrades.

lpszPictureName
Name of the screen with the PLC code view.

lpszObjectName
Name of the PLC code view.

lpszCpuName
Name of the S7 CPU. The name is identical to the station name displayed in the project tree
in the TIA Portal. No commas are permitted in the name.

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
Pointer to the data of the extended error message in the CMN_ERROR structure. The system
writes error information to this structure if an error occurs.

WinCC Engineering V18 – Programming reference

2480 System Manual, 11/2022, Online documentation
 Runtime API
3.11 Functions for displaying the PLC code

Return value

TRUE
The function has been completed without any errors.

FALSE
An error has occurred.

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;
}

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2481
Runtime API
3.11 Functions for displaying the PLC code

See also
Error-handling (Page 2493)
Basics (Page 2479)

3.11.2.3 OpenViewerIECPLByCall

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
view. To display the value in the PLC code view 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 lpszCpuName,
LPCTSTR lpszContainingBlock,
LPCTSTR lpszCalledBlock,
LPCTSTR lpszPin,
LPCMN_ERROR lpdmError);

Parameter

dwFlags
Bit array in which the individual values are ORed bit-by-bit.

Note
To display hierarchical comments, bit 0x4 has to be set.

• 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.

WinCC Engineering V18 – Programming reference

2482 System Manual, 11/2022, Online documentation
 Runtime API
3.11 Functions for displaying the PLC code

lpszServerPrefix
The parameter is reserved for later upgrades.

lpszPictureName
Name of the screen with the PLC code view.

lpszObjectName
Name of the PLC code view.

lpszCpuName
Name of the S7 CPU. The name is identical to the station name displayed in the project tree
in the TIA Portal. No commas are permitted in the name.

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 multi-instance
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 it. 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.

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 view.

lpdmError
Pointer to the data of the extended error message in the CMN_ERROR structure. The system
writes error information to this structure if an error occurs.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2483
Runtime API
3.11 Functions for displaying the PLC code

Return value

TRUE
The function has been completed without any errors.

FALSE
An error has occurred.

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, error.dwError3, error.dwError4, error.dwError5,
error.szErrorText);
}
return result;
}

WinCC Engineering V18 – Programming reference

2484 System Manual, 11/2022, Online documentation
 Runtime API
3.11 Functions for displaying the PLC code

See also
Error-handling (Page 2493)
Basics (Page 2479)

3.11.2.4 OpenViewerIECPLByFCCall

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 while taking the UDT instance into
consideration.

Note
If the input is occupied by a constant (TRUE, FALSE), this value is not displayed in the PLC code
view. To display the value in the PLC code view correctly, you should allocate a tag to the input
that has the appropriate value.

Declaration

BOOL OpenViewerIECPLByFCCall (
DWORD dwFlags,
LPCTSTR lpszServerPrefix,
LPCTSTR lpszPictureName,
LPCTSTR lpszObjectName,
LPCTSTR lpszCpuName,
LPCTSTR lpszContainingBlock,
LPCTSTR lpszCalledBlock,
LPCTSTR lpszPin,
LPCTSTR lpszUdtInstance
LPCMN_ERROR lpdmError);

Parameters

dwFlags
Bit array in which the individual values are ORed bit-by-bit.

Note
To display hierarchical comments, bit 0x4 has to be set.

• 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.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2485
Runtime API
3.11 Functions for displaying the PLC code

lpszServerPrefix
The parameter is reserved for future development and must be an empty string ("").

lpszPictureName
Name of the screen with the PLC code view.

lpszObjectName
Name of the PLC code view.

lpszCpuName
Name of the S7 CPU. The name is identical to the station name displayed in the project tree
in the TIA Portal. No commas are permitted in the name.

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 multi-instance
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 it. 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.

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 view.

lpszUdtInstance
The parameter is used to limit the display of FBs or FCs called multiple times. The limitation is
based on an UDT instance interconnected to a given input pin or inout pin.

WinCC Engineering V18 – Programming reference

2486 System Manual, 11/2022, Online documentation
 Runtime API
3.11 Functions for displaying the PLC code

lpdmError
Pointer to the data of the extended error message in the CMN_ERROR structure. The system
writes error information to this structure if an error occurs.

Return value

TRUE
The function has been completed without any errors.

FALSE
An error has occurred.

Required files
kopapi.h
kopapi.lib
kopapi.dll

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2487
Runtime API
3.11 Functions for displaying the PLC code

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 OpenCodeViewerByFCCall(BOOL matchSubstringPin, char* screenName,

char* objectName, char* cpuName, char* containingBlock, char* calledBlock,
char* pinName, char* udtInstance)
{
#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 = OpenViewerIECPLByFCCall(dwFlags, serverPrefix, screenName,
objectName, cpuName, containingBlock, calledBlock, pinName, udtInstance,
&error);
if(!result)
{
// there are only few reasons why the call to OpenViewerIECPLByFCCall 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
control
printf("OpenViewerIECPLByFCCall 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;
}

3.11.2.5 OpenViewerIECPLByAssignment

Description
The function is used for the LAD and FBD languages and shows the assignment of an operand
and its preceding logic in the PLC code view.

WinCC Engineering V18 – Programming reference

2488 System Manual, 11/2022, Online documentation
 Runtime API
3.11 Functions for displaying the PLC code

Declaration

BOOL OpenViewerIECPLByAssignment (
DWORD dwFlags,
LPCTSTR lpszServerPrefix,
LPCTSTR lpszPictureName,
LPCTSTR lpszObjectName,
LPCTSTR lpszCpuName,
LPCTSTR lpszContainingBlock,
LPCTSTR lpszOperand,
LPCMN_ERROR lpdmError);

Parameter

dwFlags
Bit array in which the individual values are ORed bit-by-bit.

Note
To display hierarchical comments, bit 0x4 has to be set.

lpszServerPrefix
The parameter is reserved for later upgrades.

lpszPictureName
Name of the screen with the PLC code view.

lpszObjectName
Name of the PLC code view.

lpszCpuName
Name of the S7 CPU. The name is identical to the station name displayed in the project tree
in the TIA Portal. No commas are permitted in the name.

lpszContainingBlock
Name of the block to be opened and displayed or name of the instance of an FB.
The following can be used as names:
• 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 multi-instance
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 it. Example: "Line1.Cell1.Station1"
• Name of an FC or OB

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2489
Runtime API
3.11 Functions for displaying the PLC code

The use of the name of a FB is not allowed.

lpszOperand
Name of a local or global operand to which an assignment is made.
Name of the local or global instance that is called in the code block belonging to
lpszContainingBlock. For global operands, the global name without hash sign # must be
specified.
The following restrictions apply to operands:
• Tags from the "TEMP" area cannot be used
• Input tags cannot be used
• Static tags are only allowed in FBs
• Networks within an FC can only be displayed if no local tags are used within the network
• Networks within an FB that use tags from the "TEMP" area cannot be displayed
If lpszOperand is written several times within lpszContainingBlock or its FB, the entry point is
always the first write access of lpszOperand.

lpdmError
Pointer to the data of the extended error message in the CMN_ERROR structure. The system
writes error information to this structure if an error occurs.

Return value

TRUE
The data was transferred to the PLC code view. Error messages such as "Operand not
supported" or "Operand not found" are output in the PLC code view and cannot be queried
via the function.

FALSE
An error has occurred.

Required files
kopapi.h
kopapi.lib
kopapi.dll

WinCC Engineering V18 – Programming reference

2490 System Manual, 11/2022, Online documentation
 Runtime API
3.11 Functions for displaying the PLC code

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 OpenCodeViewerByAssignment(char* screenName, char* objectName, char*

cpuName, char* containingBlock, char* operand)
{
#pragma code("kopapi.dll")
#include "kopapi.h"
#pragma code()
BOOL result;
CMN_ERROR error;
char* serverPrefix = "";
DWORD dwFlags = 0;
result = OpenViewerIECPLByAssignment(dwFlags, serverPrefix, screenName,
objectName, cpuName, containingBlock, operand, &error);
if(!result)
{
// there are only few reasons why the call to OpenViewerIECPLByAssignment
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("OpenViewerIECPLByAssignment 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 2493)
Basics (Page 2479)

3.11.2.6 IsJumpableProDiagAlarm

Core message
The function returns a Boolean value.
The Boolean value contains the information on whether a jump to the PLC code of the
selected alarm is possible.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2491
Runtime API
3.11 Functions for displaying the PLC code

Definition

BOOL WINAPI IsJumpableProDiagAlarm (

LPCSTR screenName,
LPCSTR objectName,
long id,
LPCMN_ERRORA lpdmError)

Parameters

screenName
Pointer to the data of the screen in which the relevant object is configured.

objectName
Pointer to the data with the name of the respective object (alarm)

id
Number of the alarm in the alarm list, not the ID of the alarm.
If several alarms are selected, the value is"0".

lpdmError
Pointer to the data of the extended error message in the CMN_ERROR structure. The system
writes error information to this structure if an error occurs.

Return value

TRUE
The jump to the PLC code of the selected alarm is possible.

FALSE
The jump to the PLC code of the selected alarm is not possible.

Required files
kopapi.h
kopapi.lib
kopapi.dll

WinCC Engineering V18 – Programming reference

2492 System Manual, 11/2022, Online documentation
 Runtime API
3.11 Functions for displaying the PLC code

Example
The example shows the embedding of the function call in a user-defined C function, which is
started when an alarm is selected in the alarm view.

#include "GlobalDefinitions.h"
void OnSelectedIdChanged(char* screenName, char* objectName, long id) {
#pragma code("KOPAPI.dll")
#include "kopapi.h"
#pragma code()
CMN_ERROR errorStruct;
BOOL bResult;

bResult = IsJumpableProDiagAlarm ( screenName, objectName, id,

&errorStruct);
SetPropBOOL ( screenname, "Button_Jump", "Enabled", bResult);
}

3.11.3 Error-handling

General information
Execution of the functions for the network entry is divided in a synchronous part and an
asynchronous part. The synchronous part checks the parameters and transfers them to the
asynchronous part.
The return value of the functions specifies whether an error has occurred in the
asynchronous section of the function. If an error has occurred, the return value is FALSE.
Such errors occur when parameters, for example, the lpszErrorTag parameter is not supplied
or incorrectly supplied.
Errors that occur in the asynchronous functions are reported through the lpszErrorTag
parameter. Such errors include: Project not found, block not available, ... lpszErrorTag
contains the name of a tag of the String data type. In order to respond to the return value,
you have to configure a function that is triggered with the cycle "To change" at a value
change of the error tags. The error tag should also be used to prevent further function calls
or the operation of a button, for example, as long as the error tag has the value "RUNNING".

lpszErrorTag
Name of a tag of the String data type. If the tag is not required, NULL can be transferred as the
parameter. If required, the tag name can include a ServerPrefix.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2493
Runtime API
3.11 Functions for displaying the PLC code

The value of the error tag is changed as follows:

• When the asynchronous part is started, the value of the error tag is set to "RUNNING".
• When the asynchronous part is completed without an error, the value of the error tag is set
to "OK".
• When the asynchronous part was terminated with an error, the error tag contains a multi-line
string whose lines are separated by a linefeed character ('\n').
In the case of an error, the error tag has the following structure:
• Line 1: "ERROR"
• Line 2 - Line 6: Decimal numbers, data type: 32 bits unsigned; DWORD
• Line 7: Error text

Error text
When the asynchronous part was terminated with an error, the error tag contains a multi-line
string whose lines are separated by a linefeed character ('\n'). The seventh line contains one of
the following error texts:

IDS_E_IS_TIA_PROJECT KOPAPI: This function cannot be used in a TIA

Portal project!
IDS_E_NO_TIA_PROJECT KOPAPI: The function call is disabled because
no TIA Portal project is open!
IDS_E_TIAPORTAL_UNKNOWN_FLAGS dwFlags contains an unknown value.
IDS_E_TIAPORTAL_ERRORTAG_NOT_EXIST The error tag [%s] does not exist.
IDS_E_TIAPORTAL_PREVIOUS_CALL_IS_RUNNING The previous call is still running (RUNNING).
Please terminate it first.
IDS_E_TIAPORTAL_CANNOT_WRITE_ERRORTAG The error tag [%s] cannot be written.
IDS_E_TIAPORTAL_COMACCESS_REGISTERPS_FAILED No connection to TIA Portal possible.
IDS_E_TIAPORTAL_CANNOT_START_PORTAL TIA Portal cannot be started.
IDS_E_TIAPORTAL_CANNOT_SEARCH_STARTED_PORTAL A search for a started Portal is not possible.
IDS_E_TIAPORTAL_NO_PORTAL_STARTED A Portal could not be started.
IDS_E_TIAPORTAL_EXCEPTION_SYNC_PART Exception in synchronous processing part.
IDS_E_TIAPORTAL_EXCEPTION_ASYNC_PART Exception in asynchronous processing part.
IDS_E_TIAPORTAL_NOT_INSTALLED No TIA Portal installed.
IDS_E_TIAPORTAL_PROJECT_CANNOT_OPEN Project [%s] cannot be opened.
IDS_E_TIAPORTAL_ALREADY_OPENED_WITH_OTH‐ TIA Portal is opened with another project.
ER_PROJECT
IDS_E_TIAPORTAL_CREATECOMMAND CreateCommand error.
IDS_E_TIAPORTAL_COMMAND_ADDARGUMENT Command AddArgument error.
IDS_E_TIAPORTAL_EXECUTECOMMAND Serious error in ExecuteCommand.
IDS_E_TIAPORTAL_COMMAND_ERROR TIA project command error: [%s,%ld].
IDS_E_TIAPORTAL_COMMAND_UNKNOWN TIA project unknown command: [%s,%ld].

WinCC Engineering V18 – Programming reference

2494 System Manual, 11/2022, Online documentation
 Runtime API
3.12 Functions for displaying the PLC code in an external application

3.12 Functions for displaying the PLC code in an external application

3.12.1 Basics

Introduction
WinCC provides a library that allows you to display PLC code from Runtime in an external
application. Information about networks or values pending at block interfaces is returned in
"XML" format.
The FBD and LAD programming languages are supported. The table below shows the
instructions supported by the respective programming language:

Instruction FBD LAD

Contact No Yes
NegContact No Yes
Coil Yes Yes
NegCoil Yes Yes
RCoil Yes Yes
SCoil Yes Yes
PinCoil Yes Yes
OR Yes Yes
AND Yes No
XOR Yes No
NOT No Yes

If other instructions are contained in networks, an error is returned in XML in the section
"NetworkHeaderInfo".

Recommended development environment

Siemens recommends using the following development environment:
• MS Visual Studio 2012
• Technology: COM object

Requirements
The following requirements apply in order to be able to display PLC code using the application
programmed in MS Visual Studio:
• The application is on the PC on which Runtime has been started.
• An HMI connection between HMI and PLC is configured.
• The PLC is in RUN - required for querying dynamic data.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2495
Runtime API
3.12 Functions for displaying the PLC code in an external application

Procedure
Querying data is carried out in three steps:
1. Calling static information
In this step, you use the "RequestByAssignment" or "RequestByCall" functions to obtain
information about available networks
2. Dynamic information
In this step, you call information about the current flow or pending states for one of the
determined networks.
3. Responding to events (optional)
State changes in the PLC
– Change to the user program
– Connection to PLC interrupted
– Connection to PLC restored
These state changes are provided via the interface "IPlcCodeViewerExternalClientCB" using
the "OnEvent" method:
HRESULT OnEvent( [in] PlcCodeViewerExternalClientEvent event );

Implementation in MS Visual Studio 2012

Implement the functions for accessing the interface "IPlcCodeViewerExternalClientAccess" in
the following order:
1. Initialize
2. SetLanguage
3. RequestByAssignment | RequestByCall
4. CancelRequest
5. Terminate

See also
Structure of the XML data (Page 2505)

WinCC Engineering V18 – Programming reference

2496 System Manual, 11/2022, Online documentation
 Runtime API
3.12 Functions for displaying the PLC code in an external application

3.12.2 Querying static information of networks

3.12.2.1 Initialize

Description
The function initializes the interface.

Note
The use of the function "InitializeEx" is recommended for version V16. The "serverString"
parameter is no longer needed with the new version.

Declaration

HRESULT Initialize( [in] IPlcCodeViewerExternalClientCB* pCallback,

[in] BSTR serverString);

Parameters

IPlcCodeViewerExternalClientCB
Implements the interface which provides the methods for querying network information.

serverString
Name of the PC on which Runtime is running.

Return value
-

See also
Terminate (Page 2504)

3.12.2.2 InitializeEx

Description
The function initializes the interface.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2497
Runtime API
3.12 Functions for displaying the PLC code in an external application

Declaration

HRESULT InitializeEx( [in] IPlcCodeViewerExternalClientCB* pCallback);

Parameters

IPlcCodeViewerExternalClientCB
Implements the interface which provides the methods for querying network information.

Return value
-

See also
Terminate (Page 2504)

3.12.2.3 SetLanguage

Description
The function defines the language in which comments of tags of a network are output in the
XML file.

Declaration

HRESULT SetLanguage( [in] BSTR language);

Parameters

language
Defines the language. Use the "Culture Name" as notation from the following reference:
National Language Support (NLS) API Reference (https://msdn.microsoft.com/de-de/goglobal/
bb896001.aspx)
Another language must always be specified for hierarchical comments, and only the
hierarchical comments of this language are output.
If there are no comments in the specified language, other comments will be output in one of
the following languages:
1. German (de-DE)
2. English (en-US or en-GB)
3. If you do not define a language, the comments are output in all available languages.

WinCC Engineering V18 – Programming reference

2498 System Manual, 11/2022, Online documentation
 Runtime API
3.12 Functions for displaying the PLC code in an external application

Return value
-

3.12.2.4 RequestByAssignment

Description
The function shows the assignment to an operand and its preceding logic. All networks in which
the operand is written are output.

Note
This function is a legacy function with which you can call simple comments.

Declaration

HRESULT RequestByAssignement( [in] BSTR PLCName,

[in] BSTR ContainingBlock,
[in] BSTR OperandName,
[out] unsigned long* RequestId);

Parameters

PLCName
Name of the PLC whose user program contains the block. The name is identical to the station
name displayed in the project tree in the TIA Portal.

ContainingBlock
Name of the block to be displayed or name of the instance of an FB.
The following can be used as names:
• 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 multi-instance
name paths are specified, these are data hierarchies such as those displayed in the DB editor,
and not the call structure. The first part of the name ("Line1") does not have to be enclosed
in quotation marks, because it is clear from the context that this is a global icon. Quotation
marks are required for the individual name components when special characters such as
spaces, dots, etc., occur in it. Example: "Line1.Cell1.Station1"
• Name of an FC or OB

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2499
Runtime API
3.12 Functions for displaying the PLC code in an external application

OperandName
Name of the block to be searched for in the code block belonging to "ContainingBlock".
• For local operands, the hash sign # must be specified here.

Return value
ID with which the request is uniquely identified. The ID is generated and returned with the call
of the function.

See also
RequestByCall (Page 2501)
StartDynamicDataSubscription (Page 2508)
CancelRequest (Page 2504)

3.12.2.5 RequestByAssignmentEx

Description
The function shows the assignment to an operand and its preceding logic. All networks in which
the operand is written are output. The function returns hierarchical comments.

Declaration

HRESULT RequestByAssignementEx( [in] BSTR PLCName,

[in] BSTR ContainingBlock,
[in] BSTR OperandName,
[out] unsigned long* RequestId);

Parameters

PLCName
Name of the PLC whose user program contains the block. The name is identical to the station
name displayed in the project tree in the TIA Portal.

ContainingBlock
Name of the block to be displayed or name of the instance of an FB.

WinCC Engineering V18 – Programming reference

2500 System Manual, 11/2022, Online documentation
 Runtime API
3.12 Functions for displaying the PLC code in an external application

The following can be used as names:

• 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 multi-instance
name paths are specified, these are data hierarchies such as those displayed in the DB editor,
and not the call structure. The first part of the name ("Line1") does not have to be enclosed
in quotation marks, because it is clear from the context that this is a global icon. Quotation
marks are required for the individual name components when special characters such as
spaces, dots, etc., occur in it. Example: "Line1.Cell1.Station1"
• Name of an FC or OB

OperandName
Name of the block to be searched for in the code block belonging to "ContainingBlock".
• For local operands, the hash sign # must be specified here.

Return value
ID with which the request is uniquely identified. The ID is generated and returned with the call
of the function.

See also
RequestByCallEx (Page 2503)
StartDynamicDataSubscriptionEx (Page 2509)
CancelRequest (Page 2504)

3.12.2.6 RequestByCall

Description
The function displays the preceding logic of a network input of a standard block. All networks
which contain the input pin are returned.

Note
This function is a legacy function with which you can call simple comments.

Declaration

HRESULT RequestByCall( [in] BSTR PLCName,

[in] BSTR ContainingBlock,
[in] BSTR CalledBlock,
[in] BSTR PinName,
[in] boolean PartialPinNameMatch,
[out] unsigned long* RequestId);

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2501
Runtime API
3.12 Functions for displaying the PLC code in an external application

Parameters

PLCName
Name of the PLC whose user program contains the block. The name is identical to the station
name displayed in the project tree in the TIA Portal.

ContainingBlock
Name of the block to be displayed or name of the instance of an FB.

CalledBlock
Name of the FB or FC which is called in the network of "ContainingBlock". Alternatively, you
can also configure a DB or a multi-instance.
The following can be used as names:
• 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 multi-instance
name paths are specified, these are data hierarchies such as those displayed in the DB editor,
and not the call structure. The first part of the name ("Line1") does not have to be enclosed
in quotation marks, because it is clear from the context that this is a global icon. Quotation
marks are required for the individual name components when special characters such as
spaces, dots, etc., occur in it. Example: "Line1.Cell1.Station1"
• Name of an FC or OB

PinName
Name of an input pin of "CalledBlock". The parameter is used to ensure that the network
interconnected to the input pin is contained in the XML data.

PartialPinNameMatch
TRUE if input pins which begin with the name specified under "PinName" are also to be taken
into consideration.

Return value
ID with which the request is uniquely identified. The ID is generated and returned with the call
of the function.

See also
RequestByAssignment (Page 2499)
StartDynamicDataSubscription (Page 2508)
CancelRequest (Page 2504)

WinCC Engineering V18 – Programming reference

2502 System Manual, 11/2022, Online documentation
 Runtime API
3.12 Functions for displaying the PLC code in an external application

3.12.2.7 RequestByCallEx

Description
The function displays the preceding logic of a network input of a standard block. All networks
which contain the input pin are returned. The function returns hierarchical comments.

Declaration

HRESULT RequestByCallEx( [in] BSTR PLCName,

[in] BSTR ContainingBlock,
[in] BSTR CalledBlock,
[in] BSTR PinName,
[in] boolean PartialPinNameMatch,
[out] unsigned long* RequestId);

Parameters

PLCName
Name of the PLC whose user program contains the block. The name is identical to the station
name displayed in the project tree in the TIA Portal.

ContainingBlock
Name of the block to be displayed or name of the instance of an FB.

CalledBlock
Name of the FB or FC which is called in the network of "ContainingBlock". Alternatively, you
can also configure a DB or a multi-instance.
The following can be used as names:
• 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 multi-instance
name paths are specified, these are data hierarchies such as those displayed in the DB editor,
and not the call structure. The first part of the name ("Line1") does not have to be enclosed
in quotation marks, because it is clear from the context that this is a global icon. Quotation
marks are required for the individual name components when special characters such as
spaces, dots, etc., occur in it. Example: "Line1.Cell1.Station1"
• Name of an FC or OB

PinName
Name of an input pin of "CalledBlock". The parameter is used to ensure that the network
interconnected to the input pin is contained in the XML data.

PartialPinNameMatch
TRUE if input pins which begin with the name specified under "PinName" are also to be taken
into consideration.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2503
Runtime API
3.12 Functions for displaying the PLC code in an external application

Return value
ID with which the request is uniquely identified. The ID is generated and returned with the call
of the function.

See also
RequestByAssignmentEx (Page 2500)
StartDynamicDataSubscriptionEx (Page 2509)
CancelRequest (Page 2504)

3.12.2.8 CancelRequest

Description
The function cancels an ongoing request.

Declaration

HRESULT CancelRequest( [in] unsigned long RequestId);

Parameters

RequestId
ID of the request which is canceled.

Return value
-

See also
RequestByAssignment (Page 2499)
RequestByCall (Page 2501)

3.12.2.9 Terminate

Description
The function ends the execution of a COM object implemented with "Initialize":
• All active requests and subscriptions are ended.
• The callback functions "OnModeXML", "OnDynamicDataXML" and "OnEvent" are ended.

WinCC Engineering V18 – Programming reference

2504 System Manual, 11/2022, Online documentation
 Runtime API
3.12 Functions for displaying the PLC code in an external application

Declaration

HRESULT Terminate();

Parameters
-

Return value
-

See also
Initialize (Page 2497)

3.12.2.10 Structure of the XML data

Structure

<PlcCodeViewerExternalClientModel Version="1.0.0.0">
<CommonHeaderInfo>
</CommonHeaderInfo>
<Networks>
<Networks>
<NetworkHeaderInfo>
<NetworkHeaderInfo>
<FlgNet>
<Parts>
<Part>
<Parameters>
<Parameters>
</Part>
</Parts>
<Wires>
<Wire>
</Wire>
</Wires>
</FlgNet>
<Networks>
</Networks>
</PlcCodeViewerExternalClientModel>

The XSD file can be found by default in the following directory:

C:\Users\Public\Documents\Siemens\WinCC.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2505
Runtime API
3.12 Functions for displaying the PLC code in an external application

"<PlcCodeViewerExternalClientModel>" section
Contained: [1]
Contains the sections "CommonHeaderInfo" and "Networks".

"<Networks>" section
Contained: [0..n]
Represents a network which is uniquely identified via the attribute "NetId". Contains the
sections "NetworkHeaderInfo" and "FlgNet".

"<NetworkHeaderInfo>" section
Contained: [1]
Contains information about the network, e.g. the name of the instruction or the network
title.

WinCC Engineering V18 – Programming reference

2506 System Manual, 11/2022, Online documentation
 Runtime API
3.12 Functions for displaying the PLC code in an external application

"<FlgNet>" section
Contained: [1]
Represents the description of the network. Contains the sections "Parts" and "Wires".

"<Part>" section
Contained: [0..n]
Represents an instruction or an operand.

"<Wire>" section
Contained: [0..n]
Represents networking between instructions and operands.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2507
Runtime API
3.12 Functions for displaying the PLC code in an external application

Relevant attributes
The following table shows the attributes of the XML data.

Attribute Description Contained in

AbsAdress Absolute address Operand
DynData‐ Data type if dynamic information is retrieved. Depending on object Operand
Type type: Part
• Operand Wire
– Bool: "True" or "False"
• Part
– Powerflow
State of the current flow: "On", "Off" or "Undef"
– Bool: "True" or "False"
State of a parameter or an instruction from:
• Wire
– Powerstate
DynID References the object for querying its dynamic data with the function Operand
"StartDynamicDataSubscription" Part
Wire
Name Object name. With operands, the symbolic address is displayed. Operand
Parameter
Negated True if the input is negated.
Num References a Parameter. Parameter
PType Defines whether a pin is an input or output or represents the switching Parameter
state.
Type Defines the type.
UId References the object Is used to describe relationships such as net‐ Operand
works between objects. Part
Wire
WireElement

3.12.3 Querying dynamic statistical information of networks

3.12.3.1 StartDynamicDataSubscription

Description
The function queries cyclic information for the specified network. The information is integrated
into the XML data which you queried beforehand with "RequestByAssignment" or
"RequestByCall". Because multiple static subscriptions are supported, the subscription from the
last made call is used.

WinCC Engineering V18 – Programming reference

2508 System Manual, 11/2022, Online documentation
 Runtime API
3.12 Functions for displaying the PLC code in an external application

If you pass the value "0" for "DynIDCount" and the value "NULL" for "DynIDs", the data of all
assigned "DynIDs" are output. To specify the dynamic data for "DynIDs", you must pass the
corresponding ID for "DynIdCount" and "DynIDs".

Declaration

HRESULT StartDynamicDataSubscription( [in] int NetworkID,

[in] long DynIDCount,
[in, [size_is(DynIDCount)] long* DynIDs,
[out] long* SubscriptionId);

Parameters

NetworkID
ID of the network whose static data was queried previously. The ID is available in the XML
data in the attribute "NetID".

DynIDCount
Number of areas for which the dynamic information is queried.

DynIDs
IDs of pins or inputs for which current flows or current values are displayed. The IDs are
available in the XML data in the attribute "DynID".

Return value
ID with which the subscription is uniquely identified. The ID is generated and returned with the
call of the function.

See also
RequestByAssignment (Page 2499)
RequestByCall (Page 2501)

3.12.3.2 StartDynamicDataSubscriptionEx

Description
The function queries cyclic information for the specified network. The information is integrated
into the XML data which you queried beforehand with "RequestByAssignment" or
"RequestByCall". This function allows you to apply a static subscription for a request via
"NetworkId" and "RequestId".
If you pass the value "0" for "DynIDCount" and the value "NULL" for "DynIDs", the data of all
assigned "DynIDs" are output. To specify the dynamic data for "DynIDs", you must pass the
corresponding ID for "DynIdCount" and "DynIDs".

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2509
Runtime API
3.12 Functions for displaying the PLC code in an external application

Declaration

HRESULT StartDynamicDataSubscriptionEx( [in] int NetworkID,

[in] long DynIDCount,
[in, [size_is(DynIDCount)] long* DynIDs,
[out] long* SubscriptionId);

Parameters

NetworkID
ID of the network whose static data was queried previously. The ID is available in the XML
data in the attribute "NetID".

DynIDCount
Number of areas for which the dynamic information is queried.

DynIDs
IDs of pins or inputs for which current flows or current values are displayed. The IDs are
available in the XML data in the attribute "DynID".

Return value
ID with which the subscription is uniquely identified. The ID is generated and returned with the
call of the function.

See also
RequestByAssignmentEx (Page 2500)
RequestByCallEx (Page 2503)

3.12.3.3 StopDynamicDataSubscription

Description
The function ends a current subscription.

Declaration

HRESULT StopDynamicSubscription( [in] long SubscriptionId);

WinCC Engineering V18 – Programming reference

2510 System Manual, 11/2022, Online documentation
 Runtime API
3.13 Troubleshooting

Parameters

SubscriptionId
ID of the subscription which is ended.

Return value
-

3.12.3.4 StopDynamicDataSubscriptionEx

Description
The function ends a subscription which you define using "RequestId" and "SubscriptionId".

Declaration

HRESULT StopDynamicSubscriptionEx( [in] unsigned long RequestId,

[in] long SubscriptionId);

Parameters

RequestId
ID of the request which initializes the ending of the subscription.

SubscriptionId
ID of the subscription which is ended.

Return value
-

3.13 Troubleshooting

3.13.1 CMN_ERROR

Description
The extended error structure CMN_Error contains the error code and an error text for the error
that occurred. Each application can use the error structure to evaluate or to output error
messages.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2511
Runtime API
3.13 Troubleshooting

Declaration

Typedef struct {
DWORD dwError1;
DWORD dwError2;
DWORD dwError3;
DWORD dwError4;
DWORD dwError5;
Char szErrorText[512];
}
CMN_ERROR;

Members

dwError1 .. dwError5
Each of the API descriptions contains information on the values of the entries in case of an
error. Unless otherwise specified, the error codes are in dwError1.

szErrorText
Buffer for the text description of the error cause. The content is determined from the
resources and is generally language-dependent.

Comment
Some modules use the following error code assignments, as required

dwError1 API error code

dwError2 Subordinate error code (e.g., CCStorageError.h)
dwError3 Line number of the source code
dwError4 Array Index 1; Row; Record / Status / ....
dwError5 Array Index 2; Column; Record Element / Counter / ....

See also
Error messages (Page 1559)

WinCC Engineering V18 – Programming reference

2512 System Manual, 11/2022, Online documentation
 Runtime API
3.13 Troubleshooting

3.13.2 CCStorageError.h

Subordinate error messages CCStorageError.h

The following error messages can be returned by the API functions in the CMN_ERROR error
structure in addition to the actual error message in dwError1 and in dwError2, if available in the
respective module.

Error message Value

CCF_STORAGE_PM_E_NO_PROJECT_OPEN 0x80046101L The WinCC project cannot be
opened.
CCF_STORAGE_PM_E_NO_PROJECT_OPEN_1 0x80046102L The WinCC project cannot be
opened/created. Project Manag‐
er cannot start the SDIAGRT basic
application.
CCF_STORAGE_PM_E_NO_PROJECT_OPEN_2 0x80046103L The WinCC project cannot be
opened/created. Project Manag‐
er cannot start the PASSDBRTT
basic application.
CCF_STORAGE_PM_E_NO_PROJECT_OPEN_3 0x80046104L The WinCC project cannot be
opened/created. Project Manag‐
er cannot start the SCRIPT basic
application.
CCF_STORAGE_PM_E_NO_PROJECT_OPEN_31 0x80046105L The WinCC project cannot be
opened/created. Project Manag‐
er cannot start the XREF basic ap‐
plication.
CCF_STORAGE_PM_E_NO_PROJECT_OPEN_4 0x80046106L The WinCC project cannot be
opened/created. Project Manag‐
er cannot initialize the ASO basic
application.
CCF_STORAGE_PM_E_NO_PROJECT_OPEN_5 0x80046107L The WinCC project cannot be
opened/created. Project Manag‐
er can only open one WinCC
project at a time.
CCF_STORAGE_PM_E_NO_PROJECT_OPEN_6 0x80046108L The WinCC project cannot be
opened/created. Project Manag‐
er cannot configure a start line
for the data source.
CCF_STORAGE_PM_E_NO_PROJECT_OPEN_7 0x80046109L The WinCC project cannot be
opened/created. Project Manag‐
er cannot configure a data source.
CCF_STORAGE_PM_E_NO_PROJECT_OPEN_8 0x8004610AL The WinCC project cannot be
opened. Project Manager for the
configured WinCC server not run‐
ning yet. Start the Project Manag‐
er for the configured server.
CCF_STORAGE_PM_E_NO_PROJECT_OPEN_9 0x8004610BL The WinCC project cannot be
opened/created. Project Manag‐
er cannot create the Distributed
Configuration file (Project.dcf).

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2513
Runtime API
3.13 Troubleshooting

Error message Value

CCF_STORAGE_PM_E_NO_PROJECT_OPEN_10 0x8004610CL The WinCC project cannot be
opened.
The project path is invalid.
CCF_STORAGE_PM_E_NO_PROJECT_CLOSE_1 0x8004610DL The WinCC project cannot be
closed. Some users are already
connected to the WinCC project
via the network.
CCF_STORAGE_PM_E_NO_PROJECT_CLOSE_2 0x8004610EL The WinCC project cannot be
closed. Project Manager is miss‐
ing specific information about
this WinCC project. Please check
your project ID.
CCF_STORAGE_PM_E_NO_PROJECT_CLOSE_3 0x8004610FL The WinCC project cannot be
closed. An active WinCC project is
already running on your PC.
CCF_STORAGE_PM_E_NO_PROJECT_CLOSE_4 0x80046110L The WinCC project cannot be
closed. Project Manager does not
support the close mode of the
project.
CCF_STORAGE_PM_E_NO_PROJECT_CLOSE_5 0x80046111L The WinCC project cannot be
closed. Some users are already
connected to the WinCC project.
Timeout!
CCF_STORAGE_PM_E_NO_PROJECT_LAN‐ 0x80046112L The project does not support the
GUAGE_1 requested language.
CCF_STORAGE_PM_E_NO_ACTIVATE 0x80046113L No active WinCC projects running
on this PC.
CCF_STORAGE_PM_E_NO_ACTIVATE_1 0x80046114L The WinCC project cannot be ac‐
tivated. The WinCC server prop‐
erties have been changed. Close
and open the WinCC project
again.
CCF_STORAGE_PM_E_NO_PROJECT_CREATE 0x80046115L The WinCC project cannot be cre‐
ated.
CCF_STORAGE_PM_E_NO_PROJECT_OPEN_11 0x80046116L The WinCC project cannot be
opened. Close the running
WinCC project.
CCF_STORAGE_PM_E_NO_PROJECT_OPEN_12 0x80046117L The WinCC project cannot be
opened. The WinCC project path
exceeds the maximum permissi‐
ble length of 255 characters.
CCF_STORAGE_PM_E_NO_PROJECT_OPEN_13 0x80046118L The WinCC project cannot be
opened. The WinCC project name
exceeds the maximum permissi‐
ble length of 64 characters.
CCF_STORAGE_PM_E_NO_ACTIVATE_2 0x80046119L The WinCC project cannot be de‐
activated. The timeout interval
has expired (SCRIPT.exe).
CCF_STORAGE_PM_E_NO_ACTIVATE_3 0x8004611AL The WinCC project cannot be de‐
activated. The timeout interval
has expired (PASSDBRT.exe).

WinCC Engineering V18 – Programming reference

2514 System Manual, 11/2022, Online documentation
 Runtime API
3.13 Troubleshooting

Error message Value

CCF_STORAGE_PM_E_NO_ACTIVATE_4 0x8004611BL The WinCC project cannot be de‐
activated. The timeout interval
has expired (SDIAGRT.exe).
CCF_STORAGE_PM_E_NO_PROJECT_OPEN_14 0x8004611CL The WinCC project cannot be
opened. The project path could
not be inserted in the SIMAT‐
IC.cfg file.
CCF_STORAGE_PM_E_NO_ACTIVATE_5 0x8004611DL The WinCC project cannot be ac‐
tivated. No WinCC project exists.
CCF_STORAGE_PM_E_NO_ACTIVATE_6 0x8004611EL The WinCC project cannot be
opened. The WinCC client cannot
receive the server activation sta‐
tus over broadcast.
CCF_STORAGE_PM_E_NO_ACTIVATE_7 0x8004611FL The activation of the WinCC
project is running. The activation
of the WinCC client is not yet
complete.
CCF_STORAGE_PM_E_CREATE_SHARE_FAILED 0x80046120L The WinCC project share cannot
be created. The WinCC project
could not be opened.
CCF_STORAGE_PM_E_OPEN_FILE_FAILED 0x80046121L The WinCC project file cannot be
opened. The WinCC project can‐
not be opened.
CCF_STORAGE_PM_E_CLIENT_CANNOT_ACTI‐ 0x80046122L The client cannot activate this
VATE project because it is not included
in the client list.
CCF_STORAGE_PM_E_SYBASE_MIGRATION 0x80046123L This WinCC version does not sup‐
port the old Sybase projects. Mi‐
grate your projects.
CCF_STORAGE_PM_E_NO_PROJECT_OPENED 0x80046124L No project is currently open.
CCF_STORAGE_PM_E_COMPUTER_NOT_IN_MA‐ 0x80046125L This client is not included in the
CHINE_LIST list of specified servers.
CCF_SQL_SERVER_NOT_INSTALLED_ERROR 0x80046126L The SQL Server may have been
installed incorrectly. Check
whether the SQL Server was in‐
stalled correctly.
CCF_SQL_SERVER_DATABASE_ACCESS_ERROR 0x80046127L The SQL Server cannot access the
database. Check access rights.
CCF_PM_E_PROJECT_IS_LOCKED 0x80046128L The project is locked.
CCF_SQL_SERVER_DATABASE_NTFS_ERROR 0x80046129L The SQL Server 2005 does not
support compressed NTFS vol‐
umes. Decompress at least the
project directory and its content.
CCF_PM_OPEN_ERROR_RDP 0xC004612AL This project is generated by RDP.
It is not permitted to open it in
WinCC.
CCF_PM_OPEN_CODEPAGE_MISMATCH 0x4004612BL This code page does not match
the code page at the time of cre‐
ation.
CCF_PM_MIGRATION_NEEDED 0x8004612CL PM migration required.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2515
Runtime API
3.13 Troubleshooting

Error message Value

CCF_STORAGE_DBASO_E_NO_LICENSE 0x80046201L No license is available for this
functionality.
CCF_STORAGE_DBASO_E_LIMIT 0x80046202L The high limit of the storage ca‐
pacity has been reached.
CCF_STORAGE_DBASO_E_DATA_VERSION 0x80046203L ASO cannot work with this file
version.
CCF_STORAGE_DBASO_E_NO_CONNECTION 0x80046204L No connection to the database.
CCF_STORAGE_DBASO_E_NO_TABLE 0x80046205L The table does not exist or cannot
be opened. Check access rights.
CCF_STORAGE_DBASO_E_NO_RECORD 0x80046206L No data record
CCF_STORAGE_DBASO_E_NO_RESOURCE 0x80046207L No resource
CCF_STORAGE_DBASO_E_NOT_CREATED 0x80046208L The data record was not created.
CCF_STORAGE_DBASO_E_NOT_DELETED 0x80046209L The data record was not deleted.
CCF_STORAGE_DBASO_E_NOT_MODIFIED 0x8004620AL The data record was not changed.
CCF_STORAGE_DBASO_E_RECORD_EXIST 0x8004620BL The data record already exists.
CCF_STORAGE_DBASO_E_RECORD_IN_USE 0x8004620CL The data record is already in use.
CCF_STORAGE_DBASO_E_RECORD_FIELDSIN‐ 0x8004620DL Invalid count or field type
VALID
CCF_STORAGE_DBASO_E_RECORD_PROTECTED 0x8004620EL The data record cannot be
changed or moved.
CCF_STORAGE_DBASO_E_NO_CONTEXT 0x8004620FL No or invalid project context.
ASO does not function correctly.
CCF_STORAGE_DBASO_E_ENUM_NOENTRIES 0x80046210L No entries found for enumera‐
tion.
CCF_STORAGE_DBASO_E_NOT_FOUND 0x80046211L Could not find the specified ob‐
ject.
CCF_STORAGE_DBA‐ 0x80046212L You are not allowed to change
SO_E_ID_CHANGES_NOT_POSSIBLE the IDs.
CCF_STORAGE_DBASO_E_PARAME‐ 0x80046213L The parameter is too long.
TER_TOO_LONG
CCF_STORAGE_DBASO_E_DATA_TOO_OLD 0x80046214L The data could not be read be‐
cause it originates from an older
WinCC version.
CCF_STORAGE_DBASO_E_DATA_NEW‐ 0x80046215L The data comes from a more re‐
ER_THAN_SOFTWARE cent version than the installed
software. Please upgrade your
software.
CCF_STORAGE_DBASO_E_ENUMSINK_RE‐ 0x80046216L Enum sink executed with errors.
TURNED_WITH_ERROR
CCF_STORAGE_DBASO_E_DATA_EXIST_IN_REF‐ 0x80046217L The primary key is referenced in a
ERENCED_TABLE different table.
CCF_STORAGE_DBASO_E_DA‐ 0x80046218L The value lies outside the value
TA_OUT_OF_RANGE range.
CCF_STORAGE_DM_ASO_BULK_FAILED 0x80046219L The bulk process failed.
CCF_STORAGE_DBASO_E_RT_LIMIT_WARNING 0x8004621AL The runtime limit has been
reached.
CCF_STORAGE_DBASO_E_BAD_LOCALE_ID 0x8004621BL Bad local ID

WinCC Engineering V18 – Programming reference

2516 System Manual, 11/2022, Online documentation
 Runtime API
3.13 Troubleshooting

Error message Value

CCF_STORAGE_FILEASO_E_NO_PICTURE 0x80046301L No picture available
CCF_STORAGE_GDO_BADTYPE_IN_VARIANT 0x80046405L Incorrect type in the variant
CCF_STORAGE_GDO_DATAINCONSISTENT 0x80046406L Inconsistent data:
Some data is invalid or is outside
the value range.
CCF_STORAGE_GDO_UNITID_INVALID 0x80046407L Inconsistent data:
The ID of the channel unit is inva‐
lid.
CCF_STORAGE_GDO_USERTYPE_INVALID 0x80046408L Inconsistent data:
The user type is invalid.
CCF_STORAGE_GDO_ADDRESSBUILD_FAILURE 0x80046409L Inconsistent data
Addressing of tags was formed
incorrectly.
CCF_STORAGE_GDO_MODIFY_NOCHANGE 0x8004640AL Inconsistent data:
No relevant changes were made.
CCF_STORAGE_GDO_CHANNELWRAPPER_LOAD 0x8004640BL CCMfcChannelWrapper.DLL
could not be found.
CCF_STORAGE_GDO_CHANNEL_LOAD 0x8004640CL Error while loading the channel:
Channel not found.
CCF_STORAGE_GDO_CHANNEL_FUNC 0x8004640DL Channel access point not found.
CCF_STORAGE_GDO_CHANNEL_UNITNR 0x8004640EL The number of the channel unit is
invalid.
CCF_STORAGE_GDO_CONNECTION 0x8004640FL The connection is invalid or could
not be found.
CCF_STORAGE_GDO_TAGGROUP 0x80046410L The tag group is invalid or could
not be found.
CCF_STORAGE_GDO_NAMENOTFOUND 0x80046411L The specified name could not be
found.
CCF_STORAGE_GDO_TAGOFUSERTYPEEXISTS 0x80046412L The "UserType" object cannot be
moved.
CCF_STORAGE_GDO_PROJECTISACTIVE 0x80046413L The project was activated. No
changes or moves permitted.
CCF_STORAGE_GDO_UNIT 0x80046414L The channel unit is invalid or
could not be found.
CCF_STORAGE_GDO_MINMAX_LIMIT 0x80046415L The low or high limit was excee‐
ded.
CCF_STORAGE_GDO_PROJECT_IN_RUNTIME 0x80046416L This process is not permitted
while the project is in runtime.
CCF_STORAGE_GDO_BAD_POINTER 0x80046600L The NULL pointer is not permit‐
ted for GetProperty.
CCF_STORAGE_GDO_UNEXPECTED 0x80046601L An unexpected error has occur‐
red.
CCF_STORAGE_GDO_NO_RECORD 0x80046602L No data record exists.
CCF_STORAGE_GDO_OPERATION_NOT_COM‐ 0x80046603L The current process is not permit‐
MITTED ted.
CCF_STORAGE_GDO_NO_PROJECT_CONNEC‐ 0x80046604L No Project Connector available.
TOR

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2517
Runtime API
3.13 Troubleshooting

Error message Value

CCF_STORAGE_GDO_PROJECT_NOT_OPENED 0x80046605L The project was not opened.
CCF_STORAGE_GDO_GET_ASO_FAILED 0x80046606L "GetAso" failed.
CCF_STORAGE_GDO_BAD_TYPEID 0x80046607L The type ID is unsuitable.
CCF_STORAGE_GDO_OTHER_TYPE_NOT_COM‐ 0x80046608L Another type is not permitted.
MITED
CCF_STORAGE_GDO_CACHE_READ 0x80046609L Error reading the cache.
CCF_STORAGE_GDO_CACHE_WRITE 0x8004660AL Error writing to the cache.
CCF_STORAGE_GDO_DM_GDO_ERROR 0x8004660BL An error occurred in DM Gdo.
CCF_STORAGE_GDO_TEXT_GDO_ERROR 0x8004660CL An error occurred in Text Gdo.
CCF_STORAGE_GDO_ENUMERATOR_CREATION 0x8004660DL Creation of ASO counter failed.
CCF_STORAGE_GDO_ENUMDATA_FAILED 0x8004660EL The call to ICCTxtAsoE‐
num::EnumData() failed.
CCF_STORAGE_GDO_ENUMSINK_CREATION 0x8004660FL The creation of an Enumeration
Sink object failed.
CCF_STORAGE_GDO_WRONG_INTERFACE 0x80046610L The pointer was sent to the
wrong interface.
CCF_STORAGE_GDO_BAD_LOCALE_ID 0x80046611L The local ID was not found in the
card.
CCF_STORAGE_GDO_CREATE_OBJECT 0x80046612L CreateObject failed.
CCF_STORAGE_GDO_MODIFY_OBJECT 0x80046613L ModifyObject failed.
CCF_STORAGE_GDO_READ_OBJECT 0x80046614L ReadObject failed.
CCF_STORAGE_GDO_NOT_IMPLEMENTED 0x80046615L Not implemented.
CCF_STORAGE_GDO_REMOVE_OBJECT 0x80046616L RemoveObject failed.
CCF_STORAGE_GDO_REMOVE_ALL 0x80046617L RemoveAll failed.
CCF_STORAGE_GDO_ENUM_OBJECTS 0x80046618L EnumObjects failed.
CCF_STORAGE_GDO_GET_OBJECT_COUNT 0x80046619L GetObjectCount failed.
CCF_STORAGE_GDO_GET_RW_INTER‐ 0x8004661AL GetRWInterface of ASO failed.
FACE_FROM_ASO
CCF_STORAGE_GDO_ON_ENUM_DATA 0x8004661BL OnEnumData of Sink object
failed.
CCF_STORAGE_GDO_ASO_CREATE 0x8004661CL The creation of a call to Aso failed.
CCF_STORAGE_GDO_CREATE_CACHED_OBJECT 0x8004661DL CreateCachedObject failed.
CCF_STORAGE_GDO_CREATE_SINK_OB‐ 0x8004661EL CreateSinkObject for ASO failed.
JECT_FOR_ASO
CCF_STORAGE_GDO_CREATE_DM_GDO 0x8004661FL Error creating DM Gdo.
CCF_STORAGE_GDO_CONNECT_DM_GDO 0x80046620L Error connecting to DM Gdo.
CCF_STORAGE_GDO_CREATE_TEXT_GDO 0x80046621L Error creating Text Gdo.
CCF_STORAGE_GDO_CONNECT_TEXT_GDO 0x80046622L Error connecting to Text Gdo.
CCF_STORAGE_GDO_INVA‐ 0x80046623L Error in Enum Sink pointer.
LID_ENUM_SINK_POINTER
CCF_STORAGE_GDO_VARIANT_CHANGE_TYPE 0x80046624L Error in Variant ChangeType.
CCF_STORAGE_GDO_GET_COLLECT_ID 0x80046625L Error in GetCollectID.
CCF_STORAGE_GDO_COMMIT_TO_TYPE_HAN‐ 0x80046626L CommitToTypeHandler failed.
DLER
CCF_STORAGE_GDO_SET_TAG_ID 0x80046627L Error in SetTagId.

WinCC Engineering V18 – Programming reference

2518 System Manual, 11/2022, Online documentation
 Runtime API
3.13 Troubleshooting

Error message Value

CCF_STORAGE_GDO_SET_TEXT_ID 0x80046628L Error in SetTextId.
CCF_STORAGE_GDO_COMMIT_CACHED_OB‐ 0x80046629L Error in CommitCachedObject.
JECT
CCF_STORAGE_GDO_QUERY_INTER‐ 0x8004662AL QueryInterface of sink failed.
FACE_OF_SINK
CCF_STORAGE_GDO_BAD_PROPERTY_PARAME‐ 0x8004662BL Invalid parameters defined for
TER the property.
CCF_STORAGE_GET_TAGNAME_FROM_ID 0x8004662CL The tag name cannot be read
from the tag ID.
CCF_STORAGE_DELETE_RECORD_OF_CREATOR‐ 0x8004662DL The data for the Creator ID that is
ID not identical to 0 cannot be de‐
leted.
CCF_STORAGE_CACHE_OVERFLOW 0x8004662EL Cache overflow
CCF_STORAGE_SERVER_DOWN 0x8004662FL Server failure
CCF_STORAGE_ASO_PTR_NOT_INITIALIZED 0x80046630L Aso SmartPointer has not been
initialized.
CCF_STORAGE_CREATE_CONNECTION_CON‐ 0x80046631L The connection controller could
TROLLER not be created.
CCF_STORAGE_CONNECTION_CONTROL‐ 0x80046632L The connection controller could
LER_CONNECT_TO_PROJECT not establish a connection to the
project.
CCF_STORAGE_ASO_WRAPPER_SET_CONNEC‐ 0x80046633L A connection controller could not
TION_CONTROLLER be set for Aso wrapper.
CCF_STORAGE_ASO_WRAP‐ 0x80046634L No project memory could be set
PER_SET_PROJECT_STORAGE up for Aso wrapper.
CCF_STORAGE_PROGID_FROM_CLSID 0x80046635L Error in ProgIDFromCLSID.
CCF_STORAGE_ASO_WRAPPER_GET_ASO 0x80046636L Error in Aso wrapper, in "GetAso"
call.
CCF_STORAGE_ASO_WRAP‐ 0x80046637L Error in Aso wrapper, SetProject‐
PER_SET_PROJECT_STORAGE_NULL Storage (NULL).
CCF_STORAGE_ASO_WRAPPER_GET_RWINTER‐ 0x80046638L Error in Aso wrapper, in "GetR‐
FACE WInterface" call.
CCF_STORAGE_GDO_GET_PROJECT 0x80046639L Error in GdoCoreBase, in GetPro‐
ject call.
CCF_STORAGE_TLGGDO_VAR_NO_TRIGGER 0x8004663AL No trigger available
CCF_STORAGE_PACKAGES_PROJECT_ASO 0x80046501L Project ASO could not be instan‐
tiated.
CCF_STORAGE_PACKAGES_EXPORT_DATA 0x80046502L Data export failed.
CCF_STORAGE_PACKAGES_LIST 0x80046503L Enum Packages failed.
CCF_STORAGE_CCPACKAGEMGR_EX‐ 0x80046504L Data export is running.
PORT_IS_RUNNING
CCF_STORAGE_CCPACKAGEMGR_UP‐ 0x80046505L Data update is running.
DATE_IS_RUNNING
CCF_STORAGE_PACKAGES_EXPORT_USER_CAN‐ 0x80046506L Export was canceled by user.
CELED
CCF_STORAGE_PACKAGES_IMPORT_ON‐ 0x80046507L Only one central archive server
LY_ONE_CAS_CAN_BE_IMPORTED can be imported.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2519
Runtime API
3.13 Troubleshooting

Error message Value

CCF_STORAGE_PACKAGES_FORBID_STAND‐ 0x80046508L The standard server configura‐
ARD_SERVER tion is not permissible for this
server type.
CCF_STORAGE_PACKAGES_IMPORT_IM‐ 0x80046509L Do not import the redundant
PORT_RED server.
CCF_STORAGE_PACKAGES_IM‐ 0x8004650AL Do not update the package on
PORT_CHANGE_RED the redundant server.
CCF_STORAGE_PACKAGES_IMPORT_IM‐ 0x8004650BL Do not import the package on the
PORT_PHYS identical server.
CCF_STORAGE_PACKAGES_IM‐ 0x8004650CL Do not update the package on
PORT_CHANGE_PHYS the identical server.
CCF_STORAGE_PACKAGES_IM‐ 0x8004650DL Do not import or update the pack‐
PORT_CHANGE_OWN age on your own server.
CCF_STORAGE_PACKAGES_IMPORT_IN‐ 0x8004650EL Do not import or update the pack‐
CLUDE_OWN_RED age on your own redundant serv‐
er.
PCC_E_CANNOT_CONNECT_TO_DATABASE 0x80047000L A connection to the database
cannot be established.
PCC_E_RECONNECT_TO_DATABASE_FAILED 0x80047001L Reconnection to the database
failed.
PCC_E_JOB_ID_IS_INVALID 0x80047002L The job ID is invalid.
PCC_E_INVALID_CONTEXT_INFO_PROVIDED 0x80047003L Invalid context information
PCC_E_DATABASE_ERROR_SEE_EVENT_LOG 0x80047004L Database error. See event log for
additional information.
PCC_E_ERROR_SEE_EVENT_LOG 0x80047005L Undefined error, see event log for
additional information.
PCC_E_INVALID_PARAMETERS 0x80047006L Invalid parameters specified.
PCC_E_ROLLBACK_TRANSACTION_FAILED 0x80047007L Transaction cannot be undone.
PCC_E_COMMIT_TRANSACTION_FAILED 0x80047008L Transaction cannot be executed.
PCC_E_BEGIN_TRANSACTION_FAILED 0x80047009L Transaction cannot be started.
PCC_E_COPY_WORLDMAP_FAILED_WORLD‐ 0x8004700AL Copying of world map failed. The
MAP_LOCKED world map is locked.
PCC_E_MODIFY_WORLDMAP_FAILED_WORLD‐ 0x8004700BL Changing of world map failed.
MAP_LOCKED The world map is locked.
PCC_E_REMOVE_WORLDMAP_FAILED_WORLD‐ 0x8004700CL Moving of world map failed. The
MAP_LOCKED world map is locked.
PCC_E_MODIFY_VIEW_FAILED_VIEW_LOCKED 0x8004700DL Changing of view failed. The
view is locked.
PCC_E_REMOVE_VIEW_FAILED_VIEW_LOCKED 0x8004700EL Moving of view failed. The view is
locked.
PCC_E_COPY_WORLD‐ 0x8004700FL Copying of world map failed. One
MAP_FAILED_VIEWS_LOCKED or more views are locked.
PCC_E_MODIFY_WORLD‐ 0x80047010L Changing of world map failed.
MAP_FAILED_VIEWS_LOCKED One or more views are locked.
PCC_E_REMOVE_WORLD‐ 0x80047011L Deleting world map failed. One
MAP_FAILED_VIEWS_LOCKED or more views are locked.
PCC_E_COPY_WORLDMAP_FAILED_OB‐ 0x80047012L Copying of world map failed. One
JECTS_LOCKED or more objects are locked.

WinCC Engineering V18 – Programming reference

2520 System Manual, 11/2022, Online documentation
 Runtime API
3.13 Troubleshooting

Error message Value

PCC_E_MODIFY_WORLDMAP_FAILED_OB‐ 0x80047013L Changing of world map failed.
JECTS_LOCKED One or more objects are locked.
PCC_E_REMOVE_WORLDMAP_FAILED_OB‐ 0x80047014L Deleting world map failed. One
JECTS_LOCKED or more objects are locked.
PCC_E_MODIFY_OBJECTS_FAILED_OB‐ 0x80047015L Changing of objects failed. One
JECTS_LOCKED or more objects are locked.
PCC_E_REMOVE_OBJECTS_FAILED_OB‐ 0x80047016L Deleting objects failed. One or
JECTS_LOCKED more objects are locked.
PCC_E_COPY_WORLDMAP_FAILED_NO_ACTIVA‐ 0x80047017L Job for copying world map failed.
TED_WORLDMAP No world map is activated.
PCC_E_REMOVE_WORLDMAP_FAILED_NO_AC‐ 0x80047018L Job for moving world map failed.
TIVATED_WORLDMAP No world map is activated.
PCC_E_REMOVE_OBJECTS_FAILED_NO_ACTIVA‐ 0x80047019L Job for moving objects failed. No
TED_OBJECTS object is activated.
PCC_E_MODIFY_OBJECTS_FAILED_NO_ACTIVA‐ 0x8004701AL Job for changing objects failed.
TED_OBJECTS No object is activated.
PCC_E_REMOVE_VIEW_FAILED_NO_ACTIVA‐ 0x8004701BL Job for changing view failed. No
TED_VIEW view is activated.
PCC_E_MODIFY_VIEW_FAILED_NO_ACTIVA‐ 0x8004701CL Job for changing world map
TED_VIEW failed. No job is activated.
PCC_E_MODIFY_WORLDMAP_FAILED_NO_ACTI‐ 0x8004701DL Job for changing world map
VATED_JOB failed. No job is activated.
PCC_E_COPY_WORLD‐ 0x8004701EL Copying of world map failed.
MAP_FAILED_NOT_FOUND World map was not found.
PCC_E_WORLDMAP_NAME_IN_USE 0x8004701FL The name of the world map is al‐
ready in use.
PCC_E_VERSION_NUMBER_INVALID 0x80047020L The version number is invalid.
PCC_E_USER_DOES_NOT_HAVE_WRITE_PER‐ 0x80047021L The user does not have write per‐
MISSION mission.
PCC_E_CREATE_AREALOCK_FAILED_OB‐ 0x80047022L Creation of the area lock failed.
JECTS_LOCKED Locked objects exist.
PCC_E_MODIFY_AREALOCK_FAILED_OB‐ 0x80047023L Change of the area lock failed.
JECTS_LOCKED Locked objects exist.
PCC_E_JOB_NOT_FOUND 0x80047024L Job not found.
PCC_E_JOB_MUST_EXIST_MORE_THAN_ONCE 0x80047025L Job must exist more than once.
PCC_E_CANNOT_MODIFY_ROOT_CTX 0x80047026L The root context cannot be
changed.
PCC_E_CANNOT_MODIFY_JOB 0x80047027L The job cannot be changed.
PCC_E_CANNOT_MODIFY_JOB_RE‐ 0x80047028L The job cannot be changed. It is
SERVED_BY_OTHER_USER reserved by another user.
WINCC_DBPLUGIN_E_ROW_EXISTS 0x80047100L The row already exists.
WINCC_DBPLUGIN_E_CONSTRAINT_CONFLICT 0x80047101L A constraint conflict has occur‐
red.
WINCC_DBPLUGIN_E_INVALID_OBJECT_NAME 0x80047102L The object name is invalid.
WINCC_DBPLUGIN_E_INVALID_COLUMN_NAME 0x80047103L The column name is invalid.
WINCC_DBPLUGIN_E_DATA_CONVERSION 0x80047104L Error occurred during data con‐
version.

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2521
Runtime API
3.13 Troubleshooting

Error message Value

WINCC_DBPLUGIN_E_DATA_CONVERSION_DA‐ 0x80047105L The string conversion to date/
TETIME time format failed.
WINCC_DBPLUGIN_E_STRING_TOO_LONG 0x80047106L The string is shortened.
WINCC_DBPLUGIN_E_ARITHMETIC_OVERFLOW 0x80047107L The data type "Number overflow"
cannot save the value.
WINCC_DBPLUGIN_RECORD_LOCKED 0x80047108L The data record is locked.
WINCC_DBPLUGIN_TABLE_LOCKED 0x80047109L The table is locked.
WINCC_DBPLUGIN_CANNOTOPENDB 0x8004710AL The database cannot be opened.
PCC_E_CANNOT_DO_MAKE_UNIQUE_NAME 0x8004710BL Cannot assign unique name to
object.
PCC_E_NO_DB_FOUND_ON_RTS 0x8004710CL Database on RTS master cannot
be accessed or the database is in
standby mode.
PCC_E_OPERATION_NOT_ALLOWED_ON_RTS 0x8004710DL This process is not permitted in
the RTS database. This process
must be executed in the engi‐
neering database on PSOS.
PCC_E_NO_DB_FOUND_ON_PSOS 0x8004710EL Database on PSOS could not be
accessed.

WinCC Engineering V18 – Programming reference

2522 System Manual, 11/2022, Online documentation
Index
ActivateStoredScreen, 1376
ActivateSystemDiagnosticsView, 30
_ ActiveScreen property (VBS), 493
ActiveScreenItem object, 495
_ismbcalnum function, 1529
ActualPointIndex property (VBS), 496
_ismbcalpha function, 1529
ActualPointLeft property (VBS), 496
_ismbcdigit function, 1529
ActualPointTop property (VBS), 497
_ismbcgraph function, 1529
AdaptBorder property (VBS), 498
_ismbclower function, 1529
AdaptPicture property (VBS), 499
_ismbcprint function, 1529
AdaptScreenToWindow property (VBS), 499
_ismbcpunct function, 1529
AdaptWindowtoScreen property (VBS), 500
_ismbcspace function, 1529
Address property (VBS), 500
_ismbcupper function, 1529
AddressEnabled property (VBS), 501
_mbscat function, 1529
AdressPreview property (VBS), 501
_mbschr function, 1529
AdvancedButtonPositions property (VBS), 501
_mbscmp function, 1529
AdvancedView property (VBS), 501
_mbscpy function, 1529
Alarm object, 200
_mbscspn function, 1529
Alarm property (VBS), 501
_mbsdec function, 1529
AlarmAreaHeight property (VBS), 502
_mbsinc function, 1529
AlarmAreaWidth property (VBS), 502
_mbslen function, 1529
AlarmClasses property (VBS), 502
_mbsncat function, 1529
AlarmColor property (VBS), 502
_mbsncmp function, 1529
AlarmControl object, 237
_mbsncpy function, 1529
AlarmID property, 502
_mbspbrk function, 1529
AlarmLog property (VBS), 502
_mbsrchr function, 1529
AlarmLogs object, 202
_mbsspn function, 1529
AlarmLowerLimit property (VBS), 503
_mbsstr function, 1529
AlarmLowerLimitColor property (VBS), 504
_mbstok function, 1529
AlarmLowerLimitEnabled property (VBS), 505
_mbstrlen function, 1529
AlarmLowerLimitRelative property (VBS), 505
Alarms object (list), 201
AlarmSource property (VBS), 506
A AlarmTextTag property (VBS), 506
abort function, 1531 AlarmUpperLimit property (VBS), 506
AboveUpperLimitColor property (VBS), 490 AlarmUpperLimitColor property (VBS), 507
abs function, 1531 AlarmUpperLimitEnabled property (VBS), 508
AcceptOnExit property (VBS), 491 AlarmUpperLimitRelative property (VBS), 508
AcceptOnFull property (VBS), 491 AlarmView object, 251
AcknowledgeAlarm, 25 AllFilters property (VBS), 509
acos function, 1527 AllFiltersForHitlist property (VBS), 509
Activate method (VBS), 1250 AllowEdit property (VBS), 509
ActivateDynamic method (VBS), 1252 AllowMenu property (VBS), 509
ActivateNextScreen, 1371 AllServer property (VBS), 510
ActivatePLCCodeView, 26 AllTagTypesAllowed property (VBS), 510
ActivatePreviousScreen, 27, 1372 Analog property (VBS), 510
ActivateScreen, 28, 123, 1373 AngleMax property (VBS), 511
ActivateScreenByNumber, 29 AngleMin property (VBS), 512
ActivateScreenInScreenWindow, 124, 1374 AnimationIgnore property (VBS), 512
ActivateStartScreen, 1375 Appearance property (VBS), 512

WinCC Engineering V18 – Programming reference

System Manual, 11/2022, Online documentation 2523
Index

ApplicationWindow object, 257, 407 BackColorBottom property (VBS), 529

ApplyProjectSettings property (VBS), 513 BackColorTop property (VBS), 530
ApplyProjectSettingsForDesignMode property BackFillStyle property (VBS), 531
(VBS), 513 BackFlashingColorOff property (VBS), 533
ArchiveLogFile, 31 BackFlashingColorOn property (VBS), 534
ArchiveName property (VBS), 513 BackFlashingEnabled property (VBS), 535
ArchiveType property (VBS), 514 BackFlashingRate property (VBS), 536
asctime function, 1532 BackgroundColor property (VBS), 538
asin function, 1527 BackPicture property (VBS), 538
AskOperationMotive property (VBS), 514 BackStyle property (VBS), 538
AspectRatio property (VBS), 515 BackupRAMFileSystem, 32
AssignedFilters property (VBS), 516 Bar object, 259
AssignedHitlistFilters property (VBS), 516 BarBackColor property (VBS), 539
Assignments property (VBS), 516 BarBackFillStyle property (VBS), 540
AssociatedS7GraphDBName property (VBS), 517 BarBackFlashingColorOff property (VBS), 541
AssociatedS7GraphDBTag property (VBS), 517 BarBackFlashingColorOn property (VBS), 541
atan function, 1527 BarBackFlashingEnabled property (VBS), 542
atan2 function, 1527 BarBackFlashingRate property (VBS), 542
atof function, 1531 BarColor property (VBS), 542
at